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 my $h_tableobj = DBIx::DBSchema::Table->new( {
196 'name' => "h_$table",
197 'primary_key' => 'historynum',
198 'indices' => \%h_indices,
199 'local_options' => $local_options,
201 DBIx::DBSchema::Column->new( {
202 'name' => 'historynum',
204 'null' => 'NOT NULL',
209 DBIx::DBSchema::Column->new( {
210 'name' => 'history_date',
217 DBIx::DBSchema::Column->new( {
218 'name' => 'history_user',
220 'null' => 'NOT NULL',
225 DBIx::DBSchema::Column->new( {
226 'name' => 'history_action',
228 'null' => 'NOT NULL',
234 my $column = $tableobj->column($_);
236 #clone so as to not disturb the original
237 $column = DBIx::DBSchema::Column->new( {
238 map { $_ => $column->$_() }
239 qw( name type null length default local )
242 if ( $column->type =~ /^(\w*)SERIAL$/i ) {
243 $column->type('int');
244 $column->null('NULL');
246 #$column->default('')
247 # if $column->default =~ /^nextval\(/i;
248 #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
249 #$column->local($local);
254 $dbdef->addtable($h_tableobj);
257 if ( $datasrc =~ /^dbi:mysql/i ) {
259 my $dup_lock_table = DBIx::DBSchema::Table->new( {
260 'name' => 'duplicate_lock',
261 'primary_key' => 'duplocknum',
262 'local_options' => $local_options,
264 DBIx::DBSchema::Column->new( {
265 'name' => 'duplocknum',
267 'null' => 'NOT NULL',
272 DBIx::DBSchema::Column->new( {
273 'name' => 'lockname',
275 'null' => 'NOT NULL',
281 'indices' => { 'duplicate_lock1' =>
282 DBIx::DBSchema::Index->new({
283 'name' => 'duplicate_lock1',
285 'columns' => [ 'lockname' ],
290 $dbdef->addtable($dup_lock_table);
300 my $char_d = 80; #default maxlength for text fields
302 #my(@date_type) = ( 'timestamp', '', '' );
303 my @date_type = ( 'int', 'NULL', '' );
304 my @perl_type = ( 'text', 'NULL', '' );
305 my @money_type = ( 'decimal', '', '10,2' );
306 my @money_typen = ( 'decimal', 'NULL', '10,2' );
308 my $username_len = 32; #usernamemax config file
310 # name type nullability length default local
316 'agentnum', 'serial', '', '', '', '',
317 'agent', 'varchar', '', $char_d, '', '',
318 'typenum', 'int', '', '', '', '',
319 'disabled', 'char', 'NULL', 1, '', '',
320 'ticketing_queueid', 'int', 'NULL', '', '', '',
321 'invoice_template', 'varchar', 'NULL', $char_d, '', '',
322 'username', 'varchar', 'NULL', $char_d, '', '', #deprecated
323 '_password', 'varchar', 'NULL', $char_d, '', '', #deprecated
324 'freq', 'int', 'NULL', '', '', '', #deprecated (never used)
325 'prog', @perl_type, '', '', #deprecated (never used)
328 'primary_key' => 'agentnum',
330 'index' => [ ['typenum'], ['disabled'] ],
335 'typenum', 'serial', '', '', '', '',
336 'atype', 'varchar', '', $char_d, '', '',
338 'primary_key' => 'typenum',
345 'typepkgnum', 'serial', '', '', '', '',
346 'typenum', 'int', '', '', '', '',
347 'pkgpart', 'int', '', '', '', '',
349 'primary_key' => 'typepkgnum',
350 'unique' => [ ['typenum', 'pkgpart'] ],
351 'index' => [ ['typenum'] ],
356 'invnum', 'serial', '', '', '', '',
357 'custnum', 'int', '', '', '', '',
358 '_date', @date_type, '', '',
359 'charged', @money_type, '', '',
360 'printed', 'int', '', '', '', '',
361 'closed', 'char', 'NULL', 1, '', '',
363 'primary_key' => 'invnum',
365 'index' => [ ['custnum'], ['_date'] ],
368 'cust_bill_event' => {
370 'eventnum', 'serial', '', '', '', '',
371 'invnum', 'int', '', '', '', '',
372 'eventpart', 'int', '', '', '', '',
373 '_date', @date_type, '', '',
374 'status', 'varchar', '', $char_d, '', '',
375 'statustext', 'text', 'NULL', '', '', '',
377 'primary_key' => 'eventnum',
378 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
380 'index' => [ ['invnum'], ['status'] ],
383 'part_bill_event' => {
385 'eventpart', 'serial', '', '', '', '',
386 'freq', 'varchar', 'NULL', $char_d, '', '',
387 'payby', 'char', '', 4, '', '',
388 'event', 'varchar', '', $char_d, '', '',
389 'eventcode', @perl_type, '', '',
390 'seconds', 'int', 'NULL', '', '', '',
391 'weight', 'int', '', '', '', '',
392 'plan', 'varchar', 'NULL', $char_d, '', '',
393 'plandata', 'text', 'NULL', '', '', '',
394 'reason', 'int', 'NULL', '', '', '',
395 'disabled', 'char', 'NULL', 1, '', '',
397 'primary_key' => 'eventpart',
399 'index' => [ ['payby'], ['disabled'], ],
404 'eventpart', 'serial', '', '', '', '',
405 'agentnum', 'int', 'NULL', '', '', '',
406 'event', 'varchar', '', $char_d, '', '',
407 'eventtable', 'varchar', '', $char_d, '', '',
408 'check_freq', 'varchar', 'NULL', $char_d, '', '',
409 'weight', 'int', '', '', '', '',
410 'action', 'varchar', '', $char_d, '', '',
411 'disabled', 'char', 'NULL', 1, '', '',
413 'primary_key' => 'eventpart',
415 'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
418 'part_event_option' => {
420 'optionnum', 'serial', '', '', '', '',
421 'eventpart', 'int', '', '', '', '',
422 'optionname', 'varchar', '', $char_d, '', '',
423 'optionvalue', 'text', 'NULL', '', '', '',
425 'primary_key' => 'optionnum',
427 'index' => [ [ 'eventpart' ], [ 'optionname' ] ],
430 'part_event_condition' => {
432 'eventconditionnum', 'serial', '', '', '', '',
433 'eventpart', 'int', '', '', '', '',
434 'conditionname', 'varchar', '', $char_d, '', '',
436 'primary_key' => 'eventconditionnum',
438 'index' => [ [ 'eventpart' ], [ 'conditionname' ] ],
441 'part_event_condition_option' => {
443 'optionnum', 'serial', '', '', '', '',
444 'eventconditionnum', 'int', '', '', '', '',
445 'optionname', 'varchar', '', $char_d, '', '',
446 'optionvalue', 'text', 'NULL', '', '', '',
448 'primary_key' => 'optionnum',
450 'index' => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
453 'part_event_condition_option_option' => {
455 'optionoptionnum', 'serial', '', '', '', '',
456 'optionnum', 'int', '', '', '', '',
457 'optionname', 'varchar', '', $char_d, '', '',
458 'optionvalue', 'text', 'NULL', '', '', '',
460 'primary_key' => 'optionoptionnum',
462 'index' => [ [ 'optionnum' ], [ 'optionname' ] ],
467 'eventnum', 'serial', '', '', '', '',
468 'eventpart', 'int', '', '', '', '',
469 'tablenum', 'int', '', '', '', '',
470 '_date', @date_type, '', '',
471 'status', 'varchar', '', $char_d, '', '',
472 'statustext', 'text', 'NULL', '', '', '',
474 'primary_key' => 'eventnum',
475 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
477 'index' => [ ['eventpart'], ['tablenum'], ['status'] ],
482 'billpkgnum', 'serial', '', '', '', '',
483 'pkgnum', 'int', '', '', '', '',
484 'invnum', 'int', '', '', '', '',
485 'setup', @money_type, '', '',
486 'recur', @money_type, '', '',
487 'sdate', @date_type, '', '',
488 'edate', @date_type, '', '',
489 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
491 'primary_key' => 'billpkgnum',
493 'index' => [ ['invnum'], [ 'pkgnum' ] ],
496 'cust_bill_pkg_detail' => {
498 'detailnum', 'serial', '', '', '', '',
499 'pkgnum', 'int', '', '', '', '',
500 'invnum', 'int', '', '', '', '',
501 'detail', 'varchar', '', $char_d, '', '',
503 'primary_key' => 'detailnum',
505 'index' => [ [ 'pkgnum', 'invnum' ] ],
510 'crednum', 'serial', '', '', '', '',
511 'custnum', 'int', '', '', '', '',
512 '_date', @date_type, '', '',
513 'amount', @money_type, '', '',
514 'otaker', 'varchar', '', 32, '', '',
515 'reason', 'text', 'NULL', '', '', '',
516 'reasonnum', 'int', 'NULL', '', '', '',
517 'closed', 'char', 'NULL', 1, '', '',
519 'primary_key' => 'crednum',
521 'index' => [ ['custnum'], ['_date'] ],
524 'cust_credit_bill' => {
526 'creditbillnum', 'serial', '', '', '', '',
527 'crednum', 'int', '', '', '', '',
528 'invnum', 'int', '', '', '', '',
529 '_date', @date_type, '', '',
530 'amount', @money_type, '', '',
532 'primary_key' => 'creditbillnum',
534 'index' => [ ['crednum'], ['invnum'] ],
537 'cust_credit_bill_pkg' => {
539 'creditbillpkgnum', 'serial', '', '', '', '',
540 'creditbillnum', 'int', '', '', '', '',
541 'billpkgnum', 'int', '', '', '', '',
542 'amount', @money_type, '', '',
543 'setuprecur', 'varchar', '', $char_d, '', '',
544 'sdate', @date_type, '', '',
545 'edate', @date_type, '', '',
547 'primary_key' => 'creditbillpkgnum',
549 'index' => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
554 'custnum', 'serial', '', '', '', '',
555 'agentnum', 'int', '', '', '', '',
556 'agent_custid', 'varchar', 'NULL', $char_d, '', '',
557 # 'titlenum', 'int', 'NULL', '', '', '',
558 'last', 'varchar', '', $char_d, '', '',
559 # 'middle', 'varchar', 'NULL', $char_d, '', '',
560 'first', 'varchar', '', $char_d, '', '',
561 'ss', 'varchar', 'NULL', 11, '', '',
562 'stateid', 'varchar', 'NULL', $char_d, '', '',
563 'stateid_state', 'varchar', 'NULL', $char_d, '', '',
564 'birthdate' ,@date_type, '', '',
565 'signupdate',@date_type, '', '',
566 'company', 'varchar', 'NULL', $char_d, '', '',
567 'address1', 'varchar', '', $char_d, '', '',
568 'address2', 'varchar', 'NULL', $char_d, '', '',
569 'city', 'varchar', '', $char_d, '', '',
570 'county', 'varchar', 'NULL', $char_d, '', '',
571 'state', 'varchar', 'NULL', $char_d, '', '',
572 'zip', 'varchar', 'NULL', 10, '', '',
573 'country', 'char', '', 2, '', '',
574 'daytime', 'varchar', 'NULL', 20, '', '',
575 'night', 'varchar', 'NULL', 20, '', '',
576 'fax', 'varchar', 'NULL', 12, '', '',
577 'ship_last', 'varchar', 'NULL', $char_d, '', '',
578 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
579 'ship_first', 'varchar', 'NULL', $char_d, '', '',
580 'ship_company', 'varchar', 'NULL', $char_d, '', '',
581 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
582 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
583 'ship_city', 'varchar', 'NULL', $char_d, '', '',
584 'ship_county', 'varchar', 'NULL', $char_d, '', '',
585 'ship_state', 'varchar', 'NULL', $char_d, '', '',
586 'ship_zip', 'varchar', 'NULL', 10, '', '',
587 'ship_country', 'char', 'NULL', 2, '', '',
588 'ship_daytime', 'varchar', 'NULL', 20, '', '',
589 'ship_night', 'varchar', 'NULL', 20, '', '',
590 'ship_fax', 'varchar', 'NULL', 12, '', '',
591 'payby', 'char', '', 4, '', '',
592 'payinfo', 'varchar', 'NULL', 512, '', '',
593 'paycvv', 'varchar', 'NULL', 512, '', '',
594 'paymask', 'varchar', 'NULL', $char_d, '', '',
595 #'paydate', @date_type, '', '',
596 'paydate', 'varchar', 'NULL', 10, '', '',
597 'paystart_month', 'int', 'NULL', '', '', '',
598 'paystart_year', 'int', 'NULL', '', '', '',
599 'payissue', 'varchar', 'NULL', 2, '', '',
600 'payname', 'varchar', 'NULL', $char_d, '', '',
601 'paystate', 'varchar', 'NULL', $char_d, '', '',
602 'paytype', 'varchar', 'NULL', $char_d, '', '',
603 'payip', 'varchar', 'NULL', 15, '', '',
604 'tax', 'char', 'NULL', 1, '', '',
605 'otaker', 'varchar', '', 32, '', '',
606 'refnum', 'int', '', '', '', '',
607 'referral_custnum', 'int', 'NULL', '', '', '',
608 'comments', 'text', 'NULL', '', '', '',
609 'spool_cdr','char', 'NULL', 1, '', '',
610 'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
612 'primary_key' => 'custnum',
613 'unique' => [ [ 'agentnum', 'agent_custid' ] ],
614 #'index' => [ ['last'], ['company'] ],
615 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
616 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
617 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
618 [ 'ship_last' ], [ 'ship_company' ],
619 [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
620 [ 'payby' ], [ 'paydate' ],
624 'cust_main_invoice' => {
626 'destnum', 'serial', '', '', '', '',
627 'custnum', 'int', '', '', '', '',
628 'dest', 'varchar', '', $char_d, '', '',
630 'primary_key' => 'destnum',
632 'index' => [ ['custnum'], ],
635 'cust_main_note' => {
637 'notenum', 'serial', '', '', '', '',
638 'custnum', 'int', '', '', '', '',
639 '_date', @date_type, '', '',
640 'otaker', 'varchar', '', 32, '', '',
641 'comments', 'text', 'NULL', '', '', '',
643 'primary_key' => 'notenum',
645 'index' => [ [ 'custnum' ], [ '_date' ], ],
648 'cust_main_county' => { #county+state+country are checked off the
649 #cust_main_county for validation and to provide
652 'taxnum', 'serial', '', '', '', '',
653 'state', 'varchar', 'NULL', $char_d, '', '',
654 'county', 'varchar', 'NULL', $char_d, '', '',
655 'country', 'char', '', 2, '', '',
656 'taxclass', 'varchar', 'NULL', $char_d, '', '',
657 'exempt_amount', @money_type, '', '',
658 'tax', 'real', '', '', '', '', #tax %
659 'taxname', 'varchar', 'NULL', $char_d, '', '',
660 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
661 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
663 'primary_key' => 'taxnum',
665 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
666 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
671 'taxnum', 'serial', '', '', '', '',
672 'geocode', 'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
673 'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
674 'location', 'varchar', 'NULL', $char_d, '', '',#provided by tax authority
675 'taxclassnum', 'int', '', '', '', '',
676 'effective_date', @date_type, '', '',
677 'tax', 'real', '', '', '', '', # tax %
678 'excessrate', 'real', 'NULL','', '', '', # second tax %
679 'taxbase', @money_typen, '', '', # amount at first tax rate
680 'taxmax', @money_typen, '', '', # maximum about at both rates
681 'usetax', 'real', 'NULL', '', '', '', # tax % when non-local
682 'useexcessrate', 'real', 'NULL', '', '', '', # second tax % when non-local
683 'unittype', 'int', 'NULL', '', '', '', # for fee
684 'fee', 'real', 'NULL', '', '', '', # amount tax per unit
685 'excessfee', 'real', 'NULL', '', '', '', # second amount tax per unit
686 'feebase', 'real', 'NULL', '', '', '', # units taxed at first rate
687 'feemax', 'real', 'NULL', '', '', '', # maximum number of unit taxed
688 'maxtype', 'int', 'NULL', '', '', '', # indicator of how thresholds accumulate
689 'taxname', 'varchar', 'NULL', $char_d, '', '', # may appear on invoice
690 'taxauth', 'int', 'NULL', '', '', '', # tax authority
691 'basetype', 'int', 'NULL', '', '', '', # indicator of basis for tax
692 'passtype', 'int', 'NULL', '', '', '', # indicator declaring how item should be shown
693 'passflag', 'char', 'NULL', 1, '', '', # Y = required to list as line item, N = Prohibited
694 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
695 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
696 'manual', 'char', 'NULL', 1, '', '', # Y = manually edited
698 'primary_key' => 'taxnum',
700 'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
703 'cust_tax_location' => {
705 'custlocationnum', 'serial', '', '', '', '',
706 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
707 'zip', 'char', '', 5, '', '',
708 'state', 'char', '', 2, '', '',
709 'plus4hi', 'char', '', 4, '', '',
710 'plus4lo', 'char', '', 4, '', '',
711 'default_location','char', 'NULL', 1, '', '', # Y = default for zip
712 'geocode', 'varchar', '', 20, '', '',
714 'primary_key' => 'custlocationnum',
716 'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
721 'taxclassnum', 'serial', '', '', '', '',
722 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
723 'taxclass', 'varchar', '', $char_d, '', '',
724 'description', 'varchar', '', 2*$char_d, '', '',
726 'primary_key' => 'taxclassnum',
727 'unique' => [ [ 'data_vendor', 'taxclass' ] ],
731 'cust_pay_pending' => {
733 'paypendingnum','serial', '', '', '', '',
734 'custnum', 'int', '', '', '', '',
735 'paid', @money_type, '', '',
736 '_date', @date_type, '', '',
737 'payby', 'char', '', 4, '', '', #CARD/BILL/COMP, should
738 # be index into payby
740 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
741 'paymask', 'varchar', 'NULL', $char_d, '', '',
742 'paydate', 'varchar', 'NULL', 10, '', '',
743 #'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
744 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
746 'status', 'varchar', '', $char_d, '', '',
747 'statustext', 'text', 'NULL', '', '', '',
748 'gatewaynum', 'int', 'NULL', '', '', '',
749 #'cust_balance', @money_type, '', '',
750 'paynum', 'int', 'NULL', '', '', '',
752 'primary_key' => 'paypendingnum',
753 'unique' => [ [ 'payunique' ] ],
754 'index' => [ [ 'custnum' ], [ 'status' ], ],
759 'paynum', 'serial', '', '', '', '',
760 'custnum', 'int', '', '', '', '',
761 '_date', @date_type, '', '',
762 'paid', @money_type, '', '',
763 'otaker', 'varchar', 'NULL', 32, '', '', #NULL for the upgrade so we can create & populate the field
764 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
765 # index into payby table
767 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
768 'paymask', 'varchar', 'NULL', $char_d, '', '',
769 'paydate', 'varchar', 'NULL', 10, '', '',
770 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
771 'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
772 'closed', 'char', 'NULL', 1, '', '',
774 'primary_key' => 'paynum',
775 #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
776 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
781 'paynum', 'int', '', '', '', '',
782 'custnum', 'int', '', '', '', '',
783 'paid', @money_type, '', '',
784 '_date', @date_type, '', '',
785 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
786 # index into payby table
788 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
789 'paymask', 'varchar', 'NULL', $char_d, '', '',
790 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
791 'closed', 'char', 'NULL', 1, '', '',
792 'void_date', @date_type, '', '',
793 'reason', 'varchar', 'NULL', $char_d, '', '',
794 'otaker', 'varchar', '', 32, '', '',
796 'primary_key' => 'paynum',
798 'index' => [ [ 'custnum' ] ],
803 'billpaynum', 'serial', '', '', '', '',
804 'invnum', 'int', '', '', '', '',
805 'paynum', 'int', '', '', '', '',
806 'amount', @money_type, '', '',
807 '_date', @date_type, '', '',
809 'primary_key' => 'billpaynum',
811 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
814 'cust_bill_pay_batch' => {
816 'billpaynum', 'serial', '', '', '', '',
817 'invnum', 'int', '', '', '', '',
818 'paybatchnum', 'int', '', '', '', '',
819 'amount', @money_type, '', '',
820 '_date', @date_type, '', '',
822 'primary_key' => 'billpaynum',
824 'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
827 'cust_bill_pay_pkg' => {
829 'billpaypkgnum', 'serial', '', '', '', '',
830 'billpaynum', 'int', '', '', '', '',
831 'billpkgnum', 'int', '', '', '', '',
832 'amount', @money_type, '', '',
833 'setuprecur', 'varchar', '', $char_d, '', '',
834 'sdate', @date_type, '', '',
835 'edate', @date_type, '', '',
837 'primary_key' => 'billpaypkgnum',
839 'index' => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
842 'pay_batch' => { #batches of payments to an external processor
844 'batchnum', 'serial', '', '', '', '',
845 'payby', 'char', '', 4, '', '', # CARD/CHEK
846 'status', 'char', 'NULL', 1, '', '',
847 'download', @date_type, '', '',
848 'upload', @date_type, '', '',
850 'primary_key' => 'batchnum',
855 'cust_pay_batch' => { #what's this used for again? list of customers
856 #in current CARD batch? (necessarily CARD?)
858 'paybatchnum', 'serial', '', '', '', '',
859 'batchnum', 'int', '', '', '', '',
860 'invnum', 'int', '', '', '', '',
861 'custnum', 'int', '', '', '', '',
862 'last', 'varchar', '', $char_d, '', '',
863 'first', 'varchar', '', $char_d, '', '',
864 'address1', 'varchar', '', $char_d, '', '',
865 'address2', 'varchar', 'NULL', $char_d, '', '',
866 'city', 'varchar', '', $char_d, '', '',
867 'state', 'varchar', 'NULL', $char_d, '', '',
868 'zip', 'varchar', 'NULL', 10, '', '',
869 'country', 'char', '', 2, '', '',
870 # 'trancode', 'int', '', '', '', ''
871 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
872 'payinfo', 'varchar', '', 512, '', '',
873 #'exp', @date_type, '', ''
874 'exp', 'varchar', 'NULL', 11, '', '',
875 'payname', 'varchar', 'NULL', $char_d, '', '',
876 'amount', @money_type, '', '',
877 'status', 'varchar', 'NULL', $char_d, '', '',
879 'primary_key' => 'paybatchnum',
881 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
886 'pkgnum', 'serial', '', '', '', '',
887 'custnum', 'int', '', '', '', '',
888 'pkgpart', 'int', '', '', '', '',
889 'otaker', 'varchar', '', 32, '', '',
890 'setup', @date_type, '', '',
891 'bill', @date_type, '', '',
892 'last_bill', @date_type, '', '',
893 'susp', @date_type, '', '',
894 'adjourn', @date_type, '', '',
895 'cancel', @date_type, '', '',
896 'expire', @date_type, '', '',
897 'change_date', @date_type, '', '',
898 'change_pkgnum', 'int', 'NULL', '', '', '',
899 'change_pkgpart', 'int', 'NULL', '', '', '',
900 'manual_flag', 'char', 'NULL', 1, '', '',
902 'primary_key' => 'pkgnum',
904 'index' => [ ['custnum'], ['pkgpart'],
905 ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
906 ['expire'], ['cancel'],
911 'cust_pkg_option' => {
913 'optionnum', 'serial', '', '', '', '',
914 'pkgnum', 'int', '', '', '', '',
915 'optionname', 'varchar', '', $char_d, '', '',
916 'optionvalue', 'text', 'NULL', '', '', '',
918 'primary_key' => 'optionnum',
920 'index' => [ [ 'pkgnum' ], [ 'optionname' ] ],
923 'cust_pkg_reason' => {
925 'num', 'serial', '', '', '', '',
926 'pkgnum', 'int', '', '', '', '',
927 'reasonnum','int', '', '', '', '',
928 'otaker', 'varchar', '', 32, '', '',
929 'date', @date_type, '', '',
931 'primary_key' => 'num',
938 'refundnum', 'serial', '', '', '', '',
939 'custnum', 'int', '', '', '', '',
940 '_date', @date_type, '', '',
941 'refund', @money_type, '', '',
942 'otaker', 'varchar', '', 32, '', '',
943 'reason', 'varchar', '', $char_d, '', '',
944 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
945 # be index into payby
947 'payinfo', 'varchar', 'NULL', 512, '', '', #see cust_main above
948 'paymask', 'varchar', 'NULL', $char_d, '', '',
949 'paybatch', 'varchar', 'NULL', $char_d, '', '',
950 'closed', 'char', 'NULL', 1, '', '',
952 'primary_key' => 'refundnum',
954 'index' => [ ['custnum'], ['_date'] ],
957 'cust_credit_refund' => {
959 'creditrefundnum', 'serial', '', '', '', '',
960 'crednum', 'int', '', '', '', '',
961 'refundnum', 'int', '', '', '', '',
962 'amount', @money_type, '', '',
963 '_date', @date_type, '', '',
965 'primary_key' => 'creditrefundnum',
967 'index' => [ ['crednum'], ['refundnum'] ],
973 'svcnum', 'serial', '', '', '', '',
974 'pkgnum', 'int', 'NULL', '', '', '',
975 'svcpart', 'int', '', '', '', '',
976 'overlimit', @date_type, '', '',
978 'primary_key' => 'svcnum',
980 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
985 'pkgpart', 'serial', '', '', '', '',
986 'pkg', 'varchar', '', $char_d, '', '',
987 'comment', 'varchar', '', $char_d, '', '',
988 'promo_code', 'varchar', 'NULL', $char_d, '', '',
989 'setup', @perl_type, '', '',
990 'freq', 'varchar', '', $char_d, '', '', #billing frequency
991 'recur', @perl_type, '', '',
992 'setuptax', 'char', 'NULL', 1, '', '',
993 'recurtax', 'char', 'NULL', 1, '', '',
994 'plan', 'varchar', 'NULL', $char_d, '', '',
995 'plandata', 'text', 'NULL', '', '', '',
996 'disabled', 'char', 'NULL', 1, '', '',
997 'taxclass', 'varchar', 'NULL', $char_d, '', '',
998 'classnum', 'int', 'NULL', '', '', '',
999 'taxproductnum', 'int', 'NULL', '', '', '',
1000 'pay_weight', 'real', 'NULL', '', '', '',
1001 'credit_weight', 'real', 'NULL', '', '', '',
1002 'agentnum', 'int', 'NULL', '', '', '',
1005 'primary_key' => 'pkgpart',
1007 'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1010 'part_pkg_link' => {
1012 'pkglinknum', 'serial', '', '', '', '',
1013 'src_pkgpart', 'int', '', '', '', '',
1014 'dst_pkgpart', 'int', '', '', '', '',
1015 'link_type', 'varchar', '', $char_d, '', '',
1017 'primary_key' => 'pkglinknum',
1018 'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1019 'index' => [ [ 'src_pkgpart' ] ],
1022 'part_pkg_taxclass' => {
1024 'taxclassnum', 'serial', '', '', '', '',
1025 'taxclass', 'varchar', '', $char_d, '', '',
1027 'primary_key' => 'taxclassnum',
1028 'unique' => [ [ 'taxclass' ] ],
1032 'part_pkg_taxproduct' => {
1034 'taxproductnum', 'serial', '', '', '', '',
1035 'data_vendor', 'varchar', 'NULL', $char_d, '', '',
1036 'taxproduct', 'varchar', '', $char_d, '', '',
1037 'description', 'varchar', '', 2*$char_d, '', '',
1039 'primary_key' => 'taxproductnum',
1040 'unique' => [ [ 'data_vendor', 'taxproduct' ] ],
1044 'part_pkg_taxrate' => {
1046 'pkgtaxratenum', 'serial', '', '', '', '',
1047 'data_vendor', 'varchar', 'NULL', $char_d, '', '', # update source
1048 'geocode', 'varchar', 'NULL', $char_d, '', '', # cch provides 10
1049 'taxproductnum', 'int', '', '', '', '',
1050 'city', 'varchar', 'NULL', $char_d, '', '', # tax_location?
1051 'county', 'varchar', 'NULL', $char_d, '', '',
1052 'state', 'varchar', 'NULL', $char_d, '', '',
1053 'local', 'varchar', 'NULL', $char_d, '', '',
1054 'country', 'char', 'NULL', 2, '', '',
1055 'taxclassnumtaxed', 'int', 'NULL', '', '', '',
1056 'taxcattaxed', 'varchar', 'NULL', $char_d, '', '',
1057 'taxclassnum', 'int', 'NULL', '', '', '',
1058 'effdate', @date_type, '', '',
1059 'taxable', 'char', 'NULL', 1, '', '',
1061 'primary_key' => 'pkgtaxratenum',
1063 'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1066 'part_pkg_taxoverride' => {
1068 'taxoverridenum', 'serial', '', '', '', '',
1069 'pkgpart', 'serial', '', '', '', '',
1070 'taxclassnum', 'serial', '', '', '', '',
1072 'primary_key' => 'taxoverridenum',
1074 'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1079 # 'titlenum', 'int', '', '',
1080 # 'title', 'varchar', '', $char_d,
1082 # 'primary_key' => 'titlenum',
1083 # 'unique' => [ [] ],
1084 # 'index' => [ [] ],
1089 'pkgsvcnum', 'serial', '', '', '', '',
1090 'pkgpart', 'int', '', '', '', '',
1091 'svcpart', 'int', '', '', '', '',
1092 'quantity', 'int', '', '', '', '',
1093 'primary_svc','char', 'NULL', 1, '', '',
1095 'primary_key' => 'pkgsvcnum',
1096 'unique' => [ ['pkgpart', 'svcpart'] ],
1097 'index' => [ ['pkgpart'] ],
1100 'part_referral' => {
1102 'refnum', 'serial', '', '', '', '',
1103 'referral', 'varchar', '', $char_d, '', '',
1104 'disabled', 'char', 'NULL', 1, '', '',
1105 'agentnum', 'int', 'NULL', '', '', '',
1107 'primary_key' => 'refnum',
1109 'index' => [ ['disabled'], ['agentnum'], ],
1114 'svcpart', 'serial', '', '', '', '',
1115 'svc', 'varchar', '', $char_d, '', '',
1116 'svcdb', 'varchar', '', $char_d, '', '',
1117 'disabled', 'char', 'NULL', 1, '', '',
1119 'primary_key' => 'svcpart',
1121 'index' => [ [ 'disabled' ] ],
1124 'part_svc_column' => {
1126 'columnnum', 'serial', '', '', '', '',
1127 'svcpart', 'int', '', '', '', '',
1128 'columnname', 'varchar', '', 64, '', '',
1129 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1130 'columnflag', 'char', 'NULL', 1, '', '',
1132 'primary_key' => 'columnnum',
1133 'unique' => [ [ 'svcpart', 'columnname' ] ],
1134 'index' => [ [ 'svcpart' ] ],
1137 #(this should be renamed to part_pop)
1140 'popnum', 'serial', '', '', '', '',
1141 'city', 'varchar', '', $char_d, '', '',
1142 'state', 'varchar', '', $char_d, '', '',
1143 'ac', 'char', '', 3, '', '',
1144 'exch', 'char', '', 3, '', '',
1145 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
1147 'primary_key' => 'popnum',
1149 'index' => [ [ 'state' ] ],
1152 'part_pop_local' => {
1154 'localnum', 'serial', '', '', '', '',
1155 'popnum', 'int', '', '', '', '',
1156 'city', 'varchar', 'NULL', $char_d, '', '',
1157 'state', 'char', 'NULL', 2, '', '',
1158 'npa', 'char', '', 3, '', '',
1159 'nxx', 'char', '', 3, '', '',
1161 'primary_key' => 'localnum',
1163 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1168 'svcnum', 'int', '', '', '', '',
1169 'username', 'varchar', '', $username_len, '', '',
1170 '_password', 'varchar', '', 512, '', '',
1171 '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1172 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
1173 'popnum', 'int', 'NULL', '', '', '',
1174 'uid', 'int', 'NULL', '', '', '',
1175 'gid', 'int', 'NULL', '', '', '',
1176 'finger', 'varchar', 'NULL', $char_d, '', '',
1177 'dir', 'varchar', 'NULL', $char_d, '', '',
1178 'shell', 'varchar', 'NULL', $char_d, '', '',
1179 'quota', 'varchar', 'NULL', $char_d, '', '',
1180 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
1181 'seconds', 'int', 'NULL', '', '', '', #uhhhh
1182 'seconds_threshold', 'int', 'NULL', '', '', '',
1183 'upbytes', 'bigint', 'NULL', '', '', '',
1184 'upbytes_threshold', 'bigint', 'NULL', '', '', '',
1185 'downbytes', 'bigint', 'NULL', '', '', '',
1186 'downbytes_threshold', 'bigint', 'NULL', '', '', '',
1187 'totalbytes','bigint', 'NULL', '', '', '',
1188 'totalbytes_threshold', 'bigint', 'NULL', '', '', '',
1189 'domsvc', 'int', '', '', '', '',
1190 'last_login', @date_type, '', '',
1191 'last_logout', @date_type, '', '',
1193 'primary_key' => 'svcnum',
1194 #'unique' => [ [ 'username', 'domsvc' ] ],
1196 'index' => [ ['username'], ['domsvc'] ],
1199 'acct_rt_transaction' => {
1201 'svcrtid', 'int', '', '', '', '',
1202 'svcnum', 'int', '', '', '', '',
1203 'transaction_id', 'int', '', '', '', '',
1204 '_date', @date_type, '', '',
1205 'seconds', 'int', '', '', '', '', #uhhhh
1206 'support', 'int', '', '', '', '',
1208 'primary_key' => 'svcrtid',
1210 'index' => [ ['svcnum', 'transaction_id'] ],
1215 # 'svcnum', 'int', '', '',
1216 # 'amount', @money_type,
1218 # 'primary_key' => 'svcnum',
1219 # 'unique' => [ [] ],
1220 # 'index' => [ [] ],
1225 'svcnum', 'int', '', '', '', '',
1226 'domain', 'varchar', '', $char_d, '', '',
1227 'suffix', 'varchar', 'NULL', $char_d, '', '',
1228 'catchall', 'int', 'NULL', '', '', '',
1229 'parent_svcnum', 'int', 'NULL', '', '', '',
1230 'registrarnum', 'int', 'NULL', '', '', '',
1231 'registrarkey', 'varchar', 'NULL', 512, '', '',
1232 'setup_date', @date_type, '', '',
1233 'renewal_interval', 'int', 'NULL', '', '', '',
1234 'expiration_date', @date_type, '', '',
1236 'primary_key' => 'svcnum',
1238 'index' => [ ['domain'] ],
1241 'domain_record' => {
1243 'recnum', 'serial', '', '', '', '',
1244 'svcnum', 'int', '', '', '', '',
1245 'reczone', 'varchar', '', 255, '', '',
1246 'recaf', 'char', '', 2, '', '',
1247 'rectype', 'varchar', '', 5, '', '',
1248 'recdata', 'varchar', '', 255, '', '',
1250 'primary_key' => 'recnum',
1252 'index' => [ ['svcnum'] ],
1257 'registrarnum', 'serial', '', '', '', '',
1258 'registrarname', 'varchar', '', $char_d, '', '',
1260 'primary_key' => 'registrarnum',
1267 'svcnum', 'int', '', '', '', '',
1268 'srcsvc', 'int', 'NULL', '', '', '',
1269 'src', 'varchar', 'NULL', 255, '', '',
1270 'dstsvc', 'int', 'NULL', '', '', '',
1271 'dst', 'varchar', 'NULL', 255, '', '',
1273 'primary_key' => 'svcnum',
1275 'index' => [ ['srcsvc'], ['dstsvc'] ],
1280 'svcnum', 'int', '', '', '', '',
1281 'recnum', 'int', '', '', '', '',
1282 'usersvc', 'int', 'NULL', '', '', '',
1283 'config', 'text', 'NULL', '', '', '',
1285 'primary_key' => 'svcnum',
1292 # 'svcnum', 'int', '', '',
1293 # 'svcnum', 'int', '', '',
1294 # 'svcnum', 'int', '', '',
1295 # 'worker', 'varchar', '', $char_d,
1296 # '_date', @date_type,
1298 # 'primary_key' => 'svcnum',
1299 # 'unique' => [ [] ],
1300 # 'index' => [ [] ],
1303 'prepay_credit' => {
1305 'prepaynum', 'serial', '', '', '', '',
1306 'identifier', 'varchar', '', $char_d, '', '',
1307 'amount', @money_type, '', '',
1308 'seconds', 'int', 'NULL', '', '', '',
1309 'upbytes', 'bigint', 'NULL', '', '', '',
1310 'downbytes', 'bigint', 'NULL', '', '', '',
1311 'totalbytes', 'bigint', 'NULL', '', '', '',
1312 'agentnum', 'int', 'NULL', '', '', '',
1314 'primary_key' => 'prepaynum',
1315 'unique' => [ ['identifier'] ],
1321 'portnum', 'serial', '', '', '', '',
1322 'ip', 'varchar', 'NULL', 15, '', '',
1323 'nasport', 'int', 'NULL', '', '', '',
1324 'nasnum', 'int', '', '', '', '',
1326 'primary_key' => 'portnum',
1333 'nasnum', 'serial', '', '', '', '',
1334 'nas', 'varchar', '', $char_d, '', '',
1335 'nasip', 'varchar', '', 15, '', '',
1336 'nasfqdn', 'varchar', '', $char_d, '', '',
1337 'last', 'int', '', '', '', '',
1339 'primary_key' => 'nasnum',
1340 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
1341 'index' => [ [ 'last' ] ],
1346 # 'sessionnum', 'serial', '', '', '', '',
1347 # 'portnum', 'int', '', '', '', '',
1348 # 'svcnum', 'int', '', '', '', '',
1349 # 'login', @date_type, '', '',
1350 # 'logout', @date_type, '', '',
1352 # 'primary_key' => 'sessionnum',
1354 # 'index' => [ [ 'portnum' ] ],
1359 'jobnum', 'serial', '', '', '', '',
1360 'job', 'text', '', '', '', '',
1361 '_date', 'int', '', '', '', '',
1362 'status', 'varchar', '', $char_d, '', '',
1363 'statustext', 'text', 'NULL', '', '', '',
1364 'svcnum', 'int', 'NULL', '', '', '',
1365 'secure', 'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1368 'primary_key' => 'jobnum',
1370 'index' => [ [ 'svcnum' ], [ 'status' ] ],
1375 'argnum', 'serial', '', '', '', '',
1376 'jobnum', 'int', '', '', '', '',
1377 'arg', 'text', 'NULL', '', '', '',
1379 'primary_key' => 'argnum',
1381 'index' => [ [ 'jobnum' ] ],
1386 'dependnum', 'serial', '', '', '', '',
1387 'jobnum', 'int', '', '', '', '',
1388 'depend_jobnum', 'int', '', '', '', '',
1390 'primary_key' => 'dependnum',
1392 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1397 'exportsvcnum' => 'serial', '', '', '', '',
1398 'exportnum' => 'int', '', '', '', '',
1399 'svcpart' => 'int', '', '', '', '',
1401 'primary_key' => 'exportsvcnum',
1402 'unique' => [ [ 'exportnum', 'svcpart' ] ],
1403 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
1408 'exportnum', 'serial', '', '', '', '',
1409 'machine', 'varchar', '', $char_d, '', '',
1410 'exporttype', 'varchar', '', $char_d, '', '',
1411 'nodomain', 'char', 'NULL', 1, '', '',
1413 'primary_key' => 'exportnum',
1415 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
1418 'part_export_option' => {
1420 'optionnum', 'serial', '', '', '', '',
1421 'exportnum', 'int', '', '', '', '',
1422 'optionname', 'varchar', '', $char_d, '', '',
1423 'optionvalue', 'text', 'NULL', '', '', '',
1425 'primary_key' => 'optionnum',
1427 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
1430 'radius_usergroup' => {
1432 'usergroupnum', 'serial', '', '', '', '',
1433 'svcnum', 'int', '', '', '', '',
1434 'groupname', 'varchar', '', $char_d, '', '',
1436 'primary_key' => 'usergroupnum',
1438 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
1443 'msgnum', 'serial', '', '', '', '',
1444 'msgcode', 'varchar', '', $char_d, '', '',
1445 'locale', 'varchar', '', 16, '', '',
1446 'msg', 'text', '', '', '', '',
1448 'primary_key' => 'msgnum',
1449 'unique' => [ [ 'msgcode', 'locale' ] ],
1453 'cust_tax_exempt' => {
1455 'exemptnum', 'serial', '', '', '', '',
1456 'custnum', 'int', '', '', '', '',
1457 'taxnum', 'int', '', '', '', '',
1458 'year', 'int', '', '', '', '',
1459 'month', 'int', '', '', '', '',
1460 'amount', @money_type, '', '',
1462 'primary_key' => 'exemptnum',
1463 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1467 'cust_tax_exempt_pkg' => {
1469 'exemptpkgnum', 'serial', '', '', '', '',
1470 #'custnum', 'int', '', '', '', ''
1471 'billpkgnum', 'int', '', '', '', '',
1472 'taxnum', 'int', '', '', '', '',
1473 'year', 'int', '', '', '', '',
1474 'month', 'int', '', '', '', '',
1475 'amount', @money_type, '', '',
1477 'primary_key' => 'exemptpkgnum',
1479 'index' => [ [ 'taxnum', 'year', 'month' ],
1487 'routernum', 'serial', '', '', '', '',
1488 'routername', 'varchar', '', $char_d, '', '',
1489 'svcnum', 'int', 'NULL', '', '', '',
1490 'agentnum', 'int', 'NULL', '', '', '',
1492 'primary_key' => 'routernum',
1497 'part_svc_router' => {
1499 'svcrouternum', 'serial', '', '', '', '',
1500 'svcpart', 'int', '', '', '', '',
1501 'routernum', 'int', '', '', '', '',
1503 'primary_key' => 'svcrouternum',
1510 'blocknum', 'serial', '', '', '', '',
1511 'routernum', 'int', '', '', '', '',
1512 'ip_gateway', 'varchar', '', 15, '', '',
1513 'ip_netmask', 'int', '', '', '', '',
1514 'agentnum', 'int', 'NULL', '', '', '',
1516 'primary_key' => 'blocknum',
1517 'unique' => [ [ 'blocknum', 'routernum' ] ],
1521 'svc_broadband' => {
1523 'svcnum', 'int', '', '', '', '',
1524 'description', 'varchar', 'NULL', $char_d, '', '',
1525 'blocknum', 'int', '', '', '', '',
1526 'speed_up', 'int', '', '', '', '',
1527 'speed_down', 'int', '', '', '', '',
1528 'ip_addr', 'varchar', '', 15, '', '',
1529 'mac_addr', 'varchar', 'NULL', 12, '', '',
1530 'authkey', 'varchar', 'NULL', 32, '', '',
1531 'latitude', 'decimal', 'NULL', '', '', '',
1532 'longitude', 'decimal', 'NULL', '', '', '',
1533 'altitude', 'decimal', 'NULL', '', '', '',
1534 'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1536 'primary_key' => 'svcnum',
1541 'part_virtual_field' => {
1543 'vfieldpart', 'serial', '', '', '', '',
1544 'dbtable', 'varchar', '', 32, '', '',
1545 'name', 'varchar', '', 32, '', '',
1546 'check_block', 'text', 'NULL', '', '', '',
1547 'length', 'int', 'NULL', '', '', '',
1548 'list_source', 'text', 'NULL', '', '', '',
1549 'label', 'varchar', 'NULL', 80, '', '',
1551 'primary_key' => 'vfieldpart',
1556 'virtual_field' => {
1558 'vfieldnum', 'serial', '', '', '', '',
1559 'recnum', 'int', '', '', '', '',
1560 'vfieldpart', 'int', '', '', '', '',
1561 'value', 'varchar', '', 128, '', '',
1563 'primary_key' => 'vfieldnum',
1564 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1570 'snarfnum', 'int', '', '', '', '',
1571 'svcnum', 'int', '', '', '', '',
1572 'machine', 'varchar', '', 255, '', '',
1573 'protocol', 'varchar', '', $char_d, '', '',
1574 'username', 'varchar', '', $char_d, '', '',
1575 '_password', 'varchar', '', $char_d, '', '',
1577 'primary_key' => 'snarfnum',
1579 'index' => [ [ 'svcnum' ] ],
1584 'svcnum', 'int', '', '', '', '',
1585 'id', 'int', 'NULL', '', '', '',
1586 'title', 'varchar', 'NULL', $char_d, '', '',
1588 'primary_key' => 'svcnum',
1593 'cust_pay_refund' => {
1595 'payrefundnum', 'serial', '', '', '', '',
1596 'paynum', 'int', '', '', '', '',
1597 'refundnum', 'int', '', '', '', '',
1598 '_date', @date_type, '', '',
1599 'amount', @money_type, '', '',
1601 'primary_key' => 'payrefundnum',
1603 'index' => [ ['paynum'], ['refundnum'] ],
1606 'part_pkg_option' => {
1608 'optionnum', 'serial', '', '', '', '',
1609 'pkgpart', 'int', '', '', '', '',
1610 'optionname', 'varchar', '', $char_d, '', '',
1611 'optionvalue', 'text', 'NULL', '', '', '',
1613 'primary_key' => 'optionnum',
1615 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1620 'ratenum', 'serial', '', '', '', '',
1621 'ratename', 'varchar', '', $char_d, '', '',
1623 'primary_key' => 'ratenum',
1630 'ratedetailnum', 'serial', '', '', '', '',
1631 'ratenum', 'int', '', '', '', '',
1632 'orig_regionnum', 'int', 'NULL', '', '', '',
1633 'dest_regionnum', 'int', '', '', '', '',
1634 'min_included', 'int', '', '', '', '',
1635 #'min_charge', @money_type, '', '',
1636 'min_charge', 'decimal', '', '10,5', '', '',
1637 'sec_granularity', 'int', '', '', '', '',
1638 #time period (link to table of periods)?
1640 'primary_key' => 'ratedetailnum',
1641 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1642 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1647 'regionnum', 'serial', '', '', '', '',
1648 'regionname', 'varchar', '', $char_d, '', '',
1650 'primary_key' => 'regionnum',
1657 'prefixnum', 'serial', '', '', '', '',
1658 'regionnum', 'int', '', '',, '', '',
1659 'countrycode', 'varchar', '', 3, '', '',
1660 'npa', 'varchar', 'NULL', 6, '', '',
1661 'nxx', 'varchar', 'NULL', 3, '', '',
1663 'primary_key' => 'prefixnum',
1665 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1670 'codenum', 'serial', '', '', '', '',
1671 'code', 'varchar', '', $char_d, '', '',
1672 'agentnum', 'int', '', '', '', '',
1674 'primary_key' => 'codenum',
1675 'unique' => [ [ 'agentnum', 'code' ] ],
1676 'index' => [ [ 'agentnum' ] ],
1681 'codepkgnum', 'serial', '', '', '', '',
1682 'codenum', 'int', '', '', '', '',
1683 'pkgpart', 'int', '', '', '', '',
1685 'primary_key' => 'codepkgnum',
1686 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1687 'index' => [ [ 'codenum' ] ],
1690 'clientapi_session' => {
1692 'sessionnum', 'serial', '', '', '', '',
1693 'sessionid', 'varchar', '', $char_d, '', '',
1694 'namespace', 'varchar', '', $char_d, '', '',
1696 'primary_key' => 'sessionnum',
1697 'unique' => [ [ 'sessionid', 'namespace' ] ],
1701 'clientapi_session_field' => {
1703 'fieldnum', 'serial', '', '', '', '',
1704 'sessionnum', 'int', '', '', '', '',
1705 'fieldname', 'varchar', '', $char_d, '', '',
1706 'fieldvalue', 'text', 'NULL', '', '', '',
1708 'primary_key' => 'fieldnum',
1709 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1713 'payment_gateway' => {
1715 'gatewaynum', 'serial', '', '', '', '',
1716 'gateway_module', 'varchar', '', $char_d, '', '',
1717 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1718 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1719 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1720 'disabled', 'char', 'NULL', 1, '', '',
1722 'primary_key' => 'gatewaynum',
1724 'index' => [ [ 'disabled' ] ],
1727 'payment_gateway_option' => {
1729 'optionnum', 'serial', '', '', '', '',
1730 'gatewaynum', 'int', '', '', '', '',
1731 'optionname', 'varchar', '', $char_d, '', '',
1732 'optionvalue', 'text', 'NULL', '', '', '',
1734 'primary_key' => 'optionnum',
1736 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1739 'agent_payment_gateway' => {
1741 'agentgatewaynum', 'serial', '', '', '', '',
1742 'agentnum', 'int', '', '', '', '',
1743 'gatewaynum', 'int', '', '', '', '',
1744 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1745 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1747 'primary_key' => 'agentgatewaynum',
1749 'index' => [ [ 'agentnum', 'cardtype' ], ],
1754 'bannum', 'serial', '', '', '', '',
1755 'payby', 'char', '', 4, '', '',
1756 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1757 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1758 '_date', @date_type, '', '',
1759 'otaker', 'varchar', '', 32, '', '',
1760 'reason', 'varchar', 'NULL', $char_d, '', '',
1762 'primary_key' => 'bannum',
1763 'unique' => [ [ 'payby', 'payinfo' ] ],
1769 'classnum', 'serial', '', '', '', '',
1770 'classname', 'varchar', '', $char_d, '', '',
1771 'disabled', 'char', 'NULL', 1, '', '',
1773 'primary_key' => 'classnum',
1775 'index' => [ ['disabled'] ],
1780 # qw( name type null length default local );
1786 'acctid', 'bigserial', '', '', '', '',
1787 #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1788 'calldate', 'timestamp', '', '', \'now()', '',
1789 'clid', 'varchar', '', $char_d, \"''", '',
1790 'src', 'varchar', '', $char_d, \"''", '',
1791 'dst', 'varchar', '', $char_d, \"''", '',
1792 'dcontext', 'varchar', '', $char_d, \"''", '',
1793 'channel', 'varchar', '', $char_d, \"''", '',
1794 'dstchannel', 'varchar', '', $char_d, \"''", '',
1795 'lastapp', 'varchar', '', $char_d, \"''", '',
1796 'lastdata', 'varchar', '', $char_d, \"''", '',
1798 #these don't seem to be logged by most of the SQL cdr_* modules
1799 #except tds under sql-illegal names, so;
1800 # ... don't rely on them for rating?
1801 # and, what they hey, i went ahead and changed the names and data types
1802 # to freeside-style dates...
1803 #'start', 'timestamp', 'NULL', '', '', '',
1804 #'answer', 'timestamp', 'NULL', '', '', '',
1805 #'end', 'timestamp', 'NULL', '', '', '',
1806 'startdate', @date_type, '', '',
1807 'answerdate', @date_type, '', '',
1808 'enddate', @date_type, '', '',
1811 'duration', 'int', '', '', 0, '',
1812 'billsec', 'int', '', '', 0, '',
1813 'disposition', 'varchar', '', 45, \"''", '',
1814 'amaflags', 'int', '', '', 0, '',
1815 'accountcode', 'varchar', '', 20, \"''", '',
1816 'uniqueid', 'varchar', '', 32, \"''", '',
1817 'userfield', 'varchar', '', 255, \"''", '',
1820 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1824 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1825 'cdrtypenum', 'int', 'NULL', '', '', '',
1827 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1829 'upstream_currency', 'char', 'NULL', 3, '', '',
1830 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1831 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1833 # how it was rated internally...
1834 'ratedetailnum', 'int', 'NULL', '', '', '',
1835 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1837 'distance', 'decimal', 'NULL', '', '', '',
1838 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1840 #cdr_calltype: the big list in appendix 2
1841 'calltypenum', 'int', 'NULL', '', '', '',
1843 'description', 'varchar', 'NULL', $char_d, '', '',
1844 'quantity', 'int', 'NULL', '', '', '',
1846 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1847 'carrierid', 'int', 'NULL', '', '', '',
1849 'upstream_rateid', 'int', 'NULL', '', '', '',
1852 #and now for our own fields
1855 # a svcnum... right..?
1856 'svcnum', 'int', 'NULL', '', '', '',
1858 #NULL, done (or something)
1859 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1862 'primary_key' => 'acctid',
1864 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1869 'calltypenum', 'serial', '', '', '', '',
1870 'calltypename', 'varchar', '', $char_d, '', '',
1872 'primary_key' => 'calltypenum',
1879 'cdrtypenum' => 'serial', '', '', '', '',
1880 'cdrtypename' => 'varchar', '', $char_d, '', '',
1882 'primary_key' => 'cdrtypenum',
1889 'carrierid' => 'serial', '', '', '', '',
1890 'carriername' => 'varchar', '', $char_d, '', '',
1892 'primary_key' => 'carrierid',
1897 #map upstream rateid to ours...
1898 'cdr_upstream_rate' => {
1900 'upstreamratenum', 'serial', '', '', '', '',
1901 'upstream_rateid', 'varchar', '', $char_d, '', '',
1902 'ratedetailnum', 'int', 'NULL', '', '', '',
1904 'primary_key' => 'upstreamratenum', #XXX need a primary key
1905 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1909 'inventory_item' => {
1911 'itemnum', 'serial', '', '', '', '',
1912 'classnum', 'int', '', '', '', '',
1913 'item', 'varchar', '', $char_d, '', '',
1914 'svcnum', 'int', 'NULL', '', '', '',
1916 'primary_key' => 'itemnum',
1917 'unique' => [ [ 'classnum', 'item' ] ],
1918 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1921 'inventory_class' => {
1923 'classnum', 'serial', '', '', '', '',
1924 'classname', 'varchar', '', $char_d, '', '',
1926 'primary_key' => 'classnum',
1933 'usernum', 'serial', '', '', '', '',
1934 'username', 'varchar', '', $char_d, '', '',
1935 '_password', 'varchar', '', $char_d, '', '',
1936 'last', 'varchar', '', $char_d, '', '',
1937 'first', 'varchar', '', $char_d, '', '',
1938 'disabled', 'char', 'NULL', 1, '', '',
1940 'primary_key' => 'usernum',
1941 'unique' => [ [ 'username' ] ],
1945 'access_user_pref' => {
1947 'prefnum', 'serial', '', '', '', '',
1948 'usernum', 'int', '', '', '', '',
1949 'prefname', 'varchar', '', $char_d, '', '',
1950 'prefvalue', 'text', 'NULL', '', '', '',
1951 'expiration', @date_type, '', '',
1953 'primary_key' => 'prefnum',
1955 'index' => [ [ 'usernum' ] ],
1960 'groupnum', 'serial', '', '', '', '',
1961 'groupname', 'varchar', '', $char_d, '', '',
1963 'primary_key' => 'groupnum',
1964 'unique' => [ [ 'groupname' ] ],
1968 'access_usergroup' => {
1970 'usergroupnum', 'serial', '', '', '', '',
1971 'usernum', 'int', '', '', '', '',
1972 'groupnum', 'int', '', '', '', '',
1974 'primary_key' => 'usergroupnum',
1975 'unique' => [ [ 'usernum', 'groupnum' ] ],
1976 'index' => [ [ 'usernum' ] ],
1979 'access_groupagent' => {
1981 'groupagentnum', 'serial', '', '', '', '',
1982 'groupnum', 'int', '', '', '', '',
1983 'agentnum', 'int', '', '', '', '',
1985 'primary_key' => 'groupagentnum',
1986 'unique' => [ [ 'groupnum', 'agentnum' ] ],
1987 'index' => [ [ 'groupnum' ] ],
1992 'rightnum', 'serial', '', '', '', '',
1993 'righttype', 'varchar', '', $char_d, '', '',
1994 'rightobjnum', 'int', '', '', '', '',
1995 'rightname', 'varchar', '', $char_d, '', '',
1997 'primary_key' => 'rightnum',
1998 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2004 'svcnum', 'int', '', '', '', '',
2005 'countrycode', 'varchar', '', 3, '', '',
2006 'phonenum', 'varchar', '', 15, '', '', #12 ?
2007 'pin', 'varchar', 'NULL', $char_d, '', '',
2009 'primary_key' => 'svcnum',
2011 'index' => [ [ 'countrycode', 'phonenum' ] ],
2016 'typenum', 'serial', '', '', '', '',
2017 'class', 'char', '', 1, '', '',
2018 'type', 'varchar', '', $char_d, '', '',
2020 'primary_key' => 'typenum',
2027 'reasonnum', 'serial', '', '', '', '',
2028 'reason_type', 'int', '', '', '', '',
2029 'reason', 'text', '', '', '', '',
2030 'disabled', 'char', 'NULL', 1, '', '',
2032 'primary_key' => 'reasonnum',
2039 'confnum', 'serial', '', '', '', '',
2040 'agentnum', 'int', 'NULL', '', '', '',
2041 'name', 'varchar', '', $char_d, '', '',
2042 'value', 'text', 'NULL', '', '', '',
2044 'primary_key' => 'confnum',
2045 'unique' => [ [ 'agentnum', 'name' ]],
2051 'pkgrefnum', 'serial', '', '', '', '',
2052 'pkgnum', 'int', '', '', '', '',
2053 'refnum', 'int', '', '', '', '',
2055 'primary_key' => 'pkgrefnum',
2056 'unique' => [ [ 'pkgnum', 'refnum' ] ],
2057 'index' => [ [ 'pkgnum' ], [ 'refnum' ] ],
2059 # name type nullability length default local
2063 # 'num', 'serial', '', '', '', '',
2065 # 'primary_key' => 'num',