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 my $h_tableobj = DBIx::DBSchema::Table->new( {
196 'name' => "h_$table",
197 'primary_key' => 'historynum',
198 'indices' => \%h_indices,
199 'local_options' => $local_options,
201 DBIx::DBSchema::Column->new( {
202 'name' => 'historynum',
204 'null' => 'NOT NULL',
209 DBIx::DBSchema::Column->new( {
210 'name' => 'history_date',
217 DBIx::DBSchema::Column->new( {
218 'name' => 'history_user',
220 'null' => 'NOT NULL',
225 DBIx::DBSchema::Column->new( {
226 'name' => 'history_action',
228 'null' => 'NOT NULL',
234 my $column = $tableobj->column($_);
236 #clone so as to not disturb the original
237 $column = DBIx::DBSchema::Column->new( {
238 map { $_ => $column->$_() }
239 qw( name type null length default local )
242 if ( $column->type =~ /^(\w*)SERIAL$/i ) {
243 $column->type('int');
244 $column->null('NULL');
246 #$column->default('')
247 # if $column->default =~ /^nextval\(/i;
248 #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
249 #$column->local($local);
254 $dbdef->addtable($h_tableobj);
257 if ( $datasrc =~ /^dbi:mysql/i ) {
259 my $dup_lock_table = DBIx::DBSchema::Table->new( {
260 'name' => 'duplicate_lock',
261 'primary_key' => 'duplocknum',
262 'local_options' => $local_options,
264 DBIx::DBSchema::Column->new( {
265 'name' => 'duplocknum',
267 'null' => 'NOT NULL',
272 DBIx::DBSchema::Column->new( {
273 'name' => 'lockname',
275 'null' => 'NOT NULL',
281 'indices' => { 'duplicate_lock1' =>
282 DBIx::DBSchema::Index->new({
283 'name' => 'duplicate_lock1',
285 'columns' => [ 'lockname' ],
290 $dbdef->addtable($dup_lock_table);
300 my $char_d = 80; #default maxlength for text fields
302 #my(@date_type) = ( 'timestamp', '', '' );
303 my @date_type = ( 'int', 'NULL', '' );
304 my @perl_type = ( 'text', 'NULL', '' );
305 my @money_type = ( 'decimal', '', '10,2' );
306 my @money_typen = ( 'decimal', 'NULL', '10,2' );
308 my $username_len = 32; #usernamemax config file
310 # name type nullability length default local
316 'agentnum', 'serial', '', '', '', '',
317 'agent', 'varchar', '', $char_d, '', '',
318 'typenum', 'int', '', '', '', '',
319 'disabled', 'char', 'NULL', 1, '', '',
320 'ticketing_queueid', 'int', 'NULL', '', '', '',
321 'invoice_template', 'varchar', 'NULL', $char_d, '', '',
322 'username', 'varchar', 'NULL', $char_d, '', '', #deprecated
323 '_password', 'varchar', 'NULL', $char_d, '', '', #deprecated
324 'freq', 'int', 'NULL', '', '', '', #deprecated (never used)
325 'prog', @perl_type, '', '', #deprecated (never used)
328 'primary_key' => 'agentnum',
330 'index' => [ ['typenum'], ['disabled'] ],
335 'typenum', 'serial', '', '', '', '',
336 'atype', 'varchar', '', $char_d, '', '',
338 'primary_key' => 'typenum',
345 'typepkgnum', 'serial', '', '', '', '',
346 'typenum', 'int', '', '', '', '',
347 'pkgpart', 'int', '', '', '', '',
349 'primary_key' => 'typepkgnum',
350 'unique' => [ ['typenum', 'pkgpart'] ],
351 'index' => [ ['typenum'] ],
356 'invnum', 'serial', '', '', '', '',
357 'custnum', 'int', '', '', '', '',
358 '_date', @date_type, '', '',
359 'charged', @money_type, '', '',
360 'printed', 'int', '', '', '', '',
361 'closed', 'char', 'NULL', 1, '', '',
363 'primary_key' => 'invnum',
365 'index' => [ ['custnum'], ['_date'] ],
368 'cust_bill_event' => {
370 'eventnum', 'serial', '', '', '', '',
371 'invnum', 'int', '', '', '', '',
372 'eventpart', 'int', '', '', '', '',
373 '_date', @date_type, '', '',
374 'status', 'varchar', '', $char_d, '', '',
375 'statustext', 'text', 'NULL', '', '', '',
377 'primary_key' => 'eventnum',
378 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
380 'index' => [ ['invnum'], ['status'] ],
383 'part_bill_event' => {
385 'eventpart', 'serial', '', '', '', '',
386 'freq', 'varchar', 'NULL', $char_d, '', '',
387 'payby', 'char', '', 4, '', '',
388 'event', 'varchar', '', $char_d, '', '',
389 'eventcode', @perl_type, '', '',
390 'seconds', 'int', 'NULL', '', '', '',
391 'weight', 'int', '', '', '', '',
392 'plan', 'varchar', 'NULL', $char_d, '', '',
393 'plandata', 'text', 'NULL', '', '', '',
394 'reason', 'int', 'NULL', '', '', '',
395 'disabled', 'char', 'NULL', 1, '', '',
397 'primary_key' => 'eventpart',
399 'index' => [ ['payby'], ['disabled'], ],
404 'eventpart', 'serial', '', '', '', '',
405 'agentnum', 'int', 'NULL', '', '', '',
406 'event', 'varchar', '', $char_d, '', '',
407 'eventtable', 'varchar', '', $char_d, '', '',
408 'check_freq', 'varchar', 'NULL', $char_d, '', '',
409 'weight', 'int', '', '', '', '',
410 'action', 'varchar', '', $char_d, '', '',
411 'disabled', 'char', 'NULL', 1, '', '',
413 'primary_key' => 'eventpart',
415 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
418 'part_event_option' => {
420 'optionnum', 'serial', '', '', '', '',
421 'eventpart', 'int', '', '', '', '',
422 'optionname', 'varchar', '', $char_d, '', '',
423 'optionvalue', 'text', 'NULL', '', '', '',
425 'primary_key' => 'optionnum',
427 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
430 'part_event_condition' => {
432 'eventconditionnum', 'serial', '', '', '', '',
433 'eventpart', 'int', '', '', '', '',
434 'conditionname', 'varchar', '', $char_d, '', '',
436 'primary_key' => 'eventconditionnum',
438 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
441 'part_event_condition_option' => {
443 'optionnum', 'serial', '', '', '', '',
444 'eventconditionnum', 'int', '', '', '', '',
445 'optionname', 'varchar', '', $char_d, '', '',
446 'optionvalue', 'text', 'NULL', '', '', '',
448 'primary_key' => 'optionnum',
450 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
453 'part_event_condition_option_option' => {
455 'optionoptionnum', 'serial', '', '', '', '',
456 'optionnum', 'int', '', '', '', '',
457 'optionname', 'varchar', '', $char_d, '', '',
458 'optionvalue', 'text', 'NULL', '', '', '',
460 'primary_key' => 'optionoptionnum',
462 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
467 'eventnum', 'serial', '', '', '', '',
468 'eventpart', 'int', '', '', '', '',
469 'tablenum', 'int', '', '', '', '',
470 '_date', @date_type, '', '',
471 'status', 'varchar', '', $char_d, '', '',
472 'statustext', 'text', 'NULL', '', '', '',
474 'primary_key' => 'eventnum',
475 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
477 'index' => [ ['eventpart'], ['tablenum'], ['status'] ],
482 'billpkgnum', 'serial', '', '', '', '',
483 'pkgnum', 'int', '', '', '', '',
484 'pkgpart_override', 'int', 'NULL', '', '', '',
485 'invnum', 'int', '', '', '', '',
486 'setup', @money_type, '', '',
487 'recur', @money_type, '', '',
488 'sdate', @date_type, '', '',
489 'edate', @date_type, '', '',
490 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
492 'primary_key' => 'billpkgnum',
494 'index' => [ ['invnum'], [ 'pkgnum' ] ],
497 'cust_bill_pkg_detail' => {
499 'detailnum', 'serial', '', '', '', '',
500 'pkgnum', 'int', '', '', '', '',
501 'invnum', 'int', '', '', '', '',
502 'format', 'char', 'NULL', 1, '', '',
503 'detail', 'varchar', '', $char_d, '', '',
505 'primary_key' => 'detailnum',
507 'index' => [ [ 'pkgnum', 'invnum' ] ],
512 'crednum', 'serial', '', '', '', '',
513 'custnum', 'int', '', '', '', '',
514 '_date', @date_type, '', '',
515 'amount', @money_type, '', '',
516 'otaker', 'varchar', '', 32, '', '',
517 'reason', 'text', 'NULL', '', '', '',
518 'reasonnum', 'int', 'NULL', '', '', '',
519 'closed', 'char', 'NULL', 1, '', '',
521 'primary_key' => 'crednum',
523 'index' => [ ['custnum'], ['_date'] ],
526 'cust_credit_bill' => {
528 'creditbillnum', 'serial', '', '', '', '',
529 'crednum', 'int', '', '', '', '',
530 'invnum', 'int', '', '', '', '',
531 '_date', @date_type, '', '',
532 'amount', @money_type, '', '',
534 'primary_key' => 'creditbillnum',
536 'index' => [ ['crednum'], ['invnum'] ],
539 'cust_credit_bill_pkg' => {
541 'creditbillpkgnum', 'serial', '', '', '', '',
542 'creditbillnum', 'int', '', '', '', '',
543 'billpkgnum', 'int', '', '', '', '',
544 'amount', @money_type, '', '',
545 'setuprecur', 'varchar', '', $char_d, '', '',
546 'sdate', @date_type, '', '',
547 'edate', @date_type, '', '',
549 'primary_key' => 'creditbillpkgnum',
551 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
556 'custnum', 'serial', '', '', '', '',
557 'agentnum', 'int', '', '', '', '',
558 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
559 # 'titlenum', 'int', 'NULL', '', '', '',
560 'last', 'varchar', '', $char_d, '', '',
561 # 'middle', 'varchar', 'NULL', $char_d, '', '',
562 'first', 'varchar', '', $char_d, '', '',
563 'ss', 'varchar', 'NULL', 11, '', '',
564 'stateid', 'varchar', 'NULL', $char_d, '', '',
565 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
566 'birthdate' ,@date_type, '', '',
567 'signupdate',@date_type, '', '',
568 'company', 'varchar', 'NULL', $char_d, '', '',
569 'address1', 'varchar', '', $char_d, '', '',
570 'address2', 'varchar', 'NULL', $char_d, '', '',
571 'city', 'varchar', '', $char_d, '', '',
572 'county', 'varchar', 'NULL', $char_d, '', '',
573 'state', 'varchar', 'NULL', $char_d, '', '',
574 'zip', 'varchar', 'NULL', 10, '', '',
575 'country', 'char', '', 2, '', '',
576 'daytime', 'varchar', 'NULL', 20, '', '',
577 'night', 'varchar', 'NULL', 20, '', '',
578 'fax', 'varchar', 'NULL', 12, '', '',
579 'ship_last', 'varchar', 'NULL', $char_d, '', '',
580 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
581 'ship_first', 'varchar', 'NULL', $char_d, '', '',
582 'ship_company', 'varchar', 'NULL', $char_d, '', '',
583 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
584 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
585 'ship_city', 'varchar', 'NULL', $char_d, '', '',
586 'ship_county', 'varchar', 'NULL', $char_d, '', '',
587 'ship_state', 'varchar', 'NULL', $char_d, '', '',
588 'ship_zip', 'varchar', 'NULL', 10, '', '',
589 'ship_country', 'char', 'NULL', 2, '', '',
590 'ship_daytime', 'varchar', 'NULL', 20, '', '',
591 'ship_night', 'varchar', 'NULL', 20, '', '',
592 'ship_fax', 'varchar', 'NULL', 12, '', '',
593 'payby', 'char', '', 4, '', '',
594 'payinfo', 'varchar', 'NULL', 512, '', '',
595 'paycvv', 'varchar', 'NULL', 512, '', '',
596 'paymask', 'varchar', 'NULL', $char_d, '', '',
597 #'paydate', @date_type, '', '',
598 'paydate', 'varchar', 'NULL', 10, '', '',
599 'paystart_month', 'int', 'NULL', '', '', '',
600 'paystart_year', 'int', 'NULL', '', '', '',
601 'payissue', 'varchar', 'NULL', 2, '', '',
602 'payname', 'varchar', 'NULL', $char_d, '', '',
603 'paystate', 'varchar', 'NULL', $char_d, '', '',
604 'paytype', 'varchar', 'NULL', $char_d, '', '',
605 'payip', 'varchar', 'NULL', 15, '', '',
606 'tax', 'char', 'NULL', 1, '', '',
607 'otaker', 'varchar', '', 32, '', '',
608 'refnum', 'int', '', '', '', '',
609 'referral_custnum', 'int', 'NULL', '', '', '',
610 'comments', 'text', 'NULL', '', '', '',
611 'spool_cdr','char', 'NULL', 1, '', '',
612 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
614 'primary_key' => 'custnum',
615 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
616 #'index' => [ ['last'], ['company'] ],
617 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
618 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
619 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
620 [ 'ship_last' ], [ 'ship_company' ],
621 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
622 [ 'payby' ], [ 'paydate' ],
626 'cust_main_invoice' => {
628 'destnum', 'serial', '', '', '', '',
629 'custnum', 'int', '', '', '', '',
630 'dest', 'varchar', '', $char_d, '', '',
632 'primary_key' => 'destnum',
634 'index' => [ ['custnum'], ],
637 'cust_main_note' => {
639 'notenum', 'serial', '', '', '', '',
640 'custnum', 'int', '', '', '', '',
641 '_date', @date_type, '', '',
642 'otaker', 'varchar', '', 32, '', '',
643 'comments', 'text', 'NULL', '', '', '',
645 'primary_key' => 'notenum',
647 'index' => [ [ 'custnum' ], [ '_date' ], ],
650 'cust_main_county' => { #county+state+country are checked off the
651 #cust_main_county for validation and to provide
654 'taxnum', 'serial', '', '', '', '',
655 'state', 'varchar', 'NULL', $char_d, '', '',
656 'county', 'varchar', 'NULL', $char_d, '', '',
657 'country', 'char', '', 2, '', '',
658 'taxclass', 'varchar', 'NULL', $char_d, '', '',
659 'exempt_amount', @money_type, '', '',
660 'tax', 'real', '', '', '', '', #tax %
661 'taxname', 'varchar', 'NULL', $char_d, '', '',
662 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
663 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
665 'primary_key' => 'taxnum',
667 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
668 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
673 'taxnum', 'serial', '', '', '', '',
674 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
675 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
676 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
677 'taxclassnum', 'int', '', '', '', '',
678 'effective_date', @date_type, '', '',
679 'tax', 'real', '', '', '', '', # tax %
680 'excessrate', 'real', 'NULL','', '', '', # second tax %
681 'taxbase', @money_typen, '', '', # amount at first tax rate
682 'taxmax', @money_typen, '', '', # maximum about at both rates
683 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
684 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
685 'unittype', 'int', 'NULL', '', '', '', # for fee
686 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
687 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
688 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
689 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
690 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
691 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
692 'taxauth', 'int', 'NULL', '', '', '', # tax authority
693 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
694 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
695 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
696 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
697 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
698 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
700 'primary_key' => 'taxnum',
702 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
705 'cust_tax_location' => {
707 'custlocationnum', 'serial', '', '', '', '',
708 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
709 'zip', 'char', '', 5, '', '',
710 'state', 'char', '', 2, '', '',
711 'plus4hi', 'char', '', 4, '', '',
712 'plus4lo', 'char', '', 4, '', '',
713 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
714 'geocode', 'varchar', '', 20, '', '',
716 'primary_key' => 'custlocationnum',
718 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
723 'taxclassnum', 'serial', '', '', '', '',
724 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
725 'taxclass', 'varchar', '', $char_d, '', '',
726 'description', 'varchar', '', 2*$char_d, '', '',
728 'primary_key' => 'taxclassnum',
729 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
733 'cust_pay_pending' => {
735 'paypendingnum','serial', '', '', '', '',
736 'custnum', 'int', '', '', '', '',
737 'paid', @money_type, '', '',
738 '_date', @date_type, '', '',
739 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
740 # be index into payby
742 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
743 'paymask', 'varchar', 'NULL', $char_d, '', '',
744 'paydate', 'varchar', 'NULL', 10, '', '',
745 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
746 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
748 'status', 'varchar', '', $char_d, '', '',
749 'statustext', 'text', 'NULL', '', '', '',
750 'gatewaynum', 'int', 'NULL', '', '', '',
751 #'cust_balance', @money_type, '', '',
752 'paynum', 'int', 'NULL', '', '', '',
754 'primary_key' => 'paypendingnum',
755 'unique' => [ [ 'payunique' ] ],
756 'index' => [ [ 'custnum' ], [ 'status' ], ],
761 'paynum', 'serial', '', '', '', '',
762 'custnum', 'int', '', '', '', '',
763 '_date', @date_type, '', '',
764 'paid', @money_type, '', '',
765 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
766 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
767 # index into payby table
769 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
770 'paymask', 'varchar', 'NULL', $char_d, '', '',
771 'paydate', 'varchar', 'NULL', 10, '', '',
772 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
773 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
774 'closed', 'char', 'NULL', 1, '', '',
776 'primary_key' => 'paynum',
777 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
778 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
783 'paynum', 'int', '', '', '', '',
784 'custnum', 'int', '', '', '', '',
785 'paid', @money_type, '', '',
786 '_date', @date_type, '', '',
787 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
788 # index into payby table
790 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
791 'paymask', 'varchar', 'NULL', $char_d, '', '',
792 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
793 'closed', 'char', 'NULL', 1, '', '',
794 'void_date', @date_type, '', '',
795 'reason', 'varchar', 'NULL', $char_d, '', '',
796 'otaker', 'varchar', '', 32, '', '',
798 'primary_key' => 'paynum',
800 'index' => [ [ 'custnum' ] ],
805 'billpaynum', 'serial', '', '', '', '',
806 'invnum', 'int', '', '', '', '',
807 'paynum', 'int', '', '', '', '',
808 'amount', @money_type, '', '',
809 '_date', @date_type, '', '',
811 'primary_key' => 'billpaynum',
813 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
816 'cust_bill_pay_batch' => {
818 'billpaynum', 'serial', '', '', '', '',
819 'invnum', 'int', '', '', '', '',
820 'paybatchnum', 'int', '', '', '', '',
821 'amount', @money_type, '', '',
822 '_date', @date_type, '', '',
824 'primary_key' => 'billpaynum',
826 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
829 'cust_bill_pay_pkg' => {
831 'billpaypkgnum', 'serial', '', '', '', '',
832 'billpaynum', 'int', '', '', '', '',
833 'billpkgnum', 'int', '', '', '', '',
834 'amount', @money_type, '', '',
835 'setuprecur', 'varchar', '', $char_d, '', '',
836 'sdate', @date_type, '', '',
837 'edate', @date_type, '', '',
839 'primary_key' => 'billpaypkgnum',
841 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
844 'pay_batch' => { #batches of payments to an external processor
846 'batchnum', 'serial', '', '', '', '',
847 'payby', 'char', '', 4, '', '', # CARD/CHEK
848 'status', 'char', 'NULL', 1, '', '',
849 'download', @date_type, '', '',
850 'upload', @date_type, '', '',
852 'primary_key' => 'batchnum',
857 'cust_pay_batch' => { #what's this used for again? list of customers
858 #in current CARD batch? (necessarily CARD?)
860 'paybatchnum', 'serial', '', '', '', '',
861 'batchnum', 'int', '', '', '', '',
862 'invnum', 'int', '', '', '', '',
863 'custnum', 'int', '', '', '', '',
864 'last', 'varchar', '', $char_d, '', '',
865 'first', 'varchar', '', $char_d, '', '',
866 'address1', 'varchar', '', $char_d, '', '',
867 'address2', 'varchar', 'NULL', $char_d, '', '',
868 'city', 'varchar', '', $char_d, '', '',
869 'state', 'varchar', 'NULL', $char_d, '', '',
870 'zip', 'varchar', 'NULL', 10, '', '',
871 'country', 'char', '', 2, '', '',
872 # 'trancode', 'int', '', '', '', ''
873 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
874 'payinfo', 'varchar', '', 512, '', '',
875 #'exp', @date_type, '', ''
876 'exp', 'varchar', 'NULL', 11, '', '',
877 'payname', 'varchar', 'NULL', $char_d, '', '',
878 'amount', @money_type, '', '',
879 'status', 'varchar', 'NULL', $char_d, '', '',
881 'primary_key' => 'paybatchnum',
883 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
888 'pkgnum', 'serial', '', '', '', '',
889 'custnum', 'int', '', '', '', '',
890 'pkgpart', 'int', '', '', '', '',
891 'otaker', 'varchar', '', 32, '', '',
892 'setup', @date_type, '', '',
893 'bill', @date_type, '', '',
894 'last_bill', @date_type, '', '',
895 'susp', @date_type, '', '',
896 'adjourn', @date_type, '', '',
897 'cancel', @date_type, '', '',
898 'expire', @date_type, '', '',
899 'change_date', @date_type, '', '',
900 'change_pkgnum', 'int', 'NULL', '', '', '',
901 'change_pkgpart', 'int', 'NULL', '', '', '',
902 'manual_flag', 'char', 'NULL', 1, '', '',
904 'primary_key' => 'pkgnum',
906 'index' => [ ['custnum'], ['pkgpart'],
907 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
908 ['expire'], ['cancel'],
913 'cust_pkg_option' => {
915 'optionnum', 'serial', '', '', '', '',
916 'pkgnum', 'int', '', '', '', '',
917 'optionname', 'varchar', '', $char_d, '', '',
918 'optionvalue', 'text', 'NULL', '', '', '',
920 'primary_key' => 'optionnum',
922 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
925 'cust_pkg_reason' => {
927 'num', 'serial', '', '', '', '',
928 'pkgnum', 'int', '', '', '', '',
929 'reasonnum','int', '', '', '', '',
930 'otaker', 'varchar', '', 32, '', '',
931 'date', @date_type, '', '',
933 'primary_key' => 'num',
940 'refundnum', 'serial', '', '', '', '',
941 'custnum', 'int', '', '', '', '',
942 '_date', @date_type, '', '',
943 'refund', @money_type, '', '',
944 'otaker', 'varchar', '', 32, '', '',
945 'reason', 'varchar', '', $char_d, '', '',
946 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
947 # be index into payby
949 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
950 'paymask', 'varchar', 'NULL', $char_d, '', '',
951 'paybatch', 'varchar', 'NULL', $char_d, '', '',
952 'closed', 'char', 'NULL', 1, '', '',
954 'primary_key' => 'refundnum',
956 'index' => [ ['custnum'], ['_date'] ],
959 'cust_credit_refund' => {
961 'creditrefundnum', 'serial', '', '', '', '',
962 'crednum', 'int', '', '', '', '',
963 'refundnum', 'int', '', '', '', '',
964 'amount', @money_type, '', '',
965 '_date', @date_type, '', '',
967 'primary_key' => 'creditrefundnum',
969 'index' => [ ['crednum'], ['refundnum'] ],
975 'svcnum', 'serial', '', '', '', '',
976 'pkgnum', 'int', 'NULL', '', '', '',
977 'svcpart', 'int', '', '', '', '',
978 'overlimit', @date_type, '', '',
980 'primary_key' => 'svcnum',
982 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
987 'pkgpart', 'serial', '', '', '', '',
988 'pkg', 'varchar', '', $char_d, '', '',
989 'comment', 'varchar', '', $char_d, '', '',
990 'promo_code', 'varchar', 'NULL', $char_d, '', '',
991 'setup', @perl_type, '', '',
992 'freq', 'varchar', '', $char_d, '', '', #billing frequency
993 'recur', @perl_type, '', '',
994 'setuptax', 'char', 'NULL', 1, '', '',
995 'recurtax', 'char', 'NULL', 1, '', '',
996 'plan', 'varchar', 'NULL', $char_d, '', '',
997 'plandata', 'text', 'NULL', '', '', '',
998 'disabled', 'char', 'NULL', 1, '', '',
999 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1000 'classnum', 'int', 'NULL', '', '', '',
1001 'taxproductnum', 'int', 'NULL', '', '', '',
1002 'pay_weight', 'real', 'NULL', '', '', '',
1003 'credit_weight', 'real', 'NULL', '', '', '',
1004 'agentnum', 'int', 'NULL', '', '', '',
1007 'primary_key' => 'pkgpart',
1009 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1012 'part_pkg_link' => {
1014 'pkglinknum', 'serial', '', '', '', '',
1015 'src_pkgpart', 'int', '', '', '', '',
1016 'dst_pkgpart', 'int', '', '', '', '',
1017 'link_type', 'varchar', '', $char_d, '', '',
1019 'primary_key' => 'pkglinknum',
1020 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1021 'index' => [ [ 'src_pkgpart' ] ],
1024 'part_pkg_taxclass' => {
1026 'taxclassnum', 'serial', '', '', '', '',
1027 'taxclass', 'varchar', '', $char_d, '', '',
1029 'primary_key' => 'taxclassnum',
1030 'unique' => [ [ 'taxclass' ] ],
1034 'part_pkg_taxproduct' => {
1036 'taxproductnum', 'serial', '', '', '', '',
1037 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1038 'taxproduct', 'varchar', '', $char_d, '', '',
1039 'description', 'varchar', '', 2*$char_d, '', '',
1041 'primary_key' => 'taxproductnum',
1042 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1046 'part_pkg_taxrate' => {
1048 'pkgtaxratenum', 'serial', '', '', '', '',
1049 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1050 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1051 'taxproductnum', 'int', '', '', '', '',
1052 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1053 'county', 'varchar', 'NULL', $char_d, '', '',
1054 'state', 'varchar', 'NULL', $char_d, '', '',
1055 'local', 'varchar', 'NULL', $char_d, '', '',
1056 'country', 'char', 'NULL', 2, '', '',
1057 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1058 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1059 'taxclassnum', 'int', 'NULL', '', '', '',
1060 'effdate', @date_type, '', '',
1061 'taxable', 'char', 'NULL', 1, '', '',
1063 'primary_key' => 'pkgtaxratenum',
1065 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1068 'part_pkg_taxoverride' => {
1070 'taxoverridenum', 'serial', '', '', '', '',
1071 'pkgpart', 'serial', '', '', '', '',
1072 'taxclassnum', 'serial', '', '', '', '',
1074 'primary_key' => 'taxoverridenum',
1076 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1081 # 'titlenum', 'int', '', '',
1082 # 'title', 'varchar', '', $char_d,
1084 # 'primary_key' => 'titlenum',
1085 # 'unique' => [ [] ],
1086 # 'index' => [ [] ],
1091 'pkgsvcnum', 'serial', '', '', '', '',
1092 'pkgpart', 'int', '', '', '', '',
1093 'svcpart', 'int', '', '', '', '',
1094 'quantity', 'int', '', '', '', '',
1095 'primary_svc','char', 'NULL', 1, '', '',
1097 'primary_key' => 'pkgsvcnum',
1098 'unique' => [ ['pkgpart', 'svcpart'] ],
1099 'index' => [ ['pkgpart'] ],
1102 'part_referral' => {
1104 'refnum', 'serial', '', '', '', '',
1105 'referral', 'varchar', '', $char_d, '', '',
1106 'disabled', 'char', 'NULL', 1, '', '',
1107 'agentnum', 'int', 'NULL', '', '', '',
1109 'primary_key' => 'refnum',
1111 'index' => [ ['disabled'], ['agentnum'], ],
1116 'svcpart', 'serial', '', '', '', '',
1117 'svc', 'varchar', '', $char_d, '', '',
1118 'svcdb', 'varchar', '', $char_d, '', '',
1119 'disabled', 'char', 'NULL', 1, '', '',
1121 'primary_key' => 'svcpart',
1123 'index' => [ [ 'disabled' ] ],
1126 'part_svc_column' => {
1128 'columnnum', 'serial', '', '', '', '',
1129 'svcpart', 'int', '', '', '', '',
1130 'columnname', 'varchar', '', 64, '', '',
1131 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1132 'columnflag', 'char', 'NULL', 1, '', '',
1134 'primary_key' => 'columnnum',
1135 'unique' => [ [ 'svcpart', 'columnname' ] ],
1136 'index' => [ [ 'svcpart' ] ],
1139 #(this should be renamed to part_pop)
1142 'popnum', 'serial', '', '', '', '',
1143 'city', 'varchar', '', $char_d, '', '',
1144 'state', 'varchar', '', $char_d, '', '',
1145 'ac', 'char', '', 3, '', '',
1146 'exch', 'char', '', 3, '', '',
1147 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1149 'primary_key' => 'popnum',
1151 'index' => [ [ 'state' ] ],
1154 'part_pop_local' => {
1156 'localnum', 'serial', '', '', '', '',
1157 'popnum', 'int', '', '', '', '',
1158 'city', 'varchar', 'NULL', $char_d, '', '',
1159 'state', 'char', 'NULL', 2, '', '',
1160 'npa', 'char', '', 3, '', '',
1161 'nxx', 'char', '', 3, '', '',
1163 'primary_key' => 'localnum',
1165 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1170 'svcnum', 'int', '', '', '', '',
1171 'username', 'varchar', '', $username_len, '', '',
1172 '_password', 'varchar', '', 512, '', '',
1173 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1174 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1175 'popnum', 'int', 'NULL', '', '', '',
1176 'uid', 'int', 'NULL', '', '', '',
1177 'gid', 'int', 'NULL', '', '', '',
1178 'finger', 'varchar', 'NULL', $char_d, '', '',
1179 'dir', 'varchar', 'NULL', $char_d, '', '',
1180 'shell', 'varchar', 'NULL', $char_d, '', '',
1181 'quota', 'varchar', 'NULL', $char_d, '', '',
1182 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1183 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1184 'seconds_threshold', 'int', 'NULL', '', '', '',
1185 'upbytes', 'bigint', 'NULL', '', '', '',
1186 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1187 'downbytes', 'bigint', 'NULL', '', '', '',
1188 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1189 'totalbytes','bigint', 'NULL', '', '', '',
1190 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1191 'domsvc', 'int', '', '', '', '',
1192 'last_login', @date_type, '', '',
1193 'last_logout', @date_type, '', '',
1195 'primary_key' => 'svcnum',
1196 #'unique' => [ [ 'username', 'domsvc' ] ],
1198 'index' => [ ['username'], ['domsvc'] ],
1201 'acct_rt_transaction' => {
1203 'svcrtid', 'int', '', '', '', '',
1204 'svcnum', 'int', '', '', '', '',
1205 'transaction_id', 'int', '', '', '', '',
1206 '_date', @date_type, '', '',
1207 'seconds', 'int', '', '', '', '', #uhhhh
1208 'support', 'int', '', '', '', '',
1210 'primary_key' => 'svcrtid',
1212 'index' => [ ['svcnum', 'transaction_id'] ],
1217 # 'svcnum', 'int', '', '',
1218 # 'amount', @money_type,
1220 # 'primary_key' => 'svcnum',
1221 # 'unique' => [ [] ],
1222 # 'index' => [ [] ],
1227 'svcnum', 'int', '', '', '', '',
1228 'domain', 'varchar', '', $char_d, '', '',
1229 'suffix', 'varchar', 'NULL', $char_d, '', '',
1230 'catchall', 'int', 'NULL', '', '', '',
1231 'parent_svcnum', 'int', 'NULL', '', '', '',
1232 'registrarnum', 'int', 'NULL', '', '', '',
1233 'registrarkey', 'varchar', 'NULL', 512, '', '',
1234 'setup_date', @date_type, '', '',
1235 'renewal_interval', 'int', 'NULL', '', '', '',
1236 'expiration_date', @date_type, '', '',
1238 'primary_key' => 'svcnum',
1240 'index' => [ ['domain'] ],
1243 'domain_record' => {
1245 'recnum', 'serial', '', '', '', '',
1246 'svcnum', 'int', '', '', '', '',
1247 'reczone', 'varchar', '', 255, '', '',
1248 'recaf', 'char', '', 2, '', '',
1249 'rectype', 'varchar', '', 5, '', '',
1250 'recdata', 'varchar', '', 255, '', '',
1252 'primary_key' => 'recnum',
1254 'index' => [ ['svcnum'] ],
1259 'registrarnum', 'serial', '', '', '', '',
1260 'registrarname', 'varchar', '', $char_d, '', '',
1262 'primary_key' => 'registrarnum',
1269 'svcnum', 'int', '', '', '', '',
1270 'srcsvc', 'int', 'NULL', '', '', '',
1271 'src', 'varchar', 'NULL', 255, '', '',
1272 'dstsvc', 'int', 'NULL', '', '', '',
1273 'dst', 'varchar', 'NULL', 255, '', '',
1275 'primary_key' => 'svcnum',
1277 'index' => [ ['srcsvc'], ['dstsvc'] ],
1282 'svcnum', 'int', '', '', '', '',
1283 'recnum', 'int', '', '', '', '',
1284 'usersvc', 'int', 'NULL', '', '', '',
1285 'config', 'text', 'NULL', '', '', '',
1287 'primary_key' => 'svcnum',
1294 # 'svcnum', 'int', '', '',
1295 # 'svcnum', 'int', '', '',
1296 # 'svcnum', 'int', '', '',
1297 # 'worker', 'varchar', '', $char_d,
1298 # '_date', @date_type,
1300 # 'primary_key' => 'svcnum',
1301 # 'unique' => [ [] ],
1302 # 'index' => [ [] ],
1305 'prepay_credit' => {
1307 'prepaynum', 'serial', '', '', '', '',
1308 'identifier', 'varchar', '', $char_d, '', '',
1309 'amount', @money_type, '', '',
1310 'seconds', 'int', 'NULL', '', '', '',
1311 'upbytes', 'bigint', 'NULL', '', '', '',
1312 'downbytes', 'bigint', 'NULL', '', '', '',
1313 'totalbytes', 'bigint', 'NULL', '', '', '',
1314 'agentnum', 'int', 'NULL', '', '', '',
1316 'primary_key' => 'prepaynum',
1317 'unique' => [ ['identifier'] ],
1323 'portnum', 'serial', '', '', '', '',
1324 'ip', 'varchar', 'NULL', 15, '', '',
1325 'nasport', 'int', 'NULL', '', '', '',
1326 'nasnum', 'int', '', '', '', '',
1328 'primary_key' => 'portnum',
1335 'nasnum', 'serial', '', '', '', '',
1336 'nas', 'varchar', '', $char_d, '', '',
1337 'nasip', 'varchar', '', 15, '', '',
1338 'nasfqdn', 'varchar', '', $char_d, '', '',
1339 'last', 'int', '', '', '', '',
1341 'primary_key' => 'nasnum',
1342 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1343 'index' => [ [ 'last' ] ],
1348 # 'sessionnum', 'serial', '', '', '', '',
1349 # 'portnum', 'int', '', '', '', '',
1350 # 'svcnum', 'int', '', '', '', '',
1351 # 'login', @date_type, '', '',
1352 # 'logout', @date_type, '', '',
1354 # 'primary_key' => 'sessionnum',
1356 # 'index' => [ [ 'portnum' ] ],
1361 'jobnum', 'serial', '', '', '', '',
1362 'job', 'text', '', '', '', '',
1363 '_date', 'int', '', '', '', '',
1364 'status', 'varchar', '', $char_d, '', '',
1365 'statustext', 'text', 'NULL', '', '', '',
1366 'svcnum', 'int', 'NULL', '', '', '',
1367 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1370 'primary_key' => 'jobnum',
1372 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1377 'argnum', 'serial', '', '', '', '',
1378 'jobnum', 'int', '', '', '', '',
1379 'arg', 'text', 'NULL', '', '', '',
1381 'primary_key' => 'argnum',
1383 'index' => [ [ 'jobnum' ] ],
1388 'dependnum', 'serial', '', '', '', '',
1389 'jobnum', 'int', '', '', '', '',
1390 'depend_jobnum', 'int', '', '', '', '',
1392 'primary_key' => 'dependnum',
1394 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1399 'exportsvcnum' => 'serial', '', '', '', '',
1400 'exportnum' => 'int', '', '', '', '',
1401 'svcpart' => 'int', '', '', '', '',
1403 'primary_key' => 'exportsvcnum',
1404 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1405 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1410 'exportnum', 'serial', '', '', '', '',
1411 'machine', 'varchar', '', $char_d, '', '',
1412 'exporttype', 'varchar', '', $char_d, '', '',
1413 'nodomain', 'char', 'NULL', 1, '', '',
1415 'primary_key' => 'exportnum',
1417 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1420 'part_export_option' => {
1422 'optionnum', 'serial', '', '', '', '',
1423 'exportnum', 'int', '', '', '', '',
1424 'optionname', 'varchar', '', $char_d, '', '',
1425 'optionvalue', 'text', 'NULL', '', '', '',
1427 'primary_key' => 'optionnum',
1429 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1432 'radius_usergroup' => {
1434 'usergroupnum', 'serial', '', '', '', '',
1435 'svcnum', 'int', '', '', '', '',
1436 'groupname', 'varchar', '', $char_d, '', '',
1438 'primary_key' => 'usergroupnum',
1440 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1445 'msgnum', 'serial', '', '', '', '',
1446 'msgcode', 'varchar', '', $char_d, '', '',
1447 'locale', 'varchar', '', 16, '', '',
1448 'msg', 'text', '', '', '', '',
1450 'primary_key' => 'msgnum',
1451 'unique' => [ [ 'msgcode', 'locale' ] ],
1455 'cust_tax_exempt' => {
1457 'exemptnum', 'serial', '', '', '', '',
1458 'custnum', 'int', '', '', '', '',
1459 'taxnum', 'int', '', '', '', '',
1460 'year', 'int', '', '', '', '',
1461 'month', 'int', '', '', '', '',
1462 'amount', @money_type, '', '',
1464 'primary_key' => 'exemptnum',
1465 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1469 'cust_tax_exempt_pkg' => {
1471 'exemptpkgnum', 'serial', '', '', '', '',
1472 #'custnum', 'int', '', '', '', ''
1473 'billpkgnum', 'int', '', '', '', '',
1474 'taxnum', 'int', '', '', '', '',
1475 'year', 'int', '', '', '', '',
1476 'month', 'int', '', '', '', '',
1477 'amount', @money_type, '', '',
1479 'primary_key' => 'exemptpkgnum',
1481 'index' => [ [ 'taxnum', 'year', 'month' ],
1489 'routernum', 'serial', '', '', '', '',
1490 'routername', 'varchar', '', $char_d, '', '',
1491 'svcnum', 'int', 'NULL', '', '', '',
1492 'agentnum', 'int', 'NULL', '', '', '',
1494 'primary_key' => 'routernum',
1499 'part_svc_router' => {
1501 'svcrouternum', 'serial', '', '', '', '',
1502 'svcpart', 'int', '', '', '', '',
1503 'routernum', 'int', '', '', '', '',
1505 'primary_key' => 'svcrouternum',
1512 'blocknum', 'serial', '', '', '', '',
1513 'routernum', 'int', '', '', '', '',
1514 'ip_gateway', 'varchar', '', 15, '', '',
1515 'ip_netmask', 'int', '', '', '', '',
1516 'agentnum', 'int', 'NULL', '', '', '',
1518 'primary_key' => 'blocknum',
1519 'unique' => [ [ 'blocknum', 'routernum' ] ],
1523 'svc_broadband' => {
1525 'svcnum', 'int', '', '', '', '',
1526 'description', 'varchar', 'NULL', $char_d, '', '',
1527 'blocknum', 'int', '', '', '', '',
1528 'speed_up', 'int', '', '', '', '',
1529 'speed_down', 'int', '', '', '', '',
1530 'ip_addr', 'varchar', '', 15, '', '',
1531 'mac_addr', 'varchar', 'NULL', 12, '', '',
1532 'authkey', 'varchar', 'NULL', 32, '', '',
1533 'latitude', 'decimal', 'NULL', '', '', '',
1534 'longitude', 'decimal', 'NULL', '', '', '',
1535 'altitude', 'decimal', 'NULL', '', '', '',
1536 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1538 'primary_key' => 'svcnum',
1543 'part_virtual_field' => {
1545 'vfieldpart', 'serial', '', '', '', '',
1546 'dbtable', 'varchar', '', 32, '', '',
1547 'name', 'varchar', '', 32, '', '',
1548 'check_block', 'text', 'NULL', '', '', '',
1549 'length', 'int', 'NULL', '', '', '',
1550 'list_source', 'text', 'NULL', '', '', '',
1551 'label', 'varchar', 'NULL', 80, '', '',
1553 'primary_key' => 'vfieldpart',
1558 'virtual_field' => {
1560 'vfieldnum', 'serial', '', '', '', '',
1561 'recnum', 'int', '', '', '', '',
1562 'vfieldpart', 'int', '', '', '', '',
1563 'value', 'varchar', '', 128, '', '',
1565 'primary_key' => 'vfieldnum',
1566 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1572 'snarfnum', 'int', '', '', '', '',
1573 'svcnum', 'int', '', '', '', '',
1574 'machine', 'varchar', '', 255, '', '',
1575 'protocol', 'varchar', '', $char_d, '', '',
1576 'username', 'varchar', '', $char_d, '', '',
1577 '_password', 'varchar', '', $char_d, '', '',
1579 'primary_key' => 'snarfnum',
1581 'index' => [ [ 'svcnum' ] ],
1586 'svcnum', 'int', '', '', '', '',
1587 'id', 'int', 'NULL', '', '', '',
1588 'title', 'varchar', 'NULL', $char_d, '', '',
1590 'primary_key' => 'svcnum',
1595 'cust_pay_refund' => {
1597 'payrefundnum', 'serial', '', '', '', '',
1598 'paynum', 'int', '', '', '', '',
1599 'refundnum', 'int', '', '', '', '',
1600 '_date', @date_type, '', '',
1601 'amount', @money_type, '', '',
1603 'primary_key' => 'payrefundnum',
1605 'index' => [ ['paynum'], ['refundnum'] ],
1608 'part_pkg_option' => {
1610 'optionnum', 'serial', '', '', '', '',
1611 'pkgpart', 'int', '', '', '', '',
1612 'optionname', 'varchar', '', $char_d, '', '',
1613 'optionvalue', 'text', 'NULL', '', '', '',
1615 'primary_key' => 'optionnum',
1617 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1622 'ratenum', 'serial', '', '', '', '',
1623 'ratename', 'varchar', '', $char_d, '', '',
1625 'primary_key' => 'ratenum',
1632 'ratedetailnum', 'serial', '', '', '', '',
1633 'ratenum', 'int', '', '', '', '',
1634 'orig_regionnum', 'int', 'NULL', '', '', '',
1635 'dest_regionnum', 'int', '', '', '', '',
1636 'min_included', 'int', '', '', '', '',
1637 #'min_charge', @money_type, '', '',
1638 'min_charge', 'decimal', '', '10,5', '', '',
1639 'sec_granularity', 'int', '', '', '', '',
1640 #time period (link to table of periods)?
1642 'primary_key' => 'ratedetailnum',
1643 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1644 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1649 'regionnum', 'serial', '', '', '', '',
1650 'regionname', 'varchar', '', $char_d, '', '',
1652 'primary_key' => 'regionnum',
1659 'prefixnum', 'serial', '', '', '', '',
1660 'regionnum', 'int', '', '',, '', '',
1661 'countrycode', 'varchar', '', 3, '', '',
1662 'npa', 'varchar', 'NULL', 6, '', '',
1663 'nxx', 'varchar', 'NULL', 3, '', '',
1665 'primary_key' => 'prefixnum',
1667 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1672 'codenum', 'serial', '', '', '', '',
1673 'code', 'varchar', '', $char_d, '', '',
1674 'agentnum', 'int', '', '', '', '',
1676 'primary_key' => 'codenum',
1677 'unique' => [ [ 'agentnum', 'code' ] ],
1678 'index' => [ [ 'agentnum' ] ],
1683 'codepkgnum', 'serial', '', '', '', '',
1684 'codenum', 'int', '', '', '', '',
1685 'pkgpart', 'int', '', '', '', '',
1687 'primary_key' => 'codepkgnum',
1688 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1689 'index' => [ [ 'codenum' ] ],
1692 'clientapi_session' => {
1694 'sessionnum', 'serial', '', '', '', '',
1695 'sessionid', 'varchar', '', $char_d, '', '',
1696 'namespace', 'varchar', '', $char_d, '', '',
1698 'primary_key' => 'sessionnum',
1699 'unique' => [ [ 'sessionid', 'namespace' ] ],
1703 'clientapi_session_field' => {
1705 'fieldnum', 'serial', '', '', '', '',
1706 'sessionnum', 'int', '', '', '', '',
1707 'fieldname', 'varchar', '', $char_d, '', '',
1708 'fieldvalue', 'text', 'NULL', '', '', '',
1710 'primary_key' => 'fieldnum',
1711 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1715 'payment_gateway' => {
1717 'gatewaynum', 'serial', '', '', '', '',
1718 'gateway_module', 'varchar', '', $char_d, '', '',
1719 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1720 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1721 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1722 'disabled', 'char', 'NULL', 1, '', '',
1724 'primary_key' => 'gatewaynum',
1726 'index' => [ [ 'disabled' ] ],
1729 'payment_gateway_option' => {
1731 'optionnum', 'serial', '', '', '', '',
1732 'gatewaynum', 'int', '', '', '', '',
1733 'optionname', 'varchar', '', $char_d, '', '',
1734 'optionvalue', 'text', 'NULL', '', '', '',
1736 'primary_key' => 'optionnum',
1738 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1741 'agent_payment_gateway' => {
1743 'agentgatewaynum', 'serial', '', '', '', '',
1744 'agentnum', 'int', '', '', '', '',
1745 'gatewaynum', 'int', '', '', '', '',
1746 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1747 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1749 'primary_key' => 'agentgatewaynum',
1751 'index' => [ [ 'agentnum', 'cardtype' ], ],
1756 'bannum', 'serial', '', '', '', '',
1757 'payby', 'char', '', 4, '', '',
1758 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1759 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1760 '_date', @date_type, '', '',
1761 'otaker', 'varchar', '', 32, '', '',
1762 'reason', 'varchar', 'NULL', $char_d, '', '',
1764 'primary_key' => 'bannum',
1765 'unique' => [ [ 'payby', 'payinfo' ] ],
1771 'classnum', 'serial', '', '', '', '',
1772 'classname', 'varchar', '', $char_d, '', '',
1773 'disabled', 'char', 'NULL', 1, '', '',
1775 'primary_key' => 'classnum',
1777 'index' => [ ['disabled'] ],
1782 # qw( name type null length default local );
1788 'acctid', 'bigserial', '', '', '', '',
1789 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1790 'calldate', 'timestamp', '', '', \'now()', '',
1791 'clid', 'varchar', '', $char_d, \"''", '',
1792 'src', 'varchar', '', $char_d, \"''", '',
1793 'dst', 'varchar', '', $char_d, \"''", '',
1794 'dcontext', 'varchar', '', $char_d, \"''", '',
1795 'channel', 'varchar', '', $char_d, \"''", '',
1796 'dstchannel', 'varchar', '', $char_d, \"''", '',
1797 'lastapp', 'varchar', '', $char_d, \"''", '',
1798 'lastdata', 'varchar', '', $char_d, \"''", '',
1800 #these don't seem to be logged by most of the SQL cdr_* modules
1801 #except tds under sql-illegal names, so;
1802 # ... don't rely on them for rating?
1803 # and, what they hey, i went ahead and changed the names and data types
1804 # to freeside-style dates...
1805 #'start', 'timestamp', 'NULL', '', '', '',
1806 #'answer', 'timestamp', 'NULL', '', '', '',
1807 #'end', 'timestamp', 'NULL', '', '', '',
1808 'startdate', @date_type, '', '',
1809 'answerdate', @date_type, '', '',
1810 'enddate', @date_type, '', '',
1813 'duration', 'int', '', '', 0, '',
1814 'billsec', 'int', '', '', 0, '',
1815 'disposition', 'varchar', '', 45, \"''", '',
1816 'amaflags', 'int', '', '', 0, '',
1817 'accountcode', 'varchar', '', 20, \"''", '',
1818 'uniqueid', 'varchar', '', 32, \"''", '',
1819 'userfield', 'varchar', '', 255, \"''", '',
1822 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1826 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1827 'cdrtypenum', 'int', 'NULL', '', '', '',
1829 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1831 'upstream_currency', 'char', 'NULL', 3, '', '',
1832 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1833 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1835 # how it was rated internally...
1836 'ratedetailnum', 'int', 'NULL', '', '', '',
1837 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1839 'distance', 'decimal', 'NULL', '', '', '',
1840 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1842 #cdr_calltype: the big list in appendix 2
1843 'calltypenum', 'int', 'NULL', '', '', '',
1845 'description', 'varchar', 'NULL', $char_d, '', '',
1846 'quantity', 'int', 'NULL', '', '', '',
1848 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1849 'carrierid', 'int', 'NULL', '', '', '',
1851 'upstream_rateid', 'int', 'NULL', '', '', '',
1854 #and now for our own fields
1857 # a svcnum... right..?
1858 'svcnum', 'int', 'NULL', '', '', '',
1860 #NULL, done (or something)
1861 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1864 'primary_key' => 'acctid',
1866 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1871 'calltypenum', 'serial', '', '', '', '',
1872 'calltypename', 'varchar', '', $char_d, '', '',
1874 'primary_key' => 'calltypenum',
1881 'cdrtypenum' => 'serial', '', '', '', '',
1882 'cdrtypename' => 'varchar', '', $char_d, '', '',
1884 'primary_key' => 'cdrtypenum',
1891 'carrierid' => 'serial', '', '', '', '',
1892 'carriername' => 'varchar', '', $char_d, '', '',
1894 'primary_key' => 'carrierid',
1899 #map upstream rateid to ours...
1900 'cdr_upstream_rate' => {
1902 'upstreamratenum', 'serial', '', '', '', '',
1903 'upstream_rateid', 'varchar', '', $char_d, '', '',
1904 'ratedetailnum', 'int', 'NULL', '', '', '',
1906 'primary_key' => 'upstreamratenum', #XXX need a primary key
1907 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1911 'inventory_item' => {
1913 'itemnum', 'serial', '', '', '', '',
1914 'classnum', 'int', '', '', '', '',
1915 'item', 'varchar', '', $char_d, '', '',
1916 'svcnum', 'int', 'NULL', '', '', '',
1918 'primary_key' => 'itemnum',
1919 'unique' => [ [ 'classnum', 'item' ] ],
1920 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1923 'inventory_class' => {
1925 'classnum', 'serial', '', '', '', '',
1926 'classname', 'varchar', '', $char_d, '', '',
1928 'primary_key' => 'classnum',
1935 'usernum', 'serial', '', '', '', '',
1936 'username', 'varchar', '', $char_d, '', '',
1937 '_password', 'varchar', '', $char_d, '', '',
1938 'last', 'varchar', '', $char_d, '', '',
1939 'first', 'varchar', '', $char_d, '', '',
1940 'disabled', 'char', 'NULL', 1, '', '',
1942 'primary_key' => 'usernum',
1943 'unique' => [ [ 'username' ] ],
1947 'access_user_pref' => {
1949 'prefnum', 'serial', '', '', '', '',
1950 'usernum', 'int', '', '', '', '',
1951 'prefname', 'varchar', '', $char_d, '', '',
1952 'prefvalue', 'text', 'NULL', '', '', '',
1953 'expiration', @date_type, '', '',
1955 'primary_key' => 'prefnum',
1957 'index' => [ [ 'usernum' ] ],
1962 'groupnum', 'serial', '', '', '', '',
1963 'groupname', 'varchar', '', $char_d, '', '',
1965 'primary_key' => 'groupnum',
1966 'unique' => [ [ 'groupname' ] ],
1970 'access_usergroup' => {
1972 'usergroupnum', 'serial', '', '', '', '',
1973 'usernum', 'int', '', '', '', '',
1974 'groupnum', 'int', '', '', '', '',
1976 'primary_key' => 'usergroupnum',
1977 'unique' => [ [ 'usernum', 'groupnum' ] ],
1978 'index' => [ [ 'usernum' ] ],
1981 'access_groupagent' => {
1983 'groupagentnum', 'serial', '', '', '', '',
1984 'groupnum', 'int', '', '', '', '',
1985 'agentnum', 'int', '', '', '', '',
1987 'primary_key' => 'groupagentnum',
1988 'unique' => [ [ 'groupnum', 'agentnum' ] ],
1989 'index' => [ [ 'groupnum' ] ],
1994 'rightnum', 'serial', '', '', '', '',
1995 'righttype', 'varchar', '', $char_d, '', '',
1996 'rightobjnum', 'int', '', '', '', '',
1997 'rightname', 'varchar', '', $char_d, '', '',
1999 'primary_key' => 'rightnum',
2000 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2006 'svcnum', 'int', '', '', '', '',
2007 'countrycode', 'varchar', '', 3, '', '',
2008 'phonenum', 'varchar', '', 15, '', '', #12 ?
2009 'pin', 'varchar', 'NULL', $char_d, '', '',
2011 'primary_key' => 'svcnum',
2013 'index' => [ [ 'countrycode', 'phonenum' ] ],
2018 'typenum', 'serial', '', '', '', '',
2019 'class', 'char', '', 1, '', '',
2020 'type', 'varchar', '', $char_d, '', '',
2022 'primary_key' => 'typenum',
2029 'reasonnum', 'serial', '', '', '', '',
2030 'reason_type', 'int', '', '', '', '',
2031 'reason', 'text', '', '', '', '',
2032 'disabled', 'char', 'NULL', 1, '', '',
2034 'primary_key' => 'reasonnum',
2041 'confnum', 'serial', '', '', '', '',
2042 'agentnum', 'int', 'NULL', '', '', '',
2043 'name', 'varchar', '', $char_d, '', '',
2044 'value', 'text', 'NULL', '', '', '',
2046 'primary_key' => 'confnum',
2047 'unique' => [ [ 'agentnum', 'name' ]],
2053 'pkgrefnum', 'serial', '', '', '', '',
2054 'pkgnum', 'int', '', '', '', '',
2055 'refnum', 'int', '', '', '', '',
2057 'primary_key' => 'pkgrefnum',
2058 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2059 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2061 # name type nullability length default local
2065 # 'num', 'serial', '', '', '', '',
2067 # 'primary_key' => 'num',