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, '', '',
500 'primary_key' => 'billpkgnum',
502 'index' => [ ['invnum'], [ 'pkgnum' ] ],
505 'cust_bill_pkg_detail' => {
507 'detailnum', 'serial', '', '', '', '',
508 'pkgnum', 'int', '', '', '', '',
509 'invnum', 'int', '', '', '', '',
510 'format', 'char', 'NULL', 1, '', '',
511 'detail', 'varchar', '', $char_d, '', '',
513 'primary_key' => 'detailnum',
515 'index' => [ [ 'pkgnum', 'invnum' ] ],
520 'crednum', 'serial', '', '', '', '',
521 'custnum', 'int', '', '', '', '',
522 '_date', @date_type, '', '',
523 'amount', @money_type, '', '',
524 'otaker', 'varchar', '', 32, '', '',
525 'reason', 'text', 'NULL', '', '', '',
526 'reasonnum', 'int', 'NULL', '', '', '',
527 'closed', 'char', 'NULL', 1, '', '',
529 'primary_key' => 'crednum',
531 'index' => [ ['custnum'], ['_date'] ],
534 'cust_credit_bill' => {
536 'creditbillnum', 'serial', '', '', '', '',
537 'crednum', 'int', '', '', '', '',
538 'invnum', 'int', '', '', '', '',
539 '_date', @date_type, '', '',
540 'amount', @money_type, '', '',
542 'primary_key' => 'creditbillnum',
544 'index' => [ ['crednum'], ['invnum'] ],
547 'cust_credit_bill_pkg' => {
549 'creditbillpkgnum', 'serial', '', '', '', '',
550 'creditbillnum', 'int', '', '', '', '',
551 'billpkgnum', 'int', '', '', '', '',
552 'amount', @money_type, '', '',
553 'setuprecur', 'varchar', '', $char_d, '', '',
554 'sdate', @date_type, '', '',
555 'edate', @date_type, '', '',
557 'primary_key' => 'creditbillpkgnum',
559 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
564 'custnum', 'serial', '', '', '', '',
565 'agentnum', 'int', '', '', '', '',
566 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
567 # 'titlenum', 'int', 'NULL', '', '', '',
568 'last', 'varchar', '', $char_d, '', '',
569 # 'middle', 'varchar', 'NULL', $char_d, '', '',
570 'first', 'varchar', '', $char_d, '', '',
571 'ss', 'varchar', 'NULL', 11, '', '',
572 'stateid', 'varchar', 'NULL', $char_d, '', '',
573 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
574 'birthdate' ,@date_type, '', '',
575 'signupdate',@date_type, '', '',
576 'company', 'varchar', 'NULL', $char_d, '', '',
577 'address1', 'varchar', '', $char_d, '', '',
578 'address2', 'varchar', 'NULL', $char_d, '', '',
579 'city', 'varchar', '', $char_d, '', '',
580 'county', 'varchar', 'NULL', $char_d, '', '',
581 'state', 'varchar', 'NULL', $char_d, '', '',
582 'zip', 'varchar', 'NULL', 10, '', '',
583 'country', 'char', '', 2, '', '',
584 'daytime', 'varchar', 'NULL', 20, '', '',
585 'night', 'varchar', 'NULL', 20, '', '',
586 'fax', 'varchar', 'NULL', 12, '', '',
587 'ship_last', 'varchar', 'NULL', $char_d, '', '',
588 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
589 'ship_first', 'varchar', 'NULL', $char_d, '', '',
590 'ship_company', 'varchar', 'NULL', $char_d, '', '',
591 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
592 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
593 'ship_city', 'varchar', 'NULL', $char_d, '', '',
594 'ship_county', 'varchar', 'NULL', $char_d, '', '',
595 'ship_state', 'varchar', 'NULL', $char_d, '', '',
596 'ship_zip', 'varchar', 'NULL', 10, '', '',
597 'ship_country', 'char', 'NULL', 2, '', '',
598 'ship_daytime', 'varchar', 'NULL', 20, '', '',
599 'ship_night', 'varchar', 'NULL', 20, '', '',
600 'ship_fax', 'varchar', 'NULL', 12, '', '',
601 'payby', 'char', '', 4, '', '',
602 'payinfo', 'varchar', 'NULL', 512, '', '',
603 'paycvv', 'varchar', 'NULL', 512, '', '',
604 'paymask', 'varchar', 'NULL', $char_d, '', '',
605 #'paydate', @date_type, '', '',
606 'paydate', 'varchar', 'NULL', 10, '', '',
607 'paystart_month', 'int', 'NULL', '', '', '',
608 'paystart_year', 'int', 'NULL', '', '', '',
609 'payissue', 'varchar', 'NULL', 2, '', '',
610 'payname', 'varchar', 'NULL', $char_d, '', '',
611 'paystate', 'varchar', 'NULL', $char_d, '', '',
612 'paytype', 'varchar', 'NULL', $char_d, '', '',
613 'payip', 'varchar', 'NULL', 15, '', '',
614 'tax', 'char', 'NULL', 1, '', '',
615 'otaker', 'varchar', '', 32, '', '',
616 'refnum', 'int', '', '', '', '',
617 'referral_custnum', 'int', 'NULL', '', '', '',
618 'comments', 'text', 'NULL', '', '', '',
619 'spool_cdr','char', 'NULL', 1, '', '',
620 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
622 'primary_key' => 'custnum',
623 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
624 #'index' => [ ['last'], ['company'] ],
625 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
626 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
627 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
628 [ 'ship_last' ], [ 'ship_company' ],
629 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
630 [ 'payby' ], [ 'paydate' ],
634 'cust_main_invoice' => {
636 'destnum', 'serial', '', '', '', '',
637 'custnum', 'int', '', '', '', '',
638 'dest', 'varchar', '', $char_d, '', '',
640 'primary_key' => 'destnum',
642 'index' => [ ['custnum'], ],
645 'cust_main_note' => {
647 'notenum', 'serial', '', '', '', '',
648 'custnum', 'int', '', '', '', '',
649 '_date', @date_type, '', '',
650 'otaker', 'varchar', '', 32, '', '',
651 'comments', 'text', 'NULL', '', '', '',
653 'primary_key' => 'notenum',
655 'index' => [ [ 'custnum' ], [ '_date' ], ],
658 'cust_main_county' => { #county+state+country are checked off the
659 #cust_main_county for validation and to provide
662 'taxnum', 'serial', '', '', '', '',
663 'state', 'varchar', 'NULL', $char_d, '', '',
664 'county', 'varchar', 'NULL', $char_d, '', '',
665 'country', 'char', '', 2, '', '',
666 'taxclass', 'varchar', 'NULL', $char_d, '', '',
667 'exempt_amount', @money_type, '', '',
668 'tax', 'real', '', '', '', '', #tax %
669 'taxname', 'varchar', 'NULL', $char_d, '', '',
670 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
671 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
673 'primary_key' => 'taxnum',
675 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
676 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
681 'taxnum', 'serial', '', '', '', '',
682 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
683 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
684 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
685 'taxclassnum', 'int', '', '', '', '',
686 'effective_date', @date_type, '', '',
687 'tax', 'real', '', '', '', '', # tax %
688 'excessrate', 'real', 'NULL','', '', '', # second tax %
689 'taxbase', @money_typen, '', '', # amount at first tax rate
690 'taxmax', @money_typen, '', '', # maximum about at both rates
691 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
692 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
693 'unittype', 'int', 'NULL', '', '', '', # for fee
694 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
695 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
696 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
697 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
698 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
699 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
700 'taxauth', 'int', 'NULL', '', '', '', # tax authority
701 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
702 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
703 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
704 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
705 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
706 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
708 'primary_key' => 'taxnum',
710 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
713 'cust_tax_location' => {
715 'custlocationnum', 'serial', '', '', '', '',
716 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
717 'zip', 'char', '', 5, '', '',
718 'state', 'char', '', 2, '', '',
719 'plus4hi', 'char', '', 4, '', '',
720 'plus4lo', 'char', '', 4, '', '',
721 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
722 'geocode', 'varchar', '', 20, '', '',
724 'primary_key' => 'custlocationnum',
726 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
731 'taxclassnum', 'serial', '', '', '', '',
732 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
733 'taxclass', 'varchar', '', $char_d, '', '',
734 'description', 'varchar', '', 2*$char_d, '', '',
736 'primary_key' => 'taxclassnum',
737 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
741 'cust_pay_pending' => {
743 'paypendingnum','serial', '', '', '', '',
744 'custnum', 'int', '', '', '', '',
745 'paid', @money_type, '', '',
746 '_date', @date_type, '', '',
747 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
748 # be index into payby
750 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
751 'paymask', 'varchar', 'NULL', $char_d, '', '',
752 'paydate', 'varchar', 'NULL', 10, '', '',
753 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
754 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
756 'status', 'varchar', '', $char_d, '', '',
757 'statustext', 'text', 'NULL', '', '', '',
758 'gatewaynum', 'int', 'NULL', '', '', '',
759 #'cust_balance', @money_type, '', '',
760 'paynum', 'int', 'NULL', '', '', '',
762 'primary_key' => 'paypendingnum',
763 'unique' => [ [ 'payunique' ] ],
764 'index' => [ [ 'custnum' ], [ 'status' ], ],
769 'paynum', 'serial', '', '', '', '',
770 'custnum', 'int', '', '', '', '',
771 '_date', @date_type, '', '',
772 'paid', @money_type, '', '',
773 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
774 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
775 # index into payby table
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
782 'closed', 'char', 'NULL', 1, '', '',
784 'primary_key' => 'paynum',
785 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
786 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
791 'paynum', 'int', '', '', '', '',
792 'custnum', 'int', '', '', '', '',
793 'paid', @money_type, '', '',
794 '_date', @date_type, '', '',
795 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
796 # index into payby table
798 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
799 'paymask', 'varchar', 'NULL', $char_d, '', '',
800 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
801 'closed', 'char', 'NULL', 1, '', '',
802 'void_date', @date_type, '', '',
803 'reason', 'varchar', 'NULL', $char_d, '', '',
804 'otaker', 'varchar', '', 32, '', '',
806 'primary_key' => 'paynum',
808 'index' => [ [ 'custnum' ] ],
813 'billpaynum', 'serial', '', '', '', '',
814 'invnum', 'int', '', '', '', '',
815 'paynum', 'int', '', '', '', '',
816 'amount', @money_type, '', '',
817 '_date', @date_type, '', '',
819 'primary_key' => 'billpaynum',
821 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
824 'cust_bill_pay_batch' => {
826 'billpaynum', 'serial', '', '', '', '',
827 'invnum', 'int', '', '', '', '',
828 'paybatchnum', 'int', '', '', '', '',
829 'amount', @money_type, '', '',
830 '_date', @date_type, '', '',
832 'primary_key' => 'billpaynum',
834 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
837 'cust_bill_pay_pkg' => {
839 'billpaypkgnum', 'serial', '', '', '', '',
840 'billpaynum', 'int', '', '', '', '',
841 'billpkgnum', 'int', '', '', '', '',
842 'amount', @money_type, '', '',
843 'setuprecur', 'varchar', '', $char_d, '', '',
844 'sdate', @date_type, '', '',
845 'edate', @date_type, '', '',
847 'primary_key' => 'billpaypkgnum',
849 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
852 'pay_batch' => { #batches of payments to an external processor
854 'batchnum', 'serial', '', '', '', '',
855 'payby', 'char', '', 4, '', '', # CARD/CHEK
856 'status', 'char', 'NULL', 1, '', '',
857 'download', @date_type, '', '',
858 'upload', @date_type, '', '',
860 'primary_key' => 'batchnum',
865 'cust_pay_batch' => { #what's this used for again? list of customers
866 #in current CARD batch? (necessarily CARD?)
868 'paybatchnum', 'serial', '', '', '', '',
869 'batchnum', 'int', '', '', '', '',
870 'invnum', 'int', '', '', '', '',
871 'custnum', 'int', '', '', '', '',
872 'last', 'varchar', '', $char_d, '', '',
873 'first', 'varchar', '', $char_d, '', '',
874 'address1', 'varchar', '', $char_d, '', '',
875 'address2', 'varchar', 'NULL', $char_d, '', '',
876 'city', 'varchar', '', $char_d, '', '',
877 'state', 'varchar', 'NULL', $char_d, '', '',
878 'zip', 'varchar', 'NULL', 10, '', '',
879 'country', 'char', '', 2, '', '',
880 # 'trancode', 'int', '', '', '', ''
881 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
882 'payinfo', 'varchar', '', 512, '', '',
883 #'exp', @date_type, '', ''
884 'exp', 'varchar', 'NULL', 11, '', '',
885 'payname', 'varchar', 'NULL', $char_d, '', '',
886 'amount', @money_type, '', '',
887 'status', 'varchar', 'NULL', $char_d, '', '',
889 'primary_key' => 'paybatchnum',
891 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
896 'pkgnum', 'serial', '', '', '', '',
897 'custnum', 'int', '', '', '', '',
898 'pkgpart', 'int', '', '', '', '',
899 'otaker', 'varchar', '', 32, '', '',
900 'setup', @date_type, '', '',
901 'bill', @date_type, '', '',
902 'last_bill', @date_type, '', '',
903 'susp', @date_type, '', '',
904 'adjourn', @date_type, '', '',
905 'cancel', @date_type, '', '',
906 'expire', @date_type, '', '',
907 'change_date', @date_type, '', '',
908 'change_pkgnum', 'int', 'NULL', '', '', '',
909 'change_pkgpart', 'int', 'NULL', '', '', '',
910 'manual_flag', 'char', 'NULL', 1, '', '',
912 'primary_key' => 'pkgnum',
914 'index' => [ ['custnum'], ['pkgpart'],
915 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
916 ['expire'], ['cancel'],
921 'cust_pkg_option' => {
923 'optionnum', 'serial', '', '', '', '',
924 'pkgnum', 'int', '', '', '', '',
925 'optionname', 'varchar', '', $char_d, '', '',
926 'optionvalue', 'text', 'NULL', '', '', '',
928 'primary_key' => 'optionnum',
930 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
933 'cust_pkg_reason' => {
935 'num', 'serial', '', '', '', '',
936 'pkgnum', 'int', '', '', '', '',
937 'reasonnum','int', '', '', '', '',
938 'otaker', 'varchar', '', 32, '', '',
939 'date', @date_type, '', '',
941 'primary_key' => 'num',
948 'refundnum', 'serial', '', '', '', '',
949 'custnum', 'int', '', '', '', '',
950 '_date', @date_type, '', '',
951 'refund', @money_type, '', '',
952 'otaker', 'varchar', '', 32, '', '',
953 'reason', 'varchar', '', $char_d, '', '',
954 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
955 # be index into payby
957 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
958 'paymask', 'varchar', 'NULL', $char_d, '', '',
959 'paybatch', 'varchar', 'NULL', $char_d, '', '',
960 'closed', 'char', 'NULL', 1, '', '',
962 'primary_key' => 'refundnum',
964 'index' => [ ['custnum'], ['_date'] ],
967 'cust_credit_refund' => {
969 'creditrefundnum', 'serial', '', '', '', '',
970 'crednum', 'int', '', '', '', '',
971 'refundnum', 'int', '', '', '', '',
972 'amount', @money_type, '', '',
973 '_date', @date_type, '', '',
975 'primary_key' => 'creditrefundnum',
977 'index' => [ ['crednum'], ['refundnum'] ],
983 'svcnum', 'serial', '', '', '', '',
984 'pkgnum', 'int', 'NULL', '', '', '',
985 'svcpart', 'int', '', '', '', '',
986 'overlimit', @date_type, '', '',
988 'primary_key' => 'svcnum',
990 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
995 'pkgpart', 'serial', '', '', '', '',
996 'pkg', 'varchar', '', $char_d, '', '',
997 'comment', 'varchar', '', $char_d, '', '',
998 'promo_code', 'varchar', 'NULL', $char_d, '', '',
999 'setup', @perl_type, '', '',
1000 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1001 'recur', @perl_type, '', '',
1002 'setuptax', 'char', 'NULL', 1, '', '',
1003 'recurtax', 'char', 'NULL', 1, '', '',
1004 'plan', 'varchar', 'NULL', $char_d, '', '',
1005 'plandata', 'text', 'NULL', '', '', '',
1006 'disabled', 'char', 'NULL', 1, '', '',
1007 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1008 'classnum', 'int', 'NULL', '', '', '',
1009 'taxproductnum', 'int', 'NULL', '', '', '',
1010 'pay_weight', 'real', 'NULL', '', '', '',
1011 'credit_weight', 'real', 'NULL', '', '', '',
1012 'agentnum', 'int', 'NULL', '', '', '',
1015 'primary_key' => 'pkgpart',
1017 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1020 'part_pkg_link' => {
1022 'pkglinknum', 'serial', '', '', '', '',
1023 'src_pkgpart', 'int', '', '', '', '',
1024 'dst_pkgpart', 'int', '', '', '', '',
1025 'link_type', 'varchar', '', $char_d, '', '',
1027 'primary_key' => 'pkglinknum',
1028 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1029 'index' => [ [ 'src_pkgpart' ] ],
1032 'part_pkg_taxclass' => {
1034 'taxclassnum', 'serial', '', '', '', '',
1035 'taxclass', 'varchar', '', $char_d, '', '',
1037 'primary_key' => 'taxclassnum',
1038 'unique' => [ [ 'taxclass' ] ],
1042 'part_pkg_taxproduct' => {
1044 'taxproductnum', 'serial', '', '', '', '',
1045 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1046 'taxproduct', 'varchar', '', $char_d, '', '',
1047 'description', 'varchar', '', 2*$char_d, '', '',
1049 'primary_key' => 'taxproductnum',
1050 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1054 'part_pkg_taxrate' => {
1056 'pkgtaxratenum', 'serial', '', '', '', '',
1057 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1058 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1059 'taxproductnum', 'int', '', '', '', '',
1060 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1061 'county', 'varchar', 'NULL', $char_d, '', '',
1062 'state', 'varchar', 'NULL', $char_d, '', '',
1063 'local', 'varchar', 'NULL', $char_d, '', '',
1064 'country', 'char', 'NULL', 2, '', '',
1065 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1066 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1067 'taxclassnum', 'int', 'NULL', '', '', '',
1068 'effdate', @date_type, '', '',
1069 'taxable', 'char', 'NULL', 1, '', '',
1071 'primary_key' => 'pkgtaxratenum',
1073 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1076 'part_pkg_taxoverride' => {
1078 'taxoverridenum', 'serial', '', '', '', '',
1079 'pkgpart', 'serial', '', '', '', '',
1080 'taxclassnum', 'serial', '', '', '', '',
1082 'primary_key' => 'taxoverridenum',
1084 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1089 # 'titlenum', 'int', '', '',
1090 # 'title', 'varchar', '', $char_d,
1092 # 'primary_key' => 'titlenum',
1093 # 'unique' => [ [] ],
1094 # 'index' => [ [] ],
1099 'pkgsvcnum', 'serial', '', '', '', '',
1100 'pkgpart', 'int', '', '', '', '',
1101 'svcpart', 'int', '', '', '', '',
1102 'quantity', 'int', '', '', '', '',
1103 'primary_svc','char', 'NULL', 1, '', '',
1105 'primary_key' => 'pkgsvcnum',
1106 'unique' => [ ['pkgpart', 'svcpart'] ],
1107 'index' => [ ['pkgpart'] ],
1110 'part_referral' => {
1112 'refnum', 'serial', '', '', '', '',
1113 'referral', 'varchar', '', $char_d, '', '',
1114 'disabled', 'char', 'NULL', 1, '', '',
1115 'agentnum', 'int', 'NULL', '', '', '',
1117 'primary_key' => 'refnum',
1119 'index' => [ ['disabled'], ['agentnum'], ],
1124 'svcpart', 'serial', '', '', '', '',
1125 'svc', 'varchar', '', $char_d, '', '',
1126 'svcdb', 'varchar', '', $char_d, '', '',
1127 'disabled', 'char', 'NULL', 1, '', '',
1129 'primary_key' => 'svcpart',
1131 'index' => [ [ 'disabled' ] ],
1134 'part_svc_column' => {
1136 'columnnum', 'serial', '', '', '', '',
1137 'svcpart', 'int', '', '', '', '',
1138 'columnname', 'varchar', '', 64, '', '',
1139 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1140 'columnflag', 'char', 'NULL', 1, '', '',
1142 'primary_key' => 'columnnum',
1143 'unique' => [ [ 'svcpart', 'columnname' ] ],
1144 'index' => [ [ 'svcpart' ] ],
1147 #(this should be renamed to part_pop)
1150 'popnum', 'serial', '', '', '', '',
1151 'city', 'varchar', '', $char_d, '', '',
1152 'state', 'varchar', '', $char_d, '', '',
1153 'ac', 'char', '', 3, '', '',
1154 'exch', 'char', '', 3, '', '',
1155 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1157 'primary_key' => 'popnum',
1159 'index' => [ [ 'state' ] ],
1162 'part_pop_local' => {
1164 'localnum', 'serial', '', '', '', '',
1165 'popnum', 'int', '', '', '', '',
1166 'city', 'varchar', 'NULL', $char_d, '', '',
1167 'state', 'char', 'NULL', 2, '', '',
1168 'npa', 'char', '', 3, '', '',
1169 'nxx', 'char', '', 3, '', '',
1171 'primary_key' => 'localnum',
1173 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1178 'svcnum', 'int', '', '', '', '',
1179 'username', 'varchar', '', $username_len, '', '',
1180 '_password', 'varchar', '', 512, '', '',
1181 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1182 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1183 'popnum', 'int', 'NULL', '', '', '',
1184 'uid', 'int', 'NULL', '', '', '',
1185 'gid', 'int', 'NULL', '', '', '',
1186 'finger', 'varchar', 'NULL', $char_d, '', '',
1187 'dir', 'varchar', 'NULL', $char_d, '', '',
1188 'shell', 'varchar', 'NULL', $char_d, '', '',
1189 'quota', 'varchar', 'NULL', $char_d, '', '',
1190 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1191 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1192 'seconds_threshold', 'int', 'NULL', '', '', '',
1193 'upbytes', 'bigint', 'NULL', '', '', '',
1194 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1195 'downbytes', 'bigint', 'NULL', '', '', '',
1196 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1197 'totalbytes','bigint', 'NULL', '', '', '',
1198 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1199 'domsvc', 'int', '', '', '', '',
1200 'last_login', @date_type, '', '',
1201 'last_logout', @date_type, '', '',
1203 'primary_key' => 'svcnum',
1204 #'unique' => [ [ 'username', 'domsvc' ] ],
1206 'index' => [ ['username'], ['domsvc'] ],
1209 'acct_rt_transaction' => {
1211 'svcrtid', 'int', '', '', '', '',
1212 'svcnum', 'int', '', '', '', '',
1213 'transaction_id', 'int', '', '', '', '',
1214 '_date', @date_type, '', '',
1215 'seconds', 'int', '', '', '', '', #uhhhh
1216 'support', 'int', '', '', '', '',
1218 'primary_key' => 'svcrtid',
1220 'index' => [ ['svcnum', 'transaction_id'] ],
1225 # 'svcnum', 'int', '', '',
1226 # 'amount', @money_type,
1228 # 'primary_key' => 'svcnum',
1229 # 'unique' => [ [] ],
1230 # 'index' => [ [] ],
1235 'svcnum', 'int', '', '', '', '',
1236 'domain', 'varchar', '', $char_d, '', '',
1237 'suffix', 'varchar', 'NULL', $char_d, '', '',
1238 'catchall', 'int', 'NULL', '', '', '',
1239 'parent_svcnum', 'int', 'NULL', '', '', '',
1240 'registrarnum', 'int', 'NULL', '', '', '',
1241 'registrarkey', 'varchar', 'NULL', 512, '', '',
1242 'setup_date', @date_type, '', '',
1243 'renewal_interval', 'int', 'NULL', '', '', '',
1244 'expiration_date', @date_type, '', '',
1246 'primary_key' => 'svcnum',
1248 'index' => [ ['domain'] ],
1251 'domain_record' => {
1253 'recnum', 'serial', '', '', '', '',
1254 'svcnum', 'int', '', '', '', '',
1255 'reczone', 'varchar', '', 255, '', '',
1256 'recaf', 'char', '', 2, '', '',
1257 'rectype', 'varchar', '', 5, '', '',
1258 'recdata', 'varchar', '', 255, '', '',
1260 'primary_key' => 'recnum',
1262 'index' => [ ['svcnum'] ],
1267 'registrarnum', 'serial', '', '', '', '',
1268 'registrarname', 'varchar', '', $char_d, '', '',
1270 'primary_key' => 'registrarnum',
1277 'svcnum', 'int', '', '', '', '',
1278 'srcsvc', 'int', 'NULL', '', '', '',
1279 'src', 'varchar', 'NULL', 255, '', '',
1280 'dstsvc', 'int', 'NULL', '', '', '',
1281 'dst', 'varchar', 'NULL', 255, '', '',
1283 'primary_key' => 'svcnum',
1285 'index' => [ ['srcsvc'], ['dstsvc'] ],
1290 'svcnum', 'int', '', '', '', '',
1291 'recnum', 'int', '', '', '', '',
1292 'usersvc', 'int', 'NULL', '', '', '',
1293 'config', 'text', 'NULL', '', '', '',
1295 'primary_key' => 'svcnum',
1302 # 'svcnum', 'int', '', '',
1303 # 'svcnum', 'int', '', '',
1304 # 'svcnum', 'int', '', '',
1305 # 'worker', 'varchar', '', $char_d,
1306 # '_date', @date_type,
1308 # 'primary_key' => 'svcnum',
1309 # 'unique' => [ [] ],
1310 # 'index' => [ [] ],
1313 'prepay_credit' => {
1315 'prepaynum', 'serial', '', '', '', '',
1316 'identifier', 'varchar', '', $char_d, '', '',
1317 'amount', @money_type, '', '',
1318 'seconds', 'int', 'NULL', '', '', '',
1319 'upbytes', 'bigint', 'NULL', '', '', '',
1320 'downbytes', 'bigint', 'NULL', '', '', '',
1321 'totalbytes', 'bigint', 'NULL', '', '', '',
1322 'agentnum', 'int', 'NULL', '', '', '',
1324 'primary_key' => 'prepaynum',
1325 'unique' => [ ['identifier'] ],
1331 'portnum', 'serial', '', '', '', '',
1332 'ip', 'varchar', 'NULL', 15, '', '',
1333 'nasport', 'int', 'NULL', '', '', '',
1334 'nasnum', 'int', '', '', '', '',
1336 'primary_key' => 'portnum',
1343 'nasnum', 'serial', '', '', '', '',
1344 'nas', 'varchar', '', $char_d, '', '',
1345 'nasip', 'varchar', '', 15, '', '',
1346 'nasfqdn', 'varchar', '', $char_d, '', '',
1347 'last', 'int', '', '', '', '',
1349 'primary_key' => 'nasnum',
1350 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1351 'index' => [ [ 'last' ] ],
1356 # 'sessionnum', 'serial', '', '', '', '',
1357 # 'portnum', 'int', '', '', '', '',
1358 # 'svcnum', 'int', '', '', '', '',
1359 # 'login', @date_type, '', '',
1360 # 'logout', @date_type, '', '',
1362 # 'primary_key' => 'sessionnum',
1364 # 'index' => [ [ 'portnum' ] ],
1369 'jobnum', 'serial', '', '', '', '',
1370 'job', 'text', '', '', '', '',
1371 '_date', 'int', '', '', '', '',
1372 'status', 'varchar', '', $char_d, '', '',
1373 'statustext', 'text', 'NULL', '', '', '',
1374 'svcnum', 'int', 'NULL', '', '', '',
1375 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1378 'primary_key' => 'jobnum',
1380 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1385 'argnum', 'serial', '', '', '', '',
1386 'jobnum', 'int', '', '', '', '',
1387 'arg', 'text', 'NULL', '', '', '',
1389 'primary_key' => 'argnum',
1391 'index' => [ [ 'jobnum' ] ],
1396 'dependnum', 'serial', '', '', '', '',
1397 'jobnum', 'int', '', '', '', '',
1398 'depend_jobnum', 'int', '', '', '', '',
1400 'primary_key' => 'dependnum',
1402 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1407 'exportsvcnum' => 'serial', '', '', '', '',
1408 'exportnum' => 'int', '', '', '', '',
1409 'svcpart' => 'int', '', '', '', '',
1411 'primary_key' => 'exportsvcnum',
1412 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1413 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1418 'exportnum', 'serial', '', '', '', '',
1419 'machine', 'varchar', '', $char_d, '', '',
1420 'exporttype', 'varchar', '', $char_d, '', '',
1421 'nodomain', 'char', 'NULL', 1, '', '',
1423 'primary_key' => 'exportnum',
1425 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1428 'part_export_option' => {
1430 'optionnum', 'serial', '', '', '', '',
1431 'exportnum', 'int', '', '', '', '',
1432 'optionname', 'varchar', '', $char_d, '', '',
1433 'optionvalue', 'text', 'NULL', '', '', '',
1435 'primary_key' => 'optionnum',
1437 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1440 'radius_usergroup' => {
1442 'usergroupnum', 'serial', '', '', '', '',
1443 'svcnum', 'int', '', '', '', '',
1444 'groupname', 'varchar', '', $char_d, '', '',
1446 'primary_key' => 'usergroupnum',
1448 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1453 'msgnum', 'serial', '', '', '', '',
1454 'msgcode', 'varchar', '', $char_d, '', '',
1455 'locale', 'varchar', '', 16, '', '',
1456 'msg', 'text', '', '', '', '',
1458 'primary_key' => 'msgnum',
1459 'unique' => [ [ 'msgcode', 'locale' ] ],
1463 'cust_tax_exempt' => {
1465 'exemptnum', 'serial', '', '', '', '',
1466 'custnum', 'int', '', '', '', '',
1467 'taxnum', 'int', '', '', '', '',
1468 'year', 'int', '', '', '', '',
1469 'month', 'int', '', '', '', '',
1470 'amount', @money_type, '', '',
1472 'primary_key' => 'exemptnum',
1473 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1477 'cust_tax_exempt_pkg' => {
1479 'exemptpkgnum', 'serial', '', '', '', '',
1480 #'custnum', 'int', '', '', '', ''
1481 'billpkgnum', 'int', '', '', '', '',
1482 'taxnum', 'int', '', '', '', '',
1483 'year', 'int', '', '', '', '',
1484 'month', 'int', '', '', '', '',
1485 'amount', @money_type, '', '',
1487 'primary_key' => 'exemptpkgnum',
1489 'index' => [ [ 'taxnum', 'year', 'month' ],
1497 'routernum', 'serial', '', '', '', '',
1498 'routername', 'varchar', '', $char_d, '', '',
1499 'svcnum', 'int', 'NULL', '', '', '',
1500 'agentnum', 'int', 'NULL', '', '', '',
1502 'primary_key' => 'routernum',
1507 'part_svc_router' => {
1509 'svcrouternum', 'serial', '', '', '', '',
1510 'svcpart', 'int', '', '', '', '',
1511 'routernum', 'int', '', '', '', '',
1513 'primary_key' => 'svcrouternum',
1520 'blocknum', 'serial', '', '', '', '',
1521 'routernum', 'int', '', '', '', '',
1522 'ip_gateway', 'varchar', '', 15, '', '',
1523 'ip_netmask', 'int', '', '', '', '',
1524 'agentnum', 'int', 'NULL', '', '', '',
1526 'primary_key' => 'blocknum',
1527 'unique' => [ [ 'blocknum', 'routernum' ] ],
1531 'svc_broadband' => {
1533 'svcnum', 'int', '', '', '', '',
1534 'description', 'varchar', 'NULL', $char_d, '', '',
1535 'blocknum', 'int', '', '', '', '',
1536 'speed_up', 'int', '', '', '', '',
1537 'speed_down', 'int', '', '', '', '',
1538 'ip_addr', 'varchar', '', 15, '', '',
1539 'mac_addr', 'varchar', 'NULL', 12, '', '',
1540 'authkey', 'varchar', 'NULL', 32, '', '',
1541 'latitude', 'decimal', 'NULL', '', '', '',
1542 'longitude', 'decimal', 'NULL', '', '', '',
1543 'altitude', 'decimal', 'NULL', '', '', '',
1544 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1546 'primary_key' => 'svcnum',
1551 'part_virtual_field' => {
1553 'vfieldpart', 'serial', '', '', '', '',
1554 'dbtable', 'varchar', '', 32, '', '',
1555 'name', 'varchar', '', 32, '', '',
1556 'check_block', 'text', 'NULL', '', '', '',
1557 'length', 'int', 'NULL', '', '', '',
1558 'list_source', 'text', 'NULL', '', '', '',
1559 'label', 'varchar', 'NULL', 80, '', '',
1561 'primary_key' => 'vfieldpart',
1566 'virtual_field' => {
1568 'vfieldnum', 'serial', '', '', '', '',
1569 'recnum', 'int', '', '', '', '',
1570 'vfieldpart', 'int', '', '', '', '',
1571 'value', 'varchar', '', 128, '', '',
1573 'primary_key' => 'vfieldnum',
1574 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1580 'snarfnum', 'int', '', '', '', '',
1581 'svcnum', 'int', '', '', '', '',
1582 'machine', 'varchar', '', 255, '', '',
1583 'protocol', 'varchar', '', $char_d, '', '',
1584 'username', 'varchar', '', $char_d, '', '',
1585 '_password', 'varchar', '', $char_d, '', '',
1587 'primary_key' => 'snarfnum',
1589 'index' => [ [ 'svcnum' ] ],
1594 'svcnum', 'int', '', '', '', '',
1595 'id', 'int', 'NULL', '', '', '',
1596 'title', 'varchar', 'NULL', $char_d, '', '',
1598 'primary_key' => 'svcnum',
1603 'cust_pay_refund' => {
1605 'payrefundnum', 'serial', '', '', '', '',
1606 'paynum', 'int', '', '', '', '',
1607 'refundnum', 'int', '', '', '', '',
1608 '_date', @date_type, '', '',
1609 'amount', @money_type, '', '',
1611 'primary_key' => 'payrefundnum',
1613 'index' => [ ['paynum'], ['refundnum'] ],
1616 'part_pkg_option' => {
1618 'optionnum', 'serial', '', '', '', '',
1619 'pkgpart', 'int', '', '', '', '',
1620 'optionname', 'varchar', '', $char_d, '', '',
1621 'optionvalue', 'text', 'NULL', '', '', '',
1623 'primary_key' => 'optionnum',
1625 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1630 'ratenum', 'serial', '', '', '', '',
1631 'ratename', 'varchar', '', $char_d, '', '',
1633 'primary_key' => 'ratenum',
1640 'ratedetailnum', 'serial', '', '', '', '',
1641 'ratenum', 'int', '', '', '', '',
1642 'orig_regionnum', 'int', 'NULL', '', '', '',
1643 'dest_regionnum', 'int', '', '', '', '',
1644 'min_included', 'int', '', '', '', '',
1645 #'min_charge', @money_type, '', '',
1646 'min_charge', 'decimal', '', '10,5', '', '',
1647 'sec_granularity', 'int', '', '', '', '',
1648 #time period (link to table of periods)?
1650 'primary_key' => 'ratedetailnum',
1651 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1652 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1657 'regionnum', 'serial', '', '', '', '',
1658 'regionname', 'varchar', '', $char_d, '', '',
1660 'primary_key' => 'regionnum',
1667 'prefixnum', 'serial', '', '', '', '',
1668 'regionnum', 'int', '', '',, '', '',
1669 'countrycode', 'varchar', '', 3, '', '',
1670 'npa', 'varchar', 'NULL', 6, '', '',
1671 'nxx', 'varchar', 'NULL', 3, '', '',
1673 'primary_key' => 'prefixnum',
1675 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1680 'codenum', 'serial', '', '', '', '',
1681 'code', 'varchar', '', $char_d, '', '',
1682 'agentnum', 'int', '', '', '', '',
1684 'primary_key' => 'codenum',
1685 'unique' => [ [ 'agentnum', 'code' ] ],
1686 'index' => [ [ 'agentnum' ] ],
1691 'codepkgnum', 'serial', '', '', '', '',
1692 'codenum', 'int', '', '', '', '',
1693 'pkgpart', 'int', '', '', '', '',
1695 'primary_key' => 'codepkgnum',
1696 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1697 'index' => [ [ 'codenum' ] ],
1700 'clientapi_session' => {
1702 'sessionnum', 'serial', '', '', '', '',
1703 'sessionid', 'varchar', '', $char_d, '', '',
1704 'namespace', 'varchar', '', $char_d, '', '',
1706 'primary_key' => 'sessionnum',
1707 'unique' => [ [ 'sessionid', 'namespace' ] ],
1711 'clientapi_session_field' => {
1713 'fieldnum', 'serial', '', '', '', '',
1714 'sessionnum', 'int', '', '', '', '',
1715 'fieldname', 'varchar', '', $char_d, '', '',
1716 'fieldvalue', 'text', 'NULL', '', '', '',
1718 'primary_key' => 'fieldnum',
1719 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1723 'payment_gateway' => {
1725 'gatewaynum', 'serial', '', '', '', '',
1726 'gateway_module', 'varchar', '', $char_d, '', '',
1727 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1728 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1729 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1730 'disabled', 'char', 'NULL', 1, '', '',
1732 'primary_key' => 'gatewaynum',
1734 'index' => [ [ 'disabled' ] ],
1737 'payment_gateway_option' => {
1739 'optionnum', 'serial', '', '', '', '',
1740 'gatewaynum', 'int', '', '', '', '',
1741 'optionname', 'varchar', '', $char_d, '', '',
1742 'optionvalue', 'text', 'NULL', '', '', '',
1744 'primary_key' => 'optionnum',
1746 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1749 'agent_payment_gateway' => {
1751 'agentgatewaynum', 'serial', '', '', '', '',
1752 'agentnum', 'int', '', '', '', '',
1753 'gatewaynum', 'int', '', '', '', '',
1754 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1755 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1757 'primary_key' => 'agentgatewaynum',
1759 'index' => [ [ 'agentnum', 'cardtype' ], ],
1764 'bannum', 'serial', '', '', '', '',
1765 'payby', 'char', '', 4, '', '',
1766 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1767 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1768 '_date', @date_type, '', '',
1769 'otaker', 'varchar', '', 32, '', '',
1770 'reason', 'varchar', 'NULL', $char_d, '', '',
1772 'primary_key' => 'bannum',
1773 'unique' => [ [ 'payby', 'payinfo' ] ],
1779 'classnum', 'serial', '', '', '', '',
1780 'classname', 'varchar', '', $char_d, '', '',
1781 'disabled', 'char', 'NULL', 1, '', '',
1783 'primary_key' => 'classnum',
1785 'index' => [ ['disabled'] ],
1790 # qw( name type null length default local );
1796 'acctid', 'bigserial', '', '', '', '',
1797 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1798 'calldate', 'timestamp', '', '', \'now()', '',
1799 'clid', 'varchar', '', $char_d, \"''", '',
1800 'src', 'varchar', '', $char_d, \"''", '',
1801 'dst', 'varchar', '', $char_d, \"''", '',
1802 'dcontext', 'varchar', '', $char_d, \"''", '',
1803 'channel', 'varchar', '', $char_d, \"''", '',
1804 'dstchannel', 'varchar', '', $char_d, \"''", '',
1805 'lastapp', 'varchar', '', $char_d, \"''", '',
1806 'lastdata', 'varchar', '', $char_d, \"''", '',
1808 #these don't seem to be logged by most of the SQL cdr_* modules
1809 #except tds under sql-illegal names, so;
1810 # ... don't rely on them for rating?
1811 # and, what they hey, i went ahead and changed the names and data types
1812 # to freeside-style dates...
1813 #'start', 'timestamp', 'NULL', '', '', '',
1814 #'answer', 'timestamp', 'NULL', '', '', '',
1815 #'end', 'timestamp', 'NULL', '', '', '',
1816 'startdate', @date_type, '', '',
1817 'answerdate', @date_type, '', '',
1818 'enddate', @date_type, '', '',
1821 'duration', 'int', '', '', 0, '',
1822 'billsec', 'int', '', '', 0, '',
1823 'disposition', 'varchar', '', 45, \"''", '',
1824 'amaflags', 'int', '', '', 0, '',
1825 'accountcode', 'varchar', '', 20, \"''", '',
1826 'uniqueid', 'varchar', '', 32, \"''", '',
1827 'userfield', 'varchar', '', 255, \"''", '',
1830 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1834 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1835 'cdrtypenum', 'int', 'NULL', '', '', '',
1837 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1839 'upstream_currency', 'char', 'NULL', 3, '', '',
1840 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1841 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1843 # how it was rated internally...
1844 'ratedetailnum', 'int', 'NULL', '', '', '',
1845 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1847 'distance', 'decimal', 'NULL', '', '', '',
1848 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1850 #cdr_calltype: the big list in appendix 2
1851 'calltypenum', 'int', 'NULL', '', '', '',
1853 'description', 'varchar', 'NULL', $char_d, '', '',
1854 'quantity', 'int', 'NULL', '', '', '',
1856 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1857 'carrierid', 'int', 'NULL', '', '', '',
1859 'upstream_rateid', 'int', 'NULL', '', '', '',
1862 #and now for our own fields
1865 # a svcnum... right..?
1866 'svcnum', 'int', 'NULL', '', '', '',
1868 #NULL, done (or something)
1869 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1872 'primary_key' => 'acctid',
1874 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1879 'calltypenum', 'serial', '', '', '', '',
1880 'calltypename', 'varchar', '', $char_d, '', '',
1882 'primary_key' => 'calltypenum',
1889 'cdrtypenum' => 'serial', '', '', '', '',
1890 'cdrtypename' => 'varchar', '', $char_d, '', '',
1892 'primary_key' => 'cdrtypenum',
1899 'carrierid' => 'serial', '', '', '', '',
1900 'carriername' => 'varchar', '', $char_d, '', '',
1902 'primary_key' => 'carrierid',
1907 #map upstream rateid to ours...
1908 'cdr_upstream_rate' => {
1910 'upstreamratenum', 'serial', '', '', '', '',
1911 'upstream_rateid', 'varchar', '', $char_d, '', '',
1912 'ratedetailnum', 'int', 'NULL', '', '', '',
1914 'primary_key' => 'upstreamratenum', #XXX need a primary key
1915 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1919 'inventory_item' => {
1921 'itemnum', 'serial', '', '', '', '',
1922 'classnum', 'int', '', '', '', '',
1923 'item', 'varchar', '', $char_d, '', '',
1924 'svcnum', 'int', 'NULL', '', '', '',
1926 'primary_key' => 'itemnum',
1927 'unique' => [ [ 'classnum', 'item' ] ],
1928 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1931 'inventory_class' => {
1933 'classnum', 'serial', '', '', '', '',
1934 'classname', 'varchar', '', $char_d, '', '',
1936 'primary_key' => 'classnum',
1943 'usernum', 'serial', '', '', '', '',
1944 'username', 'varchar', '', $char_d, '', '',
1945 '_password', 'varchar', '', $char_d, '', '',
1946 'last', 'varchar', '', $char_d, '', '',
1947 'first', 'varchar', '', $char_d, '', '',
1948 'disabled', 'char', 'NULL', 1, '', '',
1950 'primary_key' => 'usernum',
1951 'unique' => [ [ 'username' ] ],
1955 'access_user_pref' => {
1957 'prefnum', 'serial', '', '', '', '',
1958 'usernum', 'int', '', '', '', '',
1959 'prefname', 'varchar', '', $char_d, '', '',
1960 'prefvalue', 'text', 'NULL', '', '', '',
1961 'expiration', @date_type, '', '',
1963 'primary_key' => 'prefnum',
1965 'index' => [ [ 'usernum' ] ],
1970 'groupnum', 'serial', '', '', '', '',
1971 'groupname', 'varchar', '', $char_d, '', '',
1973 'primary_key' => 'groupnum',
1974 'unique' => [ [ 'groupname' ] ],
1978 'access_usergroup' => {
1980 'usergroupnum', 'serial', '', '', '', '',
1981 'usernum', 'int', '', '', '', '',
1982 'groupnum', 'int', '', '', '', '',
1984 'primary_key' => 'usergroupnum',
1985 'unique' => [ [ 'usernum', 'groupnum' ] ],
1986 'index' => [ [ 'usernum' ] ],
1989 'access_groupagent' => {
1991 'groupagentnum', 'serial', '', '', '', '',
1992 'groupnum', 'int', '', '', '', '',
1993 'agentnum', 'int', '', '', '', '',
1995 'primary_key' => 'groupagentnum',
1996 'unique' => [ [ 'groupnum', 'agentnum' ] ],
1997 'index' => [ [ 'groupnum' ] ],
2002 'rightnum', 'serial', '', '', '', '',
2003 'righttype', 'varchar', '', $char_d, '', '',
2004 'rightobjnum', 'int', '', '', '', '',
2005 'rightname', 'varchar', '', $char_d, '', '',
2007 'primary_key' => 'rightnum',
2008 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2014 'svcnum', 'int', '', '', '', '',
2015 'countrycode', 'varchar', '', 3, '', '',
2016 'phonenum', 'varchar', '', 15, '', '', #12 ?
2017 'pin', 'varchar', 'NULL', $char_d, '', '',
2019 'primary_key' => 'svcnum',
2021 'index' => [ [ 'countrycode', 'phonenum' ] ],
2026 'typenum', 'serial', '', '', '', '',
2027 'class', 'char', '', 1, '', '',
2028 'type', 'varchar', '', $char_d, '', '',
2030 'primary_key' => 'typenum',
2037 'reasonnum', 'serial', '', '', '', '',
2038 'reason_type', 'int', '', '', '', '',
2039 'reason', 'text', '', '', '', '',
2040 'disabled', 'char', 'NULL', 1, '', '',
2042 'primary_key' => 'reasonnum',
2049 'confnum', 'serial', '', '', '', '',
2050 'agentnum', 'int', 'NULL', '', '', '',
2051 'name', 'varchar', '', $char_d, '', '',
2052 'value', 'text', 'NULL', '', '', '',
2054 'primary_key' => 'confnum',
2055 'unique' => [ [ 'agentnum', 'name' ]],
2061 'pkgrefnum', 'serial', '', '', '', '',
2062 'pkgnum', 'int', '', '', '', '',
2063 'refnum', 'int', '', '', '', '',
2065 'primary_key' => 'pkgrefnum',
2066 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2067 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2069 # name type nullability length default local
2073 # 'num', 'serial', '', '', '', '',
2075 # 'primary_key' => 'num',