3 use vars qw(@ISA @EXPORT_OK $DEBUG $setup_hack %dbdef_cache);
4 use subs qw(reload_dbdef);
6 use DBIx::DBSchema 0.33;
7 use DBIx::DBSchema::Table;
8 use DBIx::DBSchema::Column 0.06;
9 use DBIx::DBSchema::Index;
12 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
19 FS::Schema - Freeside database schema
23 use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
25 $dbdef = reload_dbdef;
26 $dbdef = reload_dbdef "/non/standard/filename";
28 $dbdef_dist = dbdef_dist;
32 This class represents the database schema.
38 =item reload_dbdef([FILENAME])
40 Load a database definition (see L<DBIx::DBSchema>), optionally from a
41 non-default filename. This command is executed at startup unless
42 I<$FS::Schema::setup_hack> is true. Returns a DBIx::DBSchema object.
49 unless ( exists $dbdef_cache{$file} ) {
50 warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
51 $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
52 or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
54 warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
56 $dbdef = $dbdef_cache{$file};
61 Returns the current database definition (represents the current database,
62 assuming it is up-to-date). See L<DBIx::DBSchema>.
68 =item dbdef_dist [ DATASRC ]
70 Returns the current canoical database definition as defined in this file.
72 Optionally, pass a DBI data source to enable syntax specific to that database.
73 Currently, this enables "TYPE=InnoDB" for MySQL databases.
78 my $datasrc = @_ ? shift : '';
80 my $local_options = '';
81 if ( $datasrc =~ /^dbi:mysql/i ) {
82 $local_options = 'TYPE=InnoDB';
86 # create a dbdef object from the old data structure
89 my $tables_hashref = tables_hashref();
92 my $dbdef = new DBIx::DBSchema map {
98 while (@{$tables_hashref->{$tablename}{'columns'}}) {
99 #my($name, $type, $null, $length, $default, $local) =
101 splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
102 my %hash = map { $_ => shift @coldef }
103 qw( name type null length default local );
105 unless ( defined $hash{'default'} ) {
106 warn "$tablename:\n".
107 join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
110 push @columns, new DBIx::DBSchema::Column ( \%hash );
113 #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
114 #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
115 my $unique = $tables_hashref->{$tablename}{'unique'};
116 my $index = $tables_hashref->{$tablename}{'index'};
119 DBIx::DBSchema::Index->new({
120 'name' => $tablename. $indexnum++,
127 DBIx::DBSchema::Index->new({
128 'name' => $tablename. $indexnum++,
135 DBIx::DBSchema::Table->new({
136 'name' => $tablename,
137 'primary_key' => $tables_hashref->{$tablename}{'primary_key'},
138 'columns' => \@columns,
139 'indices' => \@indices,
140 'local_options' => $local_options,
143 } keys %$tables_hashref;
146 warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
147 warn "[debug]$me $_\n" foreach $dbdef->tables;
150 #add radius attributes to svc_acct
152 #my($svc_acct)=$dbdef->table('svc_acct');
155 #foreach $attribute (@attributes) {
156 # $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
157 # 'radius_'. $attribute,
164 #foreach $attribute (@check_attributes) {
165 # $svc_acct->addcolumn( new DBIx::DBSchema::Column (
173 #create history tables (false laziness w/create-history-tables)
175 grep { ! /^clientapi_session/ }
179 my $tableobj = $dbdef->table($table)
180 or die "unknown table $table";
182 my %indices = $tableobj->indices;
184 my %h_indices = map {
186 DBIx::DBSchema::Index->new({
187 'name' => 'h_'. $indices{$_}->name,
189 'columns' => [ @{$indices{$_}->columns} ],
195 $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
196 'name' => "h_${table}_srckey",
198 'columns' => [ 'history_action', #right?
199 $tableobj->primary_key,
203 $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
204 'name' => "h_${table}_srckey2",
206 'columns' => [ 'history_date',
207 $tableobj->primary_key,
211 my $h_tableobj = DBIx::DBSchema::Table->new( {
212 'name' => "h_$table",
213 'primary_key' => 'historynum',
214 'indices' => \%h_indices,
215 'local_options' => $local_options,
217 DBIx::DBSchema::Column->new( {
218 'name' => 'historynum',
220 'null' => 'NOT NULL',
225 DBIx::DBSchema::Column->new( {
226 'name' => 'history_date',
233 DBIx::DBSchema::Column->new( {
234 'name' => 'history_user',
236 'null' => 'NOT NULL',
241 DBIx::DBSchema::Column->new( {
242 'name' => 'history_action',
244 'null' => 'NOT NULL',
250 my $column = $tableobj->column($_);
252 #clone so as to not disturb the original
253 $column = DBIx::DBSchema::Column->new( {
254 map { $_ => $column->$_() }
255 qw( name type null length default local )
258 if ( $column->type =~ /^(\w*)SERIAL$/i ) {
259 $column->type('int');
260 $column->null('NULL');
262 #$column->default('')
263 # if $column->default =~ /^nextval\(/i;
264 #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
265 #$column->local($local);
270 $dbdef->addtable($h_tableobj);
273 if ( $datasrc =~ /^dbi:mysql/i ) {
275 my $dup_lock_table = DBIx::DBSchema::Table->new( {
276 'name' => 'duplicate_lock',
277 'primary_key' => 'duplocknum',
278 'local_options' => $local_options,
280 DBIx::DBSchema::Column->new( {
281 'name' => 'duplocknum',
283 'null' => 'NOT NULL',
288 DBIx::DBSchema::Column->new( {
289 'name' => 'lockname',
291 'null' => 'NOT NULL',
297 'indices' => { 'duplicate_lock1' =>
298 DBIx::DBSchema::Index->new({
299 'name' => 'duplicate_lock1',
301 'columns' => [ 'lockname' ],
306 $dbdef->addtable($dup_lock_table);
316 my $char_d = 80; #default maxlength for text fields
318 #my(@date_type) = ( 'timestamp', '', '' );
319 my @date_type = ( 'int', 'NULL', '' );
320 my @perl_type = ( 'text', 'NULL', '' );
321 my @money_type = ( 'decimal', '', '10,2' );
322 my @money_typen = ( 'decimal', 'NULL', '10,2' );
323 my @taxrate_type = ( 'decimal', '', '14,8' ); # requires pg 8 for
324 my @taxrate_typen = ( 'decimal', 'NULL', '14,8' ); # fs-upgrade to work
326 my $username_len = 32; #usernamemax config file
328 # name type nullability length default local
334 'agentnum', 'serial', '', '', '', '',
335 'agent', 'varchar', '', $char_d, '', '',
336 'typenum', 'int', '', '', '', '',
337 'ticketing_queueid', 'int', 'NULL', '', '', '',
338 'invoice_template', 'varchar', 'NULL', $char_d, '', '',
339 'agent_custnum', 'int', 'NULL', '', '', '',
340 'disabled', 'char', 'NULL', 1, '', '',
341 'username', 'varchar', 'NULL', $char_d, '', '', #deprecated
342 '_password', 'varchar', 'NULL', $char_d, '', '', #deprecated
343 'freq', 'int', 'NULL', '', '', '', #deprecated (never used)
344 'prog', @perl_type, '', '', #deprecated (never used)
346 'primary_key' => 'agentnum',
347 #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
348 #insert is giving it a value, tho..
349 #'index' => [ ['typenum'], ['disabled'] ],
351 'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
356 'typenum', 'serial', '', '', '', '',
357 'atype', 'varchar', '', $char_d, '', '',
359 'primary_key' => 'typenum',
366 'typepkgnum', 'serial', '', '', '', '',
367 'typenum', 'int', '', '', '', '',
368 'pkgpart', 'int', '', '', '', '',
370 'primary_key' => 'typepkgnum',
371 'unique' => [ ['typenum', 'pkgpart'] ],
372 'index' => [ ['typenum'] ],
377 'invnum', 'serial', '', '', '', '',
378 'custnum', 'int', '', '', '', '',
379 '_date', @date_type, '', '',
380 'charged', @money_type, '', '',
381 'printed', 'int', '', '', '', '',
382 'closed', 'char', 'NULL', 1, '', '',
384 'primary_key' => 'invnum',
386 'index' => [ ['custnum'], ['_date'] ],
389 'cust_bill_event' => {
391 'eventnum', 'serial', '', '', '', '',
392 'invnum', 'int', '', '', '', '',
393 'eventpart', 'int', '', '', '', '',
394 '_date', @date_type, '', '',
395 'status', 'varchar', '', $char_d, '', '',
396 'statustext', 'text', 'NULL', '', '', '',
398 'primary_key' => 'eventnum',
399 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
401 'index' => [ ['invnum'], ['status'], ['eventpart'],
402 ['statustext'], ['_date'],
406 'part_bill_event' => {
408 'eventpart', 'serial', '', '', '', '',
409 'freq', 'varchar', 'NULL', $char_d, '', '',
410 'payby', 'char', '', 4, '', '',
411 'event', 'varchar', '', $char_d, '', '',
412 'eventcode', @perl_type, '', '',
413 'seconds', 'int', 'NULL', '', '', '',
414 'weight', 'int', '', '', '', '',
415 'plan', 'varchar', 'NULL', $char_d, '', '',
416 'plandata', 'text', 'NULL', '', '', '',
417 'reason', 'int', 'NULL', '', '', '',
418 'disabled', 'char', 'NULL', 1, '', '',
420 'primary_key' => 'eventpart',
422 'index' => [ ['payby'], ['disabled'], ],
427 'eventpart', 'serial', '', '', '', '',
428 'agentnum', 'int', 'NULL', '', '', '',
429 'event', 'varchar', '', $char_d, '', '',
430 'eventtable', 'varchar', '', $char_d, '', '',
431 'check_freq', 'varchar', 'NULL', $char_d, '', '',
432 'weight', 'int', '', '', '', '',
433 'action', 'varchar', '', $char_d, '', '',
434 'disabled', 'char', 'NULL', 1, '', '',
436 'primary_key' => 'eventpart',
438 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
441 'part_event_option' => {
443 'optionnum', 'serial', '', '', '', '',
444 'eventpart', 'int', '', '', '', '',
445 'optionname', 'varchar', '', $char_d, '', '',
446 'optionvalue', 'text', 'NULL', '', '', '',
448 'primary_key' => 'optionnum',
450 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
453 'part_event_condition' => {
455 'eventconditionnum', 'serial', '', '', '', '',
456 'eventpart', 'int', '', '', '', '',
457 'conditionname', 'varchar', '', $char_d, '', '',
459 'primary_key' => 'eventconditionnum',
461 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
464 'part_event_condition_option' => {
466 'optionnum', 'serial', '', '', '', '',
467 'eventconditionnum', 'int', '', '', '', '',
468 'optionname', 'varchar', '', $char_d, '', '',
469 'optionvalue', 'text', 'NULL', '', '', '',
471 'primary_key' => 'optionnum',
473 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
476 'part_event_condition_option_option' => {
478 'optionoptionnum', 'serial', '', '', '', '',
479 'optionnum', 'int', '', '', '', '',
480 'optionname', 'varchar', '', $char_d, '', '',
481 'optionvalue', 'text', 'NULL', '', '', '',
483 'primary_key' => 'optionoptionnum',
485 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
490 'eventnum', 'serial', '', '', '', '',
491 'eventpart', 'int', '', '', '', '',
492 'tablenum', 'int', '', '', '', '',
493 '_date', @date_type, '', '',
494 'status', 'varchar', '', $char_d, '', '',
495 'statustext', 'text', 'NULL', '', '', '',
497 'primary_key' => 'eventnum',
498 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
500 'index' => [ ['eventpart'], ['tablenum'], ['status'],
501 ['statustext'], ['_date'],
507 'billpkgnum', 'serial', '', '', '', '',
508 'invnum', 'int', '', '', '', '',
509 'pkgnum', 'int', '', '', '', '',
510 'pkgpart_override', 'int', 'NULL', '', '', '',
511 'setup', @money_type, '', '',
512 'recur', @money_type, '', '',
513 'sdate', @date_type, '', '',
514 'edate', @date_type, '', '',
515 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
516 'itemcomment', 'varchar', 'NULL', $char_d, '', '',
517 'section', 'varchar', 'NULL', $char_d, '', '',
518 'quantity', 'int', 'NULL', '', '', '',
519 'unitsetup', @money_typen, '', '',
520 'unitrecur', @money_typen, '', '',
521 'hidden', 'char', 'NULL', 1, '', '',
523 'primary_key' => 'billpkgnum',
525 'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
528 'cust_bill_pkg_detail' => {
530 'detailnum', 'serial', '', '', '', '',
531 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
532 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
533 'invnum', 'int', 'NULL', '', '', '', # deprecated
534 'amount', @money_typen, '', '',
535 'format', 'char', 'NULL', 1, '', '',
536 'classnum', 'int', 'NULL', '', '', '',
537 'detail', 'varchar', '', 255, '', '',
539 'primary_key' => 'detailnum',
541 'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
544 'cust_bill_pkg_display' => {
546 'billpkgdisplaynum', 'serial', '', '', '', '',
547 'billpkgnum', 'int', '', '', '', '',
548 'section', 'varchar', 'NULL', $char_d, '', '',
549 #'unitsetup', @money_typen, '', '', #override the linked real one?
550 #'unitrecur', @money_typen, '', '', #this too?
551 'post_total', 'char', 'NULL', 1, '', '',
552 'type', 'char', 'NULL', 1, '', '',
553 'summary', 'char', 'NULL', 1, '', '',
555 'primary_key' => 'billpkgdisplaynum',
557 'index' => [ ['billpkgnum'], ],
560 'cust_bill_pkg_tax_location' => {
562 'billpkgtaxlocationnum', 'serial', '', '', '', '',
563 'billpkgnum', 'int', '', '', '', '',
564 'taxnum', 'int', '', '', '', '',
565 'taxtype', 'varchar', '', $char_d, '', '',
566 'pkgnum', 'int', '', '', '', '',
567 'locationnum', 'int', '', '', '', '', #redundant?
568 'amount', @money_type, '', '',
570 'primary_key' => 'billpkgtaxlocationnum',
572 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
575 'cust_bill_pkg_tax_rate_location' => {
577 'billpkgtaxratelocationnum', 'serial', '', '', '', '',
578 'billpkgnum', 'int', '', '', '', '',
579 'taxnum', 'int', '', '', '', '',
580 'taxtype', 'varchar', '', $char_d, '', '',
581 'locationtaxid', 'varchar', 'NULL', $char_d, '', '',
582 'taxratelocationnum', 'int', '', '', '', '',
583 'amount', @money_type, '', '',
585 'primary_key' => 'billpkgtaxratelocationnum',
587 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
592 'crednum', 'serial', '', '', '', '',
593 'custnum', 'int', '', '', '', '',
594 '_date', @date_type, '', '',
595 'amount', @money_type, '', '',
596 'otaker', 'varchar', '', 32, '', '',
597 'reason', 'text', 'NULL', '', '', '',
598 'reasonnum', 'int', 'NULL', '', '', '',
599 'addlinfo', 'text', 'NULL', '', '', '',
600 'closed', 'char', 'NULL', 1, '', '',
601 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
603 'primary_key' => 'crednum',
605 'index' => [ ['custnum'], ['_date'] ],
608 'cust_credit_bill' => {
610 'creditbillnum', 'serial', '', '', '', '',
611 'crednum', 'int', '', '', '', '',
612 'invnum', 'int', '', '', '', '',
613 '_date', @date_type, '', '',
614 'amount', @money_type, '', '',
615 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
617 'primary_key' => 'creditbillnum',
619 'index' => [ ['crednum'], ['invnum'] ],
622 'cust_credit_bill_pkg' => {
624 'creditbillpkgnum', 'serial', '', '', '', '',
625 'creditbillnum', 'int', '', '', '', '',
626 'billpkgnum', 'int', '', '', '', '',
627 'amount', @money_type, '', '',
628 'setuprecur', 'varchar', '', $char_d, '', '',
629 'sdate', @date_type, '', '',
630 'edate', @date_type, '', '',
632 'primary_key' => 'creditbillpkgnum',
634 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
639 'custnum', 'serial', '', '', '', '',
640 'agentnum', 'int', '', '', '', '',
641 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
642 'custbatch', 'varchar', 'NULL', $char_d, '', '',
643 # 'titlenum', 'int', 'NULL', '', '', '',
644 'last', 'varchar', '', $char_d, '', '',
645 # 'middle', 'varchar', 'NULL', $char_d, '', '',
646 'first', 'varchar', '', $char_d, '', '',
647 'ss', 'varchar', 'NULL', 11, '', '',
648 'stateid', 'varchar', 'NULL', $char_d, '', '',
649 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
650 'birthdate' ,@date_type, '', '',
651 'signupdate',@date_type, '', '',
652 'dundate', @date_type, '', '',
653 'company', 'varchar', 'NULL', $char_d, '', '',
654 'address1', 'varchar', '', $char_d, '', '',
655 'address2', 'varchar', 'NULL', $char_d, '', '',
656 'city', 'varchar', '', $char_d, '', '',
657 'county', 'varchar', 'NULL', $char_d, '', '',
658 'state', 'varchar', 'NULL', $char_d, '', '',
659 'zip', 'varchar', 'NULL', 10, '', '',
660 'country', 'char', '', 2, '', '',
661 'daytime', 'varchar', 'NULL', 20, '', '',
662 'night', 'varchar', 'NULL', 20, '', '',
663 'fax', 'varchar', 'NULL', 12, '', '',
664 'ship_last', 'varchar', 'NULL', $char_d, '', '',
665 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
666 'ship_first', 'varchar', 'NULL', $char_d, '', '',
667 'ship_company', 'varchar', 'NULL', $char_d, '', '',
668 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
669 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
670 'ship_city', 'varchar', 'NULL', $char_d, '', '',
671 'ship_county', 'varchar', 'NULL', $char_d, '', '',
672 'ship_state', 'varchar', 'NULL', $char_d, '', '',
673 'ship_zip', 'varchar', 'NULL', 10, '', '',
674 'ship_country', 'char', 'NULL', 2, '', '',
675 'ship_daytime', 'varchar', 'NULL', 20, '', '',
676 'ship_night', 'varchar', 'NULL', 20, '', '',
677 'ship_fax', 'varchar', 'NULL', 12, '', '',
678 'payby', 'char', '', 4, '', '',
679 'payinfo', 'varchar', 'NULL', 512, '', '',
680 'paycvv', 'varchar', 'NULL', 512, '', '',
681 'paymask', 'varchar', 'NULL', $char_d, '', '',
682 #'paydate', @date_type, '', '',
683 'paydate', 'varchar', 'NULL', 10, '', '',
684 'paystart_month', 'int', 'NULL', '', '', '',
685 'paystart_year', 'int', 'NULL', '', '', '',
686 'payissue', 'varchar', 'NULL', 2, '', '',
687 'payname', 'varchar', 'NULL', $char_d, '', '',
688 'paystate', 'varchar', 'NULL', $char_d, '', '',
689 'paytype', 'varchar', 'NULL', $char_d, '', '',
690 'payip', 'varchar', 'NULL', 15, '', '',
691 'geocode', 'varchar', 'NULL', 20, '', '',
692 'censustract', 'varchar', 'NULL', 20, '', '', # 7 to save space?
693 'tax', 'char', 'NULL', 1, '', '',
694 'otaker', 'varchar', '', 32, '', '',
695 'refnum', 'int', '', '', '', '',
696 'referral_custnum', 'int', 'NULL', '', '', '',
697 'comments', 'text', 'NULL', '', '', '',
698 'spool_cdr','char', 'NULL', 1, '', '',
699 'squelch_cdr','char', 'NULL', 1, '', '',
700 'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
701 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
702 'archived', 'char', 'NULL', 1, '', '',
703 'email_csv_cdr', 'char', 'NULL', 1, '', '',
705 'primary_key' => 'custnum',
706 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
707 #'index' => [ ['last'], ['company'] ],
709 [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
710 [ 'referral_custnum' ],
711 [ 'payby' ], [ 'paydate' ],
714 [ 'last' ], [ 'company' ],
715 [ 'county' ], [ 'state' ], [ 'country' ],
717 [ 'daytime' ], [ 'night' ], [ 'fax' ],
719 [ 'ship_last' ], [ 'ship_company' ],
720 [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
722 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
726 'cust_recon' => { # what purpose does this serve?
728 'reconid', 'serial', '', '', '', '',
729 'recondate', @date_type, '', '',
730 'custnum', 'int' , '', '', '', '',
731 'agentnum', 'int', '', '', '', '',
732 'last', 'varchar', '', $char_d, '', '',
733 'first', 'varchar', '', $char_d, '', '',
734 'address1', 'varchar', '', $char_d, '', '',
735 'address2', 'varchar', 'NULL', $char_d, '', '',
736 'city', 'varchar', '', $char_d, '', '',
737 'state', 'varchar', 'NULL', $char_d, '', '',
738 'zip', 'varchar', 'NULL', 10, '', '',
739 'pkg', 'varchar', 'NULL', $char_d, '', '',
740 'adjourn', @date_type, '', '',
741 'status', 'varchar', 'NULL', 10, '', '',
742 'agent_custid', 'varchar', '', $char_d, '', '',
743 'agent_pkg', 'varchar', 'NULL', $char_d, '', '',
744 'agent_adjourn', @date_type, '', '',
745 'comments', 'text', 'NULL', '', '', '',
747 'primary_key' => 'reconid',
752 #eventually use for billing & ship from cust_main too
753 #for now, just cust_pkg locations
756 'locationnum', 'serial', '', '', '', '',
757 'custnum', 'int', '', '', '', '',
758 'address1', 'varchar', '', $char_d, '', '',
759 'address2', 'varchar', 'NULL', $char_d, '', '',
760 'city', 'varchar', '', $char_d, '', '',
761 'county', 'varchar', 'NULL', $char_d, '', '',
762 'state', 'varchar', 'NULL', $char_d, '', '',
763 'zip', 'varchar', 'NULL', 10, '', '',
764 'country', 'char', '', 2, '', '',
765 'geocode', 'varchar', 'NULL', 20, '', '',
767 'primary_key' => 'locationnum',
769 'index' => [ [ 'custnum' ],
770 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
774 'cust_main_invoice' => {
776 'destnum', 'serial', '', '', '', '',
777 'custnum', 'int', '', '', '', '',
778 'dest', 'varchar', '', $char_d, '', '',
780 'primary_key' => 'destnum',
782 'index' => [ ['custnum'], ],
785 'cust_main_note' => {
787 'notenum', 'serial', '', '', '', '',
788 'custnum', 'int', '', '', '', '',
789 '_date', @date_type, '', '',
790 'otaker', 'varchar', '', 32, '', '',
791 'comments', 'text', 'NULL', '', '', '',
793 'primary_key' => 'notenum',
795 'index' => [ [ 'custnum' ], [ '_date' ], ],
798 'cust_main_exemption' => {
800 'exemptionnum', 'serial', '', '', '', '',
801 'custnum', 'int', '', '', '', '',
802 'taxname', 'varchar', '', $char_d, '', '',
803 #start/end dates? for reporting?
805 'primary_key' => 'exemptionnum',
807 'index' => [ [ 'custnum' ] ],
810 'cust_tax_adjustment' => {
812 'adjustmentnum', 'serial', '', '', '', '',
813 'custnum', 'int', '', '', '', '',
814 'taxname', 'varchar', '', $char_d, '', '',
815 'amount', @money_type, '', '',
816 'comment', 'varchar', 'NULL', $char_d, '', '',
817 'billpkgnum', 'int', 'NULL', '', '', '',
818 #more? no cust_bill_pkg_tax_location?
820 'primary_key' => 'adjustmentnum',
822 'index' => [ [ 'custnum' ], [ 'billpkgnum' ] ],
825 'cust_main_county' => { #county+state+country are checked off the
826 #cust_main_county for validation and to provide
829 'taxnum', 'serial', '', '', '', '',
830 'state', 'varchar', 'NULL', $char_d, '', '',
831 'county', 'varchar', 'NULL', $char_d, '', '',
832 'country', 'char', '', 2, '', '',
833 'taxclass', 'varchar', 'NULL', $char_d, '', '',
834 'exempt_amount', @money_type, '', '',
835 'tax', 'real', '', '', '', '', #tax %
836 'taxname', 'varchar', 'NULL', $char_d, '', '',
837 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
838 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
840 'primary_key' => 'taxnum',
842 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
843 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
850 'taxnum', 'serial', '', '', '', '',
851 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
852 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
853 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
854 'taxclassnum', 'int', '', '', '', '',
855 'effective_date', @date_type, '', '',
856 'tax', @taxrate_type, '', '', # tax %
857 'excessrate', @taxrate_typen, '', '', # second tax %
858 'taxbase', @money_typen, '', '', # amount at first tax rate
859 'taxmax', @money_typen, '', '', # maximum about at both rates
860 'usetax', @taxrate_typen, '', '', # tax % when non-local
861 'useexcessrate', @taxrate_typen, '', '', # second tax % when non-local
862 'unittype', 'int', 'NULL', '', '', '', # for fee
863 'fee', @taxrate_typen, '', '', # amount tax per unit
864 'excessfee', @taxrate_typen, '', '', # second amount tax per unit
865 'feebase', @taxrate_typen, '', '', # units taxed at first rate
866 'feemax', @taxrate_typen, '', '', # maximum number of unit taxed
867 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
868 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
869 'taxauth', 'int', 'NULL', '', '', '', # tax authority
870 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
871 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
872 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
873 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
874 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
875 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
876 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
878 'primary_key' => 'taxnum',
880 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
883 'tax_rate_location' => {
885 'taxratelocationnum', 'serial', '', '', '', '',
886 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
887 'geocode', 'varchar', '', 20, '', '',
888 'city', 'varchar', 'NULL', $char_d, '', '',
889 'county', 'varchar', 'NULL', $char_d, '', '',
890 'state', 'char', 'NULL', 2, '', '',
891 'disabled', 'char', 'NULL', 1, '', '',
893 'primary_key' => 'taxratelocationnum',
895 'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
898 'cust_tax_location' => {
900 'custlocationnum', 'serial', '', '', '', '',
901 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
902 'city', 'varchar', 'NULL', $char_d, '', '',
903 'postalcity', 'varchar', 'NULL', $char_d, '', '',
904 'county', 'varchar', 'NULL', $char_d, '', '',
905 'zip', 'char', '', 5, '', '',
906 'state', 'char', '', 2, '', '',
907 'plus4hi', 'char', 'NULL', 4, '', '',
908 'plus4lo', 'char', 'NULL', 4, '', '',
909 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
910 'cityflag', 'char', 'NULL', 1, '', '', # I(n)/O(out)/B(oth)/NULL
911 'geocode', 'varchar', '', 20, '', '',
913 'primary_key' => 'custlocationnum',
915 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
920 'taxclassnum', 'serial', '', '', '', '',
921 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
922 'taxclass', 'varchar', '', $char_d, '', '',
923 'description', 'varchar', '', 2*$char_d, '', '',
925 'primary_key' => 'taxclassnum',
926 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
930 'cust_pay_pending' => {
932 'paypendingnum','serial', '', '', '', '',
933 'custnum', 'int', '', '', '', '',
934 'paid', @money_type, '', '',
935 '_date', @date_type, '', '',
936 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
937 # be index into payby
939 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
940 'paymask', 'varchar', 'NULL', $char_d, '', '',
941 'paydate', 'varchar', 'NULL', 10, '', '',
942 'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
943 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
944 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
946 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
947 'status', 'varchar', '', $char_d, '', '',
948 'session_id', 'varchar', 'NULL', $char_d, '', '', #only need 32
949 'statustext', 'text', 'NULL', '', '', '',
950 'gatewaynum', 'int', 'NULL', '', '', '',
951 #'cust_balance', @money_type, '', '',
952 'paynum', 'int', 'NULL', '', '', '',
953 'jobnum', 'int', 'NULL', '', '', '',
955 'primary_key' => 'paypendingnum',
956 'unique' => [ [ 'payunique' ] ],
957 'index' => [ [ 'custnum' ], [ 'status' ], ],
962 'paynum', 'serial', '', '', '', '',
963 'custnum', 'int', '', '', '', '',
964 '_date', @date_type, '', '',
965 'paid', @money_type, '', '',
966 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
967 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
968 # index into payby table
970 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
971 'paymask', 'varchar', 'NULL', $char_d, '', '',
972 'paydate', 'varchar', 'NULL', 10, '', '',
973 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
974 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
975 'closed', 'char', 'NULL', 1, '', '',
976 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
978 'primary_key' => 'paynum',
979 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
980 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
985 'paynum', 'int', '', '', '', '',
986 'custnum', 'int', '', '', '', '',
987 'paid', @money_type, '', '',
988 '_date', @date_type, '', '',
989 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
990 # index into payby table
992 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
993 'paymask', 'varchar', 'NULL', $char_d, '', '',
994 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
995 'closed', 'char', 'NULL', 1, '', '',
996 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
997 'void_date', @date_type, '', '',
998 'reason', 'varchar', 'NULL', $char_d, '', '',
999 'otaker', 'varchar', '', 32, '', '',
1001 'primary_key' => 'paynum',
1003 'index' => [ [ 'custnum' ] ],
1006 'cust_bill_pay' => {
1008 'billpaynum', 'serial', '', '', '', '',
1009 'invnum', 'int', '', '', '', '',
1010 'paynum', 'int', '', '', '', '',
1011 'amount', @money_type, '', '',
1012 '_date', @date_type, '', '',
1013 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1015 'primary_key' => 'billpaynum',
1017 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1020 'cust_bill_pay_batch' => {
1022 'billpaynum', 'serial', '', '', '', '',
1023 'invnum', 'int', '', '', '', '',
1024 'paybatchnum', 'int', '', '', '', '',
1025 'amount', @money_type, '', '',
1026 '_date', @date_type, '', '',
1028 'primary_key' => 'billpaynum',
1030 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1033 'cust_bill_pay_pkg' => {
1035 'billpaypkgnum', 'serial', '', '', '', '',
1036 'billpaynum', 'int', '', '', '', '',
1037 'billpkgnum', 'int', '', '', '', '',
1038 'amount', @money_type, '', '',
1039 'setuprecur', 'varchar', '', $char_d, '', '',
1040 'sdate', @date_type, '', '',
1041 'edate', @date_type, '', '',
1043 'primary_key' => 'billpaypkgnum',
1045 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1048 'pay_batch' => { #batches of payments to an external processor
1050 'batchnum', 'serial', '', '', '', '',
1051 'payby', 'char', '', 4, '', '', # CARD/CHEK
1052 'status', 'char', 'NULL', 1, '', '',
1053 'download', @date_type, '', '',
1054 'upload', @date_type, '', '',
1056 'primary_key' => 'batchnum',
1061 'cust_pay_batch' => { #what's this used for again? list of customers
1062 #in current CARD batch? (necessarily CARD?)
1064 'paybatchnum', 'serial', '', '', '', '',
1065 'batchnum', 'int', '', '', '', '',
1066 'invnum', 'int', '', '', '', '',
1067 'custnum', 'int', '', '', '', '',
1068 'last', 'varchar', '', $char_d, '', '',
1069 'first', 'varchar', '', $char_d, '', '',
1070 'address1', 'varchar', '', $char_d, '', '',
1071 'address2', 'varchar', 'NULL', $char_d, '', '',
1072 'city', 'varchar', '', $char_d, '', '',
1073 'state', 'varchar', 'NULL', $char_d, '', '',
1074 'zip', 'varchar', 'NULL', 10, '', '',
1075 'country', 'char', '', 2, '', '',
1076 # 'trancode', 'int', '', '', '', ''
1077 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1078 'payinfo', 'varchar', '', 512, '', '',
1079 #'exp', @date_type, '', ''
1080 'exp', 'varchar', 'NULL', 11, '', '',
1081 'payname', 'varchar', 'NULL', $char_d, '', '',
1082 'amount', @money_type, '', '',
1083 'status', 'varchar', 'NULL', $char_d, '', '',
1085 'primary_key' => 'paybatchnum',
1087 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1092 'pkgnum', 'serial', '', '', '', '',
1093 'custnum', 'int', '', '', '', '',
1094 'pkgpart', 'int', '', '', '', '',
1095 'locationnum', 'int', 'NULL', '', '', '',
1096 'otaker', 'varchar', '', 32, '', '',
1097 'start_date', @date_type, '', '',
1098 'setup', @date_type, '', '',
1099 'bill', @date_type, '', '',
1100 'last_bill', @date_type, '', '',
1101 'susp', @date_type, '', '',
1102 'adjourn', @date_type, '', '',
1103 'cancel', @date_type, '', '',
1104 'expire', @date_type, '', '',
1105 'change_date', @date_type, '', '',
1106 'change_pkgnum', 'int', 'NULL', '', '', '',
1107 'change_pkgpart', 'int', 'NULL', '', '', '',
1108 'change_locationnum', 'int', 'NULL', '', '', '',
1109 'manual_flag', 'char', 'NULL', 1, '', '',
1110 'quantity', 'int', 'NULL', '', '', '',
1112 'primary_key' => 'pkgnum',
1114 'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1115 [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1116 ['susp'], ['adjourn'], ['expire'], ['cancel'],
1121 'cust_pkg_option' => {
1123 'optionnum', 'serial', '', '', '', '',
1124 'pkgnum', 'int', '', '', '', '',
1125 'optionname', 'varchar', '', $char_d, '', '',
1126 'optionvalue', 'text', 'NULL', '', '', '',
1128 'primary_key' => 'optionnum',
1130 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
1133 'cust_pkg_detail' => {
1135 'pkgdetailnum', 'serial', '', '', '', '',
1136 'pkgnum', 'int', '', '', '', '',
1137 'detail', 'varchar', '', $char_d, '', '',
1138 'detailtype', 'char', '', 1, '', '', # "I"nvoice or "C"omment
1139 'weight', 'int', '', '', '', '',
1141 'primary_key' => 'pkgdetailnum',
1143 'index' => [ [ 'pkgnum', 'detailtype' ] ],
1146 'cust_pkg_reason' => {
1148 'num', 'serial', '', '', '', '',
1149 'pkgnum', 'int', '', '', '', '',
1150 'reasonnum','int', '', '', '', '',
1151 'action', 'char', 'NULL', 1, '', '', #should not be nullable
1152 'otaker', 'varchar', '', 32, '', '',
1153 'date', @date_type, '', '',
1155 'primary_key' => 'num',
1157 'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1162 'refundnum', 'serial', '', '', '', '',
1163 'custnum', 'int', '', '', '', '',
1164 '_date', @date_type, '', '',
1165 'refund', @money_type, '', '',
1166 'otaker', 'varchar', '', 32, '', '',
1167 'reason', 'varchar', '', $char_d, '', '',
1168 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
1169 # be index into payby
1171 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1172 'paymask', 'varchar', 'NULL', $char_d, '', '',
1173 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1174 'closed', 'char', 'NULL', 1, '', '',
1176 'primary_key' => 'refundnum',
1178 'index' => [ ['custnum'], ['_date'] ],
1181 'cust_credit_refund' => {
1183 'creditrefundnum', 'serial', '', '', '', '',
1184 'crednum', 'int', '', '', '', '',
1185 'refundnum', 'int', '', '', '', '',
1186 'amount', @money_type, '', '',
1187 '_date', @date_type, '', '',
1189 'primary_key' => 'creditrefundnum',
1191 'index' => [ ['crednum'], ['refundnum'] ],
1197 'svcnum', 'serial', '', '', '', '',
1198 'pkgnum', 'int', 'NULL', '', '', '',
1199 'svcpart', 'int', '', '', '', '',
1200 'overlimit', @date_type, '', '',
1202 'primary_key' => 'svcnum',
1204 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1207 'cust_svc_option' => {
1209 'optionnum', 'serial', '', '', '', '',
1210 'svcnum', 'int', '', '', '', '',
1211 'optionname', 'varchar', '', $char_d, '', '',
1212 'optionvalue', 'text', 'NULL', '', '', '',
1214 'primary_key' => 'optionnum',
1216 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1221 'pkgpart', 'serial', '', '', '', '',
1222 'pkg', 'varchar', '', $char_d, '', '',
1223 'comment', 'varchar', '', $char_d, '', '',
1224 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1225 'setup', @perl_type, '', '',
1226 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1227 'recur', @perl_type, '', '',
1228 'setuptax', 'char', 'NULL', 1, '', '',
1229 'recurtax', 'char', 'NULL', 1, '', '',
1230 'plan', 'varchar', 'NULL', $char_d, '', '',
1231 'plandata', 'text', 'NULL', '', '', '',
1232 'disabled', 'char', 'NULL', 1, '', '',
1233 'custom', 'char', 'NULL', 1, '', '',
1234 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1235 'classnum', 'int', 'NULL', '', '', '',
1236 'taxproductnum', 'int', 'NULL', '', '', '',
1237 'setup_cost', @money_typen, '', '',
1238 'recur_cost', @money_typen, '', '',
1239 'pay_weight', 'real', 'NULL', '', '', '',
1240 'credit_weight', 'real', 'NULL', '', '', '',
1241 'agentnum', 'int', 'NULL', '', '', '',
1244 'primary_key' => 'pkgpart',
1246 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1249 'part_pkg_link' => {
1251 'pkglinknum', 'serial', '', '', '', '',
1252 'src_pkgpart', 'int', '', '', '', '',
1253 'dst_pkgpart', 'int', '', '', '', '',
1254 'link_type', 'varchar', '', $char_d, '', '',
1255 'hidden', 'char', 'NULL', 1, '', '',
1257 'primary_key' => 'pkglinknum',
1258 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1259 'index' => [ [ 'src_pkgpart' ] ],
1261 # XXX somewhat borked unique: we don't really want a hidden and unhidden
1262 # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1264 'part_pkg_taxclass' => {
1266 'taxclassnum', 'serial', '', '', '', '',
1267 'taxclass', 'varchar', '', $char_d, '', '',
1268 'disabled', 'char', 'NULL', 1, '', '',
1270 'primary_key' => 'taxclassnum',
1271 'unique' => [ [ 'taxclass' ] ],
1272 'index' => [ [ 'disabled' ] ],
1275 'part_pkg_taxproduct' => {
1277 'taxproductnum', 'serial', '', '', '', '',
1278 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1279 'taxproduct', 'varchar', '', $char_d, '', '',
1280 'description', 'varchar', '', 3*$char_d, '', '',
1282 'primary_key' => 'taxproductnum',
1283 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1287 'part_pkg_taxrate' => {
1289 'pkgtaxratenum', 'serial', '', '', '', '',
1290 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1291 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1292 'taxproductnum', 'int', '', '', '', '',
1293 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1294 'county', 'varchar', 'NULL', $char_d, '', '',
1295 'state', 'varchar', 'NULL', $char_d, '', '',
1296 'local', 'varchar', 'NULL', $char_d, '', '',
1297 'country', 'char', 'NULL', 2, '', '',
1298 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1299 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1300 'taxclassnum', 'int', 'NULL', '', '', '',
1301 'effdate', @date_type, '', '',
1302 'taxable', 'char', 'NULL', 1, '', '',
1304 'primary_key' => 'pkgtaxratenum',
1306 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1309 'part_pkg_taxoverride' => {
1311 'taxoverridenum', 'serial', '', '', '', '',
1312 'pkgpart', 'serial', '', '', '', '',
1313 'taxclassnum', 'serial', '', '', '', '',
1314 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1316 'primary_key' => 'taxoverridenum',
1318 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1323 # 'titlenum', 'int', '', '',
1324 # 'title', 'varchar', '', $char_d,
1326 # 'primary_key' => 'titlenum',
1327 # 'unique' => [ [] ],
1328 # 'index' => [ [] ],
1333 'pkgsvcnum', 'serial', '', '', '', '',
1334 'pkgpart', 'int', '', '', '', '',
1335 'svcpart', 'int', '', '', '', '',
1336 'quantity', 'int', '', '', '', '',
1337 'primary_svc','char', 'NULL', 1, '', '',
1339 'primary_key' => 'pkgsvcnum',
1340 'unique' => [ ['pkgpart', 'svcpart'] ],
1341 'index' => [ ['pkgpart'], ['quantity'] ],
1344 'part_referral' => {
1346 'refnum', 'serial', '', '', '', '',
1347 'referral', 'varchar', '', $char_d, '', '',
1348 'disabled', 'char', 'NULL', 1, '', '',
1349 'agentnum', 'int', 'NULL', '', '', '',
1351 'primary_key' => 'refnum',
1353 'index' => [ ['disabled'], ['agentnum'], ],
1358 'svcpart', 'serial', '', '', '', '',
1359 'svc', 'varchar', '', $char_d, '', '',
1360 'svcdb', 'varchar', '', $char_d, '', '',
1361 'disabled', 'char', 'NULL', 1, '', '',
1363 'primary_key' => 'svcpart',
1365 'index' => [ [ 'disabled' ] ],
1368 'part_svc_column' => {
1370 'columnnum', 'serial', '', '', '', '',
1371 'svcpart', 'int', '', '', '', '',
1372 'columnname', 'varchar', '', 64, '', '',
1373 'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1374 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1375 'columnflag', 'char', 'NULL', 1, '', '',
1377 'primary_key' => 'columnnum',
1378 'unique' => [ [ 'svcpart', 'columnname' ] ],
1379 'index' => [ [ 'svcpart' ] ],
1382 #(this should be renamed to part_pop)
1385 'popnum', 'serial', '', '', '', '',
1386 'city', 'varchar', '', $char_d, '', '',
1387 'state', 'varchar', '', $char_d, '', '',
1388 'ac', 'char', '', 3, '', '',
1389 'exch', 'char', '', 3, '', '',
1390 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1392 'primary_key' => 'popnum',
1394 'index' => [ [ 'state' ] ],
1397 'part_pop_local' => {
1399 'localnum', 'serial', '', '', '', '',
1400 'popnum', 'int', '', '', '', '',
1401 'city', 'varchar', 'NULL', $char_d, '', '',
1402 'state', 'char', 'NULL', 2, '', '',
1403 'npa', 'char', '', 3, '', '',
1404 'nxx', 'char', '', 3, '', '',
1406 'primary_key' => 'localnum',
1408 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1413 'svcnum', 'int', '', '', '', '',
1414 'username', 'varchar', '', $username_len, '', '',
1415 '_password', 'varchar', '', 512, '', '',
1416 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1417 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1418 'popnum', 'int', 'NULL', '', '', '',
1419 'uid', 'int', 'NULL', '', '', '',
1420 'gid', 'int', 'NULL', '', '', '',
1421 'finger', 'varchar', 'NULL', $char_d, '', '',
1422 'dir', 'varchar', 'NULL', $char_d, '', '',
1423 'shell', 'varchar', 'NULL', $char_d, '', '',
1424 'quota', 'varchar', 'NULL', $char_d, '', '',
1425 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1426 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1427 'seconds_threshold', 'int', 'NULL', '', '', '',
1428 'upbytes', 'bigint', 'NULL', '', '', '',
1429 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1430 'downbytes', 'bigint', 'NULL', '', '', '',
1431 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1432 'totalbytes','bigint', 'NULL', '', '', '',
1433 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1434 'domsvc', 'int', '', '', '', '',
1435 'last_login', @date_type, '', '',
1436 'last_logout', @date_type, '', '',
1438 'primary_key' => 'svcnum',
1439 #'unique' => [ [ 'username', 'domsvc' ] ],
1441 'index' => [ ['username'], ['domsvc'] ],
1444 'acct_rt_transaction' => {
1446 'svcrtid', 'int', '', '', '', '',
1447 'svcnum', 'int', '', '', '', '',
1448 'transaction_id', 'int', '', '', '', '',
1449 '_date', @date_type, '', '',
1450 'seconds', 'int', '', '', '', '', #uhhhh
1451 'support', 'int', '', '', '', '',
1453 'primary_key' => 'svcrtid',
1455 'index' => [ ['svcnum', 'transaction_id'] ],
1460 # 'svcnum', 'int', '', '',
1461 # 'amount', @money_type,
1463 # 'primary_key' => 'svcnum',
1464 # 'unique' => [ [] ],
1465 # 'index' => [ [] ],
1470 'svcnum', 'int', '', '', '', '',
1471 'domain', 'varchar', '', $char_d, '', '',
1472 'suffix', 'varchar', 'NULL', $char_d, '', '',
1473 'catchall', 'int', 'NULL', '', '', '',
1474 'parent_svcnum', 'int', 'NULL', '', '', '',
1475 'registrarnum', 'int', 'NULL', '', '', '',
1476 'registrarkey', 'varchar', 'NULL', 512, '', '',
1477 'setup_date', @date_type, '', '',
1478 'renewal_interval', 'int', 'NULL', '', '', '',
1479 'expiration_date', @date_type, '', '',
1481 'primary_key' => 'svcnum',
1483 'index' => [ ['domain'] ],
1486 'domain_record' => {
1488 'recnum', 'serial', '', '', '', '',
1489 'svcnum', 'int', '', '', '', '',
1490 'reczone', 'varchar', '', 255, '', '',
1491 'recaf', 'char', '', 2, '', '',
1492 'rectype', 'varchar', '', 5, '', '',
1493 'recdata', 'varchar', '', 255, '', '',
1495 'primary_key' => 'recnum',
1497 'index' => [ ['svcnum'] ],
1502 'registrarnum', 'serial', '', '', '', '',
1503 'registrarname', 'varchar', '', $char_d, '', '',
1505 'primary_key' => 'registrarnum',
1512 'svcnum', 'int', '', '', '', '',
1513 'srcsvc', 'int', 'NULL', '', '', '',
1514 'src', 'varchar', 'NULL', 255, '', '',
1515 'dstsvc', 'int', 'NULL', '', '', '',
1516 'dst', 'varchar', 'NULL', 255, '', '',
1518 'primary_key' => 'svcnum',
1520 'index' => [ ['srcsvc'], ['dstsvc'] ],
1525 'svcnum', 'int', '', '', '', '',
1526 'recnum', 'int', '', '', '', '',
1527 'usersvc', 'int', 'NULL', '', '', '',
1528 'config', 'text', 'NULL', '', '', '',
1530 'primary_key' => 'svcnum',
1537 # 'svcnum', 'int', '', '',
1538 # 'svcnum', 'int', '', '',
1539 # 'svcnum', 'int', '', '',
1540 # 'worker', 'varchar', '', $char_d,
1541 # '_date', @date_type,
1543 # 'primary_key' => 'svcnum',
1544 # 'unique' => [ [] ],
1545 # 'index' => [ [] ],
1548 'prepay_credit' => {
1550 'prepaynum', 'serial', '', '', '', '',
1551 'identifier', 'varchar', '', $char_d, '', '',
1552 'amount', @money_type, '', '',
1553 'seconds', 'int', 'NULL', '', '', '',
1554 'upbytes', 'bigint', 'NULL', '', '', '',
1555 'downbytes', 'bigint', 'NULL', '', '', '',
1556 'totalbytes', 'bigint', 'NULL', '', '', '',
1557 'agentnum', 'int', 'NULL', '', '', '',
1559 'primary_key' => 'prepaynum',
1560 'unique' => [ ['identifier'] ],
1566 'portnum', 'serial', '', '', '', '',
1567 'ip', 'varchar', 'NULL', 15, '', '',
1568 'nasport', 'int', 'NULL', '', '', '',
1569 'nasnum', 'int', '', '', '', '',
1571 'primary_key' => 'portnum',
1578 'nasnum', 'serial', '', '', '', '',
1579 'nas', 'varchar', '', $char_d, '', '',
1580 'nasip', 'varchar', '', 15, '', '',
1581 'nasfqdn', 'varchar', '', $char_d, '', '',
1582 'last', 'int', '', '', '', '',
1584 'primary_key' => 'nasnum',
1585 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1586 'index' => [ [ 'last' ] ],
1591 # 'sessionnum', 'serial', '', '', '', '',
1592 # 'portnum', 'int', '', '', '', '',
1593 # 'svcnum', 'int', '', '', '', '',
1594 # 'login', @date_type, '', '',
1595 # 'logout', @date_type, '', '',
1597 # 'primary_key' => 'sessionnum',
1599 # 'index' => [ [ 'portnum' ] ],
1604 'jobnum', 'serial', '', '', '', '',
1605 'job', 'text', '', '', '', '',
1606 '_date', 'int', '', '', '', '',
1607 'status', 'varchar', '', $char_d, '', '',
1608 'statustext', 'text', 'NULL', '', '', '',
1609 'svcnum', 'int', 'NULL', '', '', '',
1610 'custnum', 'int', 'NULL', '', '', '',
1611 'secure', 'char', 'NULL', 1, '', '',
1612 'priority', 'int', 'NULL', '', '', '',
1614 'primary_key' => 'jobnum',
1616 'index' => [ [ 'secure' ], [ 'priority' ],
1617 [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1623 'argnum', 'serial', '', '', '', '',
1624 'jobnum', 'int', '', '', '', '',
1625 'frozen', 'char', 'NULL', 1, '', '',
1626 'arg', 'text', 'NULL', '', '', '',
1628 'primary_key' => 'argnum',
1630 'index' => [ [ 'jobnum' ] ],
1635 'dependnum', 'serial', '', '', '', '',
1636 'jobnum', 'int', '', '', '', '',
1637 'depend_jobnum', 'int', '', '', '', '',
1639 'primary_key' => 'dependnum',
1641 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1646 'exportsvcnum' => 'serial', '', '', '', '',
1647 'exportnum' => 'int', '', '', '', '',
1648 'svcpart' => 'int', '', '', '', '',
1650 'primary_key' => 'exportsvcnum',
1651 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1652 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1657 'exportnum', 'serial', '', '', '', '',
1658 'machine', 'varchar', '', $char_d, '', '',
1659 'exporttype', 'varchar', '', $char_d, '', '',
1660 'nodomain', 'char', 'NULL', 1, '', '',
1662 'primary_key' => 'exportnum',
1664 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1667 'part_export_option' => {
1669 'optionnum', 'serial', '', '', '', '',
1670 'exportnum', 'int', '', '', '', '',
1671 'optionname', 'varchar', '', $char_d, '', '',
1672 'optionvalue', 'text', 'NULL', '', '', '',
1674 'primary_key' => 'optionnum',
1676 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1679 'radius_usergroup' => {
1681 'usergroupnum', 'serial', '', '', '', '',
1682 'svcnum', 'int', '', '', '', '',
1683 'groupname', 'varchar', '', $char_d, '', '',
1685 'primary_key' => 'usergroupnum',
1687 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1692 'msgnum', 'serial', '', '', '', '',
1693 'msgcode', 'varchar', '', $char_d, '', '',
1694 'locale', 'varchar', '', 16, '', '',
1695 'msg', 'text', '', '', '', '',
1697 'primary_key' => 'msgnum',
1698 'unique' => [ [ 'msgcode', 'locale' ] ],
1702 'cust_tax_exempt' => {
1704 'exemptnum', 'serial', '', '', '', '',
1705 'custnum', 'int', '', '', '', '',
1706 'taxnum', 'int', '', '', '', '',
1707 'year', 'int', '', '', '', '',
1708 'month', 'int', '', '', '', '',
1709 'amount', @money_type, '', '',
1711 'primary_key' => 'exemptnum',
1712 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1716 'cust_tax_exempt_pkg' => {
1718 'exemptpkgnum', 'serial', '', '', '', '',
1719 #'custnum', 'int', '', '', '', ''
1720 'billpkgnum', 'int', '', '', '', '',
1721 'taxnum', 'int', '', '', '', '',
1722 'year', 'int', '', '', '', '',
1723 'month', 'int', '', '', '', '',
1724 'amount', @money_type, '', '',
1726 'primary_key' => 'exemptpkgnum',
1728 'index' => [ [ 'taxnum', 'year', 'month' ],
1736 'routernum', 'serial', '', '', '', '',
1737 'routername', 'varchar', '', $char_d, '', '',
1738 'svcnum', 'int', 'NULL', '', '', '',
1739 'agentnum', 'int', 'NULL', '', '', '',
1741 'primary_key' => 'routernum',
1746 'part_svc_router' => {
1748 'svcrouternum', 'serial', '', '', '', '',
1749 'svcpart', 'int', '', '', '', '',
1750 'routernum', 'int', '', '', '', '',
1752 'primary_key' => 'svcrouternum',
1759 'blocknum', 'serial', '', '', '', '',
1760 'routernum', 'int', '', '', '', '',
1761 'ip_gateway', 'varchar', '', 15, '', '',
1762 'ip_netmask', 'int', '', '', '', '',
1763 'agentnum', 'int', 'NULL', '', '', '',
1764 'manual_flag', 'char', 'NULL', 1, '', '',
1766 'primary_key' => 'blocknum',
1767 'unique' => [ [ 'blocknum', 'routernum' ] ],
1771 'svc_broadband' => {
1773 'svcnum', 'int', '', '', '', '',
1774 'description', 'varchar', 'NULL', $char_d, '', '',
1775 'blocknum', 'int', 'NULL', '', '', '',
1776 'speed_up', 'int', '', '', '', '',
1777 'speed_down', 'int', '', '', '', '',
1778 'ip_addr', 'varchar', 'NULL', 15, '', '',
1779 'mac_addr', 'varchar', 'NULL', 12, '', '',
1780 'authkey', 'varchar', 'NULL', 32, '', '',
1781 'latitude', 'decimal', 'NULL', '', '', '',
1782 'longitude', 'decimal', 'NULL', '', '', '',
1783 'altitude', 'decimal', 'NULL', '', '', '',
1784 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1785 'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1787 'primary_key' => 'svcnum',
1788 'unique' => [ [ 'mac_addr' ] ],
1792 'part_virtual_field' => {
1794 'vfieldpart', 'serial', '', '', '', '',
1795 'dbtable', 'varchar', '', 32, '', '',
1796 'name', 'varchar', '', 32, '', '',
1797 'check_block', 'text', 'NULL', '', '', '',
1798 'length', 'int', 'NULL', '', '', '',
1799 'list_source', 'text', 'NULL', '', '', '',
1800 'label', 'varchar', 'NULL', 80, '', '',
1802 'primary_key' => 'vfieldpart',
1807 'virtual_field' => {
1809 'vfieldnum', 'serial', '', '', '', '',
1810 'recnum', 'int', '', '', '', '',
1811 'vfieldpart', 'int', '', '', '', '',
1812 'value', 'varchar', '', 128, '', '',
1814 'primary_key' => 'vfieldnum',
1815 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1821 'snarfnum', 'int', '', '', '', '',
1822 'svcnum', 'int', '', '', '', '',
1823 'machine', 'varchar', '', 255, '', '',
1824 'protocol', 'varchar', '', $char_d, '', '',
1825 'username', 'varchar', '', $char_d, '', '',
1826 '_password', 'varchar', '', $char_d, '', '',
1828 'primary_key' => 'snarfnum',
1830 'index' => [ [ 'svcnum' ] ],
1835 'svcnum', 'int', '', '', '', '',
1836 'id', 'int', 'NULL', '', '', '',
1837 'title', 'varchar', 'NULL', $char_d, '', '',
1839 'primary_key' => 'svcnum',
1844 'cust_pay_refund' => {
1846 'payrefundnum', 'serial', '', '', '', '',
1847 'paynum', 'int', '', '', '', '',
1848 'refundnum', 'int', '', '', '', '',
1849 '_date', @date_type, '', '',
1850 'amount', @money_type, '', '',
1852 'primary_key' => 'payrefundnum',
1854 'index' => [ ['paynum'], ['refundnum'] ],
1857 'part_pkg_option' => {
1859 'optionnum', 'serial', '', '', '', '',
1860 'pkgpart', 'int', '', '', '', '',
1861 'optionname', 'varchar', '', $char_d, '', '',
1862 'optionvalue', 'text', 'NULL', '', '', '',
1864 'primary_key' => 'optionnum',
1866 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1869 'part_pkg_report_option' => {
1871 'num', 'serial', '', '', '', '',
1872 'name', 'varchar', '', $char_d, '', '',
1873 'disabled', 'char', 'NULL', 1, '', '',
1875 'primary_key' => 'num',
1876 'unique' => [ [ 'name' ] ],
1877 'index' => [ [ 'disabled' ] ],
1882 'ratenum', 'serial', '', '', '', '',
1883 'ratename', 'varchar', '', $char_d, '', '',
1885 'primary_key' => 'ratenum',
1892 'ratedetailnum', 'serial', '', '', '', '',
1893 'ratenum', 'int', '', '', '', '',
1894 'orig_regionnum', 'int', 'NULL', '', '', '',
1895 'dest_regionnum', 'int', '', '', '', '',
1896 'min_included', 'int', '', '', '', '',
1897 #'min_charge', @money_type, '', '',
1898 'min_charge', 'decimal', '', '10,5', '', '',
1899 'sec_granularity', 'int', '', '', '', '',
1900 #time period (link to table of periods)?
1901 'classnum', 'int', 'NULL', '', '', '',
1903 'primary_key' => 'ratedetailnum',
1904 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1905 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1910 'regionnum', 'serial', '', '', '', '',
1911 'regionname', 'varchar', '', $char_d, '', '',
1913 'primary_key' => 'regionnum',
1920 'prefixnum', 'serial', '', '', '', '',
1921 'regionnum', 'int', '', '', '', '',
1922 'countrycode', 'varchar', '', 3, '', '',
1923 'npa', 'varchar', 'NULL', 10, '', '', #actually the whole prefix
1924 'nxx', 'varchar', 'NULL', 3, '', '', #actually not used
1926 'primary_key' => 'prefixnum',
1928 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1933 'classnum', 'serial', '', '', '', '',
1934 'classname', 'varchar', '', $char_d, '', '',
1935 'disabled', 'char', 'NULL', 1, '', '',
1937 'primary_key' => 'classnum',
1939 'index' => [ ['disabled'] ],
1944 'codenum', 'serial', '', '', '', '',
1945 'code', 'varchar', '', $char_d, '', '',
1946 'agentnum', 'int', '', '', '', '',
1948 'primary_key' => 'codenum',
1949 'unique' => [ [ 'agentnum', 'code' ] ],
1950 'index' => [ [ 'agentnum' ] ],
1955 'codepkgnum', 'serial', '', '', '', '',
1956 'codenum', 'int', '', '', '', '',
1957 'pkgpart', 'int', '', '', '', '',
1959 'primary_key' => 'codepkgnum',
1960 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1961 'index' => [ [ 'codenum' ] ],
1964 'clientapi_session' => {
1966 'sessionnum', 'serial', '', '', '', '',
1967 'sessionid', 'varchar', '', $char_d, '', '',
1968 'namespace', 'varchar', '', $char_d, '', '',
1970 'primary_key' => 'sessionnum',
1971 'unique' => [ [ 'sessionid', 'namespace' ] ],
1975 'clientapi_session_field' => {
1977 'fieldnum', 'serial', '', '', '', '',
1978 'sessionnum', 'int', '', '', '', '',
1979 'fieldname', 'varchar', '', $char_d, '', '',
1980 'fieldvalue', 'text', 'NULL', '', '', '',
1982 'primary_key' => 'fieldnum',
1983 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1987 'payment_gateway' => {
1989 'gatewaynum', 'serial', '', '', '', '',
1990 'gateway_namespace','varchar', 'NULL', $char_d, '', '',
1991 'gateway_module', 'varchar', '', $char_d, '', '',
1992 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1993 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1994 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1995 'gateway_callback_url', 'varchar', 'NULL', $char_d, '', '',
1996 'disabled', 'char', 'NULL', 1, '', '',
1998 'primary_key' => 'gatewaynum',
2000 'index' => [ [ 'disabled' ] ],
2003 'payment_gateway_option' => {
2005 'optionnum', 'serial', '', '', '', '',
2006 'gatewaynum', 'int', '', '', '', '',
2007 'optionname', 'varchar', '', $char_d, '', '',
2008 'optionvalue', 'text', 'NULL', '', '', '',
2010 'primary_key' => 'optionnum',
2012 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2015 'agent_payment_gateway' => {
2017 'agentgatewaynum', 'serial', '', '', '', '',
2018 'agentnum', 'int', '', '', '', '',
2019 'gatewaynum', 'int', '', '', '', '',
2020 'cardtype', 'varchar', 'NULL', $char_d, '', '',
2021 'taxclass', 'varchar', 'NULL', $char_d, '', '',
2023 'primary_key' => 'agentgatewaynum',
2025 'index' => [ [ 'agentnum', 'cardtype' ], ],
2030 'bannum', 'serial', '', '', '', '',
2031 'payby', 'char', '', 4, '', '',
2032 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
2033 #'paymask', 'varchar', 'NULL', $char_d, '', ''
2034 '_date', @date_type, '', '',
2035 'otaker', 'varchar', '', 32, '', '',
2036 'reason', 'varchar', 'NULL', $char_d, '', '',
2038 'primary_key' => 'bannum',
2039 'unique' => [ [ 'payby', 'payinfo' ] ],
2045 'categorynum', 'serial', '', '', '', '',
2046 'categoryname', 'varchar', '', $char_d, '', '',
2047 'disabled', 'char', 'NULL', 1, '', '',
2049 'primary_key' => 'categorynum',
2051 'index' => [ ['disabled'] ],
2056 'classnum', 'serial', '', '', '', '',
2057 'classname', 'varchar', '', $char_d, '', '',
2058 'categorynum', 'int', 'NULL', '', '', '',
2059 'disabled', 'char', 'NULL', 1, '', '',
2061 'primary_key' => 'classnum',
2063 'index' => [ ['disabled'] ],
2068 # qw( name type null length default local );
2074 'acctid', 'bigserial', '', '', '', '',
2075 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2076 'calldate', 'timestamp', '', '', \'now()', '',
2077 'clid', 'varchar', '', $char_d, \"''", '',
2078 'src', 'varchar', '', $char_d, \"''", '',
2079 'dst', 'varchar', '', $char_d, \"''", '',
2080 'dcontext', 'varchar', '', $char_d, \"''", '',
2081 'channel', 'varchar', '', $char_d, \"''", '',
2082 'dstchannel', 'varchar', '', $char_d, \"''", '',
2083 'lastapp', 'varchar', '', $char_d, \"''", '',
2084 'lastdata', 'varchar', '', $char_d, \"''", '',
2086 #these don't seem to be logged by most of the SQL cdr_* modules
2087 #except tds under sql-illegal names, so;
2088 # ... don't rely on them for rating?
2089 # and, what they hey, i went ahead and changed the names and data types
2090 # to freeside-style dates...
2091 #'start', 'timestamp', 'NULL', '', '', '',
2092 #'answer', 'timestamp', 'NULL', '', '', '',
2093 #'end', 'timestamp', 'NULL', '', '', '',
2094 'startdate', @date_type, '', '',
2095 'answerdate', @date_type, '', '',
2096 'enddate', @date_type, '', '',
2099 'duration', 'int', '', '', 0, '',
2100 'billsec', 'int', '', '', 0, '',
2101 'disposition', 'varchar', '', 45, \"''", '',
2102 'amaflags', 'int', '', '', 0, '',
2103 'accountcode', 'varchar', '', 20, \"''", '',
2104 'uniqueid', 'varchar', '', 32, \"''", '',
2105 'userfield', 'varchar', '', 255, \"''", '',
2108 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2112 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2113 'cdrtypenum', 'int', 'NULL', '', '', '',
2115 'charged_party', 'varchar', 'NULL', $char_d, '', '',
2117 'upstream_currency', 'char', 'NULL', 3, '', '',
2118 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
2119 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
2121 # how it was rated internally...
2122 'ratedetailnum', 'int', 'NULL', '', '', '',
2123 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2125 'distance', 'decimal', 'NULL', '', '', '',
2126 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
2128 #cdr_calltype: the big list in appendix 2
2129 'calltypenum', 'int', 'NULL', '', '', '',
2131 'description', 'varchar', 'NULL', $char_d, '', '',
2132 'quantity', 'int', 'NULL', '', '', '',
2134 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2135 'carrierid', 'int', 'NULL', '', '', '',
2137 'upstream_rateid', 'int', 'NULL', '', '', '',
2140 #and now for our own fields
2143 # a svcnum... right..?
2144 'svcnum', 'int', 'NULL', '', '', '',
2146 #NULL, done (or something)
2147 'freesidestatus', 'varchar', 'NULL', 32, '', '',
2149 #NULL, done (or something)
2150 'freesiderewritestatus', 'varchar', 'NULL', 32, '', '',
2152 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2155 'primary_key' => 'acctid',
2157 'index' => [ [ 'calldate' ],
2158 [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2159 [ 'accountcode' ], [ 'carrierid' ],
2160 [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2165 'cdr_termination' => {
2167 'cdrtermnum', 'bigserial', '', '', '', '',
2168 'acctid', 'bigint', '', '', '', '',
2169 'termpart', 'int', '', '', '', '',#future use see below
2170 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2171 'status', 'varchar', 'NULL', 32, '', '',
2173 'primary_key' => 'cdrtermnum',
2174 'unique' => [ [ 'acctid', 'termpart' ] ],
2175 'index' => [ [ 'acctid' ], [ 'status' ], ],
2178 #to handle multiple termination/settlement passes...
2179 # 'part_termination' => {
2181 # 'termpart', 'int', '', '', '', '',
2182 # 'termname', 'varchar', '', $char_d, '', '',
2183 # 'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2185 # 'primary_key' => 'termpart',
2190 #the remaining cdr_ tables are not really used
2193 'calltypenum', 'serial', '', '', '', '',
2194 'calltypename', 'varchar', '', $char_d, '', '',
2196 'primary_key' => 'calltypenum',
2203 'cdrtypenum' => 'serial', '', '', '', '',
2204 'cdrtypename' => 'varchar', '', $char_d, '', '',
2206 'primary_key' => 'cdrtypenum',
2213 'carrierid' => 'serial', '', '', '', '',
2214 'carriername' => 'varchar', '', $char_d, '', '',
2216 'primary_key' => 'carrierid',
2223 # 'filenum', 'serial', '', '', '', '',
2224 # 'filename', 'varchar', '', '', '', '',
2225 # 'status', 'varchar', 'NULL', '', '', '',
2227 # 'primary_key' => 'filenum',
2228 # 'unique' => [ [ 'filename' ], ], #just change the index if we need to
2229 # # agent-virtualize or have a customer
2230 # # with dup-filename needs or something
2231 # # (only used by cdr.http_and_import for
2236 'inventory_item' => {
2238 'itemnum', 'serial', '', '', '', '',
2239 'classnum', 'int', '', '', '', '',
2240 'item', 'varchar', '', $char_d, '', '',
2241 'svcnum', 'int', 'NULL', '', '', '',
2243 'primary_key' => 'itemnum',
2244 'unique' => [ [ 'classnum', 'item' ] ],
2245 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2248 'inventory_class' => {
2250 'classnum', 'serial', '', '', '', '',
2251 'classname', 'varchar', '', $char_d, '', '',
2253 'primary_key' => 'classnum',
2260 'usernum', 'serial', '', '', '', '',
2261 'username', 'varchar', '', $char_d, '', '',
2262 '_password', 'varchar', '', $char_d, '', '',
2263 'last', 'varchar', '', $char_d, '', '',
2264 'first', 'varchar', '', $char_d, '', '',
2265 'disabled', 'char', 'NULL', 1, '', '',
2267 'primary_key' => 'usernum',
2268 'unique' => [ [ 'username' ] ],
2272 'access_user_pref' => {
2274 'prefnum', 'serial', '', '', '', '',
2275 'usernum', 'int', '', '', '', '',
2276 'prefname', 'varchar', '', $char_d, '', '',
2277 'prefvalue', 'text', 'NULL', '', '', '',
2278 'expiration', @date_type, '', '',
2280 'primary_key' => 'prefnum',
2282 'index' => [ [ 'usernum' ] ],
2287 'groupnum', 'serial', '', '', '', '',
2288 'groupname', 'varchar', '', $char_d, '', '',
2290 'primary_key' => 'groupnum',
2291 'unique' => [ [ 'groupname' ] ],
2295 'access_usergroup' => {
2297 'usergroupnum', 'serial', '', '', '', '',
2298 'usernum', 'int', '', '', '', '',
2299 'groupnum', 'int', '', '', '', '',
2301 'primary_key' => 'usergroupnum',
2302 'unique' => [ [ 'usernum', 'groupnum' ] ],
2303 'index' => [ [ 'usernum' ] ],
2306 'access_groupagent' => {
2308 'groupagentnum', 'serial', '', '', '', '',
2309 'groupnum', 'int', '', '', '', '',
2310 'agentnum', 'int', '', '', '', '',
2312 'primary_key' => 'groupagentnum',
2313 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2314 'index' => [ [ 'groupnum' ] ],
2319 'rightnum', 'serial', '', '', '', '',
2320 'righttype', 'varchar', '', $char_d, '', '',
2321 'rightobjnum', 'int', '', '', '', '',
2322 'rightname', 'varchar', '', $char_d, '', '',
2324 'primary_key' => 'rightnum',
2325 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2331 'svcnum', 'int', '', '', '', '',
2332 'countrycode', 'varchar', '', 3, '', '',
2333 'phonenum', 'varchar', '', 15, '', '', #12 ?
2334 'pin', 'varchar', 'NULL', $char_d, '', '',
2335 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2336 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2338 'primary_key' => 'svcnum',
2340 'index' => [ [ 'countrycode', 'phonenum' ] ],
2345 'devicenum', 'serial', '', '', '', '',
2346 'devicepart', 'int', '', '', '', '',
2347 'svcnum', 'int', '', '', '', '',
2348 'mac_addr', 'varchar', 'NULL', 12, '', '',
2350 'primary_key' => 'devicenum',
2351 'unique' => [ [ 'mac_addr' ], ],
2352 'index' => [ [ 'devicepart' ], [ 'svcnum' ], ],
2357 'devicepart', 'serial', '', '', '', '',
2358 'devicename', 'varchar', '', $char_d, '', '',
2359 #'classnum', #tie to an inventory class?
2361 'primary_key' => 'devicepart',
2362 'unique' => [ [ 'devicename' ] ], #?
2368 'availnum', 'serial', '', '', '', '',
2369 'exportnum', 'int', '', '', '', '',
2370 'countrycode', 'varchar', '', 3, '', '',
2371 'state', 'char', 'NULL', 2, '', '',
2372 'npa', 'char', '', 3, '', '',
2373 'nxx', 'char', 'NULL', 3, '', '',
2374 'station', 'char', 'NULL', 4, '', '',
2375 'name', 'varchar', 'NULL', $char_d, '', '',
2376 'svcnum', 'int', 'NULL', '', '', '',
2377 'availbatch', 'varchar', 'NULL', $char_d, '', '',
2379 'primary_key' => 'availnum',
2381 'index' => [ [ 'exportnum', 'countrycode', 'state' ], #npa search
2382 [ 'exportnum', 'countrycode', 'npa' ], #nxx search
2383 [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2384 [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2392 'typenum', 'serial', '', '', '', '',
2393 'class', 'char', '', 1, '', '',
2394 'type', 'varchar', '', $char_d, '', '',
2396 'primary_key' => 'typenum',
2403 'reasonnum', 'serial', '', '', '', '',
2404 'reason_type', 'int', '', '', '', '',
2405 'reason', 'text', '', '', '', '',
2406 'disabled', 'char', 'NULL', 1, '', '',
2408 'primary_key' => 'reasonnum',
2415 'confnum', 'serial', '', '', '', '',
2416 'agentnum', 'int', 'NULL', '', '', '',
2417 'name', 'varchar', '', $char_d, '', '',
2418 'value', 'text', 'NULL', '', '', '',
2420 'primary_key' => 'confnum',
2421 'unique' => [ [ 'agentnum', 'name' ]],
2427 'pkgrefnum', 'serial', '', '', '', '',
2428 'pkgnum', 'int', '', '', '', '',
2429 'refnum', 'int', '', '', '', '',
2431 'primary_key' => 'pkgrefnum',
2432 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2433 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2435 # name type nullability length default local
2439 # 'num', 'serial', '', '', '', '',
2441 # 'primary_key' => 'num',