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 $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
204 'name' => "h_${table}_srckey2",
206 'columns' => [ 'history_date',
207 $tableobj->primary_key,
211 my $h_tableobj = DBIx::DBSchema::Table->new( {
212 'name' => "h_$table",
213 'primary_key' => 'historynum',
214 'indices' => \%h_indices,
215 'local_options' => $local_options,
217 DBIx::DBSchema::Column->new( {
218 'name' => 'historynum',
220 'null' => 'NOT NULL',
225 DBIx::DBSchema::Column->new( {
226 'name' => 'history_date',
233 DBIx::DBSchema::Column->new( {
234 'name' => 'history_user',
236 'null' => 'NOT NULL',
241 DBIx::DBSchema::Column->new( {
242 'name' => 'history_action',
244 'null' => 'NOT NULL',
250 my $column = $tableobj->column($_);
252 #clone so as to not disturb the original
253 $column = DBIx::DBSchema::Column->new( {
254 map { $_ => $column->$_() }
255 qw( name type null length default local )
258 if ( $column->type =~ /^(\w*)SERIAL$/i ) {
259 $column->type('int');
260 $column->null('NULL');
262 #$column->default('')
263 # if $column->default =~ /^nextval\(/i;
264 #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
265 #$column->local($local);
270 $dbdef->addtable($h_tableobj);
273 if ( $datasrc =~ /^dbi:mysql/i ) {
275 my $dup_lock_table = DBIx::DBSchema::Table->new( {
276 'name' => 'duplicate_lock',
277 'primary_key' => 'duplocknum',
278 'local_options' => $local_options,
280 DBIx::DBSchema::Column->new( {
281 'name' => 'duplocknum',
283 'null' => 'NOT NULL',
288 DBIx::DBSchema::Column->new( {
289 'name' => 'lockname',
291 'null' => 'NOT NULL',
297 'indices' => { 'duplicate_lock1' =>
298 DBIx::DBSchema::Index->new({
299 'name' => 'duplicate_lock1',
301 'columns' => [ 'lockname' ],
306 $dbdef->addtable($dup_lock_table);
316 my $char_d = 80; #default maxlength for text fields
318 #my(@date_type) = ( 'timestamp', '', '' );
319 my @date_type = ( 'int', 'NULL', '' );
320 my @perl_type = ( 'text', 'NULL', '' );
321 my @money_type = ( 'decimal', '', '10,2' );
322 my @money_typen = ( 'decimal', 'NULL', '10,2' );
324 my $username_len = 32; #usernamemax config file
326 # name type nullability length default local
332 'agentnum', 'serial', '', '', '', '',
333 'agent', 'varchar', '', $char_d, '', '',
334 'typenum', 'int', '', '', '', '',
335 'disabled', 'char', 'NULL', 1, '', '',
336 'ticketing_queueid', 'int', 'NULL', '', '', '',
337 'invoice_template', 'varchar', 'NULL', $char_d, '', '',
338 'username', 'varchar', 'NULL', $char_d, '', '', #deprecated
339 '_password', 'varchar', 'NULL', $char_d, '', '', #deprecated
340 'freq', 'int', 'NULL', '', '', '', #deprecated (never used)
341 'prog', @perl_type, '', '', #deprecated (never used)
344 'primary_key' => 'agentnum',
346 'index' => [ ['typenum'], ['disabled'] ],
351 'typenum', 'serial', '', '', '', '',
352 'atype', 'varchar', '', $char_d, '', '',
354 'primary_key' => 'typenum',
361 'typepkgnum', 'serial', '', '', '', '',
362 'typenum', 'int', '', '', '', '',
363 'pkgpart', 'int', '', '', '', '',
365 'primary_key' => 'typepkgnum',
366 'unique' => [ ['typenum', 'pkgpart'] ],
367 'index' => [ ['typenum'] ],
372 'invnum', 'serial', '', '', '', '',
373 'custnum', 'int', '', '', '', '',
374 '_date', @date_type, '', '',
375 'charged', @money_type, '', '',
376 'printed', 'int', '', '', '', '',
377 'closed', 'char', 'NULL', 1, '', '',
379 'primary_key' => 'invnum',
381 'index' => [ ['custnum'], ['_date'] ],
384 'cust_bill_event' => {
386 'eventnum', 'serial', '', '', '', '',
387 'invnum', 'int', '', '', '', '',
388 'eventpart', 'int', '', '', '', '',
389 '_date', @date_type, '', '',
390 'status', 'varchar', '', $char_d, '', '',
391 'statustext', 'text', 'NULL', '', '', '',
393 'primary_key' => 'eventnum',
394 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
396 'index' => [ ['invnum'], ['status'] ],
399 'part_bill_event' => {
401 'eventpart', 'serial', '', '', '', '',
402 'freq', 'varchar', 'NULL', $char_d, '', '',
403 'payby', 'char', '', 4, '', '',
404 'event', 'varchar', '', $char_d, '', '',
405 'eventcode', @perl_type, '', '',
406 'seconds', 'int', 'NULL', '', '', '',
407 'weight', 'int', '', '', '', '',
408 'plan', 'varchar', 'NULL', $char_d, '', '',
409 'plandata', 'text', 'NULL', '', '', '',
410 'reason', 'int', 'NULL', '', '', '',
411 'disabled', 'char', 'NULL', 1, '', '',
413 'primary_key' => 'eventpart',
415 'index' => [ ['payby'], ['disabled'], ],
420 'eventpart', 'serial', '', '', '', '',
421 'agentnum', 'int', 'NULL', '', '', '',
422 'event', 'varchar', '', $char_d, '', '',
423 'eventtable', 'varchar', '', $char_d, '', '',
424 'check_freq', 'varchar', 'NULL', $char_d, '', '',
425 'weight', 'int', '', '', '', '',
426 'action', 'varchar', '', $char_d, '', '',
427 'disabled', 'char', 'NULL', 1, '', '',
429 'primary_key' => 'eventpart',
431 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
434 'part_event_option' => {
436 'optionnum', 'serial', '', '', '', '',
437 'eventpart', 'int', '', '', '', '',
438 'optionname', 'varchar', '', $char_d, '', '',
439 'optionvalue', 'text', 'NULL', '', '', '',
441 'primary_key' => 'optionnum',
443 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
446 'part_event_condition' => {
448 'eventconditionnum', 'serial', '', '', '', '',
449 'eventpart', 'int', '', '', '', '',
450 'conditionname', 'varchar', '', $char_d, '', '',
452 'primary_key' => 'eventconditionnum',
454 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
457 'part_event_condition_option' => {
459 'optionnum', 'serial', '', '', '', '',
460 'eventconditionnum', 'int', '', '', '', '',
461 'optionname', 'varchar', '', $char_d, '', '',
462 'optionvalue', 'text', 'NULL', '', '', '',
464 'primary_key' => 'optionnum',
466 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
469 'part_event_condition_option_option' => {
471 'optionoptionnum', 'serial', '', '', '', '',
472 'optionnum', 'int', '', '', '', '',
473 'optionname', 'varchar', '', $char_d, '', '',
474 'optionvalue', 'text', 'NULL', '', '', '',
476 'primary_key' => 'optionoptionnum',
478 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
483 'eventnum', 'serial', '', '', '', '',
484 'eventpart', 'int', '', '', '', '',
485 'tablenum', 'int', '', '', '', '',
486 '_date', @date_type, '', '',
487 'status', 'varchar', '', $char_d, '', '',
488 'statustext', 'text', 'NULL', '', '', '',
490 'primary_key' => 'eventnum',
491 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
493 'index' => [ ['eventpart'], ['tablenum'], ['status'] ],
498 'billpkgnum', 'serial', '', '', '', '',
499 'pkgnum', 'int', '', '', '', '',
500 'pkgpart_override', 'int', 'NULL', '', '', '',
501 'invnum', 'int', '', '', '', '',
502 'setup', @money_type, '', '',
503 'recur', @money_type, '', '',
504 'sdate', @date_type, '', '',
505 'edate', @date_type, '', '',
506 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
507 'section', 'varchar', 'NULL', $char_d, '', '',
508 'quantity', 'int', 'NULL', '', '', '',
509 'unitsetup', @money_typen, '', '',
510 'unitrecur', @money_typen, '', '',
512 'primary_key' => 'billpkgnum',
514 'index' => [ ['invnum'], [ 'pkgnum' ] ],
517 'cust_bill_pkg_detail' => {
519 'detailnum', 'serial', '', '', '', '',
520 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
521 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
522 'invnum', 'int', 'NULL', '', '', '', # deprecated
523 'amount', @money_typen, '', '',
524 'format', 'char', 'NULL', 1, '', '',
525 'classnum', 'char', 'NULL', 1, '', '',
526 'detail', 'varchar', '', $char_d, '', '',
528 'primary_key' => 'detailnum',
530 'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
533 'cust_bill_pkg_display' => {
535 'billpkgdisplaynum', 'serial', '', '', '', '',
536 'billpkgnum', 'int', '', '', '', '',
537 'section', 'varchar', 'NULL', $char_d, '', '',
538 #'unitsetup', @money_typen, '', '', #override the linked real one?
539 #'unitrecur', @money_typen, '', '', #this too?
540 'post_total', 'char', 'NULL', 1, '', '',
541 'type', 'char', 'NULL', 1, '', '',
542 'summary', 'char', 'NULL', 1, '', '',
544 'primary_key' => 'billpkgdisplaynum',
546 'index' => [ ['billpkgnum'], ],
551 'crednum', 'serial', '', '', '', '',
552 'custnum', 'int', '', '', '', '',
553 '_date', @date_type, '', '',
554 'amount', @money_type, '', '',
555 'otaker', 'varchar', '', 32, '', '',
556 'reason', 'text', 'NULL', '', '', '',
557 'reasonnum', 'int', 'NULL', '', '', '',
558 'closed', 'char', 'NULL', 1, '', '',
560 'primary_key' => 'crednum',
562 'index' => [ ['custnum'], ['_date'] ],
565 'cust_credit_bill' => {
567 'creditbillnum', 'serial', '', '', '', '',
568 'crednum', 'int', '', '', '', '',
569 'invnum', 'int', '', '', '', '',
570 '_date', @date_type, '', '',
571 'amount', @money_type, '', '',
573 'primary_key' => 'creditbillnum',
575 'index' => [ ['crednum'], ['invnum'] ],
578 'cust_credit_bill_pkg' => {
580 'creditbillpkgnum', 'serial', '', '', '', '',
581 'creditbillnum', 'int', '', '', '', '',
582 'billpkgnum', 'int', '', '', '', '',
583 'amount', @money_type, '', '',
584 'setuprecur', 'varchar', '', $char_d, '', '',
585 'sdate', @date_type, '', '',
586 'edate', @date_type, '', '',
588 'primary_key' => 'creditbillpkgnum',
590 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
595 'custnum', 'serial', '', '', '', '',
596 'agentnum', 'int', '', '', '', '',
597 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
598 'custbatch', 'varchar', 'NULL', $char_d, '', '',
599 # 'titlenum', 'int', 'NULL', '', '', '',
600 'last', 'varchar', '', $char_d, '', '',
601 # 'middle', 'varchar', 'NULL', $char_d, '', '',
602 'first', 'varchar', '', $char_d, '', '',
603 'ss', 'varchar', 'NULL', 11, '', '',
604 'stateid', 'varchar', 'NULL', $char_d, '', '',
605 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
606 'birthdate' ,@date_type, '', '',
607 'signupdate',@date_type, '', '',
608 'dundate', @date_type, '', '',
609 'company', 'varchar', 'NULL', $char_d, '', '',
610 'address1', 'varchar', '', $char_d, '', '',
611 'address2', 'varchar', 'NULL', $char_d, '', '',
612 'city', 'varchar', '', $char_d, '', '',
613 'county', 'varchar', 'NULL', $char_d, '', '',
614 'state', 'varchar', 'NULL', $char_d, '', '',
615 'zip', 'varchar', 'NULL', 10, '', '',
616 'country', 'char', '', 2, '', '',
617 'daytime', 'varchar', 'NULL', 20, '', '',
618 'night', 'varchar', 'NULL', 20, '', '',
619 'fax', 'varchar', 'NULL', 12, '', '',
620 'ship_last', 'varchar', 'NULL', $char_d, '', '',
621 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
622 'ship_first', 'varchar', 'NULL', $char_d, '', '',
623 'ship_company', 'varchar', 'NULL', $char_d, '', '',
624 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
625 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
626 'ship_city', 'varchar', 'NULL', $char_d, '', '',
627 'ship_county', 'varchar', 'NULL', $char_d, '', '',
628 'ship_state', 'varchar', 'NULL', $char_d, '', '',
629 'ship_zip', 'varchar', 'NULL', 10, '', '',
630 'ship_country', 'char', 'NULL', 2, '', '',
631 'ship_daytime', 'varchar', 'NULL', 20, '', '',
632 'ship_night', 'varchar', 'NULL', 20, '', '',
633 'ship_fax', 'varchar', 'NULL', 12, '', '',
634 'payby', 'char', '', 4, '', '',
635 'payinfo', 'varchar', 'NULL', 512, '', '',
636 'paycvv', 'varchar', 'NULL', 512, '', '',
637 'paymask', 'varchar', 'NULL', $char_d, '', '',
638 #'paydate', @date_type, '', '',
639 'paydate', 'varchar', 'NULL', 10, '', '',
640 'paystart_month', 'int', 'NULL', '', '', '',
641 'paystart_year', 'int', 'NULL', '', '', '',
642 'payissue', 'varchar', 'NULL', 2, '', '',
643 'payname', 'varchar', 'NULL', $char_d, '', '',
644 'paystate', 'varchar', 'NULL', $char_d, '', '',
645 'paytype', 'varchar', 'NULL', $char_d, '', '',
646 'payip', 'varchar', 'NULL', 15, '', '',
647 'tax', 'char', 'NULL', 1, '', '',
648 'otaker', 'varchar', '', 32, '', '',
649 'refnum', 'int', '', '', '', '',
650 'referral_custnum', 'int', 'NULL', '', '', '',
651 'comments', 'text', 'NULL', '', '', '',
652 'spool_cdr','char', 'NULL', 1, '', '',
653 'squelch_cdr','char', 'NULL', 1, '', '',
654 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
656 'primary_key' => 'custnum',
657 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
658 #'index' => [ ['last'], ['company'] ],
659 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
660 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
661 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
662 [ 'ship_last' ], [ 'ship_company' ],
663 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
664 [ 'payby' ], [ 'paydate' ],
665 [ 'agentnum' ], [ 'custbatch' ],
669 'cust_main_invoice' => {
671 'destnum', 'serial', '', '', '', '',
672 'custnum', 'int', '', '', '', '',
673 'dest', 'varchar', '', $char_d, '', '',
675 'primary_key' => 'destnum',
677 'index' => [ ['custnum'], ],
680 'cust_main_note' => {
682 'notenum', 'serial', '', '', '', '',
683 'custnum', 'int', '', '', '', '',
684 '_date', @date_type, '', '',
685 'otaker', 'varchar', '', 32, '', '',
686 'comments', 'text', 'NULL', '', '', '',
688 'primary_key' => 'notenum',
690 'index' => [ [ 'custnum' ], [ '_date' ], ],
693 'cust_main_county' => { #county+state+country are checked off the
694 #cust_main_county for validation and to provide
697 'taxnum', 'serial', '', '', '', '',
698 'state', 'varchar', 'NULL', $char_d, '', '',
699 'county', 'varchar', 'NULL', $char_d, '', '',
700 'country', 'char', '', 2, '', '',
701 'taxclass', 'varchar', 'NULL', $char_d, '', '',
702 'exempt_amount', @money_type, '', '',
703 'tax', 'real', '', '', '', '', #tax %
704 'taxname', 'varchar', 'NULL', $char_d, '', '',
705 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
706 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
708 'primary_key' => 'taxnum',
710 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
711 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
716 'taxnum', 'serial', '', '', '', '',
717 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
718 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
719 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
720 'taxclassnum', 'int', '', '', '', '',
721 'effective_date', @date_type, '', '',
722 'tax', 'real', '', '', '', '', # tax %
723 'excessrate', 'real', 'NULL','', '', '', # second tax %
724 'taxbase', @money_typen, '', '', # amount at first tax rate
725 'taxmax', @money_typen, '', '', # maximum about at both rates
726 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
727 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
728 'unittype', 'int', 'NULL', '', '', '', # for fee
729 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
730 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
731 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
732 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
733 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
734 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
735 'taxauth', 'int', 'NULL', '', '', '', # tax authority
736 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
737 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
738 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
739 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
740 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
741 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
742 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
744 'primary_key' => 'taxnum',
746 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
749 'cust_tax_location' => {
751 'custlocationnum', 'serial', '', '', '', '',
752 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
753 'zip', 'char', '', 5, '', '',
754 'state', 'char', '', 2, '', '',
755 'plus4hi', 'char', '', 4, '', '',
756 'plus4lo', 'char', '', 4, '', '',
757 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
758 'geocode', 'varchar', '', 20, '', '',
760 'primary_key' => 'custlocationnum',
762 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
767 'taxclassnum', 'serial', '', '', '', '',
768 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
769 'taxclass', 'varchar', '', $char_d, '', '',
770 'description', 'varchar', '', 2*$char_d, '', '',
772 'primary_key' => 'taxclassnum',
773 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
777 'cust_pay_pending' => {
779 'paypendingnum','serial', '', '', '', '',
780 'custnum', 'int', '', '', '', '',
781 'paid', @money_type, '', '',
782 '_date', @date_type, '', '',
783 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
784 # be index into payby
786 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
787 'paymask', 'varchar', 'NULL', $char_d, '', '',
788 'paydate', 'varchar', 'NULL', 10, '', '',
789 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
790 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
792 'status', 'varchar', '', $char_d, '', '',
793 'statustext', 'text', 'NULL', '', '', '',
794 'gatewaynum', 'int', 'NULL', '', '', '',
795 #'cust_balance', @money_type, '', '',
796 'paynum', 'int', 'NULL', '', '', '',
798 'primary_key' => 'paypendingnum',
799 'unique' => [ [ 'payunique' ] ],
800 'index' => [ [ 'custnum' ], [ 'status' ], ],
805 'paynum', 'serial', '', '', '', '',
806 'custnum', 'int', '', '', '', '',
807 '_date', @date_type, '', '',
808 'paid', @money_type, '', '',
809 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
810 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
811 # index into payby table
813 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
814 'paymask', 'varchar', 'NULL', $char_d, '', '',
815 'paydate', 'varchar', 'NULL', 10, '', '',
816 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
817 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
818 'closed', 'char', 'NULL', 1, '', '',
820 'primary_key' => 'paynum',
821 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
822 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
827 'paynum', 'int', '', '', '', '',
828 'custnum', 'int', '', '', '', '',
829 'paid', @money_type, '', '',
830 '_date', @date_type, '', '',
831 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
832 # index into payby table
834 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
835 'paymask', 'varchar', 'NULL', $char_d, '', '',
836 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
837 'closed', 'char', 'NULL', 1, '', '',
838 'void_date', @date_type, '', '',
839 'reason', 'varchar', 'NULL', $char_d, '', '',
840 'otaker', 'varchar', '', 32, '', '',
842 'primary_key' => 'paynum',
844 'index' => [ [ 'custnum' ] ],
849 'billpaynum', 'serial', '', '', '', '',
850 'invnum', 'int', '', '', '', '',
851 'paynum', 'int', '', '', '', '',
852 'amount', @money_type, '', '',
853 '_date', @date_type, '', '',
855 'primary_key' => 'billpaynum',
857 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
860 'cust_bill_pay_batch' => {
862 'billpaynum', 'serial', '', '', '', '',
863 'invnum', 'int', '', '', '', '',
864 'paybatchnum', 'int', '', '', '', '',
865 'amount', @money_type, '', '',
866 '_date', @date_type, '', '',
868 'primary_key' => 'billpaynum',
870 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
873 'cust_bill_pay_pkg' => {
875 'billpaypkgnum', 'serial', '', '', '', '',
876 'billpaynum', 'int', '', '', '', '',
877 'billpkgnum', 'int', '', '', '', '',
878 'amount', @money_type, '', '',
879 'setuprecur', 'varchar', '', $char_d, '', '',
880 'sdate', @date_type, '', '',
881 'edate', @date_type, '', '',
883 'primary_key' => 'billpaypkgnum',
885 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
888 'pay_batch' => { #batches of payments to an external processor
890 'batchnum', 'serial', '', '', '', '',
891 'payby', 'char', '', 4, '', '', # CARD/CHEK
892 'status', 'char', 'NULL', 1, '', '',
893 'download', @date_type, '', '',
894 'upload', @date_type, '', '',
896 'primary_key' => 'batchnum',
901 'cust_pay_batch' => { #what's this used for again? list of customers
902 #in current CARD batch? (necessarily CARD?)
904 'paybatchnum', 'serial', '', '', '', '',
905 'batchnum', 'int', '', '', '', '',
906 'invnum', 'int', '', '', '', '',
907 'custnum', 'int', '', '', '', '',
908 'last', 'varchar', '', $char_d, '', '',
909 'first', 'varchar', '', $char_d, '', '',
910 'address1', 'varchar', '', $char_d, '', '',
911 'address2', 'varchar', 'NULL', $char_d, '', '',
912 'city', 'varchar', '', $char_d, '', '',
913 'state', 'varchar', 'NULL', $char_d, '', '',
914 'zip', 'varchar', 'NULL', 10, '', '',
915 'country', 'char', '', 2, '', '',
916 # 'trancode', 'int', '', '', '', ''
917 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
918 'payinfo', 'varchar', '', 512, '', '',
919 #'exp', @date_type, '', ''
920 'exp', 'varchar', 'NULL', 11, '', '',
921 'payname', 'varchar', 'NULL', $char_d, '', '',
922 'amount', @money_type, '', '',
923 'status', 'varchar', 'NULL', $char_d, '', '',
925 'primary_key' => 'paybatchnum',
927 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
932 'pkgnum', 'serial', '', '', '', '',
933 'custnum', 'int', '', '', '', '',
934 'pkgpart', 'int', '', '', '', '',
935 'otaker', 'varchar', '', 32, '', '',
936 'setup', @date_type, '', '',
937 'bill', @date_type, '', '',
938 'last_bill', @date_type, '', '',
939 'susp', @date_type, '', '',
940 'adjourn', @date_type, '', '',
941 'cancel', @date_type, '', '',
942 'expire', @date_type, '', '',
943 'change_date', @date_type, '', '',
944 'change_pkgnum', 'int', 'NULL', '', '', '',
945 'change_pkgpart', 'int', 'NULL', '', '', '',
946 'manual_flag', 'char', 'NULL', 1, '', '',
947 'quantity', 'int', 'NULL', '', '', '',
949 'primary_key' => 'pkgnum',
951 'index' => [ ['custnum'], ['pkgpart'],
952 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
953 ['expire'], ['cancel'],
958 'cust_pkg_option' => {
960 'optionnum', 'serial', '', '', '', '',
961 'pkgnum', 'int', '', '', '', '',
962 'optionname', 'varchar', '', $char_d, '', '',
963 'optionvalue', 'text', 'NULL', '', '', '',
965 'primary_key' => 'optionnum',
967 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
970 'cust_pkg_detail' => {
972 'pkgdetailnum', 'serial', '', '', '', '',
973 'pkgnum', 'int', '', '', '', '',
974 'detail', 'varchar', '', $char_d, '', '',
975 'detailtype', 'char', '', 1, '', '', # "I"nvoice or "C"omment
976 'weight', 'int', '', '', '', '',
978 'primary_key' => 'pkgdetailnum',
980 'index' => [ [ 'pkgnum', 'detailtype' ] ],
983 'cust_pkg_reason' => {
985 'num', 'serial', '', '', '', '',
986 'pkgnum', 'int', '', '', '', '',
987 'reasonnum','int', '', '', '', '',
988 'action', 'char', 'NULL', 1, '', '', #should not be nullable
989 'otaker', 'varchar', '', 32, '', '',
990 'date', @date_type, '', '',
992 'primary_key' => 'num',
994 'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
999 'refundnum', 'serial', '', '', '', '',
1000 'custnum', 'int', '', '', '', '',
1001 '_date', @date_type, '', '',
1002 'refund', @money_type, '', '',
1003 'otaker', 'varchar', '', 32, '', '',
1004 'reason', 'varchar', '', $char_d, '', '',
1005 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
1006 # be index into payby
1008 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1009 'paymask', 'varchar', 'NULL', $char_d, '', '',
1010 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1011 'closed', 'char', 'NULL', 1, '', '',
1013 'primary_key' => 'refundnum',
1015 'index' => [ ['custnum'], ['_date'] ],
1018 'cust_credit_refund' => {
1020 'creditrefundnum', 'serial', '', '', '', '',
1021 'crednum', 'int', '', '', '', '',
1022 'refundnum', 'int', '', '', '', '',
1023 'amount', @money_type, '', '',
1024 '_date', @date_type, '', '',
1026 'primary_key' => 'creditrefundnum',
1028 'index' => [ ['crednum'], ['refundnum'] ],
1034 'svcnum', 'serial', '', '', '', '',
1035 'pkgnum', 'int', 'NULL', '', '', '',
1036 'svcpart', 'int', '', '', '', '',
1037 'overlimit', @date_type, '', '',
1039 'primary_key' => 'svcnum',
1041 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1044 'cust_svc_option' => {
1046 'optionnum', 'serial', '', '', '', '',
1047 'svcnum', 'int', '', '', '', '',
1048 'optionname', 'varchar', '', $char_d, '', '',
1049 'optionvalue', 'text', 'NULL', '', '', '',
1051 'primary_key' => 'optionnum',
1053 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1058 'pkgpart', 'serial', '', '', '', '',
1059 'pkg', 'varchar', '', $char_d, '', '',
1060 'comment', 'varchar', '', $char_d, '', '',
1061 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1062 'setup', @perl_type, '', '',
1063 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1064 'recur', @perl_type, '', '',
1065 'setuptax', 'char', 'NULL', 1, '', '',
1066 'recurtax', 'char', 'NULL', 1, '', '',
1067 'plan', 'varchar', 'NULL', $char_d, '', '',
1068 'plandata', 'text', 'NULL', '', '', '',
1069 'disabled', 'char', 'NULL', 1, '', '',
1070 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1071 'classnum', 'int', 'NULL', '', '', '',
1072 'taxproductnum', 'int', 'NULL', '', '', '',
1073 'pay_weight', 'real', 'NULL', '', '', '',
1074 'credit_weight', 'real', 'NULL', '', '', '',
1075 'agentnum', 'int', 'NULL', '', '', '',
1078 'primary_key' => 'pkgpart',
1080 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1083 'part_pkg_link' => {
1085 'pkglinknum', 'serial', '', '', '', '',
1086 'src_pkgpart', 'int', '', '', '', '',
1087 'dst_pkgpart', 'int', '', '', '', '',
1088 'link_type', 'varchar', '', $char_d, '', '',
1090 'primary_key' => 'pkglinknum',
1091 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1092 'index' => [ [ 'src_pkgpart' ] ],
1095 'part_pkg_taxclass' => {
1097 'taxclassnum', 'serial', '', '', '', '',
1098 'taxclass', 'varchar', '', $char_d, '', '',
1100 'primary_key' => 'taxclassnum',
1101 'unique' => [ [ 'taxclass' ] ],
1105 'part_pkg_taxproduct' => {
1107 'taxproductnum', 'serial', '', '', '', '',
1108 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1109 'taxproduct', 'varchar', '', $char_d, '', '',
1110 'description', 'varchar', '', 2*$char_d, '', '',
1112 'primary_key' => 'taxproductnum',
1113 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1117 'part_pkg_taxrate' => {
1119 'pkgtaxratenum', 'serial', '', '', '', '',
1120 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1121 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1122 'taxproductnum', 'int', '', '', '', '',
1123 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1124 'county', 'varchar', 'NULL', $char_d, '', '',
1125 'state', 'varchar', 'NULL', $char_d, '', '',
1126 'local', 'varchar', 'NULL', $char_d, '', '',
1127 'country', 'char', 'NULL', 2, '', '',
1128 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1129 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1130 'taxclassnum', 'int', 'NULL', '', '', '',
1131 'effdate', @date_type, '', '',
1132 'taxable', 'char', 'NULL', 1, '', '',
1134 'primary_key' => 'pkgtaxratenum',
1136 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1139 'part_pkg_taxoverride' => {
1141 'taxoverridenum', 'serial', '', '', '', '',
1142 'pkgpart', 'serial', '', '', '', '',
1143 'taxclassnum', 'serial', '', '', '', '',
1144 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1146 'primary_key' => 'taxoverridenum',
1148 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1153 # 'titlenum', 'int', '', '',
1154 # 'title', 'varchar', '', $char_d,
1156 # 'primary_key' => 'titlenum',
1157 # 'unique' => [ [] ],
1158 # 'index' => [ [] ],
1163 'pkgsvcnum', 'serial', '', '', '', '',
1164 'pkgpart', 'int', '', '', '', '',
1165 'svcpart', 'int', '', '', '', '',
1166 'quantity', 'int', '', '', '', '',
1167 'primary_svc','char', 'NULL', 1, '', '',
1169 'primary_key' => 'pkgsvcnum',
1170 'unique' => [ ['pkgpart', 'svcpart'] ],
1171 'index' => [ ['pkgpart'] ],
1174 'part_referral' => {
1176 'refnum', 'serial', '', '', '', '',
1177 'referral', 'varchar', '', $char_d, '', '',
1178 'disabled', 'char', 'NULL', 1, '', '',
1179 'agentnum', 'int', 'NULL', '', '', '',
1181 'primary_key' => 'refnum',
1183 'index' => [ ['disabled'], ['agentnum'], ],
1188 'svcpart', 'serial', '', '', '', '',
1189 'svc', 'varchar', '', $char_d, '', '',
1190 'svcdb', 'varchar', '', $char_d, '', '',
1191 'disabled', 'char', 'NULL', 1, '', '',
1193 'primary_key' => 'svcpart',
1195 'index' => [ [ 'disabled' ] ],
1198 'part_svc_column' => {
1200 'columnnum', 'serial', '', '', '', '',
1201 'svcpart', 'int', '', '', '', '',
1202 'columnname', 'varchar', '', 64, '', '',
1203 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1204 'columnflag', 'char', 'NULL', 1, '', '',
1206 'primary_key' => 'columnnum',
1207 'unique' => [ [ 'svcpart', 'columnname' ] ],
1208 'index' => [ [ 'svcpart' ] ],
1211 #(this should be renamed to part_pop)
1214 'popnum', 'serial', '', '', '', '',
1215 'city', 'varchar', '', $char_d, '', '',
1216 'state', 'varchar', '', $char_d, '', '',
1217 'ac', 'char', '', 3, '', '',
1218 'exch', 'char', '', 3, '', '',
1219 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1221 'primary_key' => 'popnum',
1223 'index' => [ [ 'state' ] ],
1226 'part_pop_local' => {
1228 'localnum', 'serial', '', '', '', '',
1229 'popnum', 'int', '', '', '', '',
1230 'city', 'varchar', 'NULL', $char_d, '', '',
1231 'state', 'char', 'NULL', 2, '', '',
1232 'npa', 'char', '', 3, '', '',
1233 'nxx', 'char', '', 3, '', '',
1235 'primary_key' => 'localnum',
1237 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1242 'svcnum', 'int', '', '', '', '',
1243 'username', 'varchar', '', $username_len, '', '',
1244 '_password', 'varchar', '', 512, '', '',
1245 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1246 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1247 'popnum', 'int', 'NULL', '', '', '',
1248 'uid', 'int', 'NULL', '', '', '',
1249 'gid', 'int', 'NULL', '', '', '',
1250 'finger', 'varchar', 'NULL', $char_d, '', '',
1251 'dir', 'varchar', 'NULL', $char_d, '', '',
1252 'shell', 'varchar', 'NULL', $char_d, '', '',
1253 'quota', 'varchar', 'NULL', $char_d, '', '',
1254 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1255 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1256 'seconds_threshold', 'int', 'NULL', '', '', '',
1257 'upbytes', 'bigint', 'NULL', '', '', '',
1258 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1259 'downbytes', 'bigint', 'NULL', '', '', '',
1260 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1261 'totalbytes','bigint', 'NULL', '', '', '',
1262 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1263 'domsvc', 'int', '', '', '', '',
1264 'last_login', @date_type, '', '',
1265 'last_logout', @date_type, '', '',
1267 'primary_key' => 'svcnum',
1268 #'unique' => [ [ 'username', 'domsvc' ] ],
1270 'index' => [ ['username'], ['domsvc'] ],
1273 'acct_rt_transaction' => {
1275 'svcrtid', 'int', '', '', '', '',
1276 'svcnum', 'int', '', '', '', '',
1277 'transaction_id', 'int', '', '', '', '',
1278 '_date', @date_type, '', '',
1279 'seconds', 'int', '', '', '', '', #uhhhh
1280 'support', 'int', '', '', '', '',
1282 'primary_key' => 'svcrtid',
1284 'index' => [ ['svcnum', 'transaction_id'] ],
1289 # 'svcnum', 'int', '', '',
1290 # 'amount', @money_type,
1292 # 'primary_key' => 'svcnum',
1293 # 'unique' => [ [] ],
1294 # 'index' => [ [] ],
1299 'svcnum', 'int', '', '', '', '',
1300 'domain', 'varchar', '', $char_d, '', '',
1301 'suffix', 'varchar', 'NULL', $char_d, '', '',
1302 'catchall', 'int', 'NULL', '', '', '',
1303 'parent_svcnum', 'int', 'NULL', '', '', '',
1304 'registrarnum', 'int', 'NULL', '', '', '',
1305 'registrarkey', 'varchar', 'NULL', 512, '', '',
1306 'setup_date', @date_type, '', '',
1307 'renewal_interval', 'int', 'NULL', '', '', '',
1308 'expiration_date', @date_type, '', '',
1310 'primary_key' => 'svcnum',
1312 'index' => [ ['domain'] ],
1315 'domain_record' => {
1317 'recnum', 'serial', '', '', '', '',
1318 'svcnum', 'int', '', '', '', '',
1319 'reczone', 'varchar', '', 255, '', '',
1320 'recaf', 'char', '', 2, '', '',
1321 'rectype', 'varchar', '', 5, '', '',
1322 'recdata', 'varchar', '', 255, '', '',
1324 'primary_key' => 'recnum',
1326 'index' => [ ['svcnum'] ],
1331 'registrarnum', 'serial', '', '', '', '',
1332 'registrarname', 'varchar', '', $char_d, '', '',
1334 'primary_key' => 'registrarnum',
1341 'svcnum', 'int', '', '', '', '',
1342 'srcsvc', 'int', 'NULL', '', '', '',
1343 'src', 'varchar', 'NULL', 255, '', '',
1344 'dstsvc', 'int', 'NULL', '', '', '',
1345 'dst', 'varchar', 'NULL', 255, '', '',
1347 'primary_key' => 'svcnum',
1349 'index' => [ ['srcsvc'], ['dstsvc'] ],
1354 'svcnum', 'int', '', '', '', '',
1355 'recnum', 'int', '', '', '', '',
1356 'usersvc', 'int', 'NULL', '', '', '',
1357 'config', 'text', 'NULL', '', '', '',
1359 'primary_key' => 'svcnum',
1366 # 'svcnum', 'int', '', '',
1367 # 'svcnum', 'int', '', '',
1368 # 'svcnum', 'int', '', '',
1369 # 'worker', 'varchar', '', $char_d,
1370 # '_date', @date_type,
1372 # 'primary_key' => 'svcnum',
1373 # 'unique' => [ [] ],
1374 # 'index' => [ [] ],
1377 'prepay_credit' => {
1379 'prepaynum', 'serial', '', '', '', '',
1380 'identifier', 'varchar', '', $char_d, '', '',
1381 'amount', @money_type, '', '',
1382 'seconds', 'int', 'NULL', '', '', '',
1383 'upbytes', 'bigint', 'NULL', '', '', '',
1384 'downbytes', 'bigint', 'NULL', '', '', '',
1385 'totalbytes', 'bigint', 'NULL', '', '', '',
1386 'agentnum', 'int', 'NULL', '', '', '',
1388 'primary_key' => 'prepaynum',
1389 'unique' => [ ['identifier'] ],
1395 'portnum', 'serial', '', '', '', '',
1396 'ip', 'varchar', 'NULL', 15, '', '',
1397 'nasport', 'int', 'NULL', '', '', '',
1398 'nasnum', 'int', '', '', '', '',
1400 'primary_key' => 'portnum',
1407 'nasnum', 'serial', '', '', '', '',
1408 'nas', 'varchar', '', $char_d, '', '',
1409 'nasip', 'varchar', '', 15, '', '',
1410 'nasfqdn', 'varchar', '', $char_d, '', '',
1411 'last', 'int', '', '', '', '',
1413 'primary_key' => 'nasnum',
1414 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1415 'index' => [ [ 'last' ] ],
1420 # 'sessionnum', 'serial', '', '', '', '',
1421 # 'portnum', 'int', '', '', '', '',
1422 # 'svcnum', 'int', '', '', '', '',
1423 # 'login', @date_type, '', '',
1424 # 'logout', @date_type, '', '',
1426 # 'primary_key' => 'sessionnum',
1428 # 'index' => [ [ 'portnum' ] ],
1433 'jobnum', 'serial', '', '', '', '',
1434 'job', 'text', '', '', '', '',
1435 '_date', 'int', '', '', '', '',
1436 'status', 'varchar', '', $char_d, '', '',
1437 'statustext', 'text', 'NULL', '', '', '',
1438 'svcnum', 'int', 'NULL', '', '', '',
1439 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1442 'primary_key' => 'jobnum',
1444 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1449 'argnum', 'serial', '', '', '', '',
1450 'jobnum', 'int', '', '', '', '',
1451 'arg', 'text', 'NULL', '', '', '',
1453 'primary_key' => 'argnum',
1455 'index' => [ [ 'jobnum' ] ],
1460 'dependnum', 'serial', '', '', '', '',
1461 'jobnum', 'int', '', '', '', '',
1462 'depend_jobnum', 'int', '', '', '', '',
1464 'primary_key' => 'dependnum',
1466 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1471 'exportsvcnum' => 'serial', '', '', '', '',
1472 'exportnum' => 'int', '', '', '', '',
1473 'svcpart' => 'int', '', '', '', '',
1475 'primary_key' => 'exportsvcnum',
1476 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1477 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1482 'exportnum', 'serial', '', '', '', '',
1483 'machine', 'varchar', '', $char_d, '', '',
1484 'exporttype', 'varchar', '', $char_d, '', '',
1485 'nodomain', 'char', 'NULL', 1, '', '',
1487 'primary_key' => 'exportnum',
1489 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1492 'part_export_option' => {
1494 'optionnum', 'serial', '', '', '', '',
1495 'exportnum', 'int', '', '', '', '',
1496 'optionname', 'varchar', '', $char_d, '', '',
1497 'optionvalue', 'text', 'NULL', '', '', '',
1499 'primary_key' => 'optionnum',
1501 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1504 'radius_usergroup' => {
1506 'usergroupnum', 'serial', '', '', '', '',
1507 'svcnum', 'int', '', '', '', '',
1508 'groupname', 'varchar', '', $char_d, '', '',
1510 'primary_key' => 'usergroupnum',
1512 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1517 'msgnum', 'serial', '', '', '', '',
1518 'msgcode', 'varchar', '', $char_d, '', '',
1519 'locale', 'varchar', '', 16, '', '',
1520 'msg', 'text', '', '', '', '',
1522 'primary_key' => 'msgnum',
1523 'unique' => [ [ 'msgcode', 'locale' ] ],
1527 'cust_tax_exempt' => {
1529 'exemptnum', 'serial', '', '', '', '',
1530 'custnum', 'int', '', '', '', '',
1531 'taxnum', 'int', '', '', '', '',
1532 'year', 'int', '', '', '', '',
1533 'month', 'int', '', '', '', '',
1534 'amount', @money_type, '', '',
1536 'primary_key' => 'exemptnum',
1537 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1541 'cust_tax_exempt_pkg' => {
1543 'exemptpkgnum', 'serial', '', '', '', '',
1544 #'custnum', 'int', '', '', '', ''
1545 'billpkgnum', 'int', '', '', '', '',
1546 'taxnum', 'int', '', '', '', '',
1547 'year', 'int', '', '', '', '',
1548 'month', 'int', '', '', '', '',
1549 'amount', @money_type, '', '',
1551 'primary_key' => 'exemptpkgnum',
1553 'index' => [ [ 'taxnum', 'year', 'month' ],
1561 'routernum', 'serial', '', '', '', '',
1562 'routername', 'varchar', '', $char_d, '', '',
1563 'svcnum', 'int', 'NULL', '', '', '',
1564 'agentnum', 'int', 'NULL', '', '', '',
1566 'primary_key' => 'routernum',
1571 'part_svc_router' => {
1573 'svcrouternum', 'serial', '', '', '', '',
1574 'svcpart', 'int', '', '', '', '',
1575 'routernum', 'int', '', '', '', '',
1577 'primary_key' => 'svcrouternum',
1584 'blocknum', 'serial', '', '', '', '',
1585 'routernum', 'int', '', '', '', '',
1586 'ip_gateway', 'varchar', '', 15, '', '',
1587 'ip_netmask', 'int', '', '', '', '',
1588 'agentnum', 'int', 'NULL', '', '', '',
1590 'primary_key' => 'blocknum',
1591 'unique' => [ [ 'blocknum', 'routernum' ] ],
1595 'svc_broadband' => {
1597 'svcnum', 'int', '', '', '', '',
1598 'description', 'varchar', 'NULL', $char_d, '', '',
1599 'blocknum', 'int', '', '', '', '',
1600 'speed_up', 'int', '', '', '', '',
1601 'speed_down', 'int', '', '', '', '',
1602 'ip_addr', 'varchar', '', 15, '', '',
1603 'mac_addr', 'varchar', 'NULL', 12, '', '',
1604 'authkey', 'varchar', 'NULL', 32, '', '',
1605 'latitude', 'decimal', 'NULL', '', '', '',
1606 'longitude', 'decimal', 'NULL', '', '', '',
1607 'altitude', 'decimal', 'NULL', '', '', '',
1608 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1610 'primary_key' => 'svcnum',
1615 'part_virtual_field' => {
1617 'vfieldpart', 'serial', '', '', '', '',
1618 'dbtable', 'varchar', '', 32, '', '',
1619 'name', 'varchar', '', 32, '', '',
1620 'check_block', 'text', 'NULL', '', '', '',
1621 'length', 'int', 'NULL', '', '', '',
1622 'list_source', 'text', 'NULL', '', '', '',
1623 'label', 'varchar', 'NULL', 80, '', '',
1625 'primary_key' => 'vfieldpart',
1630 'virtual_field' => {
1632 'vfieldnum', 'serial', '', '', '', '',
1633 'recnum', 'int', '', '', '', '',
1634 'vfieldpart', 'int', '', '', '', '',
1635 'value', 'varchar', '', 128, '', '',
1637 'primary_key' => 'vfieldnum',
1638 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1644 'snarfnum', 'int', '', '', '', '',
1645 'svcnum', 'int', '', '', '', '',
1646 'machine', 'varchar', '', 255, '', '',
1647 'protocol', 'varchar', '', $char_d, '', '',
1648 'username', 'varchar', '', $char_d, '', '',
1649 '_password', 'varchar', '', $char_d, '', '',
1651 'primary_key' => 'snarfnum',
1653 'index' => [ [ 'svcnum' ] ],
1658 'svcnum', 'int', '', '', '', '',
1659 'id', 'int', 'NULL', '', '', '',
1660 'title', 'varchar', 'NULL', $char_d, '', '',
1662 'primary_key' => 'svcnum',
1667 'cust_pay_refund' => {
1669 'payrefundnum', 'serial', '', '', '', '',
1670 'paynum', 'int', '', '', '', '',
1671 'refundnum', 'int', '', '', '', '',
1672 '_date', @date_type, '', '',
1673 'amount', @money_type, '', '',
1675 'primary_key' => 'payrefundnum',
1677 'index' => [ ['paynum'], ['refundnum'] ],
1680 'part_pkg_option' => {
1682 'optionnum', 'serial', '', '', '', '',
1683 'pkgpart', 'int', '', '', '', '',
1684 'optionname', 'varchar', '', $char_d, '', '',
1685 'optionvalue', 'text', 'NULL', '', '', '',
1687 'primary_key' => 'optionnum',
1689 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1694 'ratenum', 'serial', '', '', '', '',
1695 'ratename', 'varchar', '', $char_d, '', '',
1697 'primary_key' => 'ratenum',
1704 'ratedetailnum', 'serial', '', '', '', '',
1705 'ratenum', 'int', '', '', '', '',
1706 'orig_regionnum', 'int', 'NULL', '', '', '',
1707 'dest_regionnum', 'int', '', '', '', '',
1708 'min_included', 'int', '', '', '', '',
1709 #'min_charge', @money_type, '', '',
1710 'min_charge', 'decimal', '', '10,5', '', '',
1711 'sec_granularity', 'int', '', '', '', '',
1712 #time period (link to table of periods)?
1713 'classnum', 'int', 'NULL', '', '', '',
1715 'primary_key' => 'ratedetailnum',
1716 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1717 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1722 'regionnum', 'serial', '', '', '', '',
1723 'regionname', 'varchar', '', $char_d, '', '',
1725 'primary_key' => 'regionnum',
1732 'prefixnum', 'serial', '', '', '', '',
1733 'regionnum', 'int', '', '',, '', '',
1734 'countrycode', 'varchar', '', 3, '', '',
1735 'npa', 'varchar', 'NULL', 6, '', '',
1736 'nxx', 'varchar', 'NULL', 3, '', '',
1738 'primary_key' => 'prefixnum',
1740 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1745 'classnum', 'serial', '', '', '', '',
1746 'classname', 'varchar', '', $char_d, '', '',
1747 'disabled', 'char', 'NULL', 1, '', '',
1749 'primary_key' => 'classnum',
1751 'index' => [ ['disabled'] ],
1756 'codenum', 'serial', '', '', '', '',
1757 'code', 'varchar', '', $char_d, '', '',
1758 'agentnum', 'int', '', '', '', '',
1760 'primary_key' => 'codenum',
1761 'unique' => [ [ 'agentnum', 'code' ] ],
1762 'index' => [ [ 'agentnum' ] ],
1767 'codepkgnum', 'serial', '', '', '', '',
1768 'codenum', 'int', '', '', '', '',
1769 'pkgpart', 'int', '', '', '', '',
1771 'primary_key' => 'codepkgnum',
1772 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1773 'index' => [ [ 'codenum' ] ],
1776 'clientapi_session' => {
1778 'sessionnum', 'serial', '', '', '', '',
1779 'sessionid', 'varchar', '', $char_d, '', '',
1780 'namespace', 'varchar', '', $char_d, '', '',
1782 'primary_key' => 'sessionnum',
1783 'unique' => [ [ 'sessionid', 'namespace' ] ],
1787 'clientapi_session_field' => {
1789 'fieldnum', 'serial', '', '', '', '',
1790 'sessionnum', 'int', '', '', '', '',
1791 'fieldname', 'varchar', '', $char_d, '', '',
1792 'fieldvalue', 'text', 'NULL', '', '', '',
1794 'primary_key' => 'fieldnum',
1795 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1799 'payment_gateway' => {
1801 'gatewaynum', 'serial', '', '', '', '',
1802 'gateway_module', 'varchar', '', $char_d, '', '',
1803 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1804 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1805 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1806 'disabled', 'char', 'NULL', 1, '', '',
1808 'primary_key' => 'gatewaynum',
1810 'index' => [ [ 'disabled' ] ],
1813 'payment_gateway_option' => {
1815 'optionnum', 'serial', '', '', '', '',
1816 'gatewaynum', 'int', '', '', '', '',
1817 'optionname', 'varchar', '', $char_d, '', '',
1818 'optionvalue', 'text', 'NULL', '', '', '',
1820 'primary_key' => 'optionnum',
1822 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1825 'agent_payment_gateway' => {
1827 'agentgatewaynum', 'serial', '', '', '', '',
1828 'agentnum', 'int', '', '', '', '',
1829 'gatewaynum', 'int', '', '', '', '',
1830 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1831 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1833 'primary_key' => 'agentgatewaynum',
1835 'index' => [ [ 'agentnum', 'cardtype' ], ],
1840 'bannum', 'serial', '', '', '', '',
1841 'payby', 'char', '', 4, '', '',
1842 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1843 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1844 '_date', @date_type, '', '',
1845 'otaker', 'varchar', '', 32, '', '',
1846 'reason', 'varchar', 'NULL', $char_d, '', '',
1848 'primary_key' => 'bannum',
1849 'unique' => [ [ 'payby', 'payinfo' ] ],
1855 'categorynum', 'serial', '', '', '', '',
1856 'categoryname', 'varchar', '', $char_d, '', '',
1857 'disabled', 'char', 'NULL', 1, '', '',
1859 'primary_key' => 'categorynum',
1861 'index' => [ ['disabled'] ],
1866 'classnum', 'serial', '', '', '', '',
1867 'classname', 'varchar', '', $char_d, '', '',
1868 'categorynum', 'int', 'NULL', '', '', '',
1869 'disabled', 'char', 'NULL', 1, '', '',
1871 'primary_key' => 'classnum',
1873 'index' => [ ['disabled'] ],
1878 # qw( name type null length default local );
1884 'acctid', 'bigserial', '', '', '', '',
1885 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1886 'calldate', 'timestamp', '', '', \'now()', '',
1887 'clid', 'varchar', '', $char_d, \"''", '',
1888 'src', 'varchar', '', $char_d, \"''", '',
1889 'dst', 'varchar', '', $char_d, \"''", '',
1890 'dcontext', 'varchar', '', $char_d, \"''", '',
1891 'channel', 'varchar', '', $char_d, \"''", '',
1892 'dstchannel', 'varchar', '', $char_d, \"''", '',
1893 'lastapp', 'varchar', '', $char_d, \"''", '',
1894 'lastdata', 'varchar', '', $char_d, \"''", '',
1896 #these don't seem to be logged by most of the SQL cdr_* modules
1897 #except tds under sql-illegal names, so;
1898 # ... don't rely on them for rating?
1899 # and, what they hey, i went ahead and changed the names and data types
1900 # to freeside-style dates...
1901 #'start', 'timestamp', 'NULL', '', '', '',
1902 #'answer', 'timestamp', 'NULL', '', '', '',
1903 #'end', 'timestamp', 'NULL', '', '', '',
1904 'startdate', @date_type, '', '',
1905 'answerdate', @date_type, '', '',
1906 'enddate', @date_type, '', '',
1909 'duration', 'int', '', '', 0, '',
1910 'billsec', 'int', '', '', 0, '',
1911 'disposition', 'varchar', '', 45, \"''", '',
1912 'amaflags', 'int', '', '', 0, '',
1913 'accountcode', 'varchar', '', 20, \"''", '',
1914 'uniqueid', 'varchar', '', 32, \"''", '',
1915 'userfield', 'varchar', '', 255, \"''", '',
1918 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1922 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1923 'cdrtypenum', 'int', 'NULL', '', '', '',
1925 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1927 'upstream_currency', 'char', 'NULL', 3, '', '',
1928 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1929 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1931 # how it was rated internally...
1932 'ratedetailnum', 'int', 'NULL', '', '', '',
1933 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1935 'distance', 'decimal', 'NULL', '', '', '',
1936 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1938 #cdr_calltype: the big list in appendix 2
1939 'calltypenum', 'int', 'NULL', '', '', '',
1941 'description', 'varchar', 'NULL', $char_d, '', '',
1942 'quantity', 'int', 'NULL', '', '', '',
1944 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1945 'carrierid', 'int', 'NULL', '', '', '',
1947 'upstream_rateid', 'int', 'NULL', '', '', '',
1950 #and now for our own fields
1953 # a svcnum... right..?
1954 'svcnum', 'int', 'NULL', '', '', '',
1956 #NULL, done (or something)
1957 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1959 'cdrbatch', 'varchar', 'NULL', $char_d, '', '',
1962 'primary_key' => 'acctid',
1964 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'cdrbatch' ], ],
1969 'calltypenum', 'serial', '', '', '', '',
1970 'calltypename', 'varchar', '', $char_d, '', '',
1972 'primary_key' => 'calltypenum',
1979 'cdrtypenum' => 'serial', '', '', '', '',
1980 'cdrtypename' => 'varchar', '', $char_d, '', '',
1982 'primary_key' => 'cdrtypenum',
1989 'carrierid' => 'serial', '', '', '', '',
1990 'carriername' => 'varchar', '', $char_d, '', '',
1992 'primary_key' => 'carrierid',
1997 #map upstream rateid to ours...
1998 'cdr_upstream_rate' => {
2000 'upstreamratenum', 'serial', '', '', '', '',
2001 'upstream_rateid', 'varchar', '', $char_d, '', '',
2002 'ratedetailnum', 'int', 'NULL', '', '', '',
2004 'primary_key' => 'upstreamratenum', #XXX need a primary key
2005 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2009 'inventory_item' => {
2011 'itemnum', 'serial', '', '', '', '',
2012 'classnum', 'int', '', '', '', '',
2013 'item', 'varchar', '', $char_d, '', '',
2014 'svcnum', 'int', 'NULL', '', '', '',
2016 'primary_key' => 'itemnum',
2017 'unique' => [ [ 'classnum', 'item' ] ],
2018 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2021 'inventory_class' => {
2023 'classnum', 'serial', '', '', '', '',
2024 'classname', 'varchar', '', $char_d, '', '',
2026 'primary_key' => 'classnum',
2033 'usernum', 'serial', '', '', '', '',
2034 'username', 'varchar', '', $char_d, '', '',
2035 '_password', 'varchar', '', $char_d, '', '',
2036 'last', 'varchar', '', $char_d, '', '',
2037 'first', 'varchar', '', $char_d, '', '',
2038 'disabled', 'char', 'NULL', 1, '', '',
2040 'primary_key' => 'usernum',
2041 'unique' => [ [ 'username' ] ],
2045 'access_user_pref' => {
2047 'prefnum', 'serial', '', '', '', '',
2048 'usernum', 'int', '', '', '', '',
2049 'prefname', 'varchar', '', $char_d, '', '',
2050 'prefvalue', 'text', 'NULL', '', '', '',
2051 'expiration', @date_type, '', '',
2053 'primary_key' => 'prefnum',
2055 'index' => [ [ 'usernum' ] ],
2060 'groupnum', 'serial', '', '', '', '',
2061 'groupname', 'varchar', '', $char_d, '', '',
2063 'primary_key' => 'groupnum',
2064 'unique' => [ [ 'groupname' ] ],
2068 'access_usergroup' => {
2070 'usergroupnum', 'serial', '', '', '', '',
2071 'usernum', 'int', '', '', '', '',
2072 'groupnum', 'int', '', '', '', '',
2074 'primary_key' => 'usergroupnum',
2075 'unique' => [ [ 'usernum', 'groupnum' ] ],
2076 'index' => [ [ 'usernum' ] ],
2079 'access_groupagent' => {
2081 'groupagentnum', 'serial', '', '', '', '',
2082 'groupnum', 'int', '', '', '', '',
2083 'agentnum', 'int', '', '', '', '',
2085 'primary_key' => 'groupagentnum',
2086 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2087 'index' => [ [ 'groupnum' ] ],
2092 'rightnum', 'serial', '', '', '', '',
2093 'righttype', 'varchar', '', $char_d, '', '',
2094 'rightobjnum', 'int', '', '', '', '',
2095 'rightname', 'varchar', '', $char_d, '', '',
2097 'primary_key' => 'rightnum',
2098 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2104 'svcnum', 'int', '', '', '', '',
2105 'countrycode', 'varchar', '', 3, '', '',
2106 'phonenum', 'varchar', '', 15, '', '', #12 ?
2107 'pin', 'varchar', 'NULL', $char_d, '', '',
2108 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2109 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2111 'primary_key' => 'svcnum',
2113 'index' => [ [ 'countrycode', 'phonenum' ] ],
2118 'availnum', 'int', '', '', '', '',
2119 'exportnum', 'int', '', '', '', '',
2120 'countrycode', 'varchar', '', 3, '', '',
2121 'state', 'char', 'NULL', 2, '', '',
2122 'npa', 'char', '', 3, '', '',
2123 'nxx', 'char', 'NULL', 3, '', '',
2124 'station', 'char', 'NULL', 4, '', '',
2125 'svcnum', 'int', 'NULL', '', '', '',
2126 'availbatch', 'varchar', 'NULL', $char_d, '', '',
2128 'primary_key' => 'availnum',
2130 'index' => [ [ 'exportnum', 'countrycode', 'state' ], #npa search
2131 [ 'exportnum', 'countrycode', 'npa' ], #nxx search
2132 [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2133 [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2141 'typenum', 'serial', '', '', '', '',
2142 'class', 'char', '', 1, '', '',
2143 'type', 'varchar', '', $char_d, '', '',
2145 'primary_key' => 'typenum',
2152 'reasonnum', 'serial', '', '', '', '',
2153 'reason_type', 'int', '', '', '', '',
2154 'reason', 'text', '', '', '', '',
2155 'disabled', 'char', 'NULL', 1, '', '',
2157 'primary_key' => 'reasonnum',
2164 'confnum', 'serial', '', '', '', '',
2165 'agentnum', 'int', 'NULL', '', '', '',
2166 'name', 'varchar', '', $char_d, '', '',
2167 'value', 'text', 'NULL', '', '', '',
2169 'primary_key' => 'confnum',
2170 'unique' => [ [ 'agentnum', 'name' ]],
2176 'pkgrefnum', 'serial', '', '', '', '',
2177 'pkgnum', 'int', '', '', '', '',
2178 'refnum', 'int', '', '', '', '',
2180 'primary_key' => 'pkgrefnum',
2181 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2182 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2184 # name type nullability length default local
2188 # 'num', 'serial', '', '', '', '',
2190 # 'primary_key' => 'num',