FS/FS/Schema.pm

   1 package FS::Schema;
   2
   3 use vars qw(@ISA @EXPORT_OK $DEBUG $setup_hack %dbdef_cache);
   4 use subs qw(reload_dbdef);
   5 use Exporter;
   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);
  12
  13 @ISA = qw(Exporter);
  14 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  15
  16 $DEBUG = 0;
  17 $me = '[FS::Schema]';
  18
  19 #hardcoded now...
  20 ##ask FS::UID to run this stuff for us later
  21 #FS::UID->install_callback( sub {
  22 #  #$conf = new FS::Conf;
  23 #  &reload_dbdef("/usr/local/etc/freeside/dbdef.". datasrc)
  24 #    unless $setup_hack; #$setup_hack needed now?
  25 #} );
  26
  27 =head1 NAME
  28
  29 FS::Schema - Freeside database schema
  30
  31 =head1 SYNOPSYS
  32
  33     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  34
  35     $dbdef = reload_dbdef;
  36     $dbdef = reload_dbdef "/non/standard/filename";
  37     $dbdef = dbdef;
  38     $dbdef_dist = dbdef_dist;
  39
  40 =head1 DESCRIPTION
  41
  42 This class represents the database schema.
  43
  44 =head1 METHODS
  45
  46 =over 4
  47
  48 =item reload_dbdef([FILENAME])
  49
  50 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  51 non-default filename.  This command is executed at startup unless
  52 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  53
  54 =cut
  55
  56 sub reload_dbdef {
  57   my $file = shift;
  58
  59   unless ( exists $dbdef_cache{$file} ) {
  60     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  61     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  62                             or die "can't load database schema from $file";
  63   } else {
  64     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  65   }
  66   $dbdef = $dbdef_cache{$file};
  67 }
  68
  69 =item dbdef
  70
  71 Returns the current database definition (represents the current database,
  72 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  73
  74 =cut
  75
  76 sub dbdef { $dbdef; }
  77
  78 =item dbdef_dist [ OPTION => VALUE ... ]
  79
  80 Returns the current canoical database definition as defined in this file.
  81
  82 =cut
  83
  84 sub dbdef_dist {
  85
  86   ###
  87   # create a dbdef object from the old data structure
  88   ###
  89
  90   my $tables_hashref = tables_hashref();
  91
  92   #turn it into objects
  93   my $dbdef = new DBIx::DBSchema map {
  94     my @columns;
  95     while (@{$tables_hashref->{$_}{'columns'}}) {
  96       #my($name, $type, $null, $length, $default, $local) =
  97       my @coldef =
  98         splice @{$tables_hashref->{$_}{'columns'}}, 0, 6;
  99       my %hash = map { $_ => shift @coldef }
 100                      qw( name type null length default local );
 101
 102       unless ( defined $hash{'default'} ) {
 103         warn "$_:\n".
 104              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 105       }
 106
 107       push @columns, new DBIx::DBSchema::Column ( \%hash );
 108     }
 109     DBIx::DBSchema::Table->new(
 110       $_,
 111       $tables_hashref->{$_}{'primary_key'},
 112       DBIx::DBSchema::ColGroup::Unique->new($tables_hashref->{$_}{'unique'}),
 113       DBIx::DBSchema::ColGroup::Index->new($tables_hashref->{$_}{'index'}),
 114       @columns,
 115     );
 116   } keys %$tables_hashref;
 117
 118   if ( $DEBUG ) {
 119     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 120     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 121   }
 122
 123   my $cust_main = $dbdef->table('cust_main');
 124   #unless ($ship) { #remove ship_ from cust_main
 125   #  $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
 126   #} else { #add indices
 127     push @{$cust_main->index->lol_ref},
 128       map { [ "ship_$_" ] } qw( last company daytime night fax );
 129   #}
 130
 131   #add radius attributes to svc_acct
 132   #
 133   #my($svc_acct)=$dbdef->table('svc_acct');
 134   #
 135   #my($attribute);
 136   #foreach $attribute (@attributes) {
 137   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 138   #    'radius_'. $attribute,
 139   #    'varchar',
 140   #    'NULL',
 141   #    $char_d,
 142   #  ));
 143   #}
 144   #
 145   #foreach $attribute (@check_attributes) {
 146   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 147   #    'rc_'. $attribute,
 148   #    'varchar',
 149   #    'NULL',
 150   #    $char_d,
 151   #  ));
 152   #}
 153
 154   #create history tables (false laziness w/create-history-tables)
 155   foreach my $table (
 156     grep { ! /^clientapi_session/ }
 157     grep { ! /^h_/ }
 158     $dbdef->tables
 159   ) {
 160     my $tableobj = $dbdef->table($table)
 161       or die "unknown table $table";
 162
 163     die "unique->lol_ref undefined for $table"
 164       unless defined $tableobj->unique->lol_ref;
 165     die "index->lol_ref undefined for $table"
 166       unless defined $tableobj->index->lol_ref;
 167
 168     my $h_tableobj = DBIx::DBSchema::Table->new( {
 169       name        => "h_$table",
 170       primary_key => 'historynum',
 171       unique      => DBIx::DBSchema::ColGroup::Unique->new( [] ),
 172       'index'     => DBIx::DBSchema::ColGroup::Index->new( [
 173                        @{$tableobj->unique->lol_ref},
 174                        @{$tableobj->index->lol_ref}
 175                      ] ),
 176       columns     => [
 177                        DBIx::DBSchema::Column->new( {
 178                          'name'    => 'historynum',
 179                          'type'    => 'serial',
 180                          'null'    => 'NOT NULL',
 181                          'length'  => '',
 182                          'default' => '',
 183                          'local'   => '',
 184                        } ),
 185                        DBIx::DBSchema::Column->new( {
 186                          'name'    => 'history_date',
 187                          'type'    => 'int',
 188                          'null'    => 'NULL',
 189                          'length'  => '',
 190                          'default' => '',
 191                          'local'   => '',
 192                        } ),
 193                        DBIx::DBSchema::Column->new( {
 194                          'name'    => 'history_user',
 195                          'type'    => 'varchar',
 196                          'null'    => 'NOT NULL',
 197                          'length'  => '80',
 198                          'default' => '',
 199                          'local'   => '',
 200                        } ),
 201                        DBIx::DBSchema::Column->new( {
 202                          'name'    => 'history_action',
 203                          'type'    => 'varchar',
 204                          'null'    => 'NOT NULL',
 205                          'length'  => '80',
 206                          'default' => '',
 207                          'local'   => '',
 208                        } ),
 209                        map {
 210                          my $column = $tableobj->column($_);
 211
 212                          #clone so as to not disturb the original
 213                          $column = DBIx::DBSchema::Column->new( {
 214                            map { $_ => $column->$_() }
 215                              qw( name type null length default local )
 216                          } );
 217
 218                          if ( $column->type eq 'serial' ) {
 219                            $column->type('int');
 220                            $column->null('NULL');
 221                          }
 222                          #$column->default('')
 223                          #  if $column->default =~ /^nextval\(/i;
 224                          #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 225                          #$column->local($local);
 226                          $column;
 227                        } $tableobj->columns
 228                      ],
 229     } );
 230     $dbdef->addtable($h_tableobj);
 231   }
 232
 233   $dbdef;
 234
 235 }
 236
 237 sub tables_hashref {
 238
 239   my $char_d = 80; #default maxlength for text fields
 240
 241   #my(@date_type)  = ( 'timestamp', '', ''     );
 242   my @date_type  = ( 'int', 'NULL', ''     );
 243   my @perl_type = ( 'text', 'NULL', ''  );
 244   my @money_type = ( 'decimal',   '', '10,2' );
 245
 246   my $username_len = 32; #usernamemax config file
 247
 248     # name type nullability length default local
 249
 250   return {
 251
 252     'agent' => {
 253       'columns' => [
 254         'agentnum', 'serial',            '',     '', '', '',
 255         'agent',    'varchar',           '',     $char_d, '', '',
 256         'typenum',  'int',            '',     '', '', '',
 257         'freq',     'int',       'NULL', '', '', '',
 258         'prog',     @perl_type, '', '',
 259         'disabled',     'char', 'NULL', 1, '', '',
 260         'username', 'varchar',       'NULL',     $char_d, '', '',
 261         '_password','varchar',       'NULL',     $char_d, '', '',
 262         'ticketing_queueid', 'int', 'NULL', '', '', '',
 263       ],
 264       'primary_key' => 'agentnum',
 265       'unique' => [],
 266       'index' => [ ['typenum'], ['disabled'] ],
 267     },
 268
 269     'agent_type' => {
 270       'columns' => [
 271         'typenum',   'serial',  '', '', '', '',
 272         'atype',     'varchar', '', $char_d, '', '',
 273       ],
 274       'primary_key' => 'typenum',
 275       'unique' => [],
 276       'index' => [],
 277     },
 278
 279     'type_pkgs' => {
 280       'columns' => [
 281         'typepkgnum', 'serial', '', '', '', '',
 282         'typenum',   'int',  '', '', '', '',
 283         'pkgpart',   'int',  '', '', '', '',
 284       ],
 285       'primary_key' => 'typepkgnum',
 286       'unique' => [ ['typenum', 'pkgpart'] ],
 287       'index' => [ ['typenum'] ],
 288     },
 289
 290     'cust_bill' => {
 291       'columns' => [
 292         'invnum',    'serial',  '', '', '', '',
 293         'custnum',   'int',  '', '', '', '',
 294         '_date',     @date_type, '', '',
 295         'charged',   @money_type, '', '',
 296         'printed',   'int',  '', '', '', '',
 297         'closed',    'char', 'NULL', 1, '', '',
 298       ],
 299       'primary_key' => 'invnum',
 300       'unique' => [],
 301       'index' => [ ['custnum'], ['_date'] ],
 302     },
 303
 304     'cust_bill_event' => {
 305       'columns' => [
 306         'eventnum',    'serial',  '', '', '', '',
 307         'invnum',   'int',  '', '', '', '',
 308         'eventpart',   'int',  '', '', '', '',
 309         '_date',     @date_type, '', '',
 310         'status', 'varchar', '', $char_d, '', '',
 311         'statustext', 'text', 'NULL', '', '', '',
 312       ],
 313       'primary_key' => 'eventnum',
 314       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 315       'unique' => [],
 316       'index' => [ ['invnum'], ['status'] ],
 317     },
 318
 319     'part_bill_event' => {
 320       'columns' => [
 321         'eventpart',    'serial',  '', '', '', '',
 322         'freq',        'varchar',       'NULL',     $char_d, '', '',
 323         'payby',       'char',  '', 4, '', '',
 324         'event',       'varchar',           '',     $char_d, '', '',
 325         'eventcode',    @perl_type, '', '',
 326         'seconds',     'int', 'NULL', '', '', '',
 327         'weight',      'int', '', '', '', '',
 328         'plan',       'varchar', 'NULL', $char_d, '', '',
 329         'plandata',   'text', 'NULL', '', '', '',
 330         'disabled',     'char', 'NULL', 1, '', '',
 331       ],
 332       'primary_key' => 'eventpart',
 333       'unique' => [],
 334       'index' => [ ['payby'], ['disabled'], ],
 335     },
 336
 337     'cust_bill_pkg' => {
 338       'columns' => [
 339         'billpkgnum', 'serial', '', '', '', '',
 340         'pkgnum',  'int', '', '', '', '',
 341         'invnum',  'int', '', '', '', '',
 342         'setup',   @money_type, '', '',
 343         'recur',   @money_type, '', '',
 344         'sdate',   @date_type, '', '',
 345         'edate',   @date_type, '', '',
 346         'itemdesc', 'varchar', 'NULL', $char_d, '', '',
 347       ],
 348       'primary_key' => 'billpkgnum',
 349       'unique' => [],
 350       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 351     },
 352
 353     'cust_bill_pkg_detail' => {
 354       'columns' => [
 355         'detailnum', 'serial', '', '', '', '',
 356         'pkgnum',  'int', '', '', '', '',
 357         'invnum',  'int', '', '', '', '',
 358         'detail',  'varchar', '', $char_d, '', '',
 359       ],
 360       'primary_key' => 'detailnum',
 361       'unique' => [],
 362       'index' => [ [ 'pkgnum', 'invnum' ] ],
 363     },
 364
 365     'cust_credit' => {
 366       'columns' => [
 367         'crednum',  'serial', '', '', '', '',
 368         'custnum',  'int', '', '', '', '',
 369         '_date',    @date_type, '', '',
 370         'amount',   @money_type, '', '',
 371         'otaker',   'varchar', '', 32, '', '',
 372         'reason',   'text', 'NULL', '', '', '',
 373         'closed',    'char', 'NULL', 1, '', '',
 374       ],
 375       'primary_key' => 'crednum',
 376       'unique' => [],
 377       'index' => [ ['custnum'] ],
 378     },
 379
 380     'cust_credit_bill' => {
 381       'columns' => [
 382         'creditbillnum', 'serial', '', '', '', '',
 383         'crednum',  'int', '', '', '', '',
 384         'invnum',  'int', '', '', '', '',
 385         '_date',    @date_type, '', '',
 386         'amount',   @money_type, '', '',
 387       ],
 388       'primary_key' => 'creditbillnum',
 389       'unique' => [],
 390       'index' => [ ['crednum'], ['invnum'] ],
 391     },
 392
 393     'cust_main' => {
 394       'columns' => [
 395         'custnum',  'serial',  '',     '', '', '',
 396         'agentnum', 'int',  '',     '', '', '',
 397 #        'titlenum', 'int',  'NULL',   '', '', '',
 398         'last',     'varchar', '',     $char_d, '', '',
 399 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 400         'first',    'varchar', '',     $char_d, '', '',
 401         'ss',       'varchar', 'NULL', 11, '', '',
 402         'company',  'varchar', 'NULL', $char_d, '', '',
 403         'address1', 'varchar', '',     $char_d, '', '',
 404         'address2', 'varchar', 'NULL', $char_d, '', '',
 405         'city',     'varchar', '',     $char_d, '', '',
 406         'county',   'varchar', 'NULL', $char_d, '', '',
 407         'state',    'varchar', 'NULL', $char_d, '', '',
 408         'zip',      'varchar', 'NULL', 10, '', '',
 409         'country',  'char', '',     2, '', '',
 410         'daytime',  'varchar', 'NULL', 20, '', '',
 411         'night',    'varchar', 'NULL', 20, '', '',
 412         'fax',      'varchar', 'NULL', 12, '', '',
 413         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 414 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 415         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 416         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 417         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 418         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 419         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 420         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 421         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 422         'ship_zip',      'varchar', 'NULL', 10, '', '',
 423         'ship_country',  'char', 'NULL', 2, '', '',
 424         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 425         'ship_night',    'varchar', 'NULL', 20, '', '',
 426         'ship_fax',      'varchar', 'NULL', 12, '', '',
 427         'payby',    'char', '',     4, '', '',
 428         'payinfo',  'varchar', 'NULL', 512, '', '',
 429         'paycvv',   'varchar', 'NULL', 512, '', '',
 430         'paymask', 'varchar', 'NULL', $char_d, '', '',
 431         #'paydate',  @date_type, '', '',
 432         'paydate',  'varchar', 'NULL', 10, '', '',
 433         'paystart_month', 'int', 'NULL', '', '', '',
 434         'paystart_year',  'int', 'NULL', '', '', '',
 435         'payissue', 'varchar', 'NULL', 2, '', '',
 436         'payname',  'varchar', 'NULL', $char_d, '', '',
 437         'payip',    'varchar', 'NULL', 15, '', '',
 438         'tax',      'char', 'NULL', 1, '', '',
 439         'otaker',   'varchar', '',    32, '', '',
 440         'refnum',   'int',  '',     '', '', '',
 441         'referral_custnum', 'int',  'NULL', '', '', '',
 442         'comments', 'text', 'NULL', '', '', '',
 443         'spool_cdr','char', 'NULL', 1, '', '',
 444       ],
 445       'primary_key' => 'custnum',
 446       'unique' => [],
 447       #'index' => [ ['last'], ['company'] ],
 448       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 449                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 450                    [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 451                    [ 'ship_last' ], [ 'ship_company' ],
 452                    [ 'payby' ], [ 'paydate' ],
 453
 454                  ],
 455     },
 456
 457     'cust_main_invoice' => {
 458       'columns' => [
 459         'destnum',  'serial',  '',     '', '', '',
 460         'custnum',  'int',  '',     '', '', '',
 461         'dest',     'varchar', '',  $char_d, '', '',
 462       ],
 463       'primary_key' => 'destnum',
 464       'unique' => [],
 465       'index' => [ ['custnum'], ],
 466     },
 467
 468     'cust_main_county' => { #county+state+country are checked off the
 469                             #cust_main_county for validation and to provide
 470                             # a tax rate.
 471       'columns' => [
 472         'taxnum',   'serial',   '',    '', '', '',
 473         'state',    'varchar',  'NULL',    $char_d, '', '',
 474         'county',   'varchar',  'NULL',    $char_d, '', '',
 475         'country',  'char',  '', 2, '', '',
 476         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 477         'exempt_amount', @money_type, '', '',
 478         'tax',      'real',  '',    '', '', '', #tax %
 479         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 480         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 481         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 482       ],
 483       'primary_key' => 'taxnum',
 484       'unique' => [],
 485   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 486       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 487     },
 488
 489     'cust_pay' => {
 490       'columns' => [
 491         'paynum',   'serial',    '',   '', '', '',
 492         #now cust_bill_pay #'invnum',   'int',    '',   '', '', '',
 493         'custnum',  'int',    '',   '', '', '',
 494         'paid',     @money_type, '', '',
 495         '_date',    @date_type, '', '',
 496         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 497                                                  # index into payby table
 498                                                  # eventually
 499         'payinfo',  'varchar',   'NULL', $char_d, '', '', #see cust_main above
 500         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 501         'closed',    'char', 'NULL', 1, '', '',
 502       ],
 503       'primary_key' => 'paynum',
 504       'unique' => [],
 505       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 506     },
 507
 508     'cust_pay_void' => {
 509       'columns' => [
 510         'paynum',    'int',    '',   '', '', '',
 511         'custnum',   'int',    '',   '', '', '',
 512         'paid',      @money_type, '', '',
 513         '_date',     @date_type, '', '',
 514         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 515                                                   # index into payby table
 516                                                   # eventually
 517         'payinfo',   'varchar',   'NULL', $char_d, '', '', #see cust_main above
 518         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 519         'closed',    'char', 'NULL', 1, '', '',
 520         'void_date', @date_type, '', '',
 521         'reason',    'varchar',   'NULL', $char_d, '', '',
 522         'otaker',   'varchar', '', 32, '', '',
 523       ],
 524       'primary_key' => 'paynum',
 525       'unique' => [],
 526       'index' => [ [ 'custnum' ] ],
 527     },
 528
 529     'cust_bill_pay' => {
 530       'columns' => [
 531         'billpaynum', 'serial',     '',   '', '', '',
 532         'invnum',  'int',     '',   '', '', '',
 533         'paynum',  'int',     '',   '', '', '',
 534         'amount',  @money_type, '', '',
 535         '_date',   @date_type, '', '',
 536       ],
 537       'primary_key' => 'billpaynum',
 538       'unique' => [],
 539       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 540     },
 541
 542     'pay_batch' => { #batches of payments to an external processor
 543       'columns' => [
 544         'batchnum',   'serial',    '',   '', '', '',
 545         'status',     'char', 'NULL',     1, '', '',
 546         'download',   @date_type, 'NULL', '',
 547         'upload',     @date_type, 'NULL', '',
 548       ],
 549       'primary_key' => 'batchnum',
 550       'unique' => [],
 551       'index' => [],
 552     },
 553
 554     'cust_pay_batch' => { #what's this used for again?  list of customers
 555                           #in current CARD batch? (necessarily CARD?)
 556       'columns' => [
 557         'paybatchnum',   'serial',    '',   '', '', '',
 558         'batchnum',   'int',    '',   '', '', '',
 559         'invnum',   'int',    '',   '', '', '',
 560         'custnum',   'int',    '',   '', '', '',
 561         'last',     'varchar', '',     $char_d, '', '',
 562         'first',    'varchar', '',     $char_d, '', '',
 563         'address1', 'varchar', '',     $char_d, '', '',
 564         'address2', 'varchar', 'NULL', $char_d, '', '',
 565         'city',     'varchar', '',     $char_d, '', '',
 566         'state',    'varchar', 'NULL', $char_d, '', '',
 567         'zip',      'varchar', 'NULL', 10, '', '',
 568         'country',  'char', '',     2, '', '',
 569         #        'trancode', 'int', '', '', '', ''
 570         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 571         'payinfo',  'varchar', '',     512, '', '',
 572         #'exp',      @date_type, '', ''
 573         'exp',      'varchar', 'NULL',     11, '', '',
 574         'payname',  'varchar', 'NULL', $char_d, '', '',
 575         'amount',   @money_type, '', '',
 576         'status',   'varchar', 'NULL',     $char_d, '', '',
 577       ],
 578       'primary_key' => 'paybatchnum',
 579       'unique' => [],
 580       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 581     },
 582
 583     'cust_pkg' => {
 584       'columns' => [
 585         'pkgnum',    'serial',    '',   '', '', '',
 586         'custnum',   'int',    '',   '', '', '',
 587         'pkgpart',   'int',    '',   '', '', '',
 588         'otaker',    'varchar', '', 32, '', '',
 589         'setup',     @date_type, '', '',
 590         'bill',      @date_type, '', '',
 591         'last_bill', @date_type, '', '',
 592         'susp',      @date_type, '', '',
 593         'cancel',    @date_type, '', '',
 594         'expire',    @date_type, '', '',
 595         'manual_flag', 'char', 'NULL', 1, '', '',
 596       ],
 597       'primary_key' => 'pkgnum',
 598       'unique' => [],
 599       'index' => [ ['custnum'], ['pkgpart'] ],
 600     },
 601
 602     'cust_refund' => {
 603       'columns' => [
 604         'refundnum',    'serial',    '',   '', '', '',
 605         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 606         'custnum',  'int',    '',   '', '', '',
 607         '_date',        @date_type, '', '',
 608         'refund',       @money_type, '', '',
 609         'otaker',       'varchar',   '',   32, '', '',
 610         'reason',       'varchar',   '',   $char_d, '', '',
 611         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 612                                                      # be index into payby
 613                                                      # table eventually
 614         'payinfo',      'varchar',   'NULL', $char_d, '', '', #see cust_main above
 615         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 616         'closed',    'char', 'NULL', 1, '', '',
 617       ],
 618       'primary_key' => 'refundnum',
 619       'unique' => [],
 620       'index' => [],
 621     },
 622
 623     'cust_credit_refund' => {
 624       'columns' => [
 625         'creditrefundnum', 'serial',     '',   '', '', '',
 626         'crednum',  'int',     '',   '', '', '',
 627         'refundnum',  'int',     '',   '', '', '',
 628         'amount',  @money_type, '', '',
 629         '_date',   @date_type, '', '',
 630       ],
 631       'primary_key' => 'creditrefundnum',
 632       'unique' => [],
 633       'index' => [ [ 'crednum', 'refundnum' ] ],
 634     },
 635
 636
 637     'cust_svc' => {
 638       'columns' => [
 639         'svcnum',    'serial',    '',   '', '', '',
 640         'pkgnum',    'int',    'NULL',   '', '', '',
 641         'svcpart',   'int',    '',   '', '', '',
 642       ],
 643       'primary_key' => 'svcnum',
 644       'unique' => [],
 645       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 646     },
 647
 648     'part_pkg' => {
 649       'columns' => [
 650         'pkgpart',    'serial',    '',   '', '', '',
 651         'pkg',        'varchar',   '',   $char_d, '', '',
 652         'comment',    'varchar',   '',   $char_d, '', '',
 653         'promo_code', 'varchar', 'NULL', $char_d, '', '',
 654         'setup',      @perl_type, '', '',
 655         'freq',       'varchar',   '',   $char_d, '', '', #billing frequency
 656         'recur',      @perl_type, '', '',
 657         'setuptax',  'char', 'NULL', 1, '', '',
 658         'recurtax',  'char', 'NULL', 1, '', '',
 659         'plan',       'varchar', 'NULL', $char_d, '', '',
 660         'plandata',   'text', 'NULL', '', '', '',
 661         'disabled',   'char', 'NULL', 1, '', '',
 662         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 663         'classnum',   'int',     'NULL', '', '', '',
 664       ],
 665       'primary_key' => 'pkgpart',
 666       'unique' => [],
 667       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 668     },
 669
 670 #    'part_title' => {
 671 #      'columns' => [
 672 #        'titlenum',   'int',    '',   '',
 673 #        'title',      'varchar',   '',   $char_d,
 674 #      ],
 675 #      'primary_key' => 'titlenum',
 676 #      'unique' => [ [] ],
 677 #      'index' => [ [] ],
 678 #    },
 679
 680     'pkg_svc' => {
 681       'columns' => [
 682         'pkgsvcnum',  'serial', '',  '', '', '',
 683         'pkgpart',    'int',    '',   '', '', '',
 684         'svcpart',    'int',    '',   '', '', '',
 685         'quantity',   'int',    '',   '', '', '',
 686         'primary_svc','char', 'NULL',  1, '', '',
 687       ],
 688       'primary_key' => 'pkgsvcnum',
 689       'unique' => [ ['pkgpart', 'svcpart'] ],
 690       'index' => [ ['pkgpart'] ],
 691     },
 692
 693     'part_referral' => {
 694       'columns' => [
 695         'refnum',   'serial',    '',   '', '', '',
 696         'referral', 'varchar',   '',   $char_d, '', '',
 697         'disabled',     'char', 'NULL', 1, '', '',
 698       ],
 699       'primary_key' => 'refnum',
 700       'unique' => [],
 701       'index' => [ ['disabled'] ],
 702     },
 703
 704     'part_svc' => {
 705       'columns' => [
 706         'svcpart',    'serial',    '',   '', '', '',
 707         'svc',        'varchar',   '',   $char_d, '', '',
 708         'svcdb',      'varchar',   '',   $char_d, '', '',
 709         'disabled',   'char',  'NULL',   1, '', '',
 710       ],
 711       'primary_key' => 'svcpart',
 712       'unique' => [],
 713       'index' => [ [ 'disabled' ] ],
 714     },
 715
 716     'part_svc_column' => {
 717       'columns' => [
 718         'columnnum',   'serial',         '', '', '', '',
 719         'svcpart',     'int',         '', '', '', '',
 720         'columnname',  'varchar',     '', 64, '', '',
 721         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 722         'columnflag',  'char',    'NULL', 1, '', '',
 723       ],
 724       'primary_key' => 'columnnum',
 725       'unique' => [ [ 'svcpart', 'columnname' ] ],
 726       'index' => [ [ 'svcpart' ] ],
 727     },
 728
 729     #(this should be renamed to part_pop)
 730     'svc_acct_pop' => {
 731       'columns' => [
 732         'popnum',    'serial',    '',   '', '', '',
 733         'city',      'varchar',   '',   $char_d, '', '',
 734         'state',     'varchar',   '',   $char_d, '', '',
 735         'ac',        'char',   '',   3, '', '',
 736         'exch',      'char',   '',   3, '', '',
 737         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 738       ],
 739       'primary_key' => 'popnum',
 740       'unique' => [],
 741       'index' => [ [ 'state' ] ],
 742     },
 743
 744     'part_pop_local' => {
 745       'columns' => [
 746         'localnum',  'serial',     '',     '', '', '',
 747         'popnum',    'int',     '',     '', '', '',
 748         'city',      'varchar', 'NULL', $char_d, '', '',
 749         'state',     'char',    'NULL', 2, '', '',
 750         'npa',       'char',    '',     3, '', '',
 751         'nxx',       'char',    '',     3, '', '',
 752       ],
 753       'primary_key' => 'localnum',
 754       'unique' => [],
 755       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 756     },
 757
 758     'svc_acct' => {
 759       'columns' => [
 760         'svcnum',    'int',    '',   '', '', '',
 761         'username',  'varchar',   '',   $username_len, '', '', #unique (& remove dup code)
 762         '_password', 'varchar',   '',   72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
 763         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 764         'popnum',    'int',    'NULL',   '', '', '',
 765         'uid',       'int', 'NULL',   '', '', '',
 766         'gid',       'int', 'NULL',   '', '', '',
 767         'finger',    'varchar',   'NULL',   $char_d, '', '',
 768         'dir',       'varchar',   'NULL',   $char_d, '', '',
 769         'shell',     'varchar',   'NULL',   $char_d, '', '',
 770         'quota',     'varchar',   'NULL',   $char_d, '', '',
 771         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 772         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 773         'domsvc',    'int', '',   '', '', '',
 774       ],
 775       'primary_key' => 'svcnum',
 776       #'unique' => [ [ 'username', 'domsvc' ] ],
 777       'unique' => [],
 778       'index' => [ ['username'], ['domsvc'] ],
 779     },
 780
 781     #'svc_charge' => {
 782     #  'columns' => [
 783     #    'svcnum',    'int',    '',   '',
 784     #    'amount',    @money_type,
 785     #  ],
 786     #  'primary_key' => 'svcnum',
 787     #  'unique' => [ [] ],
 788     #  'index' => [ [] ],
 789     #},
 790
 791     'svc_domain' => {
 792       'columns' => [
 793         'svcnum',    'int',    '',   '', '', '',
 794         'domain',    'varchar',    '',   $char_d, '', '',
 795         'catchall',  'int', 'NULL',    '', '', '',
 796       ],
 797       'primary_key' => 'svcnum',
 798       'unique' => [ ['domain'] ],
 799       'index' => [],
 800     },
 801
 802     'domain_record' => {
 803       'columns' => [
 804         'recnum',    'serial',     '',  '', '', '',
 805         'svcnum',    'int',     '',  '', '', '',
 806         'reczone',   'varchar', '',  255, '', '',
 807         'recaf',     'char',    '',  2, '', '',
 808         'rectype',   'varchar',    '',  5, '', '',
 809         'recdata',   'varchar', '',  255, '', '',
 810       ],
 811       'primary_key' => 'recnum',
 812       'unique'      => [],
 813       'index'       => [ ['svcnum'] ],
 814     },
 815
 816     'svc_forward' => {
 817       'columns' => [
 818         'svcnum',   'int',            '',   '', '', '',
 819         'srcsvc',   'int',        'NULL',   '', '', '',
 820         'src',      'varchar',    'NULL',  255, '', '',
 821         'dstsvc',   'int',        'NULL',   '', '', '',
 822         'dst',      'varchar',    'NULL',  255, '', '',
 823       ],
 824       'primary_key' => 'svcnum',
 825       'unique'      => [],
 826       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 827     },
 828
 829     'svc_www' => {
 830       'columns' => [
 831         'svcnum',   'int',    '',  '', '', '',
 832         'recnum',   'int',    '',  '', '', '',
 833         'usersvc',  'int',    '',  '', '', '',
 834       ],
 835       'primary_key' => 'svcnum',
 836       'unique'      => [],
 837       'index'       => [],
 838     },
 839
 840     #'svc_wo' => {
 841     #  'columns' => [
 842     #    'svcnum',    'int',    '',   '',
 843     #    'svcnum',    'int',    '',   '',
 844     #    'svcnum',    'int',    '',   '',
 845     #    'worker',    'varchar',   '',   $char_d,
 846     #    '_date',     @date_type,
 847     #  ],
 848     #  'primary_key' => 'svcnum',
 849     #  'unique' => [ [] ],
 850     #  'index' => [ [] ],
 851     #},
 852
 853     'prepay_credit' => {
 854       'columns' => [
 855         'prepaynum',   'serial',     '',   '', '', '',
 856         'identifier',  'varchar', '', $char_d, '', '',
 857         'amount',      @money_type, '', '',
 858         'seconds',     'int',     'NULL', '', '', '',
 859         'agentnum',    'int',     'NULL', '', '', '',
 860       ],
 861       'primary_key' => 'prepaynum',
 862       'unique'      => [ ['identifier'] ],
 863       'index'       => [],
 864     },
 865
 866     'port' => {
 867       'columns' => [
 868         'portnum',  'serial',     '',   '', '', '',
 869         'ip',       'varchar', 'NULL', 15, '', '',
 870         'nasport',  'int',     'NULL', '', '', '',
 871         'nasnum',   'int',     '',   '', '', '',
 872       ],
 873       'primary_key' => 'portnum',
 874       'unique'      => [],
 875       'index'       => [],
 876     },
 877
 878     'nas' => {
 879       'columns' => [
 880         'nasnum',   'serial',     '',    '', '', '',
 881         'nas',      'varchar', '',    $char_d, '', '',
 882         'nasip',    'varchar', '',    15, '', '',
 883         'nasfqdn',  'varchar', '',    $char_d, '', '',
 884         'last',     'int',     '',    '', '', '',
 885       ],
 886       'primary_key' => 'nasnum',
 887       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
 888       'index'       => [ [ 'last' ] ],
 889     },
 890
 891     'session' => {
 892       'columns' => [
 893         'sessionnum', 'serial',       '',   '', '', '',
 894         'portnum',    'int',       '',   '', '', '',
 895         'svcnum',     'int',       '',   '', '', '',
 896         'login',      @date_type, '', '',
 897         'logout',     @date_type, '', '',
 898       ],
 899       'primary_key' => 'sessionnum',
 900       'unique'      => [],
 901       'index'       => [ [ 'portnum' ] ],
 902     },
 903
 904     'queue' => {
 905       'columns' => [
 906         'jobnum', 'serial', '', '', '', '',
 907         'job', 'text', '', '', '', '',
 908         '_date', 'int', '', '', '', '',
 909         'status', 'varchar', '', $char_d, '', '',
 910         'statustext', 'text', 'NULL', '', '', '',
 911         'svcnum', 'int', 'NULL', '', '', '',
 912       ],
 913       'primary_key' => 'jobnum',
 914       'unique'      => [],
 915       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
 916     },
 917
 918     'queue_arg' => {
 919       'columns' => [
 920         'argnum', 'serial', '', '', '', '',
 921         'jobnum', 'int', '', '', '', '',
 922         'arg', 'text', 'NULL', '', '', '',
 923       ],
 924       'primary_key' => 'argnum',
 925       'unique'      => [],
 926       'index'       => [ [ 'jobnum' ] ],
 927     },
 928
 929     'queue_depend' => {
 930       'columns' => [
 931         'dependnum', 'serial', '', '', '', '',
 932         'jobnum', 'int', '', '', '', '',
 933         'depend_jobnum', 'int', '', '', '', '',
 934       ],
 935       'primary_key' => 'dependnum',
 936       'unique'      => [],
 937       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
 938     },
 939
 940     'export_svc' => {
 941       'columns' => [
 942         'exportsvcnum' => 'serial', '', '', '', '',
 943         'exportnum'    => 'int', '', '', '', '',
 944         'svcpart'      => 'int', '', '', '', '',
 945       ],
 946       'primary_key' => 'exportsvcnum',
 947       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
 948       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
 949     },
 950
 951     'part_export' => {
 952       'columns' => [
 953         'exportnum', 'serial', '', '', '', '',
 954         'machine', 'varchar', '', $char_d, '', '',
 955         'exporttype', 'varchar', '', $char_d, '', '',
 956         'nodomain',     'char', 'NULL', 1, '', '',
 957       ],
 958       'primary_key' => 'exportnum',
 959       'unique'      => [],
 960       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
 961     },
 962
 963     'part_export_option' => {
 964       'columns' => [
 965         'optionnum', 'serial', '', '', '', '',
 966         'exportnum', 'int', '', '', '', '',
 967         'optionname', 'varchar', '', $char_d, '', '',
 968         'optionvalue', 'text', 'NULL', '', '', '',
 969       ],
 970       'primary_key' => 'optionnum',
 971       'unique'      => [],
 972       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
 973     },
 974
 975     'radius_usergroup' => {
 976       'columns' => [
 977         'usergroupnum', 'serial', '', '', '', '',
 978         'svcnum',       'int', '', '', '', '',
 979         'groupname',    'varchar', '', $char_d, '', '',
 980       ],
 981       'primary_key' => 'usergroupnum',
 982       'unique'      => [],
 983       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
 984     },
 985
 986     'msgcat' => {
 987       'columns' => [
 988         'msgnum', 'serial', '', '', '', '',
 989         'msgcode', 'varchar', '', $char_d, '', '',
 990         'locale', 'varchar', '', 16, '', '',
 991         'msg', 'text', '', '', '', '',
 992       ],
 993       'primary_key' => 'msgnum',
 994       'unique'      => [ [ 'msgcode', 'locale' ] ],
 995       'index'       => [],
 996     },
 997
 998     'cust_tax_exempt' => {
 999       'columns' => [
1000         'exemptnum', 'serial', '', '', '', '',
1001         'custnum',   'int', '', '', '', '',
1002         'taxnum',    'int', '', '', '', '',
1003         'year',      'int', '', '', '', '',
1004         'month',     'int', '', '', '', '',
1005         'amount',   @money_type, '', '',
1006       ],
1007       'primary_key' => 'exemptnum',
1008       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1009       'index'       => [],
1010     },
1011
1012     'cust_tax_exempt_pkg' => {
1013       'columns' => [
1014         'exemptpkgnum',  'serial', '', '', '', '',
1015         #'custnum',      'int', '', '', '', ''
1016         'billpkgnum',   'int', '', '', '', '',
1017         'taxnum',       'int', '', '', '', '',
1018         'year',         'int', '', '', '', '',
1019         'month',        'int', '', '', '', '',
1020         'amount',       @money_type, '', '',
1021       ],
1022       'primary_key' => 'exemptpkgnum',
1023       'unique' => [],
1024       'index'  => [ [ 'taxnum', 'year', 'month' ],
1025                     [ 'billpkgnum' ],
1026                     [ 'taxnum' ]
1027                   ],
1028     },
1029
1030     'router' => {
1031       'columns' => [
1032         'routernum', 'serial', '', '', '', '',
1033         'routername', 'varchar', '', $char_d, '', '',
1034         'svcnum', 'int', 'NULL', '', '', '',
1035       ],
1036       'primary_key' => 'routernum',
1037       'unique'      => [],
1038       'index'       => [],
1039     },
1040
1041     'part_svc_router' => {
1042       'columns' => [
1043         'svcrouternum', 'serial', '', '', '', '',
1044         'svcpart', 'int', '', '', '', '',
1045         'routernum', 'int', '', '', '', '',
1046       ],
1047       'primary_key' => 'svcrouternum',
1048       'unique'      => [],
1049       'index'       => [],
1050     },
1051
1052     'addr_block' => {
1053       'columns' => [
1054         'blocknum', 'serial', '', '', '', '',
1055         'routernum', 'int', '', '', '', '',
1056         'ip_gateway', 'varchar', '', 15, '', '',
1057         'ip_netmask', 'int', '', '', '', '',
1058       ],
1059       'primary_key' => 'blocknum',
1060       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1061       'index'       => [],
1062     },
1063
1064     'svc_broadband' => {
1065       'columns' => [
1066         'svcnum', 'int', '', '', '', '',
1067         'blocknum', 'int', '', '', '', '',
1068         'speed_up', 'int', '', '', '', '',
1069         'speed_down', 'int', '', '', '', '',
1070         'ip_addr', 'varchar', '', 15, '', '',
1071       ],
1072       'primary_key' => 'svcnum',
1073       'unique'      => [],
1074       'index'       => [],
1075     },
1076
1077     'part_virtual_field' => {
1078       'columns' => [
1079         'vfieldpart', 'int', '', '', '', '',
1080         'dbtable', 'varchar', '', 32, '', '',
1081         'name', 'varchar', '', 32, '', '',
1082         'check_block', 'text', 'NULL', '', '', '',
1083         'length', 'int', 'NULL', '', '', '',
1084         'list_source', 'text', 'NULL', '', '', '',
1085         'label', 'varchar', 'NULL', 80, '', '',
1086       ],
1087       'primary_key' => 'vfieldpart',
1088       'unique' => [],
1089       'index' => [],
1090     },
1091
1092     'virtual_field' => {
1093       'columns' => [
1094         'vfieldnum', 'serial', '', '', '', '',
1095         'recnum', 'int', '', '', '', '',
1096         'vfieldpart', 'int', '', '', '', '',
1097         'value', 'varchar', '', 128, '', '',
1098       ],
1099       'primary_key' => 'vfieldnum',
1100       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1101       'index' => [],
1102     },
1103
1104     'acct_snarf' => {
1105       'columns' => [
1106         'snarfnum',  'int', '', '', '', '',
1107         'svcnum',    'int', '', '', '', '',
1108         'machine',   'varchar', '', 255, '', '',
1109         'protocol',  'varchar', '', $char_d, '', '',
1110         'username',  'varchar', '', $char_d, '', '',
1111         '_password', 'varchar', '', $char_d, '', '',
1112       ],
1113       'primary_key' => 'snarfnum',
1114       'unique' => [],
1115       'index'  => [ [ 'svcnum' ] ],
1116     },
1117
1118     'svc_external' => {
1119       'columns' => [
1120         'svcnum', 'int', '', '', '', '',
1121         'id',     'int', 'NULL', '', '', '',
1122         'title',  'varchar', 'NULL', $char_d, '', '',
1123       ],
1124       'primary_key' => 'svcnum',
1125       'unique'      => [],
1126       'index'       => [],
1127     },
1128
1129     'cust_pay_refund' => {
1130       'columns' => [
1131         'payrefundnum', 'serial', '', '', '', '',
1132         'paynum',  'int', '', '', '', '',
1133         'refundnum',  'int', '', '', '', '',
1134         '_date',    @date_type, '', '',
1135         'amount',   @money_type, '', '',
1136       ],
1137       'primary_key' => 'payrefundnum',
1138       'unique' => [],
1139       'index' => [ ['paynum'], ['refundnum'] ],
1140     },
1141
1142     'part_pkg_option' => {
1143       'columns' => [
1144         'optionnum', 'serial', '', '', '', '',
1145         'pkgpart', 'int', '', '', '', '',
1146         'optionname', 'varchar', '', $char_d, '', '',
1147         'optionvalue', 'text', 'NULL', '', '', '',
1148       ],
1149       'primary_key' => 'optionnum',
1150       'unique'      => [],
1151       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1152     },
1153
1154     'rate' => {
1155       'columns' => [
1156         'ratenum',  'serial', '', '', '', '',
1157         'ratename', 'varchar', '', $char_d, '', '',
1158       ],
1159       'primary_key' => 'ratenum',
1160       'unique'      => [],
1161       'index'       => [],
1162     },
1163
1164     'rate_detail' => {
1165       'columns' => [
1166         'ratedetailnum',   'serial', '', '', '', '',
1167         'ratenum',         'int',     '', '', '', '',
1168         'orig_regionnum',  'int', 'NULL', '', '', '',
1169         'dest_regionnum',  'int',     '', '', '', '',
1170         'min_included',    'int',     '', '', '', '',
1171         #'min_charge',      @money_type, '', '',
1172         'min_charge',      'decimal', '', '10,5', '', '',
1173         'sec_granularity', 'int',     '', '', '', '',
1174         #time period (link to table of periods)?
1175       ],
1176       'primary_key' => 'ratedetailnum',
1177       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1178       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1179     },
1180
1181     'rate_region' => {
1182       'columns' => [
1183         'regionnum',   'serial',      '', '', '', '',
1184         'regionname',  'varchar',     '', $char_d, '', '',
1185       ],
1186       'primary_key' => 'regionnum',
1187       'unique'      => [],
1188       'index'       => [],
1189     },
1190
1191     'rate_prefix' => {
1192       'columns' => [
1193         'prefixnum',   'serial',    '', '', '', '',
1194         'regionnum',   'int',       '', '',, '', '',
1195         'countrycode', 'varchar',     '', 3, '', '',
1196         'npa',         'varchar', 'NULL', 6, '', '',
1197         'nxx',         'varchar', 'NULL', 3, '', '',
1198       ],
1199       'primary_key' => 'prefixnum',
1200       'unique'      => [],
1201       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1202     },
1203
1204     'reg_code' => {
1205       'columns' => [
1206         'codenum',   'serial',    '', '', '', '',
1207         'code',      'varchar',   '', $char_d, '', '',
1208         'agentnum',  'int',       '', '', '', '',
1209       ],
1210       'primary_key' => 'codenum',
1211       'unique'      => [ [ 'agentnum', 'code' ] ],
1212       'index'       => [ [ 'agentnum' ] ],
1213     },
1214
1215     'reg_code_pkg' => {
1216       'columns' => [
1217         'codepkgnum', 'serial', '', '', '', '',
1218         'codenum',   'int',    '', '', '', '',
1219         'pkgpart',   'int',    '', '', '', '',
1220       ],
1221       'primary_key' => 'codepkgnum',
1222       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1223       'index'       => [ [ 'codenum' ] ],
1224     },
1225
1226     'clientapi_session' => {
1227       'columns' => [
1228         'sessionnum',  'serial',  '', '', '', '',
1229         'sessionid',  'varchar',  '', $char_d, '', '',
1230         'namespace',  'varchar',  '', $char_d, '', '',
1231       ],
1232       'primary_key' => 'sessionnum',
1233       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1234       'index'       => [],
1235     },
1236
1237     'clientapi_session_field' => {
1238       'columns' => [
1239         'fieldnum',    'serial',     '', '', '', '',
1240         'sessionnum',     'int',     '', '', '', '',
1241         'fieldname',  'varchar',     '', $char_d, '', '',
1242         'fieldvalue',    'text', 'NULL', '', '', '',
1243       ],
1244       'primary_key' => 'fieldnum',
1245       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1246       'index'       => [],
1247     },
1248
1249     'payment_gateway' => {
1250       'columns' => [
1251         'gatewaynum',       'serial',   '',     '', '', '',
1252         'gateway_module',   'varchar',  '',     $char_d, '', '',
1253         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1254         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1255         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1256         'disabled',   'char',  'NULL',   1, '', '',
1257       ],
1258       'primary_key' => 'gatewaynum',
1259       'unique' => [],
1260       'index'  => [ [ 'disabled' ] ],
1261     },
1262
1263     'payment_gateway_option' => {
1264       'columns' => [
1265         'optionnum',   'serial',  '',     '', '', '',
1266         'gatewaynum',  'int',     '',     '', '', '',
1267         'optionname',  'varchar', '',     $char_d, '', '',
1268         'optionvalue', 'text',    'NULL', '', '', '',
1269       ],
1270       'primary_key' => 'optionnum',
1271       'unique'      => [],
1272       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1273     },
1274
1275     'agent_payment_gateway' => {
1276       'columns' => [
1277         'agentgatewaynum', 'serial', '', '', '', '',
1278         'agentnum',        'int', '', '', '', '',
1279         'gatewaynum',      'int', '', '', '', '',
1280         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1281         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1282       ],
1283       'primary_key' => 'agentgatewaynum',
1284       'unique'      => [],
1285       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1286     },
1287
1288     'banned_pay' => {
1289       'columns' => [
1290         'bannum',  'serial',   '',     '', '', '',
1291         'payby',   'char',     '',       4, '', '',
1292         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1293         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1294         '_date',   @date_type, '', '',
1295         'otaker',  'varchar',  '',     32, '', '',
1296         'reason',  'varchar',  'NULL', $char_d, '', '',
1297       ],
1298       'primary_key' => 'bannum',
1299       'unique'      => [ [ 'payby', 'payinfo' ] ],
1300       'index'       => [],
1301     },
1302
1303     'cancel_reason' => {
1304       'columns' => [
1305         'reasonnum', 'serial',  '',     '', '', '',
1306         'reason',    'varchar', '',     $char_d, '', '',
1307         'disabled',  'char',    'NULL', 1, '', '',
1308       ],
1309       'primary_key' => 'reasonnum',
1310       'unique' => [],
1311       'index'  => [ [ 'disabled' ] ],
1312     },
1313
1314     'pkg_class' => {
1315       'columns' => [
1316         'classnum',   'serial',  '', '', '', '',
1317         'classname',  'varchar', '', $char_d, '', '',
1318       ],
1319       'primary_key' => 'classnum',
1320       'unique' => [],
1321       'index' => [],
1322     },
1323
1324     'cdr' => {
1325       'columns' => [
1326         # qw( name type null length default local );
1327
1328         ###
1329         #asterisk fields
1330         ###
1331
1332         'acctid',   'bigserial',  '', '', '', '',
1333         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1334         'clid',        'varchar',  '', $char_d, \"''", '',
1335         'src',         'varchar',  '', $char_d, \"''", '',
1336         'dst',         'varchar',  '', $char_d, \"''", '',
1337         'dcontext',    'varchar',  '', $char_d, \"''", '',
1338         'channel',     'varchar',  '', $char_d, \"''", '',
1339         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1340         'lastapp',     'varchar',  '', $char_d, \"''", '',
1341         'lastdata',    'varchar',  '', $char_d, \"''", '',
1342
1343         #these don't seem to be logged by most of the SQL cdr_* modules
1344         #except tds under sql-illegal names, so;
1345         # ... don't rely on them for rating?
1346         # and, what they hey, i went ahead and changed the names and data types
1347         # to freeside-style dates...
1348           #'start',  'timestamp', 'NULL',  '',    '', '',
1349           #'answer', 'timestamp', 'NULL',  '',    '', '',
1350           #'end',    'timestamp', 'NULL',  '',    '', '',
1351         'startdate',  @date_type, '', '',
1352         'answerdate', @date_type, '', '',
1353         'enddate',    @date_type, '', '',
1354         #
1355
1356         'duration',    'int',      '',      '',     0, '',
1357         'billsec',     'int',      '',      '',     0, '',
1358         'disposition', 'varchar',  '',      45, \"''", '',
1359         'amaflags',    'int',      '',      '',     0, '',
1360         'accountcode', 'varchar',  '',      20, \"''", '',
1361         'uniqueid',    'varchar',  '',      32, \"''", '',
1362         'userfield',   'varchar',  '',     255, \"''", '',
1363
1364         ###
1365         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1366         # defaults
1367         ###
1368
1369         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1370         'cdrtypenum',              'int', 'NULL',      '', '', '',
1371
1372         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1373
1374         'upstream_currency',      'char', 'NULL',       3, '', '',
1375         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1376         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1377
1378         # how it was rated internally...
1379         'ratedetailnum',           'int', 'NULL',      '', '', '',
1380         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1381
1382         'distance',            'decimal', 'NULL',      '', '', '',
1383         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1384
1385         #cdr_calltype: the big list in appendix 2
1386         'calltypenum',             'int', 'NULL',      '', '', '',
1387
1388         'description',         'varchar', 'NULL', $char_d, '', '',
1389         'quantity',                'int', 'NULL',      '', '', '',
1390
1391         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1392         'carrierid',               'int', 'NULL',      '', '', '',
1393
1394         'upstream_rateid',         'int', 'NULL',      '', '', '',
1395
1396         ###
1397         #and now for our own fields
1398         ###
1399
1400         # a svcnum... right..?
1401         'svcnum',             'int',   'NULL',     '',   '', '',
1402
1403         #NULL, done (or something)
1404         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1405
1406       ],
1407       'primary_key' => 'acctid',
1408       'unique' => [],
1409       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1410     },
1411
1412     'cdr_calltype' => {
1413       'columns' => [
1414         'calltypenum',   'serial',  '', '', '', '',
1415         'calltypename',  'varchar', '', $char_d, '', '',
1416       ],
1417       'primary_key' => 'calltypenum',
1418       'unique'      => [],
1419       'index'       => [],
1420     },
1421
1422     'cdr_type' => {
1423       'columns' => [
1424         'cdrtypenum'  => 'serial',  '', '', '', '',
1425         'cdrtypename' => 'varchar', '', '', '', '',
1426       ],
1427       'primary_key' => 'cdrtypenum',
1428       'unique'      => [],
1429       'index'       => [],
1430     },
1431
1432     'cdr_carrier' => {
1433       'columns' => [
1434         'carrierid'   => 'serial',  '', '', '', '',
1435         'carriername' => 'varchar', '', '', '', '',
1436       ],
1437       'primary_key' => 'carrierid',
1438       'unique'      => [],
1439       'index'       => [],
1440     },
1441
1442     #map upstream rateid to ours...
1443     'cdr_upstream_rate' => {
1444       'columns' => [
1445         'upstreamratenum', 'serial',  '', '', '', '',
1446         'upstream_rateid', 'varchar', '', $char_d, '', '',
1447         'ratedetailnum',   'int', 'NULL', '', '', '',
1448       ],
1449       'primary_key' => 'upstreamratenum', #XXX need a primary key
1450       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1451       'index'  => [],
1452     },
1453
1454     'inventory_item' => {
1455       'columns' => [
1456         'itemnum',  'serial',      '',      '', '', '',
1457         'classnum', 'int',         '',      '', '', '',
1458         'item',     'varchar',     '', $char_d, '', '',
1459         'svcnum',   'int',     'NULL',      '', '', '',
1460       ],
1461       'primary_key' => 'itemnum',
1462       'unique' => [ [ 'classnum', 'item' ] ],
1463       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1464     },
1465
1466     'inventory_class' => {
1467       'columns' => [
1468         'classnum',  'serial',       '',      '', '', '',
1469         'classname', 'varchar',      '', $char_d, '', '',
1470       ],
1471       'primary_key' => 'classnum',
1472       'unique' => [],
1473       'index'  => [],
1474     },
1475
1476     'access_user' => {
1477       'columns' => [
1478         'usernum',   'serial',  '',      '', '', '',
1479         'username',  'varchar', '', $char_d, '', '',
1480         '_password', 'varchar', '', $char_d, '', '',
1481         'last',      'varchar', '', $char_d, '', '',
1482         'first',     'varchar', '', $char_d, '', '',
1483         'disabled',     'char', 'NULL',   1, '', '',
1484       ],
1485       'primary_key' => 'usernum',
1486       'unique' => [ [ 'username' ] ],
1487       'index'  => [],
1488     },
1489
1490     'access_user_pref' => {
1491       'columns' => [
1492         'prefnum',    'serial',       '', '', '', '',
1493         'usernum',     'int',       '', '', '', '',
1494         'prefname', 'varchar', '', $char_d, '', '',
1495         'prefvalue', 'text', 'NULL', '', '', '',
1496       ],
1497       'primary_key' => 'prefnum',
1498       'unique' => [],
1499       'index'  => [ [ 'usernum' ] ],
1500     },
1501
1502     'access_group' => {
1503       'columns' => [
1504         'groupnum',   'serial', '',      '', '', '',
1505         'groupname', 'varchar', '', $char_d, '', '',
1506       ],
1507       'primary_key' => 'groupnum',
1508       'unique' => [ [ 'groupname' ] ],
1509       'index'  => [],
1510     },
1511
1512     'access_usergroup' => {
1513       'columns' => [
1514         'usergroupnum', 'serial', '', '', '', '',
1515         'usernum',         'int', '', '', '', '',
1516         'groupnum',        'int', '', '', '', '',
1517       ],
1518       'primary_key' => 'usergroupnum',
1519       'unique' => [ [ 'usernum', 'groupnum' ] ],
1520       'index'  => [ [ 'usernum' ] ],
1521     },
1522
1523     'access_groupagent' => {
1524       'columns' => [
1525         'groupagentnum', 'serial', '', '', '', '',
1526         'groupnum',         'int', '', '', '', '',
1527         'agentnum',         'int', '', '', '', '',
1528       ],
1529       'primary_key' => 'groupagentnum',
1530       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1531       'index'  => [ [ 'groupnum' ] ],
1532     },
1533
1534     'access_right' => {
1535       'columns' => [
1536         'rightnum',   'serial', '',      '', '', '',
1537         'righttype', 'varchar', '', $char_d, '', '',
1538         'rightobjnum',   'int', '',      '', '', '',
1539         'rightname', 'varchar', '',      '', '', '',
1540       ],
1541       'primary_key' => 'rightnum',
1542       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1543       'index'  => [],
1544     },
1545
1546     'svc_phone' => {
1547       'columns' => [
1548         'svcnum',      'int',         '',      '', '', '',
1549         'countrycode', 'varchar',     '',       3, '', '',
1550         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1551         'pin',         'varchar', 'NULL', $char_d, '', '',
1552       ],
1553       'primary_key' => 'svcnum',
1554       'unique' => [],
1555       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1556     },
1557
1558   };
1559
1560     #'new_table' => {
1561     #  'columns' => [
1562     #    'num', 'serial',       '', '', '', '',
1563     #  ],
1564     #  'primary_key' => 'num',
1565     #  'unique' => [],
1566     #  'index'  => [],
1567     #},
1568
1569 }
1570
1571 =back
1572
1573 =head1 BUGS
1574
1575 =head1 SEE ALSO
1576
1577 L<DBIx::DBSchema>
1578
1579 =cut
1580
1581 1;
1582