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 'pkgnum', 'int', '', '', '', '',
512 'invnum', 'int', '', '', '', '',
513 'format', 'char', 'NULL', 1, '', '',
514 'detail', 'varchar', '', $char_d, '', '',
516 'primary_key' => 'detailnum',
518 'index' => [ [ 'pkgnum', 'invnum' ] ],
523 'crednum', 'serial', '', '', '', '',
524 'custnum', 'int', '', '', '', '',
525 '_date', @date_type, '', '',
526 'amount', @money_type, '', '',
527 'otaker', 'varchar', '', 32, '', '',
528 'reason', 'text', 'NULL', '', '', '',
529 'reasonnum', 'int', 'NULL', '', '', '',
530 'closed', 'char', 'NULL', 1, '', '',
532 'primary_key' => 'crednum',
534 'index' => [ ['custnum'], ['_date'] ],
537 'cust_credit_bill' => {
539 'creditbillnum', 'serial', '', '', '', '',
540 'crednum', 'int', '', '', '', '',
541 'invnum', 'int', '', '', '', '',
542 '_date', @date_type, '', '',
543 'amount', @money_type, '', '',
545 'primary_key' => 'creditbillnum',
547 'index' => [ ['crednum'], ['invnum'] ],
550 'cust_credit_bill_pkg' => {
552 'creditbillpkgnum', 'serial', '', '', '', '',
553 'creditbillnum', 'int', '', '', '', '',
554 'billpkgnum', 'int', '', '', '', '',
555 'amount', @money_type, '', '',
556 'setuprecur', 'varchar', '', $char_d, '', '',
557 'sdate', @date_type, '', '',
558 'edate', @date_type, '', '',
560 'primary_key' => 'creditbillpkgnum',
562 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
567 'custnum', 'serial', '', '', '', '',
568 'agentnum', 'int', '', '', '', '',
569 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
570 # 'titlenum', 'int', 'NULL', '', '', '',
571 'last', 'varchar', '', $char_d, '', '',
572 # 'middle', 'varchar', 'NULL', $char_d, '', '',
573 'first', 'varchar', '', $char_d, '', '',
574 'ss', 'varchar', 'NULL', 11, '', '',
575 'stateid', 'varchar', 'NULL', $char_d, '', '',
576 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
577 'birthdate' ,@date_type, '', '',
578 'signupdate',@date_type, '', '',
579 'company', 'varchar', 'NULL', $char_d, '', '',
580 'address1', 'varchar', '', $char_d, '', '',
581 'address2', 'varchar', 'NULL', $char_d, '', '',
582 'city', 'varchar', '', $char_d, '', '',
583 'county', 'varchar', 'NULL', $char_d, '', '',
584 'state', 'varchar', 'NULL', $char_d, '', '',
585 'zip', 'varchar', 'NULL', 10, '', '',
586 'country', 'char', '', 2, '', '',
587 'daytime', 'varchar', 'NULL', 20, '', '',
588 'night', 'varchar', 'NULL', 20, '', '',
589 'fax', 'varchar', 'NULL', 12, '', '',
590 'ship_last', 'varchar', 'NULL', $char_d, '', '',
591 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
592 'ship_first', 'varchar', 'NULL', $char_d, '', '',
593 'ship_company', 'varchar', 'NULL', $char_d, '', '',
594 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
595 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
596 'ship_city', 'varchar', 'NULL', $char_d, '', '',
597 'ship_county', 'varchar', 'NULL', $char_d, '', '',
598 'ship_state', 'varchar', 'NULL', $char_d, '', '',
599 'ship_zip', 'varchar', 'NULL', 10, '', '',
600 'ship_country', 'char', 'NULL', 2, '', '',
601 'ship_daytime', 'varchar', 'NULL', 20, '', '',
602 'ship_night', 'varchar', 'NULL', 20, '', '',
603 'ship_fax', 'varchar', 'NULL', 12, '', '',
604 'payby', 'char', '', 4, '', '',
605 'payinfo', 'varchar', 'NULL', 512, '', '',
606 'paycvv', 'varchar', 'NULL', 512, '', '',
607 'paymask', 'varchar', 'NULL', $char_d, '', '',
608 #'paydate', @date_type, '', '',
609 'paydate', 'varchar', 'NULL', 10, '', '',
610 'paystart_month', 'int', 'NULL', '', '', '',
611 'paystart_year', 'int', 'NULL', '', '', '',
612 'payissue', 'varchar', 'NULL', 2, '', '',
613 'payname', 'varchar', 'NULL', $char_d, '', '',
614 'paystate', 'varchar', 'NULL', $char_d, '', '',
615 'paytype', 'varchar', 'NULL', $char_d, '', '',
616 'payip', 'varchar', 'NULL', 15, '', '',
617 'tax', 'char', 'NULL', 1, '', '',
618 'otaker', 'varchar', '', 32, '', '',
619 'refnum', 'int', '', '', '', '',
620 'referral_custnum', 'int', 'NULL', '', '', '',
621 'comments', 'text', 'NULL', '', '', '',
622 'spool_cdr','char', 'NULL', 1, '', '',
623 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
625 'primary_key' => 'custnum',
626 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
627 #'index' => [ ['last'], ['company'] ],
628 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
629 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
630 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
631 [ 'ship_last' ], [ 'ship_company' ],
632 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
633 [ 'payby' ], [ 'paydate' ],
637 'cust_main_invoice' => {
639 'destnum', 'serial', '', '', '', '',
640 'custnum', 'int', '', '', '', '',
641 'dest', 'varchar', '', $char_d, '', '',
643 'primary_key' => 'destnum',
645 'index' => [ ['custnum'], ],
648 'cust_main_note' => {
650 'notenum', 'serial', '', '', '', '',
651 'custnum', 'int', '', '', '', '',
652 '_date', @date_type, '', '',
653 'otaker', 'varchar', '', 32, '', '',
654 'comments', 'text', 'NULL', '', '', '',
656 'primary_key' => 'notenum',
658 'index' => [ [ 'custnum' ], [ '_date' ], ],
661 'cust_main_county' => { #county+state+country are checked off the
662 #cust_main_county for validation and to provide
665 'taxnum', 'serial', '', '', '', '',
666 'state', 'varchar', 'NULL', $char_d, '', '',
667 'county', 'varchar', 'NULL', $char_d, '', '',
668 'country', 'char', '', 2, '', '',
669 'taxclass', 'varchar', 'NULL', $char_d, '', '',
670 'exempt_amount', @money_type, '', '',
671 'tax', 'real', '', '', '', '', #tax %
672 'taxname', 'varchar', 'NULL', $char_d, '', '',
673 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
674 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
676 'primary_key' => 'taxnum',
678 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
679 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
684 'taxnum', 'serial', '', '', '', '',
685 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
686 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
687 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
688 'taxclassnum', 'int', '', '', '', '',
689 'effective_date', @date_type, '', '',
690 'tax', 'real', '', '', '', '', # tax %
691 'excessrate', 'real', 'NULL','', '', '', # second tax %
692 'taxbase', @money_typen, '', '', # amount at first tax rate
693 'taxmax', @money_typen, '', '', # maximum about at both rates
694 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
695 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
696 'unittype', 'int', 'NULL', '', '', '', # for fee
697 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
698 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
699 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
700 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
701 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
702 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
703 'taxauth', 'int', 'NULL', '', '', '', # tax authority
704 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
705 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
706 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
707 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
708 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
709 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
711 'primary_key' => 'taxnum',
713 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
716 'cust_tax_location' => {
718 'custlocationnum', 'serial', '', '', '', '',
719 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
720 'zip', 'char', '', 5, '', '',
721 'state', 'char', '', 2, '', '',
722 'plus4hi', 'char', '', 4, '', '',
723 'plus4lo', 'char', '', 4, '', '',
724 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
725 'geocode', 'varchar', '', 20, '', '',
727 'primary_key' => 'custlocationnum',
729 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
734 'taxclassnum', 'serial', '', '', '', '',
735 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
736 'taxclass', 'varchar', '', $char_d, '', '',
737 'description', 'varchar', '', 2*$char_d, '', '',
739 'primary_key' => 'taxclassnum',
740 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
744 'cust_pay_pending' => {
746 'paypendingnum','serial', '', '', '', '',
747 'custnum', 'int', '', '', '', '',
748 'paid', @money_type, '', '',
749 '_date', @date_type, '', '',
750 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
751 # be index into payby
753 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
754 'paymask', 'varchar', 'NULL', $char_d, '', '',
755 'paydate', 'varchar', 'NULL', 10, '', '',
756 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
757 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
759 'status', 'varchar', '', $char_d, '', '',
760 'statustext', 'text', 'NULL', '', '', '',
761 'gatewaynum', 'int', 'NULL', '', '', '',
762 #'cust_balance', @money_type, '', '',
763 'paynum', 'int', 'NULL', '', '', '',
765 'primary_key' => 'paypendingnum',
766 'unique' => [ [ 'payunique' ] ],
767 'index' => [ [ 'custnum' ], [ 'status' ], ],
772 'paynum', 'serial', '', '', '', '',
773 'custnum', 'int', '', '', '', '',
774 '_date', @date_type, '', '',
775 'paid', @money_type, '', '',
776 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
777 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
778 # index into payby table
780 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
781 'paymask', 'varchar', 'NULL', $char_d, '', '',
782 'paydate', 'varchar', 'NULL', 10, '', '',
783 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
784 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
785 'closed', 'char', 'NULL', 1, '', '',
787 'primary_key' => 'paynum',
788 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
789 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
794 'paynum', 'int', '', '', '', '',
795 'custnum', 'int', '', '', '', '',
796 'paid', @money_type, '', '',
797 '_date', @date_type, '', '',
798 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
799 # index into payby table
801 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
802 'paymask', 'varchar', 'NULL', $char_d, '', '',
803 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
804 'closed', 'char', 'NULL', 1, '', '',
805 'void_date', @date_type, '', '',
806 'reason', 'varchar', 'NULL', $char_d, '', '',
807 'otaker', 'varchar', '', 32, '', '',
809 'primary_key' => 'paynum',
811 'index' => [ [ 'custnum' ] ],
816 'billpaynum', 'serial', '', '', '', '',
817 'invnum', 'int', '', '', '', '',
818 'paynum', 'int', '', '', '', '',
819 'amount', @money_type, '', '',
820 '_date', @date_type, '', '',
822 'primary_key' => 'billpaynum',
824 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
827 'cust_bill_pay_batch' => {
829 'billpaynum', 'serial', '', '', '', '',
830 'invnum', 'int', '', '', '', '',
831 'paybatchnum', 'int', '', '', '', '',
832 'amount', @money_type, '', '',
833 '_date', @date_type, '', '',
835 'primary_key' => 'billpaynum',
837 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
840 'cust_bill_pay_pkg' => {
842 'billpaypkgnum', 'serial', '', '', '', '',
843 'billpaynum', 'int', '', '', '', '',
844 'billpkgnum', 'int', '', '', '', '',
845 'amount', @money_type, '', '',
846 'setuprecur', 'varchar', '', $char_d, '', '',
847 'sdate', @date_type, '', '',
848 'edate', @date_type, '', '',
850 'primary_key' => 'billpaypkgnum',
852 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
855 'pay_batch' => { #batches of payments to an external processor
857 'batchnum', 'serial', '', '', '', '',
858 'payby', 'char', '', 4, '', '', # CARD/CHEK
859 'status', 'char', 'NULL', 1, '', '',
860 'download', @date_type, '', '',
861 'upload', @date_type, '', '',
863 'primary_key' => 'batchnum',
868 'cust_pay_batch' => { #what's this used for again? list of customers
869 #in current CARD batch? (necessarily CARD?)
871 'paybatchnum', 'serial', '', '', '', '',
872 'batchnum', 'int', '', '', '', '',
873 'invnum', 'int', '', '', '', '',
874 'custnum', 'int', '', '', '', '',
875 'last', 'varchar', '', $char_d, '', '',
876 'first', 'varchar', '', $char_d, '', '',
877 'address1', 'varchar', '', $char_d, '', '',
878 'address2', 'varchar', 'NULL', $char_d, '', '',
879 'city', 'varchar', '', $char_d, '', '',
880 'state', 'varchar', 'NULL', $char_d, '', '',
881 'zip', 'varchar', 'NULL', 10, '', '',
882 'country', 'char', '', 2, '', '',
883 # 'trancode', 'int', '', '', '', ''
884 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
885 'payinfo', 'varchar', '', 512, '', '',
886 #'exp', @date_type, '', ''
887 'exp', 'varchar', 'NULL', 11, '', '',
888 'payname', 'varchar', 'NULL', $char_d, '', '',
889 'amount', @money_type, '', '',
890 'status', 'varchar', 'NULL', $char_d, '', '',
892 'primary_key' => 'paybatchnum',
894 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
899 'pkgnum', 'serial', '', '', '', '',
900 'custnum', 'int', '', '', '', '',
901 'pkgpart', 'int', '', '', '', '',
902 'otaker', 'varchar', '', 32, '', '',
903 'setup', @date_type, '', '',
904 'bill', @date_type, '', '',
905 'last_bill', @date_type, '', '',
906 'susp', @date_type, '', '',
907 'adjourn', @date_type, '', '',
908 'cancel', @date_type, '', '',
909 'expire', @date_type, '', '',
910 'change_date', @date_type, '', '',
911 'change_pkgnum', 'int', 'NULL', '', '', '',
912 'change_pkgpart', 'int', 'NULL', '', '', '',
913 'manual_flag', 'char', 'NULL', 1, '', '',
914 'quantity', 'int', 'NULL', '', '', '',
916 'primary_key' => 'pkgnum',
918 'index' => [ ['custnum'], ['pkgpart'],
919 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
920 ['expire'], ['cancel'],
925 'cust_pkg_option' => {
927 'optionnum', 'serial', '', '', '', '',
928 'pkgnum', 'int', '', '', '', '',
929 'optionname', 'varchar', '', $char_d, '', '',
930 'optionvalue', 'text', 'NULL', '', '', '',
932 'primary_key' => 'optionnum',
934 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
937 'cust_pkg_reason' => {
939 'num', 'serial', '', '', '', '',
940 'pkgnum', 'int', '', '', '', '',
941 'reasonnum','int', '', '', '', '',
942 'action', 'char', 'NULL', 1, '', '', #should not be nullable
943 'otaker', 'varchar', '', 32, '', '',
944 'date', @date_type, '', '',
946 'primary_key' => 'num',
953 'refundnum', 'serial', '', '', '', '',
954 'custnum', 'int', '', '', '', '',
955 '_date', @date_type, '', '',
956 'refund', @money_type, '', '',
957 'otaker', 'varchar', '', 32, '', '',
958 'reason', 'varchar', '', $char_d, '', '',
959 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
960 # be index into payby
962 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
963 'paymask', 'varchar', 'NULL', $char_d, '', '',
964 'paybatch', 'varchar', 'NULL', $char_d, '', '',
965 'closed', 'char', 'NULL', 1, '', '',
967 'primary_key' => 'refundnum',
969 'index' => [ ['custnum'], ['_date'] ],
972 'cust_credit_refund' => {
974 'creditrefundnum', 'serial', '', '', '', '',
975 'crednum', 'int', '', '', '', '',
976 'refundnum', 'int', '', '', '', '',
977 'amount', @money_type, '', '',
978 '_date', @date_type, '', '',
980 'primary_key' => 'creditrefundnum',
982 'index' => [ ['crednum'], ['refundnum'] ],
988 'svcnum', 'serial', '', '', '', '',
989 'pkgnum', 'int', 'NULL', '', '', '',
990 'svcpart', 'int', '', '', '', '',
991 'overlimit', @date_type, '', '',
993 'primary_key' => 'svcnum',
995 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1000 'pkgpart', 'serial', '', '', '', '',
1001 'pkg', 'varchar', '', $char_d, '', '',
1002 'comment', 'varchar', '', $char_d, '', '',
1003 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1004 'setup', @perl_type, '', '',
1005 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1006 'recur', @perl_type, '', '',
1007 'setuptax', 'char', 'NULL', 1, '', '',
1008 'recurtax', 'char', 'NULL', 1, '', '',
1009 'plan', 'varchar', 'NULL', $char_d, '', '',
1010 'plandata', 'text', 'NULL', '', '', '',
1011 'disabled', 'char', 'NULL', 1, '', '',
1012 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1013 'classnum', 'int', 'NULL', '', '', '',
1014 'taxproductnum', 'int', 'NULL', '', '', '',
1015 'pay_weight', 'real', 'NULL', '', '', '',
1016 'credit_weight', 'real', 'NULL', '', '', '',
1017 'agentnum', 'int', 'NULL', '', '', '',
1020 'primary_key' => 'pkgpart',
1022 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1025 'part_pkg_link' => {
1027 'pkglinknum', 'serial', '', '', '', '',
1028 'src_pkgpart', 'int', '', '', '', '',
1029 'dst_pkgpart', 'int', '', '', '', '',
1030 'link_type', 'varchar', '', $char_d, '', '',
1032 'primary_key' => 'pkglinknum',
1033 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1034 'index' => [ [ 'src_pkgpart' ] ],
1037 'part_pkg_taxclass' => {
1039 'taxclassnum', 'serial', '', '', '', '',
1040 'taxclass', 'varchar', '', $char_d, '', '',
1042 'primary_key' => 'taxclassnum',
1043 'unique' => [ [ 'taxclass' ] ],
1047 'part_pkg_taxproduct' => {
1049 'taxproductnum', 'serial', '', '', '', '',
1050 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1051 'taxproduct', 'varchar', '', $char_d, '', '',
1052 'description', 'varchar', '', 2*$char_d, '', '',
1054 'primary_key' => 'taxproductnum',
1055 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1059 'part_pkg_taxrate' => {
1061 'pkgtaxratenum', 'serial', '', '', '', '',
1062 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1063 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1064 'taxproductnum', 'int', '', '', '', '',
1065 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1066 'county', 'varchar', 'NULL', $char_d, '', '',
1067 'state', 'varchar', 'NULL', $char_d, '', '',
1068 'local', 'varchar', 'NULL', $char_d, '', '',
1069 'country', 'char', 'NULL', 2, '', '',
1070 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1071 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1072 'taxclassnum', 'int', 'NULL', '', '', '',
1073 'effdate', @date_type, '', '',
1074 'taxable', 'char', 'NULL', 1, '', '',
1076 'primary_key' => 'pkgtaxratenum',
1078 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1081 'part_pkg_taxoverride' => {
1083 'taxoverridenum', 'serial', '', '', '', '',
1084 'pkgpart', 'serial', '', '', '', '',
1085 'taxclassnum', 'serial', '', '', '', '',
1087 'primary_key' => 'taxoverridenum',
1089 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1094 # 'titlenum', 'int', '', '',
1095 # 'title', 'varchar', '', $char_d,
1097 # 'primary_key' => 'titlenum',
1098 # 'unique' => [ [] ],
1099 # 'index' => [ [] ],
1104 'pkgsvcnum', 'serial', '', '', '', '',
1105 'pkgpart', 'int', '', '', '', '',
1106 'svcpart', 'int', '', '', '', '',
1107 'quantity', 'int', '', '', '', '',
1108 'primary_svc','char', 'NULL', 1, '', '',
1110 'primary_key' => 'pkgsvcnum',
1111 'unique' => [ ['pkgpart', 'svcpart'] ],
1112 'index' => [ ['pkgpart'] ],
1115 'part_referral' => {
1117 'refnum', 'serial', '', '', '', '',
1118 'referral', 'varchar', '', $char_d, '', '',
1119 'disabled', 'char', 'NULL', 1, '', '',
1120 'agentnum', 'int', 'NULL', '', '', '',
1122 'primary_key' => 'refnum',
1124 'index' => [ ['disabled'], ['agentnum'], ],
1129 'svcpart', 'serial', '', '', '', '',
1130 'svc', 'varchar', '', $char_d, '', '',
1131 'svcdb', 'varchar', '', $char_d, '', '',
1132 'disabled', 'char', 'NULL', 1, '', '',
1134 'primary_key' => 'svcpart',
1136 'index' => [ [ 'disabled' ] ],
1139 'part_svc_column' => {
1141 'columnnum', 'serial', '', '', '', '',
1142 'svcpart', 'int', '', '', '', '',
1143 'columnname', 'varchar', '', 64, '', '',
1144 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1145 'columnflag', 'char', 'NULL', 1, '', '',
1147 'primary_key' => 'columnnum',
1148 'unique' => [ [ 'svcpart', 'columnname' ] ],
1149 'index' => [ [ 'svcpart' ] ],
1152 #(this should be renamed to part_pop)
1155 'popnum', 'serial', '', '', '', '',
1156 'city', 'varchar', '', $char_d, '', '',
1157 'state', 'varchar', '', $char_d, '', '',
1158 'ac', 'char', '', 3, '', '',
1159 'exch', 'char', '', 3, '', '',
1160 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1162 'primary_key' => 'popnum',
1164 'index' => [ [ 'state' ] ],
1167 'part_pop_local' => {
1169 'localnum', 'serial', '', '', '', '',
1170 'popnum', 'int', '', '', '', '',
1171 'city', 'varchar', 'NULL', $char_d, '', '',
1172 'state', 'char', 'NULL', 2, '', '',
1173 'npa', 'char', '', 3, '', '',
1174 'nxx', 'char', '', 3, '', '',
1176 'primary_key' => 'localnum',
1178 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1183 'svcnum', 'int', '', '', '', '',
1184 'username', 'varchar', '', $username_len, '', '',
1185 '_password', 'varchar', '', 512, '', '',
1186 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1187 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1188 'popnum', 'int', 'NULL', '', '', '',
1189 'uid', 'int', 'NULL', '', '', '',
1190 'gid', 'int', 'NULL', '', '', '',
1191 'finger', 'varchar', 'NULL', $char_d, '', '',
1192 'dir', 'varchar', 'NULL', $char_d, '', '',
1193 'shell', 'varchar', 'NULL', $char_d, '', '',
1194 'quota', 'varchar', 'NULL', $char_d, '', '',
1195 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1196 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1197 'seconds_threshold', 'int', 'NULL', '', '', '',
1198 'upbytes', 'bigint', 'NULL', '', '', '',
1199 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1200 'downbytes', 'bigint', 'NULL', '', '', '',
1201 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1202 'totalbytes','bigint', 'NULL', '', '', '',
1203 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1204 'domsvc', 'int', '', '', '', '',
1205 'last_login', @date_type, '', '',
1206 'last_logout', @date_type, '', '',
1208 'primary_key' => 'svcnum',
1209 #'unique' => [ [ 'username', 'domsvc' ] ],
1211 'index' => [ ['username'], ['domsvc'] ],
1214 'acct_rt_transaction' => {
1216 'svcrtid', 'int', '', '', '', '',
1217 'svcnum', 'int', '', '', '', '',
1218 'transaction_id', 'int', '', '', '', '',
1219 '_date', @date_type, '', '',
1220 'seconds', 'int', '', '', '', '', #uhhhh
1221 'support', 'int', '', '', '', '',
1223 'primary_key' => 'svcrtid',
1225 'index' => [ ['svcnum', 'transaction_id'] ],
1230 # 'svcnum', 'int', '', '',
1231 # 'amount', @money_type,
1233 # 'primary_key' => 'svcnum',
1234 # 'unique' => [ [] ],
1235 # 'index' => [ [] ],
1240 'svcnum', 'int', '', '', '', '',
1241 'domain', 'varchar', '', $char_d, '', '',
1242 'suffix', 'varchar', 'NULL', $char_d, '', '',
1243 'catchall', 'int', 'NULL', '', '', '',
1244 'parent_svcnum', 'int', 'NULL', '', '', '',
1245 'registrarnum', 'int', 'NULL', '', '', '',
1246 'registrarkey', 'varchar', 'NULL', 512, '', '',
1247 'setup_date', @date_type, '', '',
1248 'renewal_interval', 'int', 'NULL', '', '', '',
1249 'expiration_date', @date_type, '', '',
1251 'primary_key' => 'svcnum',
1253 'index' => [ ['domain'] ],
1256 'domain_record' => {
1258 'recnum', 'serial', '', '', '', '',
1259 'svcnum', 'int', '', '', '', '',
1260 'reczone', 'varchar', '', 255, '', '',
1261 'recaf', 'char', '', 2, '', '',
1262 'rectype', 'varchar', '', 5, '', '',
1263 'recdata', 'varchar', '', 255, '', '',
1265 'primary_key' => 'recnum',
1267 'index' => [ ['svcnum'] ],
1272 'registrarnum', 'serial', '', '', '', '',
1273 'registrarname', 'varchar', '', $char_d, '', '',
1275 'primary_key' => 'registrarnum',
1282 'svcnum', 'int', '', '', '', '',
1283 'srcsvc', 'int', 'NULL', '', '', '',
1284 'src', 'varchar', 'NULL', 255, '', '',
1285 'dstsvc', 'int', 'NULL', '', '', '',
1286 'dst', 'varchar', 'NULL', 255, '', '',
1288 'primary_key' => 'svcnum',
1290 'index' => [ ['srcsvc'], ['dstsvc'] ],
1295 'svcnum', 'int', '', '', '', '',
1296 'recnum', 'int', '', '', '', '',
1297 'usersvc', 'int', 'NULL', '', '', '',
1298 'config', 'text', 'NULL', '', '', '',
1300 'primary_key' => 'svcnum',
1307 # 'svcnum', 'int', '', '',
1308 # 'svcnum', 'int', '', '',
1309 # 'svcnum', 'int', '', '',
1310 # 'worker', 'varchar', '', $char_d,
1311 # '_date', @date_type,
1313 # 'primary_key' => 'svcnum',
1314 # 'unique' => [ [] ],
1315 # 'index' => [ [] ],
1318 'prepay_credit' => {
1320 'prepaynum', 'serial', '', '', '', '',
1321 'identifier', 'varchar', '', $char_d, '', '',
1322 'amount', @money_type, '', '',
1323 'seconds', 'int', 'NULL', '', '', '',
1324 'upbytes', 'bigint', 'NULL', '', '', '',
1325 'downbytes', 'bigint', 'NULL', '', '', '',
1326 'totalbytes', 'bigint', 'NULL', '', '', '',
1327 'agentnum', 'int', 'NULL', '', '', '',
1329 'primary_key' => 'prepaynum',
1330 'unique' => [ ['identifier'] ],
1336 'portnum', 'serial', '', '', '', '',
1337 'ip', 'varchar', 'NULL', 15, '', '',
1338 'nasport', 'int', 'NULL', '', '', '',
1339 'nasnum', 'int', '', '', '', '',
1341 'primary_key' => 'portnum',
1348 'nasnum', 'serial', '', '', '', '',
1349 'nas', 'varchar', '', $char_d, '', '',
1350 'nasip', 'varchar', '', 15, '', '',
1351 'nasfqdn', 'varchar', '', $char_d, '', '',
1352 'last', 'int', '', '', '', '',
1354 'primary_key' => 'nasnum',
1355 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1356 'index' => [ [ 'last' ] ],
1361 # 'sessionnum', 'serial', '', '', '', '',
1362 # 'portnum', 'int', '', '', '', '',
1363 # 'svcnum', 'int', '', '', '', '',
1364 # 'login', @date_type, '', '',
1365 # 'logout', @date_type, '', '',
1367 # 'primary_key' => 'sessionnum',
1369 # 'index' => [ [ 'portnum' ] ],
1374 'jobnum', 'serial', '', '', '', '',
1375 'job', 'text', '', '', '', '',
1376 '_date', 'int', '', '', '', '',
1377 'status', 'varchar', '', $char_d, '', '',
1378 'statustext', 'text', 'NULL', '', '', '',
1379 'svcnum', 'int', 'NULL', '', '', '',
1380 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1383 'primary_key' => 'jobnum',
1385 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1390 'argnum', 'serial', '', '', '', '',
1391 'jobnum', 'int', '', '', '', '',
1392 'arg', 'text', 'NULL', '', '', '',
1394 'primary_key' => 'argnum',
1396 'index' => [ [ 'jobnum' ] ],
1401 'dependnum', 'serial', '', '', '', '',
1402 'jobnum', 'int', '', '', '', '',
1403 'depend_jobnum', 'int', '', '', '', '',
1405 'primary_key' => 'dependnum',
1407 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1412 'exportsvcnum' => 'serial', '', '', '', '',
1413 'exportnum' => 'int', '', '', '', '',
1414 'svcpart' => 'int', '', '', '', '',
1416 'primary_key' => 'exportsvcnum',
1417 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1418 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1423 'exportnum', 'serial', '', '', '', '',
1424 'machine', 'varchar', '', $char_d, '', '',
1425 'exporttype', 'varchar', '', $char_d, '', '',
1426 'nodomain', 'char', 'NULL', 1, '', '',
1428 'primary_key' => 'exportnum',
1430 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1433 'part_export_option' => {
1435 'optionnum', 'serial', '', '', '', '',
1436 'exportnum', 'int', '', '', '', '',
1437 'optionname', 'varchar', '', $char_d, '', '',
1438 'optionvalue', 'text', 'NULL', '', '', '',
1440 'primary_key' => 'optionnum',
1442 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1445 'radius_usergroup' => {
1447 'usergroupnum', 'serial', '', '', '', '',
1448 'svcnum', 'int', '', '', '', '',
1449 'groupname', 'varchar', '', $char_d, '', '',
1451 'primary_key' => 'usergroupnum',
1453 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1458 'msgnum', 'serial', '', '', '', '',
1459 'msgcode', 'varchar', '', $char_d, '', '',
1460 'locale', 'varchar', '', 16, '', '',
1461 'msg', 'text', '', '', '', '',
1463 'primary_key' => 'msgnum',
1464 'unique' => [ [ 'msgcode', 'locale' ] ],
1468 'cust_tax_exempt' => {
1470 'exemptnum', 'serial', '', '', '', '',
1471 'custnum', 'int', '', '', '', '',
1472 'taxnum', 'int', '', '', '', '',
1473 'year', 'int', '', '', '', '',
1474 'month', 'int', '', '', '', '',
1475 'amount', @money_type, '', '',
1477 'primary_key' => 'exemptnum',
1478 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1482 'cust_tax_exempt_pkg' => {
1484 'exemptpkgnum', 'serial', '', '', '', '',
1485 #'custnum', 'int', '', '', '', ''
1486 'billpkgnum', 'int', '', '', '', '',
1487 'taxnum', 'int', '', '', '', '',
1488 'year', 'int', '', '', '', '',
1489 'month', 'int', '', '', '', '',
1490 'amount', @money_type, '', '',
1492 'primary_key' => 'exemptpkgnum',
1494 'index' => [ [ 'taxnum', 'year', 'month' ],
1502 'routernum', 'serial', '', '', '', '',
1503 'routername', 'varchar', '', $char_d, '', '',
1504 'svcnum', 'int', 'NULL', '', '', '',
1505 'agentnum', 'int', 'NULL', '', '', '',
1507 'primary_key' => 'routernum',
1512 'part_svc_router' => {
1514 'svcrouternum', 'serial', '', '', '', '',
1515 'svcpart', 'int', '', '', '', '',
1516 'routernum', 'int', '', '', '', '',
1518 'primary_key' => 'svcrouternum',
1525 'blocknum', 'serial', '', '', '', '',
1526 'routernum', 'int', '', '', '', '',
1527 'ip_gateway', 'varchar', '', 15, '', '',
1528 'ip_netmask', 'int', '', '', '', '',
1529 'agentnum', 'int', 'NULL', '', '', '',
1531 'primary_key' => 'blocknum',
1532 'unique' => [ [ 'blocknum', 'routernum' ] ],
1536 'svc_broadband' => {
1538 'svcnum', 'int', '', '', '', '',
1539 'description', 'varchar', 'NULL', $char_d, '', '',
1540 'blocknum', 'int', '', '', '', '',
1541 'speed_up', 'int', '', '', '', '',
1542 'speed_down', 'int', '', '', '', '',
1543 'ip_addr', 'varchar', '', 15, '', '',
1544 'mac_addr', 'varchar', 'NULL', 12, '', '',
1545 'authkey', 'varchar', 'NULL', 32, '', '',
1546 'latitude', 'decimal', 'NULL', '', '', '',
1547 'longitude', 'decimal', 'NULL', '', '', '',
1548 'altitude', 'decimal', 'NULL', '', '', '',
1549 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1551 'primary_key' => 'svcnum',
1556 'part_virtual_field' => {
1558 'vfieldpart', 'serial', '', '', '', '',
1559 'dbtable', 'varchar', '', 32, '', '',
1560 'name', 'varchar', '', 32, '', '',
1561 'check_block', 'text', 'NULL', '', '', '',
1562 'length', 'int', 'NULL', '', '', '',
1563 'list_source', 'text', 'NULL', '', '', '',
1564 'label', 'varchar', 'NULL', 80, '', '',
1566 'primary_key' => 'vfieldpart',
1571 'virtual_field' => {
1573 'vfieldnum', 'serial', '', '', '', '',
1574 'recnum', 'int', '', '', '', '',
1575 'vfieldpart', 'int', '', '', '', '',
1576 'value', 'varchar', '', 128, '', '',
1578 'primary_key' => 'vfieldnum',
1579 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1585 'snarfnum', 'int', '', '', '', '',
1586 'svcnum', 'int', '', '', '', '',
1587 'machine', 'varchar', '', 255, '', '',
1588 'protocol', 'varchar', '', $char_d, '', '',
1589 'username', 'varchar', '', $char_d, '', '',
1590 '_password', 'varchar', '', $char_d, '', '',
1592 'primary_key' => 'snarfnum',
1594 'index' => [ [ 'svcnum' ] ],
1599 'svcnum', 'int', '', '', '', '',
1600 'id', 'int', 'NULL', '', '', '',
1601 'title', 'varchar', 'NULL', $char_d, '', '',
1603 'primary_key' => 'svcnum',
1608 'cust_pay_refund' => {
1610 'payrefundnum', 'serial', '', '', '', '',
1611 'paynum', 'int', '', '', '', '',
1612 'refundnum', 'int', '', '', '', '',
1613 '_date', @date_type, '', '',
1614 'amount', @money_type, '', '',
1616 'primary_key' => 'payrefundnum',
1618 'index' => [ ['paynum'], ['refundnum'] ],
1621 'part_pkg_option' => {
1623 'optionnum', 'serial', '', '', '', '',
1624 'pkgpart', 'int', '', '', '', '',
1625 'optionname', 'varchar', '', $char_d, '', '',
1626 'optionvalue', 'text', 'NULL', '', '', '',
1628 'primary_key' => 'optionnum',
1630 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1635 'ratenum', 'serial', '', '', '', '',
1636 'ratename', 'varchar', '', $char_d, '', '',
1638 'primary_key' => 'ratenum',
1645 'ratedetailnum', 'serial', '', '', '', '',
1646 'ratenum', 'int', '', '', '', '',
1647 'orig_regionnum', 'int', 'NULL', '', '', '',
1648 'dest_regionnum', 'int', '', '', '', '',
1649 'min_included', 'int', '', '', '', '',
1650 #'min_charge', @money_type, '', '',
1651 'min_charge', 'decimal', '', '10,5', '', '',
1652 'sec_granularity', 'int', '', '', '', '',
1653 #time period (link to table of periods)?
1655 'primary_key' => 'ratedetailnum',
1656 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1657 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1662 'regionnum', 'serial', '', '', '', '',
1663 'regionname', 'varchar', '', $char_d, '', '',
1665 'primary_key' => 'regionnum',
1672 'prefixnum', 'serial', '', '', '', '',
1673 'regionnum', 'int', '', '',, '', '',
1674 'countrycode', 'varchar', '', 3, '', '',
1675 'npa', 'varchar', 'NULL', 6, '', '',
1676 'nxx', 'varchar', 'NULL', 3, '', '',
1678 'primary_key' => 'prefixnum',
1680 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1685 'codenum', 'serial', '', '', '', '',
1686 'code', 'varchar', '', $char_d, '', '',
1687 'agentnum', 'int', '', '', '', '',
1689 'primary_key' => 'codenum',
1690 'unique' => [ [ 'agentnum', 'code' ] ],
1691 'index' => [ [ 'agentnum' ] ],
1696 'codepkgnum', 'serial', '', '', '', '',
1697 'codenum', 'int', '', '', '', '',
1698 'pkgpart', 'int', '', '', '', '',
1700 'primary_key' => 'codepkgnum',
1701 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1702 'index' => [ [ 'codenum' ] ],
1705 'clientapi_session' => {
1707 'sessionnum', 'serial', '', '', '', '',
1708 'sessionid', 'varchar', '', $char_d, '', '',
1709 'namespace', 'varchar', '', $char_d, '', '',
1711 'primary_key' => 'sessionnum',
1712 'unique' => [ [ 'sessionid', 'namespace' ] ],
1716 'clientapi_session_field' => {
1718 'fieldnum', 'serial', '', '', '', '',
1719 'sessionnum', 'int', '', '', '', '',
1720 'fieldname', 'varchar', '', $char_d, '', '',
1721 'fieldvalue', 'text', 'NULL', '', '', '',
1723 'primary_key' => 'fieldnum',
1724 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1728 'payment_gateway' => {
1730 'gatewaynum', 'serial', '', '', '', '',
1731 'gateway_module', 'varchar', '', $char_d, '', '',
1732 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1733 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1734 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1735 'disabled', 'char', 'NULL', 1, '', '',
1737 'primary_key' => 'gatewaynum',
1739 'index' => [ [ 'disabled' ] ],
1742 'payment_gateway_option' => {
1744 'optionnum', 'serial', '', '', '', '',
1745 'gatewaynum', 'int', '', '', '', '',
1746 'optionname', 'varchar', '', $char_d, '', '',
1747 'optionvalue', 'text', 'NULL', '', '', '',
1749 'primary_key' => 'optionnum',
1751 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1754 'agent_payment_gateway' => {
1756 'agentgatewaynum', 'serial', '', '', '', '',
1757 'agentnum', 'int', '', '', '', '',
1758 'gatewaynum', 'int', '', '', '', '',
1759 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1760 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1762 'primary_key' => 'agentgatewaynum',
1764 'index' => [ [ 'agentnum', 'cardtype' ], ],
1769 'bannum', 'serial', '', '', '', '',
1770 'payby', 'char', '', 4, '', '',
1771 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1772 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1773 '_date', @date_type, '', '',
1774 'otaker', 'varchar', '', 32, '', '',
1775 'reason', 'varchar', 'NULL', $char_d, '', '',
1777 'primary_key' => 'bannum',
1778 'unique' => [ [ 'payby', 'payinfo' ] ],
1784 'categorynum', 'serial', '', '', '', '',
1785 'categoryname', 'varchar', '', $char_d, '', '',
1786 'disabled', 'char', 'NULL', 1, '', '',
1788 'primary_key' => 'categorynum',
1790 'index' => [ ['disabled'] ],
1795 'classnum', 'serial', '', '', '', '',
1796 'classname', 'varchar', '', $char_d, '', '',
1797 'categorynum', 'int', 'NULL', '', '', '',
1798 'disabled', 'char', 'NULL', 1, '', '',
1800 'primary_key' => 'classnum',
1802 'index' => [ ['disabled'] ],
1807 # qw( name type null length default local );
1813 'acctid', 'bigserial', '', '', '', '',
1814 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1815 'calldate', 'timestamp', '', '', \'now()', '',
1816 'clid', 'varchar', '', $char_d, \"''", '',
1817 'src', 'varchar', '', $char_d, \"''", '',
1818 'dst', 'varchar', '', $char_d, \"''", '',
1819 'dcontext', 'varchar', '', $char_d, \"''", '',
1820 'channel', 'varchar', '', $char_d, \"''", '',
1821 'dstchannel', 'varchar', '', $char_d, \"''", '',
1822 'lastapp', 'varchar', '', $char_d, \"''", '',
1823 'lastdata', 'varchar', '', $char_d, \"''", '',
1825 #these don't seem to be logged by most of the SQL cdr_* modules
1826 #except tds under sql-illegal names, so;
1827 # ... don't rely on them for rating?
1828 # and, what they hey, i went ahead and changed the names and data types
1829 # to freeside-style dates...
1830 #'start', 'timestamp', 'NULL', '', '', '',
1831 #'answer', 'timestamp', 'NULL', '', '', '',
1832 #'end', 'timestamp', 'NULL', '', '', '',
1833 'startdate', @date_type, '', '',
1834 'answerdate', @date_type, '', '',
1835 'enddate', @date_type, '', '',
1838 'duration', 'int', '', '', 0, '',
1839 'billsec', 'int', '', '', 0, '',
1840 'disposition', 'varchar', '', 45, \"''", '',
1841 'amaflags', 'int', '', '', 0, '',
1842 'accountcode', 'varchar', '', 20, \"''", '',
1843 'uniqueid', 'varchar', '', 32, \"''", '',
1844 'userfield', 'varchar', '', 255, \"''", '',
1847 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1851 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1852 'cdrtypenum', 'int', 'NULL', '', '', '',
1854 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1856 'upstream_currency', 'char', 'NULL', 3, '', '',
1857 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1858 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1860 # how it was rated internally...
1861 'ratedetailnum', 'int', 'NULL', '', '', '',
1862 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1864 'distance', 'decimal', 'NULL', '', '', '',
1865 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1867 #cdr_calltype: the big list in appendix 2
1868 'calltypenum', 'int', 'NULL', '', '', '',
1870 'description', 'varchar', 'NULL', $char_d, '', '',
1871 'quantity', 'int', 'NULL', '', '', '',
1873 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1874 'carrierid', 'int', 'NULL', '', '', '',
1876 'upstream_rateid', 'int', 'NULL', '', '', '',
1879 #and now for our own fields
1882 # a svcnum... right..?
1883 'svcnum', 'int', 'NULL', '', '', '',
1885 #NULL, done (or something)
1886 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1889 'primary_key' => 'acctid',
1891 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1896 'calltypenum', 'serial', '', '', '', '',
1897 'calltypename', 'varchar', '', $char_d, '', '',
1899 'primary_key' => 'calltypenum',
1906 'cdrtypenum' => 'serial', '', '', '', '',
1907 'cdrtypename' => 'varchar', '', $char_d, '', '',
1909 'primary_key' => 'cdrtypenum',
1916 'carrierid' => 'serial', '', '', '', '',
1917 'carriername' => 'varchar', '', $char_d, '', '',
1919 'primary_key' => 'carrierid',
1924 #map upstream rateid to ours...
1925 'cdr_upstream_rate' => {
1927 'upstreamratenum', 'serial', '', '', '', '',
1928 'upstream_rateid', 'varchar', '', $char_d, '', '',
1929 'ratedetailnum', 'int', 'NULL', '', '', '',
1931 'primary_key' => 'upstreamratenum', #XXX need a primary key
1932 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1936 'inventory_item' => {
1938 'itemnum', 'serial', '', '', '', '',
1939 'classnum', 'int', '', '', '', '',
1940 'item', 'varchar', '', $char_d, '', '',
1941 'svcnum', 'int', 'NULL', '', '', '',
1943 'primary_key' => 'itemnum',
1944 'unique' => [ [ 'classnum', 'item' ] ],
1945 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1948 'inventory_class' => {
1950 'classnum', 'serial', '', '', '', '',
1951 'classname', 'varchar', '', $char_d, '', '',
1953 'primary_key' => 'classnum',
1960 'usernum', 'serial', '', '', '', '',
1961 'username', 'varchar', '', $char_d, '', '',
1962 '_password', 'varchar', '', $char_d, '', '',
1963 'last', 'varchar', '', $char_d, '', '',
1964 'first', 'varchar', '', $char_d, '', '',
1965 'disabled', 'char', 'NULL', 1, '', '',
1967 'primary_key' => 'usernum',
1968 'unique' => [ [ 'username' ] ],
1972 'access_user_pref' => {
1974 'prefnum', 'serial', '', '', '', '',
1975 'usernum', 'int', '', '', '', '',
1976 'prefname', 'varchar', '', $char_d, '', '',
1977 'prefvalue', 'text', 'NULL', '', '', '',
1978 'expiration', @date_type, '', '',
1980 'primary_key' => 'prefnum',
1982 'index' => [ [ 'usernum' ] ],
1987 'groupnum', 'serial', '', '', '', '',
1988 'groupname', 'varchar', '', $char_d, '', '',
1990 'primary_key' => 'groupnum',
1991 'unique' => [ [ 'groupname' ] ],
1995 'access_usergroup' => {
1997 'usergroupnum', 'serial', '', '', '', '',
1998 'usernum', 'int', '', '', '', '',
1999 'groupnum', 'int', '', '', '', '',
2001 'primary_key' => 'usergroupnum',
2002 'unique' => [ [ 'usernum', 'groupnum' ] ],
2003 'index' => [ [ 'usernum' ] ],
2006 'access_groupagent' => {
2008 'groupagentnum', 'serial', '', '', '', '',
2009 'groupnum', 'int', '', '', '', '',
2010 'agentnum', 'int', '', '', '', '',
2012 'primary_key' => 'groupagentnum',
2013 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2014 'index' => [ [ 'groupnum' ] ],
2019 'rightnum', 'serial', '', '', '', '',
2020 'righttype', 'varchar', '', $char_d, '', '',
2021 'rightobjnum', 'int', '', '', '', '',
2022 'rightname', 'varchar', '', $char_d, '', '',
2024 'primary_key' => 'rightnum',
2025 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2031 'svcnum', 'int', '', '', '', '',
2032 'countrycode', 'varchar', '', 3, '', '',
2033 'phonenum', 'varchar', '', 15, '', '', #12 ?
2034 'pin', 'varchar', 'NULL', $char_d, '', '',
2035 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2037 'primary_key' => 'svcnum',
2039 'index' => [ [ 'countrycode', 'phonenum' ] ],
2044 'availnum', 'int', '', '', '', '',
2045 'exportnum', 'int', '', '', '', '',
2046 'countrycode', 'varchar', '', 3, '', '',
2047 'state', 'char', 'NULL', 2, '', '',
2048 'npa', 'char', '', 3, '', '',
2049 'nxx', 'char', 'NULL', 3, '', '',
2051 'primary_key' => 'availnum',
2053 'index' => [ [ 'exportnum', 'countrycode', 'state' ] ],
2058 'typenum', 'serial', '', '', '', '',
2059 'class', 'char', '', 1, '', '',
2060 'type', 'varchar', '', $char_d, '', '',
2062 'primary_key' => 'typenum',
2069 'reasonnum', 'serial', '', '', '', '',
2070 'reason_type', 'int', '', '', '', '',
2071 'reason', 'text', '', '', '', '',
2072 'disabled', 'char', 'NULL', 1, '', '',
2074 'primary_key' => 'reasonnum',
2081 'confnum', 'serial', '', '', '', '',
2082 'agentnum', 'int', 'NULL', '', '', '',
2083 'name', 'varchar', '', $char_d, '', '',
2084 'value', 'text', 'NULL', '', '', '',
2086 'primary_key' => 'confnum',
2087 'unique' => [ [ 'agentnum', 'name' ]],
2093 'pkgrefnum', 'serial', '', '', '', '',
2094 'pkgnum', 'int', '', '', '', '',
2095 'refnum', 'int', '', '', '', '',
2097 'primary_key' => 'pkgrefnum',
2098 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2099 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2101 # name type nullability length default local
2105 # 'num', 'serial', '', '', '', '',
2107 # 'primary_key' => 'num',