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 'quantity', 'int', 'NULL', '', '', '',
500 'unitsetup', @money_typen, '', '',
501 'unitrecur', @money_typen, '', '',
503 'primary_key' => 'billpkgnum',
505 'index' => [ ['invnum'], [ 'pkgnum' ] ],
508 'cust_bill_pkg_detail' => {
510 'detailnum', 'serial', '', '', '', '',
511 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
512 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
513 'invnum', 'int', 'NULL', '', '', '', # deprecated
514 'format', 'char', 'NULL', 1, '', '',
515 'detail', 'varchar', '', $char_d, '', '',
517 'primary_key' => 'detailnum',
519 'index' => [ [ 'billpkgnum' ], [ 'pkgnum', 'invnum' ] ],
524 'crednum', 'serial', '', '', '', '',
525 'custnum', 'int', '', '', '', '',
526 '_date', @date_type, '', '',
527 'amount', @money_type, '', '',
528 'otaker', 'varchar', '', 32, '', '',
529 'reason', 'text', 'NULL', '', '', '',
530 'reasonnum', 'int', 'NULL', '', '', '',
531 'closed', 'char', 'NULL', 1, '', '',
533 'primary_key' => 'crednum',
535 'index' => [ ['custnum'], ['_date'] ],
538 'cust_credit_bill' => {
540 'creditbillnum', 'serial', '', '', '', '',
541 'crednum', 'int', '', '', '', '',
542 'invnum', 'int', '', '', '', '',
543 '_date', @date_type, '', '',
544 'amount', @money_type, '', '',
546 'primary_key' => 'creditbillnum',
548 'index' => [ ['crednum'], ['invnum'] ],
551 'cust_credit_bill_pkg' => {
553 'creditbillpkgnum', 'serial', '', '', '', '',
554 'creditbillnum', 'int', '', '', '', '',
555 'billpkgnum', 'int', '', '', '', '',
556 'amount', @money_type, '', '',
557 'setuprecur', 'varchar', '', $char_d, '', '',
558 'sdate', @date_type, '', '',
559 'edate', @date_type, '', '',
561 'primary_key' => 'creditbillpkgnum',
563 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
568 'custnum', 'serial', '', '', '', '',
569 'agentnum', 'int', '', '', '', '',
570 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
571 # 'titlenum', 'int', 'NULL', '', '', '',
572 'last', 'varchar', '', $char_d, '', '',
573 # 'middle', 'varchar', 'NULL', $char_d, '', '',
574 'first', 'varchar', '', $char_d, '', '',
575 'ss', 'varchar', 'NULL', 11, '', '',
576 'stateid', 'varchar', 'NULL', $char_d, '', '',
577 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
578 'birthdate' ,@date_type, '', '',
579 'signupdate',@date_type, '', '',
580 'company', 'varchar', 'NULL', $char_d, '', '',
581 'address1', 'varchar', '', $char_d, '', '',
582 'address2', 'varchar', 'NULL', $char_d, '', '',
583 'city', 'varchar', '', $char_d, '', '',
584 'county', 'varchar', 'NULL', $char_d, '', '',
585 'state', 'varchar', 'NULL', $char_d, '', '',
586 'zip', 'varchar', 'NULL', 10, '', '',
587 'country', 'char', '', 2, '', '',
588 'daytime', 'varchar', 'NULL', 20, '', '',
589 'night', 'varchar', 'NULL', 20, '', '',
590 'fax', 'varchar', 'NULL', 12, '', '',
591 'ship_last', 'varchar', 'NULL', $char_d, '', '',
592 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
593 'ship_first', 'varchar', 'NULL', $char_d, '', '',
594 'ship_company', 'varchar', 'NULL', $char_d, '', '',
595 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
596 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
597 'ship_city', 'varchar', 'NULL', $char_d, '', '',
598 'ship_county', 'varchar', 'NULL', $char_d, '', '',
599 'ship_state', 'varchar', 'NULL', $char_d, '', '',
600 'ship_zip', 'varchar', 'NULL', 10, '', '',
601 'ship_country', 'char', 'NULL', 2, '', '',
602 'ship_daytime', 'varchar', 'NULL', 20, '', '',
603 'ship_night', 'varchar', 'NULL', 20, '', '',
604 'ship_fax', 'varchar', 'NULL', 12, '', '',
605 'payby', 'char', '', 4, '', '',
606 'payinfo', 'varchar', 'NULL', 512, '', '',
607 'paycvv', 'varchar', 'NULL', 512, '', '',
608 'paymask', 'varchar', 'NULL', $char_d, '', '',
609 #'paydate', @date_type, '', '',
610 'paydate', 'varchar', 'NULL', 10, '', '',
611 'paystart_month', 'int', 'NULL', '', '', '',
612 'paystart_year', 'int', 'NULL', '', '', '',
613 'payissue', 'varchar', 'NULL', 2, '', '',
614 'payname', 'varchar', 'NULL', $char_d, '', '',
615 'paystate', 'varchar', 'NULL', $char_d, '', '',
616 'paytype', 'varchar', 'NULL', $char_d, '', '',
617 'payip', 'varchar', 'NULL', 15, '', '',
618 'tax', 'char', 'NULL', 1, '', '',
619 'otaker', 'varchar', '', 32, '', '',
620 'refnum', 'int', '', '', '', '',
621 'referral_custnum', 'int', 'NULL', '', '', '',
622 'comments', 'text', 'NULL', '', '', '',
623 'spool_cdr','char', 'NULL', 1, '', '',
624 'squelch_cdr','char', 'NULL', 1, '', '',
625 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
627 'primary_key' => 'custnum',
628 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
629 #'index' => [ ['last'], ['company'] ],
630 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
631 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
632 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
633 [ 'ship_last' ], [ 'ship_company' ],
634 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
635 [ 'payby' ], [ 'paydate' ],
639 'cust_main_invoice' => {
641 'destnum', 'serial', '', '', '', '',
642 'custnum', 'int', '', '', '', '',
643 'dest', 'varchar', '', $char_d, '', '',
645 'primary_key' => 'destnum',
647 'index' => [ ['custnum'], ],
650 'cust_main_note' => {
652 'notenum', 'serial', '', '', '', '',
653 'custnum', 'int', '', '', '', '',
654 '_date', @date_type, '', '',
655 'otaker', 'varchar', '', 32, '', '',
656 'comments', 'text', 'NULL', '', '', '',
658 'primary_key' => 'notenum',
660 'index' => [ [ 'custnum' ], [ '_date' ], ],
663 'cust_main_county' => { #county+state+country are checked off the
664 #cust_main_county for validation and to provide
667 'taxnum', 'serial', '', '', '', '',
668 'state', 'varchar', 'NULL', $char_d, '', '',
669 'county', 'varchar', 'NULL', $char_d, '', '',
670 'country', 'char', '', 2, '', '',
671 'taxclass', 'varchar', 'NULL', $char_d, '', '',
672 'exempt_amount', @money_type, '', '',
673 'tax', 'real', '', '', '', '', #tax %
674 'taxname', 'varchar', 'NULL', $char_d, '', '',
675 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
676 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
678 'primary_key' => 'taxnum',
680 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
681 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
686 'taxnum', 'serial', '', '', '', '',
687 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
688 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
689 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
690 'taxclassnum', 'int', '', '', '', '',
691 'effective_date', @date_type, '', '',
692 'tax', 'real', '', '', '', '', # tax %
693 'excessrate', 'real', 'NULL','', '', '', # second tax %
694 'taxbase', @money_typen, '', '', # amount at first tax rate
695 'taxmax', @money_typen, '', '', # maximum about at both rates
696 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
697 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
698 'unittype', 'int', 'NULL', '', '', '', # for fee
699 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
700 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
701 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
702 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
703 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
704 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
705 'taxauth', 'int', 'NULL', '', '', '', # tax authority
706 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
707 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
708 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
709 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
710 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
711 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
712 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
714 'primary_key' => 'taxnum',
716 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
719 'cust_tax_location' => {
721 'custlocationnum', 'serial', '', '', '', '',
722 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
723 'zip', 'char', '', 5, '', '',
724 'state', 'char', '', 2, '', '',
725 'plus4hi', 'char', '', 4, '', '',
726 'plus4lo', 'char', '', 4, '', '',
727 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
728 'geocode', 'varchar', '', 20, '', '',
730 'primary_key' => 'custlocationnum',
732 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
737 'taxclassnum', 'serial', '', '', '', '',
738 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
739 'taxclass', 'varchar', '', $char_d, '', '',
740 'description', 'varchar', '', 2*$char_d, '', '',
742 'primary_key' => 'taxclassnum',
743 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
747 'cust_pay_pending' => {
749 'paypendingnum','serial', '', '', '', '',
750 'custnum', 'int', '', '', '', '',
751 'paid', @money_type, '', '',
752 '_date', @date_type, '', '',
753 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
754 # be index into payby
756 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
757 'paymask', 'varchar', 'NULL', $char_d, '', '',
758 'paydate', 'varchar', 'NULL', 10, '', '',
759 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
760 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
762 'status', 'varchar', '', $char_d, '', '',
763 'statustext', 'text', 'NULL', '', '', '',
764 'gatewaynum', 'int', 'NULL', '', '', '',
765 #'cust_balance', @money_type, '', '',
766 'paynum', 'int', 'NULL', '', '', '',
768 'primary_key' => 'paypendingnum',
769 'unique' => [ [ 'payunique' ] ],
770 'index' => [ [ 'custnum' ], [ 'status' ], ],
775 'paynum', 'serial', '', '', '', '',
776 'custnum', 'int', '', '', '', '',
777 '_date', @date_type, '', '',
778 'paid', @money_type, '', '',
779 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
780 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
781 # index into payby table
783 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
784 'paymask', 'varchar', 'NULL', $char_d, '', '',
785 'paydate', 'varchar', 'NULL', 10, '', '',
786 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
787 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
788 'closed', 'char', 'NULL', 1, '', '',
790 'primary_key' => 'paynum',
791 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
792 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
797 'paynum', 'int', '', '', '', '',
798 'custnum', 'int', '', '', '', '',
799 'paid', @money_type, '', '',
800 '_date', @date_type, '', '',
801 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
802 # index into payby table
804 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
805 'paymask', 'varchar', 'NULL', $char_d, '', '',
806 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
807 'closed', 'char', 'NULL', 1, '', '',
808 'void_date', @date_type, '', '',
809 'reason', 'varchar', 'NULL', $char_d, '', '',
810 'otaker', 'varchar', '', 32, '', '',
812 'primary_key' => 'paynum',
814 'index' => [ [ 'custnum' ] ],
819 'billpaynum', 'serial', '', '', '', '',
820 'invnum', 'int', '', '', '', '',
821 'paynum', 'int', '', '', '', '',
822 'amount', @money_type, '', '',
823 '_date', @date_type, '', '',
825 'primary_key' => 'billpaynum',
827 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
830 'cust_bill_pay_batch' => {
832 'billpaynum', 'serial', '', '', '', '',
833 'invnum', 'int', '', '', '', '',
834 'paybatchnum', 'int', '', '', '', '',
835 'amount', @money_type, '', '',
836 '_date', @date_type, '', '',
838 'primary_key' => 'billpaynum',
840 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
843 'cust_bill_pay_pkg' => {
845 'billpaypkgnum', 'serial', '', '', '', '',
846 'billpaynum', 'int', '', '', '', '',
847 'billpkgnum', 'int', '', '', '', '',
848 'amount', @money_type, '', '',
849 'setuprecur', 'varchar', '', $char_d, '', '',
850 'sdate', @date_type, '', '',
851 'edate', @date_type, '', '',
853 'primary_key' => 'billpaypkgnum',
855 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
858 'pay_batch' => { #batches of payments to an external processor
860 'batchnum', 'serial', '', '', '', '',
861 'payby', 'char', '', 4, '', '', # CARD/CHEK
862 'status', 'char', 'NULL', 1, '', '',
863 'download', @date_type, '', '',
864 'upload', @date_type, '', '',
866 'primary_key' => 'batchnum',
871 'cust_pay_batch' => { #what's this used for again? list of customers
872 #in current CARD batch? (necessarily CARD?)
874 'paybatchnum', 'serial', '', '', '', '',
875 'batchnum', 'int', '', '', '', '',
876 'invnum', 'int', '', '', '', '',
877 'custnum', 'int', '', '', '', '',
878 'last', 'varchar', '', $char_d, '', '',
879 'first', 'varchar', '', $char_d, '', '',
880 'address1', 'varchar', '', $char_d, '', '',
881 'address2', 'varchar', 'NULL', $char_d, '', '',
882 'city', 'varchar', '', $char_d, '', '',
883 'state', 'varchar', 'NULL', $char_d, '', '',
884 'zip', 'varchar', 'NULL', 10, '', '',
885 'country', 'char', '', 2, '', '',
886 # 'trancode', 'int', '', '', '', ''
887 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
888 'payinfo', 'varchar', '', 512, '', '',
889 #'exp', @date_type, '', ''
890 'exp', 'varchar', 'NULL', 11, '', '',
891 'payname', 'varchar', 'NULL', $char_d, '', '',
892 'amount', @money_type, '', '',
893 'status', 'varchar', 'NULL', $char_d, '', '',
895 'primary_key' => 'paybatchnum',
897 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
902 'pkgnum', 'serial', '', '', '', '',
903 'custnum', 'int', '', '', '', '',
904 'pkgpart', 'int', '', '', '', '',
905 'otaker', 'varchar', '', 32, '', '',
906 'setup', @date_type, '', '',
907 'bill', @date_type, '', '',
908 'last_bill', @date_type, '', '',
909 'susp', @date_type, '', '',
910 'adjourn', @date_type, '', '',
911 'cancel', @date_type, '', '',
912 'expire', @date_type, '', '',
913 'change_date', @date_type, '', '',
914 'change_pkgnum', 'int', 'NULL', '', '', '',
915 'change_pkgpart', 'int', 'NULL', '', '', '',
916 'manual_flag', 'char', 'NULL', 1, '', '',
917 'quantity', 'int', 'NULL', '', '', '',
919 'primary_key' => 'pkgnum',
921 'index' => [ ['custnum'], ['pkgpart'],
922 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
923 ['expire'], ['cancel'],
928 'cust_pkg_option' => {
930 'optionnum', 'serial', '', '', '', '',
931 'pkgnum', 'int', '', '', '', '',
932 'optionname', 'varchar', '', $char_d, '', '',
933 'optionvalue', 'text', 'NULL', '', '', '',
935 'primary_key' => 'optionnum',
937 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
940 'cust_pkg_reason' => {
942 'num', 'serial', '', '', '', '',
943 'pkgnum', 'int', '', '', '', '',
944 'reasonnum','int', '', '', '', '',
945 'action', 'char', 'NULL', 1, '', '', #should not be nullable
946 'otaker', 'varchar', '', 32, '', '',
947 'date', @date_type, '', '',
949 'primary_key' => 'num',
956 'refundnum', 'serial', '', '', '', '',
957 'custnum', 'int', '', '', '', '',
958 '_date', @date_type, '', '',
959 'refund', @money_type, '', '',
960 'otaker', 'varchar', '', 32, '', '',
961 'reason', 'varchar', '', $char_d, '', '',
962 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
963 # be index into payby
965 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
966 'paymask', 'varchar', 'NULL', $char_d, '', '',
967 'paybatch', 'varchar', 'NULL', $char_d, '', '',
968 'closed', 'char', 'NULL', 1, '', '',
970 'primary_key' => 'refundnum',
972 'index' => [ ['custnum'], ['_date'] ],
975 'cust_credit_refund' => {
977 'creditrefundnum', 'serial', '', '', '', '',
978 'crednum', 'int', '', '', '', '',
979 'refundnum', 'int', '', '', '', '',
980 'amount', @money_type, '', '',
981 '_date', @date_type, '', '',
983 'primary_key' => 'creditrefundnum',
985 'index' => [ ['crednum'], ['refundnum'] ],
991 'svcnum', 'serial', '', '', '', '',
992 'pkgnum', 'int', 'NULL', '', '', '',
993 'svcpart', 'int', '', '', '', '',
994 'overlimit', @date_type, '', '',
996 'primary_key' => 'svcnum',
998 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1003 'pkgpart', 'serial', '', '', '', '',
1004 'pkg', 'varchar', '', $char_d, '', '',
1005 'comment', 'varchar', '', $char_d, '', '',
1006 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1007 'setup', @perl_type, '', '',
1008 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1009 'recur', @perl_type, '', '',
1010 'setuptax', 'char', 'NULL', 1, '', '',
1011 'recurtax', 'char', 'NULL', 1, '', '',
1012 'plan', 'varchar', 'NULL', $char_d, '', '',
1013 'plandata', 'text', 'NULL', '', '', '',
1014 'disabled', 'char', 'NULL', 1, '', '',
1015 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1016 'classnum', 'int', 'NULL', '', '', '',
1017 'taxproductnum', 'int', 'NULL', '', '', '',
1018 'pay_weight', 'real', 'NULL', '', '', '',
1019 'credit_weight', 'real', 'NULL', '', '', '',
1020 'agentnum', 'int', 'NULL', '', '', '',
1023 'primary_key' => 'pkgpart',
1025 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1028 'part_pkg_link' => {
1030 'pkglinknum', 'serial', '', '', '', '',
1031 'src_pkgpart', 'int', '', '', '', '',
1032 'dst_pkgpart', 'int', '', '', '', '',
1033 'link_type', 'varchar', '', $char_d, '', '',
1035 'primary_key' => 'pkglinknum',
1036 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1037 'index' => [ [ 'src_pkgpart' ] ],
1040 'part_pkg_taxclass' => {
1042 'taxclassnum', 'serial', '', '', '', '',
1043 'taxclass', 'varchar', '', $char_d, '', '',
1045 'primary_key' => 'taxclassnum',
1046 'unique' => [ [ 'taxclass' ] ],
1050 'part_pkg_taxproduct' => {
1052 'taxproductnum', 'serial', '', '', '', '',
1053 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1054 'taxproduct', 'varchar', '', $char_d, '', '',
1055 'description', 'varchar', '', 2*$char_d, '', '',
1057 'primary_key' => 'taxproductnum',
1058 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1062 'part_pkg_taxrate' => {
1064 'pkgtaxratenum', 'serial', '', '', '', '',
1065 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1066 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1067 'taxproductnum', 'int', '', '', '', '',
1068 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1069 'county', 'varchar', 'NULL', $char_d, '', '',
1070 'state', 'varchar', 'NULL', $char_d, '', '',
1071 'local', 'varchar', 'NULL', $char_d, '', '',
1072 'country', 'char', 'NULL', 2, '', '',
1073 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1074 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1075 'taxclassnum', 'int', 'NULL', '', '', '',
1076 'effdate', @date_type, '', '',
1077 'taxable', 'char', 'NULL', 1, '', '',
1079 'primary_key' => 'pkgtaxratenum',
1081 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1084 'part_pkg_taxoverride' => {
1086 'taxoverridenum', 'serial', '', '', '', '',
1087 'pkgpart', 'serial', '', '', '', '',
1088 'taxclassnum', 'serial', '', '', '', '',
1090 'primary_key' => 'taxoverridenum',
1092 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1097 # 'titlenum', 'int', '', '',
1098 # 'title', 'varchar', '', $char_d,
1100 # 'primary_key' => 'titlenum',
1101 # 'unique' => [ [] ],
1102 # 'index' => [ [] ],
1107 'pkgsvcnum', 'serial', '', '', '', '',
1108 'pkgpart', 'int', '', '', '', '',
1109 'svcpart', 'int', '', '', '', '',
1110 'quantity', 'int', '', '', '', '',
1111 'primary_svc','char', 'NULL', 1, '', '',
1113 'primary_key' => 'pkgsvcnum',
1114 'unique' => [ ['pkgpart', 'svcpart'] ],
1115 'index' => [ ['pkgpart'] ],
1118 'part_referral' => {
1120 'refnum', 'serial', '', '', '', '',
1121 'referral', 'varchar', '', $char_d, '', '',
1122 'disabled', 'char', 'NULL', 1, '', '',
1123 'agentnum', 'int', 'NULL', '', '', '',
1125 'primary_key' => 'refnum',
1127 'index' => [ ['disabled'], ['agentnum'], ],
1132 'svcpart', 'serial', '', '', '', '',
1133 'svc', 'varchar', '', $char_d, '', '',
1134 'svcdb', 'varchar', '', $char_d, '', '',
1135 'disabled', 'char', 'NULL', 1, '', '',
1137 'primary_key' => 'svcpart',
1139 'index' => [ [ 'disabled' ] ],
1142 'part_svc_column' => {
1144 'columnnum', 'serial', '', '', '', '',
1145 'svcpart', 'int', '', '', '', '',
1146 'columnname', 'varchar', '', 64, '', '',
1147 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1148 'columnflag', 'char', 'NULL', 1, '', '',
1150 'primary_key' => 'columnnum',
1151 'unique' => [ [ 'svcpart', 'columnname' ] ],
1152 'index' => [ [ 'svcpart' ] ],
1155 #(this should be renamed to part_pop)
1158 'popnum', 'serial', '', '', '', '',
1159 'city', 'varchar', '', $char_d, '', '',
1160 'state', 'varchar', '', $char_d, '', '',
1161 'ac', 'char', '', 3, '', '',
1162 'exch', 'char', '', 3, '', '',
1163 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1165 'primary_key' => 'popnum',
1167 'index' => [ [ 'state' ] ],
1170 'part_pop_local' => {
1172 'localnum', 'serial', '', '', '', '',
1173 'popnum', 'int', '', '', '', '',
1174 'city', 'varchar', 'NULL', $char_d, '', '',
1175 'state', 'char', 'NULL', 2, '', '',
1176 'npa', 'char', '', 3, '', '',
1177 'nxx', 'char', '', 3, '', '',
1179 'primary_key' => 'localnum',
1181 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1186 'svcnum', 'int', '', '', '', '',
1187 'username', 'varchar', '', $username_len, '', '',
1188 '_password', 'varchar', '', 512, '', '',
1189 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1190 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1191 'popnum', 'int', 'NULL', '', '', '',
1192 'uid', 'int', 'NULL', '', '', '',
1193 'gid', 'int', 'NULL', '', '', '',
1194 'finger', 'varchar', 'NULL', $char_d, '', '',
1195 'dir', 'varchar', 'NULL', $char_d, '', '',
1196 'shell', 'varchar', 'NULL', $char_d, '', '',
1197 'quota', 'varchar', 'NULL', $char_d, '', '',
1198 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1199 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1200 'seconds_threshold', 'int', 'NULL', '', '', '',
1201 'upbytes', 'bigint', 'NULL', '', '', '',
1202 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1203 'downbytes', 'bigint', 'NULL', '', '', '',
1204 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1205 'totalbytes','bigint', 'NULL', '', '', '',
1206 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1207 'domsvc', 'int', '', '', '', '',
1208 'last_login', @date_type, '', '',
1209 'last_logout', @date_type, '', '',
1211 'primary_key' => 'svcnum',
1212 #'unique' => [ [ 'username', 'domsvc' ] ],
1214 'index' => [ ['username'], ['domsvc'] ],
1217 'acct_rt_transaction' => {
1219 'svcrtid', 'int', '', '', '', '',
1220 'svcnum', 'int', '', '', '', '',
1221 'transaction_id', 'int', '', '', '', '',
1222 '_date', @date_type, '', '',
1223 'seconds', 'int', '', '', '', '', #uhhhh
1224 'support', 'int', '', '', '', '',
1226 'primary_key' => 'svcrtid',
1228 'index' => [ ['svcnum', 'transaction_id'] ],
1233 # 'svcnum', 'int', '', '',
1234 # 'amount', @money_type,
1236 # 'primary_key' => 'svcnum',
1237 # 'unique' => [ [] ],
1238 # 'index' => [ [] ],
1243 'svcnum', 'int', '', '', '', '',
1244 'domain', 'varchar', '', $char_d, '', '',
1245 'suffix', 'varchar', 'NULL', $char_d, '', '',
1246 'catchall', 'int', 'NULL', '', '', '',
1247 'parent_svcnum', 'int', 'NULL', '', '', '',
1248 'registrarnum', 'int', 'NULL', '', '', '',
1249 'registrarkey', 'varchar', 'NULL', 512, '', '',
1250 'setup_date', @date_type, '', '',
1251 'renewal_interval', 'int', 'NULL', '', '', '',
1252 'expiration_date', @date_type, '', '',
1254 'primary_key' => 'svcnum',
1256 'index' => [ ['domain'] ],
1259 'domain_record' => {
1261 'recnum', 'serial', '', '', '', '',
1262 'svcnum', 'int', '', '', '', '',
1263 'reczone', 'varchar', '', 255, '', '',
1264 'recaf', 'char', '', 2, '', '',
1265 'rectype', 'varchar', '', 5, '', '',
1266 'recdata', 'varchar', '', 255, '', '',
1268 'primary_key' => 'recnum',
1270 'index' => [ ['svcnum'] ],
1275 'registrarnum', 'serial', '', '', '', '',
1276 'registrarname', 'varchar', '', $char_d, '', '',
1278 'primary_key' => 'registrarnum',
1285 'svcnum', 'int', '', '', '', '',
1286 'srcsvc', 'int', 'NULL', '', '', '',
1287 'src', 'varchar', 'NULL', 255, '', '',
1288 'dstsvc', 'int', 'NULL', '', '', '',
1289 'dst', 'varchar', 'NULL', 255, '', '',
1291 'primary_key' => 'svcnum',
1293 'index' => [ ['srcsvc'], ['dstsvc'] ],
1298 'svcnum', 'int', '', '', '', '',
1299 'recnum', 'int', '', '', '', '',
1300 'usersvc', 'int', 'NULL', '', '', '',
1301 'config', 'text', 'NULL', '', '', '',
1303 'primary_key' => 'svcnum',
1310 # 'svcnum', 'int', '', '',
1311 # 'svcnum', 'int', '', '',
1312 # 'svcnum', 'int', '', '',
1313 # 'worker', 'varchar', '', $char_d,
1314 # '_date', @date_type,
1316 # 'primary_key' => 'svcnum',
1317 # 'unique' => [ [] ],
1318 # 'index' => [ [] ],
1321 'prepay_credit' => {
1323 'prepaynum', 'serial', '', '', '', '',
1324 'identifier', 'varchar', '', $char_d, '', '',
1325 'amount', @money_type, '', '',
1326 'seconds', 'int', 'NULL', '', '', '',
1327 'upbytes', 'bigint', 'NULL', '', '', '',
1328 'downbytes', 'bigint', 'NULL', '', '', '',
1329 'totalbytes', 'bigint', 'NULL', '', '', '',
1330 'agentnum', 'int', 'NULL', '', '', '',
1332 'primary_key' => 'prepaynum',
1333 'unique' => [ ['identifier'] ],
1339 'portnum', 'serial', '', '', '', '',
1340 'ip', 'varchar', 'NULL', 15, '', '',
1341 'nasport', 'int', 'NULL', '', '', '',
1342 'nasnum', 'int', '', '', '', '',
1344 'primary_key' => 'portnum',
1351 'nasnum', 'serial', '', '', '', '',
1352 'nas', 'varchar', '', $char_d, '', '',
1353 'nasip', 'varchar', '', 15, '', '',
1354 'nasfqdn', 'varchar', '', $char_d, '', '',
1355 'last', 'int', '', '', '', '',
1357 'primary_key' => 'nasnum',
1358 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1359 'index' => [ [ 'last' ] ],
1364 # 'sessionnum', 'serial', '', '', '', '',
1365 # 'portnum', 'int', '', '', '', '',
1366 # 'svcnum', 'int', '', '', '', '',
1367 # 'login', @date_type, '', '',
1368 # 'logout', @date_type, '', '',
1370 # 'primary_key' => 'sessionnum',
1372 # 'index' => [ [ 'portnum' ] ],
1377 'jobnum', 'serial', '', '', '', '',
1378 'job', 'text', '', '', '', '',
1379 '_date', 'int', '', '', '', '',
1380 'status', 'varchar', '', $char_d, '', '',
1381 'statustext', 'text', 'NULL', '', '', '',
1382 'svcnum', 'int', 'NULL', '', '', '',
1383 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1386 'primary_key' => 'jobnum',
1388 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1393 'argnum', 'serial', '', '', '', '',
1394 'jobnum', 'int', '', '', '', '',
1395 'arg', 'text', 'NULL', '', '', '',
1397 'primary_key' => 'argnum',
1399 'index' => [ [ 'jobnum' ] ],
1404 'dependnum', 'serial', '', '', '', '',
1405 'jobnum', 'int', '', '', '', '',
1406 'depend_jobnum', 'int', '', '', '', '',
1408 'primary_key' => 'dependnum',
1410 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1415 'exportsvcnum' => 'serial', '', '', '', '',
1416 'exportnum' => 'int', '', '', '', '',
1417 'svcpart' => 'int', '', '', '', '',
1419 'primary_key' => 'exportsvcnum',
1420 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1421 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1426 'exportnum', 'serial', '', '', '', '',
1427 'machine', 'varchar', '', $char_d, '', '',
1428 'exporttype', 'varchar', '', $char_d, '', '',
1429 'nodomain', 'char', 'NULL', 1, '', '',
1431 'primary_key' => 'exportnum',
1433 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1436 'part_export_option' => {
1438 'optionnum', 'serial', '', '', '', '',
1439 'exportnum', 'int', '', '', '', '',
1440 'optionname', 'varchar', '', $char_d, '', '',
1441 'optionvalue', 'text', 'NULL', '', '', '',
1443 'primary_key' => 'optionnum',
1445 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1448 'radius_usergroup' => {
1450 'usergroupnum', 'serial', '', '', '', '',
1451 'svcnum', 'int', '', '', '', '',
1452 'groupname', 'varchar', '', $char_d, '', '',
1454 'primary_key' => 'usergroupnum',
1456 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1461 'msgnum', 'serial', '', '', '', '',
1462 'msgcode', 'varchar', '', $char_d, '', '',
1463 'locale', 'varchar', '', 16, '', '',
1464 'msg', 'text', '', '', '', '',
1466 'primary_key' => 'msgnum',
1467 'unique' => [ [ 'msgcode', 'locale' ] ],
1471 'cust_tax_exempt' => {
1473 'exemptnum', 'serial', '', '', '', '',
1474 'custnum', 'int', '', '', '', '',
1475 'taxnum', 'int', '', '', '', '',
1476 'year', 'int', '', '', '', '',
1477 'month', 'int', '', '', '', '',
1478 'amount', @money_type, '', '',
1480 'primary_key' => 'exemptnum',
1481 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1485 'cust_tax_exempt_pkg' => {
1487 'exemptpkgnum', 'serial', '', '', '', '',
1488 #'custnum', 'int', '', '', '', ''
1489 'billpkgnum', 'int', '', '', '', '',
1490 'taxnum', 'int', '', '', '', '',
1491 'year', 'int', '', '', '', '',
1492 'month', 'int', '', '', '', '',
1493 'amount', @money_type, '', '',
1495 'primary_key' => 'exemptpkgnum',
1497 'index' => [ [ 'taxnum', 'year', 'month' ],
1505 'routernum', 'serial', '', '', '', '',
1506 'routername', 'varchar', '', $char_d, '', '',
1507 'svcnum', 'int', 'NULL', '', '', '',
1508 'agentnum', 'int', 'NULL', '', '', '',
1510 'primary_key' => 'routernum',
1515 'part_svc_router' => {
1517 'svcrouternum', 'serial', '', '', '', '',
1518 'svcpart', 'int', '', '', '', '',
1519 'routernum', 'int', '', '', '', '',
1521 'primary_key' => 'svcrouternum',
1528 'blocknum', 'serial', '', '', '', '',
1529 'routernum', 'int', '', '', '', '',
1530 'ip_gateway', 'varchar', '', 15, '', '',
1531 'ip_netmask', 'int', '', '', '', '',
1532 'agentnum', 'int', 'NULL', '', '', '',
1534 'primary_key' => 'blocknum',
1535 'unique' => [ [ 'blocknum', 'routernum' ] ],
1539 'svc_broadband' => {
1541 'svcnum', 'int', '', '', '', '',
1542 'description', 'varchar', 'NULL', $char_d, '', '',
1543 'blocknum', 'int', '', '', '', '',
1544 'speed_up', 'int', '', '', '', '',
1545 'speed_down', 'int', '', '', '', '',
1546 'ip_addr', 'varchar', '', 15, '', '',
1547 'mac_addr', 'varchar', 'NULL', 12, '', '',
1548 'authkey', 'varchar', 'NULL', 32, '', '',
1549 'latitude', 'decimal', 'NULL', '', '', '',
1550 'longitude', 'decimal', 'NULL', '', '', '',
1551 'altitude', 'decimal', 'NULL', '', '', '',
1552 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1554 'primary_key' => 'svcnum',
1559 'part_virtual_field' => {
1561 'vfieldpart', 'serial', '', '', '', '',
1562 'dbtable', 'varchar', '', 32, '', '',
1563 'name', 'varchar', '', 32, '', '',
1564 'check_block', 'text', 'NULL', '', '', '',
1565 'length', 'int', 'NULL', '', '', '',
1566 'list_source', 'text', 'NULL', '', '', '',
1567 'label', 'varchar', 'NULL', 80, '', '',
1569 'primary_key' => 'vfieldpart',
1574 'virtual_field' => {
1576 'vfieldnum', 'serial', '', '', '', '',
1577 'recnum', 'int', '', '', '', '',
1578 'vfieldpart', 'int', '', '', '', '',
1579 'value', 'varchar', '', 128, '', '',
1581 'primary_key' => 'vfieldnum',
1582 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1588 'snarfnum', 'int', '', '', '', '',
1589 'svcnum', 'int', '', '', '', '',
1590 'machine', 'varchar', '', 255, '', '',
1591 'protocol', 'varchar', '', $char_d, '', '',
1592 'username', 'varchar', '', $char_d, '', '',
1593 '_password', 'varchar', '', $char_d, '', '',
1595 'primary_key' => 'snarfnum',
1597 'index' => [ [ 'svcnum' ] ],
1602 'svcnum', 'int', '', '', '', '',
1603 'id', 'int', 'NULL', '', '', '',
1604 'title', 'varchar', 'NULL', $char_d, '', '',
1606 'primary_key' => 'svcnum',
1611 'cust_pay_refund' => {
1613 'payrefundnum', 'serial', '', '', '', '',
1614 'paynum', 'int', '', '', '', '',
1615 'refundnum', 'int', '', '', '', '',
1616 '_date', @date_type, '', '',
1617 'amount', @money_type, '', '',
1619 'primary_key' => 'payrefundnum',
1621 'index' => [ ['paynum'], ['refundnum'] ],
1624 'part_pkg_option' => {
1626 'optionnum', 'serial', '', '', '', '',
1627 'pkgpart', 'int', '', '', '', '',
1628 'optionname', 'varchar', '', $char_d, '', '',
1629 'optionvalue', 'text', 'NULL', '', '', '',
1631 'primary_key' => 'optionnum',
1633 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1638 'ratenum', 'serial', '', '', '', '',
1639 'ratename', 'varchar', '', $char_d, '', '',
1641 'primary_key' => 'ratenum',
1648 'ratedetailnum', 'serial', '', '', '', '',
1649 'ratenum', 'int', '', '', '', '',
1650 'orig_regionnum', 'int', 'NULL', '', '', '',
1651 'dest_regionnum', 'int', '', '', '', '',
1652 'min_included', 'int', '', '', '', '',
1653 #'min_charge', @money_type, '', '',
1654 'min_charge', 'decimal', '', '10,5', '', '',
1655 'sec_granularity', 'int', '', '', '', '',
1656 #time period (link to table of periods)?
1658 'primary_key' => 'ratedetailnum',
1659 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1660 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1665 'regionnum', 'serial', '', '', '', '',
1666 'regionname', 'varchar', '', $char_d, '', '',
1668 'primary_key' => 'regionnum',
1675 'prefixnum', 'serial', '', '', '', '',
1676 'regionnum', 'int', '', '',, '', '',
1677 'countrycode', 'varchar', '', 3, '', '',
1678 'npa', 'varchar', 'NULL', 6, '', '',
1679 'nxx', 'varchar', 'NULL', 3, '', '',
1681 'primary_key' => 'prefixnum',
1683 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1688 'codenum', 'serial', '', '', '', '',
1689 'code', 'varchar', '', $char_d, '', '',
1690 'agentnum', 'int', '', '', '', '',
1692 'primary_key' => 'codenum',
1693 'unique' => [ [ 'agentnum', 'code' ] ],
1694 'index' => [ [ 'agentnum' ] ],
1699 'codepkgnum', 'serial', '', '', '', '',
1700 'codenum', 'int', '', '', '', '',
1701 'pkgpart', 'int', '', '', '', '',
1703 'primary_key' => 'codepkgnum',
1704 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1705 'index' => [ [ 'codenum' ] ],
1708 'clientapi_session' => {
1710 'sessionnum', 'serial', '', '', '', '',
1711 'sessionid', 'varchar', '', $char_d, '', '',
1712 'namespace', 'varchar', '', $char_d, '', '',
1714 'primary_key' => 'sessionnum',
1715 'unique' => [ [ 'sessionid', 'namespace' ] ],
1719 'clientapi_session_field' => {
1721 'fieldnum', 'serial', '', '', '', '',
1722 'sessionnum', 'int', '', '', '', '',
1723 'fieldname', 'varchar', '', $char_d, '', '',
1724 'fieldvalue', 'text', 'NULL', '', '', '',
1726 'primary_key' => 'fieldnum',
1727 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1731 'payment_gateway' => {
1733 'gatewaynum', 'serial', '', '', '', '',
1734 'gateway_module', 'varchar', '', $char_d, '', '',
1735 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1736 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1737 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1738 'disabled', 'char', 'NULL', 1, '', '',
1740 'primary_key' => 'gatewaynum',
1742 'index' => [ [ 'disabled' ] ],
1745 'payment_gateway_option' => {
1747 'optionnum', 'serial', '', '', '', '',
1748 'gatewaynum', 'int', '', '', '', '',
1749 'optionname', 'varchar', '', $char_d, '', '',
1750 'optionvalue', 'text', 'NULL', '', '', '',
1752 'primary_key' => 'optionnum',
1754 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1757 'agent_payment_gateway' => {
1759 'agentgatewaynum', 'serial', '', '', '', '',
1760 'agentnum', 'int', '', '', '', '',
1761 'gatewaynum', 'int', '', '', '', '',
1762 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1763 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1765 'primary_key' => 'agentgatewaynum',
1767 'index' => [ [ 'agentnum', 'cardtype' ], ],
1772 'bannum', 'serial', '', '', '', '',
1773 'payby', 'char', '', 4, '', '',
1774 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1775 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1776 '_date', @date_type, '', '',
1777 'otaker', 'varchar', '', 32, '', '',
1778 'reason', 'varchar', 'NULL', $char_d, '', '',
1780 'primary_key' => 'bannum',
1781 'unique' => [ [ 'payby', 'payinfo' ] ],
1787 'categorynum', 'serial', '', '', '', '',
1788 'categoryname', 'varchar', '', $char_d, '', '',
1789 'disabled', 'char', 'NULL', 1, '', '',
1791 'primary_key' => 'categorynum',
1793 'index' => [ ['disabled'] ],
1798 'classnum', 'serial', '', '', '', '',
1799 'classname', 'varchar', '', $char_d, '', '',
1800 'categorynum', 'int', 'NULL', '', '', '',
1801 'disabled', 'char', 'NULL', 1, '', '',
1803 'primary_key' => 'classnum',
1805 'index' => [ ['disabled'] ],
1810 # qw( name type null length default local );
1816 'acctid', 'bigserial', '', '', '', '',
1817 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1818 'calldate', 'timestamp', '', '', \'now()', '',
1819 'clid', 'varchar', '', $char_d, \"''", '',
1820 'src', 'varchar', '', $char_d, \"''", '',
1821 'dst', 'varchar', '', $char_d, \"''", '',
1822 'dcontext', 'varchar', '', $char_d, \"''", '',
1823 'channel', 'varchar', '', $char_d, \"''", '',
1824 'dstchannel', 'varchar', '', $char_d, \"''", '',
1825 'lastapp', 'varchar', '', $char_d, \"''", '',
1826 'lastdata', 'varchar', '', $char_d, \"''", '',
1828 #these don't seem to be logged by most of the SQL cdr_* modules
1829 #except tds under sql-illegal names, so;
1830 # ... don't rely on them for rating?
1831 # and, what they hey, i went ahead and changed the names and data types
1832 # to freeside-style dates...
1833 #'start', 'timestamp', 'NULL', '', '', '',
1834 #'answer', 'timestamp', 'NULL', '', '', '',
1835 #'end', 'timestamp', 'NULL', '', '', '',
1836 'startdate', @date_type, '', '',
1837 'answerdate', @date_type, '', '',
1838 'enddate', @date_type, '', '',
1841 'duration', 'int', '', '', 0, '',
1842 'billsec', 'int', '', '', 0, '',
1843 'disposition', 'varchar', '', 45, \"''", '',
1844 'amaflags', 'int', '', '', 0, '',
1845 'accountcode', 'varchar', '', 20, \"''", '',
1846 'uniqueid', 'varchar', '', 32, \"''", '',
1847 'userfield', 'varchar', '', 255, \"''", '',
1850 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1854 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1855 'cdrtypenum', 'int', 'NULL', '', '', '',
1857 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1859 'upstream_currency', 'char', 'NULL', 3, '', '',
1860 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1861 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1863 # how it was rated internally...
1864 'ratedetailnum', 'int', 'NULL', '', '', '',
1865 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1867 'distance', 'decimal', 'NULL', '', '', '',
1868 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1870 #cdr_calltype: the big list in appendix 2
1871 'calltypenum', 'int', 'NULL', '', '', '',
1873 'description', 'varchar', 'NULL', $char_d, '', '',
1874 'quantity', 'int', 'NULL', '', '', '',
1876 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1877 'carrierid', 'int', 'NULL', '', '', '',
1879 'upstream_rateid', 'int', 'NULL', '', '', '',
1882 #and now for our own fields
1885 # a svcnum... right..?
1886 'svcnum', 'int', 'NULL', '', '', '',
1888 #NULL, done (or something)
1889 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1892 'primary_key' => 'acctid',
1894 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1899 'calltypenum', 'serial', '', '', '', '',
1900 'calltypename', 'varchar', '', $char_d, '', '',
1902 'primary_key' => 'calltypenum',
1909 'cdrtypenum' => 'serial', '', '', '', '',
1910 'cdrtypename' => 'varchar', '', $char_d, '', '',
1912 'primary_key' => 'cdrtypenum',
1919 'carrierid' => 'serial', '', '', '', '',
1920 'carriername' => 'varchar', '', $char_d, '', '',
1922 'primary_key' => 'carrierid',
1927 #map upstream rateid to ours...
1928 'cdr_upstream_rate' => {
1930 'upstreamratenum', 'serial', '', '', '', '',
1931 'upstream_rateid', 'varchar', '', $char_d, '', '',
1932 'ratedetailnum', 'int', 'NULL', '', '', '',
1934 'primary_key' => 'upstreamratenum', #XXX need a primary key
1935 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1939 'inventory_item' => {
1941 'itemnum', 'serial', '', '', '', '',
1942 'classnum', 'int', '', '', '', '',
1943 'item', 'varchar', '', $char_d, '', '',
1944 'svcnum', 'int', 'NULL', '', '', '',
1946 'primary_key' => 'itemnum',
1947 'unique' => [ [ 'classnum', 'item' ] ],
1948 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1951 'inventory_class' => {
1953 'classnum', 'serial', '', '', '', '',
1954 'classname', 'varchar', '', $char_d, '', '',
1956 'primary_key' => 'classnum',
1963 'usernum', 'serial', '', '', '', '',
1964 'username', 'varchar', '', $char_d, '', '',
1965 '_password', 'varchar', '', $char_d, '', '',
1966 'last', 'varchar', '', $char_d, '', '',
1967 'first', 'varchar', '', $char_d, '', '',
1968 'disabled', 'char', 'NULL', 1, '', '',
1970 'primary_key' => 'usernum',
1971 'unique' => [ [ 'username' ] ],
1975 'access_user_pref' => {
1977 'prefnum', 'serial', '', '', '', '',
1978 'usernum', 'int', '', '', '', '',
1979 'prefname', 'varchar', '', $char_d, '', '',
1980 'prefvalue', 'text', 'NULL', '', '', '',
1981 'expiration', @date_type, '', '',
1983 'primary_key' => 'prefnum',
1985 'index' => [ [ 'usernum' ] ],
1990 'groupnum', 'serial', '', '', '', '',
1991 'groupname', 'varchar', '', $char_d, '', '',
1993 'primary_key' => 'groupnum',
1994 'unique' => [ [ 'groupname' ] ],
1998 'access_usergroup' => {
2000 'usergroupnum', 'serial', '', '', '', '',
2001 'usernum', 'int', '', '', '', '',
2002 'groupnum', 'int', '', '', '', '',
2004 'primary_key' => 'usergroupnum',
2005 'unique' => [ [ 'usernum', 'groupnum' ] ],
2006 'index' => [ [ 'usernum' ] ],
2009 'access_groupagent' => {
2011 'groupagentnum', 'serial', '', '', '', '',
2012 'groupnum', 'int', '', '', '', '',
2013 'agentnum', 'int', '', '', '', '',
2015 'primary_key' => 'groupagentnum',
2016 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2017 'index' => [ [ 'groupnum' ] ],
2022 'rightnum', 'serial', '', '', '', '',
2023 'righttype', 'varchar', '', $char_d, '', '',
2024 'rightobjnum', 'int', '', '', '', '',
2025 'rightname', 'varchar', '', $char_d, '', '',
2027 'primary_key' => 'rightnum',
2028 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2034 'svcnum', 'int', '', '', '', '',
2035 'countrycode', 'varchar', '', 3, '', '',
2036 'phonenum', 'varchar', '', 15, '', '', #12 ?
2037 'pin', 'varchar', 'NULL', $char_d, '', '',
2038 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2040 'primary_key' => 'svcnum',
2042 'index' => [ [ 'countrycode', 'phonenum' ] ],
2047 'availnum', 'int', '', '', '', '',
2048 'exportnum', 'int', '', '', '', '',
2049 'countrycode', 'varchar', '', 3, '', '',
2050 'state', 'char', 'NULL', 2, '', '',
2051 'npa', 'char', '', 3, '', '',
2052 'nxx', 'char', 'NULL', 3, '', '',
2054 'primary_key' => 'availnum',
2056 'index' => [ [ 'exportnum', 'countrycode', 'state' ] ],
2061 'typenum', 'serial', '', '', '', '',
2062 'class', 'char', '', 1, '', '',
2063 'type', 'varchar', '', $char_d, '', '',
2065 'primary_key' => 'typenum',
2072 'reasonnum', 'serial', '', '', '', '',
2073 'reason_type', 'int', '', '', '', '',
2074 'reason', 'text', '', '', '', '',
2075 'disabled', 'char', 'NULL', 1, '', '',
2077 'primary_key' => 'reasonnum',
2084 'confnum', 'serial', '', '', '', '',
2085 'agentnum', 'int', 'NULL', '', '', '',
2086 'name', 'varchar', '', $char_d, '', '',
2087 'value', 'text', 'NULL', '', '', '',
2089 'primary_key' => 'confnum',
2090 'unique' => [ [ 'agentnum', 'name' ]],
2096 'pkgrefnum', 'serial', '', '', '', '',
2097 'pkgnum', 'int', '', '', '', '',
2098 'refnum', 'int', '', '', '', '',
2100 'primary_key' => 'pkgrefnum',
2101 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2102 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2104 # name type nullability length default local
2108 # 'num', 'serial', '', '', '', '',
2110 # 'primary_key' => 'num',