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 unless ( defined $hash{'default'} ) {
106 warn "$tablename:\n".
107 join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
110 push @columns, new DBIx::DBSchema::Column ( \%hash );
113 #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
114 #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
115 my $unique = $tables_hashref->{$tablename}{'unique'};
116 my $index = $tables_hashref->{$tablename}{'index'};
119 DBIx::DBSchema::Index->new({
120 'name' => $tablename. $indexnum++,
127 DBIx::DBSchema::Index->new({
128 'name' => $tablename. $indexnum++,
135 DBIx::DBSchema::Table->new({
136 'name' => $tablename,
137 'primary_key' => $tables_hashref->{$tablename}{'primary_key'},
138 'columns' => \@columns,
139 'indices' => \@indices,
140 'local_options' => $local_options,
143 } keys %$tables_hashref;
146 warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
147 warn "[debug]$me $_\n" foreach $dbdef->tables;
150 #add radius attributes to svc_acct
152 #my($svc_acct)=$dbdef->table('svc_acct');
155 #foreach $attribute (@attributes) {
156 # $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
157 # 'radius_'. $attribute,
164 #foreach $attribute (@check_attributes) {
165 # $svc_acct->addcolumn( new DBIx::DBSchema::Column (
173 #create history tables (false laziness w/create-history-tables)
175 grep { ! /^clientapi_session/ }
179 my $tableobj = $dbdef->table($table)
180 or die "unknown table $table";
182 my %indices = $tableobj->indices;
184 my %h_indices = map {
186 DBIx::DBSchema::Index->new({
187 'name' => 'h_'. $indices{$_}->name,
189 'columns' => [ @{$indices{$_}->columns} ],
195 $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
196 'name' => "h_${table}_srckey",
198 'columns' => [ 'history_action', #right?
199 $tableobj->primary_key,
203 my $h_tableobj = DBIx::DBSchema::Table->new( {
204 'name' => "h_$table",
205 'primary_key' => 'historynum',
206 'indices' => \%h_indices,
207 'local_options' => $local_options,
209 DBIx::DBSchema::Column->new( {
210 'name' => 'historynum',
212 'null' => 'NOT NULL',
217 DBIx::DBSchema::Column->new( {
218 'name' => 'history_date',
225 DBIx::DBSchema::Column->new( {
226 'name' => 'history_user',
228 'null' => 'NOT NULL',
233 DBIx::DBSchema::Column->new( {
234 'name' => 'history_action',
236 'null' => 'NOT NULL',
242 my $column = $tableobj->column($_);
244 #clone so as to not disturb the original
245 $column = DBIx::DBSchema::Column->new( {
246 map { $_ => $column->$_() }
247 qw( name type null length default local )
250 if ( $column->type =~ /^(\w*)SERIAL$/i ) {
251 $column->type('int');
252 $column->null('NULL');
254 #$column->default('')
255 # if $column->default =~ /^nextval\(/i;
256 #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
257 #$column->local($local);
262 $dbdef->addtable($h_tableobj);
265 if ( $datasrc =~ /^dbi:mysql/i ) {
267 my $dup_lock_table = DBIx::DBSchema::Table->new( {
268 'name' => 'duplicate_lock',
269 'primary_key' => 'duplocknum',
270 'local_options' => $local_options,
272 DBIx::DBSchema::Column->new( {
273 'name' => 'duplocknum',
275 'null' => 'NOT NULL',
280 DBIx::DBSchema::Column->new( {
281 'name' => 'lockname',
283 'null' => 'NOT NULL',
289 'indices' => { 'duplicate_lock1' =>
290 DBIx::DBSchema::Index->new({
291 'name' => 'duplicate_lock1',
293 'columns' => [ 'lockname' ],
298 $dbdef->addtable($dup_lock_table);
308 my $char_d = 80; #default maxlength for text fields
310 #my(@date_type) = ( 'timestamp', '', '' );
311 my @date_type = ( 'int', 'NULL', '' );
312 my @perl_type = ( 'text', 'NULL', '' );
313 my @money_type = ( 'decimal', '', '10,2' );
314 my @money_typen = ( 'decimal', 'NULL', '10,2' );
316 my $username_len = 32; #usernamemax config file
318 # name type nullability length default local
324 'agentnum', 'serial', '', '', '', '',
325 'agent', 'varchar', '', $char_d, '', '',
326 'typenum', 'int', '', '', '', '',
327 'disabled', 'char', 'NULL', 1, '', '',
328 'ticketing_queueid', 'int', 'NULL', '', '', '',
329 'invoice_template', 'varchar', 'NULL', $char_d, '', '',
330 'username', 'varchar', 'NULL', $char_d, '', '', #deprecated
331 '_password', 'varchar', 'NULL', $char_d, '', '', #deprecated
332 'freq', 'int', 'NULL', '', '', '', #deprecated (never used)
333 'prog', @perl_type, '', '', #deprecated (never used)
336 'primary_key' => 'agentnum',
338 'index' => [ ['typenum'], ['disabled'] ],
343 'typenum', 'serial', '', '', '', '',
344 'atype', 'varchar', '', $char_d, '', '',
346 'primary_key' => 'typenum',
353 'typepkgnum', 'serial', '', '', '', '',
354 'typenum', 'int', '', '', '', '',
355 'pkgpart', 'int', '', '', '', '',
357 'primary_key' => 'typepkgnum',
358 'unique' => [ ['typenum', 'pkgpart'] ],
359 'index' => [ ['typenum'] ],
364 'invnum', 'serial', '', '', '', '',
365 'custnum', 'int', '', '', '', '',
366 '_date', @date_type, '', '',
367 'charged', @money_type, '', '',
368 'printed', 'int', '', '', '', '',
369 'closed', 'char', 'NULL', 1, '', '',
371 'primary_key' => 'invnum',
373 'index' => [ ['custnum'], ['_date'] ],
376 'cust_bill_event' => {
378 'eventnum', 'serial', '', '', '', '',
379 'invnum', 'int', '', '', '', '',
380 'eventpart', 'int', '', '', '', '',
381 '_date', @date_type, '', '',
382 'status', 'varchar', '', $char_d, '', '',
383 'statustext', 'text', 'NULL', '', '', '',
385 'primary_key' => 'eventnum',
386 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
388 'index' => [ ['invnum'], ['status'] ],
391 'part_bill_event' => {
393 'eventpart', 'serial', '', '', '', '',
394 'freq', 'varchar', 'NULL', $char_d, '', '',
395 'payby', 'char', '', 4, '', '',
396 'event', 'varchar', '', $char_d, '', '',
397 'eventcode', @perl_type, '', '',
398 'seconds', 'int', 'NULL', '', '', '',
399 'weight', 'int', '', '', '', '',
400 'plan', 'varchar', 'NULL', $char_d, '', '',
401 'plandata', 'text', 'NULL', '', '', '',
402 'reason', 'int', 'NULL', '', '', '',
403 'disabled', 'char', 'NULL', 1, '', '',
405 'primary_key' => 'eventpart',
407 'index' => [ ['payby'], ['disabled'], ],
412 'eventpart', 'serial', '', '', '', '',
413 'agentnum', 'int', 'NULL', '', '', '',
414 'event', 'varchar', '', $char_d, '', '',
415 'eventtable', 'varchar', '', $char_d, '', '',
416 'check_freq', 'varchar', 'NULL', $char_d, '', '',
417 'weight', 'int', '', '', '', '',
418 'action', 'varchar', '', $char_d, '', '',
419 'disabled', 'char', 'NULL', 1, '', '',
421 'primary_key' => 'eventpart',
423 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
426 'part_event_option' => {
428 'optionnum', 'serial', '', '', '', '',
429 'eventpart', 'int', '', '', '', '',
430 'optionname', 'varchar', '', $char_d, '', '',
431 'optionvalue', 'text', 'NULL', '', '', '',
433 'primary_key' => 'optionnum',
435 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
438 'part_event_condition' => {
440 'eventconditionnum', 'serial', '', '', '', '',
441 'eventpart', 'int', '', '', '', '',
442 'conditionname', 'varchar', '', $char_d, '', '',
444 'primary_key' => 'eventconditionnum',
446 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
449 'part_event_condition_option' => {
451 'optionnum', 'serial', '', '', '', '',
452 'eventconditionnum', 'int', '', '', '', '',
453 'optionname', 'varchar', '', $char_d, '', '',
454 'optionvalue', 'text', 'NULL', '', '', '',
456 'primary_key' => 'optionnum',
458 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
461 'part_event_condition_option_option' => {
463 'optionoptionnum', 'serial', '', '', '', '',
464 'optionnum', 'int', '', '', '', '',
465 'optionname', 'varchar', '', $char_d, '', '',
466 'optionvalue', 'text', 'NULL', '', '', '',
468 'primary_key' => 'optionoptionnum',
470 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
475 'eventnum', 'serial', '', '', '', '',
476 'eventpart', 'int', '', '', '', '',
477 'tablenum', 'int', '', '', '', '',
478 '_date', @date_type, '', '',
479 'status', 'varchar', '', $char_d, '', '',
480 'statustext', 'text', 'NULL', '', '', '',
482 'primary_key' => 'eventnum',
483 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
485 'index' => [ ['eventpart'], ['tablenum'], ['status'] ],
490 'billpkgnum', 'serial', '', '', '', '',
491 'pkgnum', 'int', '', '', '', '',
492 'pkgpart_override', 'int', 'NULL', '', '', '',
493 'invnum', 'int', '', '', '', '',
494 'setup', @money_type, '', '',
495 'recur', @money_type, '', '',
496 'sdate', @date_type, '', '',
497 'edate', @date_type, '', '',
498 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
499 'section', 'varchar', 'NULL', $char_d, '', '',
500 'quantity', 'int', 'NULL', '', '', '',
501 'unitsetup', @money_typen, '', '',
502 'unitrecur', @money_typen, '', '',
503 'duplicate', 'char', 'NULL', 1, '', '', # does this need to be in db?
504 'post_total', 'char', 'NULL', 1, '', '',
506 'primary_key' => 'billpkgnum',
508 'index' => [ ['invnum'], [ 'pkgnum' ] ],
511 'cust_bill_pkg_detail' => {
513 'detailnum', 'serial', '', '', '', '',
514 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
515 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
516 'invnum', 'int', 'NULL', '', '', '', # deprecated
517 'format', 'char', 'NULL', 1, '', '',
518 'detail', 'varchar', '', $char_d, '', '',
520 'primary_key' => 'detailnum',
522 'index' => [ [ 'billpkgnum' ], [ 'pkgnum', 'invnum' ] ],
527 'crednum', 'serial', '', '', '', '',
528 'custnum', 'int', '', '', '', '',
529 '_date', @date_type, '', '',
530 'amount', @money_type, '', '',
531 'otaker', 'varchar', '', 32, '', '',
532 'reason', 'text', 'NULL', '', '', '',
533 'reasonnum', 'int', 'NULL', '', '', '',
534 'closed', 'char', 'NULL', 1, '', '',
536 'primary_key' => 'crednum',
538 'index' => [ ['custnum'], ['_date'] ],
541 'cust_credit_bill' => {
543 'creditbillnum', 'serial', '', '', '', '',
544 'crednum', 'int', '', '', '', '',
545 'invnum', 'int', '', '', '', '',
546 '_date', @date_type, '', '',
547 'amount', @money_type, '', '',
549 'primary_key' => 'creditbillnum',
551 'index' => [ ['crednum'], ['invnum'] ],
554 'cust_credit_bill_pkg' => {
556 'creditbillpkgnum', 'serial', '', '', '', '',
557 'creditbillnum', 'int', '', '', '', '',
558 'billpkgnum', 'int', '', '', '', '',
559 'amount', @money_type, '', '',
560 'setuprecur', 'varchar', '', $char_d, '', '',
561 'sdate', @date_type, '', '',
562 'edate', @date_type, '', '',
564 'primary_key' => 'creditbillpkgnum',
566 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
571 'custnum', 'serial', '', '', '', '',
572 'agentnum', 'int', '', '', '', '',
573 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
574 'custbatch', 'varchar', 'NULL', $char_d, '', '',
575 # 'titlenum', 'int', 'NULL', '', '', '',
576 'last', 'varchar', '', $char_d, '', '',
577 # 'middle', 'varchar', 'NULL', $char_d, '', '',
578 'first', 'varchar', '', $char_d, '', '',
579 'ss', 'varchar', 'NULL', 11, '', '',
580 'stateid', 'varchar', 'NULL', $char_d, '', '',
581 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
582 'birthdate' ,@date_type, '', '',
583 'signupdate',@date_type, '', '',
584 'company', 'varchar', 'NULL', $char_d, '', '',
585 'address1', 'varchar', '', $char_d, '', '',
586 'address2', 'varchar', 'NULL', $char_d, '', '',
587 'city', 'varchar', '', $char_d, '', '',
588 'county', 'varchar', 'NULL', $char_d, '', '',
589 'state', 'varchar', 'NULL', $char_d, '', '',
590 'zip', 'varchar', 'NULL', 10, '', '',
591 'country', 'char', '', 2, '', '',
592 'daytime', 'varchar', 'NULL', 20, '', '',
593 'night', 'varchar', 'NULL', 20, '', '',
594 'fax', 'varchar', 'NULL', 12, '', '',
595 'ship_last', 'varchar', 'NULL', $char_d, '', '',
596 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
597 'ship_first', 'varchar', 'NULL', $char_d, '', '',
598 'ship_company', 'varchar', 'NULL', $char_d, '', '',
599 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
600 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
601 'ship_city', 'varchar', 'NULL', $char_d, '', '',
602 'ship_county', 'varchar', 'NULL', $char_d, '', '',
603 'ship_state', 'varchar', 'NULL', $char_d, '', '',
604 'ship_zip', 'varchar', 'NULL', 10, '', '',
605 'ship_country', 'char', 'NULL', 2, '', '',
606 'ship_daytime', 'varchar', 'NULL', 20, '', '',
607 'ship_night', 'varchar', 'NULL', 20, '', '',
608 'ship_fax', 'varchar', 'NULL', 12, '', '',
609 'payby', 'char', '', 4, '', '',
610 'payinfo', 'varchar', 'NULL', 512, '', '',
611 'paycvv', 'varchar', 'NULL', 512, '', '',
612 'paymask', 'varchar', 'NULL', $char_d, '', '',
613 #'paydate', @date_type, '', '',
614 'paydate', 'varchar', 'NULL', 10, '', '',
615 'paystart_month', 'int', 'NULL', '', '', '',
616 'paystart_year', 'int', 'NULL', '', '', '',
617 'payissue', 'varchar', 'NULL', 2, '', '',
618 'payname', 'varchar', 'NULL', $char_d, '', '',
619 'paystate', 'varchar', 'NULL', $char_d, '', '',
620 'paytype', 'varchar', 'NULL', $char_d, '', '',
621 'payip', 'varchar', 'NULL', 15, '', '',
622 'tax', 'char', 'NULL', 1, '', '',
623 'otaker', 'varchar', '', 32, '', '',
624 'refnum', 'int', '', '', '', '',
625 'referral_custnum', 'int', 'NULL', '', '', '',
626 'comments', 'text', 'NULL', '', '', '',
627 'spool_cdr','char', 'NULL', 1, '', '',
628 'squelch_cdr','char', 'NULL', 1, '', '',
629 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
631 'primary_key' => 'custnum',
632 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
633 #'index' => [ ['last'], ['company'] ],
634 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
635 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
636 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
637 [ 'ship_last' ], [ 'ship_company' ],
638 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
639 [ 'payby' ], [ 'paydate' ],
640 [ 'agentnum' ], [ 'custbatch' ],
644 'cust_main_invoice' => {
646 'destnum', 'serial', '', '', '', '',
647 'custnum', 'int', '', '', '', '',
648 'dest', 'varchar', '', $char_d, '', '',
650 'primary_key' => 'destnum',
652 'index' => [ ['custnum'], ],
655 'cust_main_note' => {
657 'notenum', 'serial', '', '', '', '',
658 'custnum', 'int', '', '', '', '',
659 '_date', @date_type, '', '',
660 'otaker', 'varchar', '', 32, '', '',
661 'comments', 'text', 'NULL', '', '', '',
663 'primary_key' => 'notenum',
665 'index' => [ [ 'custnum' ], [ '_date' ], ],
668 'cust_main_county' => { #county+state+country are checked off the
669 #cust_main_county for validation and to provide
672 'taxnum', 'serial', '', '', '', '',
673 'state', 'varchar', 'NULL', $char_d, '', '',
674 'county', 'varchar', 'NULL', $char_d, '', '',
675 'country', 'char', '', 2, '', '',
676 'taxclass', 'varchar', 'NULL', $char_d, '', '',
677 'exempt_amount', @money_type, '', '',
678 'tax', 'real', '', '', '', '', #tax %
679 'taxname', 'varchar', 'NULL', $char_d, '', '',
680 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
681 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
683 'primary_key' => 'taxnum',
685 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
686 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
691 'taxnum', 'serial', '', '', '', '',
692 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
693 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
694 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
695 'taxclassnum', 'int', '', '', '', '',
696 'effective_date', @date_type, '', '',
697 'tax', 'real', '', '', '', '', # tax %
698 'excessrate', 'real', 'NULL','', '', '', # second tax %
699 'taxbase', @money_typen, '', '', # amount at first tax rate
700 'taxmax', @money_typen, '', '', # maximum about at both rates
701 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
702 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
703 'unittype', 'int', 'NULL', '', '', '', # for fee
704 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
705 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
706 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
707 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
708 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
709 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
710 'taxauth', 'int', 'NULL', '', '', '', # tax authority
711 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
712 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
713 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
714 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
715 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
716 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
717 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
719 'primary_key' => 'taxnum',
721 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
724 'cust_tax_location' => {
726 'custlocationnum', 'serial', '', '', '', '',
727 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
728 'zip', 'char', '', 5, '', '',
729 'state', 'char', '', 2, '', '',
730 'plus4hi', 'char', '', 4, '', '',
731 'plus4lo', 'char', '', 4, '', '',
732 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
733 'geocode', 'varchar', '', 20, '', '',
735 'primary_key' => 'custlocationnum',
737 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
742 'taxclassnum', 'serial', '', '', '', '',
743 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
744 'taxclass', 'varchar', '', $char_d, '', '',
745 'description', 'varchar', '', 2*$char_d, '', '',
747 'primary_key' => 'taxclassnum',
748 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
752 'cust_pay_pending' => {
754 'paypendingnum','serial', '', '', '', '',
755 'custnum', 'int', '', '', '', '',
756 'paid', @money_type, '', '',
757 '_date', @date_type, '', '',
758 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
759 # be index into payby
761 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
762 'paymask', 'varchar', 'NULL', $char_d, '', '',
763 'paydate', 'varchar', 'NULL', 10, '', '',
764 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
765 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
767 'status', 'varchar', '', $char_d, '', '',
768 'statustext', 'text', 'NULL', '', '', '',
769 'gatewaynum', 'int', 'NULL', '', '', '',
770 #'cust_balance', @money_type, '', '',
771 'paynum', 'int', 'NULL', '', '', '',
773 'primary_key' => 'paypendingnum',
774 'unique' => [ [ 'payunique' ] ],
775 'index' => [ [ 'custnum' ], [ 'status' ], ],
780 'paynum', 'serial', '', '', '', '',
781 'custnum', 'int', '', '', '', '',
782 '_date', @date_type, '', '',
783 'paid', @money_type, '', '',
784 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
785 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
786 # index into payby table
788 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
789 'paymask', 'varchar', 'NULL', $char_d, '', '',
790 'paydate', 'varchar', 'NULL', 10, '', '',
791 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
792 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
793 'closed', 'char', 'NULL', 1, '', '',
795 'primary_key' => 'paynum',
796 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
797 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
802 'paynum', 'int', '', '', '', '',
803 'custnum', 'int', '', '', '', '',
804 'paid', @money_type, '', '',
805 '_date', @date_type, '', '',
806 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
807 # index into payby table
809 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
810 'paymask', 'varchar', 'NULL', $char_d, '', '',
811 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
812 'closed', 'char', 'NULL', 1, '', '',
813 'void_date', @date_type, '', '',
814 'reason', 'varchar', 'NULL', $char_d, '', '',
815 'otaker', 'varchar', '', 32, '', '',
817 'primary_key' => 'paynum',
819 'index' => [ [ 'custnum' ] ],
824 'billpaynum', 'serial', '', '', '', '',
825 'invnum', 'int', '', '', '', '',
826 'paynum', 'int', '', '', '', '',
827 'amount', @money_type, '', '',
828 '_date', @date_type, '', '',
830 'primary_key' => 'billpaynum',
832 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
835 'cust_bill_pay_batch' => {
837 'billpaynum', 'serial', '', '', '', '',
838 'invnum', 'int', '', '', '', '',
839 'paybatchnum', 'int', '', '', '', '',
840 'amount', @money_type, '', '',
841 '_date', @date_type, '', '',
843 'primary_key' => 'billpaynum',
845 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
848 'cust_bill_pay_pkg' => {
850 'billpaypkgnum', 'serial', '', '', '', '',
851 'billpaynum', 'int', '', '', '', '',
852 'billpkgnum', 'int', '', '', '', '',
853 'amount', @money_type, '', '',
854 'setuprecur', 'varchar', '', $char_d, '', '',
855 'sdate', @date_type, '', '',
856 'edate', @date_type, '', '',
858 'primary_key' => 'billpaypkgnum',
860 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
863 'pay_batch' => { #batches of payments to an external processor
865 'batchnum', 'serial', '', '', '', '',
866 'payby', 'char', '', 4, '', '', # CARD/CHEK
867 'status', 'char', 'NULL', 1, '', '',
868 'download', @date_type, '', '',
869 'upload', @date_type, '', '',
871 'primary_key' => 'batchnum',
876 'cust_pay_batch' => { #what's this used for again? list of customers
877 #in current CARD batch? (necessarily CARD?)
879 'paybatchnum', 'serial', '', '', '', '',
880 'batchnum', 'int', '', '', '', '',
881 'invnum', 'int', '', '', '', '',
882 'custnum', 'int', '', '', '', '',
883 'last', 'varchar', '', $char_d, '', '',
884 'first', 'varchar', '', $char_d, '', '',
885 'address1', 'varchar', '', $char_d, '', '',
886 'address2', 'varchar', 'NULL', $char_d, '', '',
887 'city', 'varchar', '', $char_d, '', '',
888 'state', 'varchar', 'NULL', $char_d, '', '',
889 'zip', 'varchar', 'NULL', 10, '', '',
890 'country', 'char', '', 2, '', '',
891 # 'trancode', 'int', '', '', '', ''
892 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
893 'payinfo', 'varchar', '', 512, '', '',
894 #'exp', @date_type, '', ''
895 'exp', 'varchar', 'NULL', 11, '', '',
896 'payname', 'varchar', 'NULL', $char_d, '', '',
897 'amount', @money_type, '', '',
898 'status', 'varchar', 'NULL', $char_d, '', '',
900 'primary_key' => 'paybatchnum',
902 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
907 'pkgnum', 'serial', '', '', '', '',
908 'custnum', 'int', '', '', '', '',
909 'pkgpart', 'int', '', '', '', '',
910 'otaker', 'varchar', '', 32, '', '',
911 'setup', @date_type, '', '',
912 'bill', @date_type, '', '',
913 'last_bill', @date_type, '', '',
914 'susp', @date_type, '', '',
915 'adjourn', @date_type, '', '',
916 'cancel', @date_type, '', '',
917 'expire', @date_type, '', '',
918 'change_date', @date_type, '', '',
919 'change_pkgnum', 'int', 'NULL', '', '', '',
920 'change_pkgpart', 'int', 'NULL', '', '', '',
921 'manual_flag', 'char', 'NULL', 1, '', '',
922 'quantity', 'int', 'NULL', '', '', '',
924 'primary_key' => 'pkgnum',
926 'index' => [ ['custnum'], ['pkgpart'],
927 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
928 ['expire'], ['cancel'],
933 'cust_pkg_option' => {
935 'optionnum', 'serial', '', '', '', '',
936 'pkgnum', 'int', '', '', '', '',
937 'optionname', 'varchar', '', $char_d, '', '',
938 'optionvalue', 'text', 'NULL', '', '', '',
940 'primary_key' => 'optionnum',
942 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
945 'cust_pkg_reason' => {
947 'num', 'serial', '', '', '', '',
948 'pkgnum', 'int', '', '', '', '',
949 'reasonnum','int', '', '', '', '',
950 'action', 'char', 'NULL', 1, '', '', #should not be nullable
951 'otaker', 'varchar', '', 32, '', '',
952 'date', @date_type, '', '',
954 'primary_key' => 'num',
961 'refundnum', 'serial', '', '', '', '',
962 'custnum', 'int', '', '', '', '',
963 '_date', @date_type, '', '',
964 'refund', @money_type, '', '',
965 'otaker', 'varchar', '', 32, '', '',
966 'reason', 'varchar', '', $char_d, '', '',
967 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
968 # be index into payby
970 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
971 'paymask', 'varchar', 'NULL', $char_d, '', '',
972 'paybatch', 'varchar', 'NULL', $char_d, '', '',
973 'closed', 'char', 'NULL', 1, '', '',
975 'primary_key' => 'refundnum',
977 'index' => [ ['custnum'], ['_date'] ],
980 'cust_credit_refund' => {
982 'creditrefundnum', 'serial', '', '', '', '',
983 'crednum', 'int', '', '', '', '',
984 'refundnum', 'int', '', '', '', '',
985 'amount', @money_type, '', '',
986 '_date', @date_type, '', '',
988 'primary_key' => 'creditrefundnum',
990 'index' => [ ['crednum'], ['refundnum'] ],
996 'svcnum', 'serial', '', '', '', '',
997 'pkgnum', 'int', 'NULL', '', '', '',
998 'svcpart', 'int', '', '', '', '',
999 'overlimit', @date_type, '', '',
1001 'primary_key' => 'svcnum',
1003 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1008 'pkgpart', 'serial', '', '', '', '',
1009 'pkg', 'varchar', '', $char_d, '', '',
1010 'comment', 'varchar', '', $char_d, '', '',
1011 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1012 'setup', @perl_type, '', '',
1013 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1014 'recur', @perl_type, '', '',
1015 'setuptax', 'char', 'NULL', 1, '', '',
1016 'recurtax', 'char', 'NULL', 1, '', '',
1017 'plan', 'varchar', 'NULL', $char_d, '', '',
1018 'plandata', 'text', 'NULL', '', '', '',
1019 'disabled', 'char', 'NULL', 1, '', '',
1020 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1021 'classnum', 'int', 'NULL', '', '', '',
1022 'taxproductnum', 'int', 'NULL', '', '', '',
1023 'pay_weight', 'real', 'NULL', '', '', '',
1024 'credit_weight', 'real', 'NULL', '', '', '',
1025 'agentnum', 'int', 'NULL', '', '', '',
1028 'primary_key' => 'pkgpart',
1030 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1033 'part_pkg_link' => {
1035 'pkglinknum', 'serial', '', '', '', '',
1036 'src_pkgpart', 'int', '', '', '', '',
1037 'dst_pkgpart', 'int', '', '', '', '',
1038 'link_type', 'varchar', '', $char_d, '', '',
1040 'primary_key' => 'pkglinknum',
1041 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1042 'index' => [ [ 'src_pkgpart' ] ],
1045 'part_pkg_taxclass' => {
1047 'taxclassnum', 'serial', '', '', '', '',
1048 'taxclass', 'varchar', '', $char_d, '', '',
1050 'primary_key' => 'taxclassnum',
1051 'unique' => [ [ 'taxclass' ] ],
1055 'part_pkg_taxproduct' => {
1057 'taxproductnum', 'serial', '', '', '', '',
1058 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1059 'taxproduct', 'varchar', '', $char_d, '', '',
1060 'description', 'varchar', '', 2*$char_d, '', '',
1062 'primary_key' => 'taxproductnum',
1063 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1067 'part_pkg_taxrate' => {
1069 'pkgtaxratenum', 'serial', '', '', '', '',
1070 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1071 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1072 'taxproductnum', 'int', '', '', '', '',
1073 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1074 'county', 'varchar', 'NULL', $char_d, '', '',
1075 'state', 'varchar', 'NULL', $char_d, '', '',
1076 'local', 'varchar', 'NULL', $char_d, '', '',
1077 'country', 'char', 'NULL', 2, '', '',
1078 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1079 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1080 'taxclassnum', 'int', 'NULL', '', '', '',
1081 'effdate', @date_type, '', '',
1082 'taxable', 'char', 'NULL', 1, '', '',
1084 'primary_key' => 'pkgtaxratenum',
1086 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1089 'part_pkg_taxoverride' => {
1091 'taxoverridenum', 'serial', '', '', '', '',
1092 'pkgpart', 'serial', '', '', '', '',
1093 'taxclassnum', 'serial', '', '', '', '',
1095 'primary_key' => 'taxoverridenum',
1097 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1102 # 'titlenum', 'int', '', '',
1103 # 'title', 'varchar', '', $char_d,
1105 # 'primary_key' => 'titlenum',
1106 # 'unique' => [ [] ],
1107 # 'index' => [ [] ],
1112 'pkgsvcnum', 'serial', '', '', '', '',
1113 'pkgpart', 'int', '', '', '', '',
1114 'svcpart', 'int', '', '', '', '',
1115 'quantity', 'int', '', '', '', '',
1116 'primary_svc','char', 'NULL', 1, '', '',
1118 'primary_key' => 'pkgsvcnum',
1119 'unique' => [ ['pkgpart', 'svcpart'] ],
1120 'index' => [ ['pkgpart'] ],
1123 'part_referral' => {
1125 'refnum', 'serial', '', '', '', '',
1126 'referral', 'varchar', '', $char_d, '', '',
1127 'disabled', 'char', 'NULL', 1, '', '',
1128 'agentnum', 'int', 'NULL', '', '', '',
1130 'primary_key' => 'refnum',
1132 'index' => [ ['disabled'], ['agentnum'], ],
1137 'svcpart', 'serial', '', '', '', '',
1138 'svc', 'varchar', '', $char_d, '', '',
1139 'svcdb', 'varchar', '', $char_d, '', '',
1140 'disabled', 'char', 'NULL', 1, '', '',
1142 'primary_key' => 'svcpart',
1144 'index' => [ [ 'disabled' ] ],
1147 'part_svc_column' => {
1149 'columnnum', 'serial', '', '', '', '',
1150 'svcpart', 'int', '', '', '', '',
1151 'columnname', 'varchar', '', 64, '', '',
1152 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1153 'columnflag', 'char', 'NULL', 1, '', '',
1155 'primary_key' => 'columnnum',
1156 'unique' => [ [ 'svcpart', 'columnname' ] ],
1157 'index' => [ [ 'svcpart' ] ],
1160 #(this should be renamed to part_pop)
1163 'popnum', 'serial', '', '', '', '',
1164 'city', 'varchar', '', $char_d, '', '',
1165 'state', 'varchar', '', $char_d, '', '',
1166 'ac', 'char', '', 3, '', '',
1167 'exch', 'char', '', 3, '', '',
1168 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1170 'primary_key' => 'popnum',
1172 'index' => [ [ 'state' ] ],
1175 'part_pop_local' => {
1177 'localnum', 'serial', '', '', '', '',
1178 'popnum', 'int', '', '', '', '',
1179 'city', 'varchar', 'NULL', $char_d, '', '',
1180 'state', 'char', 'NULL', 2, '', '',
1181 'npa', 'char', '', 3, '', '',
1182 'nxx', 'char', '', 3, '', '',
1184 'primary_key' => 'localnum',
1186 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1191 'svcnum', 'int', '', '', '', '',
1192 'username', 'varchar', '', $username_len, '', '',
1193 '_password', 'varchar', '', 512, '', '',
1194 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1195 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1196 'popnum', 'int', 'NULL', '', '', '',
1197 'uid', 'int', 'NULL', '', '', '',
1198 'gid', 'int', 'NULL', '', '', '',
1199 'finger', 'varchar', 'NULL', $char_d, '', '',
1200 'dir', 'varchar', 'NULL', $char_d, '', '',
1201 'shell', 'varchar', 'NULL', $char_d, '', '',
1202 'quota', 'varchar', 'NULL', $char_d, '', '',
1203 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1204 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1205 'seconds_threshold', 'int', 'NULL', '', '', '',
1206 'upbytes', 'bigint', 'NULL', '', '', '',
1207 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1208 'downbytes', 'bigint', 'NULL', '', '', '',
1209 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1210 'totalbytes','bigint', 'NULL', '', '', '',
1211 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1212 'domsvc', 'int', '', '', '', '',
1213 'last_login', @date_type, '', '',
1214 'last_logout', @date_type, '', '',
1216 'primary_key' => 'svcnum',
1217 #'unique' => [ [ 'username', 'domsvc' ] ],
1219 'index' => [ ['username'], ['domsvc'] ],
1222 'acct_rt_transaction' => {
1224 'svcrtid', 'int', '', '', '', '',
1225 'svcnum', 'int', '', '', '', '',
1226 'transaction_id', 'int', '', '', '', '',
1227 '_date', @date_type, '', '',
1228 'seconds', 'int', '', '', '', '', #uhhhh
1229 'support', 'int', '', '', '', '',
1231 'primary_key' => 'svcrtid',
1233 'index' => [ ['svcnum', 'transaction_id'] ],
1238 # 'svcnum', 'int', '', '',
1239 # 'amount', @money_type,
1241 # 'primary_key' => 'svcnum',
1242 # 'unique' => [ [] ],
1243 # 'index' => [ [] ],
1248 'svcnum', 'int', '', '', '', '',
1249 'domain', 'varchar', '', $char_d, '', '',
1250 'suffix', 'varchar', 'NULL', $char_d, '', '',
1251 'catchall', 'int', 'NULL', '', '', '',
1252 'parent_svcnum', 'int', 'NULL', '', '', '',
1253 'registrarnum', 'int', 'NULL', '', '', '',
1254 'registrarkey', 'varchar', 'NULL', 512, '', '',
1255 'setup_date', @date_type, '', '',
1256 'renewal_interval', 'int', 'NULL', '', '', '',
1257 'expiration_date', @date_type, '', '',
1259 'primary_key' => 'svcnum',
1261 'index' => [ ['domain'] ],
1264 'domain_record' => {
1266 'recnum', 'serial', '', '', '', '',
1267 'svcnum', 'int', '', '', '', '',
1268 'reczone', 'varchar', '', 255, '', '',
1269 'recaf', 'char', '', 2, '', '',
1270 'rectype', 'varchar', '', 5, '', '',
1271 'recdata', 'varchar', '', 255, '', '',
1273 'primary_key' => 'recnum',
1275 'index' => [ ['svcnum'] ],
1280 'registrarnum', 'serial', '', '', '', '',
1281 'registrarname', 'varchar', '', $char_d, '', '',
1283 'primary_key' => 'registrarnum',
1290 'svcnum', 'int', '', '', '', '',
1291 'srcsvc', 'int', 'NULL', '', '', '',
1292 'src', 'varchar', 'NULL', 255, '', '',
1293 'dstsvc', 'int', 'NULL', '', '', '',
1294 'dst', 'varchar', 'NULL', 255, '', '',
1296 'primary_key' => 'svcnum',
1298 'index' => [ ['srcsvc'], ['dstsvc'] ],
1303 'svcnum', 'int', '', '', '', '',
1304 'recnum', 'int', '', '', '', '',
1305 'usersvc', 'int', 'NULL', '', '', '',
1306 'config', 'text', 'NULL', '', '', '',
1308 'primary_key' => 'svcnum',
1315 # 'svcnum', 'int', '', '',
1316 # 'svcnum', 'int', '', '',
1317 # 'svcnum', 'int', '', '',
1318 # 'worker', 'varchar', '', $char_d,
1319 # '_date', @date_type,
1321 # 'primary_key' => 'svcnum',
1322 # 'unique' => [ [] ],
1323 # 'index' => [ [] ],
1326 'prepay_credit' => {
1328 'prepaynum', 'serial', '', '', '', '',
1329 'identifier', 'varchar', '', $char_d, '', '',
1330 'amount', @money_type, '', '',
1331 'seconds', 'int', 'NULL', '', '', '',
1332 'upbytes', 'bigint', 'NULL', '', '', '',
1333 'downbytes', 'bigint', 'NULL', '', '', '',
1334 'totalbytes', 'bigint', 'NULL', '', '', '',
1335 'agentnum', 'int', 'NULL', '', '', '',
1337 'primary_key' => 'prepaynum',
1338 'unique' => [ ['identifier'] ],
1344 'portnum', 'serial', '', '', '', '',
1345 'ip', 'varchar', 'NULL', 15, '', '',
1346 'nasport', 'int', 'NULL', '', '', '',
1347 'nasnum', 'int', '', '', '', '',
1349 'primary_key' => 'portnum',
1356 'nasnum', 'serial', '', '', '', '',
1357 'nas', 'varchar', '', $char_d, '', '',
1358 'nasip', 'varchar', '', 15, '', '',
1359 'nasfqdn', 'varchar', '', $char_d, '', '',
1360 'last', 'int', '', '', '', '',
1362 'primary_key' => 'nasnum',
1363 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1364 'index' => [ [ 'last' ] ],
1369 # 'sessionnum', 'serial', '', '', '', '',
1370 # 'portnum', 'int', '', '', '', '',
1371 # 'svcnum', 'int', '', '', '', '',
1372 # 'login', @date_type, '', '',
1373 # 'logout', @date_type, '', '',
1375 # 'primary_key' => 'sessionnum',
1377 # 'index' => [ [ 'portnum' ] ],
1382 'jobnum', 'serial', '', '', '', '',
1383 'job', 'text', '', '', '', '',
1384 '_date', 'int', '', '', '', '',
1385 'status', 'varchar', '', $char_d, '', '',
1386 'statustext', 'text', 'NULL', '', '', '',
1387 'svcnum', 'int', 'NULL', '', '', '',
1388 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1391 'primary_key' => 'jobnum',
1393 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1398 'argnum', 'serial', '', '', '', '',
1399 'jobnum', 'int', '', '', '', '',
1400 'arg', 'text', 'NULL', '', '', '',
1402 'primary_key' => 'argnum',
1404 'index' => [ [ 'jobnum' ] ],
1409 'dependnum', 'serial', '', '', '', '',
1410 'jobnum', 'int', '', '', '', '',
1411 'depend_jobnum', 'int', '', '', '', '',
1413 'primary_key' => 'dependnum',
1415 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1420 'exportsvcnum' => 'serial', '', '', '', '',
1421 'exportnum' => 'int', '', '', '', '',
1422 'svcpart' => 'int', '', '', '', '',
1424 'primary_key' => 'exportsvcnum',
1425 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1426 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1431 'exportnum', 'serial', '', '', '', '',
1432 'machine', 'varchar', '', $char_d, '', '',
1433 'exporttype', 'varchar', '', $char_d, '', '',
1434 'nodomain', 'char', 'NULL', 1, '', '',
1436 'primary_key' => 'exportnum',
1438 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1441 'part_export_option' => {
1443 'optionnum', 'serial', '', '', '', '',
1444 'exportnum', 'int', '', '', '', '',
1445 'optionname', 'varchar', '', $char_d, '', '',
1446 'optionvalue', 'text', 'NULL', '', '', '',
1448 'primary_key' => 'optionnum',
1450 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1453 'radius_usergroup' => {
1455 'usergroupnum', 'serial', '', '', '', '',
1456 'svcnum', 'int', '', '', '', '',
1457 'groupname', 'varchar', '', $char_d, '', '',
1459 'primary_key' => 'usergroupnum',
1461 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1466 'msgnum', 'serial', '', '', '', '',
1467 'msgcode', 'varchar', '', $char_d, '', '',
1468 'locale', 'varchar', '', 16, '', '',
1469 'msg', 'text', '', '', '', '',
1471 'primary_key' => 'msgnum',
1472 'unique' => [ [ 'msgcode', 'locale' ] ],
1476 'cust_tax_exempt' => {
1478 'exemptnum', 'serial', '', '', '', '',
1479 'custnum', 'int', '', '', '', '',
1480 'taxnum', 'int', '', '', '', '',
1481 'year', 'int', '', '', '', '',
1482 'month', 'int', '', '', '', '',
1483 'amount', @money_type, '', '',
1485 'primary_key' => 'exemptnum',
1486 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1490 'cust_tax_exempt_pkg' => {
1492 'exemptpkgnum', 'serial', '', '', '', '',
1493 #'custnum', 'int', '', '', '', ''
1494 'billpkgnum', 'int', '', '', '', '',
1495 'taxnum', 'int', '', '', '', '',
1496 'year', 'int', '', '', '', '',
1497 'month', 'int', '', '', '', '',
1498 'amount', @money_type, '', '',
1500 'primary_key' => 'exemptpkgnum',
1502 'index' => [ [ 'taxnum', 'year', 'month' ],
1510 'routernum', 'serial', '', '', '', '',
1511 'routername', 'varchar', '', $char_d, '', '',
1512 'svcnum', 'int', 'NULL', '', '', '',
1513 'agentnum', 'int', 'NULL', '', '', '',
1515 'primary_key' => 'routernum',
1520 'part_svc_router' => {
1522 'svcrouternum', 'serial', '', '', '', '',
1523 'svcpart', 'int', '', '', '', '',
1524 'routernum', 'int', '', '', '', '',
1526 'primary_key' => 'svcrouternum',
1533 'blocknum', 'serial', '', '', '', '',
1534 'routernum', 'int', '', '', '', '',
1535 'ip_gateway', 'varchar', '', 15, '', '',
1536 'ip_netmask', 'int', '', '', '', '',
1537 'agentnum', 'int', 'NULL', '', '', '',
1539 'primary_key' => 'blocknum',
1540 'unique' => [ [ 'blocknum', 'routernum' ] ],
1544 'svc_broadband' => {
1546 'svcnum', 'int', '', '', '', '',
1547 'description', 'varchar', 'NULL', $char_d, '', '',
1548 'blocknum', 'int', '', '', '', '',
1549 'speed_up', 'int', '', '', '', '',
1550 'speed_down', 'int', '', '', '', '',
1551 'ip_addr', 'varchar', '', 15, '', '',
1552 'mac_addr', 'varchar', 'NULL', 12, '', '',
1553 'authkey', 'varchar', 'NULL', 32, '', '',
1554 'latitude', 'decimal', 'NULL', '', '', '',
1555 'longitude', 'decimal', 'NULL', '', '', '',
1556 'altitude', 'decimal', 'NULL', '', '', '',
1557 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1559 'primary_key' => 'svcnum',
1564 'part_virtual_field' => {
1566 'vfieldpart', 'serial', '', '', '', '',
1567 'dbtable', 'varchar', '', 32, '', '',
1568 'name', 'varchar', '', 32, '', '',
1569 'check_block', 'text', 'NULL', '', '', '',
1570 'length', 'int', 'NULL', '', '', '',
1571 'list_source', 'text', 'NULL', '', '', '',
1572 'label', 'varchar', 'NULL', 80, '', '',
1574 'primary_key' => 'vfieldpart',
1579 'virtual_field' => {
1581 'vfieldnum', 'serial', '', '', '', '',
1582 'recnum', 'int', '', '', '', '',
1583 'vfieldpart', 'int', '', '', '', '',
1584 'value', 'varchar', '', 128, '', '',
1586 'primary_key' => 'vfieldnum',
1587 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1593 'snarfnum', 'int', '', '', '', '',
1594 'svcnum', 'int', '', '', '', '',
1595 'machine', 'varchar', '', 255, '', '',
1596 'protocol', 'varchar', '', $char_d, '', '',
1597 'username', 'varchar', '', $char_d, '', '',
1598 '_password', 'varchar', '', $char_d, '', '',
1600 'primary_key' => 'snarfnum',
1602 'index' => [ [ 'svcnum' ] ],
1607 'svcnum', 'int', '', '', '', '',
1608 'id', 'int', 'NULL', '', '', '',
1609 'title', 'varchar', 'NULL', $char_d, '', '',
1611 'primary_key' => 'svcnum',
1616 'cust_pay_refund' => {
1618 'payrefundnum', 'serial', '', '', '', '',
1619 'paynum', 'int', '', '', '', '',
1620 'refundnum', 'int', '', '', '', '',
1621 '_date', @date_type, '', '',
1622 'amount', @money_type, '', '',
1624 'primary_key' => 'payrefundnum',
1626 'index' => [ ['paynum'], ['refundnum'] ],
1629 'part_pkg_option' => {
1631 'optionnum', 'serial', '', '', '', '',
1632 'pkgpart', 'int', '', '', '', '',
1633 'optionname', 'varchar', '', $char_d, '', '',
1634 'optionvalue', 'text', 'NULL', '', '', '',
1636 'primary_key' => 'optionnum',
1638 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1643 'ratenum', 'serial', '', '', '', '',
1644 'ratename', 'varchar', '', $char_d, '', '',
1646 'primary_key' => 'ratenum',
1653 'ratedetailnum', 'serial', '', '', '', '',
1654 'ratenum', 'int', '', '', '', '',
1655 'orig_regionnum', 'int', 'NULL', '', '', '',
1656 'dest_regionnum', 'int', '', '', '', '',
1657 'min_included', 'int', '', '', '', '',
1658 #'min_charge', @money_type, '', '',
1659 'min_charge', 'decimal', '', '10,5', '', '',
1660 'sec_granularity', 'int', '', '', '', '',
1661 #time period (link to table of periods)?
1663 'primary_key' => 'ratedetailnum',
1664 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1665 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1670 'regionnum', 'serial', '', '', '', '',
1671 'regionname', 'varchar', '', $char_d, '', '',
1673 'primary_key' => 'regionnum',
1680 'prefixnum', 'serial', '', '', '', '',
1681 'regionnum', 'int', '', '',, '', '',
1682 'countrycode', 'varchar', '', 3, '', '',
1683 'npa', 'varchar', 'NULL', 6, '', '',
1684 'nxx', 'varchar', 'NULL', 3, '', '',
1686 'primary_key' => 'prefixnum',
1688 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1693 'codenum', 'serial', '', '', '', '',
1694 'code', 'varchar', '', $char_d, '', '',
1695 'agentnum', 'int', '', '', '', '',
1697 'primary_key' => 'codenum',
1698 'unique' => [ [ 'agentnum', 'code' ] ],
1699 'index' => [ [ 'agentnum' ] ],
1704 'codepkgnum', 'serial', '', '', '', '',
1705 'codenum', 'int', '', '', '', '',
1706 'pkgpart', 'int', '', '', '', '',
1708 'primary_key' => 'codepkgnum',
1709 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1710 'index' => [ [ 'codenum' ] ],
1713 'clientapi_session' => {
1715 'sessionnum', 'serial', '', '', '', '',
1716 'sessionid', 'varchar', '', $char_d, '', '',
1717 'namespace', 'varchar', '', $char_d, '', '',
1719 'primary_key' => 'sessionnum',
1720 'unique' => [ [ 'sessionid', 'namespace' ] ],
1724 'clientapi_session_field' => {
1726 'fieldnum', 'serial', '', '', '', '',
1727 'sessionnum', 'int', '', '', '', '',
1728 'fieldname', 'varchar', '', $char_d, '', '',
1729 'fieldvalue', 'text', 'NULL', '', '', '',
1731 'primary_key' => 'fieldnum',
1732 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1736 'payment_gateway' => {
1738 'gatewaynum', 'serial', '', '', '', '',
1739 'gateway_module', 'varchar', '', $char_d, '', '',
1740 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1741 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1742 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1743 'disabled', 'char', 'NULL', 1, '', '',
1745 'primary_key' => 'gatewaynum',
1747 'index' => [ [ 'disabled' ] ],
1750 'payment_gateway_option' => {
1752 'optionnum', 'serial', '', '', '', '',
1753 'gatewaynum', 'int', '', '', '', '',
1754 'optionname', 'varchar', '', $char_d, '', '',
1755 'optionvalue', 'text', 'NULL', '', '', '',
1757 'primary_key' => 'optionnum',
1759 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1762 'agent_payment_gateway' => {
1764 'agentgatewaynum', 'serial', '', '', '', '',
1765 'agentnum', 'int', '', '', '', '',
1766 'gatewaynum', 'int', '', '', '', '',
1767 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1768 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1770 'primary_key' => 'agentgatewaynum',
1772 'index' => [ [ 'agentnum', 'cardtype' ], ],
1777 'bannum', 'serial', '', '', '', '',
1778 'payby', 'char', '', 4, '', '',
1779 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1780 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1781 '_date', @date_type, '', '',
1782 'otaker', 'varchar', '', 32, '', '',
1783 'reason', 'varchar', 'NULL', $char_d, '', '',
1785 'primary_key' => 'bannum',
1786 'unique' => [ [ 'payby', 'payinfo' ] ],
1792 'categorynum', 'serial', '', '', '', '',
1793 'categoryname', 'varchar', '', $char_d, '', '',
1794 'disabled', 'char', 'NULL', 1, '', '',
1796 'primary_key' => 'categorynum',
1798 'index' => [ ['disabled'] ],
1803 'classnum', 'serial', '', '', '', '',
1804 'classname', 'varchar', '', $char_d, '', '',
1805 'categorynum', 'int', 'NULL', '', '', '',
1806 'disabled', 'char', 'NULL', 1, '', '',
1808 'primary_key' => 'classnum',
1810 'index' => [ ['disabled'] ],
1815 # qw( name type null length default local );
1821 'acctid', 'bigserial', '', '', '', '',
1822 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1823 'calldate', 'timestamp', '', '', \'now()', '',
1824 'clid', 'varchar', '', $char_d, \"''", '',
1825 'src', 'varchar', '', $char_d, \"''", '',
1826 'dst', 'varchar', '', $char_d, \"''", '',
1827 'dcontext', 'varchar', '', $char_d, \"''", '',
1828 'channel', 'varchar', '', $char_d, \"''", '',
1829 'dstchannel', 'varchar', '', $char_d, \"''", '',
1830 'lastapp', 'varchar', '', $char_d, \"''", '',
1831 'lastdata', 'varchar', '', $char_d, \"''", '',
1833 #these don't seem to be logged by most of the SQL cdr_* modules
1834 #except tds under sql-illegal names, so;
1835 # ... don't rely on them for rating?
1836 # and, what they hey, i went ahead and changed the names and data types
1837 # to freeside-style dates...
1838 #'start', 'timestamp', 'NULL', '', '', '',
1839 #'answer', 'timestamp', 'NULL', '', '', '',
1840 #'end', 'timestamp', 'NULL', '', '', '',
1841 'startdate', @date_type, '', '',
1842 'answerdate', @date_type, '', '',
1843 'enddate', @date_type, '', '',
1846 'duration', 'int', '', '', 0, '',
1847 'billsec', 'int', '', '', 0, '',
1848 'disposition', 'varchar', '', 45, \"''", '',
1849 'amaflags', 'int', '', '', 0, '',
1850 'accountcode', 'varchar', '', 20, \"''", '',
1851 'uniqueid', 'varchar', '', 32, \"''", '',
1852 'userfield', 'varchar', '', 255, \"''", '',
1855 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1859 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1860 'cdrtypenum', 'int', 'NULL', '', '', '',
1862 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1864 'upstream_currency', 'char', 'NULL', 3, '', '',
1865 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1866 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1868 # how it was rated internally...
1869 'ratedetailnum', 'int', 'NULL', '', '', '',
1870 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1872 'distance', 'decimal', 'NULL', '', '', '',
1873 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1875 #cdr_calltype: the big list in appendix 2
1876 'calltypenum', 'int', 'NULL', '', '', '',
1878 'description', 'varchar', 'NULL', $char_d, '', '',
1879 'quantity', 'int', 'NULL', '', '', '',
1881 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1882 'carrierid', 'int', 'NULL', '', '', '',
1884 'upstream_rateid', 'int', 'NULL', '', '', '',
1887 #and now for our own fields
1890 # a svcnum... right..?
1891 'svcnum', 'int', 'NULL', '', '', '',
1893 #NULL, done (or something)
1894 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1897 'primary_key' => 'acctid',
1899 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1904 'calltypenum', 'serial', '', '', '', '',
1905 'calltypename', 'varchar', '', $char_d, '', '',
1907 'primary_key' => 'calltypenum',
1914 'cdrtypenum' => 'serial', '', '', '', '',
1915 'cdrtypename' => 'varchar', '', $char_d, '', '',
1917 'primary_key' => 'cdrtypenum',
1924 'carrierid' => 'serial', '', '', '', '',
1925 'carriername' => 'varchar', '', $char_d, '', '',
1927 'primary_key' => 'carrierid',
1932 #map upstream rateid to ours...
1933 'cdr_upstream_rate' => {
1935 'upstreamratenum', 'serial', '', '', '', '',
1936 'upstream_rateid', 'varchar', '', $char_d, '', '',
1937 'ratedetailnum', 'int', 'NULL', '', '', '',
1939 'primary_key' => 'upstreamratenum', #XXX need a primary key
1940 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1944 'inventory_item' => {
1946 'itemnum', 'serial', '', '', '', '',
1947 'classnum', 'int', '', '', '', '',
1948 'item', 'varchar', '', $char_d, '', '',
1949 'svcnum', 'int', 'NULL', '', '', '',
1951 'primary_key' => 'itemnum',
1952 'unique' => [ [ 'classnum', 'item' ] ],
1953 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1956 'inventory_class' => {
1958 'classnum', 'serial', '', '', '', '',
1959 'classname', 'varchar', '', $char_d, '', '',
1961 'primary_key' => 'classnum',
1968 'usernum', 'serial', '', '', '', '',
1969 'username', 'varchar', '', $char_d, '', '',
1970 '_password', 'varchar', '', $char_d, '', '',
1971 'last', 'varchar', '', $char_d, '', '',
1972 'first', 'varchar', '', $char_d, '', '',
1973 'disabled', 'char', 'NULL', 1, '', '',
1975 'primary_key' => 'usernum',
1976 'unique' => [ [ 'username' ] ],
1980 'access_user_pref' => {
1982 'prefnum', 'serial', '', '', '', '',
1983 'usernum', 'int', '', '', '', '',
1984 'prefname', 'varchar', '', $char_d, '', '',
1985 'prefvalue', 'text', 'NULL', '', '', '',
1986 'expiration', @date_type, '', '',
1988 'primary_key' => 'prefnum',
1990 'index' => [ [ 'usernum' ] ],
1995 'groupnum', 'serial', '', '', '', '',
1996 'groupname', 'varchar', '', $char_d, '', '',
1998 'primary_key' => 'groupnum',
1999 'unique' => [ [ 'groupname' ] ],
2003 'access_usergroup' => {
2005 'usergroupnum', 'serial', '', '', '', '',
2006 'usernum', 'int', '', '', '', '',
2007 'groupnum', 'int', '', '', '', '',
2009 'primary_key' => 'usergroupnum',
2010 'unique' => [ [ 'usernum', 'groupnum' ] ],
2011 'index' => [ [ 'usernum' ] ],
2014 'access_groupagent' => {
2016 'groupagentnum', 'serial', '', '', '', '',
2017 'groupnum', 'int', '', '', '', '',
2018 'agentnum', 'int', '', '', '', '',
2020 'primary_key' => 'groupagentnum',
2021 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2022 'index' => [ [ 'groupnum' ] ],
2027 'rightnum', 'serial', '', '', '', '',
2028 'righttype', 'varchar', '', $char_d, '', '',
2029 'rightobjnum', 'int', '', '', '', '',
2030 'rightname', 'varchar', '', $char_d, '', '',
2032 'primary_key' => 'rightnum',
2033 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2039 'svcnum', 'int', '', '', '', '',
2040 'countrycode', 'varchar', '', 3, '', '',
2041 'phonenum', 'varchar', '', 15, '', '', #12 ?
2042 'pin', 'varchar', 'NULL', $char_d, '', '',
2043 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2044 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2046 'primary_key' => 'svcnum',
2048 'index' => [ [ 'countrycode', 'phonenum' ] ],
2053 'availnum', 'int', '', '', '', '',
2054 'exportnum', 'int', '', '', '', '',
2055 'countrycode', 'varchar', '', 3, '', '',
2056 'state', 'char', 'NULL', 2, '', '',
2057 'npa', 'char', '', 3, '', '',
2058 'nxx', 'char', 'NULL', 3, '', '',
2060 'primary_key' => 'availnum',
2062 'index' => [ [ 'exportnum', 'countrycode', 'state' ] ],
2067 'typenum', 'serial', '', '', '', '',
2068 'class', 'char', '', 1, '', '',
2069 'type', 'varchar', '', $char_d, '', '',
2071 'primary_key' => 'typenum',
2078 'reasonnum', 'serial', '', '', '', '',
2079 'reason_type', 'int', '', '', '', '',
2080 'reason', 'text', '', '', '', '',
2081 'disabled', 'char', 'NULL', 1, '', '',
2083 'primary_key' => 'reasonnum',
2090 'confnum', 'serial', '', '', '', '',
2091 'agentnum', 'int', 'NULL', '', '', '',
2092 'name', 'varchar', '', $char_d, '', '',
2093 'value', 'text', 'NULL', '', '', '',
2095 'primary_key' => 'confnum',
2096 'unique' => [ [ 'agentnum', 'name' ]],
2102 'pkgrefnum', 'serial', '', '', '', '',
2103 'pkgnum', 'int', '', '', '', '',
2104 'refnum', 'int', '', '', '', '',
2106 'primary_key' => 'pkgrefnum',
2107 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2108 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2110 # name type nullability length default local
2114 # 'num', 'serial', '', '', '', '',
2116 # 'primary_key' => 'num',