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 'otaker', 'varchar', '', 32, '', '',
943 'date', @date_type, '', '',
945 'primary_key' => 'num',
952 'refundnum', 'serial', '', '', '', '',
953 'custnum', 'int', '', '', '', '',
954 '_date', @date_type, '', '',
955 'refund', @money_type, '', '',
956 'otaker', 'varchar', '', 32, '', '',
957 'reason', 'varchar', '', $char_d, '', '',
958 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
959 # be index into payby
961 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
962 'paymask', 'varchar', 'NULL', $char_d, '', '',
963 'paybatch', 'varchar', 'NULL', $char_d, '', '',
964 'closed', 'char', 'NULL', 1, '', '',
966 'primary_key' => 'refundnum',
968 'index' => [ ['custnum'], ['_date'] ],
971 'cust_credit_refund' => {
973 'creditrefundnum', 'serial', '', '', '', '',
974 'crednum', 'int', '', '', '', '',
975 'refundnum', 'int', '', '', '', '',
976 'amount', @money_type, '', '',
977 '_date', @date_type, '', '',
979 'primary_key' => 'creditrefundnum',
981 'index' => [ ['crednum'], ['refundnum'] ],
987 'svcnum', 'serial', '', '', '', '',
988 'pkgnum', 'int', 'NULL', '', '', '',
989 'svcpart', 'int', '', '', '', '',
990 'overlimit', @date_type, '', '',
992 'primary_key' => 'svcnum',
994 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
999 'pkgpart', 'serial', '', '', '', '',
1000 'pkg', 'varchar', '', $char_d, '', '',
1001 'comment', 'varchar', '', $char_d, '', '',
1002 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1003 'setup', @perl_type, '', '',
1004 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1005 'recur', @perl_type, '', '',
1006 'setuptax', 'char', 'NULL', 1, '', '',
1007 'recurtax', 'char', 'NULL', 1, '', '',
1008 'plan', 'varchar', 'NULL', $char_d, '', '',
1009 'plandata', 'text', 'NULL', '', '', '',
1010 'disabled', 'char', 'NULL', 1, '', '',
1011 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1012 'classnum', 'int', 'NULL', '', '', '',
1013 'taxproductnum', 'int', 'NULL', '', '', '',
1014 'pay_weight', 'real', 'NULL', '', '', '',
1015 'credit_weight', 'real', 'NULL', '', '', '',
1016 'agentnum', 'int', 'NULL', '', '', '',
1019 'primary_key' => 'pkgpart',
1021 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1024 'part_pkg_link' => {
1026 'pkglinknum', 'serial', '', '', '', '',
1027 'src_pkgpart', 'int', '', '', '', '',
1028 'dst_pkgpart', 'int', '', '', '', '',
1029 'link_type', 'varchar', '', $char_d, '', '',
1031 'primary_key' => 'pkglinknum',
1032 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1033 'index' => [ [ 'src_pkgpart' ] ],
1036 'part_pkg_taxclass' => {
1038 'taxclassnum', 'serial', '', '', '', '',
1039 'taxclass', 'varchar', '', $char_d, '', '',
1041 'primary_key' => 'taxclassnum',
1042 'unique' => [ [ 'taxclass' ] ],
1046 'part_pkg_taxproduct' => {
1048 'taxproductnum', 'serial', '', '', '', '',
1049 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1050 'taxproduct', 'varchar', '', $char_d, '', '',
1051 'description', 'varchar', '', 2*$char_d, '', '',
1053 'primary_key' => 'taxproductnum',
1054 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1058 'part_pkg_taxrate' => {
1060 'pkgtaxratenum', 'serial', '', '', '', '',
1061 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1062 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1063 'taxproductnum', 'int', '', '', '', '',
1064 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1065 'county', 'varchar', 'NULL', $char_d, '', '',
1066 'state', 'varchar', 'NULL', $char_d, '', '',
1067 'local', 'varchar', 'NULL', $char_d, '', '',
1068 'country', 'char', 'NULL', 2, '', '',
1069 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1070 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1071 'taxclassnum', 'int', 'NULL', '', '', '',
1072 'effdate', @date_type, '', '',
1073 'taxable', 'char', 'NULL', 1, '', '',
1075 'primary_key' => 'pkgtaxratenum',
1077 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1080 'part_pkg_taxoverride' => {
1082 'taxoverridenum', 'serial', '', '', '', '',
1083 'pkgpart', 'serial', '', '', '', '',
1084 'taxclassnum', 'serial', '', '', '', '',
1086 'primary_key' => 'taxoverridenum',
1088 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1093 # 'titlenum', 'int', '', '',
1094 # 'title', 'varchar', '', $char_d,
1096 # 'primary_key' => 'titlenum',
1097 # 'unique' => [ [] ],
1098 # 'index' => [ [] ],
1103 'pkgsvcnum', 'serial', '', '', '', '',
1104 'pkgpart', 'int', '', '', '', '',
1105 'svcpart', 'int', '', '', '', '',
1106 'quantity', 'int', '', '', '', '',
1107 'primary_svc','char', 'NULL', 1, '', '',
1109 'primary_key' => 'pkgsvcnum',
1110 'unique' => [ ['pkgpart', 'svcpart'] ],
1111 'index' => [ ['pkgpart'] ],
1114 'part_referral' => {
1116 'refnum', 'serial', '', '', '', '',
1117 'referral', 'varchar', '', $char_d, '', '',
1118 'disabled', 'char', 'NULL', 1, '', '',
1119 'agentnum', 'int', 'NULL', '', '', '',
1121 'primary_key' => 'refnum',
1123 'index' => [ ['disabled'], ['agentnum'], ],
1128 'svcpart', 'serial', '', '', '', '',
1129 'svc', 'varchar', '', $char_d, '', '',
1130 'svcdb', 'varchar', '', $char_d, '', '',
1131 'disabled', 'char', 'NULL', 1, '', '',
1133 'primary_key' => 'svcpart',
1135 'index' => [ [ 'disabled' ] ],
1138 'part_svc_column' => {
1140 'columnnum', 'serial', '', '', '', '',
1141 'svcpart', 'int', '', '', '', '',
1142 'columnname', 'varchar', '', 64, '', '',
1143 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1144 'columnflag', 'char', 'NULL', 1, '', '',
1146 'primary_key' => 'columnnum',
1147 'unique' => [ [ 'svcpart', 'columnname' ] ],
1148 'index' => [ [ 'svcpart' ] ],
1151 #(this should be renamed to part_pop)
1154 'popnum', 'serial', '', '', '', '',
1155 'city', 'varchar', '', $char_d, '', '',
1156 'state', 'varchar', '', $char_d, '', '',
1157 'ac', 'char', '', 3, '', '',
1158 'exch', 'char', '', 3, '', '',
1159 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1161 'primary_key' => 'popnum',
1163 'index' => [ [ 'state' ] ],
1166 'part_pop_local' => {
1168 'localnum', 'serial', '', '', '', '',
1169 'popnum', 'int', '', '', '', '',
1170 'city', 'varchar', 'NULL', $char_d, '', '',
1171 'state', 'char', 'NULL', 2, '', '',
1172 'npa', 'char', '', 3, '', '',
1173 'nxx', 'char', '', 3, '', '',
1175 'primary_key' => 'localnum',
1177 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1182 'svcnum', 'int', '', '', '', '',
1183 'username', 'varchar', '', $username_len, '', '',
1184 '_password', 'varchar', '', 512, '', '',
1185 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1186 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1187 'popnum', 'int', 'NULL', '', '', '',
1188 'uid', 'int', 'NULL', '', '', '',
1189 'gid', 'int', 'NULL', '', '', '',
1190 'finger', 'varchar', 'NULL', $char_d, '', '',
1191 'dir', 'varchar', 'NULL', $char_d, '', '',
1192 'shell', 'varchar', 'NULL', $char_d, '', '',
1193 'quota', 'varchar', 'NULL', $char_d, '', '',
1194 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1195 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1196 'seconds_threshold', 'int', 'NULL', '', '', '',
1197 'upbytes', 'bigint', 'NULL', '', '', '',
1198 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1199 'downbytes', 'bigint', 'NULL', '', '', '',
1200 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1201 'totalbytes','bigint', 'NULL', '', '', '',
1202 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1203 'domsvc', 'int', '', '', '', '',
1204 'last_login', @date_type, '', '',
1205 'last_logout', @date_type, '', '',
1207 'primary_key' => 'svcnum',
1208 #'unique' => [ [ 'username', 'domsvc' ] ],
1210 'index' => [ ['username'], ['domsvc'] ],
1213 'acct_rt_transaction' => {
1215 'svcrtid', 'int', '', '', '', '',
1216 'svcnum', 'int', '', '', '', '',
1217 'transaction_id', 'int', '', '', '', '',
1218 '_date', @date_type, '', '',
1219 'seconds', 'int', '', '', '', '', #uhhhh
1220 'support', 'int', '', '', '', '',
1222 'primary_key' => 'svcrtid',
1224 'index' => [ ['svcnum', 'transaction_id'] ],
1229 # 'svcnum', 'int', '', '',
1230 # 'amount', @money_type,
1232 # 'primary_key' => 'svcnum',
1233 # 'unique' => [ [] ],
1234 # 'index' => [ [] ],
1239 'svcnum', 'int', '', '', '', '',
1240 'domain', 'varchar', '', $char_d, '', '',
1241 'suffix', 'varchar', 'NULL', $char_d, '', '',
1242 'catchall', 'int', 'NULL', '', '', '',
1243 'parent_svcnum', 'int', 'NULL', '', '', '',
1244 'registrarnum', 'int', 'NULL', '', '', '',
1245 'registrarkey', 'varchar', 'NULL', 512, '', '',
1246 'setup_date', @date_type, '', '',
1247 'renewal_interval', 'int', 'NULL', '', '', '',
1248 'expiration_date', @date_type, '', '',
1250 'primary_key' => 'svcnum',
1252 'index' => [ ['domain'] ],
1255 'domain_record' => {
1257 'recnum', 'serial', '', '', '', '',
1258 'svcnum', 'int', '', '', '', '',
1259 'reczone', 'varchar', '', 255, '', '',
1260 'recaf', 'char', '', 2, '', '',
1261 'rectype', 'varchar', '', 5, '', '',
1262 'recdata', 'varchar', '', 255, '', '',
1264 'primary_key' => 'recnum',
1266 'index' => [ ['svcnum'] ],
1271 'registrarnum', 'serial', '', '', '', '',
1272 'registrarname', 'varchar', '', $char_d, '', '',
1274 'primary_key' => 'registrarnum',
1281 'svcnum', 'int', '', '', '', '',
1282 'srcsvc', 'int', 'NULL', '', '', '',
1283 'src', 'varchar', 'NULL', 255, '', '',
1284 'dstsvc', 'int', 'NULL', '', '', '',
1285 'dst', 'varchar', 'NULL', 255, '', '',
1287 'primary_key' => 'svcnum',
1289 'index' => [ ['srcsvc'], ['dstsvc'] ],
1294 'svcnum', 'int', '', '', '', '',
1295 'recnum', 'int', '', '', '', '',
1296 'usersvc', 'int', 'NULL', '', '', '',
1297 'config', 'text', 'NULL', '', '', '',
1299 'primary_key' => 'svcnum',
1306 # 'svcnum', 'int', '', '',
1307 # 'svcnum', 'int', '', '',
1308 # 'svcnum', 'int', '', '',
1309 # 'worker', 'varchar', '', $char_d,
1310 # '_date', @date_type,
1312 # 'primary_key' => 'svcnum',
1313 # 'unique' => [ [] ],
1314 # 'index' => [ [] ],
1317 'prepay_credit' => {
1319 'prepaynum', 'serial', '', '', '', '',
1320 'identifier', 'varchar', '', $char_d, '', '',
1321 'amount', @money_type, '', '',
1322 'seconds', 'int', 'NULL', '', '', '',
1323 'upbytes', 'bigint', 'NULL', '', '', '',
1324 'downbytes', 'bigint', 'NULL', '', '', '',
1325 'totalbytes', 'bigint', 'NULL', '', '', '',
1326 'agentnum', 'int', 'NULL', '', '', '',
1328 'primary_key' => 'prepaynum',
1329 'unique' => [ ['identifier'] ],
1335 'portnum', 'serial', '', '', '', '',
1336 'ip', 'varchar', 'NULL', 15, '', '',
1337 'nasport', 'int', 'NULL', '', '', '',
1338 'nasnum', 'int', '', '', '', '',
1340 'primary_key' => 'portnum',
1347 'nasnum', 'serial', '', '', '', '',
1348 'nas', 'varchar', '', $char_d, '', '',
1349 'nasip', 'varchar', '', 15, '', '',
1350 'nasfqdn', 'varchar', '', $char_d, '', '',
1351 'last', 'int', '', '', '', '',
1353 'primary_key' => 'nasnum',
1354 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1355 'index' => [ [ 'last' ] ],
1360 # 'sessionnum', 'serial', '', '', '', '',
1361 # 'portnum', 'int', '', '', '', '',
1362 # 'svcnum', 'int', '', '', '', '',
1363 # 'login', @date_type, '', '',
1364 # 'logout', @date_type, '', '',
1366 # 'primary_key' => 'sessionnum',
1368 # 'index' => [ [ 'portnum' ] ],
1373 'jobnum', 'serial', '', '', '', '',
1374 'job', 'text', '', '', '', '',
1375 '_date', 'int', '', '', '', '',
1376 'status', 'varchar', '', $char_d, '', '',
1377 'statustext', 'text', 'NULL', '', '', '',
1378 'svcnum', 'int', 'NULL', '', '', '',
1379 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1382 'primary_key' => 'jobnum',
1384 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1389 'argnum', 'serial', '', '', '', '',
1390 'jobnum', 'int', '', '', '', '',
1391 'arg', 'text', 'NULL', '', '', '',
1393 'primary_key' => 'argnum',
1395 'index' => [ [ 'jobnum' ] ],
1400 'dependnum', 'serial', '', '', '', '',
1401 'jobnum', 'int', '', '', '', '',
1402 'depend_jobnum', 'int', '', '', '', '',
1404 'primary_key' => 'dependnum',
1406 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1411 'exportsvcnum' => 'serial', '', '', '', '',
1412 'exportnum' => 'int', '', '', '', '',
1413 'svcpart' => 'int', '', '', '', '',
1415 'primary_key' => 'exportsvcnum',
1416 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1417 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1422 'exportnum', 'serial', '', '', '', '',
1423 'machine', 'varchar', '', $char_d, '', '',
1424 'exporttype', 'varchar', '', $char_d, '', '',
1425 'nodomain', 'char', 'NULL', 1, '', '',
1427 'primary_key' => 'exportnum',
1429 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1432 'part_export_option' => {
1434 'optionnum', 'serial', '', '', '', '',
1435 'exportnum', 'int', '', '', '', '',
1436 'optionname', 'varchar', '', $char_d, '', '',
1437 'optionvalue', 'text', 'NULL', '', '', '',
1439 'primary_key' => 'optionnum',
1441 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1444 'radius_usergroup' => {
1446 'usergroupnum', 'serial', '', '', '', '',
1447 'svcnum', 'int', '', '', '', '',
1448 'groupname', 'varchar', '', $char_d, '', '',
1450 'primary_key' => 'usergroupnum',
1452 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1457 'msgnum', 'serial', '', '', '', '',
1458 'msgcode', 'varchar', '', $char_d, '', '',
1459 'locale', 'varchar', '', 16, '', '',
1460 'msg', 'text', '', '', '', '',
1462 'primary_key' => 'msgnum',
1463 'unique' => [ [ 'msgcode', 'locale' ] ],
1467 'cust_tax_exempt' => {
1469 'exemptnum', 'serial', '', '', '', '',
1470 'custnum', 'int', '', '', '', '',
1471 'taxnum', 'int', '', '', '', '',
1472 'year', 'int', '', '', '', '',
1473 'month', 'int', '', '', '', '',
1474 'amount', @money_type, '', '',
1476 'primary_key' => 'exemptnum',
1477 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1481 'cust_tax_exempt_pkg' => {
1483 'exemptpkgnum', 'serial', '', '', '', '',
1484 #'custnum', 'int', '', '', '', ''
1485 'billpkgnum', 'int', '', '', '', '',
1486 'taxnum', 'int', '', '', '', '',
1487 'year', 'int', '', '', '', '',
1488 'month', 'int', '', '', '', '',
1489 'amount', @money_type, '', '',
1491 'primary_key' => 'exemptpkgnum',
1493 'index' => [ [ 'taxnum', 'year', 'month' ],
1501 'routernum', 'serial', '', '', '', '',
1502 'routername', 'varchar', '', $char_d, '', '',
1503 'svcnum', 'int', 'NULL', '', '', '',
1504 'agentnum', 'int', 'NULL', '', '', '',
1506 'primary_key' => 'routernum',
1511 'part_svc_router' => {
1513 'svcrouternum', 'serial', '', '', '', '',
1514 'svcpart', 'int', '', '', '', '',
1515 'routernum', 'int', '', '', '', '',
1517 'primary_key' => 'svcrouternum',
1524 'blocknum', 'serial', '', '', '', '',
1525 'routernum', 'int', '', '', '', '',
1526 'ip_gateway', 'varchar', '', 15, '', '',
1527 'ip_netmask', 'int', '', '', '', '',
1528 'agentnum', 'int', 'NULL', '', '', '',
1530 'primary_key' => 'blocknum',
1531 'unique' => [ [ 'blocknum', 'routernum' ] ],
1535 'svc_broadband' => {
1537 'svcnum', 'int', '', '', '', '',
1538 'description', 'varchar', 'NULL', $char_d, '', '',
1539 'blocknum', 'int', '', '', '', '',
1540 'speed_up', 'int', '', '', '', '',
1541 'speed_down', 'int', '', '', '', '',
1542 'ip_addr', 'varchar', '', 15, '', '',
1543 'mac_addr', 'varchar', 'NULL', 12, '', '',
1544 'authkey', 'varchar', 'NULL', 32, '', '',
1545 'latitude', 'decimal', 'NULL', '', '', '',
1546 'longitude', 'decimal', 'NULL', '', '', '',
1547 'altitude', 'decimal', 'NULL', '', '', '',
1548 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1550 'primary_key' => 'svcnum',
1555 'part_virtual_field' => {
1557 'vfieldpart', 'serial', '', '', '', '',
1558 'dbtable', 'varchar', '', 32, '', '',
1559 'name', 'varchar', '', 32, '', '',
1560 'check_block', 'text', 'NULL', '', '', '',
1561 'length', 'int', 'NULL', '', '', '',
1562 'list_source', 'text', 'NULL', '', '', '',
1563 'label', 'varchar', 'NULL', 80, '', '',
1565 'primary_key' => 'vfieldpart',
1570 'virtual_field' => {
1572 'vfieldnum', 'serial', '', '', '', '',
1573 'recnum', 'int', '', '', '', '',
1574 'vfieldpart', 'int', '', '', '', '',
1575 'value', 'varchar', '', 128, '', '',
1577 'primary_key' => 'vfieldnum',
1578 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1584 'snarfnum', 'int', '', '', '', '',
1585 'svcnum', 'int', '', '', '', '',
1586 'machine', 'varchar', '', 255, '', '',
1587 'protocol', 'varchar', '', $char_d, '', '',
1588 'username', 'varchar', '', $char_d, '', '',
1589 '_password', 'varchar', '', $char_d, '', '',
1591 'primary_key' => 'snarfnum',
1593 'index' => [ [ 'svcnum' ] ],
1598 'svcnum', 'int', '', '', '', '',
1599 'id', 'int', 'NULL', '', '', '',
1600 'title', 'varchar', 'NULL', $char_d, '', '',
1602 'primary_key' => 'svcnum',
1607 'cust_pay_refund' => {
1609 'payrefundnum', 'serial', '', '', '', '',
1610 'paynum', 'int', '', '', '', '',
1611 'refundnum', 'int', '', '', '', '',
1612 '_date', @date_type, '', '',
1613 'amount', @money_type, '', '',
1615 'primary_key' => 'payrefundnum',
1617 'index' => [ ['paynum'], ['refundnum'] ],
1620 'part_pkg_option' => {
1622 'optionnum', 'serial', '', '', '', '',
1623 'pkgpart', 'int', '', '', '', '',
1624 'optionname', 'varchar', '', $char_d, '', '',
1625 'optionvalue', 'text', 'NULL', '', '', '',
1627 'primary_key' => 'optionnum',
1629 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1634 'ratenum', 'serial', '', '', '', '',
1635 'ratename', 'varchar', '', $char_d, '', '',
1637 'primary_key' => 'ratenum',
1644 'ratedetailnum', 'serial', '', '', '', '',
1645 'ratenum', 'int', '', '', '', '',
1646 'orig_regionnum', 'int', 'NULL', '', '', '',
1647 'dest_regionnum', 'int', '', '', '', '',
1648 'min_included', 'int', '', '', '', '',
1649 #'min_charge', @money_type, '', '',
1650 'min_charge', 'decimal', '', '10,5', '', '',
1651 'sec_granularity', 'int', '', '', '', '',
1652 #time period (link to table of periods)?
1654 'primary_key' => 'ratedetailnum',
1655 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1656 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1661 'regionnum', 'serial', '', '', '', '',
1662 'regionname', 'varchar', '', $char_d, '', '',
1664 'primary_key' => 'regionnum',
1671 'prefixnum', 'serial', '', '', '', '',
1672 'regionnum', 'int', '', '',, '', '',
1673 'countrycode', 'varchar', '', 3, '', '',
1674 'npa', 'varchar', 'NULL', 6, '', '',
1675 'nxx', 'varchar', 'NULL', 3, '', '',
1677 'primary_key' => 'prefixnum',
1679 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1684 'codenum', 'serial', '', '', '', '',
1685 'code', 'varchar', '', $char_d, '', '',
1686 'agentnum', 'int', '', '', '', '',
1688 'primary_key' => 'codenum',
1689 'unique' => [ [ 'agentnum', 'code' ] ],
1690 'index' => [ [ 'agentnum' ] ],
1695 'codepkgnum', 'serial', '', '', '', '',
1696 'codenum', 'int', '', '', '', '',
1697 'pkgpart', 'int', '', '', '', '',
1699 'primary_key' => 'codepkgnum',
1700 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1701 'index' => [ [ 'codenum' ] ],
1704 'clientapi_session' => {
1706 'sessionnum', 'serial', '', '', '', '',
1707 'sessionid', 'varchar', '', $char_d, '', '',
1708 'namespace', 'varchar', '', $char_d, '', '',
1710 'primary_key' => 'sessionnum',
1711 'unique' => [ [ 'sessionid', 'namespace' ] ],
1715 'clientapi_session_field' => {
1717 'fieldnum', 'serial', '', '', '', '',
1718 'sessionnum', 'int', '', '', '', '',
1719 'fieldname', 'varchar', '', $char_d, '', '',
1720 'fieldvalue', 'text', 'NULL', '', '', '',
1722 'primary_key' => 'fieldnum',
1723 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1727 'payment_gateway' => {
1729 'gatewaynum', 'serial', '', '', '', '',
1730 'gateway_module', 'varchar', '', $char_d, '', '',
1731 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1732 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1733 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1734 'disabled', 'char', 'NULL', 1, '', '',
1736 'primary_key' => 'gatewaynum',
1738 'index' => [ [ 'disabled' ] ],
1741 'payment_gateway_option' => {
1743 'optionnum', 'serial', '', '', '', '',
1744 'gatewaynum', 'int', '', '', '', '',
1745 'optionname', 'varchar', '', $char_d, '', '',
1746 'optionvalue', 'text', 'NULL', '', '', '',
1748 'primary_key' => 'optionnum',
1750 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1753 'agent_payment_gateway' => {
1755 'agentgatewaynum', 'serial', '', '', '', '',
1756 'agentnum', 'int', '', '', '', '',
1757 'gatewaynum', 'int', '', '', '', '',
1758 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1759 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1761 'primary_key' => 'agentgatewaynum',
1763 'index' => [ [ 'agentnum', 'cardtype' ], ],
1768 'bannum', 'serial', '', '', '', '',
1769 'payby', 'char', '', 4, '', '',
1770 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1771 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1772 '_date', @date_type, '', '',
1773 'otaker', 'varchar', '', 32, '', '',
1774 'reason', 'varchar', 'NULL', $char_d, '', '',
1776 'primary_key' => 'bannum',
1777 'unique' => [ [ 'payby', 'payinfo' ] ],
1783 'categorynum', 'serial', '', '', '', '',
1784 'categoryname', 'varchar', '', $char_d, '', '',
1785 'disabled', 'char', 'NULL', 1, '', '',
1787 'primary_key' => 'categorynum',
1789 'index' => [ ['disabled'] ],
1794 'classnum', 'serial', '', '', '', '',
1795 'classname', 'varchar', '', $char_d, '', '',
1796 'categorynum', 'int', 'NULL', '', '', '',
1797 'disabled', 'char', 'NULL', 1, '', '',
1799 'primary_key' => 'classnum',
1801 'index' => [ ['disabled'] ],
1806 # qw( name type null length default local );
1812 'acctid', 'bigserial', '', '', '', '',
1813 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1814 'calldate', 'timestamp', '', '', \'now()', '',
1815 'clid', 'varchar', '', $char_d, \"''", '',
1816 'src', 'varchar', '', $char_d, \"''", '',
1817 'dst', 'varchar', '', $char_d, \"''", '',
1818 'dcontext', 'varchar', '', $char_d, \"''", '',
1819 'channel', 'varchar', '', $char_d, \"''", '',
1820 'dstchannel', 'varchar', '', $char_d, \"''", '',
1821 'lastapp', 'varchar', '', $char_d, \"''", '',
1822 'lastdata', 'varchar', '', $char_d, \"''", '',
1824 #these don't seem to be logged by most of the SQL cdr_* modules
1825 #except tds under sql-illegal names, so;
1826 # ... don't rely on them for rating?
1827 # and, what they hey, i went ahead and changed the names and data types
1828 # to freeside-style dates...
1829 #'start', 'timestamp', 'NULL', '', '', '',
1830 #'answer', 'timestamp', 'NULL', '', '', '',
1831 #'end', 'timestamp', 'NULL', '', '', '',
1832 'startdate', @date_type, '', '',
1833 'answerdate', @date_type, '', '',
1834 'enddate', @date_type, '', '',
1837 'duration', 'int', '', '', 0, '',
1838 'billsec', 'int', '', '', 0, '',
1839 'disposition', 'varchar', '', 45, \"''", '',
1840 'amaflags', 'int', '', '', 0, '',
1841 'accountcode', 'varchar', '', 20, \"''", '',
1842 'uniqueid', 'varchar', '', 32, \"''", '',
1843 'userfield', 'varchar', '', 255, \"''", '',
1846 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1850 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1851 'cdrtypenum', 'int', 'NULL', '', '', '',
1853 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1855 'upstream_currency', 'char', 'NULL', 3, '', '',
1856 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1857 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1859 # how it was rated internally...
1860 'ratedetailnum', 'int', 'NULL', '', '', '',
1861 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1863 'distance', 'decimal', 'NULL', '', '', '',
1864 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1866 #cdr_calltype: the big list in appendix 2
1867 'calltypenum', 'int', 'NULL', '', '', '',
1869 'description', 'varchar', 'NULL', $char_d, '', '',
1870 'quantity', 'int', 'NULL', '', '', '',
1872 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1873 'carrierid', 'int', 'NULL', '', '', '',
1875 'upstream_rateid', 'int', 'NULL', '', '', '',
1878 #and now for our own fields
1881 # a svcnum... right..?
1882 'svcnum', 'int', 'NULL', '', '', '',
1884 #NULL, done (or something)
1885 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1888 'primary_key' => 'acctid',
1890 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1895 'calltypenum', 'serial', '', '', '', '',
1896 'calltypename', 'varchar', '', $char_d, '', '',
1898 'primary_key' => 'calltypenum',
1905 'cdrtypenum' => 'serial', '', '', '', '',
1906 'cdrtypename' => 'varchar', '', $char_d, '', '',
1908 'primary_key' => 'cdrtypenum',
1915 'carrierid' => 'serial', '', '', '', '',
1916 'carriername' => 'varchar', '', $char_d, '', '',
1918 'primary_key' => 'carrierid',
1923 #map upstream rateid to ours...
1924 'cdr_upstream_rate' => {
1926 'upstreamratenum', 'serial', '', '', '', '',
1927 'upstream_rateid', 'varchar', '', $char_d, '', '',
1928 'ratedetailnum', 'int', 'NULL', '', '', '',
1930 'primary_key' => 'upstreamratenum', #XXX need a primary key
1931 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1935 'inventory_item' => {
1937 'itemnum', 'serial', '', '', '', '',
1938 'classnum', 'int', '', '', '', '',
1939 'item', 'varchar', '', $char_d, '', '',
1940 'svcnum', 'int', 'NULL', '', '', '',
1942 'primary_key' => 'itemnum',
1943 'unique' => [ [ 'classnum', 'item' ] ],
1944 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1947 'inventory_class' => {
1949 'classnum', 'serial', '', '', '', '',
1950 'classname', 'varchar', '', $char_d, '', '',
1952 'primary_key' => 'classnum',
1959 'usernum', 'serial', '', '', '', '',
1960 'username', 'varchar', '', $char_d, '', '',
1961 '_password', 'varchar', '', $char_d, '', '',
1962 'last', 'varchar', '', $char_d, '', '',
1963 'first', 'varchar', '', $char_d, '', '',
1964 'disabled', 'char', 'NULL', 1, '', '',
1966 'primary_key' => 'usernum',
1967 'unique' => [ [ 'username' ] ],
1971 'access_user_pref' => {
1973 'prefnum', 'serial', '', '', '', '',
1974 'usernum', 'int', '', '', '', '',
1975 'prefname', 'varchar', '', $char_d, '', '',
1976 'prefvalue', 'text', 'NULL', '', '', '',
1977 'expiration', @date_type, '', '',
1979 'primary_key' => 'prefnum',
1981 'index' => [ [ 'usernum' ] ],
1986 'groupnum', 'serial', '', '', '', '',
1987 'groupname', 'varchar', '', $char_d, '', '',
1989 'primary_key' => 'groupnum',
1990 'unique' => [ [ 'groupname' ] ],
1994 'access_usergroup' => {
1996 'usergroupnum', 'serial', '', '', '', '',
1997 'usernum', 'int', '', '', '', '',
1998 'groupnum', 'int', '', '', '', '',
2000 'primary_key' => 'usergroupnum',
2001 'unique' => [ [ 'usernum', 'groupnum' ] ],
2002 'index' => [ [ 'usernum' ] ],
2005 'access_groupagent' => {
2007 'groupagentnum', 'serial', '', '', '', '',
2008 'groupnum', 'int', '', '', '', '',
2009 'agentnum', 'int', '', '', '', '',
2011 'primary_key' => 'groupagentnum',
2012 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2013 'index' => [ [ 'groupnum' ] ],
2018 'rightnum', 'serial', '', '', '', '',
2019 'righttype', 'varchar', '', $char_d, '', '',
2020 'rightobjnum', 'int', '', '', '', '',
2021 'rightname', 'varchar', '', $char_d, '', '',
2023 'primary_key' => 'rightnum',
2024 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2030 'svcnum', 'int', '', '', '', '',
2031 'countrycode', 'varchar', '', 3, '', '',
2032 'phonenum', 'varchar', '', 15, '', '', #12 ?
2033 'pin', 'varchar', 'NULL', $char_d, '', '',
2034 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2036 'primary_key' => 'svcnum',
2038 'index' => [ [ 'countrycode', 'phonenum' ] ],
2043 'availnum', 'int', '', '', '', '',
2044 'exportnum', 'int', '', '', '', '',
2045 'countrycode', 'varchar', '', 3, '', '',
2046 'state', 'char', 'NULL', 2, '', '',
2047 'npa', 'char', '', 3, '', '',
2048 'nxx', 'char', 'NULL', 3, '', '',
2050 'primary_key' => 'availnum',
2052 'index' => [ [ 'exportnum', 'countrycode', 'state' ] ],
2057 'typenum', 'serial', '', '', '', '',
2058 'class', 'char', '', 1, '', '',
2059 'type', 'varchar', '', $char_d, '', '',
2061 'primary_key' => 'typenum',
2068 'reasonnum', 'serial', '', '', '', '',
2069 'reason_type', 'int', '', '', '', '',
2070 'reason', 'text', '', '', '', '',
2071 'disabled', 'char', 'NULL', 1, '', '',
2073 'primary_key' => 'reasonnum',
2080 'confnum', 'serial', '', '', '', '',
2081 'agentnum', 'int', 'NULL', '', '', '',
2082 'name', 'varchar', '', $char_d, '', '',
2083 'value', 'text', 'NULL', '', '', '',
2085 'primary_key' => 'confnum',
2086 'unique' => [ [ 'agentnum', 'name' ]],
2092 'pkgrefnum', 'serial', '', '', '', '',
2093 'pkgnum', 'int', '', '', '', '',
2094 'refnum', 'int', '', '', '', '',
2096 'primary_key' => 'pkgrefnum',
2097 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2098 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2100 # name type nullability length default local
2104 # 'num', 'serial', '', '', '', '',
2106 # 'primary_key' => 'num',