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 'cust_pay_batch' => { #what's this used for again? list of customers
542 #in current CARD batch? (necessarily CARD?)
544 'paybatchnum', 'serial', '', '', '', '',
545 'invnum', 'int', '', '', '', '',
546 'custnum', 'int', '', '', '', '',
547 'last', 'varchar', '', $char_d, '', '',
548 'first', 'varchar', '', $char_d, '', '',
549 'address1', 'varchar', '', $char_d, '', '',
550 'address2', 'varchar', 'NULL', $char_d, '', '',
551 'city', 'varchar', '', $char_d, '', '',
552 'state', 'varchar', 'NULL', $char_d, '', '',
553 'zip', 'varchar', 'NULL', 10, '', '',
554 'country', 'char', '', 2, '', '',
555 # 'trancode', 'int', '', '', '', ''
556 'cardnum', 'varchar', '', 16, '', '',
557 #'exp', @date_type, '', ''
558 'exp', 'varchar', '', 11, '', '',
559 'payname', 'varchar', 'NULL', $char_d, '', '',
560 'amount', @money_type, '', '',
562 'primary_key' => 'paybatchnum',
564 'index' => [ ['invnum'], ['custnum'] ],
569 'pkgnum', 'serial', '', '', '', '',
570 'custnum', 'int', '', '', '', '',
571 'pkgpart', 'int', '', '', '', '',
572 'otaker', 'varchar', '', 32, '', '',
573 'setup', @date_type, '', '',
574 'bill', @date_type, '', '',
575 'last_bill', @date_type, '', '',
576 'susp', @date_type, '', '',
577 'cancel', @date_type, '', '',
578 'expire', @date_type, '', '',
579 'manual_flag', 'char', 'NULL', 1, '', '',
581 'primary_key' => 'pkgnum',
583 'index' => [ ['custnum'], ['pkgpart'] ],
588 'refundnum', 'serial', '', '', '', '',
589 #now cust_credit_refund #'crednum', 'int', '', '', '', '',
590 'custnum', 'int', '', '', '', '',
591 '_date', @date_type, '', '',
592 'refund', @money_type, '', '',
593 'otaker', 'varchar', '', 32, '', '',
594 'reason', 'varchar', '', $char_d, '', '',
595 'payby', 'char', '', 4, '', '', # CARD/BILL/COMP, should
596 # be index into payby
598 'payinfo', 'varchar', 'NULL', $char_d, '', '', #see cust_main above
599 'paybatch', 'varchar', 'NULL', $char_d, '', '',
600 'closed', 'char', 'NULL', 1, '', '',
602 'primary_key' => 'refundnum',
607 'cust_credit_refund' => {
609 'creditrefundnum', 'serial', '', '', '', '',
610 'crednum', 'int', '', '', '', '',
611 'refundnum', 'int', '', '', '', '',
612 'amount', @money_type, '', '',
613 '_date', @date_type, '', '',
615 'primary_key' => 'creditrefundnum',
617 'index' => [ [ 'crednum', 'refundnum' ] ],
623 'svcnum', 'serial', '', '', '', '',
624 'pkgnum', 'int', 'NULL', '', '', '',
625 'svcpart', 'int', '', '', '', '',
627 'primary_key' => 'svcnum',
629 'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
634 'pkgpart', 'serial', '', '', '', '',
635 'pkg', 'varchar', '', $char_d, '', '',
636 'comment', 'varchar', '', $char_d, '', '',
637 'promo_code', 'varchar', 'NULL', $char_d, '', '',
638 'setup', @perl_type, '', '',
639 'freq', 'varchar', '', $char_d, '', '', #billing frequency
640 'recur', @perl_type, '', '',
641 'setuptax', 'char', 'NULL', 1, '', '',
642 'recurtax', 'char', 'NULL', 1, '', '',
643 'plan', 'varchar', 'NULL', $char_d, '', '',
644 'plandata', 'text', 'NULL', '', '', '',
645 'disabled', 'char', 'NULL', 1, '', '',
646 'taxclass', 'varchar', 'NULL', $char_d, '', '',
647 'classnum', 'int', 'NULL', '', '', '',
649 'primary_key' => 'pkgpart',
651 'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
656 # 'titlenum', 'int', '', '',
657 # 'title', 'varchar', '', $char_d,
659 # 'primary_key' => 'titlenum',
660 # 'unique' => [ [] ],
666 'pkgsvcnum', 'serial', '', '', '', '',
667 'pkgpart', 'int', '', '', '', '',
668 'svcpart', 'int', '', '', '', '',
669 'quantity', 'int', '', '', '', '',
670 'primary_svc','char', 'NULL', 1, '', '',
672 'primary_key' => 'pkgsvcnum',
673 'unique' => [ ['pkgpart', 'svcpart'] ],
674 'index' => [ ['pkgpart'] ],
679 'refnum', 'serial', '', '', '', '',
680 'referral', 'varchar', '', $char_d, '', '',
681 'disabled', 'char', 'NULL', 1, '', '',
683 'primary_key' => 'refnum',
685 'index' => [ ['disabled'] ],
690 'svcpart', 'serial', '', '', '', '',
691 'svc', 'varchar', '', $char_d, '', '',
692 'svcdb', 'varchar', '', $char_d, '', '',
693 'disabled', 'char', 'NULL', 1, '', '',
695 'primary_key' => 'svcpart',
697 'index' => [ [ 'disabled' ] ],
700 'part_svc_column' => {
702 'columnnum', 'serial', '', '', '', '',
703 'svcpart', 'int', '', '', '', '',
704 'columnname', 'varchar', '', 64, '', '',
705 'columnvalue', 'varchar', 'NULL', $char_d, '', '',
706 'columnflag', 'char', 'NULL', 1, '', '',
708 'primary_key' => 'columnnum',
709 'unique' => [ [ 'svcpart', 'columnname' ] ],
710 'index' => [ [ 'svcpart' ] ],
713 #(this should be renamed to part_pop)
716 'popnum', 'serial', '', '', '', '',
717 'city', 'varchar', '', $char_d, '', '',
718 'state', 'varchar', '', $char_d, '', '',
719 'ac', 'char', '', 3, '', '',
720 'exch', 'char', '', 3, '', '',
721 'loc', 'char', 'NULL', 4, '', '', #NULL for legacy purposes
723 'primary_key' => 'popnum',
725 'index' => [ [ 'state' ] ],
728 'part_pop_local' => {
730 'localnum', 'serial', '', '', '', '',
731 'popnum', 'int', '', '', '', '',
732 'city', 'varchar', 'NULL', $char_d, '', '',
733 'state', 'char', 'NULL', 2, '', '',
734 'npa', 'char', '', 3, '', '',
735 'nxx', 'char', '', 3, '', '',
737 'primary_key' => 'localnum',
739 'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
744 'svcnum', 'int', '', '', '', '',
745 'username', 'varchar', '', $username_len, '', '', #unique (& remove dup code)
746 '_password', 'varchar', '', 72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
747 'sec_phrase', 'varchar', 'NULL', $char_d, '', '',
748 'popnum', 'int', 'NULL', '', '', '',
749 'uid', 'int', 'NULL', '', '', '',
750 'gid', 'int', 'NULL', '', '', '',
751 'finger', 'varchar', 'NULL', $char_d, '', '',
752 'dir', 'varchar', 'NULL', $char_d, '', '',
753 'shell', 'varchar', 'NULL', $char_d, '', '',
754 'quota', 'varchar', 'NULL', $char_d, '', '',
755 'slipip', 'varchar', 'NULL', 15, '', '', #four TINYINTs, bah.
756 'seconds', 'int', 'NULL', '', '', '', #uhhhh
757 'domsvc', 'int', '', '', '', '',
759 'primary_key' => 'svcnum',
760 #'unique' => [ [ 'username', 'domsvc' ] ],
762 'index' => [ ['username'], ['domsvc'] ],
767 # 'svcnum', 'int', '', '',
768 # 'amount', @money_type,
770 # 'primary_key' => 'svcnum',
771 # 'unique' => [ [] ],
777 'svcnum', 'int', '', '', '', '',
778 'domain', 'varchar', '', $char_d, '', '',
779 'catchall', 'int', 'NULL', '', '', '',
781 'primary_key' => 'svcnum',
782 'unique' => [ ['domain'] ],
788 'recnum', 'serial', '', '', '', '',
789 'svcnum', 'int', '', '', '', '',
790 'reczone', 'varchar', '', 255, '', '',
791 'recaf', 'char', '', 2, '', '',
792 'rectype', 'varchar', '', 5, '', '',
793 'recdata', 'varchar', '', 255, '', '',
795 'primary_key' => 'recnum',
797 'index' => [ ['svcnum'] ],
802 'svcnum', 'int', '', '', '', '',
803 'srcsvc', 'int', 'NULL', '', '', '',
804 'src', 'varchar', 'NULL', 255, '', '',
805 'dstsvc', 'int', 'NULL', '', '', '',
806 'dst', 'varchar', 'NULL', 255, '', '',
808 'primary_key' => 'svcnum',
810 'index' => [ ['srcsvc'], ['dstsvc'] ],
815 'svcnum', 'int', '', '', '', '',
816 'recnum', 'int', '', '', '', '',
817 'usersvc', 'int', '', '', '', '',
819 'primary_key' => 'svcnum',
826 # 'svcnum', 'int', '', '',
827 # 'svcnum', 'int', '', '',
828 # 'svcnum', 'int', '', '',
829 # 'worker', 'varchar', '', $char_d,
830 # '_date', @date_type,
832 # 'primary_key' => 'svcnum',
833 # 'unique' => [ [] ],
839 'prepaynum', 'serial', '', '', '', '',
840 'identifier', 'varchar', '', $char_d, '', '',
841 'amount', @money_type, '', '',
842 'seconds', 'int', 'NULL', '', '', '',
843 'agentnum', 'int', 'NULL', '', '', '',
845 'primary_key' => 'prepaynum',
846 'unique' => [ ['identifier'] ],
852 'portnum', 'serial', '', '', '', '',
853 'ip', 'varchar', 'NULL', 15, '', '',
854 'nasport', 'int', 'NULL', '', '', '',
855 'nasnum', 'int', '', '', '', '',
857 'primary_key' => 'portnum',
864 'nasnum', 'serial', '', '', '', '',
865 'nas', 'varchar', '', $char_d, '', '',
866 'nasip', 'varchar', '', 15, '', '',
867 'nasfqdn', 'varchar', '', $char_d, '', '',
868 'last', 'int', '', '', '', '',
870 'primary_key' => 'nasnum',
871 'unique' => [ [ 'nas' ], [ 'nasip' ] ],
872 'index' => [ [ 'last' ] ],
877 'sessionnum', 'serial', '', '', '', '',
878 'portnum', 'int', '', '', '', '',
879 'svcnum', 'int', '', '', '', '',
880 'login', @date_type, '', '',
881 'logout', @date_type, '', '',
883 'primary_key' => 'sessionnum',
885 'index' => [ [ 'portnum' ] ],
890 'jobnum', 'serial', '', '', '', '',
891 'job', 'text', '', '', '', '',
892 '_date', 'int', '', '', '', '',
893 'status', 'varchar', '', $char_d, '', '',
894 'statustext', 'text', 'NULL', '', '', '',
895 'svcnum', 'int', 'NULL', '', '', '',
897 'primary_key' => 'jobnum',
899 'index' => [ [ 'svcnum' ], [ 'status' ] ],
904 'argnum', 'serial', '', '', '', '',
905 'jobnum', 'int', '', '', '', '',
906 'arg', 'text', 'NULL', '', '', '',
908 'primary_key' => 'argnum',
910 'index' => [ [ 'jobnum' ] ],
915 'dependnum', 'serial', '', '', '', '',
916 'jobnum', 'int', '', '', '', '',
917 'depend_jobnum', 'int', '', '', '', '',
919 'primary_key' => 'dependnum',
921 'index' => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
926 'exportsvcnum' => 'serial', '', '', '', '',
927 'exportnum' => 'int', '', '', '', '',
928 'svcpart' => 'int', '', '', '', '',
930 'primary_key' => 'exportsvcnum',
931 'unique' => [ [ 'exportnum', 'svcpart' ] ],
932 'index' => [ [ 'exportnum' ], [ 'svcpart' ] ],
937 'exportnum', 'serial', '', '', '', '',
938 'machine', 'varchar', '', $char_d, '', '',
939 'exporttype', 'varchar', '', $char_d, '', '',
940 'nodomain', 'char', 'NULL', 1, '', '',
942 'primary_key' => 'exportnum',
944 'index' => [ [ 'machine' ], [ 'exporttype' ] ],
947 'part_export_option' => {
949 'optionnum', 'serial', '', '', '', '',
950 'exportnum', 'int', '', '', '', '',
951 'optionname', 'varchar', '', $char_d, '', '',
952 'optionvalue', 'text', 'NULL', '', '', '',
954 'primary_key' => 'optionnum',
956 'index' => [ [ 'exportnum' ], [ 'optionname' ] ],
959 'radius_usergroup' => {
961 'usergroupnum', 'serial', '', '', '', '',
962 'svcnum', 'int', '', '', '', '',
963 'groupname', 'varchar', '', $char_d, '', '',
965 'primary_key' => 'usergroupnum',
967 'index' => [ [ 'svcnum' ], [ 'groupname' ] ],
972 'msgnum', 'serial', '', '', '', '',
973 'msgcode', 'varchar', '', $char_d, '', '',
974 'locale', 'varchar', '', 16, '', '',
975 'msg', 'text', '', '', '', '',
977 'primary_key' => 'msgnum',
978 'unique' => [ [ 'msgcode', 'locale' ] ],
982 'cust_tax_exempt' => {
984 'exemptnum', 'serial', '', '', '', '',
985 'custnum', 'int', '', '', '', '',
986 'taxnum', 'int', '', '', '', '',
987 'year', 'int', '', '', '', '',
988 'month', 'int', '', '', '', '',
989 'amount', @money_type, '', '',
991 'primary_key' => 'exemptnum',
992 'unique' => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
996 'cust_tax_exempt_pkg' => {
998 'exemptpkgnum', 'serial', '', '', '', '',
999 #'custnum', 'int', '', '', '', ''
1000 'billpkgnum', 'int', '', '', '', '',
1001 'taxnum', 'int', '', '', '', '',
1002 'year', 'int', '', '', '', '',
1003 'month', 'int', '', '', '', '',
1004 'amount', @money_type, '', '',
1006 'primary_key' => 'exemptpkgnum',
1008 'index' => [ [ 'taxnum', 'year', 'month' ],
1016 'routernum', 'serial', '', '', '', '',
1017 'routername', 'varchar', '', $char_d, '', '',
1018 'svcnum', 'int', 'NULL', '', '', '',
1020 'primary_key' => 'routernum',
1025 'part_svc_router' => {
1027 'svcrouternum', 'serial', '', '', '', '',
1028 'svcpart', 'int', '', '', '', '',
1029 'routernum', 'int', '', '', '', '',
1031 'primary_key' => 'svcrouternum',
1038 'blocknum', 'serial', '', '', '', '',
1039 'routernum', 'int', '', '', '', '',
1040 'ip_gateway', 'varchar', '', 15, '', '',
1041 'ip_netmask', 'int', '', '', '', '',
1043 'primary_key' => 'blocknum',
1044 'unique' => [ [ 'blocknum', 'routernum' ] ],
1048 'svc_broadband' => {
1050 'svcnum', 'int', '', '', '', '',
1051 'blocknum', 'int', '', '', '', '',
1052 'speed_up', 'int', '', '', '', '',
1053 'speed_down', 'int', '', '', '', '',
1054 'ip_addr', 'varchar', '', 15, '', '',
1056 'primary_key' => 'svcnum',
1061 'part_virtual_field' => {
1063 'vfieldpart', 'int', '', '', '', '',
1064 'dbtable', 'varchar', '', 32, '', '',
1065 'name', 'varchar', '', 32, '', '',
1066 'check_block', 'text', 'NULL', '', '', '',
1067 'length', 'int', 'NULL', '', '', '',
1068 'list_source', 'text', 'NULL', '', '', '',
1069 'label', 'varchar', 'NULL', 80, '', '',
1071 'primary_key' => 'vfieldpart',
1076 'virtual_field' => {
1078 'vfieldnum', 'serial', '', '', '', '',
1079 'recnum', 'int', '', '', '', '',
1080 'vfieldpart', 'int', '', '', '', '',
1081 'value', 'varchar', '', 128, '', '',
1083 'primary_key' => 'vfieldnum',
1084 'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1090 'snarfnum', 'int', '', '', '', '',
1091 'svcnum', 'int', '', '', '', '',
1092 'machine', 'varchar', '', 255, '', '',
1093 'protocol', 'varchar', '', $char_d, '', '',
1094 'username', 'varchar', '', $char_d, '', '',
1095 '_password', 'varchar', '', $char_d, '', '',
1097 'primary_key' => 'snarfnum',
1099 'index' => [ [ 'svcnum' ] ],
1104 'svcnum', 'int', '', '', '', '',
1105 'id', 'int', 'NULL', '', '', '',
1106 'title', 'varchar', 'NULL', $char_d, '', '',
1108 'primary_key' => 'svcnum',
1113 'cust_pay_refund' => {
1115 'payrefundnum', 'serial', '', '', '', '',
1116 'paynum', 'int', '', '', '', '',
1117 'refundnum', 'int', '', '', '', '',
1118 '_date', @date_type, '', '',
1119 'amount', @money_type, '', '',
1121 'primary_key' => 'payrefundnum',
1123 'index' => [ ['paynum'], ['refundnum'] ],
1126 'part_pkg_option' => {
1128 'optionnum', 'serial', '', '', '', '',
1129 'pkgpart', 'int', '', '', '', '',
1130 'optionname', 'varchar', '', $char_d, '', '',
1131 'optionvalue', 'text', 'NULL', '', '', '',
1133 'primary_key' => 'optionnum',
1135 'index' => [ [ 'pkgpart' ], [ 'optionname' ] ],
1140 'ratenum', 'serial', '', '', '', '',
1141 'ratename', 'varchar', '', $char_d, '', '',
1143 'primary_key' => 'ratenum',
1150 'ratedetailnum', 'serial', '', '', '', '',
1151 'ratenum', 'int', '', '', '', '',
1152 'orig_regionnum', 'int', 'NULL', '', '', '',
1153 'dest_regionnum', 'int', '', '', '', '',
1154 'min_included', 'int', '', '', '', '',
1155 #'min_charge', @money_type, '', '',
1156 'min_charge', 'decimal', '', '10,5', '', '',
1157 'sec_granularity', 'int', '', '', '', '',
1158 #time period (link to table of periods)?
1160 'primary_key' => 'ratedetailnum',
1161 'unique' => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1162 'index' => [ [ 'ratenum', 'dest_regionnum' ] ],
1167 'regionnum', 'serial', '', '', '', '',
1168 'regionname', 'varchar', '', $char_d, '', '',
1170 'primary_key' => 'regionnum',
1177 'prefixnum', 'serial', '', '', '', '',
1178 'regionnum', 'int', '', '',, '', '',
1179 'countrycode', 'varchar', '', 3, '', '',
1180 'npa', 'varchar', 'NULL', 6, '', '',
1181 'nxx', 'varchar', 'NULL', 3, '', '',
1183 'primary_key' => 'prefixnum',
1185 'index' => [ [ 'countrycode' ], [ 'regionnum' ] ],
1190 'codenum', 'serial', '', '', '', '',
1191 'code', 'varchar', '', $char_d, '', '',
1192 'agentnum', 'int', '', '', '', '',
1194 'primary_key' => 'codenum',
1195 'unique' => [ [ 'agentnum', 'code' ] ],
1196 'index' => [ [ 'agentnum' ] ],
1201 'codepkgnum', 'serial', '', '', '', '',
1202 'codenum', 'int', '', '', '', '',
1203 'pkgpart', 'int', '', '', '', '',
1205 'primary_key' => 'codepkgnum',
1206 'unique' => [ [ 'codenum', 'pkgpart' ] ],
1207 'index' => [ [ 'codenum' ] ],
1210 'clientapi_session' => {
1212 'sessionnum', 'serial', '', '', '', '',
1213 'sessionid', 'varchar', '', $char_d, '', '',
1214 'namespace', 'varchar', '', $char_d, '', '',
1216 'primary_key' => 'sessionnum',
1217 'unique' => [ [ 'sessionid', 'namespace' ] ],
1221 'clientapi_session_field' => {
1223 'fieldnum', 'serial', '', '', '', '',
1224 'sessionnum', 'int', '', '', '', '',
1225 'fieldname', 'varchar', '', $char_d, '', '',
1226 'fieldvalue', 'text', 'NULL', '', '', '',
1228 'primary_key' => 'fieldnum',
1229 'unique' => [ [ 'sessionnum', 'fieldname' ] ],
1233 'payment_gateway' => {
1235 'gatewaynum', 'serial', '', '', '', '',
1236 'gateway_module', 'varchar', '', $char_d, '', '',
1237 'gateway_username', 'varchar', 'NULL', $char_d, '', '',
1238 'gateway_password', 'varchar', 'NULL', $char_d, '', '',
1239 'gateway_action', 'varchar', 'NULL', $char_d, '', '',
1240 'disabled', 'char', 'NULL', 1, '', '',
1242 'primary_key' => 'gatewaynum',
1244 'index' => [ [ 'disabled' ] ],
1247 'payment_gateway_option' => {
1249 'optionnum', 'serial', '', '', '', '',
1250 'gatewaynum', 'int', '', '', '', '',
1251 'optionname', 'varchar', '', $char_d, '', '',
1252 'optionvalue', 'text', 'NULL', '', '', '',
1254 'primary_key' => 'optionnum',
1256 'index' => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1259 'agent_payment_gateway' => {
1261 'agentgatewaynum', 'serial', '', '', '', '',
1262 'agentnum', 'int', '', '', '', '',
1263 'gatewaynum', 'int', '', '', '', '',
1264 'cardtype', 'varchar', 'NULL', $char_d, '', '',
1265 'taxclass', 'varchar', 'NULL', $char_d, '', '',
1267 'primary_key' => 'agentgatewaynum',
1269 'index' => [ [ 'agentnum', 'cardtype' ], ],
1274 'bannum', 'serial', '', '', '', '',
1275 'payby', 'char', '', 4, '', '',
1276 'payinfo', 'varchar', '', 128, '', '', #say, a 512-big digest _hex encoded
1277 #'paymask', 'varchar', 'NULL', $char_d, '', ''
1278 '_date', @date_type, '', '',
1279 'otaker', 'varchar', '', 32, '', '',
1280 'reason', 'varchar', 'NULL', $char_d, '', '',
1282 'primary_key' => 'bannum',
1283 'unique' => [ [ 'payby', 'payinfo' ] ],
1287 'cancel_reason' => {
1289 'reasonnum', 'serial', '', '', '', '',
1290 'reason', 'varchar', '', $char_d, '', '',
1291 'disabled', 'char', 'NULL', 1, '', '',
1293 'primary_key' => 'reasonnum',
1295 'index' => [ [ 'disabled' ] ],
1300 'classnum', 'serial', '', '', '', '',
1301 'classname', 'varchar', '', $char_d, '', '',
1303 'primary_key' => 'classnum',
1310 # qw( name type null length default local );
1316 'acctid', 'bigserial', '', '', '', '',
1317 'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1318 'clid', 'varchar', '', $char_d, \"''", '',
1319 'src', 'varchar', '', $char_d, \"''", '',
1320 'dst', 'varchar', '', $char_d, \"''", '',
1321 'dcontext', 'varchar', '', $char_d, \"''", '',
1322 'channel', 'varchar', '', $char_d, \"''", '',
1323 'dstchannel', 'varchar', '', $char_d, \"''", '',
1324 'lastapp', 'varchar', '', $char_d, \"''", '',
1325 'lastdata', 'varchar', '', $char_d, \"''", '',
1327 #these don't seem to be logged by most of the SQL cdr_* modules
1328 #except tds under sql-illegal names, so;
1329 # ... don't rely on them for rating?
1330 # and, what they hey, i went ahead and changed the names and data types
1331 # to freeside-style dates...
1332 #'start', 'timestamp', 'NULL', '', '', '',
1333 #'answer', 'timestamp', 'NULL', '', '', '',
1334 #'end', 'timestamp', 'NULL', '', '', '',
1335 'startdate', @date_type, '', '',
1336 'answerdate', @date_type, '', '',
1337 'enddate', @date_type, '', '',
1340 'duration', 'int', '', '', 0, '',
1341 'billsec', 'int', '', '', 0, '',
1342 'disposition', 'varchar', '', 45, \"''", '',
1343 'amaflags', 'int', '', '', 0, '',
1344 'accountcode', 'varchar', '', 20, \"''", '',
1345 'uniqueid', 'varchar', '', 32, \"''", '',
1346 'userfield', 'varchar', '', 255, \"''", '',
1349 # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1353 #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1354 'cdrtypenum', 'int', 'NULL', '', '', '',
1356 'charged_party', 'varchar', 'NULL', $char_d, '', '',
1358 'upstream_currency', 'char', 'NULL', 3, '', '',
1359 'upstream_price', 'decimal', 'NULL', '10,2', '', '',
1360 'upstream_rateplanid', 'int', 'NULL', '', '', '', #?
1362 # how it was rated internally...
1363 'ratedetailnum', 'int', 'NULL', '', '', '',
1364 'rated_price', 'decimal', 'NULL', '10,2', '', '',
1366 'distance', 'decimal', 'NULL', '', '', '',
1367 'islocal', 'int', 'NULL', '', '', '', # '', '', 0, '' instead?
1369 #cdr_calltype: the big list in appendix 2
1370 'calltypenum', 'int', 'NULL', '', '', '',
1372 'description', 'varchar', 'NULL', $char_d, '', '',
1373 'quantity', 'int', 'NULL', '', '', '',
1375 #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1376 'carrierid', 'int', 'NULL', '', '', '',
1378 'upstream_rateid', 'int', 'NULL', '', '', '',
1381 #and now for our own fields
1384 # a svcnum... right..?
1385 'svcnum', 'int', 'NULL', '', '', '',
1387 #NULL, done (or something)
1388 'freesidestatus', 'varchar', 'NULL', 32, '', '',
1391 'primary_key' => 'acctid',
1393 'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1398 'calltypenum', 'serial', '', '', '', '',
1399 'calltypename', 'varchar', '', $char_d, '', '',
1401 'primary_key' => 'calltypenum',
1408 'cdrtypenum' => 'serial', '', '', '', '',
1409 'cdrtypename' => 'varchar', '', '', '', '',
1411 'primary_key' => 'cdrtypenum',
1418 'carrierid' => 'serial', '', '', '', '',
1419 'carriername' => 'varchar', '', '', '', '',
1421 'primary_key' => 'carrierid',
1426 #map upstream rateid to ours...
1427 'cdr_upstream_rate' => {
1429 'upstreamratenum', 'serial', '', '', '', '',
1430 'upstream_rateid', 'varchar', '', $char_d, '', '',
1431 'ratedetailnum', 'int', 'NULL', '', '', '',
1433 'primary_key' => 'upstreamratenum', #XXX need a primary key
1434 'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1438 'inventory_item' => {
1440 'itemnum', 'serial', '', '', '', '',
1441 'classnum', 'int', '', '', '', '',
1442 'item', 'varchar', '', $char_d, '', '',
1443 'svcnum', 'int', 'NULL', '', '', '',
1445 'primary_key' => 'itemnum',
1446 'unique' => [ [ 'classnum', 'item' ] ],
1447 'index' => [ [ 'classnum' ], [ 'svcnum' ] ],
1450 'inventory_class' => {
1452 'classnum', 'serial', '', '', '', '',
1453 'classname', 'varchar', '', $char_d, '', '',
1455 'primary_key' => 'classnum',
1462 'usernum', 'serial', '', '', '', '',
1463 'username', 'varchar', '', $char_d, '', '',
1464 '_password', 'varchar', '', $char_d, '', '',
1465 'last', 'varchar', '', $char_d, '', '',
1466 'first', 'varchar', '', $char_d, '', '',
1468 'primary_key' => 'usernum',
1469 'unique' => [ [ 'username' ] ],
1473 'access_user_pref' => {
1475 'prefnum', 'serial', '', '', '', '',
1476 'usernum', 'int', '', '', '', '',
1477 'prefname', 'varchar', '', $char_d, '', '',
1478 'prefvalue', 'text', 'NULL', '', '', '',
1480 'primary_key' => 'prefnum',
1482 'index' => [ [ 'usernum' ] ],
1487 'groupnum', 'serial', '', '', '', '',
1488 'groupname', 'varchar', '', $char_d, '', '',
1490 'primary_key' => 'groupnum',
1491 'unique' => [ [ 'groupname' ] ],
1495 'access_usergroup' => {
1497 'usergroupnum', 'serial', '', '', '', '',
1498 'usernum', 'int', '', '', '', '',
1499 'groupnum', 'int', '', '', '', '',
1501 'primary_key' => 'usergroupnum',
1502 'unique' => [ [ 'usernum', 'groupnum' ] ],
1503 'index' => [ [ 'usernum' ] ],
1506 'access_groupagent' => {
1508 'groupagentnum', 'serial', '', '', '', '',
1509 'groupnum', 'int', '', '', '', '',
1510 'agentnum', 'int', '', '', '', '',
1512 'primary_key' => 'groupagentnum',
1513 'unique' => [ [ 'groupnum', 'agentnum' ] ],
1514 'index' => [ [ 'groupnum' ] ],
1519 'rightnum', 'serial', '', '', '', '',
1520 'righttype', 'varchar', '', $char_d, '', '',
1521 'rightobjnum', 'int', '', '', '', '',
1522 'rightname', 'varchar', '', '', '', '',
1524 'primary_key' => 'rightnum',
1525 'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1533 # 'num', 'serial', '', '', '', '',
1535 # 'primary_key' => 'num',