3 use vars qw(@ISA @EXPORT_OK $DEBUG $setup_hack %dbdef_cache);
4 use subs qw(reload_dbdef);
6 use DBIx::DBSchema 0.33;
7 use DBIx::DBSchema::Table;
8 use DBIx::DBSchema::Column 0.06;
9 use DBIx::DBSchema::Index;
12 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
19 FS::Schema - Freeside database schema
23 use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
25 $dbdef = reload_dbdef;
26 $dbdef = reload_dbdef "/non/standard/filename";
28 $dbdef_dist = dbdef_dist;
32 This class represents the database schema.
38 =item reload_dbdef([FILENAME])
40 Load a database definition (see L<DBIx::DBSchema>), optionally from a
41 non-default filename. This command is executed at startup unless
42 I<$FS::Schema::setup_hack> is true. Returns a DBIx::DBSchema object.
49 unless ( exists $dbdef_cache{$file} ) {
50 warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
51 $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
52 or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
54 warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
56 $dbdef = $dbdef_cache{$file};
61 Returns the current database definition (represents the current database,
62 assuming it is up-to-date). See L<DBIx::DBSchema>.
68 =item dbdef_dist [ DATASRC ]
70 Returns the current canoical database definition as defined in this file.
72 Optionally, pass a DBI data source to enable syntax specific to that database.
73 Currently, this enables "TYPE=InnoDB" for MySQL databases.
78 my $datasrc = @_ ? shift : '';
80 my $local_options = '';
81 if ( $datasrc =~ /^dbi:mysql/i ) {
82 $local_options = 'TYPE=InnoDB';
86 # create a dbdef object from the old data structure
89 my $tables_hashref = tables_hashref();
92 my $dbdef = new DBIx::DBSchema map {
98 while (@{$tables_hashref->{$tablename}{'columns'}}) {
99 #my($name, $type, $null, $length, $default, $local) =
101 splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
102 my %hash = map { $_ => shift @coldef }
103 qw( name type null length default local );
105 #can be removed once we depend on DBIx::DBSchema 0.39;
106 $hash{'type'} = 'LONGTEXT'
107 if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
109 unless ( defined $hash{'default'} ) {
110 warn "$tablename:\n".
111 join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
114 push @columns, new DBIx::DBSchema::Column ( \%hash );
117 #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
118 #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
119 my $unique = $tables_hashref->{$tablename}{'unique'};
120 my @index = @{ $tables_hashref->{$tablename}{'index'} };
122 # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
123 # specification without a key length".
124 # better solution: teach DBIx::DBSchema to specify a default length for
125 # MySQL indices on text columns, or just to support an index length at all
126 # so we can pass something in.
127 # best solution: eliminate need for this index in cust_main::retry_realtime
128 @index = grep { @{$_}[0] ne 'statustext' } @index
129 if $datasrc =~ /^dbi:mysql/i;
133 DBIx::DBSchema::Index->new({
134 'name' => $tablename. $indexnum++,
141 DBIx::DBSchema::Index->new({
142 'name' => $tablename. $indexnum++,
149 DBIx::DBSchema::Table->new({
150 'name' => $tablename,
151 'primary_key' => $tables_hashref->{$tablename}{'primary_key'},
152 'columns' => \@columns,
153 'indices' => \@indices,
154 'local_options' => $local_options,
157 } keys %$tables_hashref;
160 warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
161 warn "[debug]$me $_\n" foreach $dbdef->tables;
164 #add radius attributes to svc_acct
166 #my($svc_acct)=$dbdef->table('svc_acct');
169 #foreach $attribute (@attributes) {
170 # $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
171 # 'radius_'. $attribute,
178 #foreach $attribute (@check_attributes) {
179 # $svc_acct->addcolumn( new DBIx::DBSchema::Column (
187 #create history tables (false laziness w/create-history-tables)
189 grep { ! /^clientapi_session/ }
193 my $tableobj = $dbdef->table($table)
194 or die "unknown table $table";
196 my %indices = $tableobj->indices;
198 my %h_indices = map {
200 DBIx::DBSchema::Index->new({
201 'name' => 'h_'. $indices{$_}->name,
203 'columns' => [ @{$indices{$_}->columns} ],
209 $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
210 'name' => "h_${table}_srckey",
212 'columns' => [ 'history_action', #right?
213 $tableobj->primary_key,
217 $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
218 'name' => "h_${table}_srckey2",
220 'columns' => [ 'history_date',
221 $tableobj->primary_key,
225 my $h_tableobj = DBIx::DBSchema::Table->new( {
226 'name' => "h_$table",
227 'primary_key' => 'historynum',
228 'indices' => \%h_indices,
229 'local_options' => $local_options,
231 DBIx::DBSchema::Column->new( {
232 'name' => 'historynum',
234 'null' => 'NOT NULL',
239 DBIx::DBSchema::Column->new( {
240 'name' => 'history_date',
247 DBIx::DBSchema::Column->new( {
248 'name' => 'history_user',
250 'null' => 'NOT NULL',
255 DBIx::DBSchema::Column->new( {
256 'name' => 'history_action',
258 'null' => 'NOT NULL',
264 my $column = $tableobj->column($_);
266 #clone so as to not disturb the original
267 $column = DBIx::DBSchema::Column->new( {
268 map { $_ => $column->$_() }
269 qw( name type null length default local )
272 if ( $column->type =~ /^(\w*)SERIAL$/i ) {
273 $column->type(uc($1).'INT');
274 $column->null('NULL');
276 #$column->default('')
277 # if $column->default =~ /^nextval\(/i;
278 #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
279 #$column->local($local);
284 $dbdef->addtable($h_tableobj);
287 if ( $datasrc =~ /^dbi:mysql/i ) {
289 my $dup_lock_table = DBIx::DBSchema::Table->new( {
290 'name' => 'duplicate_lock',
291 'primary_key' => 'duplocknum',
292 'local_options' => $local_options,
294 DBIx::DBSchema::Column->new( {
295 'name' => 'duplocknum',
297 'null' => 'NOT NULL',
302 DBIx::DBSchema::Column->new( {
303 'name' => 'lockname',
305 'null' => 'NOT NULL',
311 'indices' => { 'duplicate_lock1' =>
312 DBIx::DBSchema::Index->new({
313 'name' => 'duplicate_lock1',
315 'columns' => [ 'lockname' ],
320 $dbdef->addtable($dup_lock_table);
330 my $char_d = 80; #default maxlength for text fields
332 #my(@date_type) = ( 'timestamp', '', '' );
333 my @date_type = ( 'int', 'NULL', '' );
334 my @perl_type = ( 'text', 'NULL', '' );
335 my @money_type = ( 'decimal', '', '10,2' );
336 my @money_typen = ( 'decimal', 'NULL', '10,2' );
337 my @taxrate_type = ( 'decimal', '', '14,8' ); # requires pg 8 for
338 my @taxrate_typen = ( 'decimal', 'NULL', '14,8' ); # fs-upgrade to work
340 my $username_len = 32; #usernamemax config file
342 # name type nullability length default local
348 'agentnum', 'serial', '', '', '', '',
349 'agent', 'varchar', '', $char_d, '', '',
350 'typenum', 'int', '', '', '', '',
351 'ticketing_queueid', 'int', 'NULL', '', '', '',
352 'invoice_template', 'varchar', 'NULL', $char_d, '', '',
353 'agent_custnum', 'int', 'NULL', '', '', '',
354 'disabled', 'char', 'NULL', 1, '', '',
355 'username', 'varchar', 'NULL', $char_d, '', '', #deprecated
356 '_password', 'varchar', 'NULL', $char_d, '', '', #deprecated
357 'freq', 'int', 'NULL', '', '', '', #deprecated (never used)
358 'prog', @perl_type, '', '', #deprecated (never used)
360 'primary_key' => 'agentnum',
361 #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
362 #insert is giving it a value, tho..
363 #'index' => [ ['typenum'], ['disabled'] ],
365 'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
370 'typenum', 'serial', '', '', '', '',
371 'atype', 'varchar', '', $char_d, '', '',
373 'primary_key' => 'typenum',
380 'typepkgnum', 'serial', '', '', '', '',
381 'typenum', 'int', '', '', '', '',
382 'pkgpart', 'int', '', '', '', '',
384 'primary_key' => 'typepkgnum',
385 'unique' => [ ['typenum', 'pkgpart'] ],
386 'index' => [ ['typenum'] ],
389 'cust_attachment' => {
391 'attachnum', 'serial', '', '', '', '',
392 'custnum', 'int', '', '', '', '',
393 '_date', @date_type, '', '',
394 'otaker', 'varchar', '', 32, '', '',
395 'filename', 'varchar', '', 255, '', '',
396 'mime_type', 'varchar', '', $char_d, '', '',
397 'title', 'varchar', 'NULL', $char_d, '', '',
398 'body', 'blob', 'NULL', '', '', '',
399 'disabled', @date_type, '', '',
401 'primary_key' => 'attachnum',
403 'index' => [ ['custnum'] ],
409 'invnum', 'serial', '', '', '', '',
410 'custnum', 'int', '', '', '', '',
411 '_date', @date_type, '', '',
412 'charged', @money_type, '', '',
413 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
415 #customer balance info at invoice generation time
416 'previous_balance', @money_typen, '', '', #eventually not nullable
417 'billing_balance', @money_typen, '', '', #eventually not nullable
419 #deprecated (unused by now, right?)
420 'printed', 'int', '', '', '', '',
423 'closed', 'char', 'NULL', 1, '', '',
424 'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
426 'primary_key' => 'invnum',
428 'index' => [ ['custnum'], ['_date'], ['statementnum'], ],
431 'cust_statement' => {
433 'statementnum', 'serial', '', '', '', '',
434 'custnum', 'int', '', '', '', '',
435 '_date', @date_type, '', '',
437 'primary_key' => 'statementnum',
439 'index' => [ ['custnum'], ['_date'], ],
442 'cust_bill_event' => {
444 'eventnum', 'serial', '', '', '', '',
445 'invnum', 'int', '', '', '', '',
446 'eventpart', 'int', '', '', '', '',
447 '_date', @date_type, '', '',
448 'status', 'varchar', '', $char_d, '', '',
449 'statustext', 'text', 'NULL', '', '', '',
451 'primary_key' => 'eventnum',
452 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
454 'index' => [ ['invnum'], ['status'], ['eventpart'],
455 ['statustext'], ['_date'],
459 'part_bill_event' => {
461 'eventpart', 'serial', '', '', '', '',
462 'freq', 'varchar', 'NULL', $char_d, '', '',
463 'payby', 'char', '', 4, '', '',
464 'event', 'varchar', '', $char_d, '', '',
465 'eventcode', @perl_type, '', '',
466 'seconds', 'int', 'NULL', '', '', '',
467 'weight', 'int', '', '', '', '',
468 'plan', 'varchar', 'NULL', $char_d, '', '',
469 'plandata', 'text', 'NULL', '', '', '',
470 'reason', 'int', 'NULL', '', '', '',
471 'disabled', 'char', 'NULL', 1, '', '',
473 'primary_key' => 'eventpart',
475 'index' => [ ['payby'], ['disabled'], ],
480 'eventpart', 'serial', '', '', '', '',
481 'agentnum', 'int', 'NULL', '', '', '',
482 'event', 'varchar', '', $char_d, '', '',
483 'eventtable', 'varchar', '', $char_d, '', '',
484 'check_freq', 'varchar', 'NULL', $char_d, '', '',
485 'weight', 'int', '', '', '', '',
486 'action', 'varchar', '', $char_d, '', '',
487 'disabled', 'char', 'NULL', 1, '', '',
489 'primary_key' => 'eventpart',
491 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
494 'part_event_option' => {
496 'optionnum', 'serial', '', '', '', '',
497 'eventpart', 'int', '', '', '', '',
498 'optionname', 'varchar', '', $char_d, '', '',
499 'optionvalue', 'text', 'NULL', '', '', '',
501 'primary_key' => 'optionnum',
503 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
506 'part_event_condition' => {
508 'eventconditionnum', 'serial', '', '', '', '',
509 'eventpart', 'int', '', '', '', '',
510 'conditionname', 'varchar', '', $char_d, '', '',
512 'primary_key' => 'eventconditionnum',
514 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
517 'part_event_condition_option' => {
519 'optionnum', 'serial', '', '', '', '',
520 'eventconditionnum', 'int', '', '', '', '',
521 'optionname', 'varchar', '', $char_d, '', '',
522 'optionvalue', 'text', 'NULL', '', '', '',
524 'primary_key' => 'optionnum',
526 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
529 'part_event_condition_option_option' => {
531 'optionoptionnum', 'serial', '', '', '', '',
532 'optionnum', 'int', '', '', '', '',
533 'optionname', 'varchar', '', $char_d, '', '',
534 'optionvalue', 'text', 'NULL', '', '', '',
536 'primary_key' => 'optionoptionnum',
538 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
543 'eventnum', 'serial', '', '', '', '',
544 'eventpart', 'int', '', '', '', '',
545 'tablenum', 'int', '', '', '', '',
546 '_date', @date_type, '', '',
547 'status', 'varchar', '', $char_d, '', '',
548 'statustext', 'text', 'NULL', '', '', '',
550 'primary_key' => 'eventnum',
551 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
553 'index' => [ ['eventpart'], ['tablenum'], ['status'],
554 ['statustext'], ['_date'],
560 'billpkgnum', 'serial', '', '', '', '',
561 'invnum', 'int', '', '', '', '',
562 'pkgnum', 'int', '', '', '', '',
563 'pkgpart_override', 'int', 'NULL', '', '', '',
564 'setup', @money_type, '', '',
565 'recur', @money_type, '', '',
566 'sdate', @date_type, '', '',
567 'edate', @date_type, '', '',
568 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
569 'itemcomment', 'varchar', 'NULL', $char_d, '', '',
570 'section', 'varchar', 'NULL', $char_d, '', '',
571 'quantity', 'int', 'NULL', '', '', '',
572 'unitsetup', @money_typen, '', '',
573 'unitrecur', @money_typen, '', '',
574 'hidden', 'char', 'NULL', 1, '', '',
576 'primary_key' => 'billpkgnum',
578 'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
581 'cust_bill_pkg_detail' => {
583 'detailnum', 'serial', '', '', '', '',
584 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
585 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
586 'invnum', 'int', 'NULL', '', '', '', # deprecated
587 'amount', 'decimal', 'NULL', '10,4', '', '',
588 'format', 'char', 'NULL', 1, '', '',
589 'classnum', 'int', 'NULL', '', '', '',
590 'duration', 'int', 'NULL', '', 0, '',
591 'phonenum', 'varchar', 'NULL', 15, '', '',
592 'regionname', 'varchar', 'NULL', $char_d, '', '',
593 'detail', 'varchar', '', 255, '', '',
595 'primary_key' => 'detailnum',
597 'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
600 'cust_bill_pkg_display' => {
602 'billpkgdisplaynum', 'serial', '', '', '', '',
603 'billpkgnum', 'int', '', '', '', '',
604 'section', 'varchar', 'NULL', $char_d, '', '',
605 #'unitsetup', @money_typen, '', '', #override the linked real one?
606 #'unitrecur', @money_typen, '', '', #this too?
607 'post_total', 'char', 'NULL', 1, '', '',
608 'type', 'char', 'NULL', 1, '', '',
609 'summary', 'char', 'NULL', 1, '', '',
611 'primary_key' => 'billpkgdisplaynum',
613 'index' => [ ['billpkgnum'], ],
616 'cust_bill_pkg_tax_location' => {
618 'billpkgtaxlocationnum', 'serial', '', '', '', '',
619 'billpkgnum', 'int', '', '', '', '',
620 'taxnum', 'int', '', '', '', '',
621 'taxtype', 'varchar', '', $char_d, '', '',
622 'pkgnum', 'int', '', '', '', '',
623 'locationnum', 'int', '', '', '', '', #redundant?
624 'amount', @money_type, '', '',
626 'primary_key' => 'billpkgtaxlocationnum',
628 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
631 'cust_bill_pkg_tax_rate_location' => {
633 'billpkgtaxratelocationnum', 'serial', '', '', '', '',
634 'billpkgnum', 'int', '', '', '', '',
635 'taxnum', 'int', '', '', '', '',
636 'taxtype', 'varchar', '', $char_d, '', '',
637 'locationtaxid', 'varchar', 'NULL', $char_d, '', '',
638 'taxratelocationnum', 'int', '', '', '', '',
639 'amount', @money_type, '', '',
641 'primary_key' => 'billpkgtaxratelocationnum',
643 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
648 'crednum', 'serial', '', '', '', '',
649 'custnum', 'int', '', '', '', '',
650 '_date', @date_type, '', '',
651 'amount', @money_type, '', '',
652 'otaker', 'varchar', '', 32, '', '',
653 'reason', 'text', 'NULL', '', '', '',
654 'reasonnum', 'int', 'NULL', '', '', '',
655 'addlinfo', 'text', 'NULL', '', '', '',
656 'closed', 'char', 'NULL', 1, '', '',
657 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
658 'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
660 'primary_key' => 'crednum',
662 'index' => [ ['custnum'], ['_date'], ['eventnum'] ],
665 'cust_credit_bill' => {
667 'creditbillnum', 'serial', '', '', '', '',
668 'crednum', 'int', '', '', '', '',
669 'invnum', 'int', '', '', '', '',
670 '_date', @date_type, '', '',
671 'amount', @money_type, '', '',
672 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
674 'primary_key' => 'creditbillnum',
676 'index' => [ ['crednum'], ['invnum'] ],
679 'cust_credit_bill_pkg' => {
681 'creditbillpkgnum', 'serial', '', '', '', '',
682 'creditbillnum', 'int', '', '', '', '',
683 'billpkgnum', 'int', '', '', '', '',
684 'amount', @money_type, '', '',
685 'setuprecur', 'varchar', '', $char_d, '', '',
686 'sdate', @date_type, '', '',
687 'edate', @date_type, '', '',
689 'primary_key' => 'creditbillpkgnum',
691 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
696 'custnum', 'serial', '', '', '', '',
697 'agentnum', 'int', '', '', '', '',
698 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
699 'custbatch', 'varchar', 'NULL', $char_d, '', '',
700 # 'titlenum', 'int', 'NULL', '', '', '',
701 'last', 'varchar', '', $char_d, '', '',
702 # 'middle', 'varchar', 'NULL', $char_d, '', '',
703 'first', 'varchar', '', $char_d, '', '',
704 'ss', 'varchar', 'NULL', 11, '', '',
705 'stateid', 'varchar', 'NULL', $char_d, '', '',
706 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
707 'birthdate' ,@date_type, '', '',
708 'signupdate',@date_type, '', '',
709 'dundate', @date_type, '', '',
710 'company', 'varchar', 'NULL', $char_d, '', '',
711 'address1', 'varchar', '', $char_d, '', '',
712 'address2', 'varchar', 'NULL', $char_d, '', '',
713 'city', 'varchar', '', $char_d, '', '',
714 'county', 'varchar', 'NULL', $char_d, '', '',
715 'state', 'varchar', 'NULL', $char_d, '', '',
716 'zip', 'varchar', 'NULL', 10, '', '',
717 'country', 'char', '', 2, '', '',
718 'daytime', 'varchar', 'NULL', 20, '', '',
719 'night', 'varchar', 'NULL', 20, '', '',
720 'fax', 'varchar', 'NULL', 12, '', '',
721 'ship_last', 'varchar', 'NULL', $char_d, '', '',
722 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
723 'ship_first', 'varchar', 'NULL', $char_d, '', '',
724 'ship_company', 'varchar', 'NULL', $char_d, '', '',
725 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
726 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
727 'ship_city', 'varchar', 'NULL', $char_d, '', '',
728 'ship_county', 'varchar', 'NULL', $char_d, '', '',
729 'ship_state', 'varchar', 'NULL', $char_d, '', '',
730 'ship_zip', 'varchar', 'NULL', 10, '', '',
731 'ship_country', 'char', 'NULL', 2, '', '',
732 'ship_daytime', 'varchar', 'NULL', 20, '', '',
733 'ship_night', 'varchar', 'NULL', 20, '', '',
734 'ship_fax', 'varchar', 'NULL', 12, '', '',
735 'payby', 'char', '', 4, '', '',
736 'payinfo', 'varchar', 'NULL', 512, '', '',
737 'paycvv', 'varchar', 'NULL', 512, '', '',
738 'paymask', 'varchar', 'NULL', $char_d, '', '',
739 #'paydate', @date_type, '', '',
740 'paydate', 'varchar', 'NULL', 10, '', '',
741 'paystart_month', 'int', 'NULL', '', '', '',
742 'paystart_year', 'int', 'NULL', '', '', '',
743 'payissue', 'varchar', 'NULL', 2, '', '',
744 'payname', 'varchar', 'NULL', $char_d, '', '',
745 'paystate', 'varchar', 'NULL', $char_d, '', '',
746 'paytype', 'varchar', 'NULL', $char_d, '', '',
747 'payip', 'varchar', 'NULL', 15, '', '',
748 'geocode', 'varchar', 'NULL', 20, '', '',
749 'censustract', 'varchar', 'NULL', 20, '', '', # 7 to save space?
750 'tax', 'char', 'NULL', 1, '', '',
751 'otaker', 'varchar', '', 32, '', '',
752 'refnum', 'int', '', '', '', '',
753 'referral_custnum', 'int', 'NULL', '', '', '',
754 'comments', 'text', 'NULL', '', '', '',
755 'spool_cdr','char', 'NULL', 1, '', '',
756 'squelch_cdr','char', 'NULL', 1, '', '',
757 'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
758 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
759 'archived', 'char', 'NULL', 1, '', '',
760 'email_csv_cdr', 'char', 'NULL', 1, '', '',
762 'primary_key' => 'custnum',
763 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
764 #'index' => [ ['last'], ['company'] ],
766 [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
767 [ 'referral_custnum' ],
768 [ 'payby' ], [ 'paydate' ],
771 [ 'last' ], [ 'company' ],
772 [ 'county' ], [ 'state' ], [ 'country' ],
774 [ 'daytime' ], [ 'night' ], [ 'fax' ],
776 [ 'ship_last' ], [ 'ship_company' ],
777 [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
779 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
783 'cust_recon' => { # what purpose does this serve?
785 'reconid', 'serial', '', '', '', '',
786 'recondate', @date_type, '', '',
787 'custnum', 'int' , '', '', '', '',
788 'agentnum', 'int', '', '', '', '',
789 'last', 'varchar', '', $char_d, '', '',
790 'first', 'varchar', '', $char_d, '', '',
791 'address1', 'varchar', '', $char_d, '', '',
792 'address2', 'varchar', 'NULL', $char_d, '', '',
793 'city', 'varchar', '', $char_d, '', '',
794 'state', 'varchar', 'NULL', $char_d, '', '',
795 'zip', 'varchar', 'NULL', 10, '', '',
796 'pkg', 'varchar', 'NULL', $char_d, '', '',
797 'adjourn', @date_type, '', '',
798 'status', 'varchar', 'NULL', 10, '', '',
799 'agent_custid', 'varchar', '', $char_d, '', '',
800 'agent_pkg', 'varchar', 'NULL', $char_d, '', '',
801 'agent_adjourn', @date_type, '', '',
802 'comments', 'text', 'NULL', '', '', '',
804 'primary_key' => 'reconid',
809 #eventually use for billing & ship from cust_main too
810 #for now, just cust_pkg locations
813 'locationnum', 'serial', '', '', '', '',
814 'custnum', 'int', '', '', '', '',
815 'address1', 'varchar', '', $char_d, '', '',
816 'address2', 'varchar', 'NULL', $char_d, '', '',
817 'city', 'varchar', '', $char_d, '', '',
818 'county', 'varchar', 'NULL', $char_d, '', '',
819 'state', 'varchar', 'NULL', $char_d, '', '',
820 'zip', 'varchar', 'NULL', 10, '', '',
821 'country', 'char', '', 2, '', '',
822 'geocode', 'varchar', 'NULL', 20, '', '',
824 'primary_key' => 'locationnum',
826 'index' => [ [ 'custnum' ],
827 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
831 'cust_main_invoice' => {
833 'destnum', 'serial', '', '', '', '',
834 'custnum', 'int', '', '', '', '',
835 'dest', 'varchar', '', $char_d, '', '',
837 'primary_key' => 'destnum',
839 'index' => [ ['custnum'], ],
842 'cust_main_note' => {
844 'notenum', 'serial', '', '', '', '',
845 'custnum', 'int', '', '', '', '',
846 '_date', @date_type, '', '',
847 'otaker', 'varchar', '', 32, '', '',
848 'comments', 'text', 'NULL', '', '', '',
850 'primary_key' => 'notenum',
852 'index' => [ [ 'custnum' ], [ '_date' ], ],
855 'cust_main_exemption' => {
857 'exemptionnum', 'serial', '', '', '', '',
858 'custnum', 'int', '', '', '', '',
859 'taxname', 'varchar', '', $char_d, '', '',
860 #start/end dates? for reporting?
862 'primary_key' => 'exemptionnum',
864 'index' => [ [ 'custnum' ] ],
867 'cust_tax_adjustment' => {
869 'adjustmentnum', 'serial', '', '', '', '',
870 'custnum', 'int', '', '', '', '',
871 'taxname', 'varchar', '', $char_d, '', '',
872 'amount', @money_type, '', '',
873 'comment', 'varchar', 'NULL', $char_d, '', '',
874 'billpkgnum', 'int', 'NULL', '', '', '',
875 #more? no cust_bill_pkg_tax_location?
877 'primary_key' => 'adjustmentnum',
879 'index' => [ [ 'custnum' ], [ 'billpkgnum' ] ],
882 'cust_main_county' => { #county+state+country are checked off the
883 #cust_main_county for validation and to provide
886 'taxnum', 'serial', '', '', '', '',
887 'state', 'varchar', 'NULL', $char_d, '', '',
888 'county', 'varchar', 'NULL', $char_d, '', '',
889 'country', 'char', '', 2, '', '',
890 'taxclass', 'varchar', 'NULL', $char_d, '', '',
891 'exempt_amount', @money_type, '', '',
892 'tax', 'real', '', '', '', '', #tax %
893 'taxname', 'varchar', 'NULL', $char_d, '', '',
894 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
895 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
897 'primary_key' => 'taxnum',
899 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
900 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
907 'taxnum', 'serial', '', '', '', '',
908 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
909 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
910 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
911 'taxclassnum', 'int', '', '', '', '',
912 'effective_date', @date_type, '', '',
913 'tax', @taxrate_type, '', '', # tax %
914 'excessrate', @taxrate_typen, '', '', # second tax %
915 'taxbase', @money_typen, '', '', # amount at first tax rate
916 'taxmax', @money_typen, '', '', # maximum about at both rates
917 'usetax', @taxrate_typen, '', '', # tax % when non-local
918 'useexcessrate', @taxrate_typen, '', '', # second tax % when non-local
919 'unittype', 'int', 'NULL', '', '', '', # for fee
920 'fee', @taxrate_typen, '', '', # amount tax per unit
921 'excessfee', @taxrate_typen, '', '', # second amount tax per unit
922 'feebase', @taxrate_typen, '', '', # units taxed at first rate
923 'feemax', @taxrate_typen, '', '', # maximum number of unit taxed
924 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
925 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
926 'taxauth', 'int', 'NULL', '', '', '', # tax authority
927 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
928 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
929 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
930 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
931 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
932 'inoutcity', 'char', 'NULL', 1, '', '', # '', 'I', or 'O'
933 'inoutlocal', 'char', 'NULL', 1, '', '', # '', 'I', or 'O'
934 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
935 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
937 'primary_key' => 'taxnum',
939 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
942 'tax_rate_location' => {
944 'taxratelocationnum', 'serial', '', '', '', '',
945 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
946 'geocode', 'varchar', '', 20, '', '',
947 'city', 'varchar', 'NULL', $char_d, '', '',
948 'county', 'varchar', 'NULL', $char_d, '', '',
949 'state', 'char', 'NULL', 2, '', '',
950 'disabled', 'char', 'NULL', 1, '', '',
952 'primary_key' => 'taxratelocationnum',
954 'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
957 'cust_tax_location' => {
959 'custlocationnum', 'serial', '', '', '', '',
960 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
961 'city', 'varchar', 'NULL', $char_d, '', '',
962 'postalcity', 'varchar', 'NULL', $char_d, '', '',
963 'county', 'varchar', 'NULL', $char_d, '', '',
964 'zip', 'char', '', 5, '', '',
965 'state', 'char', '', 2, '', '',
966 'plus4hi', 'char', 'NULL', 4, '', '',
967 'plus4lo', 'char', 'NULL', 4, '', '',
968 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
969 'cityflag', 'char', 'NULL', 1, '', '', # I(n)/O(out)/B(oth)/NULL
970 'geocode', 'varchar', '', 20, '', '',
972 'primary_key' => 'custlocationnum',
974 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
979 'taxclassnum', 'serial', '', '', '', '',
980 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
981 'taxclass', 'varchar', '', $char_d, '', '',
982 'description', 'varchar', '', 2*$char_d, '', '',
984 'primary_key' => 'taxclassnum',
985 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
989 'cust_pay_pending' => {
991 'paypendingnum','serial', '', '', '', '',
992 'custnum', 'int', '', '', '', '',
993 'paid', @money_type, '', '',
994 '_date', @date_type, '', '',
995 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
996 # be index into payby
998 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
999 'paymask', 'varchar', 'NULL', $char_d, '', '',
1000 'paydate', 'varchar', 'NULL', 10, '', '',
1001 'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1002 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1003 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1005 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1006 'status', 'varchar', '', $char_d, '', '',
1007 'session_id', 'varchar', 'NULL', $char_d, '', '', #only need 32
1008 'statustext', 'text', 'NULL', '', '', '',
1009 'gatewaynum', 'int', 'NULL', '', '', '',
1010 #'cust_balance', @money_type, '', '',
1011 'paynum', 'int', 'NULL', '', '', '',
1012 'jobnum', 'int', 'NULL', '', '', '',
1014 'primary_key' => 'paypendingnum',
1015 'unique' => [ [ 'payunique' ] ],
1016 'index' => [ [ 'custnum' ], [ 'status' ], ],
1021 'paynum', 'serial', '', '', '', '',
1022 'custnum', 'int', '', '', '', '',
1023 '_date', @date_type, '', '',
1024 'paid', @money_type, '', '',
1025 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
1026 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1027 # index into payby table
1029 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1030 'paymask', 'varchar', 'NULL', $char_d, '', '',
1031 'paydate', 'varchar', 'NULL', 10, '', '',
1032 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1033 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1034 'closed', 'char', 'NULL', 1, '', '',
1035 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1037 'primary_key' => 'paynum',
1038 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1039 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
1042 'cust_pay_void' => {
1044 'paynum', 'int', '', '', '', '',
1045 'custnum', 'int', '', '', '', '',
1046 'paid', @money_type, '', '',
1047 '_date', @date_type, '', '',
1048 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1049 # index into payby table
1051 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1052 'paymask', 'varchar', 'NULL', $char_d, '', '',
1053 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1054 'closed', 'char', 'NULL', 1, '', '',
1055 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1056 'void_date', @date_type, '', '',
1057 'reason', 'varchar', 'NULL', $char_d, '', '',
1058 'otaker', 'varchar', '', 32, '', '',
1060 'primary_key' => 'paynum',
1062 'index' => [ [ 'custnum' ] ],
1065 'cust_bill_pay' => {
1067 'billpaynum', 'serial', '', '', '', '',
1068 'invnum', 'int', '', '', '', '',
1069 'paynum', 'int', '', '', '', '',
1070 'amount', @money_type, '', '',
1071 '_date', @date_type, '', '',
1072 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1074 'primary_key' => 'billpaynum',
1076 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1079 'cust_bill_pay_batch' => {
1081 'billpaynum', 'serial', '', '', '', '',
1082 'invnum', 'int', '', '', '', '',
1083 'paybatchnum', 'int', '', '', '', '',
1084 'amount', @money_type, '', '',
1085 '_date', @date_type, '', '',
1087 'primary_key' => 'billpaynum',
1089 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1092 'cust_bill_pay_pkg' => {
1094 'billpaypkgnum', 'serial', '', '', '', '',
1095 'billpaynum', 'int', '', '', '', '',
1096 'billpkgnum', 'int', '', '', '', '',
1097 'amount', @money_type, '', '',
1098 'setuprecur', 'varchar', '', $char_d, '', '',
1099 'sdate', @date_type, '', '',
1100 'edate', @date_type, '', '',
1102 'primary_key' => 'billpaypkgnum',
1104 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1107 'pay_batch' => { #batches of payments to an external processor
1109 'batchnum', 'serial', '', '', '', '',
1110 'payby', 'char', '', 4, '', '', # CARD/CHEK
1111 'status', 'char', 'NULL', 1, '', '',
1112 'download', @date_type, '', '',
1113 'upload', @date_type, '', '',
1115 'primary_key' => 'batchnum',
1120 'cust_pay_batch' => { #what's this used for again? list of customers
1121 #in current CARD batch? (necessarily CARD?)
1123 'paybatchnum', 'serial', '', '', '', '',
1124 'batchnum', 'int', '', '', '', '',
1125 'invnum', 'int', '', '', '', '',
1126 'custnum', 'int', '', '', '', '',
1127 'last', 'varchar', '', $char_d, '', '',
1128 'first', 'varchar', '', $char_d, '', '',
1129 'address1', 'varchar', '', $char_d, '', '',
1130 'address2', 'varchar', 'NULL', $char_d, '', '',
1131 'city', 'varchar', '', $char_d, '', '',
1132 'state', 'varchar', 'NULL', $char_d, '', '',
1133 'zip', 'varchar', 'NULL', 10, '', '',
1134 'country', 'char', '', 2, '', '',
1135 # 'trancode', 'int', '', '', '', ''
1136 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1137 'payinfo', 'varchar', '', 512, '', '',
1138 #'exp', @date_type, '', ''
1139 'exp', 'varchar', 'NULL', 11, '', '',
1140 'payname', 'varchar', 'NULL', $char_d, '', '',
1141 'amount', @money_type, '', '',
1142 'status', 'varchar', 'NULL', $char_d, '', '',
1144 'primary_key' => 'paybatchnum',
1146 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1151 'pkgnum', 'serial', '', '', '', '',
1152 'custnum', 'int', '', '', '', '',
1153 'pkgpart', 'int', '', '', '', '',
1154 'locationnum', 'int', 'NULL', '', '', '',
1155 'otaker', 'varchar', '', 32, '', '',
1156 'start_date', @date_type, '', '',
1157 'setup', @date_type, '', '',
1158 'bill', @date_type, '', '',
1159 'last_bill', @date_type, '', '',
1160 'susp', @date_type, '', '',
1161 'adjourn', @date_type, '', '',
1162 'cancel', @date_type, '', '',
1163 'expire', @date_type, '', '',
1164 'change_date', @date_type, '', '',
1165 'change_pkgnum', 'int', 'NULL', '', '', '',
1166 'change_pkgpart', 'int', 'NULL', '', '', '',
1167 'change_locationnum', 'int', 'NULL', '', '', '',
1168 'manual_flag', 'char', 'NULL', 1, '', '',
1169 'quantity', 'int', 'NULL', '', '', '',
1171 'primary_key' => 'pkgnum',
1173 'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1174 [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1175 ['susp'], ['adjourn'], ['expire'], ['cancel'],
1180 'cust_pkg_option' => {
1182 'optionnum', 'serial', '', '', '', '',
1183 'pkgnum', 'int', '', '', '', '',
1184 'optionname', 'varchar', '', $char_d, '', '',
1185 'optionvalue', 'text', 'NULL', '', '', '',
1187 'primary_key' => 'optionnum',
1189 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
1192 'cust_pkg_detail' => {
1194 'pkgdetailnum', 'serial', '', '', '', '',
1195 'pkgnum', 'int', '', '', '', '',
1196 'detail', 'varchar', '', $char_d, '', '',
1197 'detailtype', 'char', '', 1, '', '', # "I"nvoice or "C"omment
1198 'weight', 'int', '', '', '', '',
1200 'primary_key' => 'pkgdetailnum',
1202 'index' => [ [ 'pkgnum', 'detailtype' ] ],
1205 'cust_pkg_reason' => {
1207 'num', 'serial', '', '', '', '',
1208 'pkgnum', 'int', '', '', '', '',
1209 'reasonnum','int', '', '', '', '',
1210 'action', 'char', 'NULL', 1, '', '', #should not be nullable
1211 'otaker', 'varchar', '', 32, '', '',
1212 'date', @date_type, '', '',
1214 'primary_key' => 'num',
1216 'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1221 'refundnum', 'serial', '', '', '', '',
1222 'custnum', 'int', '', '', '', '',
1223 '_date', @date_type, '', '',
1224 'refund', @money_type, '', '',
1225 'otaker', 'varchar', '', 32, '', '',
1226 'reason', 'varchar', '', $char_d, '', '',
1227 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
1228 # be index into payby
1230 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1231 'paymask', 'varchar', 'NULL', $char_d, '', '',
1232 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1233 'closed', 'char', 'NULL', 1, '', '',
1235 'primary_key' => 'refundnum',
1237 'index' => [ ['custnum'], ['_date'] ],
1240 'cust_credit_refund' => {
1242 'creditrefundnum', 'serial', '', '', '', '',
1243 'crednum', 'int', '', '', '', '',
1244 'refundnum', 'int', '', '', '', '',
1245 'amount', @money_type, '', '',
1246 '_date', @date_type, '', '',
1248 'primary_key' => 'creditrefundnum',
1250 'index' => [ ['crednum'], ['refundnum'] ],
1256 'svcnum', 'serial', '', '', '', '',
1257 'pkgnum', 'int', 'NULL', '', '', '',
1258 'svcpart', 'int', '', '', '', '',
1259 'overlimit', @date_type, '', '',
1261 'primary_key' => 'svcnum',
1263 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1266 'cust_svc_option' => {
1268 'optionnum', 'serial', '', '', '', '',
1269 'svcnum', 'int', '', '', '', '',
1270 'optionname', 'varchar', '', $char_d, '', '',
1271 'optionvalue', 'text', 'NULL', '', '', '',
1273 'primary_key' => 'optionnum',
1275 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1280 'pkgpart', 'serial', '', '', '', '',
1281 'pkg', 'varchar', '', $char_d, '', '',
1282 'comment', 'varchar', '', $char_d, '', '',
1283 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1284 'setup', @perl_type, '', '',
1285 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1286 'recur', @perl_type, '', '',
1287 'setuptax', 'char', 'NULL', 1, '', '',
1288 'recurtax', 'char', 'NULL', 1, '', '',
1289 'plan', 'varchar', 'NULL', $char_d, '', '',
1290 'plandata', 'text', 'NULL', '', '', '',
1291 'disabled', 'char', 'NULL', 1, '', '',
1292 'custom', 'char', 'NULL', 1, '', '',
1293 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1294 'classnum', 'int', 'NULL', '', '', '',
1295 'taxproductnum', 'int', 'NULL', '', '', '',
1296 'setup_cost', @money_typen, '', '',
1297 'recur_cost', @money_typen, '', '',
1298 'pay_weight', 'real', 'NULL', '', '', '',
1299 'credit_weight', 'real', 'NULL', '', '', '',
1300 'agentnum', 'int', 'NULL', '', '', '',
1301 'fcc_ds0s', 'int', 'NULL', '', '', '',
1304 'primary_key' => 'pkgpart',
1306 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1309 'part_pkg_link' => {
1311 'pkglinknum', 'serial', '', '', '', '',
1312 'src_pkgpart', 'int', '', '', '', '',
1313 'dst_pkgpart', 'int', '', '', '', '',
1314 'link_type', 'varchar', '', $char_d, '', '',
1315 'hidden', 'char', 'NULL', 1, '', '',
1317 'primary_key' => 'pkglinknum',
1318 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1319 'index' => [ [ 'src_pkgpart' ] ],
1321 # XXX somewhat borked unique: we don't really want a hidden and unhidden
1322 # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1324 'part_pkg_taxclass' => {
1326 'taxclassnum', 'serial', '', '', '', '',
1327 'taxclass', 'varchar', '', $char_d, '', '',
1328 'disabled', 'char', 'NULL', 1, '', '',
1330 'primary_key' => 'taxclassnum',
1331 'unique' => [ [ 'taxclass' ] ],
1332 'index' => [ [ 'disabled' ] ],
1335 'part_pkg_taxproduct' => {
1337 'taxproductnum', 'serial', '', '', '', '',
1338 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1339 'taxproduct', 'varchar', '', $char_d, '', '',
1340 'description', 'varchar', '', 3*$char_d, '', '',
1342 'primary_key' => 'taxproductnum',
1343 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1347 'part_pkg_taxrate' => {
1349 'pkgtaxratenum', 'serial', '', '', '', '',
1350 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1351 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1352 'taxproductnum', 'int', '', '', '', '',
1353 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1354 'county', 'varchar', 'NULL', $char_d, '', '',
1355 'state', 'varchar', 'NULL', $char_d, '', '',
1356 'local', 'varchar', 'NULL', $char_d, '', '',
1357 'country', 'char', 'NULL', 2, '', '',
1358 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1359 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1360 'taxclassnum', 'int', 'NULL', '', '', '',
1361 'effdate', @date_type, '', '',
1362 'taxable', 'char', 'NULL', 1, '', '',
1364 'primary_key' => 'pkgtaxratenum',
1366 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1369 'part_pkg_taxoverride' => {
1371 'taxoverridenum', 'serial', '', '', '', '',
1372 'pkgpart', 'int', '', '', '', '',
1373 'taxclassnum', 'int', '', '', '', '',
1374 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1376 'primary_key' => 'taxoverridenum',
1378 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1383 # 'titlenum', 'int', '', '',
1384 # 'title', 'varchar', '', $char_d,
1386 # 'primary_key' => 'titlenum',
1387 # 'unique' => [ [] ],
1388 # 'index' => [ [] ],
1393 'pkgsvcnum', 'serial', '', '', '', '',
1394 'pkgpart', 'int', '', '', '', '',
1395 'svcpart', 'int', '', '', '', '',
1396 'quantity', 'int', '', '', '', '',
1397 'primary_svc','char', 'NULL', 1, '', '',
1399 'primary_key' => 'pkgsvcnum',
1400 'unique' => [ ['pkgpart', 'svcpart'] ],
1401 'index' => [ ['pkgpart'], ['quantity'] ],
1404 'part_referral' => {
1406 'refnum', 'serial', '', '', '', '',
1407 'referral', 'varchar', '', $char_d, '', '',
1408 'disabled', 'char', 'NULL', 1, '', '',
1409 'agentnum', 'int', 'NULL', '', '', '',
1411 'primary_key' => 'refnum',
1413 'index' => [ ['disabled'], ['agentnum'], ],
1418 'svcpart', 'serial', '', '', '', '',
1419 'svc', 'varchar', '', $char_d, '', '',
1420 'svcdb', 'varchar', '', $char_d, '', '',
1421 'disabled', 'char', 'NULL', 1, '', '',
1423 'primary_key' => 'svcpart',
1425 'index' => [ [ 'disabled' ] ],
1428 'part_svc_column' => {
1430 'columnnum', 'serial', '', '', '', '',
1431 'svcpart', 'int', '', '', '', '',
1432 'columnname', 'varchar', '', 64, '', '',
1433 'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1434 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1435 'columnflag', 'char', 'NULL', 1, '', '',
1437 'primary_key' => 'columnnum',
1438 'unique' => [ [ 'svcpart', 'columnname' ] ],
1439 'index' => [ [ 'svcpart' ] ],
1442 #(this should be renamed to part_pop)
1445 'popnum', 'serial', '', '', '', '',
1446 'city', 'varchar', '', $char_d, '', '',
1447 'state', 'varchar', '', $char_d, '', '',
1448 'ac', 'char', '', 3, '', '',
1449 'exch', 'char', '', 3, '', '',
1450 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1452 'primary_key' => 'popnum',
1454 'index' => [ [ 'state' ] ],
1457 'part_pop_local' => {
1459 'localnum', 'serial', '', '', '', '',
1460 'popnum', 'int', '', '', '', '',
1461 'city', 'varchar', 'NULL', $char_d, '', '',
1462 'state', 'char', 'NULL', 2, '', '',
1463 'npa', 'char', '', 3, '', '',
1464 'nxx', 'char', '', 3, '', '',
1466 'primary_key' => 'localnum',
1468 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1473 'svcnum', 'int', '', '', '', '',
1474 'username', 'varchar', '', $username_len, '', '',
1475 '_password', 'varchar', 'NULL', 512, '', '',
1476 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1477 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1478 'popnum', 'int', 'NULL', '', '', '',
1479 'uid', 'int', 'NULL', '', '', '',
1480 'gid', 'int', 'NULL', '', '', '',
1481 'finger', 'varchar', 'NULL', $char_d, '', '',
1482 'dir', 'varchar', 'NULL', $char_d, '', '',
1483 'shell', 'varchar', 'NULL', $char_d, '', '',
1484 'quota', 'varchar', 'NULL', $char_d, '', '',
1485 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1486 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1487 'seconds_threshold', 'int', 'NULL', '', '', '',
1488 'upbytes', 'bigint', 'NULL', '', '', '',
1489 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1490 'downbytes', 'bigint', 'NULL', '', '', '',
1491 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1492 'totalbytes','bigint', 'NULL', '', '', '',
1493 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1494 'domsvc', 'int', '', '', '', '',
1495 'pbxsvc', 'int', 'NULL', '', '', '',
1496 'last_login', @date_type, '', '',
1497 'last_logout', @date_type, '', '',
1498 #communigate pro fields (quota = MaxAccountSize)
1499 'cgp_aliases', 'varchar', 'NULL', 255, '', '',
1501 'cgp_type', 'varchar', 'NULL', $char_d, '', '', #AccountType
1502 'file_quota', 'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1503 'file_maxnum', 'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1504 'file_maxsize', 'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1505 'cgp_accessmodes', 'varchar', 'NULL', 255, '', '', #AccessModes
1506 'password_selfchange','char', 'NULL', 1, '', '', #PWDAllowed
1507 'password_recover', 'char', 'NULL', 1, 'Y','', #PasswordRecovery
1508 'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1509 'cgp_rpopallowed', 'char', 'NULL', 1, '', '', #RPOPAllowed
1510 'cgp_mailtoall', 'char', 'NULL', 1, '', '', #MailToAll
1511 'cgp_addmailtrailer', 'char', 'NULL', 1, '', '', #AddMailTrailer
1512 #XXX archive messages, mailing lists
1514 'cgp_deletemode', 'varchar', 'NULL', $char_d, '', '',#DeleteMode
1515 'cgp_emptytrash', 'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1516 'cgp_language', 'varchar', 'NULL', $char_d, '', '',#Language
1517 'cgp_timezone', 'varchar', 'NULL', $char_d, '', '',#TimeZone
1518 'cgp_skinname', 'varchar', 'NULL', $char_d, '', '',#SkinName
1519 'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1520 'cgp_sendmdnmode', 'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1522 #vacation message, redirect all mail, mail rules
1525 'primary_key' => 'svcnum',
1526 #'unique' => [ [ 'username', 'domsvc' ] ],
1528 'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1531 'acct_rt_transaction' => {
1533 'svcrtid', 'int', '', '', '', '',
1534 'svcnum', 'int', '', '', '', '',
1535 'transaction_id', 'int', '', '', '', '',
1536 '_date', @date_type, '', '',
1537 'seconds', 'int', '', '', '', '', #uhhhh
1538 'support', 'int', '', '', '', '',
1540 'primary_key' => 'svcrtid',
1542 'index' => [ ['svcnum', 'transaction_id'] ],
1547 # 'svcnum', 'int', '', '',
1548 # 'amount', @money_type,
1550 # 'primary_key' => 'svcnum',
1551 # 'unique' => [ [] ],
1552 # 'index' => [ [] ],
1557 'svcnum', 'int', '', '', '', '',
1558 'domain', 'varchar', '', $char_d, '', '',
1559 'suffix', 'varchar', 'NULL', $char_d, '', '',
1560 'catchall', 'int', 'NULL', '', '', '',
1561 'parent_svcnum', 'int', 'NULL', '', '', '',
1562 'registrarnum', 'int', 'NULL', '', '', '',
1563 'registrarkey', 'varchar', 'NULL', 512, '', '',
1564 'setup_date', @date_type, '', '',
1565 'renewal_interval', 'int', 'NULL', '', '', '',
1566 'expiration_date', @date_type, '', '',
1567 #communigate pro fields (quota = MaxAccountSize)
1568 'max_accounts', 'int', 'NULL', '', '', '',
1569 'trailer', 'text', 'NULL', '', '', '',
1570 'cgp_aliases', 'varchar', 'NULL', 255, '', '',
1571 'cgp_accessmodes','varchar','NULL', 255, '', '', #DomainAccessModes
1573 'acct_def_password_selfchange', 'char', 'NULL', 1, '', '',
1574 'acct_def_password_recover', 'char', 'NULL', 1, 'Y', '',
1575 'acct_def_cgp_accessmodes', 'varchar', 'NULL', 255, '', '',
1576 'acct_def_quota', 'varchar', 'NULL', $char_d, '', '',
1577 'acct_def_file_quota', 'varchar', 'NULL', $char_d, '', '',
1578 'acct_def_file_maxnum', 'varchar', 'NULL', $char_d, '', '',
1579 'acct_def_file_maxsize', 'varchar', 'NULL', $char_d, '', '',
1580 'acct_def_cgp_rulesallowed', 'varchar', 'NULL', $char_d, '', '',
1581 'acct_def_cgp_rpopallowed', 'char', 'NULL', 1, '', '',
1582 'acct_def_cgp_mailtoall', 'char', 'NULL', 1, '', '',
1583 'acct_def_cgp_addmailtrailer', 'char', 'NULL', 1, '', '',
1584 #XXX archive messages
1586 'acct_def_cgp_deletemode', 'varchar', 'NULL', $char_d, '', '',
1587 'acct_def_cgp_emptytrash', 'varchar', 'NULL', $char_d, '', '',
1588 'acct_def_cgp_language', 'varchar', 'NULL', $char_d, '', '',
1589 'acct_def_cgp_timezone', 'varchar', 'NULL', $char_d, '', '',
1590 'acct_def_cgp_skinname', 'varchar', 'NULL', $char_d, '', '',
1591 'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',
1592 'acct_def_cgp_sendmdnmode', 'varchar', 'NULL', $char_d, '', '',
1594 #XXX rules, archive rule, spam foldering rule(s)
1596 'primary_key' => 'svcnum',
1598 'index' => [ ['domain'] ],
1601 'domain_record' => {
1603 'recnum', 'serial', '', '', '', '',
1604 'svcnum', 'int', '', '', '', '',
1605 'reczone', 'varchar', '', 255, '', '',
1606 'recaf', 'char', '', 2, '', '',
1607 'rectype', 'varchar', '', 5, '', '',
1608 'recdata', 'varchar', '', 255, '', '',
1610 'primary_key' => 'recnum',
1612 'index' => [ ['svcnum'] ],
1617 'registrarnum', 'serial', '', '', '', '',
1618 'registrarname', 'varchar', '', $char_d, '', '',
1620 'primary_key' => 'registrarnum',
1627 'rulenum', 'serial', '', '', '', '',
1628 'name', 'varchar', '', $char_d, '', '',
1629 'comment', 'varchar', 'NULL', $char_d, '', '',
1630 'svcnum', 'int', '', '', '', '',
1631 'priority', 'int', '', '', '', '',
1633 'primary_key' => 'rulenum',
1634 'unique' => [ [ 'svcnum', 'name' ] ],
1635 'index' => [ [ 'svcnum' ] ],
1638 'cgp_rule_condition' => {
1640 'ruleconditionnum', 'serial', '', '', '', '',
1641 'condition', 'varchar', '', $char_d, '', '',
1642 'op', 'varchar', 'NULL', $char_d, '', '',
1643 'params', 'varchar', 'NULL', 255, '', '',
1644 'rulenum', 'int', '', '', '', '',
1646 'primary_key' => 'ruleconditionnum',
1648 'index' => [ [ 'rulenum' ] ],
1651 'cgp_rule_action' => {
1653 'ruleactionnum', 'serial', '', '', '', '',
1654 'action', 'varchar', '', $char_d, '', '',
1655 'params', 'varchar', 'NULL', 255, '', '',
1656 'rulenum', 'int', '', '', '', '',
1658 'primary_key' => 'ruleactionnum',
1660 'index' => [ [ 'rulenum' ] ],
1665 'svcnum', 'int', '', '', '', '',
1666 'srcsvc', 'int', 'NULL', '', '', '',
1667 'src', 'varchar', 'NULL', 255, '', '',
1668 'dstsvc', 'int', 'NULL', '', '', '',
1669 'dst', 'varchar', 'NULL', 255, '', '',
1671 'primary_key' => 'svcnum',
1673 'index' => [ ['srcsvc'], ['dstsvc'] ],
1678 'svcnum', 'int', '', '', '', '',
1679 'recnum', 'int', '', '', '', '',
1680 'usersvc', 'int', 'NULL', '', '', '',
1681 'config', 'text', 'NULL', '', '', '',
1683 'primary_key' => 'svcnum',
1690 # 'svcnum', 'int', '', '',
1691 # 'svcnum', 'int', '', '',
1692 # 'svcnum', 'int', '', '',
1693 # 'worker', 'varchar', '', $char_d,
1694 # '_date', @date_type,
1696 # 'primary_key' => 'svcnum',
1697 # 'unique' => [ [] ],
1698 # 'index' => [ [] ],
1701 'prepay_credit' => {
1703 'prepaynum', 'serial', '', '', '', '',
1704 'identifier', 'varchar', '', $char_d, '', '',
1705 'amount', @money_type, '', '',
1706 'seconds', 'int', 'NULL', '', '', '',
1707 'upbytes', 'bigint', 'NULL', '', '', '',
1708 'downbytes', 'bigint', 'NULL', '', '', '',
1709 'totalbytes', 'bigint', 'NULL', '', '', '',
1710 'agentnum', 'int', 'NULL', '', '', '',
1712 'primary_key' => 'prepaynum',
1713 'unique' => [ ['identifier'] ],
1719 'portnum', 'serial', '', '', '', '',
1720 'ip', 'varchar', 'NULL', 15, '', '',
1721 'nasport', 'int', 'NULL', '', '', '',
1722 'nasnum', 'int', '', '', '', '',
1724 'primary_key' => 'portnum',
1731 'nasnum', 'serial', '', '', '', '',
1732 'nas', 'varchar', '', $char_d, '', '',
1733 'nasip', 'varchar', '', 15, '', '',
1734 'nasfqdn', 'varchar', '', $char_d, '', '',
1735 'last', 'int', '', '', '', '',
1737 'primary_key' => 'nasnum',
1738 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1739 'index' => [ [ 'last' ] ],
1744 # 'sessionnum', 'serial', '', '', '', '',
1745 # 'portnum', 'int', '', '', '', '',
1746 # 'svcnum', 'int', '', '', '', '',
1747 # 'login', @date_type, '', '',
1748 # 'logout', @date_type, '', '',
1750 # 'primary_key' => 'sessionnum',
1752 # 'index' => [ [ 'portnum' ] ],
1757 'jobnum', 'serial', '', '', '', '',
1758 'job', 'varchar', '', 512, '', '',
1759 '_date', 'int', '', '', '', '',
1760 'status', 'varchar', '', $char_d, '', '',
1761 'statustext', 'text', 'NULL', '', '', '',
1762 'svcnum', 'int', 'NULL', '', '', '',
1763 'custnum', 'int', 'NULL', '', '', '',
1764 'secure', 'char', 'NULL', 1, '', '',
1765 'priority', 'int', 'NULL', '', '', '',
1767 'primary_key' => 'jobnum',
1769 'index' => [ [ 'secure' ], [ 'priority' ],
1770 [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1776 'argnum', 'serial', '', '', '', '',
1777 'jobnum', 'int', '', '', '', '',
1778 'frozen', 'char', 'NULL', 1, '', '',
1779 'arg', 'text', 'NULL', '', '', '',
1781 'primary_key' => 'argnum',
1783 'index' => [ [ 'jobnum' ] ],
1788 'dependnum', 'serial', '', '', '', '',
1789 'jobnum', 'int', '', '', '', '',
1790 'depend_jobnum', 'int', '', '', '', '',
1792 'primary_key' => 'dependnum',
1794 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1799 'exportsvcnum' => 'serial', '', '', '', '',
1800 'exportnum' => 'int', '', '', '', '',
1801 'svcpart' => 'int', '', '', '', '',
1803 'primary_key' => 'exportsvcnum',
1804 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1805 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1808 'export_device' => {
1810 'exportdevicenum' => 'serial', '', '', '', '',
1811 'exportnum' => 'int', '', '', '', '',
1812 'devicepart' => 'int', '', '', '', '',
1814 'primary_key' => 'exportdevicenum',
1815 'unique' => [ [ 'exportnum', 'devicepart' ] ],
1816 'index' => [ [ 'exportnum' ], [ 'devicepart' ] ],
1821 'exportnum', 'serial', '', '', '', '',
1822 'machine', 'varchar', '', $char_d, '', '',
1823 'exporttype', 'varchar', '', $char_d, '', '',
1824 'nodomain', 'char', 'NULL', 1, '', '',
1826 'primary_key' => 'exportnum',
1828 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1831 'part_export_option' => {
1833 'optionnum', 'serial', '', '', '', '',
1834 'exportnum', 'int', '', '', '', '',
1835 'optionname', 'varchar', '', $char_d, '', '',
1836 'optionvalue', 'text', 'NULL', '', '', '',
1838 'primary_key' => 'optionnum',
1840 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1843 'radius_usergroup' => {
1845 'usergroupnum', 'serial', '', '', '', '',
1846 'svcnum', 'int', '', '', '', '',
1847 'groupname', 'varchar', '', $char_d, '', '',
1849 'primary_key' => 'usergroupnum',
1851 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1856 'msgnum', 'serial', '', '', '', '',
1857 'msgcode', 'varchar', '', $char_d, '', '',
1858 'locale', 'varchar', '', 16, '', '',
1859 'msg', 'text', '', '', '', '',
1861 'primary_key' => 'msgnum',
1862 'unique' => [ [ 'msgcode', 'locale' ] ],
1866 'cust_tax_exempt' => {
1868 'exemptnum', 'serial', '', '', '', '',
1869 'custnum', 'int', '', '', '', '',
1870 'taxnum', 'int', '', '', '', '',
1871 'year', 'int', '', '', '', '',
1872 'month', 'int', '', '', '', '',
1873 'amount', @money_type, '', '',
1875 'primary_key' => 'exemptnum',
1876 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1880 'cust_tax_exempt_pkg' => {
1882 'exemptpkgnum', 'serial', '', '', '', '',
1883 #'custnum', 'int', '', '', '', ''
1884 'billpkgnum', 'int', '', '', '', '',
1885 'taxnum', 'int', '', '', '', '',
1886 'year', 'int', '', '', '', '',
1887 'month', 'int', '', '', '', '',
1888 'amount', @money_type, '', '',
1890 'primary_key' => 'exemptpkgnum',
1892 'index' => [ [ 'taxnum', 'year', 'month' ],
1900 'routernum', 'serial', '', '', '', '',
1901 'routername', 'varchar', '', $char_d, '', '',
1902 'svcnum', 'int', 'NULL', '', '', '',
1903 'agentnum', 'int', 'NULL', '', '', '',
1905 'primary_key' => 'routernum',
1910 'part_svc_router' => {
1912 'svcrouternum', 'serial', '', '', '', '',
1913 'svcpart', 'int', '', '', '', '',
1914 'routernum', 'int', '', '', '', '',
1916 'primary_key' => 'svcrouternum',
1923 'blocknum', 'serial', '', '', '', '',
1924 'routernum', 'int', '', '', '', '',
1925 'ip_gateway', 'varchar', '', 15, '', '',
1926 'ip_netmask', 'int', '', '', '', '',
1927 'agentnum', 'int', 'NULL', '', '', '',
1928 'manual_flag', 'char', 'NULL', 1, '', '',
1930 'primary_key' => 'blocknum',
1931 'unique' => [ [ 'blocknum', 'routernum' ] ],
1935 'svc_broadband' => {
1937 'svcnum', 'int', '', '', '', '',
1938 'description', 'varchar', 'NULL', $char_d, '', '',
1939 'blocknum', 'int', 'NULL', '', '', '',
1940 'speed_up', 'int', '', '', '', '',
1941 'speed_down', 'int', '', '', '', '',
1942 'ip_addr', 'varchar', 'NULL', 15, '', '',
1943 'mac_addr', 'varchar', 'NULL', 12, '', '',
1944 'authkey', 'varchar', 'NULL', 32, '', '',
1945 'latitude', 'decimal', 'NULL', '', '', '',
1946 'longitude', 'decimal', 'NULL', '', '', '',
1947 'altitude', 'decimal', 'NULL', '', '', '',
1948 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1949 'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1951 'primary_key' => 'svcnum',
1952 'unique' => [ [ 'mac_addr' ] ],
1956 'part_virtual_field' => {
1958 'vfieldpart', 'serial', '', '', '', '',
1959 'dbtable', 'varchar', '', 32, '', '',
1960 'name', 'varchar', '', 32, '', '',
1961 'check_block', 'text', 'NULL', '', '', '',
1962 'length', 'int', 'NULL', '', '', '',
1963 'list_source', 'text', 'NULL', '', '', '',
1964 'label', 'varchar', 'NULL', 80, '', '',
1966 'primary_key' => 'vfieldpart',
1971 'virtual_field' => {
1973 'vfieldnum', 'serial', '', '', '', '',
1974 'recnum', 'int', '', '', '', '',
1975 'vfieldpart', 'int', '', '', '', '',
1976 'value', 'varchar', '', 128, '', '',
1978 'primary_key' => 'vfieldnum',
1979 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1985 'snarfnum', 'int', '', '', '', '',
1986 'svcnum', 'int', '', '', '', '',
1987 'machine', 'varchar', '', 255, '', '',
1988 'protocol', 'varchar', '', $char_d, '', '',
1989 'username', 'varchar', '', $char_d, '', '',
1990 '_password', 'varchar', '', $char_d, '', '',
1992 'primary_key' => 'snarfnum',
1994 'index' => [ [ 'svcnum' ] ],
1999 'svcnum', 'int', '', '', '', '',
2000 'id', 'int', 'NULL', '', '', '',
2001 'title', 'varchar', 'NULL', $char_d, '', '',
2003 'primary_key' => 'svcnum',
2008 'cust_pay_refund' => {
2010 'payrefundnum', 'serial', '', '', '', '',
2011 'paynum', 'int', '', '', '', '',
2012 'refundnum', 'int', '', '', '', '',
2013 '_date', @date_type, '', '',
2014 'amount', @money_type, '', '',
2016 'primary_key' => 'payrefundnum',
2018 'index' => [ ['paynum'], ['refundnum'] ],
2021 'part_pkg_option' => {
2023 'optionnum', 'serial', '', '', '', '',
2024 'pkgpart', 'int', '', '', '', '',
2025 'optionname', 'varchar', '', $char_d, '', '',
2026 'optionvalue', 'text', 'NULL', '', '', '',
2028 'primary_key' => 'optionnum',
2030 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
2033 'part_pkg_report_option' => {
2035 'num', 'serial', '', '', '', '',
2036 'name', 'varchar', '', $char_d, '', '',
2037 'disabled', 'char', 'NULL', 1, '', '',
2039 'primary_key' => 'num',
2040 'unique' => [ [ 'name' ] ],
2041 'index' => [ [ 'disabled' ] ],
2046 'ratenum', 'serial', '', '', '', '',
2047 'ratename', 'varchar', '', $char_d, '', '',
2049 'primary_key' => 'ratenum',
2056 'ratedetailnum', 'serial', '', '', '', '',
2057 'ratenum', 'int', '', '', '', '',
2058 'orig_regionnum', 'int', 'NULL', '', '', '',
2059 'dest_regionnum', 'int', '', '', '', '',
2060 'min_included', 'int', '', '', '', '',
2061 'conn_charge', @money_type, '0', '', #'decimal','','10,5','0','',
2062 'conn_sec', 'int', '', '', '0', '',
2063 'min_charge', 'decimal', '', '10,5', '', '', #@money_type, '', '',
2064 'sec_granularity', 'int', '', '', '', '',
2065 #time period (link to table of periods)?
2066 'classnum', 'int', 'NULL', '', '', '',
2068 'primary_key' => 'ratedetailnum',
2069 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2070 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
2075 'regionnum', 'serial', '', '', '', '',
2076 'regionname', 'varchar', '', $char_d, '', '',
2078 'primary_key' => 'regionnum',
2085 'prefixnum', 'serial', '', '', '', '',
2086 'regionnum', 'int', '', '', '', '',
2087 'countrycode', 'varchar', '', 3, '', '',
2088 'npa', 'varchar', 'NULL', 10, '', '', #actually the whole prefix
2089 'nxx', 'varchar', 'NULL', 3, '', '', #actually not used
2091 'primary_key' => 'prefixnum',
2093 'index' => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2098 'classnum', 'serial', '', '', '', '',
2099 'weight', 'int', 'NULL', '', '', '',
2100 'classname', 'varchar', '', $char_d, '', '',
2101 'format', 'varchar', 'NULL', $char_d, '', '',
2102 'disabled', 'char', 'NULL', 1, '', '',
2104 'primary_key' => 'classnum',
2106 'index' => [ ['disabled'] ],
2111 'codenum', 'serial', '', '', '', '',
2112 'code', 'varchar', '', $char_d, '', '',
2113 'agentnum', 'int', '', '', '', '',
2115 'primary_key' => 'codenum',
2116 'unique' => [ [ 'agentnum', 'code' ] ],
2117 'index' => [ [ 'agentnum' ] ],
2122 'codepkgnum', 'serial', '', '', '', '',
2123 'codenum', 'int', '', '', '', '',
2124 'pkgpart', 'int', '', '', '', '',
2126 'primary_key' => 'codepkgnum',
2127 'unique' => [ [ 'codenum', 'pkgpart' ] ],
2128 'index' => [ [ 'codenum' ] ],
2131 'clientapi_session' => {
2133 'sessionnum', 'serial', '', '', '', '',
2134 'sessionid', 'varchar', '', $char_d, '', '',
2135 'namespace', 'varchar', '', $char_d, '', '',
2137 'primary_key' => 'sessionnum',
2138 'unique' => [ [ 'sessionid', 'namespace' ] ],
2142 'clientapi_session_field' => {
2144 'fieldnum', 'serial', '', '', '', '',
2145 'sessionnum', 'int', '', '', '', '',
2146 'fieldname', 'varchar', '', $char_d, '', '',
2147 'fieldvalue', 'text', 'NULL', '', '', '',
2149 'primary_key' => 'fieldnum',
2150 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
2154 'payment_gateway' => {
2156 'gatewaynum', 'serial', '', '', '', '',
2157 'gateway_namespace','varchar', 'NULL', $char_d, '', '',
2158 'gateway_module', 'varchar', '', $char_d, '', '',
2159 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
2160 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
2161 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
2162 'gateway_callback_url', 'varchar', 'NULL', $char_d, '', '',
2163 'disabled', 'char', 'NULL', 1, '', '',
2165 'primary_key' => 'gatewaynum',
2167 'index' => [ [ 'disabled' ] ],
2170 'payment_gateway_option' => {
2172 'optionnum', 'serial', '', '', '', '',
2173 'gatewaynum', 'int', '', '', '', '',
2174 'optionname', 'varchar', '', $char_d, '', '',
2175 'optionvalue', 'text', 'NULL', '', '', '',
2177 'primary_key' => 'optionnum',
2179 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2182 'agent_payment_gateway' => {
2184 'agentgatewaynum', 'serial', '', '', '', '',
2185 'agentnum', 'int', '', '', '', '',
2186 'gatewaynum', 'int', '', '', '', '',
2187 'cardtype', 'varchar', 'NULL', $char_d, '', '',
2188 'taxclass', 'varchar', 'NULL', $char_d, '', '',
2190 'primary_key' => 'agentgatewaynum',
2192 'index' => [ [ 'agentnum', 'cardtype' ], ],
2197 'bannum', 'serial', '', '', '', '',
2198 'payby', 'char', '', 4, '', '',
2199 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
2200 #'paymask', 'varchar', 'NULL', $char_d, '', ''
2201 '_date', @date_type, '', '',
2202 'otaker', 'varchar', '', 32, '', '',
2203 'reason', 'varchar', 'NULL', $char_d, '', '',
2205 'primary_key' => 'bannum',
2206 'unique' => [ [ 'payby', 'payinfo' ] ],
2212 'categorynum', 'serial', '', '', '', '',
2213 'categoryname', 'varchar', '', $char_d, '', '',
2214 'weight', 'int', 'NULL', '', '', '',
2215 'condense', 'char', 'NULL', 1, '', '',
2216 'disabled', 'char', 'NULL', 1, '', '',
2218 'primary_key' => 'categorynum',
2220 'index' => [ ['disabled'] ],
2225 'classnum', 'serial', '', '', '', '',
2226 'classname', 'varchar', '', $char_d, '', '',
2227 'categorynum', 'int', 'NULL', '', '', '',
2228 'disabled', 'char', 'NULL', 1, '', '',
2230 'primary_key' => 'classnum',
2232 'index' => [ ['disabled'] ],
2237 # qw( name type null length default local );
2243 'acctid', 'bigserial', '', '', '', '',
2244 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2245 'calldate', 'timestamp', '', '', \'now()', '',
2246 'clid', 'varchar', '', $char_d, \"''", '',
2247 'src', 'varchar', '', $char_d, \"''", '',
2248 'dst', 'varchar', '', $char_d, \"''", '',
2249 'dcontext', 'varchar', '', $char_d, \"''", '',
2250 'channel', 'varchar', '', $char_d, \"''", '',
2251 'dstchannel', 'varchar', '', $char_d, \"''", '',
2252 'lastapp', 'varchar', '', $char_d, \"''", '',
2253 'lastdata', 'varchar', '', $char_d, \"''", '',
2255 #these don't seem to be logged by most of the SQL cdr_* modules
2256 #except tds under sql-illegal names, so;
2257 # ... don't rely on them for rating?
2258 # and, what they hey, i went ahead and changed the names and data types
2259 # to freeside-style dates...
2260 #'start', 'timestamp', 'NULL', '', '', '',
2261 #'answer', 'timestamp', 'NULL', '', '', '',
2262 #'end', 'timestamp', 'NULL', '', '', '',
2263 'startdate', @date_type, '', '',
2264 'answerdate', @date_type, '', '',
2265 'enddate', @date_type, '', '',
2268 'duration', 'int', '', '', 0, '',
2269 'billsec', 'int', '', '', 0, '',
2270 'disposition', 'varchar', '', 45, \"''", '',
2271 'amaflags', 'int', '', '', 0, '',
2272 'accountcode', 'varchar', '', 20, \"''", '',
2273 'uniqueid', 'varchar', '', 32, \"''", '',
2274 'userfield', 'varchar', '', 255, \"''", '',
2277 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2279 # though these are now used elsewhere:
2280 # charged_party, upstream_price, rated_price, carrierid
2283 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2284 'cdrtypenum', 'int', 'NULL', '', '', '',
2286 'charged_party', 'varchar', 'NULL', $char_d, '', '',
2288 'upstream_currency', 'char', 'NULL', 3, '', '',
2289 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
2290 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
2292 # how it was rated internally...
2293 'ratedetailnum', 'int', 'NULL', '', '', '',
2294 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2296 'distance', 'decimal', 'NULL', '', '', '',
2297 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
2299 #cdr_calltype: the big list in appendix 2
2300 'calltypenum', 'int', 'NULL', '', '', '',
2302 'description', 'varchar', 'NULL', $char_d, '', '',
2303 'quantity', 'int', 'NULL', '', '', '',
2305 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2306 'carrierid', 'int', 'NULL', '', '', '',
2308 'upstream_rateid', 'int', 'NULL', '', '', '',
2311 #and now for our own fields
2314 # a svcnum... right..?
2315 'svcnum', 'int', 'NULL', '', '', '',
2317 #NULL, done (or something)
2318 'freesidestatus', 'varchar', 'NULL', 32, '', '',
2320 #NULL, done (or something)
2321 'freesiderewritestatus', 'varchar', 'NULL', 32, '', '',
2323 #an indexed place to put big numbers
2324 'cdrid', 'bigint', 'NULL', '', '', '',
2327 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2329 'cdrbatchnum', 'int', 'NULL', '', '', '',
2332 'primary_key' => 'acctid',
2334 'index' => [ [ 'calldate' ],
2335 [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2336 [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2337 [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2338 [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2344 'cdrbatchnum', 'serial', '', '', '', '',
2345 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2346 '_date', @date_type, '', '',
2348 'primary_key' => 'cdrbatchnum',
2349 'unique' => [ [ 'cdrbatch' ] ],
2353 'cdr_termination' => {
2355 'cdrtermnum', 'bigserial', '', '', '', '',
2356 'acctid', 'bigint', '', '', '', '',
2357 'termpart', 'int', '', '', '', '',#future use see below
2358 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2359 'status', 'varchar', 'NULL', 32, '', '',
2361 'primary_key' => 'cdrtermnum',
2362 'unique' => [ [ 'acctid', 'termpart' ] ],
2363 'index' => [ [ 'acctid' ], [ 'status' ], ],
2366 #to handle multiple termination/settlement passes...
2367 # 'part_termination' => {
2369 # 'termpart', 'int', '', '', '', '',
2370 # 'termname', 'varchar', '', $char_d, '', '',
2371 # 'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2373 # 'primary_key' => 'termpart',
2378 #the remaining cdr_ tables are not really used
2381 'calltypenum', 'serial', '', '', '', '',
2382 'calltypename', 'varchar', '', $char_d, '', '',
2384 'primary_key' => 'calltypenum',
2391 'cdrtypenum' => 'serial', '', '', '', '',
2392 'cdrtypename' => 'varchar', '', $char_d, '', '',
2394 'primary_key' => 'cdrtypenum',
2401 'carrierid' => 'serial', '', '', '', '',
2402 'carriername' => 'varchar', '', $char_d, '', '',
2404 'primary_key' => 'carrierid',
2411 # 'filenum', 'serial', '', '', '', '',
2412 # 'filename', 'varchar', '', '', '', '',
2413 # 'status', 'varchar', 'NULL', '', '', '',
2415 # 'primary_key' => 'filenum',
2416 # 'unique' => [ [ 'filename' ], ], #just change the index if we need to
2417 # # agent-virtualize or have a customer
2418 # # with dup-filename needs or something
2419 # # (only used by cdr.http_and_import for
2424 'inventory_item' => {
2426 'itemnum', 'serial', '', '', '', '',
2427 'classnum', 'int', '', '', '', '',
2428 'item', 'varchar', '', $char_d, '', '',
2429 'svcnum', 'int', 'NULL', '', '', '',
2431 'primary_key' => 'itemnum',
2432 'unique' => [ [ 'classnum', 'item' ] ],
2433 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2436 'inventory_class' => {
2438 'classnum', 'serial', '', '', '', '',
2439 'classname', 'varchar', '', $char_d, '', '',
2441 'primary_key' => 'classnum',
2448 'usernum', 'serial', '', '', '', '',
2449 'username', 'varchar', '', $char_d, '', '',
2450 '_password', 'varchar', '', $char_d, '', '',
2451 'last', 'varchar', '', $char_d, '', '',
2452 'first', 'varchar', '', $char_d, '', '',
2453 'user_custnum', 'int', 'NULL', '', '', '',
2454 'disabled', 'char', 'NULL', 1, '', '',
2456 'primary_key' => 'usernum',
2457 'unique' => [ [ 'username' ] ],
2458 'index' => [ [ 'user_custnum' ] ],
2461 'access_user_pref' => {
2463 'prefnum', 'serial', '', '', '', '',
2464 'usernum', 'int', '', '', '', '',
2465 'prefname', 'varchar', '', $char_d, '', '',
2466 'prefvalue', 'text', 'NULL', '', '', '',
2467 'expiration', @date_type, '', '',
2469 'primary_key' => 'prefnum',
2471 'index' => [ [ 'usernum' ] ],
2476 'groupnum', 'serial', '', '', '', '',
2477 'groupname', 'varchar', '', $char_d, '', '',
2479 'primary_key' => 'groupnum',
2480 'unique' => [ [ 'groupname' ] ],
2484 'access_usergroup' => {
2486 'usergroupnum', 'serial', '', '', '', '',
2487 'usernum', 'int', '', '', '', '',
2488 'groupnum', 'int', '', '', '', '',
2490 'primary_key' => 'usergroupnum',
2491 'unique' => [ [ 'usernum', 'groupnum' ] ],
2492 'index' => [ [ 'usernum' ] ],
2495 'access_groupagent' => {
2497 'groupagentnum', 'serial', '', '', '', '',
2498 'groupnum', 'int', '', '', '', '',
2499 'agentnum', 'int', '', '', '', '',
2501 'primary_key' => 'groupagentnum',
2502 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2503 'index' => [ [ 'groupnum' ] ],
2508 'rightnum', 'serial', '', '', '', '',
2509 'righttype', 'varchar', '', $char_d, '', '',
2510 'rightobjnum', 'int', '', '', '', '',
2511 'rightname', 'varchar', '', $char_d, '', '',
2513 'primary_key' => 'rightnum',
2514 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2520 'svcnum', 'int', '', '', '', '',
2521 'countrycode', 'varchar', '', 3, '', '',
2522 'phonenum', 'varchar', '', 15, '', '', #12 ?
2523 'pin', 'varchar', 'NULL', $char_d, '', '',
2524 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2525 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2526 'pbxsvc', 'int', 'NULL', '', '', '',
2527 'domsvc', 'int', 'NULL', '', '', '',
2528 'locationnum', 'int', 'NULL', '', '', '',
2530 'primary_key' => 'svcnum',
2532 'index' => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
2539 'devicenum', 'serial', '', '', '', '',
2540 'devicepart', 'int', '', '', '', '',
2541 'svcnum', 'int', '', '', '', '',
2542 'mac_addr', 'varchar', 'NULL', 12, '', '',
2544 'primary_key' => 'devicenum',
2545 'unique' => [ [ 'mac_addr' ], ],
2546 'index' => [ [ 'devicepart' ], [ 'svcnum' ], ],
2551 'devicepart', 'serial', '', '', '', '',
2552 'devicename', 'varchar', '', $char_d, '', '',
2553 #'classnum', #tie to an inventory class?
2555 'primary_key' => 'devicepart',
2556 'unique' => [ [ 'devicename' ] ], #?
2562 'availnum', 'serial', '', '', '', '',
2563 'exportnum', 'int', '', '', '', '',
2564 'countrycode', 'varchar', '', 3, '', '',
2565 'state', 'char', 'NULL', 2, '', '',
2566 'npa', 'char', '', 3, '', '',
2567 'nxx', 'char', 'NULL', 3, '', '',
2568 'station', 'char', 'NULL', 4, '', '',
2569 'name', 'varchar', 'NULL', $char_d, '', '',
2570 'svcnum', 'int', 'NULL', '', '', '',
2571 'availbatch', 'varchar', 'NULL', $char_d, '', '',
2573 'primary_key' => 'availnum',
2575 'index' => [ [ 'exportnum', 'countrycode', 'state' ], #npa search
2576 [ 'exportnum', 'countrycode', 'npa' ], #nxx search
2577 [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2578 [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2586 'typenum', 'serial', '', '', '', '',
2587 'class', 'char', '', 1, '', '',
2588 'type', 'varchar', '', $char_d, '', '',
2590 'primary_key' => 'typenum',
2597 'reasonnum', 'serial', '', '', '', '',
2598 'reason_type', 'int', '', '', '', '',
2599 'reason', 'text', '', '', '', '',
2600 'disabled', 'char', 'NULL', 1, '', '',
2602 'primary_key' => 'reasonnum',
2609 'confnum', 'serial', '', '', '', '',
2610 'agentnum', 'int', 'NULL', '', '', '',
2611 'name', 'varchar', '', $char_d, '', '',
2612 'value', 'text', 'NULL', '', '', '',
2614 'primary_key' => 'confnum',
2615 'unique' => [ [ 'agentnum', 'name' ]],
2621 'pkgrefnum', 'serial', '', '', '', '',
2622 'pkgnum', 'int', '', '', '', '',
2623 'refnum', 'int', '', '', '', '',
2625 'primary_key' => 'pkgrefnum',
2626 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2627 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2632 'svcnum', 'int', '', '', '', '',
2633 'id', 'int', 'NULL', '', '', '',
2634 'title', 'varchar', 'NULL', $char_d, '', '',
2635 'max_extensions', 'int', 'NULL', '', '', '',
2637 'primary_key' => 'svcnum',
2639 'index' => [ [ 'id' ] ],
2642 'svc_mailinglist' => { #svc_group?
2644 'svcnum', 'int', '', '', '', '',
2645 'username', 'varchar', '', $username_len, '', '',
2646 'domsvc', 'int', '', '', '', '',
2647 'listnum', 'int', '', '', '', '',
2648 'reply_to', 'char', 'NULL', 1, '', '',#SetReplyTo
2649 'remove_from', 'char', 'NULL', 1, '', '',#RemoveAuthor
2650 'reject_auto', 'char', 'NULL', 1, '', '',#RejectAuto
2651 'remove_to_and_cc', 'char', 'NULL', 1, '', '',#RemoveToAndCc
2653 'primary_key' => 'svcnum',
2655 'index' => [ ['username'], ['domsvc'], ['listnum'] ],
2660 'listnum', 'serial', '', '', '', '',
2661 'listname', 'varchar', '', $char_d, '', '',
2663 'primary_key' => 'listnum',
2668 'mailinglistmember' => {
2670 'membernum', 'serial', '', '', '', '',
2671 'listnum', 'int', '', '', '', '',
2672 'svcnum', 'int', 'NULL', '', '', '',
2673 'email', 'varchar', 'NULL', 255, '', '',
2675 'primary_key' => 'membernum',
2677 'index' => [['listnum'],['svcnum'],['email']],
2681 # name type nullability length default local
2685 # 'num', 'serial', '', '', '', '',
2687 # 'primary_key' => 'num',