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