3 use vars qw(@ISA @EXPORT_OK $DEBUG $setup_hack %dbdef_cache);
4 use subs qw(reload_dbdef);
6 use DBIx::DBSchema 0.30;
7 use DBIx::DBSchema::Table;
8 use DBIx::DBSchema::Column 0.06;
9 use DBIx::DBSchema::ColGroup::Unique;
10 use DBIx::DBSchema::ColGroup::Index;
11 use FS::UID qw(datasrc);
14 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
19 #ask FS::UID to run this stuff for us later
20 FS::UID->install_callback( sub {
21 #$conf = new FS::Conf;
22 &reload_dbdef("/usr/local/etc/freeside/dbdef.". datasrc)
23 unless $setup_hack; #$setup_hack needed now?
28 FS::Schema - Freeside database schema
32 use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
34 $dbdef = reload_dbdef;
35 $dbdef = reload_dbdef "/non/standard/filename";
37 $dbdef_dist = dbdef_dist;
41 This class represents the database schema.
47 =item reload_dbdef([FILENAME])
49 Load a database definition (see L<DBIx::DBSchema>), optionally from a
50 non-default filename. This command is executed at startup unless
51 I<$FS::Schema::setup_hack> is true. Returns a DBIx::DBSchema object.
58 unless ( exists $dbdef_cache{$file} ) {
59 warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
60 $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
61 or die "can't load database schema from $file";
63 warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
65 $dbdef = $dbdef_cache{$file};
70 Returns the current database definition (represents the current database,
71 assuming it is up-to-date). See L<DBIx::DBSchema>.
77 =item dbdef_dist [ OPTION => VALUE ... ]
79 Returns the current canoical database definition as defined in this file.
86 # create a dbdef object from the old data structure
89 my $tables_hashref = tables_hashref();
92 my $dbdef = new DBIx::DBSchema map {
94 while (@{$tables_hashref->{$_}{'columns'}}) {
95 #my($name, $type, $null, $length, $default, $local) =
97 splice @{$tables_hashref->{$_}{'columns'}}, 0, 6;
98 my %hash = map { $_ => shift @coldef }
99 qw( name type null length default local );
101 unless ( defined $hash{'default'} ) {
103 join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
106 push @columns, new DBIx::DBSchema::Column ( \%hash );
108 DBIx::DBSchema::Table->new(
110 $tables_hashref->{$_}{'primary_key'},
111 DBIx::DBSchema::ColGroup::Unique->new($tables_hashref->{$_}{'unique'}),
112 DBIx::DBSchema::ColGroup::Index->new($tables_hashref->{$_}{'index'}),
115 } keys %$tables_hashref;
118 warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
119 warn "[debug]$me $_\n" foreach $dbdef->tables;
122 my $cust_main = $dbdef->table('cust_main');
123 #unless ($ship) { #remove ship_ from cust_main
124 # $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
125 #} else { #add indices
126 push @{$cust_main->index->lol_ref},
127 map { [ "ship_$_" ] } qw( last company daytime night fax );
130 #add radius attributes to svc_acct
132 #my($svc_acct)=$dbdef->table('svc_acct');
135 #foreach $attribute (@attributes) {
136 # $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
137 # 'radius_'. $attribute,
144 #foreach $attribute (@check_attributes) {
145 # $svc_acct->addcolumn( new DBIx::DBSchema::Column (
153 #create history tables (false laziness w/create-history-tables)
155 grep { ! /^clientapi_session/ }
159 my $tableobj = $dbdef->table($table)
160 or die "unknown table $table";
162 die "unique->lol_ref undefined for $table"
163 unless defined $tableobj->unique->lol_ref;
164 die "index->lol_ref undefined for $table"
165 unless defined $tableobj->index->lol_ref;
167 my $h_tableobj = DBIx::DBSchema::Table->new( {
169 primary_key => 'historynum',
170 unique => DBIx::DBSchema::ColGroup::Unique->new( [] ),
171 'index' => DBIx::DBSchema::ColGroup::Index->new( [
172 @{$tableobj->unique->lol_ref},
173 @{$tableobj->index->lol_ref}
176 DBIx::DBSchema::Column->new( {
177 'name' => 'historynum',
179 'null' => 'NOT NULL',
184 DBIx::DBSchema::Column->new( {
185 'name' => 'history_date',
192 DBIx::DBSchema::Column->new( {
193 'name' => 'history_user',
195 'null' => 'NOT NULL',
200 DBIx::DBSchema::Column->new( {
201 'name' => 'history_action',
203 'null' => 'NOT NULL',
209 my $column = $tableobj->column($_);
211 #clone so as to not disturb the original
212 $column = DBIx::DBSchema::Column->new( {
213 map { $_ => $column->$_() }
214 qw( name type null length default local )
217 if ( $column->type eq 'serial' ) {
218 $column->type('int');
219 $column->null('NULL');
221 #$column->default('')
222 # if $column->default =~ /^nextval\(/i;
223 #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
224 #$column->local($local);
229 $dbdef->addtable($h_tableobj);
238 my $char_d = 80; #default maxlength for text fields
240 #my(@date_type) = ( 'timestamp', '', '' );
241 my @date_type = ( 'int', 'NULL', '' );
242 my @perl_type = ( 'text', 'NULL', '' );
243 my @money_type = ( 'decimal', '', '10,2' );
245 my $username_len = 32; #usernamemax config file
247 # name type nullability length default local
253 'agentnum', 'serial', '', '', '', '',
254 'agent', 'varchar', '', $char_d, '', '',
255 'typenum', 'int', '', '', '', '',
256 'freq', 'int', 'NULL', '', '', '',
257 'prog', @perl_type, '', '',
258 'disabled', 'char', 'NULL', 1, '', '',
259 'username', 'varchar', 'NULL', $char_d, '', '',
260 '_password','varchar', 'NULL', $char_d, '', '',
261 'ticketing_queueid', 'int', 'NULL', '', '', '',
263 'primary_key' => 'agentnum',
265 'index' => [ ['typenum'], ['disabled'] ],
270 'typenum', 'serial', '', '', '', '',
271 'atype', 'varchar', '', $char_d, '', '',
273 'primary_key' => 'typenum',
280 'typepkgnum', 'serial', '', '', '', '',
281 'typenum', 'int', '', '', '', '',
282 'pkgpart', 'int', '', '', '', '',
284 'primary_key' => 'typepkgnum',
285 'unique' => [ ['typenum', 'pkgpart'] ],
286 'index' => [ ['typenum'] ],
291 'invnum', 'serial', '', '', '', '',
292 'custnum', 'int', '', '', '', '',
293 '_date', @date_type, '', '',
294 'charged', @money_type, '', '',
295 'printed', 'int', '', '', '', '',
296 'closed', 'char', 'NULL', 1, '', '',
298 'primary_key' => 'invnum',
300 'index' => [ ['custnum'], ['_date'] ],
303 'cust_bill_event' => {
305 'eventnum', 'serial', '', '', '', '',
306 'invnum', 'int', '', '', '', '',
307 'eventpart', 'int', '', '', '', '',
308 '_date', @date_type, '', '',
309 'status', 'varchar', '', $char_d, '', '',
310 'statustext', 'text', 'NULL', '', '', '',
312 'primary_key' => 'eventnum',
313 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
315 'index' => [ ['invnum'], ['status'] ],
318 'part_bill_event' => {
320 'eventpart', 'serial', '', '', '', '',
321 'freq', 'varchar', 'NULL', $char_d, '', '',
322 'payby', 'char', '', 4, '', '',
323 'event', 'varchar', '', $char_d, '', '',
324 'eventcode', @perl_type, '', '',
325 'seconds', 'int', 'NULL', '', '', '',
326 'weight', 'int', '', '', '', '',
327 'plan', 'varchar', 'NULL', $char_d, '', '',
328 'plandata', 'text', 'NULL', '', '', '',
329 'disabled', 'char', 'NULL', 1, '', '',
331 'primary_key' => 'eventpart',
333 'index' => [ ['payby'], ['disabled'], ],
338 'billpkgnum', 'serial', '', '', '', '',
339 'pkgnum', 'int', '', '', '', '',
340 'invnum', 'int', '', '', '', '',
341 'setup', @money_type, '', '',
342 'recur', @money_type, '', '',
343 'sdate', @date_type, '', '',
344 'edate', @date_type, '', '',
345 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
347 'primary_key' => 'billpkgnum',
349 'index' => [ ['invnum'], [ 'pkgnum' ] ],
352 'cust_bill_pkg_detail' => {
354 'detailnum', 'serial', '', '', '', '',
355 'pkgnum', 'int', '', '', '', '',
356 'invnum', 'int', '', '', '', '',
357 'detail', 'varchar', '', $char_d, '', '',
359 'primary_key' => 'detailnum',
361 'index' => [ [ 'pkgnum', 'invnum' ] ],
366 'crednum', 'serial', '', '', '', '',
367 'custnum', 'int', '', '', '', '',
368 '_date', @date_type, '', '',
369 'amount', @money_type, '', '',
370 'otaker', 'varchar', '', 32, '', '',
371 'reason', 'text', 'NULL', '', '', '',
372 'closed', 'char', 'NULL', 1, '', '',
374 'primary_key' => 'crednum',
376 'index' => [ ['custnum'] ],
379 'cust_credit_bill' => {
381 'creditbillnum', 'serial', '', '', '', '',
382 'crednum', 'int', '', '', '', '',
383 'invnum', 'int', '', '', '', '',
384 '_date', @date_type, '', '',
385 'amount', @money_type, '', '',
387 'primary_key' => 'creditbillnum',
389 'index' => [ ['crednum'], ['invnum'] ],
394 'custnum', 'serial', '', '', '', '',
395 'agentnum', 'int', '', '', '', '',
396 # 'titlenum', 'int', 'NULL', '', '', '',
397 'last', 'varchar', '', $char_d, '', '',
398 # 'middle', 'varchar', 'NULL', $char_d, '', '',
399 'first', 'varchar', '', $char_d, '', '',
400 'ss', 'varchar', 'NULL', 11, '', '',
401 'company', 'varchar', 'NULL', $char_d, '', '',
402 'address1', 'varchar', '', $char_d, '', '',
403 'address2', 'varchar', 'NULL', $char_d, '', '',
404 'city', 'varchar', '', $char_d, '', '',
405 'county', 'varchar', 'NULL', $char_d, '', '',
406 'state', 'varchar', 'NULL', $char_d, '', '',
407 'zip', 'varchar', 'NULL', 10, '', '',
408 'country', 'char', '', 2, '', '',
409 'daytime', 'varchar', 'NULL', 20, '', '',
410 'night', 'varchar', 'NULL', 20, '', '',
411 'fax', 'varchar', 'NULL', 12, '', '',
412 'ship_last', 'varchar', 'NULL', $char_d, '', '',
413 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
414 'ship_first', 'varchar', 'NULL', $char_d, '', '',
415 'ship_company', 'varchar', 'NULL', $char_d, '', '',
416 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
417 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
418 'ship_city', 'varchar', 'NULL', $char_d, '', '',
419 'ship_county', 'varchar', 'NULL', $char_d, '', '',
420 'ship_state', 'varchar', 'NULL', $char_d, '', '',
421 'ship_zip', 'varchar', 'NULL', 10, '', '',
422 'ship_country', 'char', 'NULL', 2, '', '',
423 'ship_daytime', 'varchar', 'NULL', 20, '', '',
424 'ship_night', 'varchar', 'NULL', 20, '', '',
425 'ship_fax', 'varchar', 'NULL', 12, '', '',
426 'payby', 'char', '', 4, '', '',
427 'payinfo', 'varchar', 'NULL', 512, '', '',
428 'paycvv', 'varchar', 'NULL', 512, '', '',
429 'paymask', 'varchar', 'NULL', $char_d, '', '',
430 #'paydate', @date_type, '', '',
431 'paydate', 'varchar', 'NULL', 10, '', '',
432 'paystart_month', 'int', 'NULL', '', '', '',
433 'paystart_year', 'int', 'NULL', '', '', '',
434 'payissue', 'varchar', 'NULL', 2, '', '',
435 'payname', 'varchar', 'NULL', $char_d, '', '',
436 'payip', 'varchar', 'NULL', 15, '', '',
437 'tax', 'char', 'NULL', 1, '', '',
438 'otaker', 'varchar', '', 32, '', '',
439 'refnum', 'int', '', '', '', '',
440 'referral_custnum', 'int', 'NULL', '', '', '',
441 'comments', 'text', 'NULL', '', '', '',
442 'spool_cdr','char', 'NULL', 1, '', '',
444 'primary_key' => 'custnum',
446 #'index' => [ ['last'], ['company'] ],
447 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
448 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
449 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
450 [ 'ship_last' ], [ 'ship_company' ],
451 [ 'payby' ], [ 'paydate' ],
456 'cust_main_invoice' => {
458 'destnum', 'serial', '', '', '', '',
459 'custnum', 'int', '', '', '', '',
460 'dest', 'varchar', '', $char_d, '', '',
462 'primary_key' => 'destnum',
464 'index' => [ ['custnum'], ],
467 'cust_main_county' => { #county+state+country are checked off the
468 #cust_main_county for validation and to provide
471 'taxnum', 'serial', '', '', '', '',
472 'state', 'varchar', 'NULL', $char_d, '', '',
473 'county', 'varchar', 'NULL', $char_d, '', '',
474 'country', 'char', '', 2, '', '',
475 'taxclass', 'varchar', 'NULL', $char_d, '', '',
476 'exempt_amount', @money_type, '', '',
477 'tax', 'real', '', '', '', '', #tax %
478 'taxname', 'varchar', 'NULL', $char_d, '', '',
479 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
480 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
482 'primary_key' => 'taxnum',
484 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
485 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
490 'paynum', 'serial', '', '', '', '',
491 #now cust_bill_pay #'invnum', 'int', '', '', '', '',
492 'custnum', 'int', '', '', '', '',
493 'paid', @money_type, '', '',
494 '_date', @date_type, '', '',
495 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
496 # index into payby table
498 'payinfo', 'varchar', 'NULL', $char_d, '', '', #see cust_main above
499 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
500 'closed', 'char', 'NULL', 1, '', '',
502 'primary_key' => 'paynum',
504 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
509 'paynum', 'int', '', '', '', '',
510 'custnum', 'int', '', '', '', '',
511 'paid', @money_type, '', '',
512 '_date', @date_type, '', '',
513 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
514 # index into payby table
516 'payinfo', 'varchar', 'NULL', $char_d, '', '', #see cust_main above
517 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
518 'closed', 'char', 'NULL', 1, '', '',
519 'void_date', @date_type, '', '',
520 'reason', 'varchar', 'NULL', $char_d, '', '',
521 'otaker', 'varchar', '', 32, '', '',
523 'primary_key' => 'paynum',
525 'index' => [ [ 'custnum' ] ],
530 'billpaynum', 'serial', '', '', '', '',
531 'invnum', 'int', '', '', '', '',
532 'paynum', 'int', '', '', '', '',
533 'amount', @money_type, '', '',
534 '_date', @date_type, '', '',
536 'primary_key' => 'billpaynum',
538 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
541 'pay_batch' => { #batches of payments to an external processor
543 'batchnum', 'serial', '', '', '', '',
544 'status', 'char', 'NULL', 1, '', '',
546 'primary_key' => 'batchnum',
551 'cust_pay_batch' => { #what's this used for again? list of customers
552 #in current CARD batch? (necessarily CARD?)
554 'paybatchnum', 'serial', '', '', '', '',
555 'batchnum', 'int', '', '', '', '',
556 'invnum', 'int', '', '', '', '',
557 'custnum', 'int', '', '', '', '',
558 'last', 'varchar', '', $char_d, '', '',
559 'first', 'varchar', '', $char_d, '', '',
560 'address1', 'varchar', '', $char_d, '', '',
561 'address2', 'varchar', 'NULL', $char_d, '', '',
562 'city', 'varchar', '', $char_d, '', '',
563 'state', 'varchar', 'NULL', $char_d, '', '',
564 'zip', 'varchar', 'NULL', 10, '', '',
565 'country', 'char', '', 2, '', '',
566 # 'trancode', 'int', '', '', '', ''
567 'payinfo', 'varchar', '', 512, '', '',
568 #'exp', @date_type, '', ''
569 'exp', 'varchar', '', 11, '', '',
570 'payname', 'varchar', 'NULL', $char_d, '', '',
571 'amount', @money_type, '', '',
573 'primary_key' => 'paybatchnum',
575 'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
580 'pkgnum', 'serial', '', '', '', '',
581 'custnum', 'int', '', '', '', '',
582 'pkgpart', 'int', '', '', '', '',
583 'otaker', 'varchar', '', 32, '', '',
584 'setup', @date_type, '', '',
585 'bill', @date_type, '', '',
586 'last_bill', @date_type, '', '',
587 'susp', @date_type, '', '',
588 'cancel', @date_type, '', '',
589 'expire', @date_type, '', '',
590 'manual_flag', 'char', 'NULL', 1, '', '',
592 'primary_key' => 'pkgnum',
594 'index' => [ ['custnum'], ['pkgpart'] ],
599 'refundnum', 'serial', '', '', '', '',
600 #now cust_credit_refund #'crednum', 'int', '', '', '', '',
601 'custnum', 'int', '', '', '', '',
602 '_date', @date_type, '', '',
603 'refund', @money_type, '', '',
604 'otaker', 'varchar', '', 32, '', '',
605 'reason', 'varchar', '', $char_d, '', '',
606 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
607 # be index into payby
609 'payinfo', 'varchar', 'NULL', $char_d, '', '', #see cust_main above
610 'paybatch', 'varchar', 'NULL', $char_d, '', '',
611 'closed', 'char', 'NULL', 1, '', '',
613 'primary_key' => 'refundnum',
618 'cust_credit_refund' => {
620 'creditrefundnum', 'serial', '', '', '', '',
621 'crednum', 'int', '', '', '', '',
622 'refundnum', 'int', '', '', '', '',
623 'amount', @money_type, '', '',
624 '_date', @date_type, '', '',
626 'primary_key' => 'creditrefundnum',
628 'index' => [ [ 'crednum', 'refundnum' ] ],
634 'svcnum', 'serial', '', '', '', '',
635 'pkgnum', 'int', 'NULL', '', '', '',
636 'svcpart', 'int', '', '', '', '',
638 'primary_key' => 'svcnum',
640 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
645 'pkgpart', 'serial', '', '', '', '',
646 'pkg', 'varchar', '', $char_d, '', '',
647 'comment', 'varchar', '', $char_d, '', '',
648 'promo_code', 'varchar', 'NULL', $char_d, '', '',
649 'setup', @perl_type, '', '',
650 'freq', 'varchar', '', $char_d, '', '', #billing frequency
651 'recur', @perl_type, '', '',
652 'setuptax', 'char', 'NULL', 1, '', '',
653 'recurtax', 'char', 'NULL', 1, '', '',
654 'plan', 'varchar', 'NULL', $char_d, '', '',
655 'plandata', 'text', 'NULL', '', '', '',
656 'disabled', 'char', 'NULL', 1, '', '',
657 'taxclass', 'varchar', 'NULL', $char_d, '', '',
658 'classnum', 'int', 'NULL', '', '', '',
660 'primary_key' => 'pkgpart',
662 'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
667 # 'titlenum', 'int', '', '',
668 # 'title', 'varchar', '', $char_d,
670 # 'primary_key' => 'titlenum',
671 # 'unique' => [ [] ],
677 'pkgsvcnum', 'serial', '', '', '', '',
678 'pkgpart', 'int', '', '', '', '',
679 'svcpart', 'int', '', '', '', '',
680 'quantity', 'int', '', '', '', '',
681 'primary_svc','char', 'NULL', 1, '', '',
683 'primary_key' => 'pkgsvcnum',
684 'unique' => [ ['pkgpart', 'svcpart'] ],
685 'index' => [ ['pkgpart'] ],
690 'refnum', 'serial', '', '', '', '',
691 'referral', 'varchar', '', $char_d, '', '',
692 'disabled', 'char', 'NULL', 1, '', '',
694 'primary_key' => 'refnum',
696 'index' => [ ['disabled'] ],
701 'svcpart', 'serial', '', '', '', '',
702 'svc', 'varchar', '', $char_d, '', '',
703 'svcdb', 'varchar', '', $char_d, '', '',
704 'disabled', 'char', 'NULL', 1, '', '',
706 'primary_key' => 'svcpart',
708 'index' => [ [ 'disabled' ] ],
711 'part_svc_column' => {
713 'columnnum', 'serial', '', '', '', '',
714 'svcpart', 'int', '', '', '', '',
715 'columnname', 'varchar', '', 64, '', '',
716 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
717 'columnflag', 'char', 'NULL', 1, '', '',
719 'primary_key' => 'columnnum',
720 'unique' => [ [ 'svcpart', 'columnname' ] ],
721 'index' => [ [ 'svcpart' ] ],
724 #(this should be renamed to part_pop)
727 'popnum', 'serial', '', '', '', '',
728 'city', 'varchar', '', $char_d, '', '',
729 'state', 'varchar', '', $char_d, '', '',
730 'ac', 'char', '', 3, '', '',
731 'exch', 'char', '', 3, '', '',
732 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
734 'primary_key' => 'popnum',
736 'index' => [ [ 'state' ] ],
739 'part_pop_local' => {
741 'localnum', 'serial', '', '', '', '',
742 'popnum', 'int', '', '', '', '',
743 'city', 'varchar', 'NULL', $char_d, '', '',
744 'state', 'char', 'NULL', 2, '', '',
745 'npa', 'char', '', 3, '', '',
746 'nxx', 'char', '', 3, '', '',
748 'primary_key' => 'localnum',
750 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
755 'svcnum', 'int', '', '', '', '',
756 'username', 'varchar', '', $username_len, '', '', #unique (& remove dup code)
757 '_password', 'varchar', '', 72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
758 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
759 'popnum', 'int', 'NULL', '', '', '',
760 'uid', 'int', 'NULL', '', '', '',
761 'gid', 'int', 'NULL', '', '', '',
762 'finger', 'varchar', 'NULL', $char_d, '', '',
763 'dir', 'varchar', 'NULL', $char_d, '', '',
764 'shell', 'varchar', 'NULL', $char_d, '', '',
765 'quota', 'varchar', 'NULL', $char_d, '', '',
766 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
767 'seconds', 'int', 'NULL', '', '', '', #uhhhh
768 'domsvc', 'int', '', '', '', '',
770 'primary_key' => 'svcnum',
771 #'unique' => [ [ 'username', 'domsvc' ] ],
773 'index' => [ ['username'], ['domsvc'] ],
778 # 'svcnum', 'int', '', '',
779 # 'amount', @money_type,
781 # 'primary_key' => 'svcnum',
782 # 'unique' => [ [] ],
788 'svcnum', 'int', '', '', '', '',
789 'domain', 'varchar', '', $char_d, '', '',
790 'catchall', 'int', 'NULL', '', '', '',
792 'primary_key' => 'svcnum',
793 'unique' => [ ['domain'] ],
799 'recnum', 'serial', '', '', '', '',
800 'svcnum', 'int', '', '', '', '',
801 'reczone', 'varchar', '', 255, '', '',
802 'recaf', 'char', '', 2, '', '',
803 'rectype', 'varchar', '', 5, '', '',
804 'recdata', 'varchar', '', 255, '', '',
806 'primary_key' => 'recnum',
808 'index' => [ ['svcnum'] ],
813 'svcnum', 'int', '', '', '', '',
814 'srcsvc', 'int', 'NULL', '', '', '',
815 'src', 'varchar', 'NULL', 255, '', '',
816 'dstsvc', 'int', 'NULL', '', '', '',
817 'dst', 'varchar', 'NULL', 255, '', '',
819 'primary_key' => 'svcnum',
821 'index' => [ ['srcsvc'], ['dstsvc'] ],
826 'svcnum', 'int', '', '', '', '',
827 'recnum', 'int', '', '', '', '',
828 'usersvc', 'int', '', '', '', '',
830 'primary_key' => 'svcnum',
837 # 'svcnum', 'int', '', '',
838 # 'svcnum', 'int', '', '',
839 # 'svcnum', 'int', '', '',
840 # 'worker', 'varchar', '', $char_d,
841 # '_date', @date_type,
843 # 'primary_key' => 'svcnum',
844 # 'unique' => [ [] ],
850 'prepaynum', 'serial', '', '', '', '',
851 'identifier', 'varchar', '', $char_d, '', '',
852 'amount', @money_type, '', '',
853 'seconds', 'int', 'NULL', '', '', '',
854 'agentnum', 'int', 'NULL', '', '', '',
856 'primary_key' => 'prepaynum',
857 'unique' => [ ['identifier'] ],
863 'portnum', 'serial', '', '', '', '',
864 'ip', 'varchar', 'NULL', 15, '', '',
865 'nasport', 'int', 'NULL', '', '', '',
866 'nasnum', 'int', '', '', '', '',
868 'primary_key' => 'portnum',
875 'nasnum', 'serial', '', '', '', '',
876 'nas', 'varchar', '', $char_d, '', '',
877 'nasip', 'varchar', '', 15, '', '',
878 'nasfqdn', 'varchar', '', $char_d, '', '',
879 'last', 'int', '', '', '', '',
881 'primary_key' => 'nasnum',
882 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
883 'index' => [ [ 'last' ] ],
888 'sessionnum', 'serial', '', '', '', '',
889 'portnum', 'int', '', '', '', '',
890 'svcnum', 'int', '', '', '', '',
891 'login', @date_type, '', '',
892 'logout', @date_type, '', '',
894 'primary_key' => 'sessionnum',
896 'index' => [ [ 'portnum' ] ],
901 'jobnum', 'serial', '', '', '', '',
902 'job', 'text', '', '', '', '',
903 '_date', 'int', '', '', '', '',
904 'status', 'varchar', '', $char_d, '', '',
905 'statustext', 'text', 'NULL', '', '', '',
906 'svcnum', 'int', 'NULL', '', '', '',
908 'primary_key' => 'jobnum',
910 'index' => [ [ 'svcnum' ], [ 'status' ] ],
915 'argnum', 'serial', '', '', '', '',
916 'jobnum', 'int', '', '', '', '',
917 'arg', 'text', 'NULL', '', '', '',
919 'primary_key' => 'argnum',
921 'index' => [ [ 'jobnum' ] ],
926 'dependnum', 'serial', '', '', '', '',
927 'jobnum', 'int', '', '', '', '',
928 'depend_jobnum', 'int', '', '', '', '',
930 'primary_key' => 'dependnum',
932 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
937 'exportsvcnum' => 'serial', '', '', '', '',
938 'exportnum' => 'int', '', '', '', '',
939 'svcpart' => 'int', '', '', '', '',
941 'primary_key' => 'exportsvcnum',
942 'unique' => [ [ 'exportnum', 'svcpart' ] ],
943 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
948 'exportnum', 'serial', '', '', '', '',
949 'machine', 'varchar', '', $char_d, '', '',
950 'exporttype', 'varchar', '', $char_d, '', '',
951 'nodomain', 'char', 'NULL', 1, '', '',
953 'primary_key' => 'exportnum',
955 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
958 'part_export_option' => {
960 'optionnum', 'serial', '', '', '', '',
961 'exportnum', 'int', '', '', '', '',
962 'optionname', 'varchar', '', $char_d, '', '',
963 'optionvalue', 'text', 'NULL', '', '', '',
965 'primary_key' => 'optionnum',
967 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
970 'radius_usergroup' => {
972 'usergroupnum', 'serial', '', '', '', '',
973 'svcnum', 'int', '', '', '', '',
974 'groupname', 'varchar', '', $char_d, '', '',
976 'primary_key' => 'usergroupnum',
978 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
983 'msgnum', 'serial', '', '', '', '',
984 'msgcode', 'varchar', '', $char_d, '', '',
985 'locale', 'varchar', '', 16, '', '',
986 'msg', 'text', '', '', '', '',
988 'primary_key' => 'msgnum',
989 'unique' => [ [ 'msgcode', 'locale' ] ],
993 'cust_tax_exempt' => {
995 'exemptnum', 'serial', '', '', '', '',
996 'custnum', 'int', '', '', '', '',
997 'taxnum', 'int', '', '', '', '',
998 'year', 'int', '', '', '', '',
999 'month', 'int', '', '', '', '',
1000 'amount', @money_type, '', '',
1002 'primary_key' => 'exemptnum',
1003 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1007 'cust_tax_exempt_pkg' => {
1009 'exemptpkgnum', 'serial', '', '', '', '',
1010 #'custnum', 'int', '', '', '', ''
1011 'billpkgnum', 'int', '', '', '', '',
1012 'taxnum', 'int', '', '', '', '',
1013 'year', 'int', '', '', '', '',
1014 'month', 'int', '', '', '', '',
1015 'amount', @money_type, '', '',
1017 'primary_key' => 'exemptpkgnum',
1019 'index' => [ [ 'taxnum', 'year', 'month' ],
1027 'routernum', 'serial', '', '', '', '',
1028 'routername', 'varchar', '', $char_d, '', '',
1029 'svcnum', 'int', 'NULL', '', '', '',
1031 'primary_key' => 'routernum',
1036 'part_svc_router' => {
1038 'svcrouternum', 'serial', '', '', '', '',
1039 'svcpart', 'int', '', '', '', '',
1040 'routernum', 'int', '', '', '', '',
1042 'primary_key' => 'svcrouternum',
1049 'blocknum', 'serial', '', '', '', '',
1050 'routernum', 'int', '', '', '', '',
1051 'ip_gateway', 'varchar', '', 15, '', '',
1052 'ip_netmask', 'int', '', '', '', '',
1054 'primary_key' => 'blocknum',
1055 'unique' => [ [ 'blocknum', 'routernum' ] ],
1059 'svc_broadband' => {
1061 'svcnum', 'int', '', '', '', '',
1062 'blocknum', 'int', '', '', '', '',
1063 'speed_up', 'int', '', '', '', '',
1064 'speed_down', 'int', '', '', '', '',
1065 'ip_addr', 'varchar', '', 15, '', '',
1067 'primary_key' => 'svcnum',
1072 'part_virtual_field' => {
1074 'vfieldpart', 'int', '', '', '', '',
1075 'dbtable', 'varchar', '', 32, '', '',
1076 'name', 'varchar', '', 32, '', '',
1077 'check_block', 'text', 'NULL', '', '', '',
1078 'length', 'int', 'NULL', '', '', '',
1079 'list_source', 'text', 'NULL', '', '', '',
1080 'label', 'varchar', 'NULL', 80, '', '',
1082 'primary_key' => 'vfieldpart',
1087 'virtual_field' => {
1089 'vfieldnum', 'serial', '', '', '', '',
1090 'recnum', 'int', '', '', '', '',
1091 'vfieldpart', 'int', '', '', '', '',
1092 'value', 'varchar', '', 128, '', '',
1094 'primary_key' => 'vfieldnum',
1095 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1101 'snarfnum', 'int', '', '', '', '',
1102 'svcnum', 'int', '', '', '', '',
1103 'machine', 'varchar', '', 255, '', '',
1104 'protocol', 'varchar', '', $char_d, '', '',
1105 'username', 'varchar', '', $char_d, '', '',
1106 '_password', 'varchar', '', $char_d, '', '',
1108 'primary_key' => 'snarfnum',
1110 'index' => [ [ 'svcnum' ] ],
1115 'svcnum', 'int', '', '', '', '',
1116 'id', 'int', 'NULL', '', '', '',
1117 'title', 'varchar', 'NULL', $char_d, '', '',
1119 'primary_key' => 'svcnum',
1124 'cust_pay_refund' => {
1126 'payrefundnum', 'serial', '', '', '', '',
1127 'paynum', 'int', '', '', '', '',
1128 'refundnum', 'int', '', '', '', '',
1129 '_date', @date_type, '', '',
1130 'amount', @money_type, '', '',
1132 'primary_key' => 'payrefundnum',
1134 'index' => [ ['paynum'], ['refundnum'] ],
1137 'part_pkg_option' => {
1139 'optionnum', 'serial', '', '', '', '',
1140 'pkgpart', 'int', '', '', '', '',
1141 'optionname', 'varchar', '', $char_d, '', '',
1142 'optionvalue', 'text', 'NULL', '', '', '',
1144 'primary_key' => 'optionnum',
1146 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1151 'ratenum', 'serial', '', '', '', '',
1152 'ratename', 'varchar', '', $char_d, '', '',
1154 'primary_key' => 'ratenum',
1161 'ratedetailnum', 'serial', '', '', '', '',
1162 'ratenum', 'int', '', '', '', '',
1163 'orig_regionnum', 'int', 'NULL', '', '', '',
1164 'dest_regionnum', 'int', '', '', '', '',
1165 'min_included', 'int', '', '', '', '',
1166 #'min_charge', @money_type, '', '',
1167 'min_charge', 'decimal', '', '10,5', '', '',
1168 'sec_granularity', 'int', '', '', '', '',
1169 #time period (link to table of periods)?
1171 'primary_key' => 'ratedetailnum',
1172 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1173 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1178 'regionnum', 'serial', '', '', '', '',
1179 'regionname', 'varchar', '', $char_d, '', '',
1181 'primary_key' => 'regionnum',
1188 'prefixnum', 'serial', '', '', '', '',
1189 'regionnum', 'int', '', '',, '', '',
1190 'countrycode', 'varchar', '', 3, '', '',
1191 'npa', 'varchar', 'NULL', 6, '', '',
1192 'nxx', 'varchar', 'NULL', 3, '', '',
1194 'primary_key' => 'prefixnum',
1196 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1201 'codenum', 'serial', '', '', '', '',
1202 'code', 'varchar', '', $char_d, '', '',
1203 'agentnum', 'int', '', '', '', '',
1205 'primary_key' => 'codenum',
1206 'unique' => [ [ 'agentnum', 'code' ] ],
1207 'index' => [ [ 'agentnum' ] ],
1212 'codepkgnum', 'serial', '', '', '', '',
1213 'codenum', 'int', '', '', '', '',
1214 'pkgpart', 'int', '', '', '', '',
1216 'primary_key' => 'codepkgnum',
1217 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1218 'index' => [ [ 'codenum' ] ],
1221 'clientapi_session' => {
1223 'sessionnum', 'serial', '', '', '', '',
1224 'sessionid', 'varchar', '', $char_d, '', '',
1225 'namespace', 'varchar', '', $char_d, '', '',
1227 'primary_key' => 'sessionnum',
1228 'unique' => [ [ 'sessionid', 'namespace' ] ],
1232 'clientapi_session_field' => {
1234 'fieldnum', 'serial', '', '', '', '',
1235 'sessionnum', 'int', '', '', '', '',
1236 'fieldname', 'varchar', '', $char_d, '', '',
1237 'fieldvalue', 'text', 'NULL', '', '', '',
1239 'primary_key' => 'fieldnum',
1240 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1244 'payment_gateway' => {
1246 'gatewaynum', 'serial', '', '', '', '',
1247 'gateway_module', 'varchar', '', $char_d, '', '',
1248 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1249 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1250 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1251 'disabled', 'char', 'NULL', 1, '', '',
1253 'primary_key' => 'gatewaynum',
1255 'index' => [ [ 'disabled' ] ],
1258 'payment_gateway_option' => {
1260 'optionnum', 'serial', '', '', '', '',
1261 'gatewaynum', 'int', '', '', '', '',
1262 'optionname', 'varchar', '', $char_d, '', '',
1263 'optionvalue', 'text', 'NULL', '', '', '',
1265 'primary_key' => 'optionnum',
1267 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1270 'agent_payment_gateway' => {
1272 'agentgatewaynum', 'serial', '', '', '', '',
1273 'agentnum', 'int', '', '', '', '',
1274 'gatewaynum', 'int', '', '', '', '',
1275 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1276 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1278 'primary_key' => 'agentgatewaynum',
1280 'index' => [ [ 'agentnum', 'cardtype' ], ],
1285 'bannum', 'serial', '', '', '', '',
1286 'payby', 'char', '', 4, '', '',
1287 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1288 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1289 '_date', @date_type, '', '',
1290 'otaker', 'varchar', '', 32, '', '',
1291 'reason', 'varchar', 'NULL', $char_d, '', '',
1293 'primary_key' => 'bannum',
1294 'unique' => [ [ 'payby', 'payinfo' ] ],
1298 'cancel_reason' => {
1300 'reasonnum', 'serial', '', '', '', '',
1301 'reason', 'varchar', '', $char_d, '', '',
1302 'disabled', 'char', 'NULL', 1, '', '',
1304 'primary_key' => 'reasonnum',
1306 'index' => [ [ 'disabled' ] ],
1311 'classnum', 'serial', '', '', '', '',
1312 'classname', 'varchar', '', $char_d, '', '',
1314 'primary_key' => 'classnum',
1321 # qw( name type null length default local );
1327 'acctid', 'bigserial', '', '', '', '',
1328 'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1329 'clid', 'varchar', '', $char_d, \"''", '',
1330 'src', 'varchar', '', $char_d, \"''", '',
1331 'dst', 'varchar', '', $char_d, \"''", '',
1332 'dcontext', 'varchar', '', $char_d, \"''", '',
1333 'channel', 'varchar', '', $char_d, \"''", '',
1334 'dstchannel', 'varchar', '', $char_d, \"''", '',
1335 'lastapp', 'varchar', '', $char_d, \"''", '',
1336 'lastdata', 'varchar', '', $char_d, \"''", '',
1338 #these don't seem to be logged by most of the SQL cdr_* modules
1339 #except tds under sql-illegal names, so;
1340 # ... don't rely on them for rating?
1341 # and, what they hey, i went ahead and changed the names and data types
1342 # to freeside-style dates...
1343 #'start', 'timestamp', 'NULL', '', '', '',
1344 #'answer', 'timestamp', 'NULL', '', '', '',
1345 #'end', 'timestamp', 'NULL', '', '', '',
1346 'startdate', @date_type, '', '',
1347 'answerdate', @date_type, '', '',
1348 'enddate', @date_type, '', '',
1351 'duration', 'int', '', '', 0, '',
1352 'billsec', 'int', '', '', 0, '',
1353 'disposition', 'varchar', '', 45, \"''", '',
1354 'amaflags', 'int', '', '', 0, '',
1355 'accountcode', 'varchar', '', 20, \"''", '',
1356 'uniqueid', 'varchar', '', 32, \"''", '',
1357 'userfield', 'varchar', '', 255, \"''", '',
1360 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1364 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1365 'cdrtypenum', 'int', 'NULL', '', '', '',
1367 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1369 'upstream_currency', 'char', 'NULL', 3, '', '',
1370 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1371 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1373 # how it was rated internally...
1374 'ratedetailnum', 'int', 'NULL', '', '', '',
1375 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1377 'distance', 'decimal', 'NULL', '', '', '',
1378 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1380 #cdr_calltype: the big list in appendix 2
1381 'calltypenum', 'int', 'NULL', '', '', '',
1383 'description', 'varchar', 'NULL', $char_d, '', '',
1384 'quantity', 'int', 'NULL', '', '', '',
1386 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1387 'carrierid', 'int', 'NULL', '', '', '',
1389 'upstream_rateid', 'int', 'NULL', '', '', '',
1392 #and now for our own fields
1395 # a svcnum... right..?
1396 'svcnum', 'int', 'NULL', '', '', '',
1398 #NULL, done (or something)
1399 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1402 'primary_key' => 'acctid',
1404 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1409 'calltypenum', 'serial', '', '', '', '',
1410 'calltypename', 'varchar', '', $char_d, '', '',
1412 'primary_key' => 'calltypenum',
1419 'cdrtypenum' => 'serial', '', '', '', '',
1420 'cdrtypename' => 'varchar', '', '', '', '',
1422 'primary_key' => 'cdrtypenum',
1429 'carrierid' => 'serial', '', '', '', '',
1430 'carriername' => 'varchar', '', '', '', '',
1432 'primary_key' => 'carrierid',
1437 #map upstream rateid to ours...
1438 'cdr_upstream_rate' => {
1440 'upstreamratenum', 'serial', '', '', '', '',
1441 'upstream_rateid', 'varchar', '', $char_d, '', '',
1442 'ratedetailnum', 'int', 'NULL', '', '', '',
1444 'primary_key' => 'upstreamratenum', #XXX need a primary key
1445 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1449 'inventory_item' => {
1451 'itemnum', 'serial', '', '', '', '',
1452 'classnum', 'int', '', '', '', '',
1453 'item', 'varchar', '', $char_d, '', '',
1454 'svcnum', 'int', 'NULL', '', '', '',
1456 'primary_key' => 'itemnum',
1457 'unique' => [ [ 'classnum', 'item' ] ],
1458 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1461 'inventory_class' => {
1463 'classnum', 'serial', '', '', '', '',
1464 'classname', 'varchar', '', $char_d, '', '',
1466 'primary_key' => 'classnum',
1473 'usernum', 'serial', '', '', '', '',
1474 'username', 'varchar', '', $char_d, '', '',
1475 '_password', 'varchar', '', $char_d, '', '',
1476 'last', 'varchar', '', $char_d, '', '',
1477 'first', 'varchar', '', $char_d, '', '',
1479 'primary_key' => 'usernum',
1480 'unique' => [ [ 'username' ] ],
1484 'access_user_pref' => {
1486 'prefnum', 'serial', '', '', '', '',
1487 'usernum', 'int', '', '', '', '',
1488 'prefname', 'varchar', '', $char_d, '', '',
1489 'prefvalue', 'text', 'NULL', '', '', '',
1491 'primary_key' => 'prefnum',
1493 'index' => [ [ 'usernum' ] ],
1498 'groupnum', 'serial', '', '', '', '',
1499 'groupname', 'varchar', '', $char_d, '', '',
1501 'primary_key' => 'groupnum',
1502 'unique' => [ [ 'groupname' ] ],
1506 'access_usergroup' => {
1508 'usergroupnum', 'serial', '', '', '', '',
1509 'usernum', 'int', '', '', '', '',
1510 'groupnum', 'int', '', '', '', '',
1512 'primary_key' => 'usergroupnum',
1513 'unique' => [ [ 'usernum', 'groupnum' ] ],
1514 'index' => [ [ 'usernum' ] ],
1517 'access_groupagent' => {
1519 'groupagentnum', 'serial', '', '', '', '',
1520 'groupnum', 'int', '', '', '', '',
1521 'agentnum', 'int', '', '', '', '',
1523 'primary_key' => 'groupagentnum',
1524 'unique' => [ [ 'groupnum', 'agentnum' ] ],
1525 'index' => [ [ 'groupnum' ] ],
1530 'rightnum', 'serial', '', '', '', '',
1531 'righttype', 'varchar', '', $char_d, '', '',
1532 'rightobjnum', 'int', '', '', '', '',
1533 'rightname', 'varchar', '', '', '', '',
1535 'primary_key' => 'rightnum',
1536 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1544 # 'num', 'serial', '', '', '', '',
1546 # 'primary_key' => 'num',