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, '', '',
504 'primary_key' => 'billpkgnum',
506 'index' => [ ['invnum'], [ 'pkgnum' ] ],
509 'cust_bill_pkg_detail' => {
511 'detailnum', 'serial', '', '', '', '',
512 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
513 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
514 'invnum', 'int', 'NULL', '', '', '', # deprecated
515 'amount', @money_typen, '', '',
516 'format', 'char', 'NULL', 1, '', '',
517 'classnum', 'char', 'NULL', 1, '', '',
518 'detail', 'varchar', '', $char_d, '', '',
520 'primary_key' => 'detailnum',
522 'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
525 'cust_bill_pkg_display' => {
527 'billpkgdisplaynum', 'serial', '', '', '', '',
528 'billpkgnum', 'int', '', '', '', '',
529 'section', 'varchar', 'NULL', $char_d, '', '',
530 #'unitsetup', @money_typen, '', '', #override the linked real one?
531 #'unitrecur', @money_typen, '', '', #this too?
532 'post_total', 'char', 'NULL', 1, '', '',
533 'type', 'char', 'NULL', 1, '', '',
534 'summary', 'char', 'NULL', 1, '', '',
536 'primary_key' => 'billpkgdisplaynum',
538 'index' => [ ['billpkgnum'], ],
543 'crednum', 'serial', '', '', '', '',
544 'custnum', 'int', '', '', '', '',
545 '_date', @date_type, '', '',
546 'amount', @money_type, '', '',
547 'otaker', 'varchar', '', 32, '', '',
548 'reason', 'text', 'NULL', '', '', '',
549 'reasonnum', 'int', 'NULL', '', '', '',
550 'closed', 'char', 'NULL', 1, '', '',
552 'primary_key' => 'crednum',
554 'index' => [ ['custnum'], ['_date'] ],
557 'cust_credit_bill' => {
559 'creditbillnum', 'serial', '', '', '', '',
560 'crednum', 'int', '', '', '', '',
561 'invnum', 'int', '', '', '', '',
562 '_date', @date_type, '', '',
563 'amount', @money_type, '', '',
565 'primary_key' => 'creditbillnum',
567 'index' => [ ['crednum'], ['invnum'] ],
570 'cust_credit_bill_pkg' => {
572 'creditbillpkgnum', 'serial', '', '', '', '',
573 'creditbillnum', 'int', '', '', '', '',
574 'billpkgnum', 'int', '', '', '', '',
575 'amount', @money_type, '', '',
576 'setuprecur', 'varchar', '', $char_d, '', '',
577 'sdate', @date_type, '', '',
578 'edate', @date_type, '', '',
580 'primary_key' => 'creditbillpkgnum',
582 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
587 'custnum', 'serial', '', '', '', '',
588 'agentnum', 'int', '', '', '', '',
589 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
590 'custbatch', 'varchar', 'NULL', $char_d, '', '',
591 # 'titlenum', 'int', 'NULL', '', '', '',
592 'last', 'varchar', '', $char_d, '', '',
593 # 'middle', 'varchar', 'NULL', $char_d, '', '',
594 'first', 'varchar', '', $char_d, '', '',
595 'ss', 'varchar', 'NULL', 11, '', '',
596 'stateid', 'varchar', 'NULL', $char_d, '', '',
597 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
598 'birthdate' ,@date_type, '', '',
599 'signupdate',@date_type, '', '',
600 'company', 'varchar', 'NULL', $char_d, '', '',
601 'address1', 'varchar', '', $char_d, '', '',
602 'address2', 'varchar', 'NULL', $char_d, '', '',
603 'city', 'varchar', '', $char_d, '', '',
604 'county', 'varchar', 'NULL', $char_d, '', '',
605 'state', 'varchar', 'NULL', $char_d, '', '',
606 'zip', 'varchar', 'NULL', 10, '', '',
607 'country', 'char', '', 2, '', '',
608 'daytime', 'varchar', 'NULL', 20, '', '',
609 'night', 'varchar', 'NULL', 20, '', '',
610 'fax', 'varchar', 'NULL', 12, '', '',
611 'ship_last', 'varchar', 'NULL', $char_d, '', '',
612 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
613 'ship_first', 'varchar', 'NULL', $char_d, '', '',
614 'ship_company', 'varchar', 'NULL', $char_d, '', '',
615 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
616 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
617 'ship_city', 'varchar', 'NULL', $char_d, '', '',
618 'ship_county', 'varchar', 'NULL', $char_d, '', '',
619 'ship_state', 'varchar', 'NULL', $char_d, '', '',
620 'ship_zip', 'varchar', 'NULL', 10, '', '',
621 'ship_country', 'char', 'NULL', 2, '', '',
622 'ship_daytime', 'varchar', 'NULL', 20, '', '',
623 'ship_night', 'varchar', 'NULL', 20, '', '',
624 'ship_fax', 'varchar', 'NULL', 12, '', '',
625 'payby', 'char', '', 4, '', '',
626 'payinfo', 'varchar', 'NULL', 512, '', '',
627 'paycvv', 'varchar', 'NULL', 512, '', '',
628 'paymask', 'varchar', 'NULL', $char_d, '', '',
629 #'paydate', @date_type, '', '',
630 'paydate', 'varchar', 'NULL', 10, '', '',
631 'paystart_month', 'int', 'NULL', '', '', '',
632 'paystart_year', 'int', 'NULL', '', '', '',
633 'payissue', 'varchar', 'NULL', 2, '', '',
634 'payname', 'varchar', 'NULL', $char_d, '', '',
635 'paystate', 'varchar', 'NULL', $char_d, '', '',
636 'paytype', 'varchar', 'NULL', $char_d, '', '',
637 'payip', 'varchar', 'NULL', 15, '', '',
638 'tax', 'char', 'NULL', 1, '', '',
639 'otaker', 'varchar', '', 32, '', '',
640 'refnum', 'int', '', '', '', '',
641 'referral_custnum', 'int', 'NULL', '', '', '',
642 'comments', 'text', 'NULL', '', '', '',
643 'spool_cdr','char', 'NULL', 1, '', '',
644 'squelch_cdr','char', 'NULL', 1, '', '',
645 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
647 'primary_key' => 'custnum',
648 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
649 #'index' => [ ['last'], ['company'] ],
650 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
651 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
652 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
653 [ 'ship_last' ], [ 'ship_company' ],
654 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
655 [ 'payby' ], [ 'paydate' ],
656 [ 'agentnum' ], [ 'custbatch' ],
660 'cust_main_invoice' => {
662 'destnum', 'serial', '', '', '', '',
663 'custnum', 'int', '', '', '', '',
664 'dest', 'varchar', '', $char_d, '', '',
666 'primary_key' => 'destnum',
668 'index' => [ ['custnum'], ],
671 'cust_main_note' => {
673 'notenum', 'serial', '', '', '', '',
674 'custnum', 'int', '', '', '', '',
675 '_date', @date_type, '', '',
676 'otaker', 'varchar', '', 32, '', '',
677 'comments', 'text', 'NULL', '', '', '',
679 'primary_key' => 'notenum',
681 'index' => [ [ 'custnum' ], [ '_date' ], ],
684 'cust_main_county' => { #county+state+country are checked off the
685 #cust_main_county for validation and to provide
688 'taxnum', 'serial', '', '', '', '',
689 'state', 'varchar', 'NULL', $char_d, '', '',
690 'county', 'varchar', 'NULL', $char_d, '', '',
691 'country', 'char', '', 2, '', '',
692 'taxclass', 'varchar', 'NULL', $char_d, '', '',
693 'exempt_amount', @money_type, '', '',
694 'tax', 'real', '', '', '', '', #tax %
695 'taxname', 'varchar', 'NULL', $char_d, '', '',
696 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
697 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
699 'primary_key' => 'taxnum',
701 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
702 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
707 'taxnum', 'serial', '', '', '', '',
708 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
709 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
710 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
711 'taxclassnum', 'int', '', '', '', '',
712 'effective_date', @date_type, '', '',
713 'tax', 'real', '', '', '', '', # tax %
714 'excessrate', 'real', 'NULL','', '', '', # second tax %
715 'taxbase', @money_typen, '', '', # amount at first tax rate
716 'taxmax', @money_typen, '', '', # maximum about at both rates
717 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
718 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
719 'unittype', 'int', 'NULL', '', '', '', # for fee
720 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
721 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
722 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
723 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
724 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
725 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
726 'taxauth', 'int', 'NULL', '', '', '', # tax authority
727 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
728 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
729 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
730 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
731 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
732 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
733 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
735 'primary_key' => 'taxnum',
737 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
740 'cust_tax_location' => {
742 'custlocationnum', 'serial', '', '', '', '',
743 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
744 'zip', 'char', '', 5, '', '',
745 'state', 'char', '', 2, '', '',
746 'plus4hi', 'char', '', 4, '', '',
747 'plus4lo', 'char', '', 4, '', '',
748 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
749 'geocode', 'varchar', '', 20, '', '',
751 'primary_key' => 'custlocationnum',
753 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
758 'taxclassnum', 'serial', '', '', '', '',
759 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
760 'taxclass', 'varchar', '', $char_d, '', '',
761 'description', 'varchar', '', 2*$char_d, '', '',
763 'primary_key' => 'taxclassnum',
764 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
768 'cust_pay_pending' => {
770 'paypendingnum','serial', '', '', '', '',
771 'custnum', 'int', '', '', '', '',
772 'paid', @money_type, '', '',
773 '_date', @date_type, '', '',
774 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
775 # be index into payby
777 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
778 'paymask', 'varchar', 'NULL', $char_d, '', '',
779 'paydate', 'varchar', 'NULL', 10, '', '',
780 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
781 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
783 'status', 'varchar', '', $char_d, '', '',
784 'statustext', 'text', 'NULL', '', '', '',
785 'gatewaynum', 'int', 'NULL', '', '', '',
786 #'cust_balance', @money_type, '', '',
787 'paynum', 'int', 'NULL', '', '', '',
789 'primary_key' => 'paypendingnum',
790 'unique' => [ [ 'payunique' ] ],
791 'index' => [ [ 'custnum' ], [ 'status' ], ],
796 'paynum', 'serial', '', '', '', '',
797 'custnum', 'int', '', '', '', '',
798 '_date', @date_type, '', '',
799 'paid', @money_type, '', '',
800 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
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 'paydate', 'varchar', 'NULL', 10, '', '',
807 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
808 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
809 'closed', 'char', 'NULL', 1, '', '',
811 'primary_key' => 'paynum',
812 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
813 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
818 'paynum', 'int', '', '', '', '',
819 'custnum', 'int', '', '', '', '',
820 'paid', @money_type, '', '',
821 '_date', @date_type, '', '',
822 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
823 # index into payby table
825 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
826 'paymask', 'varchar', 'NULL', $char_d, '', '',
827 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
828 'closed', 'char', 'NULL', 1, '', '',
829 'void_date', @date_type, '', '',
830 'reason', 'varchar', 'NULL', $char_d, '', '',
831 'otaker', 'varchar', '', 32, '', '',
833 'primary_key' => 'paynum',
835 'index' => [ [ 'custnum' ] ],
840 'billpaynum', 'serial', '', '', '', '',
841 'invnum', 'int', '', '', '', '',
842 'paynum', 'int', '', '', '', '',
843 'amount', @money_type, '', '',
844 '_date', @date_type, '', '',
846 'primary_key' => 'billpaynum',
848 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
851 'cust_bill_pay_batch' => {
853 'billpaynum', 'serial', '', '', '', '',
854 'invnum', 'int', '', '', '', '',
855 'paybatchnum', 'int', '', '', '', '',
856 'amount', @money_type, '', '',
857 '_date', @date_type, '', '',
859 'primary_key' => 'billpaynum',
861 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
864 'cust_bill_pay_pkg' => {
866 'billpaypkgnum', 'serial', '', '', '', '',
867 'billpaynum', 'int', '', '', '', '',
868 'billpkgnum', 'int', '', '', '', '',
869 'amount', @money_type, '', '',
870 'setuprecur', 'varchar', '', $char_d, '', '',
871 'sdate', @date_type, '', '',
872 'edate', @date_type, '', '',
874 'primary_key' => 'billpaypkgnum',
876 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
879 'pay_batch' => { #batches of payments to an external processor
881 'batchnum', 'serial', '', '', '', '',
882 'payby', 'char', '', 4, '', '', # CARD/CHEK
883 'status', 'char', 'NULL', 1, '', '',
884 'download', @date_type, '', '',
885 'upload', @date_type, '', '',
887 'primary_key' => 'batchnum',
892 'cust_pay_batch' => { #what's this used for again? list of customers
893 #in current CARD batch? (necessarily CARD?)
895 'paybatchnum', 'serial', '', '', '', '',
896 'batchnum', 'int', '', '', '', '',
897 'invnum', 'int', '', '', '', '',
898 'custnum', 'int', '', '', '', '',
899 'last', 'varchar', '', $char_d, '', '',
900 'first', 'varchar', '', $char_d, '', '',
901 'address1', 'varchar', '', $char_d, '', '',
902 'address2', 'varchar', 'NULL', $char_d, '', '',
903 'city', 'varchar', '', $char_d, '', '',
904 'state', 'varchar', 'NULL', $char_d, '', '',
905 'zip', 'varchar', 'NULL', 10, '', '',
906 'country', 'char', '', 2, '', '',
907 # 'trancode', 'int', '', '', '', ''
908 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
909 'payinfo', 'varchar', '', 512, '', '',
910 #'exp', @date_type, '', ''
911 'exp', 'varchar', 'NULL', 11, '', '',
912 'payname', 'varchar', 'NULL', $char_d, '', '',
913 'amount', @money_type, '', '',
914 'status', 'varchar', 'NULL', $char_d, '', '',
916 'primary_key' => 'paybatchnum',
918 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
923 'pkgnum', 'serial', '', '', '', '',
924 'custnum', 'int', '', '', '', '',
925 'pkgpart', 'int', '', '', '', '',
926 'otaker', 'varchar', '', 32, '', '',
927 'setup', @date_type, '', '',
928 'bill', @date_type, '', '',
929 'last_bill', @date_type, '', '',
930 'susp', @date_type, '', '',
931 'adjourn', @date_type, '', '',
932 'cancel', @date_type, '', '',
933 'expire', @date_type, '', '',
934 'change_date', @date_type, '', '',
935 'change_pkgnum', 'int', 'NULL', '', '', '',
936 'change_pkgpart', 'int', 'NULL', '', '', '',
937 'manual_flag', 'char', 'NULL', 1, '', '',
938 'quantity', 'int', 'NULL', '', '', '',
940 'primary_key' => 'pkgnum',
942 'index' => [ ['custnum'], ['pkgpart'],
943 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
944 ['expire'], ['cancel'],
949 'cust_pkg_option' => {
951 'optionnum', 'serial', '', '', '', '',
952 'pkgnum', 'int', '', '', '', '',
953 'optionname', 'varchar', '', $char_d, '', '',
954 'optionvalue', 'text', 'NULL', '', '', '',
956 'primary_key' => 'optionnum',
958 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
961 'cust_pkg_detail' => {
963 'pkgdetailnum', 'serial', '', '', '', '',
964 'pkgnum', 'int', '', '', '', '',
965 'detail', 'varchar', '', $char_d, '', '',
966 'detailtype', 'char', '', 1, '', '', # "I"nvoice or "C"omment
967 'weight', 'int', '', '', '', '',
969 'primary_key' => 'pkgdetailnum',
971 'index' => [ [ 'pkgnum', 'detailtype' ] ],
974 'cust_pkg_reason' => {
976 'num', 'serial', '', '', '', '',
977 'pkgnum', 'int', '', '', '', '',
978 'reasonnum','int', '', '', '', '',
979 'action', 'char', 'NULL', 1, '', '', #should not be nullable
980 'otaker', 'varchar', '', 32, '', '',
981 'date', @date_type, '', '',
983 'primary_key' => 'num',
985 'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
990 'refundnum', 'serial', '', '', '', '',
991 'custnum', 'int', '', '', '', '',
992 '_date', @date_type, '', '',
993 'refund', @money_type, '', '',
994 'otaker', 'varchar', '', 32, '', '',
995 'reason', 'varchar', '', $char_d, '', '',
996 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
997 # be index into payby
999 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1000 'paymask', 'varchar', 'NULL', $char_d, '', '',
1001 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1002 'closed', 'char', 'NULL', 1, '', '',
1004 'primary_key' => 'refundnum',
1006 'index' => [ ['custnum'], ['_date'] ],
1009 'cust_credit_refund' => {
1011 'creditrefundnum', 'serial', '', '', '', '',
1012 'crednum', 'int', '', '', '', '',
1013 'refundnum', 'int', '', '', '', '',
1014 'amount', @money_type, '', '',
1015 '_date', @date_type, '', '',
1017 'primary_key' => 'creditrefundnum',
1019 'index' => [ ['crednum'], ['refundnum'] ],
1025 'svcnum', 'serial', '', '', '', '',
1026 'pkgnum', 'int', 'NULL', '', '', '',
1027 'svcpart', 'int', '', '', '', '',
1028 'overlimit', @date_type, '', '',
1030 'primary_key' => 'svcnum',
1032 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1035 'cust_svc_option' => {
1037 'optionnum', 'serial', '', '', '', '',
1038 'svcnum', 'int', '', '', '', '',
1039 'optionname', 'varchar', '', $char_d, '', '',
1040 'optionvalue', 'text', 'NULL', '', '', '',
1042 'primary_key' => 'optionnum',
1044 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1049 'pkgpart', 'serial', '', '', '', '',
1050 'pkg', 'varchar', '', $char_d, '', '',
1051 'comment', 'varchar', '', $char_d, '', '',
1052 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1053 'setup', @perl_type, '', '',
1054 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1055 'recur', @perl_type, '', '',
1056 'setuptax', 'char', 'NULL', 1, '', '',
1057 'recurtax', 'char', 'NULL', 1, '', '',
1058 'plan', 'varchar', 'NULL', $char_d, '', '',
1059 'plandata', 'text', 'NULL', '', '', '',
1060 'disabled', 'char', 'NULL', 1, '', '',
1061 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1062 'classnum', 'int', 'NULL', '', '', '',
1063 'taxproductnum', 'int', 'NULL', '', '', '',
1064 'pay_weight', 'real', 'NULL', '', '', '',
1065 'credit_weight', 'real', 'NULL', '', '', '',
1066 'agentnum', 'int', 'NULL', '', '', '',
1069 'primary_key' => 'pkgpart',
1071 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1074 'part_pkg_link' => {
1076 'pkglinknum', 'serial', '', '', '', '',
1077 'src_pkgpart', 'int', '', '', '', '',
1078 'dst_pkgpart', 'int', '', '', '', '',
1079 'link_type', 'varchar', '', $char_d, '', '',
1081 'primary_key' => 'pkglinknum',
1082 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1083 'index' => [ [ 'src_pkgpart' ] ],
1086 'part_pkg_taxclass' => {
1088 'taxclassnum', 'serial', '', '', '', '',
1089 'taxclass', 'varchar', '', $char_d, '', '',
1091 'primary_key' => 'taxclassnum',
1092 'unique' => [ [ 'taxclass' ] ],
1096 'part_pkg_taxproduct' => {
1098 'taxproductnum', 'serial', '', '', '', '',
1099 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1100 'taxproduct', 'varchar', '', $char_d, '', '',
1101 'description', 'varchar', '', 2*$char_d, '', '',
1103 'primary_key' => 'taxproductnum',
1104 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1108 'part_pkg_taxrate' => {
1110 'pkgtaxratenum', 'serial', '', '', '', '',
1111 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1112 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1113 'taxproductnum', 'int', '', '', '', '',
1114 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1115 'county', 'varchar', 'NULL', $char_d, '', '',
1116 'state', 'varchar', 'NULL', $char_d, '', '',
1117 'local', 'varchar', 'NULL', $char_d, '', '',
1118 'country', 'char', 'NULL', 2, '', '',
1119 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1120 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1121 'taxclassnum', 'int', 'NULL', '', '', '',
1122 'effdate', @date_type, '', '',
1123 'taxable', 'char', 'NULL', 1, '', '',
1125 'primary_key' => 'pkgtaxratenum',
1127 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1130 'part_pkg_taxoverride' => {
1132 'taxoverridenum', 'serial', '', '', '', '',
1133 'pkgpart', 'serial', '', '', '', '',
1134 'taxclassnum', 'serial', '', '', '', '',
1135 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1137 'primary_key' => 'taxoverridenum',
1139 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1144 # 'titlenum', 'int', '', '',
1145 # 'title', 'varchar', '', $char_d,
1147 # 'primary_key' => 'titlenum',
1148 # 'unique' => [ [] ],
1149 # 'index' => [ [] ],
1154 'pkgsvcnum', 'serial', '', '', '', '',
1155 'pkgpart', 'int', '', '', '', '',
1156 'svcpart', 'int', '', '', '', '',
1157 'quantity', 'int', '', '', '', '',
1158 'primary_svc','char', 'NULL', 1, '', '',
1160 'primary_key' => 'pkgsvcnum',
1161 'unique' => [ ['pkgpart', 'svcpart'] ],
1162 'index' => [ ['pkgpart'] ],
1165 'part_referral' => {
1167 'refnum', 'serial', '', '', '', '',
1168 'referral', 'varchar', '', $char_d, '', '',
1169 'disabled', 'char', 'NULL', 1, '', '',
1170 'agentnum', 'int', 'NULL', '', '', '',
1172 'primary_key' => 'refnum',
1174 'index' => [ ['disabled'], ['agentnum'], ],
1179 'svcpart', 'serial', '', '', '', '',
1180 'svc', 'varchar', '', $char_d, '', '',
1181 'svcdb', 'varchar', '', $char_d, '', '',
1182 'disabled', 'char', 'NULL', 1, '', '',
1184 'primary_key' => 'svcpart',
1186 'index' => [ [ 'disabled' ] ],
1189 'part_svc_column' => {
1191 'columnnum', 'serial', '', '', '', '',
1192 'svcpart', 'int', '', '', '', '',
1193 'columnname', 'varchar', '', 64, '', '',
1194 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1195 'columnflag', 'char', 'NULL', 1, '', '',
1197 'primary_key' => 'columnnum',
1198 'unique' => [ [ 'svcpart', 'columnname' ] ],
1199 'index' => [ [ 'svcpart' ] ],
1202 #(this should be renamed to part_pop)
1205 'popnum', 'serial', '', '', '', '',
1206 'city', 'varchar', '', $char_d, '', '',
1207 'state', 'varchar', '', $char_d, '', '',
1208 'ac', 'char', '', 3, '', '',
1209 'exch', 'char', '', 3, '', '',
1210 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1212 'primary_key' => 'popnum',
1214 'index' => [ [ 'state' ] ],
1217 'part_pop_local' => {
1219 'localnum', 'serial', '', '', '', '',
1220 'popnum', 'int', '', '', '', '',
1221 'city', 'varchar', 'NULL', $char_d, '', '',
1222 'state', 'char', 'NULL', 2, '', '',
1223 'npa', 'char', '', 3, '', '',
1224 'nxx', 'char', '', 3, '', '',
1226 'primary_key' => 'localnum',
1228 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1233 'svcnum', 'int', '', '', '', '',
1234 'username', 'varchar', '', $username_len, '', '',
1235 '_password', 'varchar', '', 512, '', '',
1236 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1237 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1238 'popnum', 'int', 'NULL', '', '', '',
1239 'uid', 'int', 'NULL', '', '', '',
1240 'gid', 'int', 'NULL', '', '', '',
1241 'finger', 'varchar', 'NULL', $char_d, '', '',
1242 'dir', 'varchar', 'NULL', $char_d, '', '',
1243 'shell', 'varchar', 'NULL', $char_d, '', '',
1244 'quota', 'varchar', 'NULL', $char_d, '', '',
1245 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1246 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1247 'seconds_threshold', 'int', 'NULL', '', '', '',
1248 'upbytes', 'bigint', 'NULL', '', '', '',
1249 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1250 'downbytes', 'bigint', 'NULL', '', '', '',
1251 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1252 'totalbytes','bigint', 'NULL', '', '', '',
1253 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1254 'domsvc', 'int', '', '', '', '',
1255 'last_login', @date_type, '', '',
1256 'last_logout', @date_type, '', '',
1258 'primary_key' => 'svcnum',
1259 #'unique' => [ [ 'username', 'domsvc' ] ],
1261 'index' => [ ['username'], ['domsvc'] ],
1264 'acct_rt_transaction' => {
1266 'svcrtid', 'int', '', '', '', '',
1267 'svcnum', 'int', '', '', '', '',
1268 'transaction_id', 'int', '', '', '', '',
1269 '_date', @date_type, '', '',
1270 'seconds', 'int', '', '', '', '', #uhhhh
1271 'support', 'int', '', '', '', '',
1273 'primary_key' => 'svcrtid',
1275 'index' => [ ['svcnum', 'transaction_id'] ],
1280 # 'svcnum', 'int', '', '',
1281 # 'amount', @money_type,
1283 # 'primary_key' => 'svcnum',
1284 # 'unique' => [ [] ],
1285 # 'index' => [ [] ],
1290 'svcnum', 'int', '', '', '', '',
1291 'domain', 'varchar', '', $char_d, '', '',
1292 'suffix', 'varchar', 'NULL', $char_d, '', '',
1293 'catchall', 'int', 'NULL', '', '', '',
1294 'parent_svcnum', 'int', 'NULL', '', '', '',
1295 'registrarnum', 'int', 'NULL', '', '', '',
1296 'registrarkey', 'varchar', 'NULL', 512, '', '',
1297 'setup_date', @date_type, '', '',
1298 'renewal_interval', 'int', 'NULL', '', '', '',
1299 'expiration_date', @date_type, '', '',
1301 'primary_key' => 'svcnum',
1303 'index' => [ ['domain'] ],
1306 'domain_record' => {
1308 'recnum', 'serial', '', '', '', '',
1309 'svcnum', 'int', '', '', '', '',
1310 'reczone', 'varchar', '', 255, '', '',
1311 'recaf', 'char', '', 2, '', '',
1312 'rectype', 'varchar', '', 5, '', '',
1313 'recdata', 'varchar', '', 255, '', '',
1315 'primary_key' => 'recnum',
1317 'index' => [ ['svcnum'] ],
1322 'registrarnum', 'serial', '', '', '', '',
1323 'registrarname', 'varchar', '', $char_d, '', '',
1325 'primary_key' => 'registrarnum',
1332 'svcnum', 'int', '', '', '', '',
1333 'srcsvc', 'int', 'NULL', '', '', '',
1334 'src', 'varchar', 'NULL', 255, '', '',
1335 'dstsvc', 'int', 'NULL', '', '', '',
1336 'dst', 'varchar', 'NULL', 255, '', '',
1338 'primary_key' => 'svcnum',
1340 'index' => [ ['srcsvc'], ['dstsvc'] ],
1345 'svcnum', 'int', '', '', '', '',
1346 'recnum', 'int', '', '', '', '',
1347 'usersvc', 'int', 'NULL', '', '', '',
1348 'config', 'text', 'NULL', '', '', '',
1350 'primary_key' => 'svcnum',
1357 # 'svcnum', 'int', '', '',
1358 # 'svcnum', 'int', '', '',
1359 # 'svcnum', 'int', '', '',
1360 # 'worker', 'varchar', '', $char_d,
1361 # '_date', @date_type,
1363 # 'primary_key' => 'svcnum',
1364 # 'unique' => [ [] ],
1365 # 'index' => [ [] ],
1368 'prepay_credit' => {
1370 'prepaynum', 'serial', '', '', '', '',
1371 'identifier', 'varchar', '', $char_d, '', '',
1372 'amount', @money_type, '', '',
1373 'seconds', 'int', 'NULL', '', '', '',
1374 'upbytes', 'bigint', 'NULL', '', '', '',
1375 'downbytes', 'bigint', 'NULL', '', '', '',
1376 'totalbytes', 'bigint', 'NULL', '', '', '',
1377 'agentnum', 'int', 'NULL', '', '', '',
1379 'primary_key' => 'prepaynum',
1380 'unique' => [ ['identifier'] ],
1386 'portnum', 'serial', '', '', '', '',
1387 'ip', 'varchar', 'NULL', 15, '', '',
1388 'nasport', 'int', 'NULL', '', '', '',
1389 'nasnum', 'int', '', '', '', '',
1391 'primary_key' => 'portnum',
1398 'nasnum', 'serial', '', '', '', '',
1399 'nas', 'varchar', '', $char_d, '', '',
1400 'nasip', 'varchar', '', 15, '', '',
1401 'nasfqdn', 'varchar', '', $char_d, '', '',
1402 'last', 'int', '', '', '', '',
1404 'primary_key' => 'nasnum',
1405 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1406 'index' => [ [ 'last' ] ],
1411 # 'sessionnum', 'serial', '', '', '', '',
1412 # 'portnum', 'int', '', '', '', '',
1413 # 'svcnum', 'int', '', '', '', '',
1414 # 'login', @date_type, '', '',
1415 # 'logout', @date_type, '', '',
1417 # 'primary_key' => 'sessionnum',
1419 # 'index' => [ [ 'portnum' ] ],
1424 'jobnum', 'serial', '', '', '', '',
1425 'job', 'text', '', '', '', '',
1426 '_date', 'int', '', '', '', '',
1427 'status', 'varchar', '', $char_d, '', '',
1428 'statustext', 'text', 'NULL', '', '', '',
1429 'svcnum', 'int', 'NULL', '', '', '',
1430 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1433 'primary_key' => 'jobnum',
1435 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1440 'argnum', 'serial', '', '', '', '',
1441 'jobnum', 'int', '', '', '', '',
1442 'arg', 'text', 'NULL', '', '', '',
1444 'primary_key' => 'argnum',
1446 'index' => [ [ 'jobnum' ] ],
1451 'dependnum', 'serial', '', '', '', '',
1452 'jobnum', 'int', '', '', '', '',
1453 'depend_jobnum', 'int', '', '', '', '',
1455 'primary_key' => 'dependnum',
1457 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1462 'exportsvcnum' => 'serial', '', '', '', '',
1463 'exportnum' => 'int', '', '', '', '',
1464 'svcpart' => 'int', '', '', '', '',
1466 'primary_key' => 'exportsvcnum',
1467 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1468 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1473 'exportnum', 'serial', '', '', '', '',
1474 'machine', 'varchar', '', $char_d, '', '',
1475 'exporttype', 'varchar', '', $char_d, '', '',
1476 'nodomain', 'char', 'NULL', 1, '', '',
1478 'primary_key' => 'exportnum',
1480 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1483 'part_export_option' => {
1485 'optionnum', 'serial', '', '', '', '',
1486 'exportnum', 'int', '', '', '', '',
1487 'optionname', 'varchar', '', $char_d, '', '',
1488 'optionvalue', 'text', 'NULL', '', '', '',
1490 'primary_key' => 'optionnum',
1492 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1495 'radius_usergroup' => {
1497 'usergroupnum', 'serial', '', '', '', '',
1498 'svcnum', 'int', '', '', '', '',
1499 'groupname', 'varchar', '', $char_d, '', '',
1501 'primary_key' => 'usergroupnum',
1503 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1508 'msgnum', 'serial', '', '', '', '',
1509 'msgcode', 'varchar', '', $char_d, '', '',
1510 'locale', 'varchar', '', 16, '', '',
1511 'msg', 'text', '', '', '', '',
1513 'primary_key' => 'msgnum',
1514 'unique' => [ [ 'msgcode', 'locale' ] ],
1518 'cust_tax_exempt' => {
1520 'exemptnum', 'serial', '', '', '', '',
1521 'custnum', 'int', '', '', '', '',
1522 'taxnum', 'int', '', '', '', '',
1523 'year', 'int', '', '', '', '',
1524 'month', 'int', '', '', '', '',
1525 'amount', @money_type, '', '',
1527 'primary_key' => 'exemptnum',
1528 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1532 'cust_tax_exempt_pkg' => {
1534 'exemptpkgnum', 'serial', '', '', '', '',
1535 #'custnum', 'int', '', '', '', ''
1536 'billpkgnum', 'int', '', '', '', '',
1537 'taxnum', 'int', '', '', '', '',
1538 'year', 'int', '', '', '', '',
1539 'month', 'int', '', '', '', '',
1540 'amount', @money_type, '', '',
1542 'primary_key' => 'exemptpkgnum',
1544 'index' => [ [ 'taxnum', 'year', 'month' ],
1552 'routernum', 'serial', '', '', '', '',
1553 'routername', 'varchar', '', $char_d, '', '',
1554 'svcnum', 'int', 'NULL', '', '', '',
1555 'agentnum', 'int', 'NULL', '', '', '',
1557 'primary_key' => 'routernum',
1562 'part_svc_router' => {
1564 'svcrouternum', 'serial', '', '', '', '',
1565 'svcpart', 'int', '', '', '', '',
1566 'routernum', 'int', '', '', '', '',
1568 'primary_key' => 'svcrouternum',
1575 'blocknum', 'serial', '', '', '', '',
1576 'routernum', 'int', '', '', '', '',
1577 'ip_gateway', 'varchar', '', 15, '', '',
1578 'ip_netmask', 'int', '', '', '', '',
1579 'agentnum', 'int', 'NULL', '', '', '',
1581 'primary_key' => 'blocknum',
1582 'unique' => [ [ 'blocknum', 'routernum' ] ],
1586 'svc_broadband' => {
1588 'svcnum', 'int', '', '', '', '',
1589 'description', 'varchar', 'NULL', $char_d, '', '',
1590 'blocknum', 'int', '', '', '', '',
1591 'speed_up', 'int', '', '', '', '',
1592 'speed_down', 'int', '', '', '', '',
1593 'ip_addr', 'varchar', '', 15, '', '',
1594 'mac_addr', 'varchar', 'NULL', 12, '', '',
1595 'authkey', 'varchar', 'NULL', 32, '', '',
1596 'latitude', 'decimal', 'NULL', '', '', '',
1597 'longitude', 'decimal', 'NULL', '', '', '',
1598 'altitude', 'decimal', 'NULL', '', '', '',
1599 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1601 'primary_key' => 'svcnum',
1606 'part_virtual_field' => {
1608 'vfieldpart', 'serial', '', '', '', '',
1609 'dbtable', 'varchar', '', 32, '', '',
1610 'name', 'varchar', '', 32, '', '',
1611 'check_block', 'text', 'NULL', '', '', '',
1612 'length', 'int', 'NULL', '', '', '',
1613 'list_source', 'text', 'NULL', '', '', '',
1614 'label', 'varchar', 'NULL', 80, '', '',
1616 'primary_key' => 'vfieldpart',
1621 'virtual_field' => {
1623 'vfieldnum', 'serial', '', '', '', '',
1624 'recnum', 'int', '', '', '', '',
1625 'vfieldpart', 'int', '', '', '', '',
1626 'value', 'varchar', '', 128, '', '',
1628 'primary_key' => 'vfieldnum',
1629 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1635 'snarfnum', 'int', '', '', '', '',
1636 'svcnum', 'int', '', '', '', '',
1637 'machine', 'varchar', '', 255, '', '',
1638 'protocol', 'varchar', '', $char_d, '', '',
1639 'username', 'varchar', '', $char_d, '', '',
1640 '_password', 'varchar', '', $char_d, '', '',
1642 'primary_key' => 'snarfnum',
1644 'index' => [ [ 'svcnum' ] ],
1649 'svcnum', 'int', '', '', '', '',
1650 'id', 'int', 'NULL', '', '', '',
1651 'title', 'varchar', 'NULL', $char_d, '', '',
1653 'primary_key' => 'svcnum',
1658 'cust_pay_refund' => {
1660 'payrefundnum', 'serial', '', '', '', '',
1661 'paynum', 'int', '', '', '', '',
1662 'refundnum', 'int', '', '', '', '',
1663 '_date', @date_type, '', '',
1664 'amount', @money_type, '', '',
1666 'primary_key' => 'payrefundnum',
1668 'index' => [ ['paynum'], ['refundnum'] ],
1671 'part_pkg_option' => {
1673 'optionnum', 'serial', '', '', '', '',
1674 'pkgpart', 'int', '', '', '', '',
1675 'optionname', 'varchar', '', $char_d, '', '',
1676 'optionvalue', 'text', 'NULL', '', '', '',
1678 'primary_key' => 'optionnum',
1680 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1685 'ratenum', 'serial', '', '', '', '',
1686 'ratename', 'varchar', '', $char_d, '', '',
1688 'primary_key' => 'ratenum',
1695 'ratedetailnum', 'serial', '', '', '', '',
1696 'ratenum', 'int', '', '', '', '',
1697 'orig_regionnum', 'int', 'NULL', '', '', '',
1698 'dest_regionnum', 'int', '', '', '', '',
1699 'min_included', 'int', '', '', '', '',
1700 #'min_charge', @money_type, '', '',
1701 'min_charge', 'decimal', '', '10,5', '', '',
1702 'sec_granularity', 'int', '', '', '', '',
1703 #time period (link to table of periods)?
1704 'classnum', 'int', 'NULL', '', '', '',
1706 'primary_key' => 'ratedetailnum',
1707 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1708 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1713 'regionnum', 'serial', '', '', '', '',
1714 'regionname', 'varchar', '', $char_d, '', '',
1716 'primary_key' => 'regionnum',
1723 'prefixnum', 'serial', '', '', '', '',
1724 'regionnum', 'int', '', '',, '', '',
1725 'countrycode', 'varchar', '', 3, '', '',
1726 'npa', 'varchar', 'NULL', 6, '', '',
1727 'nxx', 'varchar', 'NULL', 3, '', '',
1729 'primary_key' => 'prefixnum',
1731 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1736 'classnum', 'serial', '', '', '', '',
1737 'classname', 'varchar', '', $char_d, '', '',
1738 'disabled', 'char', 'NULL', 1, '', '',
1740 'primary_key' => 'classnum',
1742 'index' => [ ['disabled'] ],
1747 'codenum', 'serial', '', '', '', '',
1748 'code', 'varchar', '', $char_d, '', '',
1749 'agentnum', 'int', '', '', '', '',
1751 'primary_key' => 'codenum',
1752 'unique' => [ [ 'agentnum', 'code' ] ],
1753 'index' => [ [ 'agentnum' ] ],
1758 'codepkgnum', 'serial', '', '', '', '',
1759 'codenum', 'int', '', '', '', '',
1760 'pkgpart', 'int', '', '', '', '',
1762 'primary_key' => 'codepkgnum',
1763 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1764 'index' => [ [ 'codenum' ] ],
1767 'clientapi_session' => {
1769 'sessionnum', 'serial', '', '', '', '',
1770 'sessionid', 'varchar', '', $char_d, '', '',
1771 'namespace', 'varchar', '', $char_d, '', '',
1773 'primary_key' => 'sessionnum',
1774 'unique' => [ [ 'sessionid', 'namespace' ] ],
1778 'clientapi_session_field' => {
1780 'fieldnum', 'serial', '', '', '', '',
1781 'sessionnum', 'int', '', '', '', '',
1782 'fieldname', 'varchar', '', $char_d, '', '',
1783 'fieldvalue', 'text', 'NULL', '', '', '',
1785 'primary_key' => 'fieldnum',
1786 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1790 'payment_gateway' => {
1792 'gatewaynum', 'serial', '', '', '', '',
1793 'gateway_module', 'varchar', '', $char_d, '', '',
1794 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1795 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1796 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1797 'disabled', 'char', 'NULL', 1, '', '',
1799 'primary_key' => 'gatewaynum',
1801 'index' => [ [ 'disabled' ] ],
1804 'payment_gateway_option' => {
1806 'optionnum', 'serial', '', '', '', '',
1807 'gatewaynum', 'int', '', '', '', '',
1808 'optionname', 'varchar', '', $char_d, '', '',
1809 'optionvalue', 'text', 'NULL', '', '', '',
1811 'primary_key' => 'optionnum',
1813 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1816 'agent_payment_gateway' => {
1818 'agentgatewaynum', 'serial', '', '', '', '',
1819 'agentnum', 'int', '', '', '', '',
1820 'gatewaynum', 'int', '', '', '', '',
1821 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1822 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1824 'primary_key' => 'agentgatewaynum',
1826 'index' => [ [ 'agentnum', 'cardtype' ], ],
1831 'bannum', 'serial', '', '', '', '',
1832 'payby', 'char', '', 4, '', '',
1833 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1834 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1835 '_date', @date_type, '', '',
1836 'otaker', 'varchar', '', 32, '', '',
1837 'reason', 'varchar', 'NULL', $char_d, '', '',
1839 'primary_key' => 'bannum',
1840 'unique' => [ [ 'payby', 'payinfo' ] ],
1846 'categorynum', 'serial', '', '', '', '',
1847 'categoryname', 'varchar', '', $char_d, '', '',
1848 'disabled', 'char', 'NULL', 1, '', '',
1850 'primary_key' => 'categorynum',
1852 'index' => [ ['disabled'] ],
1857 'classnum', 'serial', '', '', '', '',
1858 'classname', 'varchar', '', $char_d, '', '',
1859 'categorynum', 'int', 'NULL', '', '', '',
1860 'disabled', 'char', 'NULL', 1, '', '',
1862 'primary_key' => 'classnum',
1864 'index' => [ ['disabled'] ],
1869 # qw( name type null length default local );
1875 'acctid', 'bigserial', '', '', '', '',
1876 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1877 'calldate', 'timestamp', '', '', \'now()', '',
1878 'clid', 'varchar', '', $char_d, \"''", '',
1879 'src', 'varchar', '', $char_d, \"''", '',
1880 'dst', 'varchar', '', $char_d, \"''", '',
1881 'dcontext', 'varchar', '', $char_d, \"''", '',
1882 'channel', 'varchar', '', $char_d, \"''", '',
1883 'dstchannel', 'varchar', '', $char_d, \"''", '',
1884 'lastapp', 'varchar', '', $char_d, \"''", '',
1885 'lastdata', 'varchar', '', $char_d, \"''", '',
1887 #these don't seem to be logged by most of the SQL cdr_* modules
1888 #except tds under sql-illegal names, so;
1889 # ... don't rely on them for rating?
1890 # and, what they hey, i went ahead and changed the names and data types
1891 # to freeside-style dates...
1892 #'start', 'timestamp', 'NULL', '', '', '',
1893 #'answer', 'timestamp', 'NULL', '', '', '',
1894 #'end', 'timestamp', 'NULL', '', '', '',
1895 'startdate', @date_type, '', '',
1896 'answerdate', @date_type, '', '',
1897 'enddate', @date_type, '', '',
1900 'duration', 'int', '', '', 0, '',
1901 'billsec', 'int', '', '', 0, '',
1902 'disposition', 'varchar', '', 45, \"''", '',
1903 'amaflags', 'int', '', '', 0, '',
1904 'accountcode', 'varchar', '', 20, \"''", '',
1905 'uniqueid', 'varchar', '', 32, \"''", '',
1906 'userfield', 'varchar', '', 255, \"''", '',
1909 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1913 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1914 'cdrtypenum', 'int', 'NULL', '', '', '',
1916 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1918 'upstream_currency', 'char', 'NULL', 3, '', '',
1919 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1920 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1922 # how it was rated internally...
1923 'ratedetailnum', 'int', 'NULL', '', '', '',
1924 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1926 'distance', 'decimal', 'NULL', '', '', '',
1927 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1929 #cdr_calltype: the big list in appendix 2
1930 'calltypenum', 'int', 'NULL', '', '', '',
1932 'description', 'varchar', 'NULL', $char_d, '', '',
1933 'quantity', 'int', 'NULL', '', '', '',
1935 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1936 'carrierid', 'int', 'NULL', '', '', '',
1938 'upstream_rateid', 'int', 'NULL', '', '', '',
1941 #and now for our own fields
1944 # a svcnum... right..?
1945 'svcnum', 'int', 'NULL', '', '', '',
1947 #NULL, done (or something)
1948 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1950 'cdrbatch', 'varchar', 'NULL', $char_d, '', '',
1953 'primary_key' => 'acctid',
1955 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'cdrbatch' ], ],
1960 'calltypenum', 'serial', '', '', '', '',
1961 'calltypename', 'varchar', '', $char_d, '', '',
1963 'primary_key' => 'calltypenum',
1970 'cdrtypenum' => 'serial', '', '', '', '',
1971 'cdrtypename' => 'varchar', '', $char_d, '', '',
1973 'primary_key' => 'cdrtypenum',
1980 'carrierid' => 'serial', '', '', '', '',
1981 'carriername' => 'varchar', '', $char_d, '', '',
1983 'primary_key' => 'carrierid',
1988 #map upstream rateid to ours...
1989 'cdr_upstream_rate' => {
1991 'upstreamratenum', 'serial', '', '', '', '',
1992 'upstream_rateid', 'varchar', '', $char_d, '', '',
1993 'ratedetailnum', 'int', 'NULL', '', '', '',
1995 'primary_key' => 'upstreamratenum', #XXX need a primary key
1996 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2000 'inventory_item' => {
2002 'itemnum', 'serial', '', '', '', '',
2003 'classnum', 'int', '', '', '', '',
2004 'item', 'varchar', '', $char_d, '', '',
2005 'svcnum', 'int', 'NULL', '', '', '',
2007 'primary_key' => 'itemnum',
2008 'unique' => [ [ 'classnum', 'item' ] ],
2009 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2012 'inventory_class' => {
2014 'classnum', 'serial', '', '', '', '',
2015 'classname', 'varchar', '', $char_d, '', '',
2017 'primary_key' => 'classnum',
2024 'usernum', 'serial', '', '', '', '',
2025 'username', 'varchar', '', $char_d, '', '',
2026 '_password', 'varchar', '', $char_d, '', '',
2027 'last', 'varchar', '', $char_d, '', '',
2028 'first', 'varchar', '', $char_d, '', '',
2029 'disabled', 'char', 'NULL', 1, '', '',
2031 'primary_key' => 'usernum',
2032 'unique' => [ [ 'username' ] ],
2036 'access_user_pref' => {
2038 'prefnum', 'serial', '', '', '', '',
2039 'usernum', 'int', '', '', '', '',
2040 'prefname', 'varchar', '', $char_d, '', '',
2041 'prefvalue', 'text', 'NULL', '', '', '',
2042 'expiration', @date_type, '', '',
2044 'primary_key' => 'prefnum',
2046 'index' => [ [ 'usernum' ] ],
2051 'groupnum', 'serial', '', '', '', '',
2052 'groupname', 'varchar', '', $char_d, '', '',
2054 'primary_key' => 'groupnum',
2055 'unique' => [ [ 'groupname' ] ],
2059 'access_usergroup' => {
2061 'usergroupnum', 'serial', '', '', '', '',
2062 'usernum', 'int', '', '', '', '',
2063 'groupnum', 'int', '', '', '', '',
2065 'primary_key' => 'usergroupnum',
2066 'unique' => [ [ 'usernum', 'groupnum' ] ],
2067 'index' => [ [ 'usernum' ] ],
2070 'access_groupagent' => {
2072 'groupagentnum', 'serial', '', '', '', '',
2073 'groupnum', 'int', '', '', '', '',
2074 'agentnum', 'int', '', '', '', '',
2076 'primary_key' => 'groupagentnum',
2077 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2078 'index' => [ [ 'groupnum' ] ],
2083 'rightnum', 'serial', '', '', '', '',
2084 'righttype', 'varchar', '', $char_d, '', '',
2085 'rightobjnum', 'int', '', '', '', '',
2086 'rightname', 'varchar', '', $char_d, '', '',
2088 'primary_key' => 'rightnum',
2089 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2095 'svcnum', 'int', '', '', '', '',
2096 'countrycode', 'varchar', '', 3, '', '',
2097 'phonenum', 'varchar', '', 15, '', '', #12 ?
2098 'pin', 'varchar', 'NULL', $char_d, '', '',
2099 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2100 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2102 'primary_key' => 'svcnum',
2104 'index' => [ [ 'countrycode', 'phonenum' ] ],
2109 'availnum', 'int', '', '', '', '',
2110 'exportnum', 'int', '', '', '', '',
2111 'countrycode', 'varchar', '', 3, '', '',
2112 'state', 'char', 'NULL', 2, '', '',
2113 'npa', 'char', '', 3, '', '',
2114 'nxx', 'char', 'NULL', 3, '', '',
2116 'primary_key' => 'availnum',
2118 'index' => [ [ 'exportnum', 'countrycode', 'state' ] ],
2123 'typenum', 'serial', '', '', '', '',
2124 'class', 'char', '', 1, '', '',
2125 'type', 'varchar', '', $char_d, '', '',
2127 'primary_key' => 'typenum',
2134 'reasonnum', 'serial', '', '', '', '',
2135 'reason_type', 'int', '', '', '', '',
2136 'reason', 'text', '', '', '', '',
2137 'disabled', 'char', 'NULL', 1, '', '',
2139 'primary_key' => 'reasonnum',
2146 'confnum', 'serial', '', '', '', '',
2147 'agentnum', 'int', 'NULL', '', '', '',
2148 'name', 'varchar', '', $char_d, '', '',
2149 'value', 'text', 'NULL', '', '', '',
2151 'primary_key' => 'confnum',
2152 'unique' => [ [ 'agentnum', 'name' ]],
2158 'pkgrefnum', 'serial', '', '', '', '',
2159 'pkgnum', 'int', '', '', '', '',
2160 'refnum', 'int', '', '', '', '',
2162 'primary_key' => 'pkgrefnum',
2163 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2164 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2166 # name type nullability length default local
2170 # 'num', 'serial', '', '', '', '',
2172 # 'primary_key' => 'num',