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, '', '', #not yet used much
410 'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
411 'agent_invid', 'int', 'NULL', '', '', '', #(varchar?) importing legacy
413 'primary_key' => 'invnum',
414 'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum? huh
415 'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
418 'cust_statement' => {
420 'statementnum', 'serial', '', '', '', '',
421 'custnum', 'int', '', '', '', '',
422 '_date', @date_type, '', '',
424 'primary_key' => 'statementnum',
426 'index' => [ ['custnum'], ['_date'], ],
429 'cust_bill_event' => {
431 'eventnum', 'serial', '', '', '', '',
432 'invnum', 'int', '', '', '', '',
433 'eventpart', 'int', '', '', '', '',
434 '_date', @date_type, '', '',
435 'status', 'varchar', '', $char_d, '', '',
436 'statustext', 'text', 'NULL', '', '', '',
438 'primary_key' => 'eventnum',
439 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
441 'index' => [ ['invnum'], ['status'], ['eventpart'],
442 ['statustext'], ['_date'],
446 'part_bill_event' => {
448 'eventpart', 'serial', '', '', '', '',
449 'freq', 'varchar', 'NULL', $char_d, '', '',
450 'payby', 'char', '', 4, '', '',
451 'event', 'varchar', '', $char_d, '', '',
452 'eventcode', @perl_type, '', '',
453 'seconds', 'int', 'NULL', '', '', '',
454 'weight', 'int', '', '', '', '',
455 'plan', 'varchar', 'NULL', $char_d, '', '',
456 'plandata', 'text', 'NULL', '', '', '',
457 'reason', 'int', 'NULL', '', '', '',
458 'disabled', 'char', 'NULL', 1, '', '',
460 'primary_key' => 'eventpart',
462 'index' => [ ['payby'], ['disabled'], ],
467 'eventpart', 'serial', '', '', '', '',
468 'agentnum', 'int', 'NULL', '', '', '',
469 'event', 'varchar', '', $char_d, '', '',
470 'eventtable', 'varchar', '', $char_d, '', '',
471 'check_freq', 'varchar', 'NULL', $char_d, '', '',
472 'weight', 'int', '', '', '', '',
473 'action', 'varchar', '', $char_d, '', '',
474 'disabled', 'char', 'NULL', 1, '', '',
476 'primary_key' => 'eventpart',
478 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
481 'part_event_option' => {
483 'optionnum', 'serial', '', '', '', '',
484 'eventpart', 'int', '', '', '', '',
485 'optionname', 'varchar', '', $char_d, '', '',
486 'optionvalue', 'text', 'NULL', '', '', '',
488 'primary_key' => 'optionnum',
490 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
493 'part_event_condition' => {
495 'eventconditionnum', 'serial', '', '', '', '',
496 'eventpart', 'int', '', '', '', '',
497 'conditionname', 'varchar', '', $char_d, '', '',
499 'primary_key' => 'eventconditionnum',
501 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
504 'part_event_condition_option' => {
506 'optionnum', 'serial', '', '', '', '',
507 'eventconditionnum', 'int', '', '', '', '',
508 'optionname', 'varchar', '', $char_d, '', '',
509 'optionvalue', 'text', 'NULL', '', '', '',
511 'primary_key' => 'optionnum',
513 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
516 'part_event_condition_option_option' => {
518 'optionoptionnum', 'serial', '', '', '', '',
519 'optionnum', 'int', '', '', '', '',
520 'optionname', 'varchar', '', $char_d, '', '',
521 'optionvalue', 'text', 'NULL', '', '', '',
523 'primary_key' => 'optionoptionnum',
525 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
530 'eventnum', 'serial', '', '', '', '',
531 'eventpart', 'int', '', '', '', '',
532 'tablenum', 'int', '', '', '', '',
533 '_date', @date_type, '', '',
534 'status', 'varchar', '', $char_d, '', '',
535 'statustext', 'text', 'NULL', '', '', '',
537 'primary_key' => 'eventnum',
538 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
540 'index' => [ ['eventpart'], ['tablenum'], ['status'],
541 ['statustext'], ['_date'],
547 'billpkgnum', 'serial', '', '', '', '',
548 'invnum', 'int', '', '', '', '',
549 'pkgnum', 'int', '', '', '', '',
550 'pkgpart_override', 'int', 'NULL', '', '', '',
551 'setup', @money_type, '', '',
552 'recur', @money_type, '', '',
553 'sdate', @date_type, '', '',
554 'edate', @date_type, '', '',
555 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
556 'itemcomment', 'varchar', 'NULL', $char_d, '', '',
557 'section', 'varchar', 'NULL', $char_d, '', '',
558 'quantity', 'int', 'NULL', '', '', '',
559 'unitsetup', @money_typen, '', '',
560 'unitrecur', @money_typen, '', '',
561 'hidden', 'char', 'NULL', 1, '', '',
563 'primary_key' => 'billpkgnum',
565 'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
568 'cust_bill_pkg_detail' => {
570 'detailnum', 'serial', '', '', '', '',
571 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
572 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
573 'invnum', 'int', 'NULL', '', '', '', # deprecated
574 'amount', 'decimal', 'NULL', '10,4', '', '',
575 'format', 'char', 'NULL', 1, '', '',
576 'classnum', 'int', 'NULL', '', '', '',
577 'duration', 'int', 'NULL', '', 0, '',
578 'phonenum', 'varchar', 'NULL', 15, '', '',
579 'regionname', 'varchar', 'NULL', $char_d, '', '',
580 'detail', 'varchar', '', 255, '', '',
582 'primary_key' => 'detailnum',
584 'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
587 'cust_bill_pkg_display' => {
589 'billpkgdisplaynum', 'serial', '', '', '', '',
590 'billpkgnum', 'int', '', '', '', '',
591 'section', 'varchar', 'NULL', $char_d, '', '',
592 #'unitsetup', @money_typen, '', '', #override the linked real one?
593 #'unitrecur', @money_typen, '', '', #this too?
594 'post_total', 'char', 'NULL', 1, '', '',
595 'type', 'char', 'NULL', 1, '', '',
596 'summary', 'char', 'NULL', 1, '', '',
598 'primary_key' => 'billpkgdisplaynum',
600 'index' => [ ['billpkgnum'], ],
603 'cust_bill_pkg_tax_location' => {
605 'billpkgtaxlocationnum', 'serial', '', '', '', '',
606 'billpkgnum', 'int', '', '', '', '',
607 'taxnum', 'int', '', '', '', '',
608 'taxtype', 'varchar', '', $char_d, '', '',
609 'pkgnum', 'int', '', '', '', '',
610 'locationnum', 'int', '', '', '', '', #redundant?
611 'amount', @money_type, '', '',
613 'primary_key' => 'billpkgtaxlocationnum',
615 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
618 'cust_bill_pkg_tax_rate_location' => {
620 'billpkgtaxratelocationnum', 'serial', '', '', '', '',
621 'billpkgnum', 'int', '', '', '', '',
622 'taxnum', 'int', '', '', '', '',
623 'taxtype', 'varchar', '', $char_d, '', '',
624 'locationtaxid', 'varchar', 'NULL', $char_d, '', '',
625 'taxratelocationnum', 'int', '', '', '', '',
626 'amount', @money_type, '', '',
628 'primary_key' => 'billpkgtaxratelocationnum',
630 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
635 'crednum', 'serial', '', '', '', '',
636 'custnum', 'int', '', '', '', '',
637 '_date', @date_type, '', '',
638 'amount', @money_type, '', '',
639 'otaker', 'varchar', '', 32, '', '',
640 'reason', 'text', 'NULL', '', '', '',
641 'reasonnum', 'int', 'NULL', '', '', '',
642 'addlinfo', 'text', 'NULL', '', '', '',
643 'closed', 'char', 'NULL', 1, '', '',
644 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
646 'primary_key' => 'crednum',
648 'index' => [ ['custnum'], ['_date'] ],
651 'cust_credit_bill' => {
653 'creditbillnum', 'serial', '', '', '', '',
654 'crednum', 'int', '', '', '', '',
655 'invnum', 'int', '', '', '', '',
656 '_date', @date_type, '', '',
657 'amount', @money_type, '', '',
658 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
660 'primary_key' => 'creditbillnum',
662 'index' => [ ['crednum'], ['invnum'] ],
665 'cust_credit_bill_pkg' => {
667 'creditbillpkgnum', 'serial', '', '', '', '',
668 'creditbillnum', 'int', '', '', '', '',
669 'billpkgnum', 'int', '', '', '', '',
670 'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
671 'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
672 'amount', @money_type, '', '',
673 'setuprecur', 'varchar', '', $char_d, '', '',
674 'sdate', @date_type, '', '',
675 'edate', @date_type, '', '',
677 'primary_key' => 'creditbillpkgnum',
679 'index' => [ [ 'creditbillnum' ],
681 [ 'billpkgtaxlocationnum' ],
682 [ 'billpkgtaxratelocationnum' ],
688 'custnum', 'serial', '', '', '', '',
689 'agentnum', 'int', '', '', '', '',
690 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
691 'classnum', 'int', 'NULL', '', '', '',
692 'custbatch', 'varchar', 'NULL', $char_d, '', '',
693 # 'titlenum', 'int', 'NULL', '', '', '',
694 'last', 'varchar', '', $char_d, '', '',
695 # 'middle', 'varchar', 'NULL', $char_d, '', '',
696 'first', 'varchar', '', $char_d, '', '',
697 'ss', 'varchar', 'NULL', 11, '', '',
698 'stateid', 'varchar', 'NULL', $char_d, '', '',
699 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
700 'birthdate' ,@date_type, '', '',
701 'signupdate',@date_type, '', '',
702 'dundate', @date_type, '', '',
703 'company', 'varchar', 'NULL', $char_d, '', '',
704 'address1', 'varchar', '', $char_d, '', '',
705 'address2', 'varchar', 'NULL', $char_d, '', '',
706 'city', 'varchar', '', $char_d, '', '',
707 'county', 'varchar', 'NULL', $char_d, '', '',
708 'state', 'varchar', 'NULL', $char_d, '', '',
709 'zip', 'varchar', 'NULL', 10, '', '',
710 'country', 'char', '', 2, '', '',
711 'daytime', 'varchar', 'NULL', 20, '', '',
712 'night', 'varchar', 'NULL', 20, '', '',
713 'fax', 'varchar', 'NULL', 12, '', '',
714 'ship_last', 'varchar', 'NULL', $char_d, '', '',
715 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
716 'ship_first', 'varchar', 'NULL', $char_d, '', '',
717 'ship_company', 'varchar', 'NULL', $char_d, '', '',
718 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
719 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
720 'ship_city', 'varchar', 'NULL', $char_d, '', '',
721 'ship_county', 'varchar', 'NULL', $char_d, '', '',
722 'ship_state', 'varchar', 'NULL', $char_d, '', '',
723 'ship_zip', 'varchar', 'NULL', 10, '', '',
724 'ship_country', 'char', 'NULL', 2, '', '',
725 'ship_daytime', 'varchar', 'NULL', 20, '', '',
726 'ship_night', 'varchar', 'NULL', 20, '', '',
727 'ship_fax', 'varchar', 'NULL', 12, '', '',
728 'payby', 'char', '', 4, '', '',
729 'payinfo', 'varchar', 'NULL', 512, '', '',
730 'paycvv', 'varchar', 'NULL', 512, '', '',
731 'paymask', 'varchar', 'NULL', $char_d, '', '',
732 #'paydate', @date_type, '', '',
733 'paydate', 'varchar', 'NULL', 10, '', '',
734 'paystart_month', 'int', 'NULL', '', '', '',
735 'paystart_year', 'int', 'NULL', '', '', '',
736 'payissue', 'varchar', 'NULL', 2, '', '',
737 'payname', 'varchar', 'NULL', $char_d, '', '',
738 'paystate', 'varchar', 'NULL', $char_d, '', '',
739 'paytype', 'varchar', 'NULL', $char_d, '', '',
740 'payip', 'varchar', 'NULL', 15, '', '',
741 'geocode', 'varchar', 'NULL', 20, '', '',
742 'censustract', 'varchar', 'NULL', 20, '', '', # 7 to save space?
743 'tax', 'char', 'NULL', 1, '', '',
744 'otaker', 'varchar', '', 32, '', '',
745 'refnum', 'int', '', '', '', '',
746 'referral_custnum', 'int', 'NULL', '', '', '',
747 'comments', 'text', 'NULL', '', '', '',
748 'spool_cdr','char', 'NULL', 1, '', '',
749 'squelch_cdr','char', 'NULL', 1, '', '',
750 'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
751 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
752 'archived', 'char', 'NULL', 1, '', '',
753 'email_csv_cdr', 'char', 'NULL', 1, '', '',
755 'primary_key' => 'custnum',
756 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
757 #'index' => [ ['last'], ['company'] ],
759 [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ],
761 [ 'referral_custnum' ],
762 [ 'payby' ], [ 'paydate' ],
765 [ 'last' ], [ 'company' ],
766 [ 'county' ], [ 'state' ], [ 'country' ],
768 [ 'daytime' ], [ 'night' ], [ 'fax' ],
770 [ 'ship_last' ], [ 'ship_company' ],
771 [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
773 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
777 'cust_recon' => { # what purpose does this serve?
779 'reconid', 'serial', '', '', '', '',
780 'recondate', @date_type, '', '',
781 'custnum', 'int' , '', '', '', '',
782 'agentnum', 'int', '', '', '', '',
783 'last', 'varchar', '', $char_d, '', '',
784 'first', 'varchar', '', $char_d, '', '',
785 'address1', 'varchar', '', $char_d, '', '',
786 'address2', 'varchar', 'NULL', $char_d, '', '',
787 'city', 'varchar', '', $char_d, '', '',
788 'state', 'varchar', 'NULL', $char_d, '', '',
789 'zip', 'varchar', 'NULL', 10, '', '',
790 'pkg', 'varchar', 'NULL', $char_d, '', '',
791 'adjourn', @date_type, '', '',
792 'status', 'varchar', 'NULL', 10, '', '',
793 'agent_custid', 'varchar', '', $char_d, '', '',
794 'agent_pkg', 'varchar', 'NULL', $char_d, '', '',
795 'agent_adjourn', @date_type, '', '',
796 'comments', 'text', 'NULL', '', '', '',
798 'primary_key' => 'reconid',
803 #eventually for cust_main too
806 'contactnum', 'serial', '', '', '', '',
807 'prospectnum', 'int', 'NULL', '', '', '',
808 'custnum', 'int', 'NULL', '', '', '',
809 'locationnum', 'int', 'NULL', '', '', '', #not yet
810 # 'titlenum', 'int', 'NULL', '', '', '', #eg Mr. Mrs. Dr. Rev.
811 'last', 'varchar', '', $char_d, '', '',
812 # 'middle', 'varchar', 'NULL', $char_d, '', '',
813 'first', 'varchar', '', $char_d, '', '',
814 'title', 'varchar', '', $char_d, '', '', #eg Head Bottle Washer
815 'comment', 'varchar', '', $char_d, '', '',
816 'disabled', 'char', 'NULL', 1, '', '',
818 'primary_key' => 'contactnum',
820 'index' => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
821 [ 'last' ], [ 'first' ],
827 'contactphonenum', 'serial', '', '', '', '',
828 'contactnum', 'int', '', '', '', '',
829 'phonetypenum', 'int', '', '', '', '',
830 'countrycode', 'varchar', '', 3, '', '',
831 'phonenum', 'varchar', '', 14, '', '',
832 'extension', 'varchar', '', 7, '', '',
833 #?#'comment', 'varchar', '', $char_d, '', '',
835 'primary_key' => 'contactphonenum',
842 'phonetypenum', 'serial', '', '', '', '',
843 'typename', 'varchar', '', $char_d, '', '',
844 'weight', 'int', '', '', '', '',
846 'primary_key' => 'phonetypenum',
847 'unique' => [ [ 'typename' ], ],
853 'contactemailnum', 'serial', '', '', '', '',
854 'contactnum', 'int', '', '', '', '',
855 'emailaddress', 'varchar', '', $char_d, '', '',
857 'primary_key' => 'contactemailnum',
858 'unique' => [ [ 'emailaddress' ], ],
864 'prospectnum', 'serial', '', '', '', '',
865 'agentnum', 'int', '', '', '', '',
866 'company', 'varchar', '', $char_d, '', '',
867 #'disabled', 'char', 'NULL', 1, '', '',
869 'primary_key' => 'prospectnum',
871 'index' => [ [ 'company' ], [ 'agentnum' ], ],
874 #eventually use for billing & ship from cust_main too
875 #for now, just cust_pkg locations
876 'cust_location' => { #'location' now that its prospects too, but...
878 'locationnum', 'serial', '', '', '', '',
879 'prospectnum', 'int', 'NULL', '', '', '',
880 'custnum', 'int', 'NULL', '', '', '',
881 'address1', 'varchar', '', $char_d, '', '',
882 'address2', 'varchar', 'NULL', $char_d, '', '',
883 'city', 'varchar', '', $char_d, '', '',
884 'county', 'varchar', 'NULL', $char_d, '', '',
885 'state', 'varchar', 'NULL', $char_d, '', '',
886 'zip', 'varchar', 'NULL', 10, '', '',
887 'country', 'char', '', 2, '', '',
888 'geocode', 'varchar', 'NULL', 20, '', '',
890 'primary_key' => 'locationnum',
892 'index' => [ [ 'prospectnum' ], [ 'custnum' ],
893 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
897 'cust_main_invoice' => {
899 'destnum', 'serial', '', '', '', '',
900 'custnum', 'int', '', '', '', '',
901 'dest', 'varchar', '', $char_d, '', '',
903 'primary_key' => 'destnum',
905 'index' => [ ['custnum'], ],
908 'cust_main_note' => {
910 'notenum', 'serial', '', '', '', '',
911 'custnum', 'int', '', '', '', '',
912 '_date', @date_type, '', '',
913 'otaker', 'varchar', '', 32, '', '',
914 'comments', 'text', 'NULL', '', '', '',
916 'primary_key' => 'notenum',
918 'index' => [ [ 'custnum' ], [ '_date' ], ],
923 'categorynum', 'serial', '', '', '', '',
924 'categoryname', 'varchar', '', $char_d, '', '',
925 'weight', 'int', 'NULL', '', '', '',
926 'disabled', 'char', 'NULL', 1, '', '',
928 'primary_key' => 'categorynum',
930 'index' => [ ['disabled'] ],
935 'classnum', 'serial', '', '', '', '',
936 'classname', 'varchar', '', $char_d, '', '',
937 'categorynum', 'int', 'NULL', '', '', '',
938 'disabled', 'char', 'NULL', 1, '', '',
940 'primary_key' => 'classnum',
942 'index' => [ ['disabled'] ],
945 'cust_main_exemption' => {
947 'exemptionnum', 'serial', '', '', '', '',
948 'custnum', 'int', '', '', '', '',
949 'taxname', 'varchar', '', $char_d, '', '',
950 #start/end dates? for reporting?
952 'primary_key' => 'exemptionnum',
954 'index' => [ [ 'custnum' ] ],
957 'cust_tax_adjustment' => {
959 'adjustmentnum', 'serial', '', '', '', '',
960 'custnum', 'int', '', '', '', '',
961 'taxname', 'varchar', '', $char_d, '', '',
962 'amount', @money_type, '', '',
963 'comment', 'varchar', 'NULL', $char_d, '', '',
964 'billpkgnum', 'int', 'NULL', '', '', '',
965 #more? no cust_bill_pkg_tax_location?
967 'primary_key' => 'adjustmentnum',
969 'index' => [ [ 'custnum' ], [ 'billpkgnum' ] ],
972 'cust_main_county' => { #county+state+country are checked off the
973 #cust_main_county for validation and to provide
976 'taxnum', 'serial', '', '', '', '',
977 'city', 'varchar', 'NULL', $char_d, '', '',
978 'county', 'varchar', 'NULL', $char_d, '', '',
979 'state', 'varchar', 'NULL', $char_d, '', '',
980 'country', 'char', '', 2, '', '',
981 'taxclass', 'varchar', 'NULL', $char_d, '', '',
982 'exempt_amount', @money_type, '', '',
983 'tax', 'real', '', '', '', '', #tax %
984 'taxname', 'varchar', 'NULL', $char_d, '', '',
985 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
986 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
988 'primary_key' => 'taxnum',
990 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
991 'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
998 'taxnum', 'serial', '', '', '', '',
999 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1000 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1001 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1002 'taxclassnum', 'int', '', '', '', '',
1003 'effective_date', @date_type, '', '',
1004 'tax', @taxrate_type, '', '', # tax %
1005 'excessrate', @taxrate_typen, '', '', # second tax %
1006 'taxbase', @money_typen, '', '', # amount at first tax rate
1007 'taxmax', @money_typen, '', '', # maximum about at both rates
1008 'usetax', @taxrate_typen, '', '', # tax % when non-local
1009 'useexcessrate', @taxrate_typen, '', '', # second tax % when non-local
1010 'unittype', 'int', 'NULL', '', '', '', # for fee
1011 'fee', @taxrate_typen, '', '', # amount tax per unit
1012 'excessfee', @taxrate_typen, '', '', # second amount tax per unit
1013 'feebase', @taxrate_typen, '', '', # units taxed at first rate
1014 'feemax', @taxrate_typen, '', '', # maximum number of unit taxed
1015 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
1016 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
1017 'taxauth', 'int', 'NULL', '', '', '', # tax authority
1018 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
1019 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
1020 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
1021 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
1022 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
1023 'inoutcity', 'char', 'NULL', 1, '', '', # '', 'I', or 'O'
1024 'inoutlocal', 'char', 'NULL', 1, '', '', # '', 'I', or 'O'
1025 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
1026 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
1028 'primary_key' => 'taxnum',
1030 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1033 'tax_rate_location' => {
1035 'taxratelocationnum', 'serial', '', '', '', '',
1036 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1037 'geocode', 'varchar', '', 20, '', '',
1038 'city', 'varchar', 'NULL', $char_d, '', '',
1039 'county', 'varchar', 'NULL', $char_d, '', '',
1040 'state', 'char', 'NULL', 2, '', '',
1041 'disabled', 'char', 'NULL', 1, '', '',
1043 'primary_key' => 'taxratelocationnum',
1045 'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1048 'cust_tax_location' => {
1050 'custlocationnum', 'serial', '', '', '', '',
1051 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1052 'city', 'varchar', 'NULL', $char_d, '', '',
1053 'postalcity', 'varchar', 'NULL', $char_d, '', '',
1054 'county', 'varchar', 'NULL', $char_d, '', '',
1055 'zip', 'char', '', 5, '', '',
1056 'state', 'char', '', 2, '', '',
1057 'plus4hi', 'char', 'NULL', 4, '', '',
1058 'plus4lo', 'char', 'NULL', 4, '', '',
1059 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
1060 'cityflag', 'char', 'NULL', 1, '', '', # I(n)/O(out)/B(oth)/NULL
1061 'geocode', 'varchar', '', 20, '', '',
1063 'primary_key' => 'custlocationnum',
1065 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1070 'taxclassnum', 'serial', '', '', '', '',
1071 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1072 'taxclass', 'varchar', '', $char_d, '', '',
1073 'description', 'varchar', '', 2*$char_d, '', '',
1075 'primary_key' => 'taxclassnum',
1076 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1080 'cust_pay_pending' => {
1082 'paypendingnum','serial', '', '', '', '',
1083 'custnum', 'int', '', '', '', '',
1084 'paid', @money_type, '', '',
1085 '_date', @date_type, '', '',
1086 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
1087 # be index into payby
1089 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1090 'paymask', 'varchar', 'NULL', $char_d, '', '',
1091 'paydate', 'varchar', 'NULL', 10, '', '',
1092 'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1093 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1094 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1096 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1097 'status', 'varchar', '', $char_d, '', '',
1098 'session_id', 'varchar', 'NULL', $char_d, '', '', #only need 32
1099 'statustext', 'text', 'NULL', '', '', '',
1100 'gatewaynum', 'int', 'NULL', '', '', '',
1101 #'cust_balance', @money_type, '', '',
1102 'paynum', 'int', 'NULL', '', '', '',
1103 'jobnum', 'int', 'NULL', '', '', '',
1105 'primary_key' => 'paypendingnum',
1106 'unique' => [ [ 'payunique' ] ],
1107 'index' => [ [ 'custnum' ], [ 'status' ], ],
1112 'paynum', 'serial', '', '', '', '',
1113 'custnum', 'int', '', '', '', '',
1114 '_date', @date_type, '', '',
1115 'paid', @money_type, '', '',
1116 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
1117 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1118 # index into payby table
1120 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1121 'paymask', 'varchar', 'NULL', $char_d, '', '',
1122 'paydate', 'varchar', 'NULL', 10, '', '',
1123 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1124 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1125 'closed', 'char', 'NULL', 1, '', '',
1126 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1128 'primary_key' => 'paynum',
1129 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1130 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
1133 'cust_pay_void' => {
1135 'paynum', 'int', '', '', '', '',
1136 'custnum', 'int', '', '', '', '',
1137 'paid', @money_type, '', '',
1138 '_date', @date_type, '', '',
1139 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1140 # index into payby table
1142 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1143 'paymask', 'varchar', 'NULL', $char_d, '', '',
1144 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1145 'closed', 'char', 'NULL', 1, '', '',
1146 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1147 'void_date', @date_type, '', '',
1148 'reason', 'varchar', 'NULL', $char_d, '', '',
1149 'otaker', 'varchar', '', 32, '', '',
1151 'primary_key' => 'paynum',
1153 'index' => [ [ 'custnum' ] ],
1156 'cust_bill_pay' => {
1158 'billpaynum', 'serial', '', '', '', '',
1159 'invnum', 'int', '', '', '', '',
1160 'paynum', 'int', '', '', '', '',
1161 'amount', @money_type, '', '',
1162 '_date', @date_type, '', '',
1163 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1165 'primary_key' => 'billpaynum',
1167 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1170 'cust_bill_pay_batch' => {
1172 'billpaynum', 'serial', '', '', '', '',
1173 'invnum', 'int', '', '', '', '',
1174 'paybatchnum', 'int', '', '', '', '',
1175 'amount', @money_type, '', '',
1176 '_date', @date_type, '', '',
1178 'primary_key' => 'billpaynum',
1180 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1183 'cust_bill_pay_pkg' => {
1185 'billpaypkgnum', 'serial', '', '', '', '',
1186 'billpaynum', 'int', '', '', '', '',
1187 'billpkgnum', 'int', '', '', '', '',
1188 'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1189 'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1190 'amount', @money_type, '', '',
1191 'setuprecur', 'varchar', '', $char_d, '', '',
1192 'sdate', @date_type, '', '',
1193 'edate', @date_type, '', '',
1195 'primary_key' => 'billpaypkgnum',
1197 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1200 'pay_batch' => { #batches of payments to an external processor
1202 'batchnum', 'serial', '', '', '', '',
1203 'payby', 'char', '', 4, '', '', # CARD/CHEK
1204 'status', 'char', 'NULL', 1, '', '',
1205 'download', @date_type, '', '',
1206 'upload', @date_type, '', '',
1208 'primary_key' => 'batchnum',
1213 'cust_pay_batch' => { #what's this used for again? list of customers
1214 #in current CARD batch? (necessarily CARD?)
1216 'paybatchnum', 'serial', '', '', '', '',
1217 'batchnum', 'int', '', '', '', '',
1218 'invnum', 'int', '', '', '', '',
1219 'custnum', 'int', '', '', '', '',
1220 'last', 'varchar', '', $char_d, '', '',
1221 'first', 'varchar', '', $char_d, '', '',
1222 'address1', 'varchar', '', $char_d, '', '',
1223 'address2', 'varchar', 'NULL', $char_d, '', '',
1224 'city', 'varchar', '', $char_d, '', '',
1225 'state', 'varchar', 'NULL', $char_d, '', '',
1226 'zip', 'varchar', 'NULL', 10, '', '',
1227 'country', 'char', '', 2, '', '',
1228 # 'trancode', 'int', '', '', '', ''
1229 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1230 'payinfo', 'varchar', '', 512, '', '',
1231 #'exp', @date_type, '', ''
1232 'exp', 'varchar', 'NULL', 11, '', '',
1233 'payname', 'varchar', 'NULL', $char_d, '', '',
1234 'amount', @money_type, '', '',
1235 'status', 'varchar', 'NULL', $char_d, '', '',
1237 'primary_key' => 'paybatchnum',
1239 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1244 'pkgnum', 'serial', '', '', '', '',
1245 'custnum', 'int', '', '', '', '',
1246 'pkgpart', 'int', '', '', '', '',
1247 'locationnum', 'int', 'NULL', '', '', '',
1248 'otaker', 'varchar', '', 32, '', '',
1249 'start_date', @date_type, '', '',
1250 'setup', @date_type, '', '',
1251 'bill', @date_type, '', '',
1252 'last_bill', @date_type, '', '',
1253 'susp', @date_type, '', '',
1254 'adjourn', @date_type, '', '',
1255 'cancel', @date_type, '', '',
1256 'expire', @date_type, '', '',
1257 'change_date', @date_type, '', '',
1258 'change_pkgnum', 'int', 'NULL', '', '', '',
1259 'change_pkgpart', 'int', 'NULL', '', '', '',
1260 'change_locationnum', 'int', 'NULL', '', '', '',
1261 'manual_flag', 'char', 'NULL', 1, '', '',
1262 'quantity', 'int', 'NULL', '', '', '',
1264 'primary_key' => 'pkgnum',
1266 'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1267 [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1268 ['susp'], ['adjourn'], ['expire'], ['cancel'],
1273 'cust_pkg_option' => {
1275 'optionnum', 'serial', '', '', '', '',
1276 'pkgnum', 'int', '', '', '', '',
1277 'optionname', 'varchar', '', $char_d, '', '',
1278 'optionvalue', 'text', 'NULL', '', '', '',
1280 'primary_key' => 'optionnum',
1282 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
1285 'cust_pkg_detail' => {
1287 'pkgdetailnum', 'serial', '', '', '', '',
1288 'pkgnum', 'int', '', '', '', '',
1289 'detail', 'varchar', '', $char_d, '', '',
1290 'detailtype', 'char', '', 1, '', '', # "I"nvoice or "C"omment
1291 'weight', 'int', '', '', '', '',
1293 'primary_key' => 'pkgdetailnum',
1295 'index' => [ [ 'pkgnum', 'detailtype' ] ],
1298 'cust_pkg_reason' => {
1300 'num', 'serial', '', '', '', '',
1301 'pkgnum', 'int', '', '', '', '',
1302 'reasonnum','int', '', '', '', '',
1303 'action', 'char', 'NULL', 1, '', '', #should not be nullable
1304 'otaker', 'varchar', '', 32, '', '',
1305 'date', @date_type, '', '',
1307 'primary_key' => 'num',
1309 'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1314 'refundnum', 'serial', '', '', '', '',
1315 'custnum', 'int', '', '', '', '',
1316 '_date', @date_type, '', '',
1317 'refund', @money_type, '', '',
1318 'otaker', 'varchar', '', 32, '', '',
1319 'reason', 'varchar', '', $char_d, '', '',
1320 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
1321 # be index into payby
1323 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1324 'paymask', 'varchar', 'NULL', $char_d, '', '',
1325 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1326 'closed', 'char', 'NULL', 1, '', '',
1328 'primary_key' => 'refundnum',
1330 'index' => [ ['custnum'], ['_date'] ],
1333 'cust_credit_refund' => {
1335 'creditrefundnum', 'serial', '', '', '', '',
1336 'crednum', 'int', '', '', '', '',
1337 'refundnum', 'int', '', '', '', '',
1338 'amount', @money_type, '', '',
1339 '_date', @date_type, '', '',
1341 'primary_key' => 'creditrefundnum',
1343 'index' => [ ['crednum'], ['refundnum'] ],
1349 'svcnum', 'serial', '', '', '', '',
1350 'pkgnum', 'int', 'NULL', '', '', '',
1351 'svcpart', 'int', '', '', '', '',
1352 'overlimit', @date_type, '', '',
1354 'primary_key' => 'svcnum',
1356 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1359 'cust_svc_option' => {
1361 'optionnum', 'serial', '', '', '', '',
1362 'svcnum', 'int', '', '', '', '',
1363 'optionname', 'varchar', '', $char_d, '', '',
1364 'optionvalue', 'text', 'NULL', '', '', '',
1366 'primary_key' => 'optionnum',
1368 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1373 'pkgpart', 'serial', '', '', '', '',
1374 'pkg', 'varchar', '', $char_d, '', '',
1375 'comment', 'varchar', '', $char_d, '', '',
1376 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1377 'setup', @perl_type, '', '',
1378 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1379 'recur', @perl_type, '', '',
1380 'setuptax', 'char', 'NULL', 1, '', '',
1381 'recurtax', 'char', 'NULL', 1, '', '',
1382 'plan', 'varchar', 'NULL', $char_d, '', '',
1383 'plandata', 'text', 'NULL', '', '', '',
1384 'disabled', 'char', 'NULL', 1, '', '',
1385 'custom', 'char', 'NULL', 1, '', '',
1386 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1387 'classnum', 'int', 'NULL', '', '', '',
1388 'addon_classnum','int', 'NULL', '', '', '',
1389 'taxproductnum', 'int', 'NULL', '', '', '',
1390 'setup_cost', @money_typen, '', '',
1391 'recur_cost', @money_typen, '', '',
1392 'pay_weight', 'real', 'NULL', '', '', '',
1393 'credit_weight', 'real', 'NULL', '', '', '',
1394 'agentnum', 'int', 'NULL', '', '', '',
1397 'primary_key' => 'pkgpart',
1399 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1404 'part_pkg_link' => {
1406 'pkglinknum', 'serial', '', '', '', '',
1407 'src_pkgpart', 'int', '', '', '', '',
1408 'dst_pkgpart', 'int', '', '', '', '',
1409 'link_type', 'varchar', '', $char_d, '', '',
1410 'hidden', 'char', 'NULL', 1, '', '',
1412 'primary_key' => 'pkglinknum',
1413 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1414 'index' => [ [ 'src_pkgpart' ] ],
1416 # XXX somewhat borked unique: we don't really want a hidden and unhidden
1417 # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1419 'part_pkg_taxclass' => {
1421 'taxclassnum', 'serial', '', '', '', '',
1422 'taxclass', 'varchar', '', $char_d, '', '',
1423 'disabled', 'char', 'NULL', 1, '', '',
1425 'primary_key' => 'taxclassnum',
1426 'unique' => [ [ 'taxclass' ] ],
1427 'index' => [ [ 'disabled' ] ],
1430 'part_pkg_taxproduct' => {
1432 'taxproductnum', 'serial', '', '', '', '',
1433 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1434 'taxproduct', 'varchar', '', $char_d, '', '',
1435 'description', 'varchar', '', 3*$char_d, '', '',
1437 'primary_key' => 'taxproductnum',
1438 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1442 'part_pkg_taxrate' => {
1444 'pkgtaxratenum', 'serial', '', '', '', '',
1445 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1446 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1447 'taxproductnum', 'int', '', '', '', '',
1448 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1449 'county', 'varchar', 'NULL', $char_d, '', '',
1450 'state', 'varchar', 'NULL', $char_d, '', '',
1451 'local', 'varchar', 'NULL', $char_d, '', '',
1452 'country', 'char', 'NULL', 2, '', '',
1453 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1454 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1455 'taxclassnum', 'int', 'NULL', '', '', '',
1456 'effdate', @date_type, '', '',
1457 'taxable', 'char', 'NULL', 1, '', '',
1459 'primary_key' => 'pkgtaxratenum',
1461 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1464 'part_pkg_taxoverride' => {
1466 'taxoverridenum', 'serial', '', '', '', '',
1467 'pkgpart', 'serial', '', '', '', '',
1468 'taxclassnum', 'serial', '', '', '', '',
1469 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1471 'primary_key' => 'taxoverridenum',
1473 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1478 # 'titlenum', 'int', '', '',
1479 # 'title', 'varchar', '', $char_d,
1481 # 'primary_key' => 'titlenum',
1482 # 'unique' => [ [] ],
1483 # 'index' => [ [] ],
1488 'pkgsvcnum', 'serial', '', '', '', '',
1489 'pkgpart', 'int', '', '', '', '',
1490 'svcpart', 'int', '', '', '', '',
1491 'quantity', 'int', '', '', '', '',
1492 'primary_svc','char', 'NULL', 1, '', '',
1494 'primary_key' => 'pkgsvcnum',
1495 'unique' => [ ['pkgpart', 'svcpart'] ],
1496 'index' => [ ['pkgpart'], ['quantity'] ],
1499 'part_referral' => {
1501 'refnum', 'serial', '', '', '', '',
1502 'referral', 'varchar', '', $char_d, '', '',
1503 'disabled', 'char', 'NULL', 1, '', '',
1504 'agentnum', 'int', 'NULL', '', '', '',
1506 'primary_key' => 'refnum',
1508 'index' => [ ['disabled'], ['agentnum'], ],
1513 'svcpart', 'serial', '', '', '', '',
1514 'svc', 'varchar', '', $char_d, '', '',
1515 'svcdb', 'varchar', '', $char_d, '', '',
1516 'disabled', 'char', 'NULL', 1, '', '',
1518 'primary_key' => 'svcpart',
1520 'index' => [ [ 'disabled' ] ],
1523 'part_svc_column' => {
1525 'columnnum', 'serial', '', '', '', '',
1526 'svcpart', 'int', '', '', '', '',
1527 'columnname', 'varchar', '', 64, '', '',
1528 'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1529 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1530 'columnflag', 'char', 'NULL', 1, '', '',
1532 'primary_key' => 'columnnum',
1533 'unique' => [ [ 'svcpart', 'columnname' ] ],
1534 'index' => [ [ 'svcpart' ] ],
1537 #(this should be renamed to part_pop)
1540 'popnum', 'serial', '', '', '', '',
1541 'city', 'varchar', '', $char_d, '', '',
1542 'state', 'varchar', '', $char_d, '', '',
1543 'ac', 'char', '', 3, '', '',
1544 'exch', 'char', '', 3, '', '',
1545 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1547 'primary_key' => 'popnum',
1549 'index' => [ [ 'state' ] ],
1552 'part_pop_local' => {
1554 'localnum', 'serial', '', '', '', '',
1555 'popnum', 'int', '', '', '', '',
1556 'city', 'varchar', 'NULL', $char_d, '', '',
1557 'state', 'char', 'NULL', 2, '', '',
1558 'npa', 'char', '', 3, '', '',
1559 'nxx', 'char', '', 3, '', '',
1561 'primary_key' => 'localnum',
1563 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1568 'svcnum', 'int', '', '', '', '',
1569 'username', 'varchar', '', $username_len, '', '',
1570 '_password', 'varchar', 'NULL', 512, '', '',
1571 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1572 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1573 'popnum', 'int', 'NULL', '', '', '',
1574 'uid', 'int', 'NULL', '', '', '',
1575 'gid', 'int', 'NULL', '', '', '',
1576 'finger', 'varchar', 'NULL', $char_d, '', '',
1577 'dir', 'varchar', 'NULL', $char_d, '', '',
1578 'shell', 'varchar', 'NULL', $char_d, '', '',
1579 'quota', 'varchar', 'NULL', $char_d, '', '',
1580 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1581 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1582 'seconds_threshold', 'int', 'NULL', '', '', '',
1583 'upbytes', 'bigint', 'NULL', '', '', '',
1584 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1585 'downbytes', 'bigint', 'NULL', '', '', '',
1586 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1587 'totalbytes','bigint', 'NULL', '', '', '',
1588 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1589 'domsvc', 'int', '', '', '', '',
1590 'last_login', @date_type, '', '',
1591 'last_logout', @date_type, '', '',
1593 'primary_key' => 'svcnum',
1594 #'unique' => [ [ 'username', 'domsvc' ] ],
1596 'index' => [ ['username'], ['domsvc'] ],
1599 'acct_rt_transaction' => {
1601 'svcrtid', 'int', '', '', '', '',
1602 'svcnum', 'int', '', '', '', '',
1603 'transaction_id', 'int', '', '', '', '',
1604 '_date', @date_type, '', '',
1605 'seconds', 'int', '', '', '', '', #uhhhh
1606 'support', 'int', '', '', '', '',
1608 'primary_key' => 'svcrtid',
1610 'index' => [ ['svcnum', 'transaction_id'] ],
1615 # 'svcnum', 'int', '', '',
1616 # 'amount', @money_type,
1618 # 'primary_key' => 'svcnum',
1619 # 'unique' => [ [] ],
1620 # 'index' => [ [] ],
1625 'svcnum', 'int', '', '', '', '',
1626 'domain', 'varchar', '', $char_d, '', '',
1627 'suffix', 'varchar', 'NULL', $char_d, '', '',
1628 'catchall', 'int', 'NULL', '', '', '',
1629 'parent_svcnum', 'int', 'NULL', '', '', '',
1630 'registrarnum', 'int', 'NULL', '', '', '',
1631 'registrarkey', 'varchar', 'NULL', 512, '', '',
1632 'setup_date', @date_type, '', '',
1633 'renewal_interval', 'int', 'NULL', '', '', '',
1634 'expiration_date', @date_type, '', '',
1636 'primary_key' => 'svcnum',
1638 'index' => [ ['domain'] ],
1641 'domain_record' => {
1643 'recnum', 'serial', '', '', '', '',
1644 'svcnum', 'int', '', '', '', '',
1645 'reczone', 'varchar', '', 255, '', '',
1646 'recaf', 'char', '', 2, '', '',
1647 'rectype', 'varchar', '', 5, '', '',
1648 'recdata', 'varchar', '', 255, '', '',
1650 'primary_key' => 'recnum',
1652 'index' => [ ['svcnum'] ],
1657 'registrarnum', 'serial', '', '', '', '',
1658 'registrarname', 'varchar', '', $char_d, '', '',
1660 'primary_key' => 'registrarnum',
1667 'svcnum', 'int', '', '', '', '',
1668 'srcsvc', 'int', 'NULL', '', '', '',
1669 'src', 'varchar', 'NULL', 255, '', '',
1670 'dstsvc', 'int', 'NULL', '', '', '',
1671 'dst', 'varchar', 'NULL', 255, '', '',
1673 'primary_key' => 'svcnum',
1675 'index' => [ ['srcsvc'], ['dstsvc'] ],
1680 'svcnum', 'int', '', '', '', '',
1681 'recnum', 'int', '', '', '', '',
1682 'usersvc', 'int', 'NULL', '', '', '',
1683 'config', 'text', 'NULL', '', '', '',
1685 'primary_key' => 'svcnum',
1692 # 'svcnum', 'int', '', '',
1693 # 'svcnum', 'int', '', '',
1694 # 'svcnum', 'int', '', '',
1695 # 'worker', 'varchar', '', $char_d,
1696 # '_date', @date_type,
1698 # 'primary_key' => 'svcnum',
1699 # 'unique' => [ [] ],
1700 # 'index' => [ [] ],
1703 'prepay_credit' => {
1705 'prepaynum', 'serial', '', '', '', '',
1706 'identifier', 'varchar', '', $char_d, '', '',
1707 'amount', @money_type, '', '',
1708 'seconds', 'int', 'NULL', '', '', '',
1709 'upbytes', 'bigint', 'NULL', '', '', '',
1710 'downbytes', 'bigint', 'NULL', '', '', '',
1711 'totalbytes', 'bigint', 'NULL', '', '', '',
1712 'agentnum', 'int', 'NULL', '', '', '',
1714 'primary_key' => 'prepaynum',
1715 'unique' => [ ['identifier'] ],
1721 'portnum', 'serial', '', '', '', '',
1722 'ip', 'varchar', 'NULL', 15, '', '',
1723 'nasport', 'int', 'NULL', '', '', '',
1724 'nasnum', 'int', '', '', '', '',
1726 'primary_key' => 'portnum',
1733 'nasnum', 'serial', '', '', '', '',
1734 'nas', 'varchar', '', $char_d, '', '',
1735 'nasip', 'varchar', '', 15, '', '',
1736 'nasfqdn', 'varchar', '', $char_d, '', '',
1737 'last', 'int', '', '', '', '',
1739 'primary_key' => 'nasnum',
1740 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1741 'index' => [ [ 'last' ] ],
1746 # 'sessionnum', 'serial', '', '', '', '',
1747 # 'portnum', 'int', '', '', '', '',
1748 # 'svcnum', 'int', '', '', '', '',
1749 # 'login', @date_type, '', '',
1750 # 'logout', @date_type, '', '',
1752 # 'primary_key' => 'sessionnum',
1754 # 'index' => [ [ 'portnum' ] ],
1759 'jobnum', 'serial', '', '', '', '',
1760 'job', 'varchar', '', 512, '', '',
1761 '_date', 'int', '', '', '', '',
1762 'status', 'varchar', '', $char_d, '', '',
1763 'statustext', 'text', 'NULL', '', '', '',
1764 'svcnum', 'int', 'NULL', '', '', '',
1765 'custnum', 'int', 'NULL', '', '', '',
1766 'secure', 'char', 'NULL', 1, '', '',
1767 'priority', 'int', 'NULL', '', '', '',
1769 'primary_key' => 'jobnum',
1771 'index' => [ [ 'secure' ], [ 'priority' ],
1772 [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1778 'argnum', 'serial', '', '', '', '',
1779 'jobnum', 'int', '', '', '', '',
1780 'frozen', 'char', 'NULL', 1, '', '',
1781 'arg', 'text', 'NULL', '', '', '',
1783 'primary_key' => 'argnum',
1785 'index' => [ [ 'jobnum' ] ],
1790 'dependnum', 'serial', '', '', '', '',
1791 'jobnum', 'int', '', '', '', '',
1792 'depend_jobnum', 'int', '', '', '', '',
1794 'primary_key' => 'dependnum',
1796 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1801 'exportsvcnum' => 'serial', '', '', '', '',
1802 'exportnum' => 'int', '', '', '', '',
1803 'svcpart' => 'int', '', '', '', '',
1805 'primary_key' => 'exportsvcnum',
1806 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1807 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1812 'exportnum', 'serial', '', '', '', '',
1813 'machine', 'varchar', '', $char_d, '', '',
1814 'exporttype', 'varchar', '', $char_d, '', '',
1815 'nodomain', 'char', 'NULL', 1, '', '',
1817 'primary_key' => 'exportnum',
1819 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1822 'part_export_option' => {
1824 'optionnum', 'serial', '', '', '', '',
1825 'exportnum', 'int', '', '', '', '',
1826 'optionname', 'varchar', '', $char_d, '', '',
1827 'optionvalue', 'text', 'NULL', '', '', '',
1829 'primary_key' => 'optionnum',
1831 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1834 'radius_usergroup' => {
1836 'usergroupnum', 'serial', '', '', '', '',
1837 'svcnum', 'int', '', '', '', '',
1838 'groupname', 'varchar', '', $char_d, '', '',
1840 'primary_key' => 'usergroupnum',
1842 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1847 'msgnum', 'serial', '', '', '', '',
1848 'msgcode', 'varchar', '', $char_d, '', '',
1849 'locale', 'varchar', '', 16, '', '',
1850 'msg', 'text', '', '', '', '',
1852 'primary_key' => 'msgnum',
1853 'unique' => [ [ 'msgcode', 'locale' ] ],
1857 'cust_tax_exempt' => {
1859 'exemptnum', 'serial', '', '', '', '',
1860 'custnum', 'int', '', '', '', '',
1861 'taxnum', 'int', '', '', '', '',
1862 'year', 'int', '', '', '', '',
1863 'month', 'int', '', '', '', '',
1864 'amount', @money_type, '', '',
1866 'primary_key' => 'exemptnum',
1867 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1871 'cust_tax_exempt_pkg' => {
1873 'exemptpkgnum', 'serial', '', '', '', '',
1874 #'custnum', 'int', '', '', '', ''
1875 'billpkgnum', 'int', '', '', '', '',
1876 'taxnum', 'int', '', '', '', '',
1877 'year', 'int', '', '', '', '',
1878 'month', 'int', '', '', '', '',
1879 'creditbillpkgnum', 'int', 'NULL', '', '', '',
1880 'amount', @money_type, '', '',
1882 'primary_key' => 'exemptpkgnum',
1884 'index' => [ [ 'taxnum', 'year', 'month' ],
1887 [ 'creditbillpkgnum' ],
1893 'routernum', 'serial', '', '', '', '',
1894 'routername', 'varchar', '', $char_d, '', '',
1895 'svcnum', 'int', 'NULL', '', '', '',
1896 'agentnum', 'int', 'NULL', '', '', '',
1898 'primary_key' => 'routernum',
1903 'part_svc_router' => {
1905 'svcrouternum', 'serial', '', '', '', '',
1906 'svcpart', 'int', '', '', '', '',
1907 'routernum', 'int', '', '', '', '',
1909 'primary_key' => 'svcrouternum',
1916 'blocknum', 'serial', '', '', '', '',
1917 'routernum', 'int', '', '', '', '',
1918 'ip_gateway', 'varchar', '', 15, '', '',
1919 'ip_netmask', 'int', '', '', '', '',
1920 'agentnum', 'int', 'NULL', '', '', '',
1921 'manual_flag', 'char', 'NULL', 1, '', '',
1923 'primary_key' => 'blocknum',
1924 'unique' => [ [ 'blocknum', 'routernum' ] ],
1928 'svc_broadband' => {
1930 'svcnum', 'int', '', '', '', '',
1931 'description', 'varchar', 'NULL', $char_d, '', '',
1932 'blocknum', 'int', 'NULL', '', '', '',
1933 'speed_up', 'int', '', '', '', '',
1934 'speed_down', 'int', '', '', '', '',
1935 'ip_addr', 'varchar', 'NULL', 15, '', '',
1936 'mac_addr', 'varchar', 'NULL', 12, '', '',
1937 'authkey', 'varchar', 'NULL', 32, '', '',
1938 'latitude', 'decimal', 'NULL', '', '', '',
1939 'longitude', 'decimal', 'NULL', '', '', '',
1940 'altitude', 'decimal', 'NULL', '', '', '',
1941 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1942 'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1944 'primary_key' => 'svcnum',
1945 'unique' => [ [ 'mac_addr' ] ],
1949 'part_virtual_field' => {
1951 'vfieldpart', 'serial', '', '', '', '',
1952 'dbtable', 'varchar', '', 32, '', '',
1953 'name', 'varchar', '', 32, '', '',
1954 'check_block', 'text', 'NULL', '', '', '',
1955 'length', 'int', 'NULL', '', '', '',
1956 'list_source', 'text', 'NULL', '', '', '',
1957 'label', 'varchar', 'NULL', 80, '', '',
1959 'primary_key' => 'vfieldpart',
1964 'virtual_field' => {
1966 'vfieldnum', 'serial', '', '', '', '',
1967 'recnum', 'int', '', '', '', '',
1968 'vfieldpart', 'int', '', '', '', '',
1969 'value', 'varchar', '', 128, '', '',
1971 'primary_key' => 'vfieldnum',
1972 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1978 'snarfnum', 'int', '', '', '', '',
1979 'svcnum', 'int', '', '', '', '',
1980 'machine', 'varchar', '', 255, '', '',
1981 'protocol', 'varchar', '', $char_d, '', '',
1982 'username', 'varchar', '', $char_d, '', '',
1983 '_password', 'varchar', '', $char_d, '', '',
1985 'primary_key' => 'snarfnum',
1987 'index' => [ [ 'svcnum' ] ],
1992 'svcnum', 'int', '', '', '', '',
1993 'id', 'int', 'NULL', '', '', '',
1994 'title', 'varchar', 'NULL', $char_d, '', '',
1996 'primary_key' => 'svcnum',
2001 'cust_pay_refund' => {
2003 'payrefundnum', 'serial', '', '', '', '',
2004 'paynum', 'int', '', '', '', '',
2005 'refundnum', 'int', '', '', '', '',
2006 '_date', @date_type, '', '',
2007 'amount', @money_type, '', '',
2009 'primary_key' => 'payrefundnum',
2011 'index' => [ ['paynum'], ['refundnum'] ],
2014 'part_pkg_option' => {
2016 'optionnum', 'serial', '', '', '', '',
2017 'pkgpart', 'int', '', '', '', '',
2018 'optionname', 'varchar', '', $char_d, '', '',
2019 'optionvalue', 'text', 'NULL', '', '', '',
2021 'primary_key' => 'optionnum',
2023 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
2026 'part_pkg_report_option' => {
2028 'num', 'serial', '', '', '', '',
2029 'name', 'varchar', '', $char_d, '', '',
2030 'disabled', 'char', 'NULL', 1, '', '',
2032 'primary_key' => 'num',
2033 'unique' => [ [ 'name' ] ],
2034 'index' => [ [ 'disabled' ] ],
2039 'ratenum', 'serial', '', '', '', '',
2040 'ratename', 'varchar', '', $char_d, '', '',
2042 'primary_key' => 'ratenum',
2049 'ratedetailnum', 'serial', '', '', '', '',
2050 'ratenum', 'int', '', '', '', '',
2051 'orig_regionnum', 'int', 'NULL', '', '', '',
2052 'dest_regionnum', 'int', '', '', '', '',
2053 'min_included', 'int', '', '', '', '',
2054 #'min_charge', @money_type, '', '',
2055 'min_charge', 'decimal', '', '10,5', '', '',
2056 'sec_granularity', 'int', '', '', '', '',
2057 #time period (link to table of periods)?
2058 'classnum', 'int', 'NULL', '', '', '',
2060 'primary_key' => 'ratedetailnum',
2061 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2062 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
2067 'regionnum', 'serial', '', '', '', '',
2068 'regionname', 'varchar', '', $char_d, '', '',
2070 'primary_key' => 'regionnum',
2077 'prefixnum', 'serial', '', '', '', '',
2078 'regionnum', 'int', '', '', '', '',
2079 'countrycode', 'varchar', '', 3, '', '',
2080 'npa', 'varchar', 'NULL', 10, '', '', #actually the whole prefix
2081 'nxx', 'varchar', 'NULL', 3, '', '', #actually not used
2083 'primary_key' => 'prefixnum',
2085 'index' => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2090 'classnum', 'serial', '', '', '', '',
2091 'weight', 'int', 'NULL', '', '', '',
2092 'classname', 'varchar', '', $char_d, '', '',
2093 'format', 'varchar', 'NULL', $char_d, '', '',
2094 'disabled', 'char', 'NULL', 1, '', '',
2096 'primary_key' => 'classnum',
2098 'index' => [ ['disabled'] ],
2103 'codenum', 'serial', '', '', '', '',
2104 'code', 'varchar', '', $char_d, '', '',
2105 'agentnum', 'int', '', '', '', '',
2107 'primary_key' => 'codenum',
2108 'unique' => [ [ 'agentnum', 'code' ] ],
2109 'index' => [ [ 'agentnum' ] ],
2114 'codepkgnum', 'serial', '', '', '', '',
2115 'codenum', 'int', '', '', '', '',
2116 'pkgpart', 'int', '', '', '', '',
2118 'primary_key' => 'codepkgnum',
2119 'unique' => [ [ 'codenum', 'pkgpart' ] ],
2120 'index' => [ [ 'codenum' ] ],
2123 'clientapi_session' => {
2125 'sessionnum', 'serial', '', '', '', '',
2126 'sessionid', 'varchar', '', $char_d, '', '',
2127 'namespace', 'varchar', '', $char_d, '', '',
2129 'primary_key' => 'sessionnum',
2130 'unique' => [ [ 'sessionid', 'namespace' ] ],
2134 'clientapi_session_field' => {
2136 'fieldnum', 'serial', '', '', '', '',
2137 'sessionnum', 'int', '', '', '', '',
2138 'fieldname', 'varchar', '', $char_d, '', '',
2139 'fieldvalue', 'text', 'NULL', '', '', '',
2141 'primary_key' => 'fieldnum',
2142 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
2146 'payment_gateway' => {
2148 'gatewaynum', 'serial', '', '', '', '',
2149 'gateway_namespace','varchar', 'NULL', $char_d, '', '',
2150 'gateway_module', 'varchar', '', $char_d, '', '',
2151 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
2152 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
2153 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
2154 'gateway_callback_url', 'varchar', 'NULL', $char_d, '', '',
2155 'disabled', 'char', 'NULL', 1, '', '',
2157 'primary_key' => 'gatewaynum',
2159 'index' => [ [ 'disabled' ] ],
2162 'payment_gateway_option' => {
2164 'optionnum', 'serial', '', '', '', '',
2165 'gatewaynum', 'int', '', '', '', '',
2166 'optionname', 'varchar', '', $char_d, '', '',
2167 'optionvalue', 'text', 'NULL', '', '', '',
2169 'primary_key' => 'optionnum',
2171 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2174 'agent_payment_gateway' => {
2176 'agentgatewaynum', 'serial', '', '', '', '',
2177 'agentnum', 'int', '', '', '', '',
2178 'gatewaynum', 'int', '', '', '', '',
2179 'cardtype', 'varchar', 'NULL', $char_d, '', '',
2180 'taxclass', 'varchar', 'NULL', $char_d, '', '',
2182 'primary_key' => 'agentgatewaynum',
2184 'index' => [ [ 'agentnum', 'cardtype' ], ],
2189 'bannum', 'serial', '', '', '', '',
2190 'payby', 'char', '', 4, '', '',
2191 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
2192 #'paymask', 'varchar', 'NULL', $char_d, '', ''
2193 '_date', @date_type, '', '',
2194 'otaker', 'varchar', '', 32, '', '',
2195 'reason', 'varchar', 'NULL', $char_d, '', '',
2197 'primary_key' => 'bannum',
2198 'unique' => [ [ 'payby', 'payinfo' ] ],
2204 'categorynum', 'serial', '', '', '', '',
2205 'categoryname', 'varchar', '', $char_d, '', '',
2206 'weight', 'int', 'NULL', '', '', '',
2207 'condense', 'char', 'NULL', 1, '', '',
2208 'disabled', 'char', 'NULL', 1, '', '',
2210 'primary_key' => 'categorynum',
2212 'index' => [ ['disabled'] ],
2217 'classnum', 'serial', '', '', '', '',
2218 'classname', 'varchar', '', $char_d, '', '',
2219 'categorynum', 'int', 'NULL', '', '', '',
2220 'disabled', 'char', 'NULL', 1, '', '',
2222 'primary_key' => 'classnum',
2224 'index' => [ ['disabled'] ],
2229 # qw( name type null length default local );
2235 'acctid', 'bigserial', '', '', '', '',
2236 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2237 'calldate', 'timestamp', '', '', \'now()', '',
2238 'clid', 'varchar', '', $char_d, \"''", '',
2239 'src', 'varchar', '', $char_d, \"''", '',
2240 'dst', 'varchar', '', $char_d, \"''", '',
2241 'dcontext', 'varchar', '', $char_d, \"''", '',
2242 'channel', 'varchar', '', $char_d, \"''", '',
2243 'dstchannel', 'varchar', '', $char_d, \"''", '',
2244 'lastapp', 'varchar', '', $char_d, \"''", '',
2245 'lastdata', 'varchar', '', $char_d, \"''", '',
2247 #these don't seem to be logged by most of the SQL cdr_* modules
2248 #except tds under sql-illegal names, so;
2249 # ... don't rely on them for rating?
2250 # and, what they hey, i went ahead and changed the names and data types
2251 # to freeside-style dates...
2252 #'start', 'timestamp', 'NULL', '', '', '',
2253 #'answer', 'timestamp', 'NULL', '', '', '',
2254 #'end', 'timestamp', 'NULL', '', '', '',
2255 'startdate', @date_type, '', '',
2256 'answerdate', @date_type, '', '',
2257 'enddate', @date_type, '', '',
2260 'duration', 'int', '', '', 0, '',
2261 'billsec', 'int', '', '', 0, '',
2262 'disposition', 'varchar', '', 45, \"''", '',
2263 'amaflags', 'int', '', '', 0, '',
2264 'accountcode', 'varchar', '', 20, \"''", '',
2265 'uniqueid', 'varchar', '', 32, \"''", '',
2266 'userfield', 'varchar', '', 255, \"''", '',
2269 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2271 # though these are now used elsewhere:
2272 # charged_party, upstream_price, rated_price, carrierid
2275 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2276 'cdrtypenum', 'int', 'NULL', '', '', '',
2278 'charged_party', 'varchar', 'NULL', $char_d, '', '',
2280 'upstream_currency', 'char', 'NULL', 3, '', '',
2281 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
2282 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
2284 # how it was rated internally...
2285 'ratedetailnum', 'int', 'NULL', '', '', '',
2286 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2288 'distance', 'decimal', 'NULL', '', '', '',
2289 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
2291 #cdr_calltype: the big list in appendix 2
2292 'calltypenum', 'int', 'NULL', '', '', '',
2294 'description', 'varchar', 'NULL', $char_d, '', '',
2295 'quantity', 'int', 'NULL', '', '', '',
2297 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2298 'carrierid', 'int', 'NULL', '', '', '',
2300 'upstream_rateid', 'int', 'NULL', '', '', '',
2303 #and now for our own fields
2306 # a svcnum... right..?
2307 'svcnum', 'int', 'NULL', '', '', '',
2309 #NULL, done (or something)
2310 'freesidestatus', 'varchar', 'NULL', 32, '', '',
2312 #NULL, done (or something)
2313 'freesiderewritestatus', 'varchar', 'NULL', 32, '', '',
2315 #an indexed place to put big numbers
2316 'cdrid', 'bigint', 'NULL', '', '', '',
2319 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2321 'cdrbatchnum', 'int', 'NULL', '', '', '',
2324 'primary_key' => 'acctid',
2326 'index' => [ [ 'calldate' ],
2327 [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2328 [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2329 [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2330 [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2336 'cdrbatchnum', 'serial', '', '', '', '',
2337 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2338 '_date', @date_type, '', '',
2340 'primary_key' => 'cdrbatchnum',
2341 'unique' => [ [ 'cdrbatch' ] ],
2345 'cdr_termination' => {
2347 'cdrtermnum', 'bigserial', '', '', '', '',
2348 'acctid', 'bigint', '', '', '', '',
2349 'termpart', 'int', '', '', '', '',#future use see below
2350 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2351 'status', 'varchar', 'NULL', 32, '', '',
2353 'primary_key' => 'cdrtermnum',
2354 'unique' => [ [ 'acctid', 'termpart' ] ],
2355 'index' => [ [ 'acctid' ], [ 'status' ], ],
2358 #to handle multiple termination/settlement passes...
2359 # 'part_termination' => {
2361 # 'termpart', 'int', '', '', '', '',
2362 # 'termname', 'varchar', '', $char_d, '', '',
2363 # 'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2365 # 'primary_key' => 'termpart',
2370 #the remaining cdr_ tables are not really used
2373 'calltypenum', 'serial', '', '', '', '',
2374 'calltypename', 'varchar', '', $char_d, '', '',
2376 'primary_key' => 'calltypenum',
2383 'cdrtypenum' => 'serial', '', '', '', '',
2384 'cdrtypename' => 'varchar', '', $char_d, '', '',
2386 'primary_key' => 'cdrtypenum',
2393 'carrierid' => 'serial', '', '', '', '',
2394 'carriername' => 'varchar', '', $char_d, '', '',
2396 'primary_key' => 'carrierid',
2403 # 'filenum', 'serial', '', '', '', '',
2404 # 'filename', 'varchar', '', '', '', '',
2405 # 'status', 'varchar', 'NULL', '', '', '',
2407 # 'primary_key' => 'filenum',
2408 # 'unique' => [ [ 'filename' ], ], #just change the index if we need to
2409 # # agent-virtualize or have a customer
2410 # # with dup-filename needs or something
2411 # # (only used by cdr.http_and_import for
2416 'inventory_item' => {
2418 'itemnum', 'serial', '', '', '', '',
2419 'classnum', 'int', '', '', '', '',
2420 'item', 'varchar', '', $char_d, '', '',
2421 'svcnum', 'int', 'NULL', '', '', '',
2423 'primary_key' => 'itemnum',
2424 'unique' => [ [ 'classnum', 'item' ] ],
2425 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2428 'inventory_class' => {
2430 'classnum', 'serial', '', '', '', '',
2431 'classname', 'varchar', '', $char_d, '', '',
2433 'primary_key' => 'classnum',
2440 'usernum', 'serial', '', '', '', '',
2441 'username', 'varchar', '', $char_d, '', '',
2442 '_password', 'varchar', '', $char_d, '', '',
2443 'last', 'varchar', '', $char_d, '', '',
2444 'first', 'varchar', '', $char_d, '', '',
2445 'disabled', 'char', 'NULL', 1, '', '',
2447 'primary_key' => 'usernum',
2448 'unique' => [ [ 'username' ] ],
2452 'access_user_pref' => {
2454 'prefnum', 'serial', '', '', '', '',
2455 'usernum', 'int', '', '', '', '',
2456 'prefname', 'varchar', '', $char_d, '', '',
2457 'prefvalue', 'text', 'NULL', '', '', '',
2458 'expiration', @date_type, '', '',
2460 'primary_key' => 'prefnum',
2462 'index' => [ [ 'usernum' ] ],
2467 'groupnum', 'serial', '', '', '', '',
2468 'groupname', 'varchar', '', $char_d, '', '',
2470 'primary_key' => 'groupnum',
2471 'unique' => [ [ 'groupname' ] ],
2475 'access_usergroup' => {
2477 'usergroupnum', 'serial', '', '', '', '',
2478 'usernum', 'int', '', '', '', '',
2479 'groupnum', 'int', '', '', '', '',
2481 'primary_key' => 'usergroupnum',
2482 'unique' => [ [ 'usernum', 'groupnum' ] ],
2483 'index' => [ [ 'usernum' ] ],
2486 'access_groupagent' => {
2488 'groupagentnum', 'serial', '', '', '', '',
2489 'groupnum', 'int', '', '', '', '',
2490 'agentnum', 'int', '', '', '', '',
2492 'primary_key' => 'groupagentnum',
2493 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2494 'index' => [ [ 'groupnum' ] ],
2499 'rightnum', 'serial', '', '', '', '',
2500 'righttype', 'varchar', '', $char_d, '', '',
2501 'rightobjnum', 'int', '', '', '', '',
2502 'rightname', 'varchar', '', $char_d, '', '',
2504 'primary_key' => 'rightnum',
2505 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2511 'svcnum', 'int', '', '', '', '',
2512 'countrycode', 'varchar', '', 3, '', '',
2513 'phonenum', 'varchar', '', 15, '', '', #12 ?
2514 'pin', 'varchar', 'NULL', $char_d, '', '',
2515 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2516 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2518 'primary_key' => 'svcnum',
2520 'index' => [ [ 'countrycode', 'phonenum' ] ],
2525 'devicenum', 'serial', '', '', '', '',
2526 'devicepart', 'int', '', '', '', '',
2527 'svcnum', 'int', '', '', '', '',
2528 'mac_addr', 'varchar', 'NULL', 12, '', '',
2530 'primary_key' => 'devicenum',
2531 'unique' => [ [ 'mac_addr' ], ],
2532 'index' => [ [ 'devicepart' ], [ 'svcnum' ], ],
2537 'devicepart', 'serial', '', '', '', '',
2538 'devicename', 'varchar', '', $char_d, '', '',
2539 #'classnum', #tie to an inventory class?
2541 'primary_key' => 'devicepart',
2542 'unique' => [ [ 'devicename' ] ], #?
2548 'availnum', 'serial', '', '', '', '',
2549 'exportnum', 'int', '', '', '', '',
2550 'countrycode', 'varchar', '', 3, '', '',
2551 'state', 'char', 'NULL', 2, '', '',
2552 'npa', 'char', '', 3, '', '',
2553 'nxx', 'char', 'NULL', 3, '', '',
2554 'station', 'char', 'NULL', 4, '', '',
2555 'name', 'varchar', 'NULL', $char_d, '', '',
2556 'svcnum', 'int', 'NULL', '', '', '',
2557 'availbatch', 'varchar', 'NULL', $char_d, '', '',
2559 'primary_key' => 'availnum',
2561 'index' => [ [ 'exportnum', 'countrycode', 'state' ], #npa search
2562 [ 'exportnum', 'countrycode', 'npa' ], #nxx search
2563 [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2564 [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2572 'typenum', 'serial', '', '', '', '',
2573 'class', 'char', '', 1, '', '',
2574 'type', 'varchar', '', $char_d, '', '',
2576 'primary_key' => 'typenum',
2583 'reasonnum', 'serial', '', '', '', '',
2584 'reason_type', 'int', '', '', '', '',
2585 'reason', 'text', '', '', '', '',
2586 'disabled', 'char', 'NULL', 1, '', '',
2588 'primary_key' => 'reasonnum',
2595 'confnum', 'serial', '', '', '', '',
2596 'agentnum', 'int', 'NULL', '', '', '',
2597 'name', 'varchar', '', $char_d, '', '',
2598 'value', 'text', 'NULL', '', '', '',
2600 'primary_key' => 'confnum',
2601 'unique' => [ [ 'agentnum', 'name' ]],
2607 'pkgrefnum', 'serial', '', '', '', '',
2608 'pkgnum', 'int', '', '', '', '',
2609 'refnum', 'int', '', '', '', '',
2611 'primary_key' => 'pkgrefnum',
2612 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2613 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2615 # name type nullability length default local
2619 # 'num', 'serial', '', '', '', '',
2621 # 'primary_key' => 'num',