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 #can be removed once we depend on DBIx::DBSchema 0.39;
106 $hash{'type'} = 'LONGTEXT'
107 if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
109 unless ( defined $hash{'default'} ) {
110 warn "$tablename:\n".
111 join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
114 push @columns, new DBIx::DBSchema::Column ( \%hash );
117 #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
118 #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
119 my $unique = $tables_hashref->{$tablename}{'unique'};
120 my @index = @{ $tables_hashref->{$tablename}{'index'} };
122 # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
123 # specification without a key length".
124 # better solution: teach DBIx::DBSchema to specify a default length for
125 # MySQL indices on text columns, or just to support an index length at all
126 # so we can pass something in.
127 # best solution: eliminate need for this index in cust_main::retry_realtime
128 @index = grep { @{$_}[0] ne 'statustext' } @index
129 if $datasrc =~ /^dbi:mysql/i;
133 DBIx::DBSchema::Index->new({
134 'name' => $tablename. $indexnum++,
141 DBIx::DBSchema::Index->new({
142 'name' => $tablename. $indexnum++,
149 DBIx::DBSchema::Table->new({
150 'name' => $tablename,
151 'primary_key' => $tables_hashref->{$tablename}{'primary_key'},
152 'columns' => \@columns,
153 'indices' => \@indices,
154 'local_options' => $local_options,
157 } keys %$tables_hashref;
160 warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
161 warn "[debug]$me $_\n" foreach $dbdef->tables;
164 #add radius attributes to svc_acct
166 #my($svc_acct)=$dbdef->table('svc_acct');
169 #foreach $attribute (@attributes) {
170 # $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
171 # 'radius_'. $attribute,
178 #foreach $attribute (@check_attributes) {
179 # $svc_acct->addcolumn( new DBIx::DBSchema::Column (
187 #create history tables (false laziness w/create-history-tables)
189 grep { ! /^clientapi_session/ }
193 my $tableobj = $dbdef->table($table)
194 or die "unknown table $table";
196 my %indices = $tableobj->indices;
198 my %h_indices = map {
200 DBIx::DBSchema::Index->new({
201 'name' => 'h_'. $indices{$_}->name,
203 'columns' => [ @{$indices{$_}->columns} ],
209 $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
210 'name' => "h_${table}_srckey",
212 'columns' => [ 'history_action', #right?
213 $tableobj->primary_key,
217 $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
218 'name' => "h_${table}_srckey2",
220 'columns' => [ 'history_date',
221 $tableobj->primary_key,
225 my $h_tableobj = DBIx::DBSchema::Table->new( {
226 'name' => "h_$table",
227 'primary_key' => 'historynum',
228 'indices' => \%h_indices,
229 'local_options' => $local_options,
231 DBIx::DBSchema::Column->new( {
232 'name' => 'historynum',
234 'null' => 'NOT NULL',
239 DBIx::DBSchema::Column->new( {
240 'name' => 'history_date',
247 DBIx::DBSchema::Column->new( {
248 'name' => 'history_user',
250 'null' => 'NOT NULL',
255 DBIx::DBSchema::Column->new( {
256 'name' => 'history_action',
258 'null' => 'NOT NULL',
264 my $column = $tableobj->column($_);
266 #clone so as to not disturb the original
267 $column = DBIx::DBSchema::Column->new( {
268 map { $_ => $column->$_() }
269 qw( name type null length default local )
272 if ( $column->type =~ /^(\w*)SERIAL$/i ) {
273 $column->type(uc($1).'INT');
274 $column->null('NULL');
276 #$column->default('')
277 # if $column->default =~ /^nextval\(/i;
278 #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
279 #$column->local($local);
284 $dbdef->addtable($h_tableobj);
287 if ( $datasrc =~ /^dbi:mysql/i ) {
289 my $dup_lock_table = DBIx::DBSchema::Table->new( {
290 'name' => 'duplicate_lock',
291 'primary_key' => 'duplocknum',
292 'local_options' => $local_options,
294 DBIx::DBSchema::Column->new( {
295 'name' => 'duplocknum',
297 'null' => 'NOT NULL',
302 DBIx::DBSchema::Column->new( {
303 'name' => 'lockname',
305 'null' => 'NOT NULL',
311 'indices' => { 'duplicate_lock1' =>
312 DBIx::DBSchema::Index->new({
313 'name' => 'duplicate_lock1',
315 'columns' => [ 'lockname' ],
320 $dbdef->addtable($dup_lock_table);
330 my $char_d = 80; #default maxlength for text fields
332 #my(@date_type) = ( 'timestamp', '', '' );
333 my @date_type = ( 'int', 'NULL', '' );
334 my @perl_type = ( 'text', 'NULL', '' );
335 my @money_type = ( 'decimal', '', '10,2' );
336 my @money_typen = ( 'decimal', 'NULL', '10,2' );
337 my @taxrate_type = ( 'decimal', '', '14,8' ); # requires pg 8 for
338 my @taxrate_typen = ( 'decimal', 'NULL', '14,8' ); # fs-upgrade to work
340 my $username_len = 32; #usernamemax config file
342 # name type nullability length default local
348 'agentnum', 'serial', '', '', '', '',
349 'agent', 'varchar', '', $char_d, '', '',
350 'typenum', 'int', '', '', '', '',
351 'ticketing_queueid', 'int', 'NULL', '', '', '',
352 'invoice_template', 'varchar', 'NULL', $char_d, '', '',
353 'agent_custnum', 'int', 'NULL', '', '', '',
354 'disabled', 'char', 'NULL', 1, '', '',
355 'username', 'varchar', 'NULL', $char_d, '', '', #deprecated
356 '_password', 'varchar', 'NULL', $char_d, '', '', #deprecated
357 'freq', 'int', 'NULL', '', '', '', #deprecated (never used)
358 'prog', @perl_type, '', '', #deprecated (never used)
360 'primary_key' => 'agentnum',
361 #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
362 #insert is giving it a value, tho..
363 #'index' => [ ['typenum'], ['disabled'] ],
365 'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
370 'typenum', 'serial', '', '', '', '',
371 'atype', 'varchar', '', $char_d, '', '',
373 'primary_key' => 'typenum',
380 'typepkgnum', 'serial', '', '', '', '',
381 'typenum', 'int', '', '', '', '',
382 'pkgpart', 'int', '', '', '', '',
384 'primary_key' => 'typepkgnum',
385 'unique' => [ ['typenum', 'pkgpart'] ],
386 'index' => [ ['typenum'] ],
389 'cust_attachment' => {
391 'attachnum', 'serial', '', '', '', '',
392 'custnum', 'int', '', '', '', '',
393 '_date', @date_type, '', '',
394 'otaker', 'varchar', '', 32, '', '',
395 'filename', 'varchar', '', 255, '', '',
396 'mime_type', 'varchar', '', $char_d, '', '',
397 'title', 'varchar', 'NULL', $char_d, '', '',
398 'body', 'blob', 'NULL', '', '', '',
399 'disabled', @date_type, '', '',
401 'primary_key' => 'attachnum',
403 'index' => [ ['custnum'] ],
409 'invnum', 'serial', '', '', '', '',
410 'custnum', 'int', '', '', '', '',
411 '_date', @date_type, '', '',
412 'charged', @money_type, '', '',
413 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
415 #customer balance info at invoice generation time
416 'previous_balance', @money_typen, '', '', #eventually not nullable
417 'billing_balance', @money_typen, '', '', #eventually not nullable
419 #deprecated (unused by now, right?)
420 'printed', 'int', '', '', '', '',
423 'closed', 'char', 'NULL', 1, '', '',
424 'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
426 'primary_key' => 'invnum',
428 'index' => [ ['custnum'], ['_date'], ['statementnum'], ],
431 'cust_statement' => {
433 'statementnum', 'serial', '', '', '', '',
434 'custnum', 'int', '', '', '', '',
435 '_date', @date_type, '', '',
437 'primary_key' => 'statementnum',
439 'index' => [ ['custnum'], ['_date'], ],
442 'cust_bill_event' => {
444 'eventnum', 'serial', '', '', '', '',
445 'invnum', 'int', '', '', '', '',
446 'eventpart', 'int', '', '', '', '',
447 '_date', @date_type, '', '',
448 'status', 'varchar', '', $char_d, '', '',
449 'statustext', 'text', 'NULL', '', '', '',
451 'primary_key' => 'eventnum',
452 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
454 'index' => [ ['invnum'], ['status'], ['eventpart'],
455 ['statustext'], ['_date'],
459 'part_bill_event' => {
461 'eventpart', 'serial', '', '', '', '',
462 'freq', 'varchar', 'NULL', $char_d, '', '',
463 'payby', 'char', '', 4, '', '',
464 'event', 'varchar', '', $char_d, '', '',
465 'eventcode', @perl_type, '', '',
466 'seconds', 'int', 'NULL', '', '', '',
467 'weight', 'int', '', '', '', '',
468 'plan', 'varchar', 'NULL', $char_d, '', '',
469 'plandata', 'text', 'NULL', '', '', '',
470 'reason', 'int', 'NULL', '', '', '',
471 'disabled', 'char', 'NULL', 1, '', '',
473 'primary_key' => 'eventpart',
475 'index' => [ ['payby'], ['disabled'], ],
480 'eventpart', 'serial', '', '', '', '',
481 'agentnum', 'int', 'NULL', '', '', '',
482 'event', 'varchar', '', $char_d, '', '',
483 'eventtable', 'varchar', '', $char_d, '', '',
484 'check_freq', 'varchar', 'NULL', $char_d, '', '',
485 'weight', 'int', '', '', '', '',
486 'action', 'varchar', '', $char_d, '', '',
487 'disabled', 'char', 'NULL', 1, '', '',
489 'primary_key' => 'eventpart',
491 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
494 'part_event_option' => {
496 'optionnum', 'serial', '', '', '', '',
497 'eventpart', 'int', '', '', '', '',
498 'optionname', 'varchar', '', $char_d, '', '',
499 'optionvalue', 'text', 'NULL', '', '', '',
501 'primary_key' => 'optionnum',
503 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
506 'part_event_condition' => {
508 'eventconditionnum', 'serial', '', '', '', '',
509 'eventpart', 'int', '', '', '', '',
510 'conditionname', 'varchar', '', $char_d, '', '',
512 'primary_key' => 'eventconditionnum',
514 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
517 'part_event_condition_option' => {
519 'optionnum', 'serial', '', '', '', '',
520 'eventconditionnum', 'int', '', '', '', '',
521 'optionname', 'varchar', '', $char_d, '', '',
522 'optionvalue', 'text', 'NULL', '', '', '',
524 'primary_key' => 'optionnum',
526 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
529 'part_event_condition_option_option' => {
531 'optionoptionnum', 'serial', '', '', '', '',
532 'optionnum', 'int', '', '', '', '',
533 'optionname', 'varchar', '', $char_d, '', '',
534 'optionvalue', 'text', 'NULL', '', '', '',
536 'primary_key' => 'optionoptionnum',
538 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
543 'eventnum', 'serial', '', '', '', '',
544 'eventpart', 'int', '', '', '', '',
545 'tablenum', 'int', '', '', '', '',
546 '_date', @date_type, '', '',
547 'status', 'varchar', '', $char_d, '', '',
548 'statustext', 'text', 'NULL', '', '', '',
550 'primary_key' => 'eventnum',
551 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
553 'index' => [ ['eventpart'], ['tablenum'], ['status'],
554 ['statustext'], ['_date'],
560 'billpkgnum', 'serial', '', '', '', '',
561 'invnum', 'int', '', '', '', '',
562 'pkgnum', 'int', '', '', '', '',
563 'pkgpart_override', 'int', 'NULL', '', '', '',
564 'setup', @money_type, '', '',
565 'recur', @money_type, '', '',
566 'sdate', @date_type, '', '',
567 'edate', @date_type, '', '',
568 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
569 'itemcomment', 'varchar', 'NULL', $char_d, '', '',
570 'section', 'varchar', 'NULL', $char_d, '', '',
571 'quantity', 'int', 'NULL', '', '', '',
572 'unitsetup', @money_typen, '', '',
573 'unitrecur', @money_typen, '', '',
574 'hidden', 'char', 'NULL', 1, '', '',
576 'primary_key' => 'billpkgnum',
578 'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
581 'cust_bill_pkg_detail' => {
583 'detailnum', 'serial', '', '', '', '',
584 'billpkgnum', 'int', 'NULL', '', '', '', # should not be nullable
585 'pkgnum', 'int', 'NULL', '', '', '', # deprecated
586 'invnum', 'int', 'NULL', '', '', '', # deprecated
587 'amount', 'decimal', 'NULL', '10,4', '', '',
588 'format', 'char', 'NULL', 1, '', '',
589 'classnum', 'int', 'NULL', '', '', '',
590 'duration', 'int', 'NULL', '', 0, '',
591 'phonenum', 'varchar', 'NULL', 15, '', '',
592 'regionname', 'varchar', 'NULL', $char_d, '', '',
593 'detail', 'varchar', '', 255, '', '',
595 'primary_key' => 'detailnum',
597 'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
600 'cust_bill_pkg_display' => {
602 'billpkgdisplaynum', 'serial', '', '', '', '',
603 'billpkgnum', 'int', '', '', '', '',
604 'section', 'varchar', 'NULL', $char_d, '', '',
605 #'unitsetup', @money_typen, '', '', #override the linked real one?
606 #'unitrecur', @money_typen, '', '', #this too?
607 'post_total', 'char', 'NULL', 1, '', '',
608 'type', 'char', 'NULL', 1, '', '',
609 'summary', 'char', 'NULL', 1, '', '',
611 'primary_key' => 'billpkgdisplaynum',
613 'index' => [ ['billpkgnum'], ],
616 'cust_bill_pkg_tax_location' => {
618 'billpkgtaxlocationnum', 'serial', '', '', '', '',
619 'billpkgnum', 'int', '', '', '', '',
620 'taxnum', 'int', '', '', '', '',
621 'taxtype', 'varchar', '', $char_d, '', '',
622 'pkgnum', 'int', '', '', '', '',
623 'locationnum', 'int', '', '', '', '', #redundant?
624 'amount', @money_type, '', '',
626 'primary_key' => 'billpkgtaxlocationnum',
628 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
631 'cust_bill_pkg_tax_rate_location' => {
633 'billpkgtaxratelocationnum', 'serial', '', '', '', '',
634 'billpkgnum', 'int', '', '', '', '',
635 'taxnum', 'int', '', '', '', '',
636 'taxtype', 'varchar', '', $char_d, '', '',
637 'locationtaxid', 'varchar', 'NULL', $char_d, '', '',
638 'taxratelocationnum', 'int', '', '', '', '',
639 'amount', @money_type, '', '',
641 'primary_key' => 'billpkgtaxratelocationnum',
643 'index' => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
648 'crednum', 'serial', '', '', '', '',
649 'custnum', 'int', '', '', '', '',
650 '_date', @date_type, '', '',
651 'amount', @money_type, '', '',
652 'otaker', 'varchar', '', 32, '', '',
653 'reason', 'text', 'NULL', '', '', '',
654 'reasonnum', 'int', 'NULL', '', '', '',
655 'addlinfo', 'text', 'NULL', '', '', '',
656 'closed', 'char', 'NULL', 1, '', '',
657 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
658 'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
660 'primary_key' => 'crednum',
662 'index' => [ ['custnum'], ['_date'], ['eventnum'] ],
665 'cust_credit_bill' => {
667 'creditbillnum', 'serial', '', '', '', '',
668 'crednum', 'int', '', '', '', '',
669 'invnum', 'int', '', '', '', '',
670 '_date', @date_type, '', '',
671 'amount', @money_type, '', '',
672 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
674 'primary_key' => 'creditbillnum',
676 'index' => [ ['crednum'], ['invnum'] ],
679 'cust_credit_bill_pkg' => {
681 'creditbillpkgnum', 'serial', '', '', '', '',
682 'creditbillnum', 'int', '', '', '', '',
683 'billpkgnum', 'int', '', '', '', '',
684 'amount', @money_type, '', '',
685 'setuprecur', 'varchar', '', $char_d, '', '',
686 'sdate', @date_type, '', '',
687 'edate', @date_type, '', '',
689 'primary_key' => 'creditbillpkgnum',
691 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
696 'custnum', 'serial', '', '', '', '',
697 'agentnum', 'int', '', '', '', '',
698 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
699 'custbatch', 'varchar', 'NULL', $char_d, '', '',
700 # 'titlenum', 'int', 'NULL', '', '', '',
701 'last', 'varchar', '', $char_d, '', '',
702 # 'middle', 'varchar', 'NULL', $char_d, '', '',
703 'first', 'varchar', '', $char_d, '', '',
704 'ss', 'varchar', 'NULL', 11, '', '',
705 'stateid', 'varchar', 'NULL', $char_d, '', '',
706 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
707 'birthdate' ,@date_type, '', '',
708 'signupdate',@date_type, '', '',
709 'dundate', @date_type, '', '',
710 'company', 'varchar', 'NULL', $char_d, '', '',
711 'address1', 'varchar', '', $char_d, '', '',
712 'address2', 'varchar', 'NULL', $char_d, '', '',
713 'city', 'varchar', '', $char_d, '', '',
714 'county', 'varchar', 'NULL', $char_d, '', '',
715 'state', 'varchar', 'NULL', $char_d, '', '',
716 'zip', 'varchar', 'NULL', 10, '', '',
717 'country', 'char', '', 2, '', '',
718 'daytime', 'varchar', 'NULL', 20, '', '',
719 'night', 'varchar', 'NULL', 20, '', '',
720 'fax', 'varchar', 'NULL', 12, '', '',
721 'ship_last', 'varchar', 'NULL', $char_d, '', '',
722 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
723 'ship_first', 'varchar', 'NULL', $char_d, '', '',
724 'ship_company', 'varchar', 'NULL', $char_d, '', '',
725 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
726 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
727 'ship_city', 'varchar', 'NULL', $char_d, '', '',
728 'ship_county', 'varchar', 'NULL', $char_d, '', '',
729 'ship_state', 'varchar', 'NULL', $char_d, '', '',
730 'ship_zip', 'varchar', 'NULL', 10, '', '',
731 'ship_country', 'char', 'NULL', 2, '', '',
732 'ship_daytime', 'varchar', 'NULL', 20, '', '',
733 'ship_night', 'varchar', 'NULL', 20, '', '',
734 'ship_fax', 'varchar', 'NULL', 12, '', '',
735 'payby', 'char', '', 4, '', '',
736 'payinfo', 'varchar', 'NULL', 512, '', '',
737 'paycvv', 'varchar', 'NULL', 512, '', '',
738 'paymask', 'varchar', 'NULL', $char_d, '', '',
739 #'paydate', @date_type, '', '',
740 'paydate', 'varchar', 'NULL', 10, '', '',
741 'paystart_month', 'int', 'NULL', '', '', '',
742 'paystart_year', 'int', 'NULL', '', '', '',
743 'payissue', 'varchar', 'NULL', 2, '', '',
744 'payname', 'varchar', 'NULL', $char_d, '', '',
745 'paystate', 'varchar', 'NULL', $char_d, '', '',
746 'paytype', 'varchar', 'NULL', $char_d, '', '',
747 'payip', 'varchar', 'NULL', 15, '', '',
748 'geocode', 'varchar', 'NULL', 20, '', '',
749 'censustract', 'varchar', 'NULL', 20, '', '', # 7 to save space?
750 'tax', 'char', 'NULL', 1, '', '',
751 'otaker', 'varchar', '', 32, '', '',
752 'refnum', 'int', '', '', '', '',
753 'referral_custnum', 'int', 'NULL', '', '', '',
754 'comments', 'text', 'NULL', '', '', '',
755 'spool_cdr','char', 'NULL', 1, '', '',
756 'squelch_cdr','char', 'NULL', 1, '', '',
757 'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
758 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
759 'archived', 'char', 'NULL', 1, '', '',
760 'email_csv_cdr', 'char', 'NULL', 1, '', '',
762 'primary_key' => 'custnum',
763 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
764 #'index' => [ ['last'], ['company'] ],
766 [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
767 [ 'referral_custnum' ],
768 [ 'payby' ], [ 'paydate' ],
771 [ 'last' ], [ 'company' ],
772 [ 'county' ], [ 'state' ], [ 'country' ],
774 [ 'daytime' ], [ 'night' ], [ 'fax' ],
776 [ 'ship_last' ], [ 'ship_company' ],
777 [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
779 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
783 'cust_recon' => { # what purpose does this serve?
785 'reconid', 'serial', '', '', '', '',
786 'recondate', @date_type, '', '',
787 'custnum', 'int' , '', '', '', '',
788 'agentnum', 'int', '', '', '', '',
789 'last', 'varchar', '', $char_d, '', '',
790 'first', 'varchar', '', $char_d, '', '',
791 'address1', 'varchar', '', $char_d, '', '',
792 'address2', 'varchar', 'NULL', $char_d, '', '',
793 'city', 'varchar', '', $char_d, '', '',
794 'state', 'varchar', 'NULL', $char_d, '', '',
795 'zip', 'varchar', 'NULL', 10, '', '',
796 'pkg', 'varchar', 'NULL', $char_d, '', '',
797 'adjourn', @date_type, '', '',
798 'status', 'varchar', 'NULL', 10, '', '',
799 'agent_custid', 'varchar', '', $char_d, '', '',
800 'agent_pkg', 'varchar', 'NULL', $char_d, '', '',
801 'agent_adjourn', @date_type, '', '',
802 'comments', 'text', 'NULL', '', '', '',
804 'primary_key' => 'reconid',
809 #eventually use for billing & ship from cust_main too
810 #for now, just cust_pkg locations
813 'locationnum', 'serial', '', '', '', '',
814 'custnum', 'int', '', '', '', '',
815 'address1', 'varchar', '', $char_d, '', '',
816 'address2', 'varchar', 'NULL', $char_d, '', '',
817 'city', 'varchar', '', $char_d, '', '',
818 'county', 'varchar', 'NULL', $char_d, '', '',
819 'state', 'varchar', 'NULL', $char_d, '', '',
820 'zip', 'varchar', 'NULL', 10, '', '',
821 'country', 'char', '', 2, '', '',
822 'geocode', 'varchar', 'NULL', 20, '', '',
824 'primary_key' => 'locationnum',
826 'index' => [ [ 'custnum' ],
827 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
831 'cust_main_invoice' => {
833 'destnum', 'serial', '', '', '', '',
834 'custnum', 'int', '', '', '', '',
835 'dest', 'varchar', '', $char_d, '', '',
837 'primary_key' => 'destnum',
839 'index' => [ ['custnum'], ],
842 'cust_main_note' => {
844 'notenum', 'serial', '', '', '', '',
845 'custnum', 'int', '', '', '', '',
846 '_date', @date_type, '', '',
847 'otaker', 'varchar', '', 32, '', '',
848 'comments', 'text', 'NULL', '', '', '',
850 'primary_key' => 'notenum',
852 'index' => [ [ 'custnum' ], [ '_date' ], ],
855 'cust_main_exemption' => {
857 'exemptionnum', 'serial', '', '', '', '',
858 'custnum', 'int', '', '', '', '',
859 'taxname', 'varchar', '', $char_d, '', '',
860 #start/end dates? for reporting?
862 'primary_key' => 'exemptionnum',
864 'index' => [ [ 'custnum' ] ],
867 'cust_tax_adjustment' => {
869 'adjustmentnum', 'serial', '', '', '', '',
870 'custnum', 'int', '', '', '', '',
871 'taxname', 'varchar', '', $char_d, '', '',
872 'amount', @money_type, '', '',
873 'comment', 'varchar', 'NULL', $char_d, '', '',
874 'billpkgnum', 'int', 'NULL', '', '', '',
875 #more? no cust_bill_pkg_tax_location?
877 'primary_key' => 'adjustmentnum',
879 'index' => [ [ 'custnum' ], [ 'billpkgnum' ] ],
882 'cust_main_county' => { #county+state+country are checked off the
883 #cust_main_county for validation and to provide
886 'taxnum', 'serial', '', '', '', '',
887 'state', 'varchar', 'NULL', $char_d, '', '',
888 'county', 'varchar', 'NULL', $char_d, '', '',
889 'country', 'char', '', 2, '', '',
890 'taxclass', 'varchar', 'NULL', $char_d, '', '',
891 'exempt_amount', @money_type, '', '',
892 'tax', 'real', '', '', '', '', #tax %
893 'taxname', 'varchar', 'NULL', $char_d, '', '',
894 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
895 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
897 'primary_key' => 'taxnum',
899 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
900 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
907 'taxnum', 'serial', '', '', '', '',
908 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
909 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
910 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
911 'taxclassnum', 'int', '', '', '', '',
912 'effective_date', @date_type, '', '',
913 'tax', @taxrate_type, '', '', # tax %
914 'excessrate', @taxrate_typen, '', '', # second tax %
915 'taxbase', @money_typen, '', '', # amount at first tax rate
916 'taxmax', @money_typen, '', '', # maximum about at both rates
917 'usetax', @taxrate_typen, '', '', # tax % when non-local
918 'useexcessrate', @taxrate_typen, '', '', # second tax % when non-local
919 'unittype', 'int', 'NULL', '', '', '', # for fee
920 'fee', @taxrate_typen, '', '', # amount tax per unit
921 'excessfee', @taxrate_typen, '', '', # second amount tax per unit
922 'feebase', @taxrate_typen, '', '', # units taxed at first rate
923 'feemax', @taxrate_typen, '', '', # maximum number of unit taxed
924 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
925 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
926 'taxauth', 'int', 'NULL', '', '', '', # tax authority
927 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
928 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
929 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
930 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
931 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
932 'inoutcity', 'char', 'NULL', 1, '', '', # '', 'I', or 'O'
933 'inoutlocal', 'char', 'NULL', 1, '', '', # '', 'I', or 'O'
934 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
935 'disabled', 'char', 'NULL', 1, '', '', # Y = tax disabled
937 'primary_key' => 'taxnum',
939 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
942 'tax_rate_location' => {
944 'taxratelocationnum', 'serial', '', '', '', '',
945 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
946 'geocode', 'varchar', '', 20, '', '',
947 'city', 'varchar', 'NULL', $char_d, '', '',
948 'county', 'varchar', 'NULL', $char_d, '', '',
949 'state', 'char', 'NULL', 2, '', '',
950 'disabled', 'char', 'NULL', 1, '', '',
952 'primary_key' => 'taxratelocationnum',
954 'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
957 'cust_tax_location' => {
959 'custlocationnum', 'serial', '', '', '', '',
960 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
961 'city', 'varchar', 'NULL', $char_d, '', '',
962 'postalcity', 'varchar', 'NULL', $char_d, '', '',
963 'county', 'varchar', 'NULL', $char_d, '', '',
964 'zip', 'char', '', 5, '', '',
965 'state', 'char', '', 2, '', '',
966 'plus4hi', 'char', 'NULL', 4, '', '',
967 'plus4lo', 'char', 'NULL', 4, '', '',
968 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
969 'cityflag', 'char', 'NULL', 1, '', '', # I(n)/O(out)/B(oth)/NULL
970 'geocode', 'varchar', '', 20, '', '',
972 'primary_key' => 'custlocationnum',
974 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
979 'taxclassnum', 'serial', '', '', '', '',
980 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
981 'taxclass', 'varchar', '', $char_d, '', '',
982 'description', 'varchar', '', 2*$char_d, '', '',
984 'primary_key' => 'taxclassnum',
985 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
989 'cust_pay_pending' => {
991 'paypendingnum','serial', '', '', '', '',
992 'custnum', 'int', '', '', '', '',
993 'paid', @money_type, '', '',
994 '_date', @date_type, '', '',
995 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
996 # be index into payby
998 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
999 'paymask', 'varchar', 'NULL', $char_d, '', '',
1000 'paydate', 'varchar', 'NULL', 10, '', '',
1001 'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1002 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1003 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1005 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1006 'status', 'varchar', '', $char_d, '', '',
1007 'session_id', 'varchar', 'NULL', $char_d, '', '', #only need 32
1008 'statustext', 'text', 'NULL', '', '', '',
1009 'gatewaynum', 'int', 'NULL', '', '', '',
1010 #'cust_balance', @money_type, '', '',
1011 'paynum', 'int', 'NULL', '', '', '',
1012 'jobnum', 'int', 'NULL', '', '', '',
1014 'primary_key' => 'paypendingnum',
1015 'unique' => [ [ 'payunique' ] ],
1016 'index' => [ [ 'custnum' ], [ 'status' ], ],
1021 'paynum', 'serial', '', '', '', '',
1022 'custnum', 'int', '', '', '', '',
1023 '_date', @date_type, '', '',
1024 'paid', @money_type, '', '',
1025 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
1026 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1027 # index into payby table
1029 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1030 'paymask', 'varchar', 'NULL', $char_d, '', '',
1031 'paydate', 'varchar', 'NULL', 10, '', '',
1032 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1033 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1034 'closed', 'char', 'NULL', 1, '', '',
1035 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1037 'primary_key' => 'paynum',
1038 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1039 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
1042 'cust_pay_void' => {
1044 'paynum', 'int', '', '', '', '',
1045 'custnum', 'int', '', '', '', '',
1046 'paid', @money_type, '', '',
1047 '_date', @date_type, '', '',
1048 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1049 # index into payby table
1051 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1052 'paymask', 'varchar', 'NULL', $char_d, '', '',
1053 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1054 'closed', 'char', 'NULL', 1, '', '',
1055 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1056 'void_date', @date_type, '', '',
1057 'reason', 'varchar', 'NULL', $char_d, '', '',
1058 'otaker', 'varchar', '', 32, '', '',
1060 'primary_key' => 'paynum',
1062 'index' => [ [ 'custnum' ] ],
1065 'cust_bill_pay' => {
1067 'billpaynum', 'serial', '', '', '', '',
1068 'invnum', 'int', '', '', '', '',
1069 'paynum', 'int', '', '', '', '',
1070 'amount', @money_type, '', '',
1071 '_date', @date_type, '', '',
1072 'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1074 'primary_key' => 'billpaynum',
1076 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1079 'cust_bill_pay_batch' => {
1081 'billpaynum', 'serial', '', '', '', '',
1082 'invnum', 'int', '', '', '', '',
1083 'paybatchnum', 'int', '', '', '', '',
1084 'amount', @money_type, '', '',
1085 '_date', @date_type, '', '',
1087 'primary_key' => 'billpaynum',
1089 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1092 'cust_bill_pay_pkg' => {
1094 'billpaypkgnum', 'serial', '', '', '', '',
1095 'billpaynum', 'int', '', '', '', '',
1096 'billpkgnum', 'int', '', '', '', '',
1097 'amount', @money_type, '', '',
1098 'setuprecur', 'varchar', '', $char_d, '', '',
1099 'sdate', @date_type, '', '',
1100 'edate', @date_type, '', '',
1102 'primary_key' => 'billpaypkgnum',
1104 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1107 'pay_batch' => { #batches of payments to an external processor
1109 'batchnum', 'serial', '', '', '', '',
1110 'payby', 'char', '', 4, '', '', # CARD/CHEK
1111 'status', 'char', 'NULL', 1, '', '',
1112 'download', @date_type, '', '',
1113 'upload', @date_type, '', '',
1115 'primary_key' => 'batchnum',
1120 'cust_pay_batch' => { #what's this used for again? list of customers
1121 #in current CARD batch? (necessarily CARD?)
1123 'paybatchnum', 'serial', '', '', '', '',
1124 'batchnum', 'int', '', '', '', '',
1125 'invnum', 'int', '', '', '', '',
1126 'custnum', 'int', '', '', '', '',
1127 'last', 'varchar', '', $char_d, '', '',
1128 'first', 'varchar', '', $char_d, '', '',
1129 'address1', 'varchar', '', $char_d, '', '',
1130 'address2', 'varchar', 'NULL', $char_d, '', '',
1131 'city', 'varchar', '', $char_d, '', '',
1132 'state', 'varchar', 'NULL', $char_d, '', '',
1133 'zip', 'varchar', 'NULL', 10, '', '',
1134 'country', 'char', '', 2, '', '',
1135 # 'trancode', 'int', '', '', '', ''
1136 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
1137 'payinfo', 'varchar', '', 512, '', '',
1138 #'exp', @date_type, '', ''
1139 'exp', 'varchar', 'NULL', 11, '', '',
1140 'payname', 'varchar', 'NULL', $char_d, '', '',
1141 'amount', @money_type, '', '',
1142 'status', 'varchar', 'NULL', $char_d, '', '',
1144 'primary_key' => 'paybatchnum',
1146 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1151 'pkgnum', 'serial', '', '', '', '',
1152 'custnum', 'int', '', '', '', '',
1153 'pkgpart', 'int', '', '', '', '',
1154 'locationnum', 'int', 'NULL', '', '', '',
1155 'otaker', 'varchar', '', 32, '', '',
1156 'start_date', @date_type, '', '',
1157 'setup', @date_type, '', '',
1158 'bill', @date_type, '', '',
1159 'last_bill', @date_type, '', '',
1160 'susp', @date_type, '', '',
1161 'adjourn', @date_type, '', '',
1162 'cancel', @date_type, '', '',
1163 'expire', @date_type, '', '',
1164 'change_date', @date_type, '', '',
1165 'change_pkgnum', 'int', 'NULL', '', '', '',
1166 'change_pkgpart', 'int', 'NULL', '', '', '',
1167 'change_locationnum', 'int', 'NULL', '', '', '',
1168 'manual_flag', 'char', 'NULL', 1, '', '',
1169 'quantity', 'int', 'NULL', '', '', '',
1171 'primary_key' => 'pkgnum',
1173 'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1174 [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1175 ['susp'], ['adjourn'], ['expire'], ['cancel'],
1180 'cust_pkg_option' => {
1182 'optionnum', 'serial', '', '', '', '',
1183 'pkgnum', 'int', '', '', '', '',
1184 'optionname', 'varchar', '', $char_d, '', '',
1185 'optionvalue', 'text', 'NULL', '', '', '',
1187 'primary_key' => 'optionnum',
1189 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
1192 'cust_pkg_detail' => {
1194 'pkgdetailnum', 'serial', '', '', '', '',
1195 'pkgnum', 'int', '', '', '', '',
1196 'detail', 'varchar', '', $char_d, '', '',
1197 'detailtype', 'char', '', 1, '', '', # "I"nvoice or "C"omment
1198 'weight', 'int', '', '', '', '',
1200 'primary_key' => 'pkgdetailnum',
1202 'index' => [ [ 'pkgnum', 'detailtype' ] ],
1205 'cust_pkg_reason' => {
1207 'num', 'serial', '', '', '', '',
1208 'pkgnum', 'int', '', '', '', '',
1209 'reasonnum','int', '', '', '', '',
1210 'action', 'char', 'NULL', 1, '', '', #should not be nullable
1211 'otaker', 'varchar', '', 32, '', '',
1212 'date', @date_type, '', '',
1214 'primary_key' => 'num',
1216 'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1221 'refundnum', 'serial', '', '', '', '',
1222 'custnum', 'int', '', '', '', '',
1223 '_date', @date_type, '', '',
1224 'refund', @money_type, '', '',
1225 'otaker', 'varchar', '', 32, '', '',
1226 'reason', 'varchar', '', $char_d, '', '',
1227 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
1228 # be index into payby
1230 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
1231 'paymask', 'varchar', 'NULL', $char_d, '', '',
1232 'paybatch', 'varchar', 'NULL', $char_d, '', '',
1233 'closed', 'char', 'NULL', 1, '', '',
1235 'primary_key' => 'refundnum',
1237 'index' => [ ['custnum'], ['_date'] ],
1240 'cust_credit_refund' => {
1242 'creditrefundnum', 'serial', '', '', '', '',
1243 'crednum', 'int', '', '', '', '',
1244 'refundnum', 'int', '', '', '', '',
1245 'amount', @money_type, '', '',
1246 '_date', @date_type, '', '',
1248 'primary_key' => 'creditrefundnum',
1250 'index' => [ ['crednum'], ['refundnum'] ],
1256 'svcnum', 'serial', '', '', '', '',
1257 'pkgnum', 'int', 'NULL', '', '', '',
1258 'svcpart', 'int', '', '', '', '',
1259 'overlimit', @date_type, '', '',
1261 'primary_key' => 'svcnum',
1263 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1266 'cust_svc_option' => {
1268 'optionnum', 'serial', '', '', '', '',
1269 'svcnum', 'int', '', '', '', '',
1270 'optionname', 'varchar', '', $char_d, '', '',
1271 'optionvalue', 'text', 'NULL', '', '', '',
1273 'primary_key' => 'optionnum',
1275 'index' => [ [ 'svcnum' ], [ 'optionname' ] ],
1280 'pkgpart', 'serial', '', '', '', '',
1281 'pkg', 'varchar', '', $char_d, '', '',
1282 'comment', 'varchar', '', $char_d, '', '',
1283 'promo_code', 'varchar', 'NULL', $char_d, '', '',
1284 'setup', @perl_type, '', '',
1285 'freq', 'varchar', '', $char_d, '', '', #billing frequency
1286 'recur', @perl_type, '', '',
1287 'setuptax', 'char', 'NULL', 1, '', '',
1288 'recurtax', 'char', 'NULL', 1, '', '',
1289 'plan', 'varchar', 'NULL', $char_d, '', '',
1290 'plandata', 'text', 'NULL', '', '', '',
1291 'disabled', 'char', 'NULL', 1, '', '',
1292 'custom', 'char', 'NULL', 1, '', '',
1293 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1294 'classnum', 'int', 'NULL', '', '', '',
1295 'taxproductnum', 'int', 'NULL', '', '', '',
1296 'setup_cost', @money_typen, '', '',
1297 'recur_cost', @money_typen, '', '',
1298 'pay_weight', 'real', 'NULL', '', '', '',
1299 'credit_weight', 'real', 'NULL', '', '', '',
1300 'agentnum', 'int', 'NULL', '', '', '',
1303 'primary_key' => 'pkgpart',
1305 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1308 'part_pkg_link' => {
1310 'pkglinknum', 'serial', '', '', '', '',
1311 'src_pkgpart', 'int', '', '', '', '',
1312 'dst_pkgpart', 'int', '', '', '', '',
1313 'link_type', 'varchar', '', $char_d, '', '',
1314 'hidden', 'char', 'NULL', 1, '', '',
1316 'primary_key' => 'pkglinknum',
1317 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1318 'index' => [ [ 'src_pkgpart' ] ],
1320 # XXX somewhat borked unique: we don't really want a hidden and unhidden
1321 # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1323 'part_pkg_taxclass' => {
1325 'taxclassnum', 'serial', '', '', '', '',
1326 'taxclass', 'varchar', '', $char_d, '', '',
1327 'disabled', 'char', 'NULL', 1, '', '',
1329 'primary_key' => 'taxclassnum',
1330 'unique' => [ [ 'taxclass' ] ],
1331 'index' => [ [ 'disabled' ] ],
1334 'part_pkg_taxproduct' => {
1336 'taxproductnum', 'serial', '', '', '', '',
1337 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1338 'taxproduct', 'varchar', '', $char_d, '', '',
1339 'description', 'varchar', '', 3*$char_d, '', '',
1341 'primary_key' => 'taxproductnum',
1342 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1346 'part_pkg_taxrate' => {
1348 'pkgtaxratenum', 'serial', '', '', '', '',
1349 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1350 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1351 'taxproductnum', 'int', '', '', '', '',
1352 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1353 'county', 'varchar', 'NULL', $char_d, '', '',
1354 'state', 'varchar', 'NULL', $char_d, '', '',
1355 'local', 'varchar', 'NULL', $char_d, '', '',
1356 'country', 'char', 'NULL', 2, '', '',
1357 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1358 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1359 'taxclassnum', 'int', 'NULL', '', '', '',
1360 'effdate', @date_type, '', '',
1361 'taxable', 'char', 'NULL', 1, '', '',
1363 'primary_key' => 'pkgtaxratenum',
1365 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1368 'part_pkg_taxoverride' => {
1370 'taxoverridenum', 'serial', '', '', '', '',
1371 'pkgpart', 'int', '', '', '', '',
1372 'taxclassnum', 'int', '', '', '', '',
1373 'usage_class', 'varchar', 'NULL', $char_d, '', '',
1375 'primary_key' => 'taxoverridenum',
1377 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1382 # 'titlenum', 'int', '', '',
1383 # 'title', 'varchar', '', $char_d,
1385 # 'primary_key' => 'titlenum',
1386 # 'unique' => [ [] ],
1387 # 'index' => [ [] ],
1392 'pkgsvcnum', 'serial', '', '', '', '',
1393 'pkgpart', 'int', '', '', '', '',
1394 'svcpart', 'int', '', '', '', '',
1395 'quantity', 'int', '', '', '', '',
1396 'primary_svc','char', 'NULL', 1, '', '',
1398 'primary_key' => 'pkgsvcnum',
1399 'unique' => [ ['pkgpart', 'svcpart'] ],
1400 'index' => [ ['pkgpart'], ['quantity'] ],
1403 'part_referral' => {
1405 'refnum', 'serial', '', '', '', '',
1406 'referral', 'varchar', '', $char_d, '', '',
1407 'disabled', 'char', 'NULL', 1, '', '',
1408 'agentnum', 'int', 'NULL', '', '', '',
1410 'primary_key' => 'refnum',
1412 'index' => [ ['disabled'], ['agentnum'], ],
1417 'svcpart', 'serial', '', '', '', '',
1418 'svc', 'varchar', '', $char_d, '', '',
1419 'svcdb', 'varchar', '', $char_d, '', '',
1420 'disabled', 'char', 'NULL', 1, '', '',
1422 'primary_key' => 'svcpart',
1424 'index' => [ [ 'disabled' ] ],
1427 'part_svc_column' => {
1429 'columnnum', 'serial', '', '', '', '',
1430 'svcpart', 'int', '', '', '', '',
1431 'columnname', 'varchar', '', 64, '', '',
1432 'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1433 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1434 'columnflag', 'char', 'NULL', 1, '', '',
1436 'primary_key' => 'columnnum',
1437 'unique' => [ [ 'svcpart', 'columnname' ] ],
1438 'index' => [ [ 'svcpart' ] ],
1441 #(this should be renamed to part_pop)
1444 'popnum', 'serial', '', '', '', '',
1445 'city', 'varchar', '', $char_d, '', '',
1446 'state', 'varchar', '', $char_d, '', '',
1447 'ac', 'char', '', 3, '', '',
1448 'exch', 'char', '', 3, '', '',
1449 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1451 'primary_key' => 'popnum',
1453 'index' => [ [ 'state' ] ],
1456 'part_pop_local' => {
1458 'localnum', 'serial', '', '', '', '',
1459 'popnum', 'int', '', '', '', '',
1460 'city', 'varchar', 'NULL', $char_d, '', '',
1461 'state', 'char', 'NULL', 2, '', '',
1462 'npa', 'char', '', 3, '', '',
1463 'nxx', 'char', '', 3, '', '',
1465 'primary_key' => 'localnum',
1467 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1472 'svcnum', 'int', '', '', '', '',
1473 'username', 'varchar', '', $username_len, '', '',
1474 '_password', 'varchar', 'NULL', 512, '', '',
1475 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1476 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1477 'popnum', 'int', 'NULL', '', '', '',
1478 'uid', 'int', 'NULL', '', '', '',
1479 'gid', 'int', 'NULL', '', '', '',
1480 'finger', 'varchar', 'NULL', $char_d, '', '',
1481 'dir', 'varchar', 'NULL', $char_d, '', '',
1482 'shell', 'varchar', 'NULL', $char_d, '', '',
1483 'quota', 'varchar', 'NULL', $char_d, '', '',
1484 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1485 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1486 'seconds_threshold', 'int', 'NULL', '', '', '',
1487 'upbytes', 'bigint', 'NULL', '', '', '',
1488 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1489 'downbytes', 'bigint', 'NULL', '', '', '',
1490 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1491 'totalbytes','bigint', 'NULL', '', '', '',
1492 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1493 'domsvc', 'int', '', '', '', '',
1494 'pbxsvc', 'int', 'NULL', '', '', '',
1495 'last_login', @date_type, '', '',
1496 'last_logout', @date_type, '', '',
1497 #communigate pro fields (quota = MaxAccountSize)
1498 'cgp_aliases', 'varchar', 'NULL', 255, '', '',
1500 'cgp_type', 'varchar', 'NULL', $char_d, '', '', #AccountType
1501 'file_quota', 'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1502 'file_maxnum', 'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1503 'file_maxsize', 'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1504 'cgp_accessmodes', 'varchar', 'NULL', 255, '', '', #AccessModes
1505 'password_selfchange','char', 'NULL', 1, '', '', #PWDAllowed
1506 'password_recover', 'char', 'NULL', 1, 'Y','', #PasswordRecovery
1507 'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1508 'cgp_rpopallowed', 'char', 'NULL', 1, '', '', #RPOPAllowed
1509 'cgp_mailtoall', 'char', 'NULL', 1, '', '', #MailToAll
1510 'cgp_addmailtrailer', 'char', 'NULL', 1, '', '', #AddMailTrailer
1511 #XXX archive messages, mailing lists
1513 'cgp_deletemode', 'varchar', 'NULL', $char_d, '', '',#DeleteMode
1514 'cgp_emptytrash', 'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1515 'cgp_language', 'varchar', 'NULL', $char_d, '', '',#Language
1516 'cgp_timezone', 'varchar', 'NULL', $char_d, '', '',#TimeZone
1517 'cgp_skinname', 'varchar', 'NULL', $char_d, '', '',#SkinName
1518 'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1519 'cgp_sendmdnmode', 'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1521 #vacation message, redirect all mail, mail rules
1524 'primary_key' => 'svcnum',
1525 #'unique' => [ [ 'username', 'domsvc' ] ],
1527 'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1530 'acct_rt_transaction' => {
1532 'svcrtid', 'int', '', '', '', '',
1533 'svcnum', 'int', '', '', '', '',
1534 'transaction_id', 'int', '', '', '', '',
1535 '_date', @date_type, '', '',
1536 'seconds', 'int', '', '', '', '', #uhhhh
1537 'support', 'int', '', '', '', '',
1539 'primary_key' => 'svcrtid',
1541 'index' => [ ['svcnum', 'transaction_id'] ],
1546 # 'svcnum', 'int', '', '',
1547 # 'amount', @money_type,
1549 # 'primary_key' => 'svcnum',
1550 # 'unique' => [ [] ],
1551 # 'index' => [ [] ],
1556 'svcnum', 'int', '', '', '', '',
1557 'domain', 'varchar', '', $char_d, '', '',
1558 'suffix', 'varchar', 'NULL', $char_d, '', '',
1559 'catchall', 'int', 'NULL', '', '', '',
1560 'parent_svcnum', 'int', 'NULL', '', '', '',
1561 'registrarnum', 'int', 'NULL', '', '', '',
1562 'registrarkey', 'varchar', 'NULL', 512, '', '',
1563 'setup_date', @date_type, '', '',
1564 'renewal_interval', 'int', 'NULL', '', '', '',
1565 'expiration_date', @date_type, '', '',
1566 #communigate pro fields (quota = MaxAccountSize)
1567 'max_accounts', 'int', 'NULL', '', '', '',
1568 'trailer', 'text', 'NULL', '', '', '',
1569 'cgp_aliases', 'varchar', 'NULL', 255, '', '',
1570 'cgp_accessmodes','varchar','NULL', 255, '', '', #DomainAccessModes
1572 'acct_def_password_selfchange', 'char', 'NULL', 1, '', '',
1573 'acct_def_password_recover', 'char', 'NULL', 1, 'Y', '',
1574 'acct_def_cgp_accessmodes', 'varchar', 'NULL', 255, '', '',
1575 'acct_def_quota', 'varchar', 'NULL', $char_d, '', '',
1576 'acct_def_file_quota', 'varchar', 'NULL', $char_d, '', '',
1577 'acct_def_file_maxnum', 'varchar', 'NULL', $char_d, '', '',
1578 'acct_def_file_maxsize', 'varchar', 'NULL', $char_d, '', '',
1579 'acct_def_cgp_rulesallowed', 'varchar', 'NULL', $char_d, '', '',
1580 'acct_def_cgp_rpopallowed', 'char', 'NULL', 1, '', '',
1581 'acct_def_cgp_mailtoall', 'char', 'NULL', 1, '', '',
1582 'acct_def_cgp_addmailtrailer', 'char', 'NULL', 1, '', '',
1583 #XXX archive messages
1585 'acct_def_cgp_deletemode', 'varchar', 'NULL', $char_d, '', '',
1586 'acct_def_cgp_emptytrash', 'varchar', 'NULL', $char_d, '', '',
1587 'acct_def_cgp_language', 'varchar', 'NULL', $char_d, '', '',
1588 'acct_def_cgp_timezone', 'varchar', 'NULL', $char_d, '', '',
1589 'acct_def_cgp_skinname', 'varchar', 'NULL', $char_d, '', '',
1590 'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',
1591 'acct_def_cgp_sendmdnmode', 'varchar', 'NULL', $char_d, '', '',
1593 #XXX rules, archive rule, spam foldering rule(s)
1595 'primary_key' => 'svcnum',
1597 'index' => [ ['domain'] ],
1600 'domain_record' => {
1602 'recnum', 'serial', '', '', '', '',
1603 'svcnum', 'int', '', '', '', '',
1604 'reczone', 'varchar', '', 255, '', '',
1605 'recaf', 'char', '', 2, '', '',
1606 'rectype', 'varchar', '', 5, '', '',
1607 'recdata', 'varchar', '', 255, '', '',
1609 'primary_key' => 'recnum',
1611 'index' => [ ['svcnum'] ],
1616 'registrarnum', 'serial', '', '', '', '',
1617 'registrarname', 'varchar', '', $char_d, '', '',
1619 'primary_key' => 'registrarnum',
1626 'rulenum', 'serial', '', '', '', '',
1627 'name', 'varchar', '', $char_d, '', '',
1628 'comment', 'varchar', 'NULL', $char_d, '', '',
1629 'svcnum', 'int', '', '', '', '',
1630 'priority', 'int', '', '', '', '',
1632 'primary_key' => 'rulenum',
1634 'index' => [ [ 'svcnum' ] ],
1637 'cgp_rule_condition' => {
1639 'ruleconditionnum', 'serial', '', '', '', '',
1640 'condition', 'varchar', '', $char_d, '', '',
1641 'op', 'varchar', 'NULL', $char_d, '', '',
1642 'params', 'varchar', 'NULL', 255, '', '',
1643 'rulenum', 'int', '', '', '', '',
1645 'primary_key' => 'ruleconditionnum',
1647 'index' => [ [ 'rulenum' ] ],
1650 'cgp_rule_action' => {
1652 'ruleactionnum', 'serial', '', '', '', '',
1653 'action', 'varchar', '', $char_d, '', '',
1654 'params', 'varchar', 'NULL', 255, '', '',
1655 'rulenum', 'int', '', '', '', '',
1657 'primary_key' => 'ruleactionnum',
1659 'index' => [ [ 'rulenum' ] ],
1664 'svcnum', 'int', '', '', '', '',
1665 'srcsvc', 'int', 'NULL', '', '', '',
1666 'src', 'varchar', 'NULL', 255, '', '',
1667 'dstsvc', 'int', 'NULL', '', '', '',
1668 'dst', 'varchar', 'NULL', 255, '', '',
1670 'primary_key' => 'svcnum',
1672 'index' => [ ['srcsvc'], ['dstsvc'] ],
1677 'svcnum', 'int', '', '', '', '',
1678 'recnum', 'int', '', '', '', '',
1679 'usersvc', 'int', 'NULL', '', '', '',
1680 'config', 'text', 'NULL', '', '', '',
1682 'primary_key' => 'svcnum',
1689 # 'svcnum', 'int', '', '',
1690 # 'svcnum', 'int', '', '',
1691 # 'svcnum', 'int', '', '',
1692 # 'worker', 'varchar', '', $char_d,
1693 # '_date', @date_type,
1695 # 'primary_key' => 'svcnum',
1696 # 'unique' => [ [] ],
1697 # 'index' => [ [] ],
1700 'prepay_credit' => {
1702 'prepaynum', 'serial', '', '', '', '',
1703 'identifier', 'varchar', '', $char_d, '', '',
1704 'amount', @money_type, '', '',
1705 'seconds', 'int', 'NULL', '', '', '',
1706 'upbytes', 'bigint', 'NULL', '', '', '',
1707 'downbytes', 'bigint', 'NULL', '', '', '',
1708 'totalbytes', 'bigint', 'NULL', '', '', '',
1709 'agentnum', 'int', 'NULL', '', '', '',
1711 'primary_key' => 'prepaynum',
1712 'unique' => [ ['identifier'] ],
1718 'portnum', 'serial', '', '', '', '',
1719 'ip', 'varchar', 'NULL', 15, '', '',
1720 'nasport', 'int', 'NULL', '', '', '',
1721 'nasnum', 'int', '', '', '', '',
1723 'primary_key' => 'portnum',
1730 'nasnum', 'serial', '', '', '', '',
1731 'nas', 'varchar', '', $char_d, '', '',
1732 'nasip', 'varchar', '', 15, '', '',
1733 'nasfqdn', 'varchar', '', $char_d, '', '',
1734 'last', 'int', '', '', '', '',
1736 'primary_key' => 'nasnum',
1737 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1738 'index' => [ [ 'last' ] ],
1743 # 'sessionnum', 'serial', '', '', '', '',
1744 # 'portnum', 'int', '', '', '', '',
1745 # 'svcnum', 'int', '', '', '', '',
1746 # 'login', @date_type, '', '',
1747 # 'logout', @date_type, '', '',
1749 # 'primary_key' => 'sessionnum',
1751 # 'index' => [ [ 'portnum' ] ],
1756 'jobnum', 'serial', '', '', '', '',
1757 'job', 'varchar', '', 512, '', '',
1758 '_date', 'int', '', '', '', '',
1759 'status', 'varchar', '', $char_d, '', '',
1760 'statustext', 'text', 'NULL', '', '', '',
1761 'svcnum', 'int', 'NULL', '', '', '',
1762 'custnum', 'int', 'NULL', '', '', '',
1763 'secure', 'char', 'NULL', 1, '', '',
1764 'priority', 'int', 'NULL', '', '', '',
1766 'primary_key' => 'jobnum',
1768 'index' => [ [ 'secure' ], [ 'priority' ],
1769 [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1775 'argnum', 'serial', '', '', '', '',
1776 'jobnum', 'int', '', '', '', '',
1777 'frozen', 'char', 'NULL', 1, '', '',
1778 'arg', 'text', 'NULL', '', '', '',
1780 'primary_key' => 'argnum',
1782 'index' => [ [ 'jobnum' ] ],
1787 'dependnum', 'serial', '', '', '', '',
1788 'jobnum', 'int', '', '', '', '',
1789 'depend_jobnum', 'int', '', '', '', '',
1791 'primary_key' => 'dependnum',
1793 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1798 'exportsvcnum' => 'serial', '', '', '', '',
1799 'exportnum' => 'int', '', '', '', '',
1800 'svcpart' => 'int', '', '', '', '',
1802 'primary_key' => 'exportsvcnum',
1803 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1804 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1807 'export_device' => {
1809 'exportdevicenum' => 'serial', '', '', '', '',
1810 'exportnum' => 'int', '', '', '', '',
1811 'devicepart' => 'int', '', '', '', '',
1813 'primary_key' => 'exportdevicenum',
1814 'unique' => [ [ 'exportnum', 'devicepart' ] ],
1815 'index' => [ [ 'exportnum' ], [ 'devicepart' ] ],
1820 'exportnum', 'serial', '', '', '', '',
1821 'machine', 'varchar', '', $char_d, '', '',
1822 'exporttype', 'varchar', '', $char_d, '', '',
1823 'nodomain', 'char', 'NULL', 1, '', '',
1825 'primary_key' => 'exportnum',
1827 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1830 'part_export_option' => {
1832 'optionnum', 'serial', '', '', '', '',
1833 'exportnum', 'int', '', '', '', '',
1834 'optionname', 'varchar', '', $char_d, '', '',
1835 'optionvalue', 'text', 'NULL', '', '', '',
1837 'primary_key' => 'optionnum',
1839 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1842 'radius_usergroup' => {
1844 'usergroupnum', 'serial', '', '', '', '',
1845 'svcnum', 'int', '', '', '', '',
1846 'groupname', 'varchar', '', $char_d, '', '',
1848 'primary_key' => 'usergroupnum',
1850 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1855 'msgnum', 'serial', '', '', '', '',
1856 'msgcode', 'varchar', '', $char_d, '', '',
1857 'locale', 'varchar', '', 16, '', '',
1858 'msg', 'text', '', '', '', '',
1860 'primary_key' => 'msgnum',
1861 'unique' => [ [ 'msgcode', 'locale' ] ],
1865 'cust_tax_exempt' => {
1867 'exemptnum', 'serial', '', '', '', '',
1868 'custnum', 'int', '', '', '', '',
1869 'taxnum', 'int', '', '', '', '',
1870 'year', 'int', '', '', '', '',
1871 'month', 'int', '', '', '', '',
1872 'amount', @money_type, '', '',
1874 'primary_key' => 'exemptnum',
1875 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1879 'cust_tax_exempt_pkg' => {
1881 'exemptpkgnum', 'serial', '', '', '', '',
1882 #'custnum', 'int', '', '', '', ''
1883 'billpkgnum', 'int', '', '', '', '',
1884 'taxnum', 'int', '', '', '', '',
1885 'year', 'int', '', '', '', '',
1886 'month', 'int', '', '', '', '',
1887 'amount', @money_type, '', '',
1889 'primary_key' => 'exemptpkgnum',
1891 'index' => [ [ 'taxnum', 'year', 'month' ],
1899 'routernum', 'serial', '', '', '', '',
1900 'routername', 'varchar', '', $char_d, '', '',
1901 'svcnum', 'int', 'NULL', '', '', '',
1902 'agentnum', 'int', 'NULL', '', '', '',
1904 'primary_key' => 'routernum',
1909 'part_svc_router' => {
1911 'svcrouternum', 'serial', '', '', '', '',
1912 'svcpart', 'int', '', '', '', '',
1913 'routernum', 'int', '', '', '', '',
1915 'primary_key' => 'svcrouternum',
1922 'blocknum', 'serial', '', '', '', '',
1923 'routernum', 'int', '', '', '', '',
1924 'ip_gateway', 'varchar', '', 15, '', '',
1925 'ip_netmask', 'int', '', '', '', '',
1926 'agentnum', 'int', 'NULL', '', '', '',
1927 'manual_flag', 'char', 'NULL', 1, '', '',
1929 'primary_key' => 'blocknum',
1930 'unique' => [ [ 'blocknum', 'routernum' ] ],
1934 'svc_broadband' => {
1936 'svcnum', 'int', '', '', '', '',
1937 'description', 'varchar', 'NULL', $char_d, '', '',
1938 'blocknum', 'int', 'NULL', '', '', '',
1939 'speed_up', 'int', '', '', '', '',
1940 'speed_down', 'int', '', '', '', '',
1941 'ip_addr', 'varchar', 'NULL', 15, '', '',
1942 'mac_addr', 'varchar', 'NULL', 12, '', '',
1943 'authkey', 'varchar', 'NULL', 32, '', '',
1944 'latitude', 'decimal', 'NULL', '', '', '',
1945 'longitude', 'decimal', 'NULL', '', '', '',
1946 'altitude', 'decimal', 'NULL', '', '', '',
1947 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1948 'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1950 'primary_key' => 'svcnum',
1951 'unique' => [ [ 'mac_addr' ] ],
1955 'part_virtual_field' => {
1957 'vfieldpart', 'serial', '', '', '', '',
1958 'dbtable', 'varchar', '', 32, '', '',
1959 'name', 'varchar', '', 32, '', '',
1960 'check_block', 'text', 'NULL', '', '', '',
1961 'length', 'int', 'NULL', '', '', '',
1962 'list_source', 'text', 'NULL', '', '', '',
1963 'label', 'varchar', 'NULL', 80, '', '',
1965 'primary_key' => 'vfieldpart',
1970 'virtual_field' => {
1972 'vfieldnum', 'serial', '', '', '', '',
1973 'recnum', 'int', '', '', '', '',
1974 'vfieldpart', 'int', '', '', '', '',
1975 'value', 'varchar', '', 128, '', '',
1977 'primary_key' => 'vfieldnum',
1978 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1984 'snarfnum', 'int', '', '', '', '',
1985 'svcnum', 'int', '', '', '', '',
1986 'machine', 'varchar', '', 255, '', '',
1987 'protocol', 'varchar', '', $char_d, '', '',
1988 'username', 'varchar', '', $char_d, '', '',
1989 '_password', 'varchar', '', $char_d, '', '',
1991 'primary_key' => 'snarfnum',
1993 'index' => [ [ 'svcnum' ] ],
1998 'svcnum', 'int', '', '', '', '',
1999 'id', 'int', 'NULL', '', '', '',
2000 'title', 'varchar', 'NULL', $char_d, '', '',
2002 'primary_key' => 'svcnum',
2007 'cust_pay_refund' => {
2009 'payrefundnum', 'serial', '', '', '', '',
2010 'paynum', 'int', '', '', '', '',
2011 'refundnum', 'int', '', '', '', '',
2012 '_date', @date_type, '', '',
2013 'amount', @money_type, '', '',
2015 'primary_key' => 'payrefundnum',
2017 'index' => [ ['paynum'], ['refundnum'] ],
2020 'part_pkg_option' => {
2022 'optionnum', 'serial', '', '', '', '',
2023 'pkgpart', 'int', '', '', '', '',
2024 'optionname', 'varchar', '', $char_d, '', '',
2025 'optionvalue', 'text', 'NULL', '', '', '',
2027 'primary_key' => 'optionnum',
2029 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
2032 'part_pkg_report_option' => {
2034 'num', 'serial', '', '', '', '',
2035 'name', 'varchar', '', $char_d, '', '',
2036 'disabled', 'char', 'NULL', 1, '', '',
2038 'primary_key' => 'num',
2039 'unique' => [ [ 'name' ] ],
2040 'index' => [ [ 'disabled' ] ],
2045 'ratenum', 'serial', '', '', '', '',
2046 'ratename', 'varchar', '', $char_d, '', '',
2048 'primary_key' => 'ratenum',
2055 'ratedetailnum', 'serial', '', '', '', '',
2056 'ratenum', 'int', '', '', '', '',
2057 'orig_regionnum', 'int', 'NULL', '', '', '',
2058 'dest_regionnum', 'int', '', '', '', '',
2059 'min_included', 'int', '', '', '', '',
2060 'conn_charge', @money_type, '0', '', #'decimal','','10,5','0','',
2061 'conn_sec', 'int', '', '', '0', '',
2062 'min_charge', 'decimal', '', '10,5', '', '', #@money_type, '', '',
2063 'sec_granularity', 'int', '', '', '', '',
2064 #time period (link to table of periods)?
2065 'classnum', 'int', 'NULL', '', '', '',
2067 'primary_key' => 'ratedetailnum',
2068 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2069 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
2074 'regionnum', 'serial', '', '', '', '',
2075 'regionname', 'varchar', '', $char_d, '', '',
2077 'primary_key' => 'regionnum',
2084 'prefixnum', 'serial', '', '', '', '',
2085 'regionnum', 'int', '', '', '', '',
2086 'countrycode', 'varchar', '', 3, '', '',
2087 'npa', 'varchar', 'NULL', 10, '', '', #actually the whole prefix
2088 'nxx', 'varchar', 'NULL', 3, '', '', #actually not used
2090 'primary_key' => 'prefixnum',
2092 'index' => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2097 'classnum', 'serial', '', '', '', '',
2098 'weight', 'int', 'NULL', '', '', '',
2099 'classname', 'varchar', '', $char_d, '', '',
2100 'format', 'varchar', 'NULL', $char_d, '', '',
2101 'disabled', 'char', 'NULL', 1, '', '',
2103 'primary_key' => 'classnum',
2105 'index' => [ ['disabled'] ],
2110 'codenum', 'serial', '', '', '', '',
2111 'code', 'varchar', '', $char_d, '', '',
2112 'agentnum', 'int', '', '', '', '',
2114 'primary_key' => 'codenum',
2115 'unique' => [ [ 'agentnum', 'code' ] ],
2116 'index' => [ [ 'agentnum' ] ],
2121 'codepkgnum', 'serial', '', '', '', '',
2122 'codenum', 'int', '', '', '', '',
2123 'pkgpart', 'int', '', '', '', '',
2125 'primary_key' => 'codepkgnum',
2126 'unique' => [ [ 'codenum', 'pkgpart' ] ],
2127 'index' => [ [ 'codenum' ] ],
2130 'clientapi_session' => {
2132 'sessionnum', 'serial', '', '', '', '',
2133 'sessionid', 'varchar', '', $char_d, '', '',
2134 'namespace', 'varchar', '', $char_d, '', '',
2136 'primary_key' => 'sessionnum',
2137 'unique' => [ [ 'sessionid', 'namespace' ] ],
2141 'clientapi_session_field' => {
2143 'fieldnum', 'serial', '', '', '', '',
2144 'sessionnum', 'int', '', '', '', '',
2145 'fieldname', 'varchar', '', $char_d, '', '',
2146 'fieldvalue', 'text', 'NULL', '', '', '',
2148 'primary_key' => 'fieldnum',
2149 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
2153 'payment_gateway' => {
2155 'gatewaynum', 'serial', '', '', '', '',
2156 'gateway_namespace','varchar', 'NULL', $char_d, '', '',
2157 'gateway_module', 'varchar', '', $char_d, '', '',
2158 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
2159 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
2160 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
2161 'gateway_callback_url', 'varchar', 'NULL', $char_d, '', '',
2162 'disabled', 'char', 'NULL', 1, '', '',
2164 'primary_key' => 'gatewaynum',
2166 'index' => [ [ 'disabled' ] ],
2169 'payment_gateway_option' => {
2171 'optionnum', 'serial', '', '', '', '',
2172 'gatewaynum', 'int', '', '', '', '',
2173 'optionname', 'varchar', '', $char_d, '', '',
2174 'optionvalue', 'text', 'NULL', '', '', '',
2176 'primary_key' => 'optionnum',
2178 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2181 'agent_payment_gateway' => {
2183 'agentgatewaynum', 'serial', '', '', '', '',
2184 'agentnum', 'int', '', '', '', '',
2185 'gatewaynum', 'int', '', '', '', '',
2186 'cardtype', 'varchar', 'NULL', $char_d, '', '',
2187 'taxclass', 'varchar', 'NULL', $char_d, '', '',
2189 'primary_key' => 'agentgatewaynum',
2191 'index' => [ [ 'agentnum', 'cardtype' ], ],
2196 'bannum', 'serial', '', '', '', '',
2197 'payby', 'char', '', 4, '', '',
2198 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
2199 #'paymask', 'varchar', 'NULL', $char_d, '', ''
2200 '_date', @date_type, '', '',
2201 'otaker', 'varchar', '', 32, '', '',
2202 'reason', 'varchar', 'NULL', $char_d, '', '',
2204 'primary_key' => 'bannum',
2205 'unique' => [ [ 'payby', 'payinfo' ] ],
2211 'categorynum', 'serial', '', '', '', '',
2212 'categoryname', 'varchar', '', $char_d, '', '',
2213 'weight', 'int', 'NULL', '', '', '',
2214 'condense', 'char', 'NULL', 1, '', '',
2215 'disabled', 'char', 'NULL', 1, '', '',
2217 'primary_key' => 'categorynum',
2219 'index' => [ ['disabled'] ],
2224 'classnum', 'serial', '', '', '', '',
2225 'classname', 'varchar', '', $char_d, '', '',
2226 'categorynum', 'int', 'NULL', '', '', '',
2227 'disabled', 'char', 'NULL', 1, '', '',
2229 'primary_key' => 'classnum',
2231 'index' => [ ['disabled'] ],
2236 # qw( name type null length default local );
2242 'acctid', 'bigserial', '', '', '', '',
2243 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2244 'calldate', 'timestamp', '', '', \'now()', '',
2245 'clid', 'varchar', '', $char_d, \"''", '',
2246 'src', 'varchar', '', $char_d, \"''", '',
2247 'dst', 'varchar', '', $char_d, \"''", '',
2248 'dcontext', 'varchar', '', $char_d, \"''", '',
2249 'channel', 'varchar', '', $char_d, \"''", '',
2250 'dstchannel', 'varchar', '', $char_d, \"''", '',
2251 'lastapp', 'varchar', '', $char_d, \"''", '',
2252 'lastdata', 'varchar', '', $char_d, \"''", '',
2254 #these don't seem to be logged by most of the SQL cdr_* modules
2255 #except tds under sql-illegal names, so;
2256 # ... don't rely on them for rating?
2257 # and, what they hey, i went ahead and changed the names and data types
2258 # to freeside-style dates...
2259 #'start', 'timestamp', 'NULL', '', '', '',
2260 #'answer', 'timestamp', 'NULL', '', '', '',
2261 #'end', 'timestamp', 'NULL', '', '', '',
2262 'startdate', @date_type, '', '',
2263 'answerdate', @date_type, '', '',
2264 'enddate', @date_type, '', '',
2267 'duration', 'int', '', '', 0, '',
2268 'billsec', 'int', '', '', 0, '',
2269 'disposition', 'varchar', '', 45, \"''", '',
2270 'amaflags', 'int', '', '', 0, '',
2271 'accountcode', 'varchar', '', 20, \"''", '',
2272 'uniqueid', 'varchar', '', 32, \"''", '',
2273 'userfield', 'varchar', '', 255, \"''", '',
2276 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2278 # though these are now used elsewhere:
2279 # charged_party, upstream_price, rated_price, carrierid
2282 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2283 'cdrtypenum', 'int', 'NULL', '', '', '',
2285 'charged_party', 'varchar', 'NULL', $char_d, '', '',
2287 'upstream_currency', 'char', 'NULL', 3, '', '',
2288 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
2289 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
2291 # how it was rated internally...
2292 'ratedetailnum', 'int', 'NULL', '', '', '',
2293 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2295 'distance', 'decimal', 'NULL', '', '', '',
2296 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
2298 #cdr_calltype: the big list in appendix 2
2299 'calltypenum', 'int', 'NULL', '', '', '',
2301 'description', 'varchar', 'NULL', $char_d, '', '',
2302 'quantity', 'int', 'NULL', '', '', '',
2304 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2305 'carrierid', 'int', 'NULL', '', '', '',
2307 'upstream_rateid', 'int', 'NULL', '', '', '',
2310 #and now for our own fields
2313 # a svcnum... right..?
2314 'svcnum', 'int', 'NULL', '', '', '',
2316 #NULL, done (or something)
2317 'freesidestatus', 'varchar', 'NULL', 32, '', '',
2319 #NULL, done (or something)
2320 'freesiderewritestatus', 'varchar', 'NULL', 32, '', '',
2322 #an indexed place to put big numbers
2323 'cdrid', 'bigint', 'NULL', '', '', '',
2326 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2328 'cdrbatchnum', 'int', 'NULL', '', '', '',
2331 'primary_key' => 'acctid',
2333 'index' => [ [ 'calldate' ],
2334 [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2335 [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2336 [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2337 [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2343 'cdrbatchnum', 'serial', '', '', '', '',
2344 'cdrbatch', 'varchar', 'NULL', 255, '', '',
2345 '_date', @date_type, '', '',
2347 'primary_key' => 'cdrbatchnum',
2348 'unique' => [ [ 'cdrbatch' ] ],
2352 'cdr_termination' => {
2354 'cdrtermnum', 'bigserial', '', '', '', '',
2355 'acctid', 'bigint', '', '', '', '',
2356 'termpart', 'int', '', '', '', '',#future use see below
2357 'rated_price', 'decimal', 'NULL', '10,4', '', '',
2358 'status', 'varchar', 'NULL', 32, '', '',
2360 'primary_key' => 'cdrtermnum',
2361 'unique' => [ [ 'acctid', 'termpart' ] ],
2362 'index' => [ [ 'acctid' ], [ 'status' ], ],
2365 #to handle multiple termination/settlement passes...
2366 # 'part_termination' => {
2368 # 'termpart', 'int', '', '', '', '',
2369 # 'termname', 'varchar', '', $char_d, '', '',
2370 # 'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2372 # 'primary_key' => 'termpart',
2377 #the remaining cdr_ tables are not really used
2380 'calltypenum', 'serial', '', '', '', '',
2381 'calltypename', 'varchar', '', $char_d, '', '',
2383 'primary_key' => 'calltypenum',
2390 'cdrtypenum' => 'serial', '', '', '', '',
2391 'cdrtypename' => 'varchar', '', $char_d, '', '',
2393 'primary_key' => 'cdrtypenum',
2400 'carrierid' => 'serial', '', '', '', '',
2401 'carriername' => 'varchar', '', $char_d, '', '',
2403 'primary_key' => 'carrierid',
2410 # 'filenum', 'serial', '', '', '', '',
2411 # 'filename', 'varchar', '', '', '', '',
2412 # 'status', 'varchar', 'NULL', '', '', '',
2414 # 'primary_key' => 'filenum',
2415 # 'unique' => [ [ 'filename' ], ], #just change the index if we need to
2416 # # agent-virtualize or have a customer
2417 # # with dup-filename needs or something
2418 # # (only used by cdr.http_and_import for
2423 'inventory_item' => {
2425 'itemnum', 'serial', '', '', '', '',
2426 'classnum', 'int', '', '', '', '',
2427 'item', 'varchar', '', $char_d, '', '',
2428 'svcnum', 'int', 'NULL', '', '', '',
2430 'primary_key' => 'itemnum',
2431 'unique' => [ [ 'classnum', 'item' ] ],
2432 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
2435 'inventory_class' => {
2437 'classnum', 'serial', '', '', '', '',
2438 'classname', 'varchar', '', $char_d, '', '',
2440 'primary_key' => 'classnum',
2447 'usernum', 'serial', '', '', '', '',
2448 'username', 'varchar', '', $char_d, '', '',
2449 '_password', 'varchar', '', $char_d, '', '',
2450 'last', 'varchar', '', $char_d, '', '',
2451 'first', 'varchar', '', $char_d, '', '',
2452 'user_custnum', 'int', 'NULL', '', '', '',
2453 'disabled', 'char', 'NULL', 1, '', '',
2455 'primary_key' => 'usernum',
2456 'unique' => [ [ 'username' ] ],
2457 'index' => [ [ 'user_custnum' ] ],
2460 'access_user_pref' => {
2462 'prefnum', 'serial', '', '', '', '',
2463 'usernum', 'int', '', '', '', '',
2464 'prefname', 'varchar', '', $char_d, '', '',
2465 'prefvalue', 'text', 'NULL', '', '', '',
2466 'expiration', @date_type, '', '',
2468 'primary_key' => 'prefnum',
2470 'index' => [ [ 'usernum' ] ],
2475 'groupnum', 'serial', '', '', '', '',
2476 'groupname', 'varchar', '', $char_d, '', '',
2478 'primary_key' => 'groupnum',
2479 'unique' => [ [ 'groupname' ] ],
2483 'access_usergroup' => {
2485 'usergroupnum', 'serial', '', '', '', '',
2486 'usernum', 'int', '', '', '', '',
2487 'groupnum', 'int', '', '', '', '',
2489 'primary_key' => 'usergroupnum',
2490 'unique' => [ [ 'usernum', 'groupnum' ] ],
2491 'index' => [ [ 'usernum' ] ],
2494 'access_groupagent' => {
2496 'groupagentnum', 'serial', '', '', '', '',
2497 'groupnum', 'int', '', '', '', '',
2498 'agentnum', 'int', '', '', '', '',
2500 'primary_key' => 'groupagentnum',
2501 'unique' => [ [ 'groupnum', 'agentnum' ] ],
2502 'index' => [ [ 'groupnum' ] ],
2507 'rightnum', 'serial', '', '', '', '',
2508 'righttype', 'varchar', '', $char_d, '', '',
2509 'rightobjnum', 'int', '', '', '', '',
2510 'rightname', 'varchar', '', $char_d, '', '',
2512 'primary_key' => 'rightnum',
2513 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2519 'svcnum', 'int', '', '', '', '',
2520 'countrycode', 'varchar', '', 3, '', '',
2521 'phonenum', 'varchar', '', 15, '', '', #12 ?
2522 'pin', 'varchar', 'NULL', $char_d, '', '',
2523 'sip_password', 'varchar', 'NULL', $char_d, '', '',
2524 'phone_name', 'varchar', 'NULL', $char_d, '', '',
2525 'pbxsvc', 'int', 'NULL', '', '', '',
2526 'domsvc', 'int', 'NULL', '', '', '',
2527 'locationnum', 'int', 'NULL', '', '', '',
2529 'primary_key' => 'svcnum',
2531 'index' => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
2538 'devicenum', 'serial', '', '', '', '',
2539 'devicepart', 'int', '', '', '', '',
2540 'svcnum', 'int', '', '', '', '',
2541 'mac_addr', 'varchar', 'NULL', 12, '', '',
2543 'primary_key' => 'devicenum',
2544 'unique' => [ [ 'mac_addr' ], ],
2545 'index' => [ [ 'devicepart' ], [ 'svcnum' ], ],
2550 'devicepart', 'serial', '', '', '', '',
2551 'devicename', 'varchar', '', $char_d, '', '',
2552 #'classnum', #tie to an inventory class?
2554 'primary_key' => 'devicepart',
2555 'unique' => [ [ 'devicename' ] ], #?
2561 'availnum', 'serial', '', '', '', '',
2562 'exportnum', 'int', '', '', '', '',
2563 'countrycode', 'varchar', '', 3, '', '',
2564 'state', 'char', 'NULL', 2, '', '',
2565 'npa', 'char', '', 3, '', '',
2566 'nxx', 'char', 'NULL', 3, '', '',
2567 'station', 'char', 'NULL', 4, '', '',
2568 'name', 'varchar', 'NULL', $char_d, '', '',
2569 'svcnum', 'int', 'NULL', '', '', '',
2570 'availbatch', 'varchar', 'NULL', $char_d, '', '',
2572 'primary_key' => 'availnum',
2574 'index' => [ [ 'exportnum', 'countrycode', 'state' ], #npa search
2575 [ 'exportnum', 'countrycode', 'npa' ], #nxx search
2576 [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2577 [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2585 'typenum', 'serial', '', '', '', '',
2586 'class', 'char', '', 1, '', '',
2587 'type', 'varchar', '', $char_d, '', '',
2589 'primary_key' => 'typenum',
2596 'reasonnum', 'serial', '', '', '', '',
2597 'reason_type', 'int', '', '', '', '',
2598 'reason', 'text', '', '', '', '',
2599 'disabled', 'char', 'NULL', 1, '', '',
2601 'primary_key' => 'reasonnum',
2608 'confnum', 'serial', '', '', '', '',
2609 'agentnum', 'int', 'NULL', '', '', '',
2610 'name', 'varchar', '', $char_d, '', '',
2611 'value', 'text', 'NULL', '', '', '',
2613 'primary_key' => 'confnum',
2614 'unique' => [ [ 'agentnum', 'name' ]],
2620 'pkgrefnum', 'serial', '', '', '', '',
2621 'pkgnum', 'int', '', '', '', '',
2622 'refnum', 'int', '', '', '', '',
2624 'primary_key' => 'pkgrefnum',
2625 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2626 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2631 'svcnum', 'int', '', '', '', '',
2632 'id', 'int', 'NULL', '', '', '',
2633 'title', 'varchar', 'NULL', $char_d, '', '',
2634 'max_extensions', 'int', 'NULL', '', '', '',
2636 'primary_key' => 'svcnum',
2638 'index' => [ [ 'id' ] ],
2641 'svc_mailinglist' => { #svc_group?
2643 'svcnum', 'int', '', '', '', '',
2644 'username', 'varchar', '', $username_len, '', '',
2645 'domsvc', 'int', '', '', '', '',
2646 'listnum', 'int', '', '', '', '',
2647 'reply_to', 'char', 'NULL', 1, '', '',#SetReplyTo
2648 'remove_from', 'char', 'NULL', 1, '', '',#RemoveAuthor
2649 'reject_auto', 'char', 'NULL', 1, '', '',#RejectAuto
2650 'remove_to_and_cc', 'char', 'NULL', 1, '', '',#RemoveToAndCc
2652 'primary_key' => 'svcnum',
2654 'index' => [ ['username'], ['domsvc'], ['listnum'] ],
2659 'listnum', 'serial', '', '', '', '',
2660 'listname', 'varchar', '', $char_d, '', '',
2662 'primary_key' => 'listnum',
2667 'mailinglistmember' => {
2669 'membernum', 'serial', '', '', '', '',
2670 'listnum', 'int', '', '', '', '',
2671 'svcnum', 'int', 'NULL', '', '', '',
2672 'email', 'varchar', 'NULL', 255, '', '',
2674 'primary_key' => 'membernum',
2676 'index' => [['listnum'],['svcnum'],['email']],
2680 # name type nullability length default local
2684 # 'num', 'serial', '', '', '', '',
2686 # 'primary_key' => 'num',