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
251 'agentnum', 'serial', '', '', '', '',
252 'agent', 'varchar', '', $char_d, '', '',
253 'typenum', 'int', '', '', '', '',
254 'freq', 'int', 'NULL', '', '', '',
255 'prog', @perl_type, '', '',
256 'disabled', 'char', 'NULL', 1, '', '',
257 'username', 'varchar', 'NULL', $char_d, '', '',
258 '_password','varchar', 'NULL', $char_d, '', '',
259 'ticketing_queueid', 'int', 'NULL', '', '', '',
261 'primary_key' => 'agentnum',
263 'index' => [ ['typenum'], ['disabled'] ],
268 'typenum', 'serial', '', '', '', '',
269 'atype', 'varchar', '', $char_d, '', '',
271 'primary_key' => 'typenum',
278 'typepkgnum', 'serial', '', '', '', '',
279 'typenum', 'int', '', '', '', '',
280 'pkgpart', 'int', '', '', '', '',
282 'primary_key' => 'typepkgnum',
283 'unique' => [ ['typenum', 'pkgpart'] ],
284 'index' => [ ['typenum'] ],
289 'invnum', 'serial', '', '', '', '',
290 'custnum', 'int', '', '', '', '',
291 '_date', @date_type, '', '',
292 'charged', @money_type, '', '',
293 'printed', 'int', '', '', '', '',
294 'closed', 'char', 'NULL', 1, '', '',
296 'primary_key' => 'invnum',
298 'index' => [ ['custnum'], ['_date'] ],
301 'cust_bill_event' => {
303 'eventnum', 'serial', '', '', '', '',
304 'invnum', 'int', '', '', '', '',
305 'eventpart', 'int', '', '', '', '',
306 '_date', @date_type, '', '',
307 'status', 'varchar', '', $char_d, '', '',
308 'statustext', 'text', 'NULL', '', '', '',
310 'primary_key' => 'eventnum',
311 #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
313 'index' => [ ['invnum'], ['status'] ],
316 'part_bill_event' => {
318 'eventpart', 'serial', '', '', '', '',
319 'freq', 'varchar', 'NULL', $char_d, '', '',
320 'payby', 'char', '', 4, '', '',
321 'event', 'varchar', '', $char_d, '', '',
322 'eventcode', @perl_type, '', '',
323 'seconds', 'int', 'NULL', '', '', '',
324 'weight', 'int', '', '', '', '',
325 'plan', 'varchar', 'NULL', $char_d, '', '',
326 'plandata', 'text', 'NULL', '', '', '',
327 'disabled', 'char', 'NULL', 1, '', '',
329 'primary_key' => 'eventpart',
331 'index' => [ ['payby'], ['disabled'], ],
336 'billpkgnum', 'serial', '', '', '', '',
337 'pkgnum', 'int', '', '', '', '',
338 'invnum', 'int', '', '', '', '',
339 'setup', @money_type, '', '',
340 'recur', @money_type, '', '',
341 'sdate', @date_type, '', '',
342 'edate', @date_type, '', '',
343 'itemdesc', 'varchar', 'NULL', $char_d, '', '',
345 'primary_key' => 'billpkgnum',
347 'index' => [ ['invnum'], [ 'pkgnum' ] ],
350 'cust_bill_pkg_detail' => {
352 'detailnum', 'serial', '', '', '', '',
353 'pkgnum', 'int', '', '', '', '',
354 'invnum', 'int', '', '', '', '',
355 'detail', 'varchar', '', $char_d, '', '',
357 'primary_key' => 'detailnum',
359 'index' => [ [ 'pkgnum', 'invnum' ] ],
364 'crednum', 'serial', '', '', '', '',
365 'custnum', 'int', '', '', '', '',
366 '_date', @date_type, '', '',
367 'amount', @money_type, '', '',
368 'otaker', 'varchar', '', 32, '', '',
369 'reason', 'text', 'NULL', '', '', '',
370 'closed', 'char', 'NULL', 1, '', '',
372 'primary_key' => 'crednum',
374 'index' => [ ['custnum'] ],
377 'cust_credit_bill' => {
379 'creditbillnum', 'serial', '', '', '', '',
380 'crednum', 'int', '', '', '', '',
381 'invnum', 'int', '', '', '', '',
382 '_date', @date_type, '', '',
383 'amount', @money_type, '', '',
385 'primary_key' => 'creditbillnum',
387 'index' => [ ['crednum'], ['invnum'] ],
392 'custnum', 'serial', '', '', '', '',
393 'agentnum', 'int', '', '', '', '',
394 # 'titlenum', 'int', 'NULL', '', '', '',
395 'last', 'varchar', '', $char_d, '', '',
396 # 'middle', 'varchar', 'NULL', $char_d, '', '',
397 'first', 'varchar', '', $char_d, '', '',
398 'ss', 'varchar', 'NULL', 11, '', '',
399 'company', 'varchar', 'NULL', $char_d, '', '',
400 'address1', 'varchar', '', $char_d, '', '',
401 'address2', 'varchar', 'NULL', $char_d, '', '',
402 'city', 'varchar', '', $char_d, '', '',
403 'county', 'varchar', 'NULL', $char_d, '', '',
404 'state', 'varchar', 'NULL', $char_d, '', '',
405 'zip', 'varchar', 'NULL', 10, '', '',
406 'country', 'char', '', 2, '', '',
407 'daytime', 'varchar', 'NULL', 20, '', '',
408 'night', 'varchar', 'NULL', 20, '', '',
409 'fax', 'varchar', 'NULL', 12, '', '',
410 'ship_last', 'varchar', 'NULL', $char_d, '', '',
411 # 'ship_middle', 'varchar', 'NULL', $char_d, '', '',
412 'ship_first', 'varchar', 'NULL', $char_d, '', '',
413 'ship_company', 'varchar', 'NULL', $char_d, '', '',
414 'ship_address1', 'varchar', 'NULL', $char_d, '', '',
415 'ship_address2', 'varchar', 'NULL', $char_d, '', '',
416 'ship_city', 'varchar', 'NULL', $char_d, '', '',
417 'ship_county', 'varchar', 'NULL', $char_d, '', '',
418 'ship_state', 'varchar', 'NULL', $char_d, '', '',
419 'ship_zip', 'varchar', 'NULL', 10, '', '',
420 'ship_country', 'char', 'NULL', 2, '', '',
421 'ship_daytime', 'varchar', 'NULL', 20, '', '',
422 'ship_night', 'varchar', 'NULL', 20, '', '',
423 'ship_fax', 'varchar', 'NULL', 12, '', '',
424 'payby', 'char', '', 4, '', '',
425 'payinfo', 'varchar', 'NULL', 512, '', '',
426 'paycvv', 'varchar', 'NULL', 512, '', '',
427 'paymask', 'varchar', 'NULL', $char_d, '', '',
428 #'paydate', @date_type, '', '',
429 'paydate', 'varchar', 'NULL', 10, '', '',
430 'paystart_month', 'int', 'NULL', '', '', '',
431 'paystart_year', 'int', 'NULL', '', '', '',
432 'payissue', 'varchar', 'NULL', 2, '', '',
433 'payname', 'varchar', 'NULL', $char_d, '', '',
434 'payip', 'varchar', 'NULL', 15, '', '',
435 'tax', 'char', 'NULL', 1, '', '',
436 'otaker', 'varchar', '', 32, '', '',
437 'refnum', 'int', '', '', '', '',
438 'referral_custnum', 'int', 'NULL', '', '', '',
439 'comments', 'text', 'NULL', '', '', '',
440 'spool_cdr','char', 'NULL', 1, '', '',
442 'primary_key' => 'custnum',
444 #'index' => [ ['last'], ['company'] ],
445 'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
446 [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
447 [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
451 'cust_main_invoice' => {
453 'destnum', 'serial', '', '', '', '',
454 'custnum', 'int', '', '', '', '',
455 'dest', 'varchar', '', $char_d, '', '',
457 'primary_key' => 'destnum',
459 'index' => [ ['custnum'], ],
462 'cust_main_county' => { #county+state+country are checked off the
463 #cust_main_county for validation and to provide
466 'taxnum', 'serial', '', '', '', '',
467 'state', 'varchar', 'NULL', $char_d, '', '',
468 'county', 'varchar', 'NULL', $char_d, '', '',
469 'country', 'char', '', 2, '', '',
470 'taxclass', 'varchar', 'NULL', $char_d, '', '',
471 'exempt_amount', @money_type, '', '',
472 'tax', 'real', '', '', '', '', #tax %
473 'taxname', 'varchar', 'NULL', $char_d, '', '',
474 'setuptax', 'char', 'NULL', 1, '', '', # Y = setup tax exempt
475 'recurtax', 'char', 'NULL', 1, '', '', # Y = recur tax exempt
477 'primary_key' => 'taxnum',
479 # 'unique' => [ ['taxnum'], ['state', 'county'] ],
480 'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
485 'paynum', 'serial', '', '', '', '',
486 #now cust_bill_pay #'invnum', 'int', '', '', '', '',
487 'custnum', 'int', '', '', '', '',
488 'paid', @money_type, '', '',
489 '_date', @date_type, '', '',
490 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
491 # index into payby table
493 'payinfo', 'varchar', 'NULL', $char_d, '', '', #see cust_main above
494 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
495 'closed', 'char', 'NULL', 1, '', '',
497 'primary_key' => 'paynum',
499 'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
504 'paynum', 'int', '', '', '', '',
505 'custnum', 'int', '', '', '', '',
506 'paid', @money_type, '', '',
507 '_date', @date_type, '', '',
508 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should be
509 # index into payby table
511 'payinfo', 'varchar', 'NULL', $char_d, '', '', #see cust_main above
512 'paybatch', 'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
513 'closed', 'char', 'NULL', 1, '', '',
514 'void_date', @date_type, '', '',
515 'reason', 'varchar', 'NULL', $char_d, '', '',
516 'otaker', 'varchar', '', 32, '', '',
518 'primary_key' => 'paynum',
520 'index' => [ [ 'custnum' ] ],
525 'billpaynum', 'serial', '', '', '', '',
526 'invnum', 'int', '', '', '', '',
527 'paynum', 'int', '', '', '', '',
528 'amount', @money_type, '', '',
529 '_date', @date_type, '', '',
531 'primary_key' => 'billpaynum',
533 'index' => [ [ 'paynum' ], [ 'invnum' ] ],
536 'cust_pay_batch' => { #what's this used for again? list of customers
537 #in current CARD batch? (necessarily CARD?)
539 'paybatchnum', 'serial', '', '', '', '',
540 'invnum', 'int', '', '', '', '',
541 'custnum', 'int', '', '', '', '',
542 'last', 'varchar', '', $char_d, '', '',
543 'first', 'varchar', '', $char_d, '', '',
544 'address1', 'varchar', '', $char_d, '', '',
545 'address2', 'varchar', 'NULL', $char_d, '', '',
546 'city', 'varchar', '', $char_d, '', '',
547 'state', 'varchar', 'NULL', $char_d, '', '',
548 'zip', 'varchar', 'NULL', 10, '', '',
549 'country', 'char', '', 2, '', '',
550 # 'trancode', 'int', '', '', '', ''
551 'cardnum', 'varchar', '', 16, '', '',
552 #'exp', @date_type, '', ''
553 'exp', 'varchar', '', 11, '', '',
554 'payname', 'varchar', 'NULL', $char_d, '', '',
555 'amount', @money_type, '', '',
557 'primary_key' => 'paybatchnum',
559 'index' => [ ['invnum'], ['custnum'] ],
564 'pkgnum', 'serial', '', '', '', '',
565 'custnum', 'int', '', '', '', '',
566 'pkgpart', 'int', '', '', '', '',
567 'otaker', 'varchar', '', 32, '', '',
568 'setup', @date_type, '', '',
569 'bill', @date_type, '', '',
570 'last_bill', @date_type, '', '',
571 'susp', @date_type, '', '',
572 'cancel', @date_type, '', '',
573 'expire', @date_type, '', '',
574 'manual_flag', 'char', 'NULL', 1, '', '',
576 'primary_key' => 'pkgnum',
578 'index' => [ ['custnum'], ['pkgpart'] ],
583 'refundnum', 'serial', '', '', '', '',
584 #now cust_credit_refund #'crednum', 'int', '', '', '', '',
585 'custnum', 'int', '', '', '', '',
586 '_date', @date_type, '', '',
587 'refund', @money_type, '', '',
588 'otaker', 'varchar', '', 32, '', '',
589 'reason', 'varchar', '', $char_d, '', '',
590 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
591 # be index into payby
593 'payinfo', 'varchar', 'NULL', $char_d, '', '', #see cust_main above
594 'paybatch', 'varchar', 'NULL', $char_d, '', '',
595 'closed', 'char', 'NULL', 1, '', '',
597 'primary_key' => 'refundnum',
602 'cust_credit_refund' => {
604 'creditrefundnum', 'serial', '', '', '', '',
605 'crednum', 'int', '', '', '', '',
606 'refundnum', 'int', '', '', '', '',
607 'amount', @money_type, '', '',
608 '_date', @date_type, '', '',
610 'primary_key' => 'creditrefundnum',
612 'index' => [ [ 'crednum', 'refundnum' ] ],
618 'svcnum', 'serial', '', '', '', '',
619 'pkgnum', 'int', 'NULL', '', '', '',
620 'svcpart', 'int', '', '', '', '',
622 'primary_key' => 'svcnum',
624 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
629 'pkgpart', 'serial', '', '', '', '',
630 'pkg', 'varchar', '', $char_d, '', '',
631 'comment', 'varchar', '', $char_d, '', '',
632 'promo_code', 'varchar', 'NULL', $char_d, '', '',
633 'setup', @perl_type, '', '',
634 'freq', 'varchar', '', $char_d, '', '', #billing frequency
635 'recur', @perl_type, '', '',
636 'setuptax', 'char', 'NULL', 1, '', '',
637 'recurtax', 'char', 'NULL', 1, '', '',
638 'plan', 'varchar', 'NULL', $char_d, '', '',
639 'plandata', 'text', 'NULL', '', '', '',
640 'disabled', 'char', 'NULL', 1, '', '',
641 'taxclass', 'varchar', 'NULL', $char_d, '', '',
642 'classnum', 'int', 'NULL', '', '', '',
644 'primary_key' => 'pkgpart',
646 'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
651 # 'titlenum', 'int', '', '',
652 # 'title', 'varchar', '', $char_d,
654 # 'primary_key' => 'titlenum',
655 # 'unique' => [ [] ],
661 'pkgsvcnum', 'serial', '', '', '', '',
662 'pkgpart', 'int', '', '', '', '',
663 'svcpart', 'int', '', '', '', '',
664 'quantity', 'int', '', '', '', '',
665 'primary_svc','char', 'NULL', 1, '', '',
667 'primary_key' => 'pkgsvcnum',
668 'unique' => [ ['pkgpart', 'svcpart'] ],
669 'index' => [ ['pkgpart'] ],
674 'refnum', 'serial', '', '', '', '',
675 'referral', 'varchar', '', $char_d, '', '',
676 'disabled', 'char', 'NULL', 1, '', '',
678 'primary_key' => 'refnum',
680 'index' => [ ['disabled'] ],
685 'svcpart', 'serial', '', '', '', '',
686 'svc', 'varchar', '', $char_d, '', '',
687 'svcdb', 'varchar', '', $char_d, '', '',
688 'disabled', 'char', 'NULL', 1, '', '',
690 'primary_key' => 'svcpart',
692 'index' => [ [ 'disabled' ] ],
695 'part_svc_column' => {
697 'columnnum', 'serial', '', '', '', '',
698 'svcpart', 'int', '', '', '', '',
699 'columnname', 'varchar', '', 64, '', '',
700 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
701 'columnflag', 'char', 'NULL', 1, '', '',
703 'primary_key' => 'columnnum',
704 'unique' => [ [ 'svcpart', 'columnname' ] ],
705 'index' => [ [ 'svcpart' ] ],
708 #(this should be renamed to part_pop)
711 'popnum', 'serial', '', '', '', '',
712 'city', 'varchar', '', $char_d, '', '',
713 'state', 'varchar', '', $char_d, '', '',
714 'ac', 'char', '', 3, '', '',
715 'exch', 'char', '', 3, '', '',
716 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
718 'primary_key' => 'popnum',
720 'index' => [ [ 'state' ] ],
723 'part_pop_local' => {
725 'localnum', 'serial', '', '', '', '',
726 'popnum', 'int', '', '', '', '',
727 'city', 'varchar', 'NULL', $char_d, '', '',
728 'state', 'char', 'NULL', 2, '', '',
729 'npa', 'char', '', 3, '', '',
730 'nxx', 'char', '', 3, '', '',
732 'primary_key' => 'localnum',
734 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
739 'svcnum', 'int', '', '', '', '',
740 'username', 'varchar', '', $username_len, '', '', #unique (& remove dup code)
741 '_password', 'varchar', '', 72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
742 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
743 'popnum', 'int', 'NULL', '', '', '',
744 'uid', 'int', 'NULL', '', '', '',
745 'gid', 'int', 'NULL', '', '', '',
746 'finger', 'varchar', 'NULL', $char_d, '', '',
747 'dir', 'varchar', 'NULL', $char_d, '', '',
748 'shell', 'varchar', 'NULL', $char_d, '', '',
749 'quota', 'varchar', 'NULL', $char_d, '', '',
750 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
751 'seconds', 'int', 'NULL', '', '', '', #uhhhh
752 'domsvc', 'int', '', '', '', '',
754 'primary_key' => 'svcnum',
755 #'unique' => [ [ 'username', 'domsvc' ] ],
757 'index' => [ ['username'], ['domsvc'] ],
762 # 'svcnum', 'int', '', '',
763 # 'amount', @money_type,
765 # 'primary_key' => 'svcnum',
766 # 'unique' => [ [] ],
772 'svcnum', 'int', '', '', '', '',
773 'domain', 'varchar', '', $char_d, '', '',
774 'catchall', 'int', 'NULL', '', '', '',
776 'primary_key' => 'svcnum',
777 'unique' => [ ['domain'] ],
783 'recnum', 'serial', '', '', '', '',
784 'svcnum', 'int', '', '', '', '',
785 'reczone', 'varchar', '', 255, '', '',
786 'recaf', 'char', '', 2, '', '',
787 'rectype', 'varchar', '', 5, '', '',
788 'recdata', 'varchar', '', 255, '', '',
790 'primary_key' => 'recnum',
792 'index' => [ ['svcnum'] ],
797 'svcnum', 'int', '', '', '', '',
798 'srcsvc', 'int', 'NULL', '', '', '',
799 'src', 'varchar', 'NULL', 255, '', '',
800 'dstsvc', 'int', 'NULL', '', '', '',
801 'dst', 'varchar', 'NULL', 255, '', '',
803 'primary_key' => 'svcnum',
805 'index' => [ ['srcsvc'], ['dstsvc'] ],
810 'svcnum', 'int', '', '', '', '',
811 'recnum', 'int', '', '', '', '',
812 'usersvc', 'int', '', '', '', '',
814 'primary_key' => 'svcnum',
821 # 'svcnum', 'int', '', '',
822 # 'svcnum', 'int', '', '',
823 # 'svcnum', 'int', '', '',
824 # 'worker', 'varchar', '', $char_d,
825 # '_date', @date_type,
827 # 'primary_key' => 'svcnum',
828 # 'unique' => [ [] ],
834 'prepaynum', 'serial', '', '', '', '',
835 'identifier', 'varchar', '', $char_d, '', '',
836 'amount', @money_type, '', '',
837 'seconds', 'int', 'NULL', '', '', '',
838 'agentnum', 'int', 'NULL', '', '', '',
840 'primary_key' => 'prepaynum',
841 'unique' => [ ['identifier'] ],
847 'portnum', 'serial', '', '', '', '',
848 'ip', 'varchar', 'NULL', 15, '', '',
849 'nasport', 'int', 'NULL', '', '', '',
850 'nasnum', 'int', '', '', '', '',
852 'primary_key' => 'portnum',
859 'nasnum', 'serial', '', '', '', '',
860 'nas', 'varchar', '', $char_d, '', '',
861 'nasip', 'varchar', '', 15, '', '',
862 'nasfqdn', 'varchar', '', $char_d, '', '',
863 'last', 'int', '', '', '', '',
865 'primary_key' => 'nasnum',
866 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
867 'index' => [ [ 'last' ] ],
872 'sessionnum', 'serial', '', '', '', '',
873 'portnum', 'int', '', '', '', '',
874 'svcnum', 'int', '', '', '', '',
875 'login', @date_type, '', '',
876 'logout', @date_type, '', '',
878 'primary_key' => 'sessionnum',
880 'index' => [ [ 'portnum' ] ],
885 'jobnum', 'serial', '', '', '', '',
886 'job', 'text', '', '', '', '',
887 '_date', 'int', '', '', '', '',
888 'status', 'varchar', '', $char_d, '', '',
889 'statustext', 'text', 'NULL', '', '', '',
890 'svcnum', 'int', 'NULL', '', '', '',
892 'primary_key' => 'jobnum',
894 'index' => [ [ 'svcnum' ], [ 'status' ] ],
899 'argnum', 'serial', '', '', '', '',
900 'jobnum', 'int', '', '', '', '',
901 'arg', 'text', 'NULL', '', '', '',
903 'primary_key' => 'argnum',
905 'index' => [ [ 'jobnum' ] ],
910 'dependnum', 'serial', '', '', '', '',
911 'jobnum', 'int', '', '', '', '',
912 'depend_jobnum', 'int', '', '', '', '',
914 'primary_key' => 'dependnum',
916 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
921 'exportsvcnum' => 'serial', '', '', '', '',
922 'exportnum' => 'int', '', '', '', '',
923 'svcpart' => 'int', '', '', '', '',
925 'primary_key' => 'exportsvcnum',
926 'unique' => [ [ 'exportnum', 'svcpart' ] ],
927 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
932 'exportnum', 'serial', '', '', '', '',
933 'machine', 'varchar', '', $char_d, '', '',
934 'exporttype', 'varchar', '', $char_d, '', '',
935 'nodomain', 'char', 'NULL', 1, '', '',
937 'primary_key' => 'exportnum',
939 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
942 'part_export_option' => {
944 'optionnum', 'serial', '', '', '', '',
945 'exportnum', 'int', '', '', '', '',
946 'optionname', 'varchar', '', $char_d, '', '',
947 'optionvalue', 'text', 'NULL', '', '', '',
949 'primary_key' => 'optionnum',
951 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
954 'radius_usergroup' => {
956 'usergroupnum', 'serial', '', '', '', '',
957 'svcnum', 'int', '', '', '', '',
958 'groupname', 'varchar', '', $char_d, '', '',
960 'primary_key' => 'usergroupnum',
962 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
967 'msgnum', 'serial', '', '', '', '',
968 'msgcode', 'varchar', '', $char_d, '', '',
969 'locale', 'varchar', '', 16, '', '',
970 'msg', 'text', '', '', '', '',
972 'primary_key' => 'msgnum',
973 'unique' => [ [ 'msgcode', 'locale' ] ],
977 'cust_tax_exempt' => {
979 'exemptnum', 'serial', '', '', '', '',
980 'custnum', 'int', '', '', '', '',
981 'taxnum', 'int', '', '', '', '',
982 'year', 'int', '', '', '', '',
983 'month', 'int', '', '', '', '',
984 'amount', @money_type, '', '',
986 'primary_key' => 'exemptnum',
987 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
991 'cust_tax_exempt_pkg' => {
993 'exemptpkgnum', 'serial', '', '', '', '',
994 #'custnum', 'int', '', '', '', ''
995 'billpkgnum', 'int', '', '', '', '',
996 'taxnum', 'int', '', '', '', '',
997 'year', 'int', '', '', '', '',
998 'month', 'int', '', '', '', '',
999 'amount', @money_type, '', '',
1001 'primary_key' => 'exemptpkgnum',
1003 'index' => [ [ 'taxnum', 'year', 'month' ],
1011 'routernum', 'serial', '', '', '', '',
1012 'routername', 'varchar', '', $char_d, '', '',
1013 'svcnum', 'int', 'NULL', '', '', '',
1015 'primary_key' => 'routernum',
1020 'part_svc_router' => {
1022 'svcrouternum', 'serial', '', '', '', '',
1023 'svcpart', 'int', '', '', '', '',
1024 'routernum', 'int', '', '', '', '',
1026 'primary_key' => 'svcrouternum',
1033 'blocknum', 'serial', '', '', '', '',
1034 'routernum', 'int', '', '', '', '',
1035 'ip_gateway', 'varchar', '', 15, '', '',
1036 'ip_netmask', 'int', '', '', '', '',
1038 'primary_key' => 'blocknum',
1039 'unique' => [ [ 'blocknum', 'routernum' ] ],
1043 'svc_broadband' => {
1045 'svcnum', 'int', '', '', '', '',
1046 'blocknum', 'int', '', '', '', '',
1047 'speed_up', 'int', '', '', '', '',
1048 'speed_down', 'int', '', '', '', '',
1049 'ip_addr', 'varchar', '', 15, '', '',
1051 'primary_key' => 'svcnum',
1056 'part_virtual_field' => {
1058 'vfieldpart', 'int', '', '', '', '',
1059 'dbtable', 'varchar', '', 32, '', '',
1060 'name', 'varchar', '', 32, '', '',
1061 'check_block', 'text', 'NULL', '', '', '',
1062 'length', 'int', 'NULL', '', '', '',
1063 'list_source', 'text', 'NULL', '', '', '',
1064 'label', 'varchar', 'NULL', 80, '', '',
1066 'primary_key' => 'vfieldpart',
1071 'virtual_field' => {
1073 'vfieldnum', 'serial', '', '', '', '',
1074 'recnum', 'int', '', '', '', '',
1075 'vfieldpart', 'int', '', '', '', '',
1076 'value', 'varchar', '', 128, '', '',
1078 'primary_key' => 'vfieldnum',
1079 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1085 'snarfnum', 'int', '', '', '', '',
1086 'svcnum', 'int', '', '', '', '',
1087 'machine', 'varchar', '', 255, '', '',
1088 'protocol', 'varchar', '', $char_d, '', '',
1089 'username', 'varchar', '', $char_d, '', '',
1090 '_password', 'varchar', '', $char_d, '', '',
1092 'primary_key' => 'snarfnum',
1094 'index' => [ [ 'svcnum' ] ],
1099 'svcnum', 'int', '', '', '', '',
1100 'id', 'int', 'NULL', '', '', '',
1101 'title', 'varchar', 'NULL', $char_d, '', '',
1103 'primary_key' => 'svcnum',
1108 'cust_pay_refund' => {
1110 'payrefundnum', 'serial', '', '', '', '',
1111 'paynum', 'int', '', '', '', '',
1112 'refundnum', 'int', '', '', '', '',
1113 '_date', @date_type, '', '',
1114 'amount', @money_type, '', '',
1116 'primary_key' => 'payrefundnum',
1118 'index' => [ ['paynum'], ['refundnum'] ],
1121 'part_pkg_option' => {
1123 'optionnum', 'serial', '', '', '', '',
1124 'pkgpart', 'int', '', '', '', '',
1125 'optionname', 'varchar', '', $char_d, '', '',
1126 'optionvalue', 'text', 'NULL', '', '', '',
1128 'primary_key' => 'optionnum',
1130 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1135 'ratenum', 'serial', '', '', '', '',
1136 'ratename', 'varchar', '', $char_d, '', '',
1138 'primary_key' => 'ratenum',
1145 'ratedetailnum', 'serial', '', '', '', '',
1146 'ratenum', 'int', '', '', '', '',
1147 'orig_regionnum', 'int', 'NULL', '', '', '',
1148 'dest_regionnum', 'int', '', '', '', '',
1149 'min_included', 'int', '', '', '', '',
1150 #'min_charge', @money_type, '', '',
1151 'min_charge', 'decimal', '', '10,5', '', '',
1152 'sec_granularity', 'int', '', '', '', '',
1153 #time period (link to table of periods)?
1155 'primary_key' => 'ratedetailnum',
1156 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1157 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1162 'regionnum', 'serial', '', '', '', '',
1163 'regionname', 'varchar', '', $char_d, '', '',
1165 'primary_key' => 'regionnum',
1172 'prefixnum', 'serial', '', '', '', '',
1173 'regionnum', 'int', '', '',, '', '',
1174 'countrycode', 'varchar', '', 3, '', '',
1175 'npa', 'varchar', 'NULL', 6, '', '',
1176 'nxx', 'varchar', 'NULL', 3, '', '',
1178 'primary_key' => 'prefixnum',
1180 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1185 'codenum', 'serial', '', '', '', '',
1186 'code', 'varchar', '', $char_d, '', '',
1187 'agentnum', 'int', '', '', '', '',
1189 'primary_key' => 'codenum',
1190 'unique' => [ [ 'agentnum', 'code' ] ],
1191 'index' => [ [ 'agentnum' ] ],
1196 'codepkgnum', 'serial', '', '', '', '',
1197 'codenum', 'int', '', '', '', '',
1198 'pkgpart', 'int', '', '', '', '',
1200 'primary_key' => 'codepkgnum',
1201 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1202 'index' => [ [ 'codenum' ] ],
1205 'clientapi_session' => {
1207 'sessionnum', 'serial', '', '', '', '',
1208 'sessionid', 'varchar', '', $char_d, '', '',
1209 'namespace', 'varchar', '', $char_d, '', '',
1211 'primary_key' => 'sessionnum',
1212 'unique' => [ [ 'sessionid', 'namespace' ] ],
1216 'clientapi_session_field' => {
1218 'fieldnum', 'serial', '', '', '', '',
1219 'sessionnum', 'int', '', '', '', '',
1220 'fieldname', 'varchar', '', $char_d, '', '',
1221 'fieldvalue', 'text', 'NULL', '', '', '',
1223 'primary_key' => 'fieldnum',
1224 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1228 'payment_gateway' => {
1230 'gatewaynum', 'serial', '', '', '', '',
1231 'gateway_module', 'varchar', '', $char_d, '', '',
1232 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1233 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1234 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1235 'disabled', 'char', 'NULL', 1, '', '',
1237 'primary_key' => 'gatewaynum',
1239 'index' => [ [ 'disabled' ] ],
1242 'payment_gateway_option' => {
1244 'optionnum', 'serial', '', '', '', '',
1245 'gatewaynum', 'int', '', '', '', '',
1246 'optionname', 'varchar', '', $char_d, '', '',
1247 'optionvalue', 'text', 'NULL', '', '', '',
1249 'primary_key' => 'optionnum',
1251 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1254 'agent_payment_gateway' => {
1256 'agentgatewaynum', 'serial', '', '', '', '',
1257 'agentnum', 'int', '', '', '', '',
1258 'gatewaynum', 'int', '', '', '', '',
1259 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1260 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1262 'primary_key' => 'agentgatewaynum',
1264 'index' => [ [ 'agentnum', 'cardtype' ], ],
1269 'bannum', 'serial', '', '', '', '',
1270 'payby', 'char', '', 4, '', '',
1271 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1272 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1273 '_date', @date_type, '', '',
1274 'otaker', 'varchar', '', 32, '', '',
1275 'reason', 'varchar', 'NULL', $char_d, '', '',
1277 'primary_key' => 'bannum',
1278 'unique' => [ [ 'payby', 'payinfo' ] ],
1282 'cancel_reason' => {
1284 'reasonnum', 'serial', '', '', '', '',
1285 'reason', 'varchar', '', $char_d, '', '',
1286 'disabled', 'char', 'NULL', 1, '', '',
1288 'primary_key' => 'reasonnum',
1290 'index' => [ [ 'disabled' ] ],
1295 'classnum', 'serial', '', '', '', '',
1296 'classname', 'varchar', '', $char_d, '', '',
1298 'primary_key' => 'classnum',
1305 # qw( name type null length default local );
1311 'acctid', 'bigserial', '', '', '', '',
1312 'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1313 'clid', 'varchar', '', $char_d, \"''", '',
1314 'src', 'varchar', '', $char_d, \"''", '',
1315 'dst', 'varchar', '', $char_d, \"''", '',
1316 'dcontext', 'varchar', '', $char_d, \"''", '',
1317 'channel', 'varchar', '', $char_d, \"''", '',
1318 'dstchannel', 'varchar', '', $char_d, \"''", '',
1319 'lastapp', 'varchar', '', $char_d, \"''", '',
1320 'lastdata', 'varchar', '', $char_d, \"''", '',
1322 #these don't seem to be logged by most of the SQL cdr_* modules
1323 #except tds under sql-illegal names, so;
1324 # ... don't rely on them for rating?
1325 # and, what they hey, i went ahead and changed the names and data types
1326 # to freeside-style dates...
1327 #'start', 'timestamp', 'NULL', '', '', '',
1328 #'answer', 'timestamp', 'NULL', '', '', '',
1329 #'end', 'timestamp', 'NULL', '', '', '',
1330 'startdate', @date_type, '', '',
1331 'answerdate', @date_type, '', '',
1332 'enddate', @date_type, '', '',
1335 'duration', 'int', '', '', 0, '',
1336 'billsec', 'int', '', '', 0, '',
1337 'disposition', 'varchar', '', 45, \"''", '',
1338 'amaflags', 'int', '', '', 0, '',
1339 'accountcode', 'varchar', '', 20, \"''", '',
1340 'uniqueid', 'varchar', '', 32, \"''", '',
1341 'userfield', 'varchar', '', 255, \"''", '',
1344 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1348 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1349 'cdrtypenum', 'int', 'NULL', '', '', '',
1351 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1353 'upstream_currency', 'char', 'NULL', 3, '', '',
1354 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1355 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1357 # how it was rated internally...
1358 'ratedetailnum', 'int', 'NULL', '', '', '',
1359 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1361 'distance', 'decimal', 'NULL', '', '', '',
1362 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1364 #cdr_calltype: the big list in appendix 2
1365 'calltypenum', 'int', 'NULL', '', '', '',
1367 'description', 'varchar', 'NULL', $char_d, '', '',
1368 'quantity', 'int', 'NULL', '', '', '',
1370 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1371 'carrierid', 'int', 'NULL', '', '', '',
1373 'upstream_rateid', 'int', 'NULL', '', '', '',
1376 #and now for our own fields
1379 # a svcnum... right..?
1380 'svcnum', 'int', 'NULL', '', '', '',
1382 #NULL, done (or something)
1383 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1386 'primary_key' => 'acctid',
1388 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1393 'calltypenum', 'serial', '', '', '', '',
1394 'calltypename', 'varchar', '', $char_d, '', '',
1396 'primary_key' => 'calltypenum',
1403 'cdrtypenum' => 'serial', '', '', '', '',
1404 'cdrtypename' => 'varchar', '', '', '', '',
1406 'primary_key' => 'cdrtypenum',
1413 'carrierid' => 'serial', '', '', '', '',
1414 'carriername' => 'varchar', '', '', '', '',
1416 'primary_key' => 'carrierid',
1421 #map upstream rateid to ours...
1422 'cdr_upstream_rate' => {
1424 'upstreamratenum', 'serial', '', '', '', '',
1425 'upstream_rateid', 'varchar', '', $char_d, '', '',
1426 'ratedetailnum', 'int', 'NULL', '', '', '',
1428 'primary_key' => 'upstreamratenum', #XXX need a primary key
1429 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1433 'inventory_item' => {
1435 'itemnum', 'serial', '', '', '', '',
1436 'classnum', 'int', '', '', '', '',
1437 'item', 'varchar', '', $char_d, '', '',
1438 'svcnum', 'int', 'NULL', '', '', '',
1440 'primary_key' => 'itemnum',
1441 'unique' => [ [ 'classnum', 'item' ] ],
1442 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1445 'inventory_class' => {
1447 'classnum', 'serial', '', '', '', '',
1448 'classname', 'varchar', $char_d, '', '', '',
1450 'primary_key' => 'classnum',