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' );
323 my @taxrate_type = ( 'decimal', '', '14,8' ); # requires pg 8 for
324 my @taxrate_typen = ( 'decimal', 'NULL', '14,8' ); # fs-upgrade to work
326 my $username_len = 32; #usernamemax config file
328 # name type nullability length default local
334 'agentnum', 'serial', '', '', '', '',
335 'agent', 'varchar', '', $char_d, '', '',
336 'typenum', 'int', '', '', '', '',
337 'ticketing_queueid', 'int', 'NULL', '', '', '',
338 'invoice_template', 'varchar', 'NULL', $char_d, '', '',
339 'agent_custnum', 'int', 'NULL', '', '', '',
340 'disabled', 'char', 'NULL', 1, '', '',
341 'username', 'varchar', 'NULL', $char_d, '', '', #deprecated
342 '_password', 'varchar', 'NULL', $char_d, '', '', #deprecated
343 'freq', 'int', 'NULL', '', '', '', #deprecated (never used)
344 'prog', @perl_type, '', '', #deprecated (never used)
346 'primary_key' => 'agentnum',
347 #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
348 #insert is giving it a value, tho..
349 #'index' => [ ['typenum'], ['disabled'] ],
351 'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
356 'typenum', 'serial', '', '', '', '',
357 'atype', 'varchar', '', $char_d, '', '',
359 'primary_key' => 'typenum',
366 'typepkgnum', 'serial', '', '', '', '',
367 'typenum', 'int', '', '', '', '',
368 'pkgpart', 'int', '', '', '', '',
370 'primary_key' => 'typepkgnum',
371 'unique' => [ ['typenum', 'pkgpart'] ],
372 'index' => [ ['typenum'] ],
375 'cust_attachment' => {
377 'attachnum', 'serial', '', '', '', '',
378 'custnum', 'int', '', '', '', '',
379 '_date', @date_type, '', '',
380 'otaker', 'varchar', '', 32, '', '',
381 'filename', 'varchar', '', 32, '', '',
382 'mime_type', 'varchar', '', 32, '', '',
383 'body', 'blob', 'NULL', '', '', '',
384 'disabled', @date_type, '', '',
386 'primary_key' => 'attachnum',
388 'index' => [ ['custnum'] ],
394 'invnum', 'serial', '', '', '', '',
395 'custnum', 'int', '', '', '', '',
396 '_date', @date_type, '', '',
397 'charged', @money_type, '', '',
398 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
400 #customer balance info at invoice generation time
401 'previous_balance', @money_typen, '', '', #eventually not nullable
402 'billing_balance', @money_typen, '', '', #eventually not nullable
404 #deprecated (unused by now, right?)
405 'printed', 'int', '', '', '', '',
408 'closed', 'char', 'NULL', 1, '', '', #not yet used much
409 'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
410 'agent_invid', 'int', 'NULL', '', '', '', #(varchar?) importing legacy
412 'primary_key' => 'invnum',
413 'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum? huh
414 'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
417 'cust_statement' => {
419 'statementnum', 'serial', '', '', '', '',
420 'custnum', 'int', '', '', '', '',
421 '_date', @date_type, '', '',
423 'primary_key' => 'statementnum',
425 'index' => [ ['custnum'], ['_date'], ],
428 'cust_bill_event' => {
430 'eventnum', 'serial', '', '', '', '',
431 'invnum', 'int', '', '', '', '',
432 'eventpart', 'int', '', '', '', '',
433 '_date', @date_type, '', '',
434 'status', 'varchar', '', $char_d, '', '',
435 'statustext', 'text', 'NULL', '', '', '',
437 'primary_key' => 'eventnum',
438 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
440 'index' => [ ['invnum'], ['status'], ['eventpart'],
441 ['statustext'], ['_date'],
445 'part_bill_event' => {
447 'eventpart', 'serial', '', '', '', '',
448 'freq', 'varchar', 'NULL', $char_d, '', '',
449 'payby', 'char', '', 4, '', '',
450 'event', 'varchar', '', $char_d, '', '',
451 'eventcode', @perl_type, '', '',
452 'seconds', 'int', 'NULL', '', '', '',
453 'weight', 'int', '', '', '', '',
454 'plan', 'varchar', 'NULL', $char_d, '', '',
455 'plandata', 'text', 'NULL', '', '', '',
456 'reason', 'int', 'NULL', '', '', '',
457 'disabled', 'char', 'NULL', 1, '', '',
459 'primary_key' => 'eventpart',
461 'index' => [ ['payby'], ['disabled'], ],
466 'eventpart', 'serial', '', '', '', '',
467 'agentnum', 'int', 'NULL', '', '', '',
468 'event', 'varchar', '', $char_d, '', '',
469 'eventtable', 'varchar', '', $char_d, '', '',
470 'check_freq', 'varchar', 'NULL', $char_d, '', '',
471 'weight', 'int', '', '', '', '',
472 'action', 'varchar', '', $char_d, '', '',
473 'disabled', 'char', 'NULL', 1, '', '',
475 'primary_key' => 'eventpart',
477 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
480 'part_event_option' => {
482 'optionnum', 'serial', '', '', '', '',
483 'eventpart', 'int', '', '', '', '',
484 'optionname', 'varchar', '', $char_d, '', '',
485 'optionvalue', 'text', 'NULL', '', '', '',
487 'primary_key' => 'optionnum',
489 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
492 'part_event_condition' => {
494 'eventconditionnum', 'serial', '', '', '', '',
495 'eventpart', 'int', '', '', '', '',
496 'conditionname', 'varchar', '', $char_d, '', '',
498 'primary_key' => 'eventconditionnum',
500 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
503 'part_event_condition_option' => {
505 'optionnum', 'serial', '', '', '', '',
506 'eventconditionnum', 'int', '', '', '', '',
507 'optionname', 'varchar', '', $char_d, '', '',
508 'optionvalue', 'text', 'NULL', '', '', '',
510 'primary_key' => 'optionnum',
512 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
515 'part_event_condition_option_option' => {
517 'optionoptionnum', 'serial', '', '', '', '',
518 'optionnum', 'int', '', '', '', '',
519 'optionname', 'varchar', '', $char_d, '', '',
520 'optionvalue', 'text', 'NULL', '', '', '',
522 'primary_key' => 'optionoptionnum',
524 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
529 'eventnum', 'serial', '', '', '', '',
530 'eventpart', 'int', '', '', '', '',
531 'tablenum', 'int', '', '', '', '',
532 '_date', @date_type, '', '',
533 'status', 'varchar', '', $char_d, '', '',
534 'statustext', 'text', 'NULL', '', '', '',
536 'primary_key' => 'eventnum',
537 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
539 'index' => [ ['eventpart'], ['tablenum'], ['status'],
540 ['statustext'], ['_date'],
546 'billpkgnum', 'serial', '', '', '', '',
547 'invnum', 'int', '', '', '', '',
548 'pkgnum', 'int', '', '', '', '',
549 'pkgpart_override', 'int', 'NULL', '', '', '',
550 'setup', @money_type, '', '',
551 'recur', @money_type, '', '',
552 'sdate', @date_type, '', '',
553 'edate', @date_type, '', '',
554 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
555 'itemcomment', 'varchar', 'NULL', $char_d, '', '',
556 'section', 'varchar', 'NULL', $char_d, '', '',
557 'quantity', 'int', 'NULL', '', '', '',
558 'unitsetup', @money_typen, '', '',
559 'unitrecur', @money_typen, '', '',
560 'hidden', 'char', 'NULL', 1, '', '',
562 'primary_key' => 'billpkgnum',
564 'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
567 'cust_bill_pkg_detail' => {
569 'detailnum', 'serial', '', '', '', '',
570 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
571 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
572 'invnum', 'int', 'NULL', '', '', '', # deprecated
573 'amount', 'decimal', 'NULL', '10,4', '', '',
574 'format', 'char', 'NULL', 1, '', '',
575 'classnum', 'int', 'NULL', '', '', '',
576 'phonenum', 'varchar', 'NULL', 15, '', '',
577 'detail', 'varchar', '', 255, '', '',
579 'primary_key' => 'detailnum',
581 'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
584 'cust_bill_pkg_display' => {
586 'billpkgdisplaynum', 'serial', '', '', '', '',
587 'billpkgnum', 'int', '', '', '', '',
588 'section', 'varchar', 'NULL', $char_d, '', '',
589 #'unitsetup', @money_typen, '', '', #override the linked real one?
590 #'unitrecur', @money_typen, '', '', #this too?
591 'post_total', 'char', 'NULL', 1, '', '',
592 'type', 'char', 'NULL', 1, '', '',
593 'summary', 'char', 'NULL', 1, '', '',
595 'primary_key' => 'billpkgdisplaynum',
597 'index' => [ ['billpkgnum'], ],
600 'cust_bill_pkg_tax_location' => {
602 'billpkgtaxlocationnum', 'serial', '', '', '', '',
603 'billpkgnum', 'int', '', '', '', '',
604 'taxnum', 'int', '', '', '', '',
605 'taxtype', 'varchar', '', $char_d, '', '',
606 'pkgnum', 'int', '', '', '', '',
607 'locationnum', 'int', '', '', '', '', #redundant?
608 'amount', @money_type, '', '',
610 'primary_key' => 'billpkgtaxlocationnum',
612 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
615 'cust_bill_pkg_tax_rate_location' => {
617 'billpkgtaxratelocationnum', 'serial', '', '', '', '',
618 'billpkgnum', 'int', '', '', '', '',
619 'taxnum', 'int', '', '', '', '',
620 'taxtype', 'varchar', '', $char_d, '', '',
621 'locationtaxid', 'varchar', 'NULL', $char_d, '', '',
622 'taxratelocationnum', 'int', '', '', '', '',
623 'amount', @money_type, '', '',
625 'primary_key' => 'billpkgtaxratelocationnum',
627 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
632 'crednum', 'serial', '', '', '', '',
633 'custnum', 'int', '', '', '', '',
634 '_date', @date_type, '', '',
635 'amount', @money_type, '', '',
636 'otaker', 'varchar', '', 32, '', '',
637 'reason', 'text', 'NULL', '', '', '',
638 'reasonnum', 'int', 'NULL', '', '', '',
639 'addlinfo', 'text', 'NULL', '', '', '',
640 'closed', 'char', 'NULL', 1, '', '',
641 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
643 'primary_key' => 'crednum',
645 'index' => [ ['custnum'], ['_date'] ],
648 'cust_credit_bill' => {
650 'creditbillnum', 'serial', '', '', '', '',
651 'crednum', 'int', '', '', '', '',
652 'invnum', 'int', '', '', '', '',
653 '_date', @date_type, '', '',
654 'amount', @money_type, '', '',
655 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
657 'primary_key' => 'creditbillnum',
659 'index' => [ ['crednum'], ['invnum'] ],
662 'cust_credit_bill_pkg' => {
664 'creditbillpkgnum', 'serial', '', '', '', '',
665 'creditbillnum', 'int', '', '', '', '',
666 'billpkgnum', 'int', '', '', '', '',
667 'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
668 'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
669 'amount', @money_type, '', '',
670 'setuprecur', 'varchar', '', $char_d, '', '',
671 'sdate', @date_type, '', '',
672 'edate', @date_type, '', '',
674 'primary_key' => 'creditbillpkgnum',
676 'index' => [ [ 'creditbillnum' ],
678 [ 'billpkgtaxlocationnum' ],
679 [ 'billpkgtaxratelocationnum' ],
685 'custnum', 'serial', '', '', '', '',
686 'agentnum', 'int', '', '', '', '',
687 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
688 'custbatch', 'varchar', 'NULL', $char_d, '', '',
689 # 'titlenum', 'int', 'NULL', '', '', '',
690 'last', 'varchar', '', $char_d, '', '',
691 # 'middle', 'varchar', 'NULL', $char_d, '', '',
692 'first', 'varchar', '', $char_d, '', '',
693 'ss', 'varchar', 'NULL', 11, '', '',
694 'stateid', 'varchar', 'NULL', $char_d, '', '',
695 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
696 'birthdate' ,@date_type, '', '',
697 'signupdate',@date_type, '', '',
698 'dundate', @date_type, '', '',
699 'company', 'varchar', 'NULL', $char_d, '', '',
700 'address1', 'varchar', '', $char_d, '', '',
701 'address2', 'varchar', 'NULL', $char_d, '', '',
702 'city', 'varchar', '', $char_d, '', '',
703 'county', 'varchar', 'NULL', $char_d, '', '',
704 'state', 'varchar', 'NULL', $char_d, '', '',
705 'zip', 'varchar', 'NULL', 10, '', '',
706 'country', 'char', '', 2, '', '',
707 'daytime', 'varchar', 'NULL', 20, '', '',
708 'night', 'varchar', 'NULL', 20, '', '',
709 'fax', 'varchar', 'NULL', 12, '', '',
710 'ship_last', 'varchar', 'NULL', $char_d, '', '',
711 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
712 'ship_first', 'varchar', 'NULL', $char_d, '', '',
713 'ship_company', 'varchar', 'NULL', $char_d, '', '',
714 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
715 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
716 'ship_city', 'varchar', 'NULL', $char_d, '', '',
717 'ship_county', 'varchar', 'NULL', $char_d, '', '',
718 'ship_state', 'varchar', 'NULL', $char_d, '', '',
719 'ship_zip', 'varchar', 'NULL', 10, '', '',
720 'ship_country', 'char', 'NULL', 2, '', '',
721 'ship_daytime', 'varchar', 'NULL', 20, '', '',
722 'ship_night', 'varchar', 'NULL', 20, '', '',
723 'ship_fax', 'varchar', 'NULL', 12, '', '',
724 'payby', 'char', '', 4, '', '',
725 'payinfo', 'varchar', 'NULL', 512, '', '',
726 'paycvv', 'varchar', 'NULL', 512, '', '',
727 'paymask', 'varchar', 'NULL', $char_d, '', '',
728 #'paydate', @date_type, '', '',
729 'paydate', 'varchar', 'NULL', 10, '', '',
730 'paystart_month', 'int', 'NULL', '', '', '',
731 'paystart_year', 'int', 'NULL', '', '', '',
732 'payissue', 'varchar', 'NULL', 2, '', '',
733 'payname', 'varchar', 'NULL', $char_d, '', '',
734 'paystate', 'varchar', 'NULL', $char_d, '', '',
735 'paytype', 'varchar', 'NULL', $char_d, '', '',
736 'payip', 'varchar', 'NULL', 15, '', '',
737 'geocode', 'varchar', 'NULL', 20, '', '',
738 'censustract', 'varchar', 'NULL', 20, '', '', # 7 to save space?
739 'tax', 'char', 'NULL', 1, '', '',
740 'otaker', 'varchar', '', 32, '', '',
741 'refnum', 'int', '', '', '', '',
742 'referral_custnum', 'int', 'NULL', '', '', '',
743 'comments', 'text', 'NULL', '', '', '',
744 'spool_cdr','char', 'NULL', 1, '', '',
745 'squelch_cdr','char', 'NULL', 1, '', '',
746 'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
747 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
748 'archived', 'char', 'NULL', 1, '', '',
749 'email_csv_cdr', 'char', 'NULL', 1, '', '',
751 'primary_key' => 'custnum',
752 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
753 #'index' => [ ['last'], ['company'] ],
755 [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
756 [ 'referral_custnum' ],
757 [ 'payby' ], [ 'paydate' ],
760 [ 'last' ], [ 'company' ],
761 [ 'county' ], [ 'state' ], [ 'country' ],
763 [ 'daytime' ], [ 'night' ], [ 'fax' ],
765 [ 'ship_last' ], [ 'ship_company' ],
766 [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
768 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
772 'cust_recon' => { # what purpose does this serve?
774 'reconid', 'serial', '', '', '', '',
775 'recondate', @date_type, '', '',
776 'custnum', 'int' , '', '', '', '',
777 'agentnum', 'int', '', '', '', '',
778 'last', 'varchar', '', $char_d, '', '',
779 'first', 'varchar', '', $char_d, '', '',
780 'address1', 'varchar', '', $char_d, '', '',
781 'address2', 'varchar', 'NULL', $char_d, '', '',
782 'city', 'varchar', '', $char_d, '', '',
783 'state', 'varchar', 'NULL', $char_d, '', '',
784 'zip', 'varchar', 'NULL', 10, '', '',
785 'pkg', 'varchar', 'NULL', $char_d, '', '',
786 'adjourn', @date_type, '', '',
787 'status', 'varchar', 'NULL', 10, '', '',
788 'agent_custid', 'varchar', '', $char_d, '', '',
789 'agent_pkg', 'varchar', 'NULL', $char_d, '', '',
790 'agent_adjourn', @date_type, '', '',
791 'comments', 'text', 'NULL', '', '', '',
793 'primary_key' => 'reconid',
798 #eventually use for billing & ship from cust_main too
799 #for now, just cust_pkg locations
802 'locationnum', 'serial', '', '', '', '',
803 'custnum', 'int', '', '', '', '',
804 'address1', 'varchar', '', $char_d, '', '',
805 'address2', 'varchar', 'NULL', $char_d, '', '',
806 'city', 'varchar', '', $char_d, '', '',
807 'county', 'varchar', 'NULL', $char_d, '', '',
808 'state', 'varchar', 'NULL', $char_d, '', '',
809 'zip', 'varchar', 'NULL', 10, '', '',
810 'country', 'char', '', 2, '', '',
811 'geocode', 'varchar', 'NULL', 20, '', '',
813 'primary_key' => 'locationnum',
815 'index' => [ [ 'custnum' ],
816 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
820 'cust_main_invoice' => {
822 'destnum', 'serial', '', '', '', '',
823 'custnum', 'int', '', '', '', '',
824 'dest', 'varchar', '', $char_d, '', '',
826 'primary_key' => 'destnum',
828 'index' => [ ['custnum'], ],
831 'cust_main_note' => {
833 'notenum', 'serial', '', '', '', '',
834 'custnum', 'int', '', '', '', '',
835 '_date', @date_type, '', '',
836 'otaker', 'varchar', '', 32, '', '',
837 'comments', 'text', 'NULL', '', '', '',
839 'primary_key' => 'notenum',
841 'index' => [ [ 'custnum' ], [ '_date' ], ],
844 'cust_main_exemption' => {
846 'exemptionnum', 'serial', '', '', '', '',
847 'custnum', 'int', '', '', '', '',
848 'taxname', 'varchar', '', $char_d, '', '',
849 #start/end dates? for reporting?
851 'primary_key' => 'exemptionnum',
853 'index' => [ [ 'custnum' ] ],
856 'cust_tax_adjustment' => {
858 'adjustmentnum', 'serial', '', '', '', '',
859 'custnum', 'int', '', '', '', '',
860 'taxname', 'varchar', '', $char_d, '', '',
861 'amount', @money_type, '', '',
862 'comment', 'varchar', 'NULL', $char_d, '', '',
863 'billpkgnum', 'int', 'NULL', '', '', '',
864 #more? no cust_bill_pkg_tax_location?
866 'primary_key' => 'adjustmentnum',
868 'index' => [ [ 'custnum' ], [ 'billpkgnum' ] ],
871 'cust_main_county' => { #county+state+country are checked off the
872 #cust_main_county for validation and to provide
875 'taxnum', 'serial', '', '', '', '',
876 'city', 'varchar', 'NULL', $char_d, '', '',
877 'county', 'varchar', 'NULL', $char_d, '', '',
878 'state', 'varchar', 'NULL', $char_d, '', '',
879 'country', 'char', '', 2, '', '',
880 'taxclass', 'varchar', 'NULL', $char_d, '', '',
881 'exempt_amount', @money_type, '', '',
882 'tax', 'real', '', '', '', '', #tax %
883 'taxname', 'varchar', 'NULL', $char_d, '', '',
884 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
885 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
887 'primary_key' => 'taxnum',
889 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
890 'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
897 'taxnum', 'serial', '', '', '', '',
898 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
899 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
900 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
901 'taxclassnum', 'int', '', '', '', '',
902 'effective_date', @date_type, '', '',
903 'tax', @taxrate_type, '', '', # tax %
904 'excessrate', @taxrate_typen, '', '', # second tax %
905 'taxbase', @money_typen, '', '', # amount at first tax rate
906 'taxmax', @money_typen, '', '', # maximum about at both rates
907 'usetax', @taxrate_typen, '', '', # tax % when non-local
908 'useexcessrate', @taxrate_typen, '', '', # second tax % when non-local
909 'unittype', 'int', 'NULL', '', '', '', # for fee
910 'fee', @taxrate_typen, '', '', # amount tax per unit
911 'excessfee', @taxrate_typen, '', '', # second amount tax per unit
912 'feebase', @taxrate_typen, '', '', # units taxed at first rate
913 'feemax', @taxrate_typen, '', '', # maximum number of unit taxed
914 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
915 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
916 'taxauth', 'int', 'NULL', '', '', '', # tax authority
917 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
918 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
919 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
920 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
921 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
922 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
923 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
925 'primary_key' => 'taxnum',
927 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
930 'tax_rate_location' => {
932 'taxratelocationnum', 'serial', '', '', '', '',
933 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
934 'geocode', 'varchar', '', 20, '', '',
935 'city', 'varchar', 'NULL', $char_d, '', '',
936 'county', 'varchar', 'NULL', $char_d, '', '',
937 'state', 'char', 'NULL', 2, '', '',
938 'disabled', 'char', 'NULL', 1, '', '',
940 'primary_key' => 'taxratelocationnum',
942 'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
945 'cust_tax_location' => {
947 'custlocationnum', 'serial', '', '', '', '',
948 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
949 'city', 'varchar', 'NULL', $char_d, '', '',
950 'postalcity', 'varchar', 'NULL', $char_d, '', '',
951 'county', 'varchar', 'NULL', $char_d, '', '',
952 'zip', 'char', '', 5, '', '',
953 'state', 'char', '', 2, '', '',
954 'plus4hi', 'char', 'NULL', 4, '', '',
955 'plus4lo', 'char', 'NULL', 4, '', '',
956 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
957 'cityflag', 'char', 'NULL', 1, '', '', # I(n)/O(out)/B(oth)/NULL
958 'geocode', 'varchar', '', 20, '', '',
960 'primary_key' => 'custlocationnum',
962 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
967 'taxclassnum', 'serial', '', '', '', '',
968 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
969 'taxclass', 'varchar', '', $char_d, '', '',
970 'description', 'varchar', '', 2*$char_d, '', '',
972 'primary_key' => 'taxclassnum',
973 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
977 'cust_pay_pending' => {
979 'paypendingnum','serial', '', '', '', '',
980 'custnum', 'int', '', '', '', '',
981 'paid', @money_type, '', '',
982 '_date', @date_type, '', '',
983 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
984 # be index into payby
986 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
987 'paymask', 'varchar', 'NULL', $char_d, '', '',
988 'paydate', 'varchar', 'NULL', 10, '', '',
989 'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
990 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
991 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
993 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
994 'status', 'varchar', '', $char_d, '', '',
995 'session_id', 'varchar', 'NULL', $char_d, '', '', #only need 32
996 'statustext', 'text', 'NULL', '', '', '',
997 'gatewaynum', 'int', 'NULL', '', '', '',
998 #'cust_balance', @money_type, '', '',
999 'paynum', 'int', 'NULL', '', '', '',
1000 'jobnum', 'int', 'NULL', '', '', '',
1002 'primary_key' => 'paypendingnum',
1003 'unique' => [ [ 'payunique' ] ],
1004 'index' => [ [ 'custnum' ], [ 'status' ], ],
1009 'paynum', 'serial', '', '', '', '',
1010 'custnum', 'int', '', '', '', '',
1011 '_date', @date_type, '', '',
1012 'paid', @money_type, '', '',
1013 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
1014 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1015 # index into payby table
1017 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1018 'paymask', 'varchar', 'NULL', $char_d, '', '',
1019 'paydate', 'varchar', 'NULL', 10, '', '',
1020 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1021 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1022 'closed', 'char', 'NULL', 1, '', '',
1023 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1025 'primary_key' => 'paynum',
1026 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1027 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
1030 'cust_pay_void' => {
1032 'paynum', 'int', '', '', '', '',
1033 'custnum', 'int', '', '', '', '',
1034 'paid', @money_type, '', '',
1035 '_date', @date_type, '', '',
1036 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1037 # index into payby table
1039 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1040 'paymask', 'varchar', 'NULL', $char_d, '', '',
1041 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1042 'closed', 'char', 'NULL', 1, '', '',
1043 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1044 'void_date', @date_type, '', '',
1045 'reason', 'varchar', 'NULL', $char_d, '', '',
1046 'otaker', 'varchar', '', 32, '', '',
1048 'primary_key' => 'paynum',
1050 'index' => [ [ 'custnum' ] ],
1053 'cust_bill_pay' => {
1055 'billpaynum', 'serial', '', '', '', '',
1056 'invnum', 'int', '', '', '', '',
1057 'paynum', 'int', '', '', '', '',
1058 'amount', @money_type, '', '',
1059 '_date', @date_type, '', '',
1060 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1062 'primary_key' => 'billpaynum',
1064 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1067 'cust_bill_pay_batch' => {
1069 'billpaynum', 'serial', '', '', '', '',
1070 'invnum', 'int', '', '', '', '',
1071 'paybatchnum', 'int', '', '', '', '',
1072 'amount', @money_type, '', '',
1073 '_date', @date_type, '', '',
1075 'primary_key' => 'billpaynum',
1077 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1080 'cust_bill_pay_pkg' => {
1082 'billpaypkgnum', 'serial', '', '', '', '',
1083 'billpaynum', 'int', '', '', '', '',
1084 'billpkgnum', 'int', '', '', '', '',
1085 'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1086 'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1087 'amount', @money_type, '', '',
1088 'setuprecur', 'varchar', '', $char_d, '', '',
1089 'sdate', @date_type, '', '',
1090 'edate', @date_type, '', '',
1092 'primary_key' => 'billpaypkgnum',
1094 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1097 'pay_batch' => { #batches of payments to an external processor
1099 'batchnum', 'serial', '', '', '', '',
1100 'payby', 'char', '', 4, '', '', # CARD/CHEK
1101 'status', 'char', 'NULL', 1, '', '',
1102 'download', @date_type, '', '',
1103 'upload', @date_type, '', '',
1105 'primary_key' => 'batchnum',
1110 'cust_pay_batch' => { #what's this used for again? list of customers
1111 #in current CARD batch? (necessarily CARD?)
1113 'paybatchnum', 'serial', '', '', '', '',
1114 'batchnum', 'int', '', '', '', '',
1115 'invnum', 'int', '', '', '', '',
1116 'custnum', 'int', '', '', '', '',
1117 'last', 'varchar', '', $char_d, '', '',
1118 'first', 'varchar', '', $char_d, '', '',
1119 'address1', 'varchar', '', $char_d, '', '',
1120 'address2', 'varchar', 'NULL', $char_d, '', '',
1121 'city', 'varchar', '', $char_d, '', '',
1122 'state', 'varchar', 'NULL', $char_d, '', '',
1123 'zip', 'varchar', 'NULL', 10, '', '',
1124 'country', 'char', '', 2, '', '',
1125 # 'trancode', 'int', '', '', '', ''
1126 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1127 'payinfo', 'varchar', '', 512, '', '',
1128 #'exp', @date_type, '', ''
1129 'exp', 'varchar', 'NULL', 11, '', '',
1130 'payname', 'varchar', 'NULL', $char_d, '', '',
1131 'amount', @money_type, '', '',
1132 'status', 'varchar', 'NULL', $char_d, '', '',
1134 'primary_key' => 'paybatchnum',
1136 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1141 'pkgnum', 'serial', '', '', '', '',
1142 'custnum', 'int', '', '', '', '',
1143 'pkgpart', 'int', '', '', '', '',
1144 'locationnum', 'int', 'NULL', '', '', '',
1145 'otaker', 'varchar', '', 32, '', '',
1146 'start_date', @date_type, '', '',
1147 'setup', @date_type, '', '',
1148 'bill', @date_type, '', '',
1149 'last_bill', @date_type, '', '',
1150 'susp', @date_type, '', '',
1151 'adjourn', @date_type, '', '',
1152 'cancel', @date_type, '', '',
1153 'expire', @date_type, '', '',
1154 'change_date', @date_type, '', '',
1155 'change_pkgnum', 'int', 'NULL', '', '', '',
1156 'change_pkgpart', 'int', 'NULL', '', '', '',
1157 'change_locationnum', 'int', 'NULL', '', '', '',
1158 'manual_flag', 'char', 'NULL', 1, '', '',
1159 'quantity', 'int', 'NULL', '', '', '',
1161 'primary_key' => 'pkgnum',
1163 'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1164 [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1165 ['susp'], ['adjourn'], ['expire'], ['cancel'],
1170 'cust_pkg_option' => {
1172 'optionnum', 'serial', '', '', '', '',
1173 'pkgnum', 'int', '', '', '', '',
1174 'optionname', 'varchar', '', $char_d, '', '',
1175 'optionvalue', 'text', 'NULL', '', '', '',
1177 'primary_key' => 'optionnum',
1179 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
1182 'cust_pkg_detail' => {
1184 'pkgdetailnum', 'serial', '', '', '', '',
1185 'pkgnum', 'int', '', '', '', '',
1186 'detail', 'varchar', '', $char_d, '', '',
1187 'detailtype', 'char', '', 1, '', '', # "I"nvoice or "C"omment
1188 'weight', 'int', '', '', '', '',
1190 'primary_key' => 'pkgdetailnum',
1192 'index' => [ [ 'pkgnum', 'detailtype' ] ],
1195 'cust_pkg_reason' => {
1197 'num', 'serial', '', '', '', '',
1198 'pkgnum', 'int', '', '', '', '',
1199 'reasonnum','int', '', '', '', '',
1200 'action', 'char', 'NULL', 1, '', '', #should not be nullable
1201 'otaker', 'varchar', '', 32, '', '',
1202 'date', @date_type, '', '',
1204 'primary_key' => 'num',
1206 'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1211 'refundnum', 'serial', '', '', '', '',
1212 'custnum', 'int', '', '', '', '',
1213 '_date', @date_type, '', '',
1214 'refund', @money_type, '', '',
1215 'otaker', 'varchar', '', 32, '', '',
1216 'reason', 'varchar', '', $char_d, '', '',
1217 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
1218 # be index into payby
1220 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1221 'paymask', 'varchar', 'NULL', $char_d, '', '',
1222 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1223 'closed', 'char', 'NULL', 1, '', '',
1225 'primary_key' => 'refundnum',
1227 'index' => [ ['custnum'], ['_date'] ],
1230 'cust_credit_refund' => {
1232 'creditrefundnum', 'serial', '', '', '', '',
1233 'crednum', 'int', '', '', '', '',
1234 'refundnum', 'int', '', '', '', '',
1235 'amount', @money_type, '', '',
1236 '_date', @date_type, '', '',
1238 'primary_key' => 'creditrefundnum',
1240 'index' => [ ['crednum'], ['refundnum'] ],
1246 'svcnum', 'serial', '', '', '', '',
1247 'pkgnum', 'int', 'NULL', '', '', '',
1248 'svcpart', 'int', '', '', '', '',
1249 'overlimit', @date_type, '', '',
1251 'primary_key' => 'svcnum',
1253 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1256 'cust_svc_option' => {
1258 'optionnum', 'serial', '', '', '', '',
1259 'svcnum', 'int', '', '', '', '',
1260 'optionname', 'varchar', '', $char_d, '', '',
1261 'optionvalue', 'text', 'NULL', '', '', '',
1263 'primary_key' => 'optionnum',
1265 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1270 'pkgpart', 'serial', '', '', '', '',
1271 'pkg', 'varchar', '', $char_d, '', '',
1272 'comment', 'varchar', '', $char_d, '', '',
1273 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1274 'setup', @perl_type, '', '',
1275 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1276 'recur', @perl_type, '', '',
1277 'setuptax', 'char', 'NULL', 1, '', '',
1278 'recurtax', 'char', 'NULL', 1, '', '',
1279 'plan', 'varchar', 'NULL', $char_d, '', '',
1280 'plandata', 'text', 'NULL', '', '', '',
1281 'disabled', 'char', 'NULL', 1, '', '',
1282 'custom', 'char', 'NULL', 1, '', '',
1283 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1284 'classnum', 'int', 'NULL', '', '', '',
1285 'addon_classnum','int', 'NULL', '', '', '',
1286 'taxproductnum', 'int', 'NULL', '', '', '',
1287 'setup_cost', @money_typen, '', '',
1288 'recur_cost', @money_typen, '', '',
1289 'pay_weight', 'real', 'NULL', '', '', '',
1290 'credit_weight', 'real', 'NULL', '', '', '',
1291 'agentnum', 'int', 'NULL', '', '', '',
1294 'primary_key' => 'pkgpart',
1296 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1301 'part_pkg_link' => {
1303 'pkglinknum', 'serial', '', '', '', '',
1304 'src_pkgpart', 'int', '', '', '', '',
1305 'dst_pkgpart', 'int', '', '', '', '',
1306 'link_type', 'varchar', '', $char_d, '', '',
1307 'hidden', 'char', 'NULL', 1, '', '',
1309 'primary_key' => 'pkglinknum',
1310 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1311 'index' => [ [ 'src_pkgpart' ] ],
1313 # XXX somewhat borked unique: we don't really want a hidden and unhidden
1314 # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1316 'part_pkg_taxclass' => {
1318 'taxclassnum', 'serial', '', '', '', '',
1319 'taxclass', 'varchar', '', $char_d, '', '',
1320 'disabled', 'char', 'NULL', 1, '', '',
1322 'primary_key' => 'taxclassnum',
1323 'unique' => [ [ 'taxclass' ] ],
1324 'index' => [ [ 'disabled' ] ],
1327 'part_pkg_taxproduct' => {
1329 'taxproductnum', 'serial', '', '', '', '',
1330 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1331 'taxproduct', 'varchar', '', $char_d, '', '',
1332 'description', 'varchar', '', 3*$char_d, '', '',
1334 'primary_key' => 'taxproductnum',
1335 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1339 'part_pkg_taxrate' => {
1341 'pkgtaxratenum', 'serial', '', '', '', '',
1342 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1343 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1344 'taxproductnum', 'int', '', '', '', '',
1345 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1346 'county', 'varchar', 'NULL', $char_d, '', '',
1347 'state', 'varchar', 'NULL', $char_d, '', '',
1348 'local', 'varchar', 'NULL', $char_d, '', '',
1349 'country', 'char', 'NULL', 2, '', '',
1350 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1351 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1352 'taxclassnum', 'int', 'NULL', '', '', '',
1353 'effdate', @date_type, '', '',
1354 'taxable', 'char', 'NULL', 1, '', '',
1356 'primary_key' => 'pkgtaxratenum',
1358 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1361 'part_pkg_taxoverride' => {
1363 'taxoverridenum', 'serial', '', '', '', '',
1364 'pkgpart', 'serial', '', '', '', '',
1365 'taxclassnum', 'serial', '', '', '', '',
1366 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1368 'primary_key' => 'taxoverridenum',
1370 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1375 # 'titlenum', 'int', '', '',
1376 # 'title', 'varchar', '', $char_d,
1378 # 'primary_key' => 'titlenum',
1379 # 'unique' => [ [] ],
1380 # 'index' => [ [] ],
1385 'pkgsvcnum', 'serial', '', '', '', '',
1386 'pkgpart', 'int', '', '', '', '',
1387 'svcpart', 'int', '', '', '', '',
1388 'quantity', 'int', '', '', '', '',
1389 'primary_svc','char', 'NULL', 1, '', '',
1391 'primary_key' => 'pkgsvcnum',
1392 'unique' => [ ['pkgpart', 'svcpart'] ],
1393 'index' => [ ['pkgpart'], ['quantity'] ],
1396 'part_referral' => {
1398 'refnum', 'serial', '', '', '', '',
1399 'referral', 'varchar', '', $char_d, '', '',
1400 'disabled', 'char', 'NULL', 1, '', '',
1401 'agentnum', 'int', 'NULL', '', '', '',
1403 'primary_key' => 'refnum',
1405 'index' => [ ['disabled'], ['agentnum'], ],
1410 'svcpart', 'serial', '', '', '', '',
1411 'svc', 'varchar', '', $char_d, '', '',
1412 'svcdb', 'varchar', '', $char_d, '', '',
1413 'disabled', 'char', 'NULL', 1, '', '',
1415 'primary_key' => 'svcpart',
1417 'index' => [ [ 'disabled' ] ],
1420 'part_svc_column' => {
1422 'columnnum', 'serial', '', '', '', '',
1423 'svcpart', 'int', '', '', '', '',
1424 'columnname', 'varchar', '', 64, '', '',
1425 'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1426 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1427 'columnflag', 'char', 'NULL', 1, '', '',
1429 'primary_key' => 'columnnum',
1430 'unique' => [ [ 'svcpart', 'columnname' ] ],
1431 'index' => [ [ 'svcpart' ] ],
1434 #(this should be renamed to part_pop)
1437 'popnum', 'serial', '', '', '', '',
1438 'city', 'varchar', '', $char_d, '', '',
1439 'state', 'varchar', '', $char_d, '', '',
1440 'ac', 'char', '', 3, '', '',
1441 'exch', 'char', '', 3, '', '',
1442 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1444 'primary_key' => 'popnum',
1446 'index' => [ [ 'state' ] ],
1449 'part_pop_local' => {
1451 'localnum', 'serial', '', '', '', '',
1452 'popnum', 'int', '', '', '', '',
1453 'city', 'varchar', 'NULL', $char_d, '', '',
1454 'state', 'char', 'NULL', 2, '', '',
1455 'npa', 'char', '', 3, '', '',
1456 'nxx', 'char', '', 3, '', '',
1458 'primary_key' => 'localnum',
1460 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1465 'svcnum', 'int', '', '', '', '',
1466 'username', 'varchar', '', $username_len, '', '',
1467 '_password', 'varchar', 'NULL', 512, '', '',
1468 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1469 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1470 'popnum', 'int', 'NULL', '', '', '',
1471 'uid', 'int', 'NULL', '', '', '',
1472 'gid', 'int', 'NULL', '', '', '',
1473 'finger', 'varchar', 'NULL', $char_d, '', '',
1474 'dir', 'varchar', 'NULL', $char_d, '', '',
1475 'shell', 'varchar', 'NULL', $char_d, '', '',
1476 'quota', 'varchar', 'NULL', $char_d, '', '',
1477 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1478 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1479 'seconds_threshold', 'int', 'NULL', '', '', '',
1480 'upbytes', 'bigint', 'NULL', '', '', '',
1481 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1482 'downbytes', 'bigint', 'NULL', '', '', '',
1483 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1484 'totalbytes','bigint', 'NULL', '', '', '',
1485 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1486 'domsvc', 'int', '', '', '', '',
1487 'last_login', @date_type, '', '',
1488 'last_logout', @date_type, '', '',
1490 'primary_key' => 'svcnum',
1491 #'unique' => [ [ 'username', 'domsvc' ] ],
1493 'index' => [ ['username'], ['domsvc'] ],
1496 'acct_rt_transaction' => {
1498 'svcrtid', 'int', '', '', '', '',
1499 'svcnum', 'int', '', '', '', '',
1500 'transaction_id', 'int', '', '', '', '',
1501 '_date', @date_type, '', '',
1502 'seconds', 'int', '', '', '', '', #uhhhh
1503 'support', 'int', '', '', '', '',
1505 'primary_key' => 'svcrtid',
1507 'index' => [ ['svcnum', 'transaction_id'] ],
1512 # 'svcnum', 'int', '', '',
1513 # 'amount', @money_type,
1515 # 'primary_key' => 'svcnum',
1516 # 'unique' => [ [] ],
1517 # 'index' => [ [] ],
1522 'svcnum', 'int', '', '', '', '',
1523 'domain', 'varchar', '', $char_d, '', '',
1524 'suffix', 'varchar', 'NULL', $char_d, '', '',
1525 'catchall', 'int', 'NULL', '', '', '',
1526 'parent_svcnum', 'int', 'NULL', '', '', '',
1527 'registrarnum', 'int', 'NULL', '', '', '',
1528 'registrarkey', 'varchar', 'NULL', 512, '', '',
1529 'setup_date', @date_type, '', '',
1530 'renewal_interval', 'int', 'NULL', '', '', '',
1531 'expiration_date', @date_type, '', '',
1533 'primary_key' => 'svcnum',
1535 'index' => [ ['domain'] ],
1538 'domain_record' => {
1540 'recnum', 'serial', '', '', '', '',
1541 'svcnum', 'int', '', '', '', '',
1542 'reczone', 'varchar', '', 255, '', '',
1543 'recaf', 'char', '', 2, '', '',
1544 'rectype', 'varchar', '', 5, '', '',
1545 'recdata', 'varchar', '', 255, '', '',
1547 'primary_key' => 'recnum',
1549 'index' => [ ['svcnum'] ],
1554 'registrarnum', 'serial', '', '', '', '',
1555 'registrarname', 'varchar', '', $char_d, '', '',
1557 'primary_key' => 'registrarnum',
1564 'svcnum', 'int', '', '', '', '',
1565 'srcsvc', 'int', 'NULL', '', '', '',
1566 'src', 'varchar', 'NULL', 255, '', '',
1567 'dstsvc', 'int', 'NULL', '', '', '',
1568 'dst', 'varchar', 'NULL', 255, '', '',
1570 'primary_key' => 'svcnum',
1572 'index' => [ ['srcsvc'], ['dstsvc'] ],
1577 'svcnum', 'int', '', '', '', '',
1578 'recnum', 'int', '', '', '', '',
1579 'usersvc', 'int', 'NULL', '', '', '',
1580 'config', 'text', 'NULL', '', '', '',
1582 'primary_key' => 'svcnum',
1589 # 'svcnum', 'int', '', '',
1590 # 'svcnum', 'int', '', '',
1591 # 'svcnum', 'int', '', '',
1592 # 'worker', 'varchar', '', $char_d,
1593 # '_date', @date_type,
1595 # 'primary_key' => 'svcnum',
1596 # 'unique' => [ [] ],
1597 # 'index' => [ [] ],
1600 'prepay_credit' => {
1602 'prepaynum', 'serial', '', '', '', '',
1603 'identifier', 'varchar', '', $char_d, '', '',
1604 'amount', @money_type, '', '',
1605 'seconds', 'int', 'NULL', '', '', '',
1606 'upbytes', 'bigint', 'NULL', '', '', '',
1607 'downbytes', 'bigint', 'NULL', '', '', '',
1608 'totalbytes', 'bigint', 'NULL', '', '', '',
1609 'agentnum', 'int', 'NULL', '', '', '',
1611 'primary_key' => 'prepaynum',
1612 'unique' => [ ['identifier'] ],
1618 'portnum', 'serial', '', '', '', '',
1619 'ip', 'varchar', 'NULL', 15, '', '',
1620 'nasport', 'int', 'NULL', '', '', '',
1621 'nasnum', 'int', '', '', '', '',
1623 'primary_key' => 'portnum',
1630 'nasnum', 'serial', '', '', '', '',
1631 'nas', 'varchar', '', $char_d, '', '',
1632 'nasip', 'varchar', '', 15, '', '',
1633 'nasfqdn', 'varchar', '', $char_d, '', '',
1634 'last', 'int', '', '', '', '',
1636 'primary_key' => 'nasnum',
1637 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1638 'index' => [ [ 'last' ] ],
1643 # 'sessionnum', 'serial', '', '', '', '',
1644 # 'portnum', 'int', '', '', '', '',
1645 # 'svcnum', 'int', '', '', '', '',
1646 # 'login', @date_type, '', '',
1647 # 'logout', @date_type, '', '',
1649 # 'primary_key' => 'sessionnum',
1651 # 'index' => [ [ 'portnum' ] ],
1656 'jobnum', 'serial', '', '', '', '',
1657 'job', 'varchar', '', 512, '', '',
1658 '_date', 'int', '', '', '', '',
1659 'status', 'varchar', '', $char_d, '', '',
1660 'statustext', 'text', 'NULL', '', '', '',
1661 'svcnum', 'int', 'NULL', '', '', '',
1662 'custnum', 'int', 'NULL', '', '', '',
1663 'secure', 'char', 'NULL', 1, '', '',
1664 'priority', 'int', 'NULL', '', '', '',
1666 'primary_key' => 'jobnum',
1668 'index' => [ [ 'secure' ], [ 'priority' ],
1669 [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1675 'argnum', 'serial', '', '', '', '',
1676 'jobnum', 'int', '', '', '', '',
1677 'frozen', 'char', 'NULL', 1, '', '',
1678 'arg', 'text', 'NULL', '', '', '',
1680 'primary_key' => 'argnum',
1682 'index' => [ [ 'jobnum' ] ],
1687 'dependnum', 'serial', '', '', '', '',
1688 'jobnum', 'int', '', '', '', '',
1689 'depend_jobnum', 'int', '', '', '', '',
1691 'primary_key' => 'dependnum',
1693 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1698 'exportsvcnum' => 'serial', '', '', '', '',
1699 'exportnum' => 'int', '', '', '', '',
1700 'svcpart' => 'int', '', '', '', '',
1702 'primary_key' => 'exportsvcnum',
1703 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1704 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1709 'exportnum', 'serial', '', '', '', '',
1710 'machine', 'varchar', '', $char_d, '', '',
1711 'exporttype', 'varchar', '', $char_d, '', '',
1712 'nodomain', 'char', 'NULL', 1, '', '',
1714 'primary_key' => 'exportnum',
1716 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1719 'part_export_option' => {
1721 'optionnum', 'serial', '', '', '', '',
1722 'exportnum', 'int', '', '', '', '',
1723 'optionname', 'varchar', '', $char_d, '', '',
1724 'optionvalue', 'text', 'NULL', '', '', '',
1726 'primary_key' => 'optionnum',
1728 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1731 'radius_usergroup' => {
1733 'usergroupnum', 'serial', '', '', '', '',
1734 'svcnum', 'int', '', '', '', '',
1735 'groupname', 'varchar', '', $char_d, '', '',
1737 'primary_key' => 'usergroupnum',
1739 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1744 'msgnum', 'serial', '', '', '', '',
1745 'msgcode', 'varchar', '', $char_d, '', '',
1746 'locale', 'varchar', '', 16, '', '',
1747 'msg', 'text', '', '', '', '',
1749 'primary_key' => 'msgnum',
1750 'unique' => [ [ 'msgcode', 'locale' ] ],
1754 'cust_tax_exempt' => {
1756 'exemptnum', 'serial', '', '', '', '',
1757 'custnum', 'int', '', '', '', '',
1758 'taxnum', 'int', '', '', '', '',
1759 'year', 'int', '', '', '', '',
1760 'month', 'int', '', '', '', '',
1761 'amount', @money_type, '', '',
1763 'primary_key' => 'exemptnum',
1764 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1768 'cust_tax_exempt_pkg' => {
1770 'exemptpkgnum', 'serial', '', '', '', '',
1771 #'custnum', 'int', '', '', '', ''
1772 'billpkgnum', 'int', '', '', '', '',
1773 'taxnum', 'int', '', '', '', '',
1774 'year', 'int', '', '', '', '',
1775 'month', 'int', '', '', '', '',
1776 'amount', @money_type, '', '',
1778 'primary_key' => 'exemptpkgnum',
1780 'index' => [ [ 'taxnum', 'year', 'month' ],
1788 'routernum', 'serial', '', '', '', '',
1789 'routername', 'varchar', '', $char_d, '', '',
1790 'svcnum', 'int', 'NULL', '', '', '',
1791 'agentnum', 'int', 'NULL', '', '', '',
1793 'primary_key' => 'routernum',
1798 'part_svc_router' => {
1800 'svcrouternum', 'serial', '', '', '', '',
1801 'svcpart', 'int', '', '', '', '',
1802 'routernum', 'int', '', '', '', '',
1804 'primary_key' => 'svcrouternum',
1811 'blocknum', 'serial', '', '', '', '',
1812 'routernum', 'int', '', '', '', '',
1813 'ip_gateway', 'varchar', '', 15, '', '',
1814 'ip_netmask', 'int', '', '', '', '',
1815 'agentnum', 'int', 'NULL', '', '', '',
1816 'manual_flag', 'char', 'NULL', 1, '', '',
1818 'primary_key' => 'blocknum',
1819 'unique' => [ [ 'blocknum', 'routernum' ] ],
1823 'svc_broadband' => {
1825 'svcnum', 'int', '', '', '', '',
1826 'description', 'varchar', 'NULL', $char_d, '', '',
1827 'blocknum', 'int', 'NULL', '', '', '',
1828 'speed_up', 'int', '', '', '', '',
1829 'speed_down', 'int', '', '', '', '',
1830 'ip_addr', 'varchar', 'NULL', 15, '', '',
1831 'mac_addr', 'varchar', 'NULL', 12, '', '',
1832 'authkey', 'varchar', 'NULL', 32, '', '',
1833 'latitude', 'decimal', 'NULL', '', '', '',
1834 'longitude', 'decimal', 'NULL', '', '', '',
1835 'altitude', 'decimal', 'NULL', '', '', '',
1836 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1837 'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1839 'primary_key' => 'svcnum',
1840 'unique' => [ [ 'mac_addr' ] ],
1844 'part_virtual_field' => {
1846 'vfieldpart', 'serial', '', '', '', '',
1847 'dbtable', 'varchar', '', 32, '', '',
1848 'name', 'varchar', '', 32, '', '',
1849 'check_block', 'text', 'NULL', '', '', '',
1850 'length', 'int', 'NULL', '', '', '',
1851 'list_source', 'text', 'NULL', '', '', '',
1852 'label', 'varchar', 'NULL', 80, '', '',
1854 'primary_key' => 'vfieldpart',
1859 'virtual_field' => {
1861 'vfieldnum', 'serial', '', '', '', '',
1862 'recnum', 'int', '', '', '', '',
1863 'vfieldpart', 'int', '', '', '', '',
1864 'value', 'varchar', '', 128, '', '',
1866 'primary_key' => 'vfieldnum',
1867 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1873 'snarfnum', 'int', '', '', '', '',
1874 'svcnum', 'int', '', '', '', '',
1875 'machine', 'varchar', '', 255, '', '',
1876 'protocol', 'varchar', '', $char_d, '', '',
1877 'username', 'varchar', '', $char_d, '', '',
1878 '_password', 'varchar', '', $char_d, '', '',
1880 'primary_key' => 'snarfnum',
1882 'index' => [ [ 'svcnum' ] ],
1887 'svcnum', 'int', '', '', '', '',
1888 'id', 'int', 'NULL', '', '', '',
1889 'title', 'varchar', 'NULL', $char_d, '', '',
1891 'primary_key' => 'svcnum',
1896 'cust_pay_refund' => {
1898 'payrefundnum', 'serial', '', '', '', '',
1899 'paynum', 'int', '', '', '', '',
1900 'refundnum', 'int', '', '', '', '',
1901 '_date', @date_type, '', '',
1902 'amount', @money_type, '', '',
1904 'primary_key' => 'payrefundnum',
1906 'index' => [ ['paynum'], ['refundnum'] ],
1909 'part_pkg_option' => {
1911 'optionnum', 'serial', '', '', '', '',
1912 'pkgpart', 'int', '', '', '', '',
1913 'optionname', 'varchar', '', $char_d, '', '',
1914 'optionvalue', 'text', 'NULL', '', '', '',
1916 'primary_key' => 'optionnum',
1918 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1921 'part_pkg_report_option' => {
1923 'num', 'serial', '', '', '', '',
1924 'name', 'varchar', '', $char_d, '', '',
1925 'disabled', 'char', 'NULL', 1, '', '',
1927 'primary_key' => 'num',
1928 'unique' => [ [ 'name' ] ],
1929 'index' => [ [ 'disabled' ] ],
1934 'ratenum', 'serial', '', '', '', '',
1935 'ratename', 'varchar', '', $char_d, '', '',
1937 'primary_key' => 'ratenum',
1944 'ratedetailnum', 'serial', '', '', '', '',
1945 'ratenum', 'int', '', '', '', '',
1946 'orig_regionnum', 'int', 'NULL', '', '', '',
1947 'dest_regionnum', 'int', '', '', '', '',
1948 'min_included', 'int', '', '', '', '',
1949 #'min_charge', @money_type, '', '',
1950 'min_charge', 'decimal', '', '10,5', '', '',
1951 'sec_granularity', 'int', '', '', '', '',
1952 #time period (link to table of periods)?
1953 'classnum', 'int', 'NULL', '', '', '',
1955 'primary_key' => 'ratedetailnum',
1956 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1957 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1962 'regionnum', 'serial', '', '', '', '',
1963 'regionname', 'varchar', '', $char_d, '', '',
1965 'primary_key' => 'regionnum',
1972 'prefixnum', 'serial', '', '', '', '',
1973 'regionnum', 'int', '', '', '', '',
1974 'countrycode', 'varchar', '', 3, '', '',
1975 'npa', 'varchar', 'NULL', 10, '', '', #actually the whole prefix
1976 'nxx', 'varchar', 'NULL', 3, '', '', #actually not used
1978 'primary_key' => 'prefixnum',
1980 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1985 'classnum', 'serial', '', '', '', '',
1986 'classname', 'varchar', '', $char_d, '', '',
1987 'disabled', 'char', 'NULL', 1, '', '',
1989 'primary_key' => 'classnum',
1991 'index' => [ ['disabled'] ],
1996 'codenum', 'serial', '', '', '', '',
1997 'code', 'varchar', '', $char_d, '', '',
1998 'agentnum', 'int', '', '', '', '',
2000 'primary_key' => 'codenum',
2001 'unique' => [ [ 'agentnum', 'code' ] ],
2002 'index' => [ [ 'agentnum' ] ],
2007 'codepkgnum', 'serial', '', '', '', '',
2008 'codenum', 'int', '', '', '', '',
2009 'pkgpart', 'int', '', '', '', '',
2011 'primary_key' => 'codepkgnum',
2012 'unique' => [ [ 'codenum', 'pkgpart' ] ],
2013 'index' => [ [ 'codenum' ] ],
2016 'clientapi_session' => {
2018 'sessionnum', 'serial', '', '', '', '',
2019 'sessionid', 'varchar', '', $char_d, '', '',
2020 'namespace', 'varchar', '', $char_d, '', '',
2022 'primary_key' => 'sessionnum',
2023 'unique' => [ [ 'sessionid', 'namespace' ] ],
2027 'clientapi_session_field' => {
2029 'fieldnum', 'serial', '', '', '', '',
2030 'sessionnum', 'int', '', '', '', '',
2031 'fieldname', 'varchar', '', $char_d, '', '',
2032 'fieldvalue', 'text', 'NULL', '', '', '',
2034 'primary_key' => 'fieldnum',
2035 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
2039 'payment_gateway' => {
2041 'gatewaynum', 'serial', '', '', '', '',
2042 'gateway_namespace','varchar', 'NULL', $char_d, '', '',
2043 'gateway_module', 'varchar', '', $char_d, '', '',
2044 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
2045 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
2046 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
2047 'gateway_callback_url', 'varchar', 'NULL', $char_d, '', '',
2048 'disabled', 'char', 'NULL', 1, '', '',
2050 'primary_key' => 'gatewaynum',
2052 'index' => [ [ 'disabled' ] ],
2055 'payment_gateway_option' => {
2057 'optionnum', 'serial', '', '', '', '',
2058 'gatewaynum', 'int', '', '', '', '',
2059 'optionname', 'varchar', '', $char_d, '', '',
2060 'optionvalue', 'text', 'NULL', '', '', '',
2062 'primary_key' => 'optionnum',
2064 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2067 'agent_payment_gateway' => {
2069 'agentgatewaynum', 'serial', '', '', '', '',
2070 'agentnum', 'int', '', '', '', '',
2071 'gatewaynum', 'int', '', '', '', '',
2072 'cardtype', 'varchar', 'NULL', $char_d, '', '',
2073 'taxclass', 'varchar', 'NULL', $char_d, '', '',
2075 'primary_key' => 'agentgatewaynum',
2077 'index' => [ [ 'agentnum', 'cardtype' ], ],
2082 'bannum', 'serial', '', '', '', '',
2083 'payby', 'char', '', 4, '', '',
2084 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
2085 #'paymask', 'varchar', 'NULL', $char_d, '', ''
2086 '_date', @date_type, '', '',
2087 'otaker', 'varchar', '', 32, '', '',
2088 'reason', 'varchar', 'NULL', $char_d, '', '',
2090 'primary_key' => 'bannum',
2091 'unique' => [ [ 'payby', 'payinfo' ] ],
2097 'categorynum', 'serial', '', '', '', '',
2098 'categoryname', 'varchar', '', $char_d, '', '',
2099 'weight', 'int', 'NULL', '', '', '',
2100 'disabled', 'char', 'NULL', 1, '', '',
2102 'primary_key' => 'categorynum',
2104 'index' => [ ['disabled'] ],
2109 'classnum', 'serial', '', '', '', '',
2110 'classname', 'varchar', '', $char_d, '', '',
2111 'categorynum', 'int', 'NULL', '', '', '',
2112 'disabled', 'char', 'NULL', 1, '', '',
2114 'primary_key' => 'classnum',
2116 'index' => [ ['disabled'] ],
2121 # qw( name type null length default local );
2127 'acctid', 'bigserial', '', '', '', '',
2128 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2129 'calldate', 'timestamp', '', '', \'now()', '',
2130 'clid', 'varchar', '', $char_d, \"''", '',
2131 'src', 'varchar', '', $char_d, \"''", '',
2132 'dst', 'varchar', '', $char_d, \"''", '',
2133 'dcontext', 'varchar', '', $char_d, \"''", '',
2134 'channel', 'varchar', '', $char_d, \"''", '',
2135 'dstchannel', 'varchar', '', $char_d, \"''", '',
2136 'lastapp', 'varchar', '', $char_d, \"''", '',
2137 'lastdata', 'varchar', '', $char_d, \"''", '',
2139 #these don't seem to be logged by most of the SQL cdr_* modules
2140 #except tds under sql-illegal names, so;
2141 # ... don't rely on them for rating?
2142 # and, what they hey, i went ahead and changed the names and data types
2143 # to freeside-style dates...
2144 #'start', 'timestamp', 'NULL', '', '', '',
2145 #'answer', 'timestamp', 'NULL', '', '', '',
2146 #'end', 'timestamp', 'NULL', '', '', '',
2147 'startdate', @date_type, '', '',
2148 'answerdate', @date_type, '', '',
2149 'enddate', @date_type, '', '',
2152 'duration', 'int', '', '', 0, '',
2153 'billsec', 'int', '', '', 0, '',
2154 'disposition', 'varchar', '', 45, \"''", '',
2155 'amaflags', 'int', '', '', 0, '',
2156 'accountcode', 'varchar', '', 20, \"''", '',
2157 'uniqueid', 'varchar', '', 32, \"''", '',
2158 'userfield', 'varchar', '', 255, \"''", '',
2161 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2163 # though these are now used elsewhere:
2164 # charged_party, upstream_price, rated_price, carrierid
2167 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2168 'cdrtypenum', 'int', 'NULL', '', '', '',
2170 'charged_party', 'varchar', 'NULL', $char_d, '', '',
2172 'upstream_currency', 'char', 'NULL', 3, '', '',
2173 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
2174 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
2176 # how it was rated internally...
2177 'ratedetailnum', 'int', 'NULL', '', '', '',
2178 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2180 'distance', 'decimal', 'NULL', '', '', '',
2181 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
2183 #cdr_calltype: the big list in appendix 2
2184 'calltypenum', 'int', 'NULL', '', '', '',
2186 'description', 'varchar', 'NULL', $char_d, '', '',
2187 'quantity', 'int', 'NULL', '', '', '',
2189 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2190 'carrierid', 'int', 'NULL', '', '', '',
2192 'upstream_rateid', 'int', 'NULL', '', '', '',
2195 #and now for our own fields
2198 # a svcnum... right..?
2199 'svcnum', 'int', 'NULL', '', '', '',
2201 #NULL, done (or something)
2202 'freesidestatus', 'varchar', 'NULL', 32, '', '',
2204 #NULL, done (or something)
2205 'freesiderewritestatus', 'varchar', 'NULL', 32, '', '',
2207 #an indexed place to put big numbers
2208 'cdrid', 'bigint', 'NULL', '', '', '',
2210 #i should become a table
2211 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2212 #'cdrbatchnum', 'int', 'NULL', '', '', '',
2215 'primary_key' => 'acctid',
2217 'index' => [ [ 'calldate' ],
2218 [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2219 [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2220 [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2227 # 'cdrbatchnum', 'serial', '', '', '', '',
2228 # 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2229 # '_date', @date_type, '', '',
2231 # 'primary_key' => 'cdrbatchnum',
2232 # 'unique' => [ [ 'cdrbatch' ] ],
2236 'cdr_termination' => {
2238 'cdrtermnum', 'bigserial', '', '', '', '',
2239 'acctid', 'bigint', '', '', '', '',
2240 'termpart', 'int', '', '', '', '',#future use see below
2241 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2242 'status', 'varchar', 'NULL', 32, '', '',
2244 'primary_key' => 'cdrtermnum',
2245 'unique' => [ [ 'acctid', 'termpart' ] ],
2246 'index' => [ [ 'acctid' ], [ 'status' ], ],
2249 #to handle multiple termination/settlement passes...
2250 # 'part_termination' => {
2252 # 'termpart', 'int', '', '', '', '',
2253 # 'termname', 'varchar', '', $char_d, '', '',
2254 # 'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2256 # 'primary_key' => 'termpart',
2261 #the remaining cdr_ tables are not really used
2264 'calltypenum', 'serial', '', '', '', '',
2265 'calltypename', 'varchar', '', $char_d, '', '',
2267 'primary_key' => 'calltypenum',
2274 'cdrtypenum' => 'serial', '', '', '', '',
2275 'cdrtypename' => 'varchar', '', $char_d, '', '',
2277 'primary_key' => 'cdrtypenum',
2284 'carrierid' => 'serial', '', '', '', '',
2285 'carriername' => 'varchar', '', $char_d, '', '',
2287 'primary_key' => 'carrierid',
2294 # 'filenum', 'serial', '', '', '', '',
2295 # 'filename', 'varchar', '', '', '', '',
2296 # 'status', 'varchar', 'NULL', '', '', '',
2298 # 'primary_key' => 'filenum',
2299 # 'unique' => [ [ 'filename' ], ], #just change the index if we need to
2300 # # agent-virtualize or have a customer
2301 # # with dup-filename needs or something
2302 # # (only used by cdr.http_and_import for
2307 'inventory_item' => {
2309 'itemnum', 'serial', '', '', '', '',
2310 'classnum', 'int', '', '', '', '',
2311 'item', 'varchar', '', $char_d, '', '',
2312 'svcnum', 'int', 'NULL', '', '', '',
2314 'primary_key' => 'itemnum',
2315 'unique' => [ [ 'classnum', 'item' ] ],
2316 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2319 'inventory_class' => {
2321 'classnum', 'serial', '', '', '', '',
2322 'classname', 'varchar', '', $char_d, '', '',
2324 'primary_key' => 'classnum',
2331 'usernum', 'serial', '', '', '', '',
2332 'username', 'varchar', '', $char_d, '', '',
2333 '_password', 'varchar', '', $char_d, '', '',
2334 'last', 'varchar', '', $char_d, '', '',
2335 'first', 'varchar', '', $char_d, '', '',
2336 'disabled', 'char', 'NULL', 1, '', '',
2338 'primary_key' => 'usernum',
2339 'unique' => [ [ 'username' ] ],
2343 'access_user_pref' => {
2345 'prefnum', 'serial', '', '', '', '',
2346 'usernum', 'int', '', '', '', '',
2347 'prefname', 'varchar', '', $char_d, '', '',
2348 'prefvalue', 'text', 'NULL', '', '', '',
2349 'expiration', @date_type, '', '',
2351 'primary_key' => 'prefnum',
2353 'index' => [ [ 'usernum' ] ],
2358 'groupnum', 'serial', '', '', '', '',
2359 'groupname', 'varchar', '', $char_d, '', '',
2361 'primary_key' => 'groupnum',
2362 'unique' => [ [ 'groupname' ] ],
2366 'access_usergroup' => {
2368 'usergroupnum', 'serial', '', '', '', '',
2369 'usernum', 'int', '', '', '', '',
2370 'groupnum', 'int', '', '', '', '',
2372 'primary_key' => 'usergroupnum',
2373 'unique' => [ [ 'usernum', 'groupnum' ] ],
2374 'index' => [ [ 'usernum' ] ],
2377 'access_groupagent' => {
2379 'groupagentnum', 'serial', '', '', '', '',
2380 'groupnum', 'int', '', '', '', '',
2381 'agentnum', 'int', '', '', '', '',
2383 'primary_key' => 'groupagentnum',
2384 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2385 'index' => [ [ 'groupnum' ] ],
2390 'rightnum', 'serial', '', '', '', '',
2391 'righttype', 'varchar', '', $char_d, '', '',
2392 'rightobjnum', 'int', '', '', '', '',
2393 'rightname', 'varchar', '', $char_d, '', '',
2395 'primary_key' => 'rightnum',
2396 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2402 'svcnum', 'int', '', '', '', '',
2403 'countrycode', 'varchar', '', 3, '', '',
2404 'phonenum', 'varchar', '', 15, '', '', #12 ?
2405 'pin', 'varchar', 'NULL', $char_d, '', '',
2406 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2407 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2409 'primary_key' => 'svcnum',
2411 'index' => [ [ 'countrycode', 'phonenum' ] ],
2416 'devicenum', 'serial', '', '', '', '',
2417 'devicepart', 'int', '', '', '', '',
2418 'svcnum', 'int', '', '', '', '',
2419 'mac_addr', 'varchar', 'NULL', 12, '', '',
2421 'primary_key' => 'devicenum',
2422 'unique' => [ [ 'mac_addr' ], ],
2423 'index' => [ [ 'devicepart' ], [ 'svcnum' ], ],
2428 'devicepart', 'serial', '', '', '', '',
2429 'devicename', 'varchar', '', $char_d, '', '',
2430 #'classnum', #tie to an inventory class?
2432 'primary_key' => 'devicepart',
2433 'unique' => [ [ 'devicename' ] ], #?
2439 'availnum', 'serial', '', '', '', '',
2440 'exportnum', 'int', '', '', '', '',
2441 'countrycode', 'varchar', '', 3, '', '',
2442 'state', 'char', 'NULL', 2, '', '',
2443 'npa', 'char', '', 3, '', '',
2444 'nxx', 'char', 'NULL', 3, '', '',
2445 'station', 'char', 'NULL', 4, '', '',
2446 'name', 'varchar', 'NULL', $char_d, '', '',
2447 'svcnum', 'int', 'NULL', '', '', '',
2448 'availbatch', 'varchar', 'NULL', $char_d, '', '',
2450 'primary_key' => 'availnum',
2452 'index' => [ [ 'exportnum', 'countrycode', 'state' ], #npa search
2453 [ 'exportnum', 'countrycode', 'npa' ], #nxx search
2454 [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2455 [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2463 'typenum', 'serial', '', '', '', '',
2464 'class', 'char', '', 1, '', '',
2465 'type', 'varchar', '', $char_d, '', '',
2467 'primary_key' => 'typenum',
2474 'reasonnum', 'serial', '', '', '', '',
2475 'reason_type', 'int', '', '', '', '',
2476 'reason', 'text', '', '', '', '',
2477 'disabled', 'char', 'NULL', 1, '', '',
2479 'primary_key' => 'reasonnum',
2486 'confnum', 'serial', '', '', '', '',
2487 'agentnum', 'int', 'NULL', '', '', '',
2488 'name', 'varchar', '', $char_d, '', '',
2489 'value', 'text', 'NULL', '', '', '',
2491 'primary_key' => 'confnum',
2492 'unique' => [ [ 'agentnum', 'name' ]],
2498 'pkgrefnum', 'serial', '', '', '', '',
2499 'pkgnum', 'int', '', '', '', '',
2500 'refnum', 'int', '', '', '', '',
2502 'primary_key' => 'pkgrefnum',
2503 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2504 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2506 # name type nullability length default local
2510 # 'num', 'serial', '', '', '', '',
2512 # 'primary_key' => 'num',