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         'reason',     'int', 'NULL', '', '', '',
 323         'disabled',     'char', 'NULL', 1, '', '',
 324       ],
 325       'primary_key' => 'eventpart',
 326       'unique' => [],
 327       'index' => [ ['payby'], ['disabled'], ],
 328     },
 329
 330     'cust_bill_pkg' => {
 331       'columns' => [
 332         'billpkgnum', 'serial', '', '', '', '',
 333         'pkgnum',  'int', '', '', '', '',
 334         'invnum',  'int', '', '', '', '',
 335         'setup',   @money_type, '', '',
 336         'recur',   @money_type, '', '',
 337         'sdate',   @date_type, '', '',
 338         'edate',   @date_type, '', '',
 339         'itemdesc', 'varchar', 'NULL', $char_d, '', '',
 340       ],
 341       'primary_key' => 'billpkgnum',
 342       'unique' => [],
 343       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 344     },
 345
 346     'cust_bill_pkg_detail' => {
 347       'columns' => [
 348         'detailnum', 'serial', '', '', '', '',
 349         'pkgnum',  'int', '', '', '', '',
 350         'invnum',  'int', '', '', '', '',
 351         'detail',  'varchar', '', $char_d, '', '',
 352       ],
 353       'primary_key' => 'detailnum',
 354       'unique' => [],
 355       'index' => [ [ 'pkgnum', 'invnum' ] ],
 356     },
 357
 358     'cust_credit' => {
 359       'columns' => [
 360         'crednum',  'serial', '', '', '', '',
 361         'custnum',  'int', '', '', '', '',
 362         '_date',    @date_type, '', '',
 363         'amount',   @money_type, '', '',
 364         'otaker',   'varchar', '', 32, '', '',
 365         'reason',   'text', 'NULL', '', '', '',
 366         'closed',    'char', 'NULL', 1, '', '',
 367       ],
 368       'primary_key' => 'crednum',
 369       'unique' => [],
 370       'index' => [ ['custnum'] ],
 371     },
 372
 373     'cust_credit_bill' => {
 374       'columns' => [
 375         'creditbillnum', 'serial', '', '', '', '',
 376         'crednum',  'int', '', '', '', '',
 377         'invnum',  'int', '', '', '', '',
 378         '_date',    @date_type, '', '',
 379         'amount',   @money_type, '', '',
 380       ],
 381       'primary_key' => 'creditbillnum',
 382       'unique' => [],
 383       'index' => [ ['crednum'], ['invnum'] ],
 384     },
 385
 386     'cust_credit_bill_pkg' => {
 387       'columns' => [
 388         'creditbillpkgnum', 'serial', '',      '', '', '',
 389         'creditbillnum',       'int', '',      '', '', '',
 390         'billpkgnum',          'int', '',      '', '', '',
 391         'amount',            @money_type,          '', '',
 392         'setuprecur',      'varchar', '', $char_d, '', '',
 393         'sdate',   @date_type, '', '',
 394         'edate',   @date_type, '', '',
 395       ],
 396       'primary_key' => 'creditbillpkgnum',
 397       'unique'      => [],
 398       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 399     },
 400
 401     'cust_main' => {
 402       'columns' => [
 403         'custnum',  'serial',  '',     '', '', '',
 404         'agentnum', 'int',  '',     '', '', '',
 405         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 406 #        'titlenum', 'int',  'NULL',   '', '', '',
 407         'last',     'varchar', '',     $char_d, '', '',
 408 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 409         'first',    'varchar', '',     $char_d, '', '',
 410         'ss',       'varchar', 'NULL', 11, '', '',
 411         'birthdate' ,@date_type, '', '',
 412         'signupdate',@date_type, '', '',
 413         'company',  'varchar', 'NULL', $char_d, '', '',
 414         'address1', 'varchar', '',     $char_d, '', '',
 415         'address2', 'varchar', 'NULL', $char_d, '', '',
 416         'city',     'varchar', '',     $char_d, '', '',
 417         'county',   'varchar', 'NULL', $char_d, '', '',
 418         'state',    'varchar', 'NULL', $char_d, '', '',
 419         'zip',      'varchar', 'NULL', 10, '', '',
 420         'country',  'char', '',     2, '', '',
 421         'daytime',  'varchar', 'NULL', 20, '', '',
 422         'night',    'varchar', 'NULL', 20, '', '',
 423         'fax',      'varchar', 'NULL', 12, '', '',
 424         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 425 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 426         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 427         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 428         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 429         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 430         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 431         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 432         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 433         'ship_zip',      'varchar', 'NULL', 10, '', '',
 434         'ship_country',  'char', 'NULL', 2, '', '',
 435         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 436         'ship_night',    'varchar', 'NULL', 20, '', '',
 437         'ship_fax',      'varchar', 'NULL', 12, '', '',
 438         'payby',    'char', '',     4, '', '',
 439         'payinfo',  'varchar', 'NULL', 512, '', '',
 440         'paycvv',   'varchar', 'NULL', 512, '', '',
 441         'paymask', 'varchar', 'NULL', $char_d, '', '',
 442         #'paydate',  @date_type, '', '',
 443         'paydate',  'varchar', 'NULL', 10, '', '',
 444         'paystart_month', 'int', 'NULL', '', '', '',
 445         'paystart_year',  'int', 'NULL', '', '', '',
 446         'payissue', 'varchar', 'NULL', 2, '', '',
 447         'payname',  'varchar', 'NULL', $char_d, '', '',
 448         'payip',    'varchar', 'NULL', 15, '', '',
 449         'tax',      'char', 'NULL', 1, '', '',
 450         'otaker',   'varchar', '',    32, '', '',
 451         'refnum',   'int',  '',     '', '', '',
 452         'referral_custnum', 'int',  'NULL', '', '', '',
 453         'comments', 'text', 'NULL', '', '', '',
 454         'spool_cdr','char', 'NULL', 1, '', '',
 455       ],
 456       'primary_key' => 'custnum',
 457       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 458       #'index' => [ ['last'], ['company'] ],
 459       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 460                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 461                    [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 462                    [ 'ship_last' ], [ 'ship_company' ],
 463                    [ 'payby' ], [ 'paydate' ],
 464
 465                  ],
 466     },
 467
 468     'cust_main_invoice' => {
 469       'columns' => [
 470         'destnum',  'serial',  '',     '', '', '',
 471         'custnum',  'int',  '',     '', '', '',
 472         'dest',     'varchar', '',  $char_d, '', '',
 473       ],
 474       'primary_key' => 'destnum',
 475       'unique' => [],
 476       'index' => [ ['custnum'], ],
 477     },
 478
 479     'cust_main_note' => {
 480       'columns' => [
 481         'notenum',  'serial',  '',     '', '', '',
 482         'custnum',  'int',  '',     '', '', '',
 483         '_date',    @date_type, '', '',
 484         'otaker',   'varchar', '',    32, '', '',
 485         'comments', 'text', 'NULL', '', '', '',
 486       ],
 487       'primary_key' => 'notenum',
 488       'unique' => [],
 489       'index' => [ [ 'custnum' ], [ '_date' ], ],
 490     },
 491
 492     'cust_main_county' => { #county+state+country are checked off the
 493                             #cust_main_county for validation and to provide
 494                             # a tax rate.
 495       'columns' => [
 496         'taxnum',   'serial',   '',    '', '', '',
 497         'state',    'varchar',  'NULL',    $char_d, '', '',
 498         'county',   'varchar',  'NULL',    $char_d, '', '',
 499         'country',  'char',  '', 2, '', '',
 500         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 501         'exempt_amount', @money_type, '', '',
 502         'tax',      'real',  '',    '', '', '', #tax %
 503         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 504         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 505         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 506       ],
 507       'primary_key' => 'taxnum',
 508       'unique' => [],
 509   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 510       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 511     },
 512
 513     'cust_pay' => {
 514       'columns' => [
 515         'paynum',   'serial',    '',   '', '', '',
 516         #now cust_bill_pay #'invnum',   'int',    '',   '', '', '',
 517         'custnum',  'int',    '',   '', '', '',
 518         'paid',     @money_type, '', '',
 519         '_date',    @date_type, '', '',
 520         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 521                                                  # index into payby table
 522                                                  # eventually
 523         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 524         'paymask', 'varchar', 'NULL', $char_d, '', '',
 525         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 526         'closed',    'char', 'NULL', 1, '', '',
 527       ],
 528       'primary_key' => 'paynum',
 529       'unique' => [],
 530       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 531     },
 532
 533     'cust_pay_void' => {
 534       'columns' => [
 535         'paynum',    'int',    '',   '', '', '',
 536         'custnum',   'int',    '',   '', '', '',
 537         'paid',      @money_type, '', '',
 538         '_date',     @date_type, '', '',
 539         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 540                                                   # index into payby table
 541                                                   # eventually
 542         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 543         'paymask', 'varchar', 'NULL', $char_d, '', '',
 544         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 545         'closed',    'char', 'NULL', 1, '', '',
 546         'void_date', @date_type, '', '',
 547         'reason',    'varchar',   'NULL', $char_d, '', '',
 548         'otaker',   'varchar', '', 32, '', '',
 549       ],
 550       'primary_key' => 'paynum',
 551       'unique' => [],
 552       'index' => [ [ 'custnum' ] ],
 553     },
 554
 555     'cust_bill_pay' => {
 556       'columns' => [
 557         'billpaynum', 'serial',     '',   '', '', '',
 558         'invnum',  'int',     '',   '', '', '',
 559         'paynum',  'int',     '',   '', '', '',
 560         'amount',  @money_type, '', '',
 561         '_date',   @date_type, '', '',
 562       ],
 563       'primary_key' => 'billpaynum',
 564       'unique' => [],
 565       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 566     },
 567
 568     'cust_bill_pay_batch' => {
 569       'columns' => [
 570         'billpaynum', 'serial',     '',   '', '', '',
 571         'invnum',  'int',     '',   '', '', '',
 572         'paybatchnum',  'int',     '',   '', '', '',
 573         'amount',  @money_type, '', '',
 574         '_date',   @date_type, '', '',
 575       ],
 576       'primary_key' => 'billpaynum',
 577       'unique' => [],
 578       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 579     },
 580
 581     'cust_bill_pay_pkg' => {
 582       'columns' => [
 583         'billpaypkgnum', 'serial', '', '', '', '',
 584         'billpaynum',       'int', '', '', '', '',
 585         'billpkgnum',       'int', '', '', '', '',
 586         'amount',         @money_type,     '', '',
 587         'setuprecur',      'varchar', '', $char_d, '', '',
 588         'sdate',   @date_type, '', '',
 589         'edate',   @date_type, '', '',
 590       ],
 591       'primary_key' => 'billpaypkgnum',
 592       'unique'      => [],
 593       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 594     },
 595
 596     'pay_batch' => { #batches of payments to an external processor
 597       'columns' => [
 598         'batchnum',   'serial',    '',   '', '', '',
 599         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 600         'status',     'char', 'NULL',     1, '', '',
 601         'download',   @date_type, '', '',
 602         'upload',     @date_type, '', '',
 603       ],
 604       'primary_key' => 'batchnum',
 605       'unique' => [],
 606       'index' => [],
 607     },
 608
 609     'cust_pay_batch' => { #what's this used for again?  list of customers
 610                           #in current CARD batch? (necessarily CARD?)
 611       'columns' => [
 612         'paybatchnum',   'serial',    '',   '', '', '',
 613         'batchnum',   'int',    '',   '', '', '',
 614         'invnum',   'int',    '',   '', '', '',
 615         'custnum',   'int',    '',   '', '', '',
 616         'last',     'varchar', '',     $char_d, '', '',
 617         'first',    'varchar', '',     $char_d, '', '',
 618         'address1', 'varchar', '',     $char_d, '', '',
 619         'address2', 'varchar', 'NULL', $char_d, '', '',
 620         'city',     'varchar', '',     $char_d, '', '',
 621         'state',    'varchar', 'NULL', $char_d, '', '',
 622         'zip',      'varchar', 'NULL', 10, '', '',
 623         'country',  'char', '',     2, '', '',
 624         #        'trancode', 'int', '', '', '', ''
 625         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 626         'payinfo',  'varchar', '',     512, '', '',
 627         #'exp',      @date_type, '', ''
 628         'exp',      'varchar', 'NULL',     11, '', '',
 629         'payname',  'varchar', 'NULL', $char_d, '', '',
 630         'amount',   @money_type, '', '',
 631         'status',   'varchar', 'NULL',     $char_d, '', '',
 632       ],
 633       'primary_key' => 'paybatchnum',
 634       'unique' => [],
 635       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 636     },
 637
 638     'cust_pkg' => {
 639       'columns' => [
 640         'pkgnum',    'serial',    '',   '', '', '',
 641         'custnum',   'int',    '',   '', '', '',
 642         'pkgpart',   'int',    '',   '', '', '',
 643         'otaker',    'varchar', '', 32, '', '',
 644         'setup',     @date_type, '', '',
 645         'bill',      @date_type, '', '',
 646         'last_bill', @date_type, '', '',
 647         'susp',      @date_type, '', '',
 648         'cancel',    @date_type, '', '',
 649         'expire',    @date_type, '', '',
 650         'manual_flag', 'char', 'NULL', 1, '', '',
 651       ],
 652       'primary_key' => 'pkgnum',
 653       'unique' => [],
 654       'index' => [ ['custnum'], ['pkgpart'] ],
 655     },
 656
 657     'cust_pkg_option' => {
 658       'columns' => [
 659         'optionnum', 'serial', '', '', '', '',
 660         'pkgnum', 'int', '', '', '', '',
 661         'optionname', 'varchar', '', $char_d, '', '',
 662         'optionvalue', 'text', 'NULL', '', '', '',
 663       ],
 664       'primary_key' => 'optionnum',
 665       'unique'      => [],
 666       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
 667     },
 668
 669     'cust_pkg_reason' => {
 670       'columns' => [
 671         'num',      'serial',    '',   '', '', '',
 672         'pkgnum',   'int',    '',   '', '', '',
 673         'reasonnum','int',    '',   '', '', '',
 674         'otaker',   'varchar', '', 32, '', '',
 675         'date',     @date_type, '', '',
 676       ],
 677       'primary_key' => 'num',
 678       'unique' => [],
 679       'index' => [],
 680     },
 681
 682     'cust_refund' => {
 683       'columns' => [
 684         'refundnum',    'serial',    '',   '', '', '',
 685         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 686         'custnum',  'int',    '',   '', '', '',
 687         '_date',        @date_type, '', '',
 688         'refund',       @money_type, '', '',
 689         'otaker',       'varchar',   '',   32, '', '',
 690         'reason',       'varchar',   '',   $char_d, '', '',
 691         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 692                                                      # be index into payby
 693                                                      # table eventually
 694         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
 695         'paymask', 'varchar', 'NULL', $char_d, '', '',
 696         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 697         'closed',    'char', 'NULL', 1, '', '',
 698       ],
 699       'primary_key' => 'refundnum',
 700       'unique' => [],
 701       'index' => [],
 702     },
 703
 704     'cust_credit_refund' => {
 705       'columns' => [
 706         'creditrefundnum', 'serial',     '',   '', '', '',
 707         'crednum',  'int',     '',   '', '', '',
 708         'refundnum',  'int',     '',   '', '', '',
 709         'amount',  @money_type, '', '',
 710         '_date',   @date_type, '', '',
 711       ],
 712       'primary_key' => 'creditrefundnum',
 713       'unique' => [],
 714       'index' => [ [ 'crednum', 'refundnum' ] ],
 715     },
 716
 717
 718     'cust_svc' => {
 719       'columns' => [
 720         'svcnum',    'serial',    '',   '', '', '',
 721         'pkgnum',    'int',    'NULL',   '', '', '',
 722         'svcpart',   'int',    '',   '', '', '',
 723       ],
 724       'primary_key' => 'svcnum',
 725       'unique' => [],
 726       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 727     },
 728
 729     'part_pkg' => {
 730       'columns' => [
 731         'pkgpart',       'serial',    '',   '', '', '',
 732         'pkg',           'varchar',   '',   $char_d, '', '',
 733         'comment',       'varchar',   '',   $char_d, '', '',
 734         'promo_code',    'varchar', 'NULL', $char_d, '', '',
 735         'setup',         @perl_type, '', '',
 736         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
 737         'recur',         @perl_type, '', '',
 738         'setuptax',      'char', 'NULL', 1, '', '',
 739         'recurtax',      'char', 'NULL', 1, '', '',
 740         'plan',          'varchar', 'NULL', $char_d, '', '',
 741         'plandata',      'text', 'NULL', '', '', '',
 742         'disabled',      'char', 'NULL', 1, '', '',
 743         'taxclass',      'varchar', 'NULL', $char_d, '', '',
 744         'classnum',      'int',     'NULL', '', '', '',
 745         'pay_weight',    'real',    'NULL', '', '', '',
 746         'credit_weight', 'real',    'NULL', '', '', '',
 747       ],
 748       'primary_key' => 'pkgpart',
 749       'unique' => [],
 750       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 751     },
 752
 753 #    'part_title' => {
 754 #      'columns' => [
 755 #        'titlenum',   'int',    '',   '',
 756 #        'title',      'varchar',   '',   $char_d,
 757 #      ],
 758 #      'primary_key' => 'titlenum',
 759 #      'unique' => [ [] ],
 760 #      'index' => [ [] ],
 761 #    },
 762
 763     'pkg_svc' => {
 764       'columns' => [
 765         'pkgsvcnum',  'serial', '',  '', '', '',
 766         'pkgpart',    'int',    '',   '', '', '',
 767         'svcpart',    'int',    '',   '', '', '',
 768         'quantity',   'int',    '',   '', '', '',
 769         'primary_svc','char', 'NULL',  1, '', '',
 770       ],
 771       'primary_key' => 'pkgsvcnum',
 772       'unique' => [ ['pkgpart', 'svcpart'] ],
 773       'index' => [ ['pkgpart'] ],
 774     },
 775
 776     'part_referral' => {
 777       'columns' => [
 778         'refnum',   'serial',     '',        '', '', '',
 779         'referral', 'varchar',    '',   $char_d, '', '',
 780         'disabled', 'char',   'NULL',         1, '', '',
 781         'agentnum', 'int',    'NULL',        '', '', '',
 782       ],
 783       'primary_key' => 'refnum',
 784       'unique' => [],
 785       'index' => [ ['disabled'] ],
 786     },
 787
 788     'part_svc' => {
 789       'columns' => [
 790         'svcpart',    'serial',    '',   '', '', '',
 791         'svc',        'varchar',   '',   $char_d, '', '',
 792         'svcdb',      'varchar',   '',   $char_d, '', '',
 793         'disabled',   'char',  'NULL',   1, '', '',
 794       ],
 795       'primary_key' => 'svcpart',
 796       'unique' => [],
 797       'index' => [ [ 'disabled' ] ],
 798     },
 799
 800     'part_svc_column' => {
 801       'columns' => [
 802         'columnnum',   'serial',         '', '', '', '',
 803         'svcpart',     'int',         '', '', '', '',
 804         'columnname',  'varchar',     '', 64, '', '',
 805         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 806         'columnflag',  'char',    'NULL', 1, '', '',
 807       ],
 808       'primary_key' => 'columnnum',
 809       'unique' => [ [ 'svcpart', 'columnname' ] ],
 810       'index' => [ [ 'svcpart' ] ],
 811     },
 812
 813     #(this should be renamed to part_pop)
 814     'svc_acct_pop' => {
 815       'columns' => [
 816         'popnum',    'serial',    '',   '', '', '',
 817         'city',      'varchar',   '',   $char_d, '', '',
 818         'state',     'varchar',   '',   $char_d, '', '',
 819         'ac',        'char',   '',   3, '', '',
 820         'exch',      'char',   '',   3, '', '',
 821         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 822       ],
 823       'primary_key' => 'popnum',
 824       'unique' => [],
 825       'index' => [ [ 'state' ] ],
 826     },
 827
 828     'part_pop_local' => {
 829       'columns' => [
 830         'localnum',  'serial',     '',     '', '', '',
 831         'popnum',    'int',     '',     '', '', '',
 832         'city',      'varchar', 'NULL', $char_d, '', '',
 833         'state',     'char',    'NULL', 2, '', '',
 834         'npa',       'char',    '',     3, '', '',
 835         'nxx',       'char',    '',     3, '', '',
 836       ],
 837       'primary_key' => 'localnum',
 838       'unique' => [],
 839       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 840     },
 841
 842     'svc_acct' => {
 843       'columns' => [
 844         'svcnum',    'int',    '',   '', '', '',
 845         'username',  'varchar',   '',   $username_len, '', '',
 846         '_password', 'varchar',   '',  512, '', '',
 847         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
 848         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 849         'popnum',    'int',    'NULL',   '', '', '',
 850         'uid',       'int', 'NULL',   '', '', '',
 851         'gid',       'int', 'NULL',   '', '', '',
 852         'finger',    'varchar',   'NULL',   $char_d, '', '',
 853         'dir',       'varchar',   'NULL',   $char_d, '', '',
 854         'shell',     'varchar',   'NULL',   $char_d, '', '',
 855         'quota',     'varchar',   'NULL',   $char_d, '', '',
 856         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 857         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 858         'seconds_threshold',   'int', 'NULL',   '', '', '',
 859         'upbytes',   'bigint', 'NULL',   '', '', '',
 860         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
 861         'downbytes', 'bigint', 'NULL',   '', '', '',
 862         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
 863         'totalbytes','bigint', 'NULL',   '', '', '',
 864         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
 865         'domsvc',    'int', '',   '', '', '',
 866       ],
 867       'primary_key' => 'svcnum',
 868       #'unique' => [ [ 'username', 'domsvc' ] ],
 869       'unique' => [],
 870       'index' => [ ['username'], ['domsvc'] ],
 871     },
 872
 873     #'svc_charge' => {
 874     #  'columns' => [
 875     #    'svcnum',    'int',    '',   '',
 876     #    'amount',    @money_type,
 877     #  ],
 878     #  'primary_key' => 'svcnum',
 879     #  'unique' => [ [] ],
 880     #  'index' => [ [] ],
 881     #},
 882
 883     'svc_domain' => {
 884       'columns' => [
 885         'svcnum',           'int',    '',        '', '', '',
 886         'domain',       'varchar',    '',   $char_d, '', '',
 887         'suffix',       'varchar', 'NULL',  $char_d, '', '',
 888         'catchall',         'int', 'NULL',       '', '', '',
 889         'parent_svcnum',    'int', 'NULL',       '', '', '',
 890         'registrarnum',     'int', 'NULL',       '', '', '',
 891         'registrarkey', 'varchar', 'NULL',       '', '', '',
 892         'setup_date',  @date_type, '', '',
 893         'renewal_interval', 'int', 'NULL',       '', '', '',
 894         'expiration_date', @date_type, '', '',
 895       ],
 896       'primary_key' => 'svcnum',
 897       'unique' => [ ],
 898       'index' => [ ['domain'] ],
 899     },
 900
 901     'domain_record' => {
 902       'columns' => [
 903         'recnum',    'serial',     '',  '', '', '',
 904         'svcnum',    'int',     '',  '', '', '',
 905         'reczone',   'varchar', '',  255, '', '',
 906         'recaf',     'char',    '',  2, '', '',
 907         'rectype',   'varchar',    '',  5, '', '',
 908         'recdata',   'varchar', '',  255, '', '',
 909       ],
 910       'primary_key' => 'recnum',
 911       'unique'      => [],
 912       'index'       => [ ['svcnum'] ],
 913     },
 914
 915     'registrar' => {
 916       'columns' => [
 917         'registrarnum',   'serial', '',      '', '', '',
 918         'registrarname', 'varchar', '', $char_d, '', '',
 919       ],
 920       'primary_key' => 'registrarnum',
 921       'unique'      => [],
 922       'index'       => [],
 923     },
 924
 925     'svc_forward' => {
 926       'columns' => [
 927         'svcnum',   'int',            '',   '', '', '',
 928         'srcsvc',   'int',        'NULL',   '', '', '',
 929         'src',      'varchar',    'NULL',  255, '', '',
 930         'dstsvc',   'int',        'NULL',   '', '', '',
 931         'dst',      'varchar',    'NULL',  255, '', '',
 932       ],
 933       'primary_key' => 'svcnum',
 934       'unique'      => [],
 935       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 936     },
 937
 938     'svc_www' => {
 939       'columns' => [
 940         'svcnum',   'int',    '',  '', '', '',
 941         'recnum',   'int',    '',  '', '', '',
 942         'usersvc',  'int',    '',  '', '', '',
 943       ],
 944       'primary_key' => 'svcnum',
 945       'unique'      => [],
 946       'index'       => [],
 947     },
 948
 949     #'svc_wo' => {
 950     #  'columns' => [
 951     #    'svcnum',    'int',    '',   '',
 952     #    'svcnum',    'int',    '',   '',
 953     #    'svcnum',    'int',    '',   '',
 954     #    'worker',    'varchar',   '',   $char_d,
 955     #    '_date',     @date_type,
 956     #  ],
 957     #  'primary_key' => 'svcnum',
 958     #  'unique' => [ [] ],
 959     #  'index' => [ [] ],
 960     #},
 961
 962     'prepay_credit' => {
 963       'columns' => [
 964         'prepaynum',   'serial',     '',   '', '', '',
 965         'identifier',  'varchar', '', $char_d, '', '',
 966         'amount',      @money_type, '', '',
 967         'seconds',     'int',     'NULL', '', '', '',
 968         'upbytes',     'bigint',     'NULL', '', '', '',
 969         'downbytes',   'bigint',     'NULL', '', '', '',
 970         'totalbytes',  'bigint',     'NULL', '', '', '',
 971         'agentnum',    'int',     'NULL', '', '', '',
 972       ],
 973       'primary_key' => 'prepaynum',
 974       'unique'      => [ ['identifier'] ],
 975       'index'       => [],
 976     },
 977
 978     'port' => {
 979       'columns' => [
 980         'portnum',  'serial',     '',   '', '', '',
 981         'ip',       'varchar', 'NULL', 15, '', '',
 982         'nasport',  'int',     'NULL', '', '', '',
 983         'nasnum',   'int',     '',   '', '', '',
 984       ],
 985       'primary_key' => 'portnum',
 986       'unique'      => [],
 987       'index'       => [],
 988     },
 989
 990     'nas' => {
 991       'columns' => [
 992         'nasnum',   'serial',     '',    '', '', '',
 993         'nas',      'varchar', '',    $char_d, '', '',
 994         'nasip',    'varchar', '',    15, '', '',
 995         'nasfqdn',  'varchar', '',    $char_d, '', '',
 996         'last',     'int',     '',    '', '', '',
 997       ],
 998       'primary_key' => 'nasnum',
 999       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1000       'index'       => [ [ 'last' ] ],
1001     },
1002
1003     'session' => {
1004       'columns' => [
1005         'sessionnum', 'serial',       '',   '', '', '',
1006         'portnum',    'int',       '',   '', '', '',
1007         'svcnum',     'int',       '',   '', '', '',
1008         'login',      @date_type, '', '',
1009         'logout',     @date_type, '', '',
1010       ],
1011       'primary_key' => 'sessionnum',
1012       'unique'      => [],
1013       'index'       => [ [ 'portnum' ] ],
1014     },
1015
1016     'queue' => {
1017       'columns' => [
1018         'jobnum', 'serial', '', '', '', '',
1019         'job', 'text', '', '', '', '',
1020         '_date', 'int', '', '', '', '',
1021         'status', 'varchar', '', $char_d, '', '',
1022         'statustext', 'text', 'NULL', '', '', '',
1023         'svcnum', 'int', 'NULL', '', '', '',
1024       ],
1025       'primary_key' => 'jobnum',
1026       'unique'      => [],
1027       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
1028     },
1029
1030     'queue_arg' => {
1031       'columns' => [
1032         'argnum', 'serial', '', '', '', '',
1033         'jobnum', 'int', '', '', '', '',
1034         'arg', 'text', 'NULL', '', '', '',
1035       ],
1036       'primary_key' => 'argnum',
1037       'unique'      => [],
1038       'index'       => [ [ 'jobnum' ] ],
1039     },
1040
1041     'queue_depend' => {
1042       'columns' => [
1043         'dependnum', 'serial', '', '', '', '',
1044         'jobnum', 'int', '', '', '', '',
1045         'depend_jobnum', 'int', '', '', '', '',
1046       ],
1047       'primary_key' => 'dependnum',
1048       'unique'      => [],
1049       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1050     },
1051
1052     'export_svc' => {
1053       'columns' => [
1054         'exportsvcnum' => 'serial', '', '', '', '',
1055         'exportnum'    => 'int', '', '', '', '',
1056         'svcpart'      => 'int', '', '', '', '',
1057       ],
1058       'primary_key' => 'exportsvcnum',
1059       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1060       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1061     },
1062
1063     'part_export' => {
1064       'columns' => [
1065         'exportnum', 'serial', '', '', '', '',
1066         'machine', 'varchar', '', $char_d, '', '',
1067         'exporttype', 'varchar', '', $char_d, '', '',
1068         'nodomain',     'char', 'NULL', 1, '', '',
1069       ],
1070       'primary_key' => 'exportnum',
1071       'unique'      => [],
1072       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1073     },
1074
1075     'part_export_option' => {
1076       'columns' => [
1077         'optionnum', 'serial', '', '', '', '',
1078         'exportnum', 'int', '', '', '', '',
1079         'optionname', 'varchar', '', $char_d, '', '',
1080         'optionvalue', 'text', 'NULL', '', '', '',
1081       ],
1082       'primary_key' => 'optionnum',
1083       'unique'      => [],
1084       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1085     },
1086
1087     'radius_usergroup' => {
1088       'columns' => [
1089         'usergroupnum', 'serial', '', '', '', '',
1090         'svcnum',       'int', '', '', '', '',
1091         'groupname',    'varchar', '', $char_d, '', '',
1092       ],
1093       'primary_key' => 'usergroupnum',
1094       'unique'      => [],
1095       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1096     },
1097
1098     'msgcat' => {
1099       'columns' => [
1100         'msgnum', 'serial', '', '', '', '',
1101         'msgcode', 'varchar', '', $char_d, '', '',
1102         'locale', 'varchar', '', 16, '', '',
1103         'msg', 'text', '', '', '', '',
1104       ],
1105       'primary_key' => 'msgnum',
1106       'unique'      => [ [ 'msgcode', 'locale' ] ],
1107       'index'       => [],
1108     },
1109
1110     'cust_tax_exempt' => {
1111       'columns' => [
1112         'exemptnum', 'serial', '', '', '', '',
1113         'custnum',   'int', '', '', '', '',
1114         'taxnum',    'int', '', '', '', '',
1115         'year',      'int', '', '', '', '',
1116         'month',     'int', '', '', '', '',
1117         'amount',   @money_type, '', '',
1118       ],
1119       'primary_key' => 'exemptnum',
1120       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1121       'index'       => [],
1122     },
1123
1124     'cust_tax_exempt_pkg' => {
1125       'columns' => [
1126         'exemptpkgnum',  'serial', '', '', '', '',
1127         #'custnum',      'int', '', '', '', ''
1128         'billpkgnum',   'int', '', '', '', '',
1129         'taxnum',       'int', '', '', '', '',
1130         'year',         'int', '', '', '', '',
1131         'month',        'int', '', '', '', '',
1132         'amount',       @money_type, '', '',
1133       ],
1134       'primary_key' => 'exemptpkgnum',
1135       'unique' => [],
1136       'index'  => [ [ 'taxnum', 'year', 'month' ],
1137                     [ 'billpkgnum' ],
1138                     [ 'taxnum' ]
1139                   ],
1140     },
1141
1142     'router' => {
1143       'columns' => [
1144         'routernum', 'serial', '', '', '', '',
1145         'routername', 'varchar', '', $char_d, '', '',
1146         'svcnum', 'int', 'NULL', '', '', '',
1147       ],
1148       'primary_key' => 'routernum',
1149       'unique'      => [],
1150       'index'       => [],
1151     },
1152
1153     'part_svc_router' => {
1154       'columns' => [
1155         'svcrouternum', 'serial', '', '', '', '',
1156         'svcpart', 'int', '', '', '', '',
1157         'routernum', 'int', '', '', '', '',
1158       ],
1159       'primary_key' => 'svcrouternum',
1160       'unique'      => [],
1161       'index'       => [],
1162     },
1163
1164     'addr_block' => {
1165       'columns' => [
1166         'blocknum', 'serial', '', '', '', '',
1167         'routernum', 'int', '', '', '', '',
1168         'ip_gateway', 'varchar', '', 15, '', '',
1169         'ip_netmask', 'int', '', '', '', '',
1170       ],
1171       'primary_key' => 'blocknum',
1172       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1173       'index'       => [],
1174     },
1175
1176     'svc_broadband' => {
1177       'columns' => [
1178         'svcnum', 'int', '', '', '', '',
1179         'description', 'varchar', 'NULL', $char_d, '', '',
1180         'blocknum', 'int', '', '', '', '',
1181         'speed_up', 'int', '', '', '', '',
1182         'speed_down', 'int', '', '', '', '',
1183         'ip_addr', 'varchar', '', 15, '', '',
1184         'mac_addr', 'varchar', 'NULL', 12, '', '',
1185         'authkey',  'varchar', 'NULL', 32, '', '',
1186         'latitude', 'decimal', 'NULL', '', '', '',
1187         'longitude', 'decimal', 'NULL', '', '', '',
1188         'altitude', 'decimal', 'NULL', '', '', '',
1189         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1190       ],
1191       'primary_key' => 'svcnum',
1192       'unique'      => [],
1193       'index'       => [],
1194     },
1195
1196     'part_virtual_field' => {
1197       'columns' => [
1198         'vfieldpart', 'int', '', '', '', '',
1199         'dbtable', 'varchar', '', 32, '', '',
1200         'name', 'varchar', '', 32, '', '',
1201         'check_block', 'text', 'NULL', '', '', '',
1202         'length', 'int', 'NULL', '', '', '',
1203         'list_source', 'text', 'NULL', '', '', '',
1204         'label', 'varchar', 'NULL', 80, '', '',
1205       ],
1206       'primary_key' => 'vfieldpart',
1207       'unique' => [],
1208       'index' => [],
1209     },
1210
1211     'virtual_field' => {
1212       'columns' => [
1213         'vfieldnum', 'serial', '', '', '', '',
1214         'recnum', 'int', '', '', '', '',
1215         'vfieldpart', 'int', '', '', '', '',
1216         'value', 'varchar', '', 128, '', '',
1217       ],
1218       'primary_key' => 'vfieldnum',
1219       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1220       'index' => [],
1221     },
1222
1223     'acct_snarf' => {
1224       'columns' => [
1225         'snarfnum',  'int', '', '', '', '',
1226         'svcnum',    'int', '', '', '', '',
1227         'machine',   'varchar', '', 255, '', '',
1228         'protocol',  'varchar', '', $char_d, '', '',
1229         'username',  'varchar', '', $char_d, '', '',
1230         '_password', 'varchar', '', $char_d, '', '',
1231       ],
1232       'primary_key' => 'snarfnum',
1233       'unique' => [],
1234       'index'  => [ [ 'svcnum' ] ],
1235     },
1236
1237     'svc_external' => {
1238       'columns' => [
1239         'svcnum', 'int', '', '', '', '',
1240         'id',     'int', 'NULL', '', '', '',
1241         'title',  'varchar', 'NULL', $char_d, '', '',
1242       ],
1243       'primary_key' => 'svcnum',
1244       'unique'      => [],
1245       'index'       => [],
1246     },
1247
1248     'cust_pay_refund' => {
1249       'columns' => [
1250         'payrefundnum', 'serial', '', '', '', '',
1251         'paynum',  'int', '', '', '', '',
1252         'refundnum',  'int', '', '', '', '',
1253         '_date',    @date_type, '', '',
1254         'amount',   @money_type, '', '',
1255       ],
1256       'primary_key' => 'payrefundnum',
1257       'unique' => [],
1258       'index' => [ ['paynum'], ['refundnum'] ],
1259     },
1260
1261     'part_pkg_option' => {
1262       'columns' => [
1263         'optionnum', 'serial', '', '', '', '',
1264         'pkgpart', 'int', '', '', '', '',
1265         'optionname', 'varchar', '', $char_d, '', '',
1266         'optionvalue', 'text', 'NULL', '', '', '',
1267       ],
1268       'primary_key' => 'optionnum',
1269       'unique'      => [],
1270       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1271     },
1272
1273     'rate' => {
1274       'columns' => [
1275         'ratenum',  'serial', '', '', '', '',
1276         'ratename', 'varchar', '', $char_d, '', '',
1277       ],
1278       'primary_key' => 'ratenum',
1279       'unique'      => [],
1280       'index'       => [],
1281     },
1282
1283     'rate_detail' => {
1284       'columns' => [
1285         'ratedetailnum',   'serial', '', '', '', '',
1286         'ratenum',         'int',     '', '', '', '',
1287         'orig_regionnum',  'int', 'NULL', '', '', '',
1288         'dest_regionnum',  'int',     '', '', '', '',
1289         'min_included',    'int',     '', '', '', '',
1290         #'min_charge',      @money_type, '', '',
1291         'min_charge',      'decimal', '', '10,5', '', '',
1292         'sec_granularity', 'int',     '', '', '', '',
1293         #time period (link to table of periods)?
1294       ],
1295       'primary_key' => 'ratedetailnum',
1296       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1297       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1298     },
1299
1300     'rate_region' => {
1301       'columns' => [
1302         'regionnum',   'serial',      '', '', '', '',
1303         'regionname',  'varchar',     '', $char_d, '', '',
1304       ],
1305       'primary_key' => 'regionnum',
1306       'unique'      => [],
1307       'index'       => [],
1308     },
1309
1310     'rate_prefix' => {
1311       'columns' => [
1312         'prefixnum',   'serial',    '', '', '', '',
1313         'regionnum',   'int',       '', '',, '', '',
1314         'countrycode', 'varchar',     '', 3, '', '',
1315         'npa',         'varchar', 'NULL', 6, '', '',
1316         'nxx',         'varchar', 'NULL', 3, '', '',
1317       ],
1318       'primary_key' => 'prefixnum',
1319       'unique'      => [],
1320       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1321     },
1322
1323     'reg_code' => {
1324       'columns' => [
1325         'codenum',   'serial',    '', '', '', '',
1326         'code',      'varchar',   '', $char_d, '', '',
1327         'agentnum',  'int',       '', '', '', '',
1328       ],
1329       'primary_key' => 'codenum',
1330       'unique'      => [ [ 'agentnum', 'code' ] ],
1331       'index'       => [ [ 'agentnum' ] ],
1332     },
1333
1334     'reg_code_pkg' => {
1335       'columns' => [
1336         'codepkgnum', 'serial', '', '', '', '',
1337         'codenum',   'int',    '', '', '', '',
1338         'pkgpart',   'int',    '', '', '', '',
1339       ],
1340       'primary_key' => 'codepkgnum',
1341       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1342       'index'       => [ [ 'codenum' ] ],
1343     },
1344
1345     'clientapi_session' => {
1346       'columns' => [
1347         'sessionnum',  'serial',  '', '', '', '',
1348         'sessionid',  'varchar',  '', $char_d, '', '',
1349         'namespace',  'varchar',  '', $char_d, '', '',
1350       ],
1351       'primary_key' => 'sessionnum',
1352       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1353       'index'       => [],
1354     },
1355
1356     'clientapi_session_field' => {
1357       'columns' => [
1358         'fieldnum',    'serial',     '', '', '', '',
1359         'sessionnum',     'int',     '', '', '', '',
1360         'fieldname',  'varchar',     '', $char_d, '', '',
1361         'fieldvalue',    'text', 'NULL', '', '', '',
1362       ],
1363       'primary_key' => 'fieldnum',
1364       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1365       'index'       => [],
1366     },
1367
1368     'payment_gateway' => {
1369       'columns' => [
1370         'gatewaynum',       'serial',   '',     '', '', '',
1371         'gateway_module',   'varchar',  '',     $char_d, '', '',
1372         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1373         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1374         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1375         'disabled',   'char',  'NULL',   1, '', '',
1376       ],
1377       'primary_key' => 'gatewaynum',
1378       'unique' => [],
1379       'index'  => [ [ 'disabled' ] ],
1380     },
1381
1382     'payment_gateway_option' => {
1383       'columns' => [
1384         'optionnum',   'serial',  '',     '', '', '',
1385         'gatewaynum',  'int',     '',     '', '', '',
1386         'optionname',  'varchar', '',     $char_d, '', '',
1387         'optionvalue', 'text',    'NULL', '', '', '',
1388       ],
1389       'primary_key' => 'optionnum',
1390       'unique'      => [],
1391       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1392     },
1393
1394     'agent_payment_gateway' => {
1395       'columns' => [
1396         'agentgatewaynum', 'serial', '', '', '', '',
1397         'agentnum',        'int', '', '', '', '',
1398         'gatewaynum',      'int', '', '', '', '',
1399         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1400         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1401       ],
1402       'primary_key' => 'agentgatewaynum',
1403       'unique'      => [],
1404       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1405     },
1406
1407     'banned_pay' => {
1408       'columns' => [
1409         'bannum',  'serial',   '',     '', '', '',
1410         'payby',   'char',     '',       4, '', '',
1411         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1412         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1413         '_date',   @date_type, '', '',
1414         'otaker',  'varchar',  '',     32, '', '',
1415         'reason',  'varchar',  'NULL', $char_d, '', '',
1416       ],
1417       'primary_key' => 'bannum',
1418       'unique'      => [ [ 'payby', 'payinfo' ] ],
1419       'index'       => [],
1420     },
1421
1422     'pkg_class' => {
1423       'columns' => [
1424         'classnum',   'serial',  '', '', '', '',
1425         'classname',  'varchar', '', $char_d, '', '',
1426         'disabled',     'char', 'NULL',   1, '', '',
1427       ],
1428       'primary_key' => 'classnum',
1429       'unique' => [],
1430       'index' => [ ['disabled'] ],
1431     },
1432
1433     'cdr' => {
1434       'columns' => [
1435         # qw( name type null length default local );
1436
1437         ###
1438         #asterisk fields
1439         ###
1440
1441         'acctid',   'bigserial',  '', '', '', '',
1442         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1443         'clid',        'varchar',  '', $char_d, \"''", '',
1444         'src',         'varchar',  '', $char_d, \"''", '',
1445         'dst',         'varchar',  '', $char_d, \"''", '',
1446         'dcontext',    'varchar',  '', $char_d, \"''", '',
1447         'channel',     'varchar',  '', $char_d, \"''", '',
1448         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1449         'lastapp',     'varchar',  '', $char_d, \"''", '',
1450         'lastdata',    'varchar',  '', $char_d, \"''", '',
1451
1452         #these don't seem to be logged by most of the SQL cdr_* modules
1453         #except tds under sql-illegal names, so;
1454         # ... don't rely on them for rating?
1455         # and, what they hey, i went ahead and changed the names and data types
1456         # to freeside-style dates...
1457           #'start',  'timestamp', 'NULL',  '',    '', '',
1458           #'answer', 'timestamp', 'NULL',  '',    '', '',
1459           #'end',    'timestamp', 'NULL',  '',    '', '',
1460         'startdate',  @date_type, '', '',
1461         'answerdate', @date_type, '', '',
1462         'enddate',    @date_type, '', '',
1463         #
1464
1465         'duration',    'int',      '',      '',     0, '',
1466         'billsec',     'int',      '',      '',     0, '',
1467         'disposition', 'varchar',  '',      45, \"''", '',
1468         'amaflags',    'int',      '',      '',     0, '',
1469         'accountcode', 'varchar',  '',      20, \"''", '',
1470         'uniqueid',    'varchar',  '',      32, \"''", '',
1471         'userfield',   'varchar',  '',     255, \"''", '',
1472
1473         ###
1474         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1475         # defaults
1476         ###
1477
1478         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1479         'cdrtypenum',              'int', 'NULL',      '', '', '',
1480
1481         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1482
1483         'upstream_currency',      'char', 'NULL',       3, '', '',
1484         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1485         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1486
1487         # how it was rated internally...
1488         'ratedetailnum',           'int', 'NULL',      '', '', '',
1489         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1490
1491         'distance',            'decimal', 'NULL',      '', '', '',
1492         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1493
1494         #cdr_calltype: the big list in appendix 2
1495         'calltypenum',             'int', 'NULL',      '', '', '',
1496
1497         'description',         'varchar', 'NULL', $char_d, '', '',
1498         'quantity',                'int', 'NULL',      '', '', '',
1499
1500         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1501         'carrierid',               'int', 'NULL',      '', '', '',
1502
1503         'upstream_rateid',         'int', 'NULL',      '', '', '',
1504
1505         ###
1506         #and now for our own fields
1507         ###
1508
1509         # a svcnum... right..?
1510         'svcnum',             'int',   'NULL',     '',   '', '',
1511
1512         #NULL, done (or something)
1513         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1514
1515       ],
1516       'primary_key' => 'acctid',
1517       'unique' => [],
1518       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1519     },
1520
1521     'cdr_calltype' => {
1522       'columns' => [
1523         'calltypenum',   'serial',  '', '', '', '',
1524         'calltypename',  'varchar', '', $char_d, '', '',
1525       ],
1526       'primary_key' => 'calltypenum',
1527       'unique'      => [],
1528       'index'       => [],
1529     },
1530
1531     'cdr_type' => {
1532       'columns' => [
1533         'cdrtypenum'  => 'serial',  '', '', '', '',
1534         'cdrtypename' => 'varchar', '', '', '', '',
1535       ],
1536       'primary_key' => 'cdrtypenum',
1537       'unique'      => [],
1538       'index'       => [],
1539     },
1540
1541     'cdr_carrier' => {
1542       'columns' => [
1543         'carrierid'   => 'serial',  '', '', '', '',
1544         'carriername' => 'varchar', '', '', '', '',
1545       ],
1546       'primary_key' => 'carrierid',
1547       'unique'      => [],
1548       'index'       => [],
1549     },
1550
1551     #map upstream rateid to ours...
1552     'cdr_upstream_rate' => {
1553       'columns' => [
1554         'upstreamratenum', 'serial',  '', '', '', '',
1555         'upstream_rateid', 'varchar', '', $char_d, '', '',
1556         'ratedetailnum',   'int', 'NULL', '', '', '',
1557       ],
1558       'primary_key' => 'upstreamratenum', #XXX need a primary key
1559       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1560       'index'  => [],
1561     },
1562
1563     'inventory_item' => {
1564       'columns' => [
1565         'itemnum',  'serial',      '',      '', '', '',
1566         'classnum', 'int',         '',      '', '', '',
1567         'item',     'varchar',     '', $char_d, '', '',
1568         'svcnum',   'int',     'NULL',      '', '', '',
1569       ],
1570       'primary_key' => 'itemnum',
1571       'unique' => [ [ 'classnum', 'item' ] ],
1572       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1573     },
1574
1575     'inventory_class' => {
1576       'columns' => [
1577         'classnum',  'serial',       '',      '', '', '',
1578         'classname', 'varchar',      '', $char_d, '', '',
1579       ],
1580       'primary_key' => 'classnum',
1581       'unique' => [],
1582       'index'  => [],
1583     },
1584
1585     'access_user' => {
1586       'columns' => [
1587         'usernum',   'serial',  '',      '', '', '',
1588         'username',  'varchar', '', $char_d, '', '',
1589         '_password', 'varchar', '', $char_d, '', '',
1590         'last',      'varchar', '', $char_d, '', '',
1591         'first',     'varchar', '', $char_d, '', '',
1592         'disabled',     'char', 'NULL',   1, '', '',
1593       ],
1594       'primary_key' => 'usernum',
1595       'unique' => [ [ 'username' ] ],
1596       'index'  => [],
1597     },
1598
1599     'access_user_pref' => {
1600       'columns' => [
1601         'prefnum',    'serial',       '', '', '', '',
1602         'usernum',     'int',       '', '', '', '',
1603         'prefname', 'varchar', '', $char_d, '', '',
1604         'prefvalue', 'text', 'NULL', '', '', '',
1605       ],
1606       'primary_key' => 'prefnum',
1607       'unique' => [],
1608       'index'  => [ [ 'usernum' ] ],
1609     },
1610
1611     'access_group' => {
1612       'columns' => [
1613         'groupnum',   'serial', '',      '', '', '',
1614         'groupname', 'varchar', '', $char_d, '', '',
1615       ],
1616       'primary_key' => 'groupnum',
1617       'unique' => [ [ 'groupname' ] ],
1618       'index'  => [],
1619     },
1620
1621     'access_usergroup' => {
1622       'columns' => [
1623         'usergroupnum', 'serial', '', '', '', '',
1624         'usernum',         'int', '', '', '', '',
1625         'groupnum',        'int', '', '', '', '',
1626       ],
1627       'primary_key' => 'usergroupnum',
1628       'unique' => [ [ 'usernum', 'groupnum' ] ],
1629       'index'  => [ [ 'usernum' ] ],
1630     },
1631
1632     'access_groupagent' => {
1633       'columns' => [
1634         'groupagentnum', 'serial', '', '', '', '',
1635         'groupnum',         'int', '', '', '', '',
1636         'agentnum',         'int', '', '', '', '',
1637       ],
1638       'primary_key' => 'groupagentnum',
1639       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1640       'index'  => [ [ 'groupnum' ] ],
1641     },
1642
1643     'access_right' => {
1644       'columns' => [
1645         'rightnum',   'serial', '',      '', '', '',
1646         'righttype', 'varchar', '', $char_d, '', '',
1647         'rightobjnum',   'int', '',      '', '', '',
1648         'rightname', 'varchar', '',      '', '', '',
1649       ],
1650       'primary_key' => 'rightnum',
1651       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1652       'index'  => [],
1653     },
1654
1655     'svc_phone' => {
1656       'columns' => [
1657         'svcnum',      'int',         '',      '', '', '',
1658         'countrycode', 'varchar',     '',       3, '', '',
1659         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1660         'pin',         'varchar', 'NULL', $char_d, '', '',
1661       ],
1662       'primary_key' => 'svcnum',
1663       'unique' => [],
1664       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1665     },
1666
1667     'reason_type' => {
1668       'columns' => [
1669         'typenum',   'serial',  '', '', '', '',
1670         'class',     'char', '', 1, '', '',
1671         'type',     'varchar', '', $char_d, '', '',
1672       ],
1673       'primary_key' => 'typenum',
1674       'unique' => [],
1675       'index' => [],
1676     },
1677
1678     'reason' => {
1679       'columns' => [
1680         'reasonnum',     'serial',  '', '', '', '',
1681         'reason_type',   'int',  '', '', '', '',
1682         'reason',        'varchar', '', $char_d, '', '',
1683         'disabled',      'char',    'NULL', 1, '', '',
1684       ],
1685       'primary_key' => 'reasonnum',
1686       'unique' => [],
1687       'index' => [],
1688     },
1689
1690     'conf' => {
1691       'columns' => [
1692         'confnum',  'serial',  '', '', '', '',
1693         'agentnum', 'int',  'NULL', '', '', '',
1694         'name',     'varchar', '', $char_d, '', '',
1695         'value',    'varchar', 'NULL', '', '', '',       # Pg specific
1696       ],
1697       'primary_key' => 'confnum',
1698       'unique' => [ [ 'agentnum', 'name' ]],
1699       'index' => [],
1700     },
1701
1702     # name type nullability length default local
1703
1704     #'new_table' => {
1705     #  'columns' => [
1706     #    'num', 'serial',       '', '', '', '',
1707     #  ],
1708     #  'primary_key' => 'num',
1709     #  'unique' => [],
1710     #  'index'  => [],
1711     #},
1712
1713   };
1714
1715 }
1716
1717 =back
1718
1719 =head1 BUGS
1720
1721 =head1 SEE ALSO
1722
1723 L<DBIx::DBSchema>
1724
1725 =cut
1726
1727 1;
1728