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(uc($1).'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', '', 255, '', '',
382 'mime_type', 'varchar', '', $char_d, '', '',
383 'title', 'varchar', 'NULL', $char_d, '', '',
384 'body', 'blob', 'NULL', '', '', '',
385 'disabled', @date_type, '', '',
387 'primary_key' => 'attachnum',
389 'index' => [ ['custnum'] ],
395 'invnum', 'serial', '', '', '', '',
396 'custnum', 'int', '', '', '', '',
397 '_date', @date_type, '', '',
398 'charged', @money_type, '', '',
399 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
401 #customer balance info at invoice generation time
402 'previous_balance', @money_typen, '', '', #eventually not nullable
403 'billing_balance', @money_typen, '', '', #eventually not nullable
405 #deprecated (unused by now, right?)
406 'printed', 'int', '', '', '', '',
409 'closed', 'char', 'NULL', 1, '', '',
410 'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
412 'primary_key' => 'invnum',
414 'index' => [ ['custnum'], ['_date'], ['statementnum'], ],
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 'duration', 'int', 'NULL', '', 0, '',
577 'phonenum', 'varchar', 'NULL', 15, '', '',
578 'regionname', 'varchar', 'NULL', $char_d, '', '',
579 'detail', 'varchar', '', 255, '', '',
581 'primary_key' => 'detailnum',
583 'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
586 'cust_bill_pkg_display' => {
588 'billpkgdisplaynum', 'serial', '', '', '', '',
589 'billpkgnum', 'int', '', '', '', '',
590 'section', 'varchar', 'NULL', $char_d, '', '',
591 #'unitsetup', @money_typen, '', '', #override the linked real one?
592 #'unitrecur', @money_typen, '', '', #this too?
593 'post_total', 'char', 'NULL', 1, '', '',
594 'type', 'char', 'NULL', 1, '', '',
595 'summary', 'char', 'NULL', 1, '', '',
597 'primary_key' => 'billpkgdisplaynum',
599 'index' => [ ['billpkgnum'], ],
602 'cust_bill_pkg_tax_location' => {
604 'billpkgtaxlocationnum', 'serial', '', '', '', '',
605 'billpkgnum', 'int', '', '', '', '',
606 'taxnum', 'int', '', '', '', '',
607 'taxtype', 'varchar', '', $char_d, '', '',
608 'pkgnum', 'int', '', '', '', '',
609 'locationnum', 'int', '', '', '', '', #redundant?
610 'amount', @money_type, '', '',
612 'primary_key' => 'billpkgtaxlocationnum',
614 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
617 'cust_bill_pkg_tax_rate_location' => {
619 'billpkgtaxratelocationnum', 'serial', '', '', '', '',
620 'billpkgnum', 'int', '', '', '', '',
621 'taxnum', 'int', '', '', '', '',
622 'taxtype', 'varchar', '', $char_d, '', '',
623 'locationtaxid', 'varchar', 'NULL', $char_d, '', '',
624 'taxratelocationnum', 'int', '', '', '', '',
625 'amount', @money_type, '', '',
627 'primary_key' => 'billpkgtaxratelocationnum',
629 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
634 'crednum', 'serial', '', '', '', '',
635 'custnum', 'int', '', '', '', '',
636 '_date', @date_type, '', '',
637 'amount', @money_type, '', '',
638 'otaker', 'varchar', '', 32, '', '',
639 'reason', 'text', 'NULL', '', '', '',
640 'reasonnum', 'int', 'NULL', '', '', '',
641 'addlinfo', 'text', 'NULL', '', '', '',
642 'closed', 'char', 'NULL', 1, '', '',
643 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
645 'primary_key' => 'crednum',
647 'index' => [ ['custnum'], ['_date'] ],
650 'cust_credit_bill' => {
652 'creditbillnum', 'serial', '', '', '', '',
653 'crednum', 'int', '', '', '', '',
654 'invnum', 'int', '', '', '', '',
655 '_date', @date_type, '', '',
656 'amount', @money_type, '', '',
657 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
659 'primary_key' => 'creditbillnum',
661 'index' => [ ['crednum'], ['invnum'] ],
664 'cust_credit_bill_pkg' => {
666 'creditbillpkgnum', 'serial', '', '', '', '',
667 'creditbillnum', 'int', '', '', '', '',
668 'billpkgnum', 'int', '', '', '', '',
669 'amount', @money_type, '', '',
670 'setuprecur', 'varchar', '', $char_d, '', '',
671 'sdate', @date_type, '', '',
672 'edate', @date_type, '', '',
674 'primary_key' => 'creditbillpkgnum',
676 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
681 'custnum', 'serial', '', '', '', '',
682 'agentnum', 'int', '', '', '', '',
683 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
684 'custbatch', 'varchar', 'NULL', $char_d, '', '',
685 # 'titlenum', 'int', 'NULL', '', '', '',
686 'last', 'varchar', '', $char_d, '', '',
687 # 'middle', 'varchar', 'NULL', $char_d, '', '',
688 'first', 'varchar', '', $char_d, '', '',
689 'ss', 'varchar', 'NULL', 11, '', '',
690 'stateid', 'varchar', 'NULL', $char_d, '', '',
691 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
692 'birthdate' ,@date_type, '', '',
693 'signupdate',@date_type, '', '',
694 'dundate', @date_type, '', '',
695 'company', 'varchar', 'NULL', $char_d, '', '',
696 'address1', 'varchar', '', $char_d, '', '',
697 'address2', 'varchar', 'NULL', $char_d, '', '',
698 'city', 'varchar', '', $char_d, '', '',
699 'county', 'varchar', 'NULL', $char_d, '', '',
700 'state', 'varchar', 'NULL', $char_d, '', '',
701 'zip', 'varchar', 'NULL', 10, '', '',
702 'country', 'char', '', 2, '', '',
703 'daytime', 'varchar', 'NULL', 20, '', '',
704 'night', 'varchar', 'NULL', 20, '', '',
705 'fax', 'varchar', 'NULL', 12, '', '',
706 'ship_last', 'varchar', 'NULL', $char_d, '', '',
707 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
708 'ship_first', 'varchar', 'NULL', $char_d, '', '',
709 'ship_company', 'varchar', 'NULL', $char_d, '', '',
710 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
711 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
712 'ship_city', 'varchar', 'NULL', $char_d, '', '',
713 'ship_county', 'varchar', 'NULL', $char_d, '', '',
714 'ship_state', 'varchar', 'NULL', $char_d, '', '',
715 'ship_zip', 'varchar', 'NULL', 10, '', '',
716 'ship_country', 'char', 'NULL', 2, '', '',
717 'ship_daytime', 'varchar', 'NULL', 20, '', '',
718 'ship_night', 'varchar', 'NULL', 20, '', '',
719 'ship_fax', 'varchar', 'NULL', 12, '', '',
720 'payby', 'char', '', 4, '', '',
721 'payinfo', 'varchar', 'NULL', 512, '', '',
722 'paycvv', 'varchar', 'NULL', 512, '', '',
723 'paymask', 'varchar', 'NULL', $char_d, '', '',
724 #'paydate', @date_type, '', '',
725 'paydate', 'varchar', 'NULL', 10, '', '',
726 'paystart_month', 'int', 'NULL', '', '', '',
727 'paystart_year', 'int', 'NULL', '', '', '',
728 'payissue', 'varchar', 'NULL', 2, '', '',
729 'payname', 'varchar', 'NULL', $char_d, '', '',
730 'paystate', 'varchar', 'NULL', $char_d, '', '',
731 'paytype', 'varchar', 'NULL', $char_d, '', '',
732 'payip', 'varchar', 'NULL', 15, '', '',
733 'geocode', 'varchar', 'NULL', 20, '', '',
734 'censustract', 'varchar', 'NULL', 20, '', '', # 7 to save space?
735 'tax', 'char', 'NULL', 1, '', '',
736 'otaker', 'varchar', '', 32, '', '',
737 'refnum', 'int', '', '', '', '',
738 'referral_custnum', 'int', 'NULL', '', '', '',
739 'comments', 'text', 'NULL', '', '', '',
740 'spool_cdr','char', 'NULL', 1, '', '',
741 'squelch_cdr','char', 'NULL', 1, '', '',
742 'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
743 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
744 'archived', 'char', 'NULL', 1, '', '',
745 'email_csv_cdr', 'char', 'NULL', 1, '', '',
747 'primary_key' => 'custnum',
748 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
749 #'index' => [ ['last'], ['company'] ],
751 [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
752 [ 'referral_custnum' ],
753 [ 'payby' ], [ 'paydate' ],
756 [ 'last' ], [ 'company' ],
757 [ 'county' ], [ 'state' ], [ 'country' ],
759 [ 'daytime' ], [ 'night' ], [ 'fax' ],
761 [ 'ship_last' ], [ 'ship_company' ],
762 [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
764 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
768 'cust_recon' => { # what purpose does this serve?
770 'reconid', 'serial', '', '', '', '',
771 'recondate', @date_type, '', '',
772 'custnum', 'int' , '', '', '', '',
773 'agentnum', 'int', '', '', '', '',
774 'last', 'varchar', '', $char_d, '', '',
775 'first', 'varchar', '', $char_d, '', '',
776 'address1', 'varchar', '', $char_d, '', '',
777 'address2', 'varchar', 'NULL', $char_d, '', '',
778 'city', 'varchar', '', $char_d, '', '',
779 'state', 'varchar', 'NULL', $char_d, '', '',
780 'zip', 'varchar', 'NULL', 10, '', '',
781 'pkg', 'varchar', 'NULL', $char_d, '', '',
782 'adjourn', @date_type, '', '',
783 'status', 'varchar', 'NULL', 10, '', '',
784 'agent_custid', 'varchar', '', $char_d, '', '',
785 'agent_pkg', 'varchar', 'NULL', $char_d, '', '',
786 'agent_adjourn', @date_type, '', '',
787 'comments', 'text', 'NULL', '', '', '',
789 'primary_key' => 'reconid',
794 #eventually use for billing & ship from cust_main too
795 #for now, just cust_pkg locations
798 'locationnum', 'serial', '', '', '', '',
799 'custnum', 'int', '', '', '', '',
800 'address1', 'varchar', '', $char_d, '', '',
801 'address2', 'varchar', 'NULL', $char_d, '', '',
802 'city', 'varchar', '', $char_d, '', '',
803 'county', 'varchar', 'NULL', $char_d, '', '',
804 'state', 'varchar', 'NULL', $char_d, '', '',
805 'zip', 'varchar', 'NULL', 10, '', '',
806 'country', 'char', '', 2, '', '',
807 'geocode', 'varchar', 'NULL', 20, '', '',
809 'primary_key' => 'locationnum',
811 'index' => [ [ 'custnum' ],
812 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
816 'cust_main_invoice' => {
818 'destnum', 'serial', '', '', '', '',
819 'custnum', 'int', '', '', '', '',
820 'dest', 'varchar', '', $char_d, '', '',
822 'primary_key' => 'destnum',
824 'index' => [ ['custnum'], ],
827 'cust_main_note' => {
829 'notenum', 'serial', '', '', '', '',
830 'custnum', 'int', '', '', '', '',
831 '_date', @date_type, '', '',
832 'otaker', 'varchar', '', 32, '', '',
833 'comments', 'text', 'NULL', '', '', '',
835 'primary_key' => 'notenum',
837 'index' => [ [ 'custnum' ], [ '_date' ], ],
840 'cust_main_exemption' => {
842 'exemptionnum', 'serial', '', '', '', '',
843 'custnum', 'int', '', '', '', '',
844 'taxname', 'varchar', '', $char_d, '', '',
845 #start/end dates? for reporting?
847 'primary_key' => 'exemptionnum',
849 'index' => [ [ 'custnum' ] ],
852 'cust_tax_adjustment' => {
854 'adjustmentnum', 'serial', '', '', '', '',
855 'custnum', 'int', '', '', '', '',
856 'taxname', 'varchar', '', $char_d, '', '',
857 'amount', @money_type, '', '',
858 'comment', 'varchar', 'NULL', $char_d, '', '',
859 'billpkgnum', 'int', 'NULL', '', '', '',
860 #more? no cust_bill_pkg_tax_location?
862 'primary_key' => 'adjustmentnum',
864 'index' => [ [ 'custnum' ], [ 'billpkgnum' ] ],
867 'cust_main_county' => { #county+state+country are checked off the
868 #cust_main_county for validation and to provide
871 'taxnum', 'serial', '', '', '', '',
872 'state', 'varchar', 'NULL', $char_d, '', '',
873 'county', 'varchar', 'NULL', $char_d, '', '',
874 'country', 'char', '', 2, '', '',
875 'taxclass', 'varchar', 'NULL', $char_d, '', '',
876 'exempt_amount', @money_type, '', '',
877 'tax', 'real', '', '', '', '', #tax %
878 'taxname', 'varchar', 'NULL', $char_d, '', '',
879 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
880 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
882 'primary_key' => 'taxnum',
884 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
885 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
892 'taxnum', 'serial', '', '', '', '',
893 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
894 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
895 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
896 'taxclassnum', 'int', '', '', '', '',
897 'effective_date', @date_type, '', '',
898 'tax', @taxrate_type, '', '', # tax %
899 'excessrate', @taxrate_typen, '', '', # second tax %
900 'taxbase', @money_typen, '', '', # amount at first tax rate
901 'taxmax', @money_typen, '', '', # maximum about at both rates
902 'usetax', @taxrate_typen, '', '', # tax % when non-local
903 'useexcessrate', @taxrate_typen, '', '', # second tax % when non-local
904 'unittype', 'int', 'NULL', '', '', '', # for fee
905 'fee', @taxrate_typen, '', '', # amount tax per unit
906 'excessfee', @taxrate_typen, '', '', # second amount tax per unit
907 'feebase', @taxrate_typen, '', '', # units taxed at first rate
908 'feemax', @taxrate_typen, '', '', # maximum number of unit taxed
909 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
910 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
911 'taxauth', 'int', 'NULL', '', '', '', # tax authority
912 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
913 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
914 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
915 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
916 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
917 'inoutcity', 'char', 'NULL', 1, '', '', # '', 'I', or 'O'
918 'inoutlocal', 'char', 'NULL', 1, '', '', # '', 'I', or 'O'
919 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
920 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
922 'primary_key' => 'taxnum',
924 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
927 'tax_rate_location' => {
929 'taxratelocationnum', 'serial', '', '', '', '',
930 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
931 'geocode', 'varchar', '', 20, '', '',
932 'city', 'varchar', 'NULL', $char_d, '', '',
933 'county', 'varchar', 'NULL', $char_d, '', '',
934 'state', 'char', 'NULL', 2, '', '',
935 'disabled', 'char', 'NULL', 1, '', '',
937 'primary_key' => 'taxratelocationnum',
939 'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
942 'cust_tax_location' => {
944 'custlocationnum', 'serial', '', '', '', '',
945 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
946 'city', 'varchar', 'NULL', $char_d, '', '',
947 'postalcity', 'varchar', 'NULL', $char_d, '', '',
948 'county', 'varchar', 'NULL', $char_d, '', '',
949 'zip', 'char', '', 5, '', '',
950 'state', 'char', '', 2, '', '',
951 'plus4hi', 'char', 'NULL', 4, '', '',
952 'plus4lo', 'char', 'NULL', 4, '', '',
953 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
954 'cityflag', 'char', 'NULL', 1, '', '', # I(n)/O(out)/B(oth)/NULL
955 'geocode', 'varchar', '', 20, '', '',
957 'primary_key' => 'custlocationnum',
959 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
964 'taxclassnum', 'serial', '', '', '', '',
965 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
966 'taxclass', 'varchar', '', $char_d, '', '',
967 'description', 'varchar', '', 2*$char_d, '', '',
969 'primary_key' => 'taxclassnum',
970 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
974 'cust_pay_pending' => {
976 'paypendingnum','serial', '', '', '', '',
977 'custnum', 'int', '', '', '', '',
978 'paid', @money_type, '', '',
979 '_date', @date_type, '', '',
980 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
981 # be index into payby
983 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
984 'paymask', 'varchar', 'NULL', $char_d, '', '',
985 'paydate', 'varchar', 'NULL', 10, '', '',
986 'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
987 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
988 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
990 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
991 'status', 'varchar', '', $char_d, '', '',
992 'session_id', 'varchar', 'NULL', $char_d, '', '', #only need 32
993 'statustext', 'text', 'NULL', '', '', '',
994 'gatewaynum', 'int', 'NULL', '', '', '',
995 #'cust_balance', @money_type, '', '',
996 'paynum', 'int', 'NULL', '', '', '',
997 'jobnum', 'int', 'NULL', '', '', '',
999 'primary_key' => 'paypendingnum',
1000 'unique' => [ [ 'payunique' ] ],
1001 'index' => [ [ 'custnum' ], [ 'status' ], ],
1006 'paynum', 'serial', '', '', '', '',
1007 'custnum', 'int', '', '', '', '',
1008 '_date', @date_type, '', '',
1009 'paid', @money_type, '', '',
1010 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
1011 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1012 # index into payby table
1014 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1015 'paymask', 'varchar', 'NULL', $char_d, '', '',
1016 'paydate', 'varchar', 'NULL', 10, '', '',
1017 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1018 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1019 'closed', 'char', 'NULL', 1, '', '',
1020 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1022 'primary_key' => 'paynum',
1023 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1024 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
1027 'cust_pay_void' => {
1029 'paynum', 'int', '', '', '', '',
1030 'custnum', 'int', '', '', '', '',
1031 'paid', @money_type, '', '',
1032 '_date', @date_type, '', '',
1033 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1034 # index into payby table
1036 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1037 'paymask', 'varchar', 'NULL', $char_d, '', '',
1038 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1039 'closed', 'char', 'NULL', 1, '', '',
1040 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1041 'void_date', @date_type, '', '',
1042 'reason', 'varchar', 'NULL', $char_d, '', '',
1043 'otaker', 'varchar', '', 32, '', '',
1045 'primary_key' => 'paynum',
1047 'index' => [ [ 'custnum' ] ],
1050 'cust_bill_pay' => {
1052 'billpaynum', 'serial', '', '', '', '',
1053 'invnum', 'int', '', '', '', '',
1054 'paynum', 'int', '', '', '', '',
1055 'amount', @money_type, '', '',
1056 '_date', @date_type, '', '',
1057 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1059 'primary_key' => 'billpaynum',
1061 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1064 'cust_bill_pay_batch' => {
1066 'billpaynum', 'serial', '', '', '', '',
1067 'invnum', 'int', '', '', '', '',
1068 'paybatchnum', 'int', '', '', '', '',
1069 'amount', @money_type, '', '',
1070 '_date', @date_type, '', '',
1072 'primary_key' => 'billpaynum',
1074 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1077 'cust_bill_pay_pkg' => {
1079 'billpaypkgnum', 'serial', '', '', '', '',
1080 'billpaynum', 'int', '', '', '', '',
1081 'billpkgnum', 'int', '', '', '', '',
1082 'amount', @money_type, '', '',
1083 'setuprecur', 'varchar', '', $char_d, '', '',
1084 'sdate', @date_type, '', '',
1085 'edate', @date_type, '', '',
1087 'primary_key' => 'billpaypkgnum',
1089 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1092 'pay_batch' => { #batches of payments to an external processor
1094 'batchnum', 'serial', '', '', '', '',
1095 'payby', 'char', '', 4, '', '', # CARD/CHEK
1096 'status', 'char', 'NULL', 1, '', '',
1097 'download', @date_type, '', '',
1098 'upload', @date_type, '', '',
1100 'primary_key' => 'batchnum',
1105 'cust_pay_batch' => { #what's this used for again? list of customers
1106 #in current CARD batch? (necessarily CARD?)
1108 'paybatchnum', 'serial', '', '', '', '',
1109 'batchnum', 'int', '', '', '', '',
1110 'invnum', 'int', '', '', '', '',
1111 'custnum', 'int', '', '', '', '',
1112 'last', 'varchar', '', $char_d, '', '',
1113 'first', 'varchar', '', $char_d, '', '',
1114 'address1', 'varchar', '', $char_d, '', '',
1115 'address2', 'varchar', 'NULL', $char_d, '', '',
1116 'city', 'varchar', '', $char_d, '', '',
1117 'state', 'varchar', 'NULL', $char_d, '', '',
1118 'zip', 'varchar', 'NULL', 10, '', '',
1119 'country', 'char', '', 2, '', '',
1120 # 'trancode', 'int', '', '', '', ''
1121 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1122 'payinfo', 'varchar', '', 512, '', '',
1123 #'exp', @date_type, '', ''
1124 'exp', 'varchar', 'NULL', 11, '', '',
1125 'payname', 'varchar', 'NULL', $char_d, '', '',
1126 'amount', @money_type, '', '',
1127 'status', 'varchar', 'NULL', $char_d, '', '',
1129 'primary_key' => 'paybatchnum',
1131 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1136 'pkgnum', 'serial', '', '', '', '',
1137 'custnum', 'int', '', '', '', '',
1138 'pkgpart', 'int', '', '', '', '',
1139 'locationnum', 'int', 'NULL', '', '', '',
1140 'otaker', 'varchar', '', 32, '', '',
1141 'start_date', @date_type, '', '',
1142 'setup', @date_type, '', '',
1143 'bill', @date_type, '', '',
1144 'last_bill', @date_type, '', '',
1145 'susp', @date_type, '', '',
1146 'adjourn', @date_type, '', '',
1147 'cancel', @date_type, '', '',
1148 'expire', @date_type, '', '',
1149 'change_date', @date_type, '', '',
1150 'change_pkgnum', 'int', 'NULL', '', '', '',
1151 'change_pkgpart', 'int', 'NULL', '', '', '',
1152 'change_locationnum', 'int', 'NULL', '', '', '',
1153 'manual_flag', 'char', 'NULL', 1, '', '',
1154 'quantity', 'int', 'NULL', '', '', '',
1156 'primary_key' => 'pkgnum',
1158 'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1159 [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1160 ['susp'], ['adjourn'], ['expire'], ['cancel'],
1165 'cust_pkg_option' => {
1167 'optionnum', 'serial', '', '', '', '',
1168 'pkgnum', 'int', '', '', '', '',
1169 'optionname', 'varchar', '', $char_d, '', '',
1170 'optionvalue', 'text', 'NULL', '', '', '',
1172 'primary_key' => 'optionnum',
1174 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
1177 'cust_pkg_detail' => {
1179 'pkgdetailnum', 'serial', '', '', '', '',
1180 'pkgnum', 'int', '', '', '', '',
1181 'detail', 'varchar', '', $char_d, '', '',
1182 'detailtype', 'char', '', 1, '', '', # "I"nvoice or "C"omment
1183 'weight', 'int', '', '', '', '',
1185 'primary_key' => 'pkgdetailnum',
1187 'index' => [ [ 'pkgnum', 'detailtype' ] ],
1190 'cust_pkg_reason' => {
1192 'num', 'serial', '', '', '', '',
1193 'pkgnum', 'int', '', '', '', '',
1194 'reasonnum','int', '', '', '', '',
1195 'action', 'char', 'NULL', 1, '', '', #should not be nullable
1196 'otaker', 'varchar', '', 32, '', '',
1197 'date', @date_type, '', '',
1199 'primary_key' => 'num',
1201 'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1206 'refundnum', 'serial', '', '', '', '',
1207 'custnum', 'int', '', '', '', '',
1208 '_date', @date_type, '', '',
1209 'refund', @money_type, '', '',
1210 'otaker', 'varchar', '', 32, '', '',
1211 'reason', 'varchar', '', $char_d, '', '',
1212 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
1213 # be index into payby
1215 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1216 'paymask', 'varchar', 'NULL', $char_d, '', '',
1217 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1218 'closed', 'char', 'NULL', 1, '', '',
1220 'primary_key' => 'refundnum',
1222 'index' => [ ['custnum'], ['_date'] ],
1225 'cust_credit_refund' => {
1227 'creditrefundnum', 'serial', '', '', '', '',
1228 'crednum', 'int', '', '', '', '',
1229 'refundnum', 'int', '', '', '', '',
1230 'amount', @money_type, '', '',
1231 '_date', @date_type, '', '',
1233 'primary_key' => 'creditrefundnum',
1235 'index' => [ ['crednum'], ['refundnum'] ],
1241 'svcnum', 'serial', '', '', '', '',
1242 'pkgnum', 'int', 'NULL', '', '', '',
1243 'svcpart', 'int', '', '', '', '',
1244 'overlimit', @date_type, '', '',
1246 'primary_key' => 'svcnum',
1248 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1251 'cust_svc_option' => {
1253 'optionnum', 'serial', '', '', '', '',
1254 'svcnum', 'int', '', '', '', '',
1255 'optionname', 'varchar', '', $char_d, '', '',
1256 'optionvalue', 'text', 'NULL', '', '', '',
1258 'primary_key' => 'optionnum',
1260 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1265 'pkgpart', 'serial', '', '', '', '',
1266 'pkg', 'varchar', '', $char_d, '', '',
1267 'comment', 'varchar', '', $char_d, '', '',
1268 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1269 'setup', @perl_type, '', '',
1270 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1271 'recur', @perl_type, '', '',
1272 'setuptax', 'char', 'NULL', 1, '', '',
1273 'recurtax', 'char', 'NULL', 1, '', '',
1274 'plan', 'varchar', 'NULL', $char_d, '', '',
1275 'plandata', 'text', 'NULL', '', '', '',
1276 'disabled', 'char', 'NULL', 1, '', '',
1277 'custom', 'char', 'NULL', 1, '', '',
1278 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1279 'classnum', 'int', 'NULL', '', '', '',
1280 'taxproductnum', 'int', 'NULL', '', '', '',
1281 'setup_cost', @money_typen, '', '',
1282 'recur_cost', @money_typen, '', '',
1283 'pay_weight', 'real', 'NULL', '', '', '',
1284 'credit_weight', 'real', 'NULL', '', '', '',
1285 'agentnum', 'int', 'NULL', '', '', '',
1288 'primary_key' => 'pkgpart',
1290 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1293 'part_pkg_link' => {
1295 'pkglinknum', 'serial', '', '', '', '',
1296 'src_pkgpart', 'int', '', '', '', '',
1297 'dst_pkgpart', 'int', '', '', '', '',
1298 'link_type', 'varchar', '', $char_d, '', '',
1299 'hidden', 'char', 'NULL', 1, '', '',
1301 'primary_key' => 'pkglinknum',
1302 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1303 'index' => [ [ 'src_pkgpart' ] ],
1305 # XXX somewhat borked unique: we don't really want a hidden and unhidden
1306 # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1308 'part_pkg_taxclass' => {
1310 'taxclassnum', 'serial', '', '', '', '',
1311 'taxclass', 'varchar', '', $char_d, '', '',
1312 'disabled', 'char', 'NULL', 1, '', '',
1314 'primary_key' => 'taxclassnum',
1315 'unique' => [ [ 'taxclass' ] ],
1316 'index' => [ [ 'disabled' ] ],
1319 'part_pkg_taxproduct' => {
1321 'taxproductnum', 'serial', '', '', '', '',
1322 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1323 'taxproduct', 'varchar', '', $char_d, '', '',
1324 'description', 'varchar', '', 3*$char_d, '', '',
1326 'primary_key' => 'taxproductnum',
1327 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1331 'part_pkg_taxrate' => {
1333 'pkgtaxratenum', 'serial', '', '', '', '',
1334 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1335 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1336 'taxproductnum', 'int', '', '', '', '',
1337 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1338 'county', 'varchar', 'NULL', $char_d, '', '',
1339 'state', 'varchar', 'NULL', $char_d, '', '',
1340 'local', 'varchar', 'NULL', $char_d, '', '',
1341 'country', 'char', 'NULL', 2, '', '',
1342 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1343 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1344 'taxclassnum', 'int', 'NULL', '', '', '',
1345 'effdate', @date_type, '', '',
1346 'taxable', 'char', 'NULL', 1, '', '',
1348 'primary_key' => 'pkgtaxratenum',
1350 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1353 'part_pkg_taxoverride' => {
1355 'taxoverridenum', 'serial', '', '', '', '',
1356 'pkgpart', 'serial', '', '', '', '',
1357 'taxclassnum', 'serial', '', '', '', '',
1358 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1360 'primary_key' => 'taxoverridenum',
1362 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1367 # 'titlenum', 'int', '', '',
1368 # 'title', 'varchar', '', $char_d,
1370 # 'primary_key' => 'titlenum',
1371 # 'unique' => [ [] ],
1372 # 'index' => [ [] ],
1377 'pkgsvcnum', 'serial', '', '', '', '',
1378 'pkgpart', 'int', '', '', '', '',
1379 'svcpart', 'int', '', '', '', '',
1380 'quantity', 'int', '', '', '', '',
1381 'primary_svc','char', 'NULL', 1, '', '',
1383 'primary_key' => 'pkgsvcnum',
1384 'unique' => [ ['pkgpart', 'svcpart'] ],
1385 'index' => [ ['pkgpart'], ['quantity'] ],
1388 'part_referral' => {
1390 'refnum', 'serial', '', '', '', '',
1391 'referral', 'varchar', '', $char_d, '', '',
1392 'disabled', 'char', 'NULL', 1, '', '',
1393 'agentnum', 'int', 'NULL', '', '', '',
1395 'primary_key' => 'refnum',
1397 'index' => [ ['disabled'], ['agentnum'], ],
1402 'svcpart', 'serial', '', '', '', '',
1403 'svc', 'varchar', '', $char_d, '', '',
1404 'svcdb', 'varchar', '', $char_d, '', '',
1405 'disabled', 'char', 'NULL', 1, '', '',
1407 'primary_key' => 'svcpart',
1409 'index' => [ [ 'disabled' ] ],
1412 'part_svc_column' => {
1414 'columnnum', 'serial', '', '', '', '',
1415 'svcpart', 'int', '', '', '', '',
1416 'columnname', 'varchar', '', 64, '', '',
1417 'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1418 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1419 'columnflag', 'char', 'NULL', 1, '', '',
1421 'primary_key' => 'columnnum',
1422 'unique' => [ [ 'svcpart', 'columnname' ] ],
1423 'index' => [ [ 'svcpart' ] ],
1426 #(this should be renamed to part_pop)
1429 'popnum', 'serial', '', '', '', '',
1430 'city', 'varchar', '', $char_d, '', '',
1431 'state', 'varchar', '', $char_d, '', '',
1432 'ac', 'char', '', 3, '', '',
1433 'exch', 'char', '', 3, '', '',
1434 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1436 'primary_key' => 'popnum',
1438 'index' => [ [ 'state' ] ],
1441 'part_pop_local' => {
1443 'localnum', 'serial', '', '', '', '',
1444 'popnum', 'int', '', '', '', '',
1445 'city', 'varchar', 'NULL', $char_d, '', '',
1446 'state', 'char', 'NULL', 2, '', '',
1447 'npa', 'char', '', 3, '', '',
1448 'nxx', 'char', '', 3, '', '',
1450 'primary_key' => 'localnum',
1452 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1457 'svcnum', 'int', '', '', '', '',
1458 'username', 'varchar', '', $username_len, '', '',
1459 '_password', 'varchar', 'NULL', 512, '', '',
1460 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1461 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1462 'popnum', 'int', 'NULL', '', '', '',
1463 'uid', 'int', 'NULL', '', '', '',
1464 'gid', 'int', 'NULL', '', '', '',
1465 'finger', 'varchar', 'NULL', $char_d, '', '',
1466 'dir', 'varchar', 'NULL', $char_d, '', '',
1467 'shell', 'varchar', 'NULL', $char_d, '', '',
1468 'quota', 'varchar', 'NULL', $char_d, '', '',
1469 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1470 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1471 'seconds_threshold', 'int', 'NULL', '', '', '',
1472 'upbytes', 'bigint', 'NULL', '', '', '',
1473 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1474 'downbytes', 'bigint', 'NULL', '', '', '',
1475 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1476 'totalbytes','bigint', 'NULL', '', '', '',
1477 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1478 'domsvc', 'int', '', '', '', '',
1479 'pbxsvc', 'int', 'NULL', '', '', '',
1480 'last_login', @date_type, '', '',
1481 'last_logout', @date_type, '', '',
1482 #communigate pro fields (quota = MaxAccountSize)
1483 'file_quota', 'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1484 'file_maxnum', 'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1485 'file_maxsize', 'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1486 'cgp_accessmodes', 'varchar', 'NULL', 255, '', '', #AccessModes
1487 'password_selfchange','char', 'NULL', 1, '', '', #PWDAllowed
1488 'password_recover', 'char', 'NULL', 1, '', '', #PasswordRecovery
1489 'cgp_type', 'varchar', 'NULL', $char_d, '', '', #AccountType
1490 'cgp_aliases', 'varchar', 'NULL', 255, '', '',
1491 'cgp_deletemode', 'varchar', 'NULL', $char_d, '', '', #DeleteMode
1492 'cgp_emptytrash', 'varchar', 'NULL', $char_d, '', '', #EmptyTrash
1494 'primary_key' => 'svcnum',
1495 #'unique' => [ [ 'username', 'domsvc' ] ],
1497 'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1500 'acct_rt_transaction' => {
1502 'svcrtid', 'int', '', '', '', '',
1503 'svcnum', 'int', '', '', '', '',
1504 'transaction_id', 'int', '', '', '', '',
1505 '_date', @date_type, '', '',
1506 'seconds', 'int', '', '', '', '', #uhhhh
1507 'support', 'int', '', '', '', '',
1509 'primary_key' => 'svcrtid',
1511 'index' => [ ['svcnum', 'transaction_id'] ],
1516 # 'svcnum', 'int', '', '',
1517 # 'amount', @money_type,
1519 # 'primary_key' => 'svcnum',
1520 # 'unique' => [ [] ],
1521 # 'index' => [ [] ],
1526 'svcnum', 'int', '', '', '', '',
1527 'domain', 'varchar', '', $char_d, '', '',
1528 'suffix', 'varchar', 'NULL', $char_d, '', '',
1529 'catchall', 'int', 'NULL', '', '', '',
1530 'parent_svcnum', 'int', 'NULL', '', '', '',
1531 'registrarnum', 'int', 'NULL', '', '', '',
1532 'registrarkey', 'varchar', 'NULL', 512, '', '',
1533 'setup_date', @date_type, '', '',
1534 'renewal_interval', 'int', 'NULL', '', '', '',
1535 'expiration_date', @date_type, '', '',
1536 #communigate pro fields (quota = MaxAccountSize)
1537 'max_accounts', 'int', 'NULL', '', '', '',
1538 'cgp_aliases', 'varchar', 'NULL', 255, '', '',
1539 'cgp_accessmodes','varchar','NULL', 255, '', '', #DomainAccessModes
1540 'acct_def_password_selfchange','char', 'NULL', 1, '', '',
1541 'acct_def_password_recover', 'char', 'NULL', 1, '', '',
1542 'acct_def_cgp_accessmodes', 'varchar', 'NULL', 255, '', '',
1543 'acct_def_quota', 'varchar', 'NULL', $char_d, '', '',
1544 'acct_def_file_quota', 'varchar', 'NULL', $char_d, '', '',
1545 'acct_def_file_maxnum', 'varchar', 'NULL', $char_d, '', '',
1546 'acct_def_file_maxsize', 'varchar', 'NULL', $char_d, '', '',
1547 'acct_def_cgp_deletemode', 'varchar', 'NULL', $char_d, '', '',
1548 'acct_def_cgp_emptytrash', 'varchar', 'NULL', $char_d, '', '',
1550 'primary_key' => 'svcnum',
1552 'index' => [ ['domain'] ],
1555 'domain_record' => {
1557 'recnum', 'serial', '', '', '', '',
1558 'svcnum', 'int', '', '', '', '',
1559 'reczone', 'varchar', '', 255, '', '',
1560 'recaf', 'char', '', 2, '', '',
1561 'rectype', 'varchar', '', 5, '', '',
1562 'recdata', 'varchar', '', 255, '', '',
1564 'primary_key' => 'recnum',
1566 'index' => [ ['svcnum'] ],
1571 'registrarnum', 'serial', '', '', '', '',
1572 'registrarname', 'varchar', '', $char_d, '', '',
1574 'primary_key' => 'registrarnum',
1581 'svcnum', 'int', '', '', '', '',
1582 'srcsvc', 'int', 'NULL', '', '', '',
1583 'src', 'varchar', 'NULL', 255, '', '',
1584 'dstsvc', 'int', 'NULL', '', '', '',
1585 'dst', 'varchar', 'NULL', 255, '', '',
1587 'primary_key' => 'svcnum',
1589 'index' => [ ['srcsvc'], ['dstsvc'] ],
1594 'svcnum', 'int', '', '', '', '',
1595 'recnum', 'int', '', '', '', '',
1596 'usersvc', 'int', 'NULL', '', '', '',
1597 'config', 'text', 'NULL', '', '', '',
1599 'primary_key' => 'svcnum',
1606 # 'svcnum', 'int', '', '',
1607 # 'svcnum', 'int', '', '',
1608 # 'svcnum', 'int', '', '',
1609 # 'worker', 'varchar', '', $char_d,
1610 # '_date', @date_type,
1612 # 'primary_key' => 'svcnum',
1613 # 'unique' => [ [] ],
1614 # 'index' => [ [] ],
1617 'prepay_credit' => {
1619 'prepaynum', 'serial', '', '', '', '',
1620 'identifier', 'varchar', '', $char_d, '', '',
1621 'amount', @money_type, '', '',
1622 'seconds', 'int', 'NULL', '', '', '',
1623 'upbytes', 'bigint', 'NULL', '', '', '',
1624 'downbytes', 'bigint', 'NULL', '', '', '',
1625 'totalbytes', 'bigint', 'NULL', '', '', '',
1626 'agentnum', 'int', 'NULL', '', '', '',
1628 'primary_key' => 'prepaynum',
1629 'unique' => [ ['identifier'] ],
1635 'portnum', 'serial', '', '', '', '',
1636 'ip', 'varchar', 'NULL', 15, '', '',
1637 'nasport', 'int', 'NULL', '', '', '',
1638 'nasnum', 'int', '', '', '', '',
1640 'primary_key' => 'portnum',
1647 'nasnum', 'serial', '', '', '', '',
1648 'nas', 'varchar', '', $char_d, '', '',
1649 'nasip', 'varchar', '', 15, '', '',
1650 'nasfqdn', 'varchar', '', $char_d, '', '',
1651 'last', 'int', '', '', '', '',
1653 'primary_key' => 'nasnum',
1654 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1655 'index' => [ [ 'last' ] ],
1660 # 'sessionnum', 'serial', '', '', '', '',
1661 # 'portnum', 'int', '', '', '', '',
1662 # 'svcnum', 'int', '', '', '', '',
1663 # 'login', @date_type, '', '',
1664 # 'logout', @date_type, '', '',
1666 # 'primary_key' => 'sessionnum',
1668 # 'index' => [ [ 'portnum' ] ],
1673 'jobnum', 'serial', '', '', '', '',
1674 'job', 'varchar', '', 512, '', '',
1675 '_date', 'int', '', '', '', '',
1676 'status', 'varchar', '', $char_d, '', '',
1677 'statustext', 'text', 'NULL', '', '', '',
1678 'svcnum', 'int', 'NULL', '', '', '',
1679 'custnum', 'int', 'NULL', '', '', '',
1680 'secure', 'char', 'NULL', 1, '', '',
1681 'priority', 'int', 'NULL', '', '', '',
1683 'primary_key' => 'jobnum',
1685 'index' => [ [ 'secure' ], [ 'priority' ],
1686 [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1692 'argnum', 'serial', '', '', '', '',
1693 'jobnum', 'int', '', '', '', '',
1694 'frozen', 'char', 'NULL', 1, '', '',
1695 'arg', 'text', 'NULL', '', '', '',
1697 'primary_key' => 'argnum',
1699 'index' => [ [ 'jobnum' ] ],
1704 'dependnum', 'serial', '', '', '', '',
1705 'jobnum', 'int', '', '', '', '',
1706 'depend_jobnum', 'int', '', '', '', '',
1708 'primary_key' => 'dependnum',
1710 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1715 'exportsvcnum' => 'serial', '', '', '', '',
1716 'exportnum' => 'int', '', '', '', '',
1717 'svcpart' => 'int', '', '', '', '',
1719 'primary_key' => 'exportsvcnum',
1720 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1721 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1724 'export_device' => {
1726 'exportdevicenum' => 'serial', '', '', '', '',
1727 'exportnum' => 'int', '', '', '', '',
1728 'devicepart' => 'int', '', '', '', '',
1730 'primary_key' => 'exportdevicenum',
1731 'unique' => [ [ 'exportnum', 'devicepart' ] ],
1732 'index' => [ [ 'exportnum' ], [ 'devicepart' ] ],
1737 'exportnum', 'serial', '', '', '', '',
1738 'machine', 'varchar', '', $char_d, '', '',
1739 'exporttype', 'varchar', '', $char_d, '', '',
1740 'nodomain', 'char', 'NULL', 1, '', '',
1742 'primary_key' => 'exportnum',
1744 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1747 'part_export_option' => {
1749 'optionnum', 'serial', '', '', '', '',
1750 'exportnum', 'int', '', '', '', '',
1751 'optionname', 'varchar', '', $char_d, '', '',
1752 'optionvalue', 'text', 'NULL', '', '', '',
1754 'primary_key' => 'optionnum',
1756 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1759 'radius_usergroup' => {
1761 'usergroupnum', 'serial', '', '', '', '',
1762 'svcnum', 'int', '', '', '', '',
1763 'groupname', 'varchar', '', $char_d, '', '',
1765 'primary_key' => 'usergroupnum',
1767 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1772 'msgnum', 'serial', '', '', '', '',
1773 'msgcode', 'varchar', '', $char_d, '', '',
1774 'locale', 'varchar', '', 16, '', '',
1775 'msg', 'text', '', '', '', '',
1777 'primary_key' => 'msgnum',
1778 'unique' => [ [ 'msgcode', 'locale' ] ],
1782 'cust_tax_exempt' => {
1784 'exemptnum', 'serial', '', '', '', '',
1785 'custnum', 'int', '', '', '', '',
1786 'taxnum', 'int', '', '', '', '',
1787 'year', 'int', '', '', '', '',
1788 'month', 'int', '', '', '', '',
1789 'amount', @money_type, '', '',
1791 'primary_key' => 'exemptnum',
1792 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1796 'cust_tax_exempt_pkg' => {
1798 'exemptpkgnum', 'serial', '', '', '', '',
1799 #'custnum', 'int', '', '', '', ''
1800 'billpkgnum', 'int', '', '', '', '',
1801 'taxnum', 'int', '', '', '', '',
1802 'year', 'int', '', '', '', '',
1803 'month', 'int', '', '', '', '',
1804 'amount', @money_type, '', '',
1806 'primary_key' => 'exemptpkgnum',
1808 'index' => [ [ 'taxnum', 'year', 'month' ],
1816 'routernum', 'serial', '', '', '', '',
1817 'routername', 'varchar', '', $char_d, '', '',
1818 'svcnum', 'int', 'NULL', '', '', '',
1819 'agentnum', 'int', 'NULL', '', '', '',
1821 'primary_key' => 'routernum',
1826 'part_svc_router' => {
1828 'svcrouternum', 'serial', '', '', '', '',
1829 'svcpart', 'int', '', '', '', '',
1830 'routernum', 'int', '', '', '', '',
1832 'primary_key' => 'svcrouternum',
1839 'blocknum', 'serial', '', '', '', '',
1840 'routernum', 'int', '', '', '', '',
1841 'ip_gateway', 'varchar', '', 15, '', '',
1842 'ip_netmask', 'int', '', '', '', '',
1843 'agentnum', 'int', 'NULL', '', '', '',
1844 'manual_flag', 'char', 'NULL', 1, '', '',
1846 'primary_key' => 'blocknum',
1847 'unique' => [ [ 'blocknum', 'routernum' ] ],
1851 'svc_broadband' => {
1853 'svcnum', 'int', '', '', '', '',
1854 'description', 'varchar', 'NULL', $char_d, '', '',
1855 'blocknum', 'int', 'NULL', '', '', '',
1856 'speed_up', 'int', '', '', '', '',
1857 'speed_down', 'int', '', '', '', '',
1858 'ip_addr', 'varchar', 'NULL', 15, '', '',
1859 'mac_addr', 'varchar', 'NULL', 12, '', '',
1860 'authkey', 'varchar', 'NULL', 32, '', '',
1861 'latitude', 'decimal', 'NULL', '', '', '',
1862 'longitude', 'decimal', 'NULL', '', '', '',
1863 'altitude', 'decimal', 'NULL', '', '', '',
1864 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1865 'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1867 'primary_key' => 'svcnum',
1868 'unique' => [ [ 'mac_addr' ] ],
1872 'part_virtual_field' => {
1874 'vfieldpart', 'serial', '', '', '', '',
1875 'dbtable', 'varchar', '', 32, '', '',
1876 'name', 'varchar', '', 32, '', '',
1877 'check_block', 'text', 'NULL', '', '', '',
1878 'length', 'int', 'NULL', '', '', '',
1879 'list_source', 'text', 'NULL', '', '', '',
1880 'label', 'varchar', 'NULL', 80, '', '',
1882 'primary_key' => 'vfieldpart',
1887 'virtual_field' => {
1889 'vfieldnum', 'serial', '', '', '', '',
1890 'recnum', 'int', '', '', '', '',
1891 'vfieldpart', 'int', '', '', '', '',
1892 'value', 'varchar', '', 128, '', '',
1894 'primary_key' => 'vfieldnum',
1895 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1901 'snarfnum', 'int', '', '', '', '',
1902 'svcnum', 'int', '', '', '', '',
1903 'machine', 'varchar', '', 255, '', '',
1904 'protocol', 'varchar', '', $char_d, '', '',
1905 'username', 'varchar', '', $char_d, '', '',
1906 '_password', 'varchar', '', $char_d, '', '',
1908 'primary_key' => 'snarfnum',
1910 'index' => [ [ 'svcnum' ] ],
1915 'svcnum', 'int', '', '', '', '',
1916 'id', 'int', 'NULL', '', '', '',
1917 'title', 'varchar', 'NULL', $char_d, '', '',
1919 'primary_key' => 'svcnum',
1924 'cust_pay_refund' => {
1926 'payrefundnum', 'serial', '', '', '', '',
1927 'paynum', 'int', '', '', '', '',
1928 'refundnum', 'int', '', '', '', '',
1929 '_date', @date_type, '', '',
1930 'amount', @money_type, '', '',
1932 'primary_key' => 'payrefundnum',
1934 'index' => [ ['paynum'], ['refundnum'] ],
1937 'part_pkg_option' => {
1939 'optionnum', 'serial', '', '', '', '',
1940 'pkgpart', 'int', '', '', '', '',
1941 'optionname', 'varchar', '', $char_d, '', '',
1942 'optionvalue', 'text', 'NULL', '', '', '',
1944 'primary_key' => 'optionnum',
1946 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1949 'part_pkg_report_option' => {
1951 'num', 'serial', '', '', '', '',
1952 'name', 'varchar', '', $char_d, '', '',
1953 'disabled', 'char', 'NULL', 1, '', '',
1955 'primary_key' => 'num',
1956 'unique' => [ [ 'name' ] ],
1957 'index' => [ [ 'disabled' ] ],
1962 'ratenum', 'serial', '', '', '', '',
1963 'ratename', 'varchar', '', $char_d, '', '',
1965 'primary_key' => 'ratenum',
1972 'ratedetailnum', 'serial', '', '', '', '',
1973 'ratenum', 'int', '', '', '', '',
1974 'orig_regionnum', 'int', 'NULL', '', '', '',
1975 'dest_regionnum', 'int', '', '', '', '',
1976 'min_included', 'int', '', '', '', '',
1977 #'min_charge', @money_type, '', '',
1978 'min_charge', 'decimal', '', '10,5', '', '',
1979 'sec_granularity', 'int', '', '', '', '',
1980 #time period (link to table of periods)?
1981 'classnum', 'int', 'NULL', '', '', '',
1983 'primary_key' => 'ratedetailnum',
1984 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1985 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1990 'regionnum', 'serial', '', '', '', '',
1991 'regionname', 'varchar', '', $char_d, '', '',
1993 'primary_key' => 'regionnum',
2000 'prefixnum', 'serial', '', '', '', '',
2001 'regionnum', 'int', '', '', '', '',
2002 'countrycode', 'varchar', '', 3, '', '',
2003 'npa', 'varchar', 'NULL', 10, '', '', #actually the whole prefix
2004 'nxx', 'varchar', 'NULL', 3, '', '', #actually not used
2006 'primary_key' => 'prefixnum',
2008 'index' => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2013 'classnum', 'serial', '', '', '', '',
2014 'weight', 'int', 'NULL', '', '', '',
2015 'classname', 'varchar', '', $char_d, '', '',
2016 'format', 'varchar', 'NULL', $char_d, '', '',
2017 'disabled', 'char', 'NULL', 1, '', '',
2019 'primary_key' => 'classnum',
2021 'index' => [ ['disabled'] ],
2026 'codenum', 'serial', '', '', '', '',
2027 'code', 'varchar', '', $char_d, '', '',
2028 'agentnum', 'int', '', '', '', '',
2030 'primary_key' => 'codenum',
2031 'unique' => [ [ 'agentnum', 'code' ] ],
2032 'index' => [ [ 'agentnum' ] ],
2037 'codepkgnum', 'serial', '', '', '', '',
2038 'codenum', 'int', '', '', '', '',
2039 'pkgpart', 'int', '', '', '', '',
2041 'primary_key' => 'codepkgnum',
2042 'unique' => [ [ 'codenum', 'pkgpart' ] ],
2043 'index' => [ [ 'codenum' ] ],
2046 'clientapi_session' => {
2048 'sessionnum', 'serial', '', '', '', '',
2049 'sessionid', 'varchar', '', $char_d, '', '',
2050 'namespace', 'varchar', '', $char_d, '', '',
2052 'primary_key' => 'sessionnum',
2053 'unique' => [ [ 'sessionid', 'namespace' ] ],
2057 'clientapi_session_field' => {
2059 'fieldnum', 'serial', '', '', '', '',
2060 'sessionnum', 'int', '', '', '', '',
2061 'fieldname', 'varchar', '', $char_d, '', '',
2062 'fieldvalue', 'text', 'NULL', '', '', '',
2064 'primary_key' => 'fieldnum',
2065 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
2069 'payment_gateway' => {
2071 'gatewaynum', 'serial', '', '', '', '',
2072 'gateway_namespace','varchar', 'NULL', $char_d, '', '',
2073 'gateway_module', 'varchar', '', $char_d, '', '',
2074 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
2075 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
2076 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
2077 'gateway_callback_url', 'varchar', 'NULL', $char_d, '', '',
2078 'disabled', 'char', 'NULL', 1, '', '',
2080 'primary_key' => 'gatewaynum',
2082 'index' => [ [ 'disabled' ] ],
2085 'payment_gateway_option' => {
2087 'optionnum', 'serial', '', '', '', '',
2088 'gatewaynum', 'int', '', '', '', '',
2089 'optionname', 'varchar', '', $char_d, '', '',
2090 'optionvalue', 'text', 'NULL', '', '', '',
2092 'primary_key' => 'optionnum',
2094 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2097 'agent_payment_gateway' => {
2099 'agentgatewaynum', 'serial', '', '', '', '',
2100 'agentnum', 'int', '', '', '', '',
2101 'gatewaynum', 'int', '', '', '', '',
2102 'cardtype', 'varchar', 'NULL', $char_d, '', '',
2103 'taxclass', 'varchar', 'NULL', $char_d, '', '',
2105 'primary_key' => 'agentgatewaynum',
2107 'index' => [ [ 'agentnum', 'cardtype' ], ],
2112 'bannum', 'serial', '', '', '', '',
2113 'payby', 'char', '', 4, '', '',
2114 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
2115 #'paymask', 'varchar', 'NULL', $char_d, '', ''
2116 '_date', @date_type, '', '',
2117 'otaker', 'varchar', '', 32, '', '',
2118 'reason', 'varchar', 'NULL', $char_d, '', '',
2120 'primary_key' => 'bannum',
2121 'unique' => [ [ 'payby', 'payinfo' ] ],
2127 'categorynum', 'serial', '', '', '', '',
2128 'categoryname', 'varchar', '', $char_d, '', '',
2129 'weight', 'int', 'NULL', '', '', '',
2130 'condense', 'char', 'NULL', 1, '', '',
2131 'disabled', 'char', 'NULL', 1, '', '',
2133 'primary_key' => 'categorynum',
2135 'index' => [ ['disabled'] ],
2140 'classnum', 'serial', '', '', '', '',
2141 'classname', 'varchar', '', $char_d, '', '',
2142 'categorynum', 'int', 'NULL', '', '', '',
2143 'disabled', 'char', 'NULL', 1, '', '',
2145 'primary_key' => 'classnum',
2147 'index' => [ ['disabled'] ],
2152 # qw( name type null length default local );
2158 'acctid', 'bigserial', '', '', '', '',
2159 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2160 'calldate', 'timestamp', '', '', \'now()', '',
2161 'clid', 'varchar', '', $char_d, \"''", '',
2162 'src', 'varchar', '', $char_d, \"''", '',
2163 'dst', 'varchar', '', $char_d, \"''", '',
2164 'dcontext', 'varchar', '', $char_d, \"''", '',
2165 'channel', 'varchar', '', $char_d, \"''", '',
2166 'dstchannel', 'varchar', '', $char_d, \"''", '',
2167 'lastapp', 'varchar', '', $char_d, \"''", '',
2168 'lastdata', 'varchar', '', $char_d, \"''", '',
2170 #these don't seem to be logged by most of the SQL cdr_* modules
2171 #except tds under sql-illegal names, so;
2172 # ... don't rely on them for rating?
2173 # and, what they hey, i went ahead and changed the names and data types
2174 # to freeside-style dates...
2175 #'start', 'timestamp', 'NULL', '', '', '',
2176 #'answer', 'timestamp', 'NULL', '', '', '',
2177 #'end', 'timestamp', 'NULL', '', '', '',
2178 'startdate', @date_type, '', '',
2179 'answerdate', @date_type, '', '',
2180 'enddate', @date_type, '', '',
2183 'duration', 'int', '', '', 0, '',
2184 'billsec', 'int', '', '', 0, '',
2185 'disposition', 'varchar', '', 45, \"''", '',
2186 'amaflags', 'int', '', '', 0, '',
2187 'accountcode', 'varchar', '', 20, \"''", '',
2188 'uniqueid', 'varchar', '', 32, \"''", '',
2189 'userfield', 'varchar', '', 255, \"''", '',
2192 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2194 # though these are now used elsewhere:
2195 # charged_party, upstream_price, rated_price, carrierid
2198 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2199 'cdrtypenum', 'int', 'NULL', '', '', '',
2201 'charged_party', 'varchar', 'NULL', $char_d, '', '',
2203 'upstream_currency', 'char', 'NULL', 3, '', '',
2204 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
2205 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
2207 # how it was rated internally...
2208 'ratedetailnum', 'int', 'NULL', '', '', '',
2209 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2211 'distance', 'decimal', 'NULL', '', '', '',
2212 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
2214 #cdr_calltype: the big list in appendix 2
2215 'calltypenum', 'int', 'NULL', '', '', '',
2217 'description', 'varchar', 'NULL', $char_d, '', '',
2218 'quantity', 'int', 'NULL', '', '', '',
2220 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2221 'carrierid', 'int', 'NULL', '', '', '',
2223 'upstream_rateid', 'int', 'NULL', '', '', '',
2226 #and now for our own fields
2229 # a svcnum... right..?
2230 'svcnum', 'int', 'NULL', '', '', '',
2232 #NULL, done (or something)
2233 'freesidestatus', 'varchar', 'NULL', 32, '', '',
2235 #NULL, done (or something)
2236 'freesiderewritestatus', 'varchar', 'NULL', 32, '', '',
2238 #an indexed place to put big numbers
2239 'cdrid', 'bigint', 'NULL', '', '', '',
2242 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2244 'cdrbatchnum', 'int', 'NULL', '', '', '',
2247 'primary_key' => 'acctid',
2249 'index' => [ [ 'calldate' ],
2250 [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2251 [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2252 [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2253 [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2259 'cdrbatchnum', 'serial', '', '', '', '',
2260 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2261 '_date', @date_type, '', '',
2263 'primary_key' => 'cdrbatchnum',
2264 'unique' => [ [ 'cdrbatch' ] ],
2268 'cdr_termination' => {
2270 'cdrtermnum', 'bigserial', '', '', '', '',
2271 'acctid', 'bigint', '', '', '', '',
2272 'termpart', 'int', '', '', '', '',#future use see below
2273 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2274 'status', 'varchar', 'NULL', 32, '', '',
2276 'primary_key' => 'cdrtermnum',
2277 'unique' => [ [ 'acctid', 'termpart' ] ],
2278 'index' => [ [ 'acctid' ], [ 'status' ], ],
2281 #to handle multiple termination/settlement passes...
2282 # 'part_termination' => {
2284 # 'termpart', 'int', '', '', '', '',
2285 # 'termname', 'varchar', '', $char_d, '', '',
2286 # 'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2288 # 'primary_key' => 'termpart',
2293 #the remaining cdr_ tables are not really used
2296 'calltypenum', 'serial', '', '', '', '',
2297 'calltypename', 'varchar', '', $char_d, '', '',
2299 'primary_key' => 'calltypenum',
2306 'cdrtypenum' => 'serial', '', '', '', '',
2307 'cdrtypename' => 'varchar', '', $char_d, '', '',
2309 'primary_key' => 'cdrtypenum',
2316 'carrierid' => 'serial', '', '', '', '',
2317 'carriername' => 'varchar', '', $char_d, '', '',
2319 'primary_key' => 'carrierid',
2326 # 'filenum', 'serial', '', '', '', '',
2327 # 'filename', 'varchar', '', '', '', '',
2328 # 'status', 'varchar', 'NULL', '', '', '',
2330 # 'primary_key' => 'filenum',
2331 # 'unique' => [ [ 'filename' ], ], #just change the index if we need to
2332 # # agent-virtualize or have a customer
2333 # # with dup-filename needs or something
2334 # # (only used by cdr.http_and_import for
2339 'inventory_item' => {
2341 'itemnum', 'serial', '', '', '', '',
2342 'classnum', 'int', '', '', '', '',
2343 'item', 'varchar', '', $char_d, '', '',
2344 'svcnum', 'int', 'NULL', '', '', '',
2346 'primary_key' => 'itemnum',
2347 'unique' => [ [ 'classnum', 'item' ] ],
2348 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2351 'inventory_class' => {
2353 'classnum', 'serial', '', '', '', '',
2354 'classname', 'varchar', '', $char_d, '', '',
2356 'primary_key' => 'classnum',
2363 'usernum', 'serial', '', '', '', '',
2364 'username', 'varchar', '', $char_d, '', '',
2365 '_password', 'varchar', '', $char_d, '', '',
2366 'last', 'varchar', '', $char_d, '', '',
2367 'first', 'varchar', '', $char_d, '', '',
2368 'disabled', 'char', 'NULL', 1, '', '',
2370 'primary_key' => 'usernum',
2371 'unique' => [ [ 'username' ] ],
2375 'access_user_pref' => {
2377 'prefnum', 'serial', '', '', '', '',
2378 'usernum', 'int', '', '', '', '',
2379 'prefname', 'varchar', '', $char_d, '', '',
2380 'prefvalue', 'text', 'NULL', '', '', '',
2381 'expiration', @date_type, '', '',
2383 'primary_key' => 'prefnum',
2385 'index' => [ [ 'usernum' ] ],
2390 'groupnum', 'serial', '', '', '', '',
2391 'groupname', 'varchar', '', $char_d, '', '',
2393 'primary_key' => 'groupnum',
2394 'unique' => [ [ 'groupname' ] ],
2398 'access_usergroup' => {
2400 'usergroupnum', 'serial', '', '', '', '',
2401 'usernum', 'int', '', '', '', '',
2402 'groupnum', 'int', '', '', '', '',
2404 'primary_key' => 'usergroupnum',
2405 'unique' => [ [ 'usernum', 'groupnum' ] ],
2406 'index' => [ [ 'usernum' ] ],
2409 'access_groupagent' => {
2411 'groupagentnum', 'serial', '', '', '', '',
2412 'groupnum', 'int', '', '', '', '',
2413 'agentnum', 'int', '', '', '', '',
2415 'primary_key' => 'groupagentnum',
2416 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2417 'index' => [ [ 'groupnum' ] ],
2422 'rightnum', 'serial', '', '', '', '',
2423 'righttype', 'varchar', '', $char_d, '', '',
2424 'rightobjnum', 'int', '', '', '', '',
2425 'rightname', 'varchar', '', $char_d, '', '',
2427 'primary_key' => 'rightnum',
2428 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2434 'svcnum', 'int', '', '', '', '',
2435 'countrycode', 'varchar', '', 3, '', '',
2436 'phonenum', 'varchar', '', 15, '', '', #12 ?
2437 'pin', 'varchar', 'NULL', $char_d, '', '',
2438 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2439 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2440 'pbxsvc', 'int', 'NULL', '', '', '',
2442 'primary_key' => 'svcnum',
2444 'index' => [ [ 'countrycode', 'phonenum' ], ['pbxsvc'] ],
2449 'devicenum', 'serial', '', '', '', '',
2450 'devicepart', 'int', '', '', '', '',
2451 'svcnum', 'int', '', '', '', '',
2452 'mac_addr', 'varchar', 'NULL', 12, '', '',
2454 'primary_key' => 'devicenum',
2455 'unique' => [ [ 'mac_addr' ], ],
2456 'index' => [ [ 'devicepart' ], [ 'svcnum' ], ],
2461 'devicepart', 'serial', '', '', '', '',
2462 'devicename', 'varchar', '', $char_d, '', '',
2463 #'classnum', #tie to an inventory class?
2465 'primary_key' => 'devicepart',
2466 'unique' => [ [ 'devicename' ] ], #?
2472 'availnum', 'serial', '', '', '', '',
2473 'exportnum', 'int', '', '', '', '',
2474 'countrycode', 'varchar', '', 3, '', '',
2475 'state', 'char', 'NULL', 2, '', '',
2476 'npa', 'char', '', 3, '', '',
2477 'nxx', 'char', 'NULL', 3, '', '',
2478 'station', 'char', 'NULL', 4, '', '',
2479 'name', 'varchar', 'NULL', $char_d, '', '',
2480 'svcnum', 'int', 'NULL', '', '', '',
2481 'availbatch', 'varchar', 'NULL', $char_d, '', '',
2483 'primary_key' => 'availnum',
2485 'index' => [ [ 'exportnum', 'countrycode', 'state' ], #npa search
2486 [ 'exportnum', 'countrycode', 'npa' ], #nxx search
2487 [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2488 [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2496 'typenum', 'serial', '', '', '', '',
2497 'class', 'char', '', 1, '', '',
2498 'type', 'varchar', '', $char_d, '', '',
2500 'primary_key' => 'typenum',
2507 'reasonnum', 'serial', '', '', '', '',
2508 'reason_type', 'int', '', '', '', '',
2509 'reason', 'text', '', '', '', '',
2510 'disabled', 'char', 'NULL', 1, '', '',
2512 'primary_key' => 'reasonnum',
2519 'confnum', 'serial', '', '', '', '',
2520 'agentnum', 'int', 'NULL', '', '', '',
2521 'name', 'varchar', '', $char_d, '', '',
2522 'value', 'text', 'NULL', '', '', '',
2524 'primary_key' => 'confnum',
2525 'unique' => [ [ 'agentnum', 'name' ]],
2531 'pkgrefnum', 'serial', '', '', '', '',
2532 'pkgnum', 'int', '', '', '', '',
2533 'refnum', 'int', '', '', '', '',
2535 'primary_key' => 'pkgrefnum',
2536 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2537 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2542 'svcnum', 'int', '', '', '', '',
2543 'id', 'int', 'NULL', '', '', '',
2544 'title', 'varchar', 'NULL', $char_d, '', '',
2545 'max_extensions', 'int', 'NULL', '', '', '',
2547 'primary_key' => 'svcnum',
2549 'index' => [ [ 'id' ] ],
2553 # name type nullability length default local
2557 # 'num', 'serial', '', '', '', '',
2559 # 'primary_key' => 'num',