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 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
626 'primary_key' => 'custnum',
627 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
628 #'index' => [ ['last'], ['company'] ],
629 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
630 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
631 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
632 [ 'ship_last' ], [ 'ship_company' ],
633 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
634 [ 'payby' ], [ 'paydate' ],
638 'cust_main_invoice' => {
640 'destnum', 'serial', '', '', '', '',
641 'custnum', 'int', '', '', '', '',
642 'dest', 'varchar', '', $char_d, '', '',
644 'primary_key' => 'destnum',
646 'index' => [ ['custnum'], ],
649 'cust_main_note' => {
651 'notenum', 'serial', '', '', '', '',
652 'custnum', 'int', '', '', '', '',
653 '_date', @date_type, '', '',
654 'otaker', 'varchar', '', 32, '', '',
655 'comments', 'text', 'NULL', '', '', '',
657 'primary_key' => 'notenum',
659 'index' => [ [ 'custnum' ], [ '_date' ], ],
662 'cust_main_county' => { #county+state+country are checked off the
663 #cust_main_county for validation and to provide
666 'taxnum', 'serial', '', '', '', '',
667 'state', 'varchar', 'NULL', $char_d, '', '',
668 'county', 'varchar', 'NULL', $char_d, '', '',
669 'country', 'char', '', 2, '', '',
670 'taxclass', 'varchar', 'NULL', $char_d, '', '',
671 'exempt_amount', @money_type, '', '',
672 'tax', 'real', '', '', '', '', #tax %
673 'taxname', 'varchar', 'NULL', $char_d, '', '',
674 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
675 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
677 'primary_key' => 'taxnum',
679 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
680 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
685 'taxnum', 'serial', '', '', '', '',
686 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
687 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
688 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
689 'taxclassnum', 'int', '', '', '', '',
690 'effective_date', @date_type, '', '',
691 'tax', 'real', '', '', '', '', # tax %
692 'excessrate', 'real', 'NULL','', '', '', # second tax %
693 'taxbase', @money_typen, '', '', # amount at first tax rate
694 'taxmax', @money_typen, '', '', # maximum about at both rates
695 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
696 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
697 'unittype', 'int', 'NULL', '', '', '', # for fee
698 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
699 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
700 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
701 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
702 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
703 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
704 'taxauth', 'int', 'NULL', '', '', '', # tax authority
705 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
706 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
707 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
708 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
709 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
710 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
711 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
713 'primary_key' => 'taxnum',
715 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
718 'cust_tax_location' => {
720 'custlocationnum', 'serial', '', '', '', '',
721 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
722 'zip', 'char', '', 5, '', '',
723 'state', 'char', '', 2, '', '',
724 'plus4hi', 'char', '', 4, '', '',
725 'plus4lo', 'char', '', 4, '', '',
726 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
727 'geocode', 'varchar', '', 20, '', '',
729 'primary_key' => 'custlocationnum',
731 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
736 'taxclassnum', 'serial', '', '', '', '',
737 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
738 'taxclass', 'varchar', '', $char_d, '', '',
739 'description', 'varchar', '', 2*$char_d, '', '',
741 'primary_key' => 'taxclassnum',
742 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
746 'cust_pay_pending' => {
748 'paypendingnum','serial', '', '', '', '',
749 'custnum', 'int', '', '', '', '',
750 'paid', @money_type, '', '',
751 '_date', @date_type, '', '',
752 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
753 # be index into payby
755 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
756 'paymask', 'varchar', 'NULL', $char_d, '', '',
757 'paydate', 'varchar', 'NULL', 10, '', '',
758 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
759 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
761 'status', 'varchar', '', $char_d, '', '',
762 'statustext', 'text', 'NULL', '', '', '',
763 'gatewaynum', 'int', 'NULL', '', '', '',
764 #'cust_balance', @money_type, '', '',
765 'paynum', 'int', 'NULL', '', '', '',
767 'primary_key' => 'paypendingnum',
768 'unique' => [ [ 'payunique' ] ],
769 'index' => [ [ 'custnum' ], [ 'status' ], ],
774 'paynum', 'serial', '', '', '', '',
775 'custnum', 'int', '', '', '', '',
776 '_date', @date_type, '', '',
777 'paid', @money_type, '', '',
778 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
779 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
780 # index into payby table
782 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
783 'paymask', 'varchar', 'NULL', $char_d, '', '',
784 'paydate', 'varchar', 'NULL', 10, '', '',
785 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
786 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
787 'closed', 'char', 'NULL', 1, '', '',
789 'primary_key' => 'paynum',
790 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
791 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
796 'paynum', 'int', '', '', '', '',
797 'custnum', 'int', '', '', '', '',
798 'paid', @money_type, '', '',
799 '_date', @date_type, '', '',
800 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
801 # index into payby table
803 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
804 'paymask', 'varchar', 'NULL', $char_d, '', '',
805 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
806 'closed', 'char', 'NULL', 1, '', '',
807 'void_date', @date_type, '', '',
808 'reason', 'varchar', 'NULL', $char_d, '', '',
809 'otaker', 'varchar', '', 32, '', '',
811 'primary_key' => 'paynum',
813 'index' => [ [ 'custnum' ] ],
818 'billpaynum', 'serial', '', '', '', '',
819 'invnum', 'int', '', '', '', '',
820 'paynum', 'int', '', '', '', '',
821 'amount', @money_type, '', '',
822 '_date', @date_type, '', '',
824 'primary_key' => 'billpaynum',
826 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
829 'cust_bill_pay_batch' => {
831 'billpaynum', 'serial', '', '', '', '',
832 'invnum', 'int', '', '', '', '',
833 'paybatchnum', 'int', '', '', '', '',
834 'amount', @money_type, '', '',
835 '_date', @date_type, '', '',
837 'primary_key' => 'billpaynum',
839 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
842 'cust_bill_pay_pkg' => {
844 'billpaypkgnum', 'serial', '', '', '', '',
845 'billpaynum', 'int', '', '', '', '',
846 'billpkgnum', 'int', '', '', '', '',
847 'amount', @money_type, '', '',
848 'setuprecur', 'varchar', '', $char_d, '', '',
849 'sdate', @date_type, '', '',
850 'edate', @date_type, '', '',
852 'primary_key' => 'billpaypkgnum',
854 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
857 'pay_batch' => { #batches of payments to an external processor
859 'batchnum', 'serial', '', '', '', '',
860 'payby', 'char', '', 4, '', '', # CARD/CHEK
861 'status', 'char', 'NULL', 1, '', '',
862 'download', @date_type, '', '',
863 'upload', @date_type, '', '',
865 'primary_key' => 'batchnum',
870 'cust_pay_batch' => { #what's this used for again? list of customers
871 #in current CARD batch? (necessarily CARD?)
873 'paybatchnum', 'serial', '', '', '', '',
874 'batchnum', 'int', '', '', '', '',
875 'invnum', 'int', '', '', '', '',
876 'custnum', 'int', '', '', '', '',
877 'last', 'varchar', '', $char_d, '', '',
878 'first', 'varchar', '', $char_d, '', '',
879 'address1', 'varchar', '', $char_d, '', '',
880 'address2', 'varchar', 'NULL', $char_d, '', '',
881 'city', 'varchar', '', $char_d, '', '',
882 'state', 'varchar', 'NULL', $char_d, '', '',
883 'zip', 'varchar', 'NULL', 10, '', '',
884 'country', 'char', '', 2, '', '',
885 # 'trancode', 'int', '', '', '', ''
886 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
887 'payinfo', 'varchar', '', 512, '', '',
888 #'exp', @date_type, '', ''
889 'exp', 'varchar', 'NULL', 11, '', '',
890 'payname', 'varchar', 'NULL', $char_d, '', '',
891 'amount', @money_type, '', '',
892 'status', 'varchar', 'NULL', $char_d, '', '',
894 'primary_key' => 'paybatchnum',
896 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
901 'pkgnum', 'serial', '', '', '', '',
902 'custnum', 'int', '', '', '', '',
903 'pkgpart', 'int', '', '', '', '',
904 'otaker', 'varchar', '', 32, '', '',
905 'setup', @date_type, '', '',
906 'bill', @date_type, '', '',
907 'last_bill', @date_type, '', '',
908 'susp', @date_type, '', '',
909 'adjourn', @date_type, '', '',
910 'cancel', @date_type, '', '',
911 'expire', @date_type, '', '',
912 'change_date', @date_type, '', '',
913 'change_pkgnum', 'int', 'NULL', '', '', '',
914 'change_pkgpart', 'int', 'NULL', '', '', '',
915 'manual_flag', 'char', 'NULL', 1, '', '',
916 'quantity', 'int', 'NULL', '', '', '',
918 'primary_key' => 'pkgnum',
920 'index' => [ ['custnum'], ['pkgpart'],
921 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
922 ['expire'], ['cancel'],
927 'cust_pkg_option' => {
929 'optionnum', 'serial', '', '', '', '',
930 'pkgnum', 'int', '', '', '', '',
931 'optionname', 'varchar', '', $char_d, '', '',
932 'optionvalue', 'text', 'NULL', '', '', '',
934 'primary_key' => 'optionnum',
936 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
939 'cust_pkg_reason' => {
941 'num', 'serial', '', '', '', '',
942 'pkgnum', 'int', '', '', '', '',
943 'reasonnum','int', '', '', '', '',
944 'action', 'char', 'NULL', 1, '', '', #should not be nullable
945 'otaker', 'varchar', '', 32, '', '',
946 'date', @date_type, '', '',
948 'primary_key' => 'num',
955 'refundnum', 'serial', '', '', '', '',
956 'custnum', 'int', '', '', '', '',
957 '_date', @date_type, '', '',
958 'refund', @money_type, '', '',
959 'otaker', 'varchar', '', 32, '', '',
960 'reason', 'varchar', '', $char_d, '', '',
961 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
962 # be index into payby
964 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
965 'paymask', 'varchar', 'NULL', $char_d, '', '',
966 'paybatch', 'varchar', 'NULL', $char_d, '', '',
967 'closed', 'char', 'NULL', 1, '', '',
969 'primary_key' => 'refundnum',
971 'index' => [ ['custnum'], ['_date'] ],
974 'cust_credit_refund' => {
976 'creditrefundnum', 'serial', '', '', '', '',
977 'crednum', 'int', '', '', '', '',
978 'refundnum', 'int', '', '', '', '',
979 'amount', @money_type, '', '',
980 '_date', @date_type, '', '',
982 'primary_key' => 'creditrefundnum',
984 'index' => [ ['crednum'], ['refundnum'] ],
990 'svcnum', 'serial', '', '', '', '',
991 'pkgnum', 'int', 'NULL', '', '', '',
992 'svcpart', 'int', '', '', '', '',
993 'overlimit', @date_type, '', '',
995 'primary_key' => 'svcnum',
997 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1002 'pkgpart', 'serial', '', '', '', '',
1003 'pkg', 'varchar', '', $char_d, '', '',
1004 'comment', 'varchar', '', $char_d, '', '',
1005 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1006 'setup', @perl_type, '', '',
1007 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1008 'recur', @perl_type, '', '',
1009 'setuptax', 'char', 'NULL', 1, '', '',
1010 'recurtax', 'char', 'NULL', 1, '', '',
1011 'plan', 'varchar', 'NULL', $char_d, '', '',
1012 'plandata', 'text', 'NULL', '', '', '',
1013 'disabled', 'char', 'NULL', 1, '', '',
1014 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1015 'classnum', 'int', 'NULL', '', '', '',
1016 'taxproductnum', 'int', 'NULL', '', '', '',
1017 'pay_weight', 'real', 'NULL', '', '', '',
1018 'credit_weight', 'real', 'NULL', '', '', '',
1019 'agentnum', 'int', 'NULL', '', '', '',
1022 'primary_key' => 'pkgpart',
1024 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1027 'part_pkg_link' => {
1029 'pkglinknum', 'serial', '', '', '', '',
1030 'src_pkgpart', 'int', '', '', '', '',
1031 'dst_pkgpart', 'int', '', '', '', '',
1032 'link_type', 'varchar', '', $char_d, '', '',
1034 'primary_key' => 'pkglinknum',
1035 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1036 'index' => [ [ 'src_pkgpart' ] ],
1039 'part_pkg_taxclass' => {
1041 'taxclassnum', 'serial', '', '', '', '',
1042 'taxclass', 'varchar', '', $char_d, '', '',
1044 'primary_key' => 'taxclassnum',
1045 'unique' => [ [ 'taxclass' ] ],
1049 'part_pkg_taxproduct' => {
1051 'taxproductnum', 'serial', '', '', '', '',
1052 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1053 'taxproduct', 'varchar', '', $char_d, '', '',
1054 'description', 'varchar', '', 2*$char_d, '', '',
1056 'primary_key' => 'taxproductnum',
1057 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1061 'part_pkg_taxrate' => {
1063 'pkgtaxratenum', 'serial', '', '', '', '',
1064 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1065 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1066 'taxproductnum', 'int', '', '', '', '',
1067 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1068 'county', 'varchar', 'NULL', $char_d, '', '',
1069 'state', 'varchar', 'NULL', $char_d, '', '',
1070 'local', 'varchar', 'NULL', $char_d, '', '',
1071 'country', 'char', 'NULL', 2, '', '',
1072 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1073 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1074 'taxclassnum', 'int', 'NULL', '', '', '',
1075 'effdate', @date_type, '', '',
1076 'taxable', 'char', 'NULL', 1, '', '',
1078 'primary_key' => 'pkgtaxratenum',
1080 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1083 'part_pkg_taxoverride' => {
1085 'taxoverridenum', 'serial', '', '', '', '',
1086 'pkgpart', 'serial', '', '', '', '',
1087 'taxclassnum', 'serial', '', '', '', '',
1089 'primary_key' => 'taxoverridenum',
1091 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1096 # 'titlenum', 'int', '', '',
1097 # 'title', 'varchar', '', $char_d,
1099 # 'primary_key' => 'titlenum',
1100 # 'unique' => [ [] ],
1101 # 'index' => [ [] ],
1106 'pkgsvcnum', 'serial', '', '', '', '',
1107 'pkgpart', 'int', '', '', '', '',
1108 'svcpart', 'int', '', '', '', '',
1109 'quantity', 'int', '', '', '', '',
1110 'primary_svc','char', 'NULL', 1, '', '',
1112 'primary_key' => 'pkgsvcnum',
1113 'unique' => [ ['pkgpart', 'svcpart'] ],
1114 'index' => [ ['pkgpart'] ],
1117 'part_referral' => {
1119 'refnum', 'serial', '', '', '', '',
1120 'referral', 'varchar', '', $char_d, '', '',
1121 'disabled', 'char', 'NULL', 1, '', '',
1122 'agentnum', 'int', 'NULL', '', '', '',
1124 'primary_key' => 'refnum',
1126 'index' => [ ['disabled'], ['agentnum'], ],
1131 'svcpart', 'serial', '', '', '', '',
1132 'svc', 'varchar', '', $char_d, '', '',
1133 'svcdb', 'varchar', '', $char_d, '', '',
1134 'disabled', 'char', 'NULL', 1, '', '',
1136 'primary_key' => 'svcpart',
1138 'index' => [ [ 'disabled' ] ],
1141 'part_svc_column' => {
1143 'columnnum', 'serial', '', '', '', '',
1144 'svcpart', 'int', '', '', '', '',
1145 'columnname', 'varchar', '', 64, '', '',
1146 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1147 'columnflag', 'char', 'NULL', 1, '', '',
1149 'primary_key' => 'columnnum',
1150 'unique' => [ [ 'svcpart', 'columnname' ] ],
1151 'index' => [ [ 'svcpart' ] ],
1154 #(this should be renamed to part_pop)
1157 'popnum', 'serial', '', '', '', '',
1158 'city', 'varchar', '', $char_d, '', '',
1159 'state', 'varchar', '', $char_d, '', '',
1160 'ac', 'char', '', 3, '', '',
1161 'exch', 'char', '', 3, '', '',
1162 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1164 'primary_key' => 'popnum',
1166 'index' => [ [ 'state' ] ],
1169 'part_pop_local' => {
1171 'localnum', 'serial', '', '', '', '',
1172 'popnum', 'int', '', '', '', '',
1173 'city', 'varchar', 'NULL', $char_d, '', '',
1174 'state', 'char', 'NULL', 2, '', '',
1175 'npa', 'char', '', 3, '', '',
1176 'nxx', 'char', '', 3, '', '',
1178 'primary_key' => 'localnum',
1180 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1185 'svcnum', 'int', '', '', '', '',
1186 'username', 'varchar', '', $username_len, '', '',
1187 '_password', 'varchar', '', 512, '', '',
1188 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1189 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1190 'popnum', 'int', 'NULL', '', '', '',
1191 'uid', 'int', 'NULL', '', '', '',
1192 'gid', 'int', 'NULL', '', '', '',
1193 'finger', 'varchar', 'NULL', $char_d, '', '',
1194 'dir', 'varchar', 'NULL', $char_d, '', '',
1195 'shell', 'varchar', 'NULL', $char_d, '', '',
1196 'quota', 'varchar', 'NULL', $char_d, '', '',
1197 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1198 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1199 'seconds_threshold', 'int', 'NULL', '', '', '',
1200 'upbytes', 'bigint', 'NULL', '', '', '',
1201 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1202 'downbytes', 'bigint', 'NULL', '', '', '',
1203 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1204 'totalbytes','bigint', 'NULL', '', '', '',
1205 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1206 'domsvc', 'int', '', '', '', '',
1207 'last_login', @date_type, '', '',
1208 'last_logout', @date_type, '', '',
1210 'primary_key' => 'svcnum',
1211 #'unique' => [ [ 'username', 'domsvc' ] ],
1213 'index' => [ ['username'], ['domsvc'] ],
1216 'acct_rt_transaction' => {
1218 'svcrtid', 'int', '', '', '', '',
1219 'svcnum', 'int', '', '', '', '',
1220 'transaction_id', 'int', '', '', '', '',
1221 '_date', @date_type, '', '',
1222 'seconds', 'int', '', '', '', '', #uhhhh
1223 'support', 'int', '', '', '', '',
1225 'primary_key' => 'svcrtid',
1227 'index' => [ ['svcnum', 'transaction_id'] ],
1232 # 'svcnum', 'int', '', '',
1233 # 'amount', @money_type,
1235 # 'primary_key' => 'svcnum',
1236 # 'unique' => [ [] ],
1237 # 'index' => [ [] ],
1242 'svcnum', 'int', '', '', '', '',
1243 'domain', 'varchar', '', $char_d, '', '',
1244 'suffix', 'varchar', 'NULL', $char_d, '', '',
1245 'catchall', 'int', 'NULL', '', '', '',
1246 'parent_svcnum', 'int', 'NULL', '', '', '',
1247 'registrarnum', 'int', 'NULL', '', '', '',
1248 'registrarkey', 'varchar', 'NULL', 512, '', '',
1249 'setup_date', @date_type, '', '',
1250 'renewal_interval', 'int', 'NULL', '', '', '',
1251 'expiration_date', @date_type, '', '',
1253 'primary_key' => 'svcnum',
1255 'index' => [ ['domain'] ],
1258 'domain_record' => {
1260 'recnum', 'serial', '', '', '', '',
1261 'svcnum', 'int', '', '', '', '',
1262 'reczone', 'varchar', '', 255, '', '',
1263 'recaf', 'char', '', 2, '', '',
1264 'rectype', 'varchar', '', 5, '', '',
1265 'recdata', 'varchar', '', 255, '', '',
1267 'primary_key' => 'recnum',
1269 'index' => [ ['svcnum'] ],
1274 'registrarnum', 'serial', '', '', '', '',
1275 'registrarname', 'varchar', '', $char_d, '', '',
1277 'primary_key' => 'registrarnum',
1284 'svcnum', 'int', '', '', '', '',
1285 'srcsvc', 'int', 'NULL', '', '', '',
1286 'src', 'varchar', 'NULL', 255, '', '',
1287 'dstsvc', 'int', 'NULL', '', '', '',
1288 'dst', 'varchar', 'NULL', 255, '', '',
1290 'primary_key' => 'svcnum',
1292 'index' => [ ['srcsvc'], ['dstsvc'] ],
1297 'svcnum', 'int', '', '', '', '',
1298 'recnum', 'int', '', '', '', '',
1299 'usersvc', 'int', 'NULL', '', '', '',
1300 'config', 'text', 'NULL', '', '', '',
1302 'primary_key' => 'svcnum',
1309 # 'svcnum', 'int', '', '',
1310 # 'svcnum', 'int', '', '',
1311 # 'svcnum', 'int', '', '',
1312 # 'worker', 'varchar', '', $char_d,
1313 # '_date', @date_type,
1315 # 'primary_key' => 'svcnum',
1316 # 'unique' => [ [] ],
1317 # 'index' => [ [] ],
1320 'prepay_credit' => {
1322 'prepaynum', 'serial', '', '', '', '',
1323 'identifier', 'varchar', '', $char_d, '', '',
1324 'amount', @money_type, '', '',
1325 'seconds', 'int', 'NULL', '', '', '',
1326 'upbytes', 'bigint', 'NULL', '', '', '',
1327 'downbytes', 'bigint', 'NULL', '', '', '',
1328 'totalbytes', 'bigint', 'NULL', '', '', '',
1329 'agentnum', 'int', 'NULL', '', '', '',
1331 'primary_key' => 'prepaynum',
1332 'unique' => [ ['identifier'] ],
1338 'portnum', 'serial', '', '', '', '',
1339 'ip', 'varchar', 'NULL', 15, '', '',
1340 'nasport', 'int', 'NULL', '', '', '',
1341 'nasnum', 'int', '', '', '', '',
1343 'primary_key' => 'portnum',
1350 'nasnum', 'serial', '', '', '', '',
1351 'nas', 'varchar', '', $char_d, '', '',
1352 'nasip', 'varchar', '', 15, '', '',
1353 'nasfqdn', 'varchar', '', $char_d, '', '',
1354 'last', 'int', '', '', '', '',
1356 'primary_key' => 'nasnum',
1357 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1358 'index' => [ [ 'last' ] ],
1363 # 'sessionnum', 'serial', '', '', '', '',
1364 # 'portnum', 'int', '', '', '', '',
1365 # 'svcnum', 'int', '', '', '', '',
1366 # 'login', @date_type, '', '',
1367 # 'logout', @date_type, '', '',
1369 # 'primary_key' => 'sessionnum',
1371 # 'index' => [ [ 'portnum' ] ],
1376 'jobnum', 'serial', '', '', '', '',
1377 'job', 'text', '', '', '', '',
1378 '_date', 'int', '', '', '', '',
1379 'status', 'varchar', '', $char_d, '', '',
1380 'statustext', 'text', 'NULL', '', '', '',
1381 'svcnum', 'int', 'NULL', '', '', '',
1382 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1385 'primary_key' => 'jobnum',
1387 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1392 'argnum', 'serial', '', '', '', '',
1393 'jobnum', 'int', '', '', '', '',
1394 'arg', 'text', 'NULL', '', '', '',
1396 'primary_key' => 'argnum',
1398 'index' => [ [ 'jobnum' ] ],
1403 'dependnum', 'serial', '', '', '', '',
1404 'jobnum', 'int', '', '', '', '',
1405 'depend_jobnum', 'int', '', '', '', '',
1407 'primary_key' => 'dependnum',
1409 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1414 'exportsvcnum' => 'serial', '', '', '', '',
1415 'exportnum' => 'int', '', '', '', '',
1416 'svcpart' => 'int', '', '', '', '',
1418 'primary_key' => 'exportsvcnum',
1419 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1420 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1425 'exportnum', 'serial', '', '', '', '',
1426 'machine', 'varchar', '', $char_d, '', '',
1427 'exporttype', 'varchar', '', $char_d, '', '',
1428 'nodomain', 'char', 'NULL', 1, '', '',
1430 'primary_key' => 'exportnum',
1432 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1435 'part_export_option' => {
1437 'optionnum', 'serial', '', '', '', '',
1438 'exportnum', 'int', '', '', '', '',
1439 'optionname', 'varchar', '', $char_d, '', '',
1440 'optionvalue', 'text', 'NULL', '', '', '',
1442 'primary_key' => 'optionnum',
1444 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1447 'radius_usergroup' => {
1449 'usergroupnum', 'serial', '', '', '', '',
1450 'svcnum', 'int', '', '', '', '',
1451 'groupname', 'varchar', '', $char_d, '', '',
1453 'primary_key' => 'usergroupnum',
1455 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1460 'msgnum', 'serial', '', '', '', '',
1461 'msgcode', 'varchar', '', $char_d, '', '',
1462 'locale', 'varchar', '', 16, '', '',
1463 'msg', 'text', '', '', '', '',
1465 'primary_key' => 'msgnum',
1466 'unique' => [ [ 'msgcode', 'locale' ] ],
1470 'cust_tax_exempt' => {
1472 'exemptnum', 'serial', '', '', '', '',
1473 'custnum', 'int', '', '', '', '',
1474 'taxnum', 'int', '', '', '', '',
1475 'year', 'int', '', '', '', '',
1476 'month', 'int', '', '', '', '',
1477 'amount', @money_type, '', '',
1479 'primary_key' => 'exemptnum',
1480 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1484 'cust_tax_exempt_pkg' => {
1486 'exemptpkgnum', 'serial', '', '', '', '',
1487 #'custnum', 'int', '', '', '', ''
1488 'billpkgnum', 'int', '', '', '', '',
1489 'taxnum', 'int', '', '', '', '',
1490 'year', 'int', '', '', '', '',
1491 'month', 'int', '', '', '', '',
1492 'amount', @money_type, '', '',
1494 'primary_key' => 'exemptpkgnum',
1496 'index' => [ [ 'taxnum', 'year', 'month' ],
1504 'routernum', 'serial', '', '', '', '',
1505 'routername', 'varchar', '', $char_d, '', '',
1506 'svcnum', 'int', 'NULL', '', '', '',
1507 'agentnum', 'int', 'NULL', '', '', '',
1509 'primary_key' => 'routernum',
1514 'part_svc_router' => {
1516 'svcrouternum', 'serial', '', '', '', '',
1517 'svcpart', 'int', '', '', '', '',
1518 'routernum', 'int', '', '', '', '',
1520 'primary_key' => 'svcrouternum',
1527 'blocknum', 'serial', '', '', '', '',
1528 'routernum', 'int', '', '', '', '',
1529 'ip_gateway', 'varchar', '', 15, '', '',
1530 'ip_netmask', 'int', '', '', '', '',
1531 'agentnum', 'int', 'NULL', '', '', '',
1533 'primary_key' => 'blocknum',
1534 'unique' => [ [ 'blocknum', 'routernum' ] ],
1538 'svc_broadband' => {
1540 'svcnum', 'int', '', '', '', '',
1541 'description', 'varchar', 'NULL', $char_d, '', '',
1542 'blocknum', 'int', '', '', '', '',
1543 'speed_up', 'int', '', '', '', '',
1544 'speed_down', 'int', '', '', '', '',
1545 'ip_addr', 'varchar', '', 15, '', '',
1546 'mac_addr', 'varchar', 'NULL', 12, '', '',
1547 'authkey', 'varchar', 'NULL', 32, '', '',
1548 'latitude', 'decimal', 'NULL', '', '', '',
1549 'longitude', 'decimal', 'NULL', '', '', '',
1550 'altitude', 'decimal', 'NULL', '', '', '',
1551 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1553 'primary_key' => 'svcnum',
1558 'part_virtual_field' => {
1560 'vfieldpart', 'serial', '', '', '', '',
1561 'dbtable', 'varchar', '', 32, '', '',
1562 'name', 'varchar', '', 32, '', '',
1563 'check_block', 'text', 'NULL', '', '', '',
1564 'length', 'int', 'NULL', '', '', '',
1565 'list_source', 'text', 'NULL', '', '', '',
1566 'label', 'varchar', 'NULL', 80, '', '',
1568 'primary_key' => 'vfieldpart',
1573 'virtual_field' => {
1575 'vfieldnum', 'serial', '', '', '', '',
1576 'recnum', 'int', '', '', '', '',
1577 'vfieldpart', 'int', '', '', '', '',
1578 'value', 'varchar', '', 128, '', '',
1580 'primary_key' => 'vfieldnum',
1581 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1587 'snarfnum', 'int', '', '', '', '',
1588 'svcnum', 'int', '', '', '', '',
1589 'machine', 'varchar', '', 255, '', '',
1590 'protocol', 'varchar', '', $char_d, '', '',
1591 'username', 'varchar', '', $char_d, '', '',
1592 '_password', 'varchar', '', $char_d, '', '',
1594 'primary_key' => 'snarfnum',
1596 'index' => [ [ 'svcnum' ] ],
1601 'svcnum', 'int', '', '', '', '',
1602 'id', 'int', 'NULL', '', '', '',
1603 'title', 'varchar', 'NULL', $char_d, '', '',
1605 'primary_key' => 'svcnum',
1610 'cust_pay_refund' => {
1612 'payrefundnum', 'serial', '', '', '', '',
1613 'paynum', 'int', '', '', '', '',
1614 'refundnum', 'int', '', '', '', '',
1615 '_date', @date_type, '', '',
1616 'amount', @money_type, '', '',
1618 'primary_key' => 'payrefundnum',
1620 'index' => [ ['paynum'], ['refundnum'] ],
1623 'part_pkg_option' => {
1625 'optionnum', 'serial', '', '', '', '',
1626 'pkgpart', 'int', '', '', '', '',
1627 'optionname', 'varchar', '', $char_d, '', '',
1628 'optionvalue', 'text', 'NULL', '', '', '',
1630 'primary_key' => 'optionnum',
1632 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1637 'ratenum', 'serial', '', '', '', '',
1638 'ratename', 'varchar', '', $char_d, '', '',
1640 'primary_key' => 'ratenum',
1647 'ratedetailnum', 'serial', '', '', '', '',
1648 'ratenum', 'int', '', '', '', '',
1649 'orig_regionnum', 'int', 'NULL', '', '', '',
1650 'dest_regionnum', 'int', '', '', '', '',
1651 'min_included', 'int', '', '', '', '',
1652 #'min_charge', @money_type, '', '',
1653 'min_charge', 'decimal', '', '10,5', '', '',
1654 'sec_granularity', 'int', '', '', '', '',
1655 #time period (link to table of periods)?
1657 'primary_key' => 'ratedetailnum',
1658 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1659 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1664 'regionnum', 'serial', '', '', '', '',
1665 'regionname', 'varchar', '', $char_d, '', '',
1667 'primary_key' => 'regionnum',
1674 'prefixnum', 'serial', '', '', '', '',
1675 'regionnum', 'int', '', '',, '', '',
1676 'countrycode', 'varchar', '', 3, '', '',
1677 'npa', 'varchar', 'NULL', 6, '', '',
1678 'nxx', 'varchar', 'NULL', 3, '', '',
1680 'primary_key' => 'prefixnum',
1682 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1687 'codenum', 'serial', '', '', '', '',
1688 'code', 'varchar', '', $char_d, '', '',
1689 'agentnum', 'int', '', '', '', '',
1691 'primary_key' => 'codenum',
1692 'unique' => [ [ 'agentnum', 'code' ] ],
1693 'index' => [ [ 'agentnum' ] ],
1698 'codepkgnum', 'serial', '', '', '', '',
1699 'codenum', 'int', '', '', '', '',
1700 'pkgpart', 'int', '', '', '', '',
1702 'primary_key' => 'codepkgnum',
1703 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1704 'index' => [ [ 'codenum' ] ],
1707 'clientapi_session' => {
1709 'sessionnum', 'serial', '', '', '', '',
1710 'sessionid', 'varchar', '', $char_d, '', '',
1711 'namespace', 'varchar', '', $char_d, '', '',
1713 'primary_key' => 'sessionnum',
1714 'unique' => [ [ 'sessionid', 'namespace' ] ],
1718 'clientapi_session_field' => {
1720 'fieldnum', 'serial', '', '', '', '',
1721 'sessionnum', 'int', '', '', '', '',
1722 'fieldname', 'varchar', '', $char_d, '', '',
1723 'fieldvalue', 'text', 'NULL', '', '', '',
1725 'primary_key' => 'fieldnum',
1726 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1730 'payment_gateway' => {
1732 'gatewaynum', 'serial', '', '', '', '',
1733 'gateway_module', 'varchar', '', $char_d, '', '',
1734 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1735 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1736 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1737 'disabled', 'char', 'NULL', 1, '', '',
1739 'primary_key' => 'gatewaynum',
1741 'index' => [ [ 'disabled' ] ],
1744 'payment_gateway_option' => {
1746 'optionnum', 'serial', '', '', '', '',
1747 'gatewaynum', 'int', '', '', '', '',
1748 'optionname', 'varchar', '', $char_d, '', '',
1749 'optionvalue', 'text', 'NULL', '', '', '',
1751 'primary_key' => 'optionnum',
1753 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1756 'agent_payment_gateway' => {
1758 'agentgatewaynum', 'serial', '', '', '', '',
1759 'agentnum', 'int', '', '', '', '',
1760 'gatewaynum', 'int', '', '', '', '',
1761 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1762 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1764 'primary_key' => 'agentgatewaynum',
1766 'index' => [ [ 'agentnum', 'cardtype' ], ],
1771 'bannum', 'serial', '', '', '', '',
1772 'payby', 'char', '', 4, '', '',
1773 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1774 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1775 '_date', @date_type, '', '',
1776 'otaker', 'varchar', '', 32, '', '',
1777 'reason', 'varchar', 'NULL', $char_d, '', '',
1779 'primary_key' => 'bannum',
1780 'unique' => [ [ 'payby', 'payinfo' ] ],
1786 'categorynum', 'serial', '', '', '', '',
1787 'categoryname', 'varchar', '', $char_d, '', '',
1788 'disabled', 'char', 'NULL', 1, '', '',
1790 'primary_key' => 'categorynum',
1792 'index' => [ ['disabled'] ],
1797 'classnum', 'serial', '', '', '', '',
1798 'classname', 'varchar', '', $char_d, '', '',
1799 'categorynum', 'int', 'NULL', '', '', '',
1800 'disabled', 'char', 'NULL', 1, '', '',
1802 'primary_key' => 'classnum',
1804 'index' => [ ['disabled'] ],
1809 # qw( name type null length default local );
1815 'acctid', 'bigserial', '', '', '', '',
1816 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1817 'calldate', 'timestamp', '', '', \'now()', '',
1818 'clid', 'varchar', '', $char_d, \"''", '',
1819 'src', 'varchar', '', $char_d, \"''", '',
1820 'dst', 'varchar', '', $char_d, \"''", '',
1821 'dcontext', 'varchar', '', $char_d, \"''", '',
1822 'channel', 'varchar', '', $char_d, \"''", '',
1823 'dstchannel', 'varchar', '', $char_d, \"''", '',
1824 'lastapp', 'varchar', '', $char_d, \"''", '',
1825 'lastdata', 'varchar', '', $char_d, \"''", '',
1827 #these don't seem to be logged by most of the SQL cdr_* modules
1828 #except tds under sql-illegal names, so;
1829 # ... don't rely on them for rating?
1830 # and, what they hey, i went ahead and changed the names and data types
1831 # to freeside-style dates...
1832 #'start', 'timestamp', 'NULL', '', '', '',
1833 #'answer', 'timestamp', 'NULL', '', '', '',
1834 #'end', 'timestamp', 'NULL', '', '', '',
1835 'startdate', @date_type, '', '',
1836 'answerdate', @date_type, '', '',
1837 'enddate', @date_type, '', '',
1840 'duration', 'int', '', '', 0, '',
1841 'billsec', 'int', '', '', 0, '',
1842 'disposition', 'varchar', '', 45, \"''", '',
1843 'amaflags', 'int', '', '', 0, '',
1844 'accountcode', 'varchar', '', 20, \"''", '',
1845 'uniqueid', 'varchar', '', 32, \"''", '',
1846 'userfield', 'varchar', '', 255, \"''", '',
1849 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1853 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1854 'cdrtypenum', 'int', 'NULL', '', '', '',
1856 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1858 'upstream_currency', 'char', 'NULL', 3, '', '',
1859 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1860 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1862 # how it was rated internally...
1863 'ratedetailnum', 'int', 'NULL', '', '', '',
1864 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1866 'distance', 'decimal', 'NULL', '', '', '',
1867 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1869 #cdr_calltype: the big list in appendix 2
1870 'calltypenum', 'int', 'NULL', '', '', '',
1872 'description', 'varchar', 'NULL', $char_d, '', '',
1873 'quantity', 'int', 'NULL', '', '', '',
1875 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1876 'carrierid', 'int', 'NULL', '', '', '',
1878 'upstream_rateid', 'int', 'NULL', '', '', '',
1881 #and now for our own fields
1884 # a svcnum... right..?
1885 'svcnum', 'int', 'NULL', '', '', '',
1887 #NULL, done (or something)
1888 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1891 'primary_key' => 'acctid',
1893 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1898 'calltypenum', 'serial', '', '', '', '',
1899 'calltypename', 'varchar', '', $char_d, '', '',
1901 'primary_key' => 'calltypenum',
1908 'cdrtypenum' => 'serial', '', '', '', '',
1909 'cdrtypename' => 'varchar', '', $char_d, '', '',
1911 'primary_key' => 'cdrtypenum',
1918 'carrierid' => 'serial', '', '', '', '',
1919 'carriername' => 'varchar', '', $char_d, '', '',
1921 'primary_key' => 'carrierid',
1926 #map upstream rateid to ours...
1927 'cdr_upstream_rate' => {
1929 'upstreamratenum', 'serial', '', '', '', '',
1930 'upstream_rateid', 'varchar', '', $char_d, '', '',
1931 'ratedetailnum', 'int', 'NULL', '', '', '',
1933 'primary_key' => 'upstreamratenum', #XXX need a primary key
1934 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1938 'inventory_item' => {
1940 'itemnum', 'serial', '', '', '', '',
1941 'classnum', 'int', '', '', '', '',
1942 'item', 'varchar', '', $char_d, '', '',
1943 'svcnum', 'int', 'NULL', '', '', '',
1945 'primary_key' => 'itemnum',
1946 'unique' => [ [ 'classnum', 'item' ] ],
1947 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1950 'inventory_class' => {
1952 'classnum', 'serial', '', '', '', '',
1953 'classname', 'varchar', '', $char_d, '', '',
1955 'primary_key' => 'classnum',
1962 'usernum', 'serial', '', '', '', '',
1963 'username', 'varchar', '', $char_d, '', '',
1964 '_password', 'varchar', '', $char_d, '', '',
1965 'last', 'varchar', '', $char_d, '', '',
1966 'first', 'varchar', '', $char_d, '', '',
1967 'disabled', 'char', 'NULL', 1, '', '',
1969 'primary_key' => 'usernum',
1970 'unique' => [ [ 'username' ] ],
1974 'access_user_pref' => {
1976 'prefnum', 'serial', '', '', '', '',
1977 'usernum', 'int', '', '', '', '',
1978 'prefname', 'varchar', '', $char_d, '', '',
1979 'prefvalue', 'text', 'NULL', '', '', '',
1980 'expiration', @date_type, '', '',
1982 'primary_key' => 'prefnum',
1984 'index' => [ [ 'usernum' ] ],
1989 'groupnum', 'serial', '', '', '', '',
1990 'groupname', 'varchar', '', $char_d, '', '',
1992 'primary_key' => 'groupnum',
1993 'unique' => [ [ 'groupname' ] ],
1997 'access_usergroup' => {
1999 'usergroupnum', 'serial', '', '', '', '',
2000 'usernum', 'int', '', '', '', '',
2001 'groupnum', 'int', '', '', '', '',
2003 'primary_key' => 'usergroupnum',
2004 'unique' => [ [ 'usernum', 'groupnum' ] ],
2005 'index' => [ [ 'usernum' ] ],
2008 'access_groupagent' => {
2010 'groupagentnum', 'serial', '', '', '', '',
2011 'groupnum', 'int', '', '', '', '',
2012 'agentnum', 'int', '', '', '', '',
2014 'primary_key' => 'groupagentnum',
2015 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2016 'index' => [ [ 'groupnum' ] ],
2021 'rightnum', 'serial', '', '', '', '',
2022 'righttype', 'varchar', '', $char_d, '', '',
2023 'rightobjnum', 'int', '', '', '', '',
2024 'rightname', 'varchar', '', $char_d, '', '',
2026 'primary_key' => 'rightnum',
2027 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2033 'svcnum', 'int', '', '', '', '',
2034 'countrycode', 'varchar', '', 3, '', '',
2035 'phonenum', 'varchar', '', 15, '', '', #12 ?
2036 'pin', 'varchar', 'NULL', $char_d, '', '',
2037 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2039 'primary_key' => 'svcnum',
2041 'index' => [ [ 'countrycode', 'phonenum' ] ],
2046 'availnum', 'int', '', '', '', '',
2047 'exportnum', 'int', '', '', '', '',
2048 'countrycode', 'varchar', '', 3, '', '',
2049 'state', 'char', 'NULL', 2, '', '',
2050 'npa', 'char', '', 3, '', '',
2051 'nxx', 'char', 'NULL', 3, '', '',
2053 'primary_key' => 'availnum',
2055 'index' => [ [ 'exportnum', 'countrycode', 'state' ] ],
2060 'typenum', 'serial', '', '', '', '',
2061 'class', 'char', '', 1, '', '',
2062 'type', 'varchar', '', $char_d, '', '',
2064 'primary_key' => 'typenum',
2071 'reasonnum', 'serial', '', '', '', '',
2072 'reason_type', 'int', '', '', '', '',
2073 'reason', 'text', '', '', '', '',
2074 'disabled', 'char', 'NULL', 1, '', '',
2076 'primary_key' => 'reasonnum',
2083 'confnum', 'serial', '', '', '', '',
2084 'agentnum', 'int', 'NULL', '', '', '',
2085 'name', 'varchar', '', $char_d, '', '',
2086 'value', 'text', 'NULL', '', '', '',
2088 'primary_key' => 'confnum',
2089 'unique' => [ [ 'agentnum', 'name' ]],
2095 'pkgrefnum', 'serial', '', '', '', '',
2096 'pkgnum', 'int', '', '', '', '',
2097 'refnum', 'int', '', '', '', '',
2099 'primary_key' => 'pkgrefnum',
2100 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2101 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2103 # name type nullability length default local
2107 # 'num', 'serial', '', '', '', '',
2109 # 'primary_key' => 'num',