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'], ],
1312 'cust_pkg_discount' => {
1314 'pkgdiscountnum', 'serial', '', '', '', '',
1315 'pkgnum', 'int', '', '', '', '',
1316 'discountnum', 'int', '', '', '', '',
1317 'months_used', 'decimal', 'NULL', '', '', '',
1318 'end_date', @date_type, '', '',
1319 'otaker', 'varchar', '', 32, '', '',
1320 'disabled', 'char', 'NULL', 1, '', '',
1322 'primary_key' => 'pkgdiscountnum',
1324 'index' => [ [ 'pkgnum' ], [ 'discountnum' ] ],
1327 'cust_bill_pkg_discount' => {
1329 'billpkgdiscountnum', 'serial', '', '', '', '',
1330 'billpkgnum', 'int', '', '', '', '',
1331 'pkgdiscountnum', 'int', '', '', '', '',
1332 'amount', @money_type, '', '',
1333 'months', 'decimal', 'NULL', '', '', '',
1335 'primary_key' => 'billpkgdiscountnum',
1337 'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1342 'discountnum', 'serial', '', '', '', '',
1343 #'agentnum', 'int', 'NULL', '', '', '',
1344 'name', 'varchar', 'NULL', $char_d, '', '',
1345 'amount', @money_type, '', '',
1346 'percent', 'decimal', '', '', '', '',
1347 'months', 'decimal', 'NULL', '', '', '',
1348 'disabled', 'char', 'NULL', 1, '', '',
1350 'primary_key' => 'discountnum',
1352 'index' => [], # [ 'agentnum' ], ],
1357 'refundnum', 'serial', '', '', '', '',
1358 'custnum', 'int', '', '', '', '',
1359 '_date', @date_type, '', '',
1360 'refund', @money_type, '', '',
1361 'otaker', 'varchar', '', 32, '', '',
1362 'reason', 'varchar', '', $char_d, '', '',
1363 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
1364 # be index into payby
1366 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1367 'paymask', 'varchar', 'NULL', $char_d, '', '',
1368 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1369 'closed', 'char', 'NULL', 1, '', '',
1371 'primary_key' => 'refundnum',
1373 'index' => [ ['custnum'], ['_date'] ],
1376 'cust_credit_refund' => {
1378 'creditrefundnum', 'serial', '', '', '', '',
1379 'crednum', 'int', '', '', '', '',
1380 'refundnum', 'int', '', '', '', '',
1381 'amount', @money_type, '', '',
1382 '_date', @date_type, '', '',
1384 'primary_key' => 'creditrefundnum',
1386 'index' => [ ['crednum'], ['refundnum'] ],
1392 'svcnum', 'serial', '', '', '', '',
1393 'pkgnum', 'int', 'NULL', '', '', '',
1394 'svcpart', 'int', '', '', '', '',
1395 'overlimit', @date_type, '', '',
1397 'primary_key' => 'svcnum',
1399 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1402 'cust_svc_option' => {
1404 'optionnum', 'serial', '', '', '', '',
1405 'svcnum', 'int', '', '', '', '',
1406 'optionname', 'varchar', '', $char_d, '', '',
1407 'optionvalue', 'text', 'NULL', '', '', '',
1409 'primary_key' => 'optionnum',
1411 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1416 'pkgpart', 'serial', '', '', '', '',
1417 'pkg', 'varchar', '', $char_d, '', '',
1418 'comment', 'varchar', '', $char_d, '', '',
1419 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1420 'setup', @perl_type, '', '',
1421 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1422 'recur', @perl_type, '', '',
1423 'setuptax', 'char', 'NULL', 1, '', '',
1424 'recurtax', 'char', 'NULL', 1, '', '',
1425 'plan', 'varchar', 'NULL', $char_d, '', '',
1426 'plandata', 'text', 'NULL', '', '', '',
1427 'disabled', 'char', 'NULL', 1, '', '',
1428 'custom', 'char', 'NULL', 1, '', '',
1429 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1430 'classnum', 'int', 'NULL', '', '', '',
1431 'addon_classnum','int', 'NULL', '', '', '',
1432 'taxproductnum', 'int', 'NULL', '', '', '',
1433 'setup_cost', @money_typen, '', '',
1434 'recur_cost', @money_typen, '', '',
1435 'pay_weight', 'real', 'NULL', '', '', '',
1436 'credit_weight', 'real', 'NULL', '', '', '',
1437 'agentnum', 'int', 'NULL', '', '', '',
1440 'primary_key' => 'pkgpart',
1442 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1447 'part_pkg_link' => {
1449 'pkglinknum', 'serial', '', '', '', '',
1450 'src_pkgpart', 'int', '', '', '', '',
1451 'dst_pkgpart', 'int', '', '', '', '',
1452 'link_type', 'varchar', '', $char_d, '', '',
1453 'hidden', 'char', 'NULL', 1, '', '',
1455 'primary_key' => 'pkglinknum',
1456 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1457 'index' => [ [ 'src_pkgpart' ] ],
1459 # XXX somewhat borked unique: we don't really want a hidden and unhidden
1460 # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1462 'part_pkg_taxclass' => {
1464 'taxclassnum', 'serial', '', '', '', '',
1465 'taxclass', 'varchar', '', $char_d, '', '',
1466 'disabled', 'char', 'NULL', 1, '', '',
1468 'primary_key' => 'taxclassnum',
1469 'unique' => [ [ 'taxclass' ] ],
1470 'index' => [ [ 'disabled' ] ],
1473 'part_pkg_taxproduct' => {
1475 'taxproductnum', 'serial', '', '', '', '',
1476 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1477 'taxproduct', 'varchar', '', $char_d, '', '',
1478 'description', 'varchar', '', 3*$char_d, '', '',
1480 'primary_key' => 'taxproductnum',
1481 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1485 'part_pkg_taxrate' => {
1487 'pkgtaxratenum', 'serial', '', '', '', '',
1488 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1489 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1490 'taxproductnum', 'int', '', '', '', '',
1491 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1492 'county', 'varchar', 'NULL', $char_d, '', '',
1493 'state', 'varchar', 'NULL', $char_d, '', '',
1494 'local', 'varchar', 'NULL', $char_d, '', '',
1495 'country', 'char', 'NULL', 2, '', '',
1496 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1497 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1498 'taxclassnum', 'int', 'NULL', '', '', '',
1499 'effdate', @date_type, '', '',
1500 'taxable', 'char', 'NULL', 1, '', '',
1502 'primary_key' => 'pkgtaxratenum',
1504 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1507 'part_pkg_taxoverride' => {
1509 'taxoverridenum', 'serial', '', '', '', '',
1510 'pkgpart', 'serial', '', '', '', '',
1511 'taxclassnum', 'serial', '', '', '', '',
1512 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1514 'primary_key' => 'taxoverridenum',
1516 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1521 # 'titlenum', 'int', '', '',
1522 # 'title', 'varchar', '', $char_d,
1524 # 'primary_key' => 'titlenum',
1525 # 'unique' => [ [] ],
1526 # 'index' => [ [] ],
1531 'pkgsvcnum', 'serial', '', '', '', '',
1532 'pkgpart', 'int', '', '', '', '',
1533 'svcpart', 'int', '', '', '', '',
1534 'quantity', 'int', '', '', '', '',
1535 'primary_svc','char', 'NULL', 1, '', '',
1537 'primary_key' => 'pkgsvcnum',
1538 'unique' => [ ['pkgpart', 'svcpart'] ],
1539 'index' => [ ['pkgpart'], ['quantity'] ],
1542 'part_referral' => {
1544 'refnum', 'serial', '', '', '', '',
1545 'referral', 'varchar', '', $char_d, '', '',
1546 'disabled', 'char', 'NULL', 1, '', '',
1547 'agentnum', 'int', 'NULL', '', '', '',
1549 'primary_key' => 'refnum',
1551 'index' => [ ['disabled'], ['agentnum'], ],
1556 'svcpart', 'serial', '', '', '', '',
1557 'svc', 'varchar', '', $char_d, '', '',
1558 'svcdb', 'varchar', '', $char_d, '', '',
1559 'disabled', 'char', 'NULL', 1, '', '',
1561 'primary_key' => 'svcpart',
1563 'index' => [ [ 'disabled' ] ],
1566 'part_svc_column' => {
1568 'columnnum', 'serial', '', '', '', '',
1569 'svcpart', 'int', '', '', '', '',
1570 'columnname', 'varchar', '', 64, '', '',
1571 'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1572 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1573 'columnflag', 'char', 'NULL', 1, '', '',
1575 'primary_key' => 'columnnum',
1576 'unique' => [ [ 'svcpart', 'columnname' ] ],
1577 'index' => [ [ 'svcpart' ] ],
1580 #(this should be renamed to part_pop)
1583 'popnum', 'serial', '', '', '', '',
1584 'city', 'varchar', '', $char_d, '', '',
1585 'state', 'varchar', '', $char_d, '', '',
1586 'ac', 'char', '', 3, '', '',
1587 'exch', 'char', '', 3, '', '',
1588 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1590 'primary_key' => 'popnum',
1592 'index' => [ [ 'state' ] ],
1595 'part_pop_local' => {
1597 'localnum', 'serial', '', '', '', '',
1598 'popnum', 'int', '', '', '', '',
1599 'city', 'varchar', 'NULL', $char_d, '', '',
1600 'state', 'char', 'NULL', 2, '', '',
1601 'npa', 'char', '', 3, '', '',
1602 'nxx', 'char', '', 3, '', '',
1604 'primary_key' => 'localnum',
1606 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1611 'svcnum', 'int', '', '', '', '',
1612 'username', 'varchar', '', $username_len, '', '',
1613 '_password', 'varchar', 'NULL', 512, '', '',
1614 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1615 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1616 'popnum', 'int', 'NULL', '', '', '',
1617 'uid', 'int', 'NULL', '', '', '',
1618 'gid', 'int', 'NULL', '', '', '',
1619 'finger', 'varchar', 'NULL', $char_d, '', '',
1620 'dir', 'varchar', 'NULL', $char_d, '', '',
1621 'shell', 'varchar', 'NULL', $char_d, '', '',
1622 'quota', 'varchar', 'NULL', $char_d, '', '',
1623 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1624 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1625 'seconds_threshold', 'int', 'NULL', '', '', '',
1626 'upbytes', 'bigint', 'NULL', '', '', '',
1627 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1628 'downbytes', 'bigint', 'NULL', '', '', '',
1629 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1630 'totalbytes','bigint', 'NULL', '', '', '',
1631 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1632 'domsvc', 'int', '', '', '', '',
1633 'pbxsvc', 'int', 'NULL', '', '', '',
1634 'last_login', @date_type, '', '',
1635 'last_logout', @date_type, '', '',
1637 'primary_key' => 'svcnum',
1638 #'unique' => [ [ 'username', 'domsvc' ] ],
1640 'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1643 'acct_rt_transaction' => {
1645 'svcrtid', 'int', '', '', '', '',
1646 'svcnum', 'int', '', '', '', '',
1647 'transaction_id', 'int', '', '', '', '',
1648 '_date', @date_type, '', '',
1649 'seconds', 'int', '', '', '', '', #uhhhh
1650 'support', 'int', '', '', '', '',
1652 'primary_key' => 'svcrtid',
1654 'index' => [ ['svcnum', 'transaction_id'] ],
1659 # 'svcnum', 'int', '', '',
1660 # 'amount', @money_type,
1662 # 'primary_key' => 'svcnum',
1663 # 'unique' => [ [] ],
1664 # 'index' => [ [] ],
1669 'svcnum', 'int', '', '', '', '',
1670 'domain', 'varchar', '', $char_d, '', '',
1671 'suffix', 'varchar', 'NULL', $char_d, '', '',
1672 'catchall', 'int', 'NULL', '', '', '',
1673 'parent_svcnum', 'int', 'NULL', '', '', '',
1674 'registrarnum', 'int', 'NULL', '', '', '',
1675 'registrarkey', 'varchar', 'NULL', 512, '', '',
1676 'setup_date', @date_type, '', '',
1677 'renewal_interval', 'int', 'NULL', '', '', '',
1678 'expiration_date', @date_type, '', '',
1680 'primary_key' => 'svcnum',
1682 'index' => [ ['domain'] ],
1685 'domain_record' => {
1687 'recnum', 'serial', '', '', '', '',
1688 'svcnum', 'int', '', '', '', '',
1689 'reczone', 'varchar', '', 255, '', '',
1690 'recaf', 'char', '', 2, '', '',
1691 'rectype', 'varchar', '', 5, '', '',
1692 'recdata', 'varchar', '', 255, '', '',
1694 'primary_key' => 'recnum',
1696 'index' => [ ['svcnum'] ],
1701 'registrarnum', 'serial', '', '', '', '',
1702 'registrarname', 'varchar', '', $char_d, '', '',
1704 'primary_key' => 'registrarnum',
1711 'svcnum', 'int', '', '', '', '',
1712 'srcsvc', 'int', 'NULL', '', '', '',
1713 'src', 'varchar', 'NULL', 255, '', '',
1714 'dstsvc', 'int', 'NULL', '', '', '',
1715 'dst', 'varchar', 'NULL', 255, '', '',
1717 'primary_key' => 'svcnum',
1719 'index' => [ ['srcsvc'], ['dstsvc'] ],
1724 'svcnum', 'int', '', '', '', '',
1725 'recnum', 'int', '', '', '', '',
1726 'usersvc', 'int', 'NULL', '', '', '',
1727 'config', 'text', 'NULL', '', '', '',
1729 'primary_key' => 'svcnum',
1736 # 'svcnum', 'int', '', '',
1737 # 'svcnum', 'int', '', '',
1738 # 'svcnum', 'int', '', '',
1739 # 'worker', 'varchar', '', $char_d,
1740 # '_date', @date_type,
1742 # 'primary_key' => 'svcnum',
1743 # 'unique' => [ [] ],
1744 # 'index' => [ [] ],
1747 'prepay_credit' => {
1749 'prepaynum', 'serial', '', '', '', '',
1750 'identifier', 'varchar', '', $char_d, '', '',
1751 'amount', @money_type, '', '',
1752 'seconds', 'int', 'NULL', '', '', '',
1753 'upbytes', 'bigint', 'NULL', '', '', '',
1754 'downbytes', 'bigint', 'NULL', '', '', '',
1755 'totalbytes', 'bigint', 'NULL', '', '', '',
1756 'agentnum', 'int', 'NULL', '', '', '',
1758 'primary_key' => 'prepaynum',
1759 'unique' => [ ['identifier'] ],
1765 'portnum', 'serial', '', '', '', '',
1766 'ip', 'varchar', 'NULL', 15, '', '',
1767 'nasport', 'int', 'NULL', '', '', '',
1768 'nasnum', 'int', '', '', '', '',
1770 'primary_key' => 'portnum',
1777 'nasnum', 'serial', '', '', '', '',
1778 'nas', 'varchar', '', $char_d, '', '',
1779 'nasip', 'varchar', '', 15, '', '',
1780 'nasfqdn', 'varchar', '', $char_d, '', '',
1781 'last', 'int', '', '', '', '',
1783 'primary_key' => 'nasnum',
1784 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1785 'index' => [ [ 'last' ] ],
1790 # 'sessionnum', 'serial', '', '', '', '',
1791 # 'portnum', 'int', '', '', '', '',
1792 # 'svcnum', 'int', '', '', '', '',
1793 # 'login', @date_type, '', '',
1794 # 'logout', @date_type, '', '',
1796 # 'primary_key' => 'sessionnum',
1798 # 'index' => [ [ 'portnum' ] ],
1803 'jobnum', 'serial', '', '', '', '',
1804 'job', 'varchar', '', 512, '', '',
1805 '_date', 'int', '', '', '', '',
1806 'status', 'varchar', '', $char_d, '', '',
1807 'statustext', 'text', 'NULL', '', '', '',
1808 'svcnum', 'int', 'NULL', '', '', '',
1809 'custnum', 'int', 'NULL', '', '', '',
1810 'secure', 'char', 'NULL', 1, '', '',
1811 'priority', 'int', 'NULL', '', '', '',
1813 'primary_key' => 'jobnum',
1815 'index' => [ [ 'secure' ], [ 'priority' ],
1816 [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1822 'argnum', 'serial', '', '', '', '',
1823 'jobnum', 'int', '', '', '', '',
1824 'frozen', 'char', 'NULL', 1, '', '',
1825 'arg', 'text', 'NULL', '', '', '',
1827 'primary_key' => 'argnum',
1829 'index' => [ [ 'jobnum' ] ],
1834 'dependnum', 'serial', '', '', '', '',
1835 'jobnum', 'int', '', '', '', '',
1836 'depend_jobnum', 'int', '', '', '', '',
1838 'primary_key' => 'dependnum',
1840 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1845 'exportsvcnum' => 'serial', '', '', '', '',
1846 'exportnum' => 'int', '', '', '', '',
1847 'svcpart' => 'int', '', '', '', '',
1849 'primary_key' => 'exportsvcnum',
1850 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1851 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1854 'export_device' => {
1856 'exportdevicenum' => 'serial', '', '', '', '',
1857 'exportnum' => 'int', '', '', '', '',
1858 'devicepart' => 'int', '', '', '', '',
1860 'primary_key' => 'exportdevicenum',
1861 'unique' => [ [ 'exportnum', 'devicepart' ] ],
1862 'index' => [ [ 'exportnum' ], [ 'devicepart' ] ],
1867 'exportnum', 'serial', '', '', '', '',
1868 'machine', 'varchar', '', $char_d, '', '',
1869 'exporttype', 'varchar', '', $char_d, '', '',
1870 'nodomain', 'char', 'NULL', 1, '', '',
1872 'primary_key' => 'exportnum',
1874 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1877 'part_export_option' => {
1879 'optionnum', 'serial', '', '', '', '',
1880 'exportnum', 'int', '', '', '', '',
1881 'optionname', 'varchar', '', $char_d, '', '',
1882 'optionvalue', 'text', 'NULL', '', '', '',
1884 'primary_key' => 'optionnum',
1886 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1889 'radius_usergroup' => {
1891 'usergroupnum', 'serial', '', '', '', '',
1892 'svcnum', 'int', '', '', '', '',
1893 'groupname', 'varchar', '', $char_d, '', '',
1895 'primary_key' => 'usergroupnum',
1897 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1902 'msgnum', 'serial', '', '', '', '',
1903 'msgcode', 'varchar', '', $char_d, '', '',
1904 'locale', 'varchar', '', 16, '', '',
1905 'msg', 'text', '', '', '', '',
1907 'primary_key' => 'msgnum',
1908 'unique' => [ [ 'msgcode', 'locale' ] ],
1912 'cust_tax_exempt' => {
1914 'exemptnum', 'serial', '', '', '', '',
1915 'custnum', 'int', '', '', '', '',
1916 'taxnum', 'int', '', '', '', '',
1917 'year', 'int', '', '', '', '',
1918 'month', 'int', '', '', '', '',
1919 'amount', @money_type, '', '',
1921 'primary_key' => 'exemptnum',
1922 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1926 'cust_tax_exempt_pkg' => {
1928 'exemptpkgnum', 'serial', '', '', '', '',
1929 #'custnum', 'int', '', '', '', ''
1930 'billpkgnum', 'int', '', '', '', '',
1931 'taxnum', 'int', '', '', '', '',
1932 'year', 'int', '', '', '', '',
1933 'month', 'int', '', '', '', '',
1934 'creditbillpkgnum', 'int', 'NULL', '', '', '',
1935 'amount', @money_type, '', '',
1937 'primary_key' => 'exemptpkgnum',
1939 'index' => [ [ 'taxnum', 'year', 'month' ],
1942 [ 'creditbillpkgnum' ],
1948 'routernum', 'serial', '', '', '', '',
1949 'routername', 'varchar', '', $char_d, '', '',
1950 'svcnum', 'int', 'NULL', '', '', '',
1951 'agentnum', 'int', 'NULL', '', '', '',
1953 'primary_key' => 'routernum',
1958 'part_svc_router' => {
1960 'svcrouternum', 'serial', '', '', '', '',
1961 'svcpart', 'int', '', '', '', '',
1962 'routernum', 'int', '', '', '', '',
1964 'primary_key' => 'svcrouternum',
1971 'blocknum', 'serial', '', '', '', '',
1972 'routernum', 'int', '', '', '', '',
1973 'ip_gateway', 'varchar', '', 15, '', '',
1974 'ip_netmask', 'int', '', '', '', '',
1975 'agentnum', 'int', 'NULL', '', '', '',
1976 'manual_flag', 'char', 'NULL', 1, '', '',
1978 'primary_key' => 'blocknum',
1979 'unique' => [ [ 'blocknum', 'routernum' ] ],
1983 'svc_broadband' => {
1985 'svcnum', 'int', '', '', '', '',
1986 'description', 'varchar', 'NULL', $char_d, '', '',
1987 'blocknum', 'int', 'NULL', '', '', '',
1988 'speed_up', 'int', '', '', '', '',
1989 'speed_down', 'int', '', '', '', '',
1990 'ip_addr', 'varchar', 'NULL', 15, '', '',
1991 'mac_addr', 'varchar', 'NULL', 12, '', '',
1992 'authkey', 'varchar', 'NULL', 32, '', '',
1993 'latitude', 'decimal', 'NULL', '', '', '',
1994 'longitude', 'decimal', 'NULL', '', '', '',
1995 'altitude', 'decimal', 'NULL', '', '', '',
1996 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1997 'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1999 'primary_key' => 'svcnum',
2000 'unique' => [ [ 'mac_addr' ] ],
2004 'part_virtual_field' => {
2006 'vfieldpart', 'serial', '', '', '', '',
2007 'dbtable', 'varchar', '', 32, '', '',
2008 'name', 'varchar', '', 32, '', '',
2009 'check_block', 'text', 'NULL', '', '', '',
2010 'length', 'int', 'NULL', '', '', '',
2011 'list_source', 'text', 'NULL', '', '', '',
2012 'label', 'varchar', 'NULL', 80, '', '',
2014 'primary_key' => 'vfieldpart',
2019 'virtual_field' => {
2021 'vfieldnum', 'serial', '', '', '', '',
2022 'recnum', 'int', '', '', '', '',
2023 'vfieldpart', 'int', '', '', '', '',
2024 'value', 'varchar', '', 128, '', '',
2026 'primary_key' => 'vfieldnum',
2027 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2033 'snarfnum', 'int', '', '', '', '',
2034 'svcnum', 'int', '', '', '', '',
2035 'machine', 'varchar', '', 255, '', '',
2036 'protocol', 'varchar', '', $char_d, '', '',
2037 'username', 'varchar', '', $char_d, '', '',
2038 '_password', 'varchar', '', $char_d, '', '',
2040 'primary_key' => 'snarfnum',
2042 'index' => [ [ 'svcnum' ] ],
2047 'svcnum', 'int', '', '', '', '',
2048 'id', 'int', 'NULL', '', '', '',
2049 'title', 'varchar', 'NULL', $char_d, '', '',
2051 'primary_key' => 'svcnum',
2056 'cust_pay_refund' => {
2058 'payrefundnum', 'serial', '', '', '', '',
2059 'paynum', 'int', '', '', '', '',
2060 'refundnum', 'int', '', '', '', '',
2061 '_date', @date_type, '', '',
2062 'amount', @money_type, '', '',
2064 'primary_key' => 'payrefundnum',
2066 'index' => [ ['paynum'], ['refundnum'] ],
2069 'part_pkg_option' => {
2071 'optionnum', 'serial', '', '', '', '',
2072 'pkgpart', 'int', '', '', '', '',
2073 'optionname', 'varchar', '', $char_d, '', '',
2074 'optionvalue', 'text', 'NULL', '', '', '',
2076 'primary_key' => 'optionnum',
2078 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
2081 'part_pkg_report_option' => {
2083 'num', 'serial', '', '', '', '',
2084 'name', 'varchar', '', $char_d, '', '',
2085 'disabled', 'char', 'NULL', 1, '', '',
2087 'primary_key' => 'num',
2088 'unique' => [ [ 'name' ] ],
2089 'index' => [ [ 'disabled' ] ],
2094 'ratenum', 'serial', '', '', '', '',
2095 'ratename', 'varchar', '', $char_d, '', '',
2097 'primary_key' => 'ratenum',
2104 'ratedetailnum', 'serial', '', '', '', '',
2105 'ratenum', 'int', '', '', '', '',
2106 'orig_regionnum', 'int', 'NULL', '', '', '',
2107 'dest_regionnum', 'int', '', '', '', '',
2108 'min_included', 'int', '', '', '', '',
2109 #'min_charge', @money_type, '', '',
2110 'min_charge', 'decimal', '', '10,5', '', '',
2111 'sec_granularity', 'int', '', '', '', '',
2112 #time period (link to table of periods)?
2113 'classnum', 'int', 'NULL', '', '', '',
2115 'primary_key' => 'ratedetailnum',
2116 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2117 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
2122 'regionnum', 'serial', '', '', '', '',
2123 'regionname', 'varchar', '', $char_d, '', '',
2125 'primary_key' => 'regionnum',
2132 'prefixnum', 'serial', '', '', '', '',
2133 'regionnum', 'int', '', '', '', '',
2134 'countrycode', 'varchar', '', 3, '', '',
2135 'npa', 'varchar', 'NULL', 10, '', '', #actually the whole prefix
2136 'nxx', 'varchar', 'NULL', 3, '', '', #actually not used
2138 'primary_key' => 'prefixnum',
2140 'index' => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2145 'classnum', 'serial', '', '', '', '',
2146 'weight', 'int', 'NULL', '', '', '',
2147 'classname', 'varchar', '', $char_d, '', '',
2148 'format', 'varchar', 'NULL', $char_d, '', '',
2149 'disabled', 'char', 'NULL', 1, '', '',
2151 'primary_key' => 'classnum',
2153 'index' => [ ['disabled'] ],
2158 'codenum', 'serial', '', '', '', '',
2159 'code', 'varchar', '', $char_d, '', '',
2160 'agentnum', 'int', '', '', '', '',
2162 'primary_key' => 'codenum',
2163 'unique' => [ [ 'agentnum', 'code' ] ],
2164 'index' => [ [ 'agentnum' ] ],
2169 'codepkgnum', 'serial', '', '', '', '',
2170 'codenum', 'int', '', '', '', '',
2171 'pkgpart', 'int', '', '', '', '',
2173 'primary_key' => 'codepkgnum',
2174 'unique' => [ [ 'codenum', 'pkgpart' ] ],
2175 'index' => [ [ 'codenum' ] ],
2178 'clientapi_session' => {
2180 'sessionnum', 'serial', '', '', '', '',
2181 'sessionid', 'varchar', '', $char_d, '', '',
2182 'namespace', 'varchar', '', $char_d, '', '',
2184 'primary_key' => 'sessionnum',
2185 'unique' => [ [ 'sessionid', 'namespace' ] ],
2189 'clientapi_session_field' => {
2191 'fieldnum', 'serial', '', '', '', '',
2192 'sessionnum', 'int', '', '', '', '',
2193 'fieldname', 'varchar', '', $char_d, '', '',
2194 'fieldvalue', 'text', 'NULL', '', '', '',
2196 'primary_key' => 'fieldnum',
2197 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
2201 'payment_gateway' => {
2203 'gatewaynum', 'serial', '', '', '', '',
2204 'gateway_namespace','varchar', 'NULL', $char_d, '', '',
2205 'gateway_module', 'varchar', '', $char_d, '', '',
2206 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
2207 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
2208 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
2209 'gateway_callback_url', 'varchar', 'NULL', $char_d, '', '',
2210 'disabled', 'char', 'NULL', 1, '', '',
2212 'primary_key' => 'gatewaynum',
2214 'index' => [ [ 'disabled' ] ],
2217 'payment_gateway_option' => {
2219 'optionnum', 'serial', '', '', '', '',
2220 'gatewaynum', 'int', '', '', '', '',
2221 'optionname', 'varchar', '', $char_d, '', '',
2222 'optionvalue', 'text', 'NULL', '', '', '',
2224 'primary_key' => 'optionnum',
2226 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2229 'agent_payment_gateway' => {
2231 'agentgatewaynum', 'serial', '', '', '', '',
2232 'agentnum', 'int', '', '', '', '',
2233 'gatewaynum', 'int', '', '', '', '',
2234 'cardtype', 'varchar', 'NULL', $char_d, '', '',
2235 'taxclass', 'varchar', 'NULL', $char_d, '', '',
2237 'primary_key' => 'agentgatewaynum',
2239 'index' => [ [ 'agentnum', 'cardtype' ], ],
2244 'bannum', 'serial', '', '', '', '',
2245 'payby', 'char', '', 4, '', '',
2246 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
2247 #'paymask', 'varchar', 'NULL', $char_d, '', ''
2248 '_date', @date_type, '', '',
2249 'otaker', 'varchar', '', 32, '', '',
2250 'reason', 'varchar', 'NULL', $char_d, '', '',
2252 'primary_key' => 'bannum',
2253 'unique' => [ [ 'payby', 'payinfo' ] ],
2259 'categorynum', 'serial', '', '', '', '',
2260 'categoryname', 'varchar', '', $char_d, '', '',
2261 'weight', 'int', 'NULL', '', '', '',
2262 'condense', 'char', 'NULL', 1, '', '',
2263 'disabled', 'char', 'NULL', 1, '', '',
2265 'primary_key' => 'categorynum',
2267 'index' => [ ['disabled'] ],
2272 'classnum', 'serial', '', '', '', '',
2273 'classname', 'varchar', '', $char_d, '', '',
2274 'categorynum', 'int', 'NULL', '', '', '',
2275 'disabled', 'char', 'NULL', 1, '', '',
2277 'primary_key' => 'classnum',
2279 'index' => [ ['disabled'] ],
2284 # qw( name type null length default local );
2290 'acctid', 'bigserial', '', '', '', '',
2291 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2292 'calldate', 'timestamp', '', '', \'now()', '',
2293 'clid', 'varchar', '', $char_d, \"''", '',
2294 'src', 'varchar', '', $char_d, \"''", '',
2295 'dst', 'varchar', '', $char_d, \"''", '',
2296 'dcontext', 'varchar', '', $char_d, \"''", '',
2297 'channel', 'varchar', '', $char_d, \"''", '',
2298 'dstchannel', 'varchar', '', $char_d, \"''", '',
2299 'lastapp', 'varchar', '', $char_d, \"''", '',
2300 'lastdata', 'varchar', '', $char_d, \"''", '',
2302 #these don't seem to be logged by most of the SQL cdr_* modules
2303 #except tds under sql-illegal names, so;
2304 # ... don't rely on them for rating?
2305 # and, what they hey, i went ahead and changed the names and data types
2306 # to freeside-style dates...
2307 #'start', 'timestamp', 'NULL', '', '', '',
2308 #'answer', 'timestamp', 'NULL', '', '', '',
2309 #'end', 'timestamp', 'NULL', '', '', '',
2310 'startdate', @date_type, '', '',
2311 'answerdate', @date_type, '', '',
2312 'enddate', @date_type, '', '',
2315 'duration', 'int', '', '', 0, '',
2316 'billsec', 'int', '', '', 0, '',
2317 'disposition', 'varchar', '', 45, \"''", '',
2318 'amaflags', 'int', '', '', 0, '',
2319 'accountcode', 'varchar', '', 20, \"''", '',
2320 'uniqueid', 'varchar', '', 32, \"''", '',
2321 'userfield', 'varchar', '', 255, \"''", '',
2324 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2326 # though these are now used elsewhere:
2327 # charged_party, upstream_price, rated_price, carrierid
2330 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2331 'cdrtypenum', 'int', 'NULL', '', '', '',
2333 'charged_party', 'varchar', 'NULL', $char_d, '', '',
2335 'upstream_currency', 'char', 'NULL', 3, '', '',
2336 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
2337 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
2339 # how it was rated internally...
2340 'ratedetailnum', 'int', 'NULL', '', '', '',
2341 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2343 'distance', 'decimal', 'NULL', '', '', '',
2344 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
2346 #cdr_calltype: the big list in appendix 2
2347 'calltypenum', 'int', 'NULL', '', '', '',
2349 'description', 'varchar', 'NULL', $char_d, '', '',
2350 'quantity', 'int', 'NULL', '', '', '',
2352 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2353 'carrierid', 'int', 'NULL', '', '', '',
2355 'upstream_rateid', 'int', 'NULL', '', '', '',
2358 #and now for our own fields
2361 # a svcnum... right..?
2362 'svcnum', 'int', 'NULL', '', '', '',
2364 #NULL, done (or something)
2365 'freesidestatus', 'varchar', 'NULL', 32, '', '',
2367 #NULL, done (or something)
2368 'freesiderewritestatus', 'varchar', 'NULL', 32, '', '',
2370 #an indexed place to put big numbers
2371 'cdrid', 'bigint', 'NULL', '', '', '',
2374 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2376 'cdrbatchnum', 'int', 'NULL', '', '', '',
2379 'primary_key' => 'acctid',
2381 'index' => [ [ 'calldate' ],
2382 [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2383 [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2384 [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2385 [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2391 'cdrbatchnum', 'serial', '', '', '', '',
2392 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2393 '_date', @date_type, '', '',
2395 'primary_key' => 'cdrbatchnum',
2396 'unique' => [ [ 'cdrbatch' ] ],
2400 'cdr_termination' => {
2402 'cdrtermnum', 'bigserial', '', '', '', '',
2403 'acctid', 'bigint', '', '', '', '',
2404 'termpart', 'int', '', '', '', '',#future use see below
2405 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2406 'status', 'varchar', 'NULL', 32, '', '',
2408 'primary_key' => 'cdrtermnum',
2409 'unique' => [ [ 'acctid', 'termpart' ] ],
2410 'index' => [ [ 'acctid' ], [ 'status' ], ],
2413 #to handle multiple termination/settlement passes...
2414 # 'part_termination' => {
2416 # 'termpart', 'int', '', '', '', '',
2417 # 'termname', 'varchar', '', $char_d, '', '',
2418 # 'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2420 # 'primary_key' => 'termpart',
2425 #the remaining cdr_ tables are not really used
2428 'calltypenum', 'serial', '', '', '', '',
2429 'calltypename', 'varchar', '', $char_d, '', '',
2431 'primary_key' => 'calltypenum',
2438 'cdrtypenum' => 'serial', '', '', '', '',
2439 'cdrtypename' => 'varchar', '', $char_d, '', '',
2441 'primary_key' => 'cdrtypenum',
2448 'carrierid' => 'serial', '', '', '', '',
2449 'carriername' => 'varchar', '', $char_d, '', '',
2451 'primary_key' => 'carrierid',
2458 # 'filenum', 'serial', '', '', '', '',
2459 # 'filename', 'varchar', '', '', '', '',
2460 # 'status', 'varchar', 'NULL', '', '', '',
2462 # 'primary_key' => 'filenum',
2463 # 'unique' => [ [ 'filename' ], ], #just change the index if we need to
2464 # # agent-virtualize or have a customer
2465 # # with dup-filename needs or something
2466 # # (only used by cdr.http_and_import for
2471 'inventory_item' => {
2473 'itemnum', 'serial', '', '', '', '',
2474 'classnum', 'int', '', '', '', '',
2475 'item', 'varchar', '', $char_d, '', '',
2476 'svcnum', 'int', 'NULL', '', '', '',
2478 'primary_key' => 'itemnum',
2479 'unique' => [ [ 'classnum', 'item' ] ],
2480 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2483 'inventory_class' => {
2485 'classnum', 'serial', '', '', '', '',
2486 'classname', 'varchar', '', $char_d, '', '',
2488 'primary_key' => 'classnum',
2495 'usernum', 'serial', '', '', '', '',
2496 'username', 'varchar', '', $char_d, '', '',
2497 '_password', 'varchar', '', $char_d, '', '',
2498 'last', 'varchar', '', $char_d, '', '',
2499 'first', 'varchar', '', $char_d, '', '',
2500 'disabled', 'char', 'NULL', 1, '', '',
2502 'primary_key' => 'usernum',
2503 'unique' => [ [ 'username' ] ],
2507 'access_user_pref' => {
2509 'prefnum', 'serial', '', '', '', '',
2510 'usernum', 'int', '', '', '', '',
2511 'prefname', 'varchar', '', $char_d, '', '',
2512 'prefvalue', 'text', 'NULL', '', '', '',
2513 'expiration', @date_type, '', '',
2515 'primary_key' => 'prefnum',
2517 'index' => [ [ 'usernum' ] ],
2522 'groupnum', 'serial', '', '', '', '',
2523 'groupname', 'varchar', '', $char_d, '', '',
2525 'primary_key' => 'groupnum',
2526 'unique' => [ [ 'groupname' ] ],
2530 'access_usergroup' => {
2532 'usergroupnum', 'serial', '', '', '', '',
2533 'usernum', 'int', '', '', '', '',
2534 'groupnum', 'int', '', '', '', '',
2536 'primary_key' => 'usergroupnum',
2537 'unique' => [ [ 'usernum', 'groupnum' ] ],
2538 'index' => [ [ 'usernum' ] ],
2541 'access_groupagent' => {
2543 'groupagentnum', 'serial', '', '', '', '',
2544 'groupnum', 'int', '', '', '', '',
2545 'agentnum', 'int', '', '', '', '',
2547 'primary_key' => 'groupagentnum',
2548 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2549 'index' => [ [ 'groupnum' ] ],
2554 'rightnum', 'serial', '', '', '', '',
2555 'righttype', 'varchar', '', $char_d, '', '',
2556 'rightobjnum', 'int', '', '', '', '',
2557 'rightname', 'varchar', '', $char_d, '', '',
2559 'primary_key' => 'rightnum',
2560 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2566 'svcnum', 'int', '', '', '', '',
2567 'countrycode', 'varchar', '', 3, '', '',
2568 'phonenum', 'varchar', '', 15, '', '', #12 ?
2569 'pin', 'varchar', 'NULL', $char_d, '', '',
2570 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2571 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2572 'pbxsvc', 'int', 'NULL', '', '', '',
2574 'primary_key' => 'svcnum',
2576 'index' => [ [ 'countrycode', 'phonenum' ], ['pbxsvc'] ],
2581 'devicenum', 'serial', '', '', '', '',
2582 'devicepart', 'int', '', '', '', '',
2583 'svcnum', 'int', '', '', '', '',
2584 'mac_addr', 'varchar', 'NULL', 12, '', '',
2586 'primary_key' => 'devicenum',
2587 'unique' => [ [ 'mac_addr' ], ],
2588 'index' => [ [ 'devicepart' ], [ 'svcnum' ], ],
2593 'devicepart', 'serial', '', '', '', '',
2594 'devicename', 'varchar', '', $char_d, '', '',
2595 #'classnum', #tie to an inventory class?
2597 'primary_key' => 'devicepart',
2598 'unique' => [ [ 'devicename' ] ], #?
2604 'availnum', 'serial', '', '', '', '',
2605 'exportnum', 'int', '', '', '', '',
2606 'countrycode', 'varchar', '', 3, '', '',
2607 'state', 'char', 'NULL', 2, '', '',
2608 'npa', 'char', '', 3, '', '',
2609 'nxx', 'char', 'NULL', 3, '', '',
2610 'station', 'char', 'NULL', 4, '', '',
2611 'name', 'varchar', 'NULL', $char_d, '', '',
2612 'svcnum', 'int', 'NULL', '', '', '',
2613 'availbatch', 'varchar', 'NULL', $char_d, '', '',
2615 'primary_key' => 'availnum',
2617 'index' => [ [ 'exportnum', 'countrycode', 'state' ], #npa search
2618 [ 'exportnum', 'countrycode', 'npa' ], #nxx search
2619 [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2620 [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2628 'typenum', 'serial', '', '', '', '',
2629 'class', 'char', '', 1, '', '',
2630 'type', 'varchar', '', $char_d, '', '',
2632 'primary_key' => 'typenum',
2639 'reasonnum', 'serial', '', '', '', '',
2640 'reason_type', 'int', '', '', '', '',
2641 'reason', 'text', '', '', '', '',
2642 'disabled', 'char', 'NULL', 1, '', '',
2644 'primary_key' => 'reasonnum',
2651 'confnum', 'serial', '', '', '', '',
2652 'agentnum', 'int', 'NULL', '', '', '',
2653 'name', 'varchar', '', $char_d, '', '',
2654 'value', 'text', 'NULL', '', '', '',
2656 'primary_key' => 'confnum',
2657 'unique' => [ [ 'agentnum', 'name' ]],
2663 'pkgrefnum', 'serial', '', '', '', '',
2664 'pkgnum', 'int', '', '', '', '',
2665 'refnum', 'int', '', '', '', '',
2667 'primary_key' => 'pkgrefnum',
2668 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2669 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2674 'svcnum', 'int', '', '', '', '',
2675 'id', 'int', 'NULL', '', '', '',
2676 'title', 'varchar', 'NULL', $char_d, '', '',
2677 'max_extensions', 'int', 'NULL', '', '', '',
2679 'primary_key' => 'svcnum',
2681 'index' => [ [ 'id' ] ],
2685 # name type nullability length default local
2689 # 'num', 'serial', '', '', '', '',
2691 # 'primary_key' => 'num',