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_reason' => {
 658       'columns' => [
 659         'num',      'serial',    '',   '', '', '',
 660         'pkgnum',   'int',    '',   '', '', '',
 661         'reasonnum','int',    '',   '', '', '',
 662         'otaker',   'varchar', '', 32, '', '',
 663         'date',     @date_type, '', '',
 664       ],
 665       'primary_key' => 'num',
 666       'unique' => [],
 667       'index' => [],
 668     },
 669
 670     'cust_refund' => {
 671       'columns' => [
 672         'refundnum',    'serial',    '',   '', '', '',
 673         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 674         'custnum',  'int',    '',   '', '', '',
 675         '_date',        @date_type, '', '',
 676         'refund',       @money_type, '', '',
 677         'otaker',       'varchar',   '',   32, '', '',
 678         'reason',       'varchar',   '',   $char_d, '', '',
 679         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 680                                                      # be index into payby
 681                                                      # table eventually
 682         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
 683         'paymask', 'varchar', 'NULL', $char_d, '', '',
 684         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 685         'closed',    'char', 'NULL', 1, '', '',
 686       ],
 687       'primary_key' => 'refundnum',
 688       'unique' => [],
 689       'index' => [],
 690     },
 691
 692     'cust_credit_refund' => {
 693       'columns' => [
 694         'creditrefundnum', 'serial',     '',   '', '', '',
 695         'crednum',  'int',     '',   '', '', '',
 696         'refundnum',  'int',     '',   '', '', '',
 697         'amount',  @money_type, '', '',
 698         '_date',   @date_type, '', '',
 699       ],
 700       'primary_key' => 'creditrefundnum',
 701       'unique' => [],
 702       'index' => [ [ 'crednum', 'refundnum' ] ],
 703     },
 704
 705
 706     'cust_svc' => {
 707       'columns' => [
 708         'svcnum',    'serial',    '',   '', '', '',
 709         'pkgnum',    'int',    'NULL',   '', '', '',
 710         'svcpart',   'int',    '',   '', '', '',
 711       ],
 712       'primary_key' => 'svcnum',
 713       'unique' => [],
 714       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 715     },
 716
 717     'part_pkg' => {
 718       'columns' => [
 719         'pkgpart',    'serial',    '',   '', '', '',
 720         'pkg',        'varchar',   '',   $char_d, '', '',
 721         'comment',    'varchar',   '',   $char_d, '', '',
 722         'promo_code', 'varchar', 'NULL', $char_d, '', '',
 723         'setup',      @perl_type, '', '',
 724         'freq',       'varchar',   '',   $char_d, '', '', #billing frequency
 725         'recur',      @perl_type, '', '',
 726         'setuptax',  'char', 'NULL', 1, '', '',
 727         'recurtax',  'char', 'NULL', 1, '', '',
 728         'plan',       'varchar', 'NULL', $char_d, '', '',
 729         'plandata',   'text', 'NULL', '', '', '',
 730         'disabled',   'char', 'NULL', 1, '', '',
 731         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 732         'classnum',   'int',     'NULL', '', '', '',
 733       ],
 734       'primary_key' => 'pkgpart',
 735       'unique' => [],
 736       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 737     },
 738
 739 #    'part_title' => {
 740 #      'columns' => [
 741 #        'titlenum',   'int',    '',   '',
 742 #        'title',      'varchar',   '',   $char_d,
 743 #      ],
 744 #      'primary_key' => 'titlenum',
 745 #      'unique' => [ [] ],
 746 #      'index' => [ [] ],
 747 #    },
 748
 749     'pkg_svc' => {
 750       'columns' => [
 751         'pkgsvcnum',  'serial', '',  '', '', '',
 752         'pkgpart',    'int',    '',   '', '', '',
 753         'svcpart',    'int',    '',   '', '', '',
 754         'quantity',   'int',    '',   '', '', '',
 755         'primary_svc','char', 'NULL',  1, '', '',
 756       ],
 757       'primary_key' => 'pkgsvcnum',
 758       'unique' => [ ['pkgpart', 'svcpart'] ],
 759       'index' => [ ['pkgpart'] ],
 760     },
 761
 762     'part_referral' => {
 763       'columns' => [
 764         'refnum',   'serial',     '',        '', '', '',
 765         'referral', 'varchar',    '',   $char_d, '', '',
 766         'disabled', 'char',   'NULL',         1, '', '',
 767         'agentnum', 'int',    'NULL',        '', '', '',
 768       ],
 769       'primary_key' => 'refnum',
 770       'unique' => [],
 771       'index' => [ ['disabled'] ],
 772     },
 773
 774     'part_svc' => {
 775       'columns' => [
 776         'svcpart',    'serial',    '',   '', '', '',
 777         'svc',        'varchar',   '',   $char_d, '', '',
 778         'svcdb',      'varchar',   '',   $char_d, '', '',
 779         'disabled',   'char',  'NULL',   1, '', '',
 780       ],
 781       'primary_key' => 'svcpart',
 782       'unique' => [],
 783       'index' => [ [ 'disabled' ] ],
 784     },
 785
 786     'part_svc_column' => {
 787       'columns' => [
 788         'columnnum',   'serial',         '', '', '', '',
 789         'svcpart',     'int',         '', '', '', '',
 790         'columnname',  'varchar',     '', 64, '', '',
 791         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 792         'columnflag',  'char',    'NULL', 1, '', '',
 793       ],
 794       'primary_key' => 'columnnum',
 795       'unique' => [ [ 'svcpart', 'columnname' ] ],
 796       'index' => [ [ 'svcpart' ] ],
 797     },
 798
 799     #(this should be renamed to part_pop)
 800     'svc_acct_pop' => {
 801       'columns' => [
 802         'popnum',    'serial',    '',   '', '', '',
 803         'city',      'varchar',   '',   $char_d, '', '',
 804         'state',     'varchar',   '',   $char_d, '', '',
 805         'ac',        'char',   '',   3, '', '',
 806         'exch',      'char',   '',   3, '', '',
 807         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 808       ],
 809       'primary_key' => 'popnum',
 810       'unique' => [],
 811       'index' => [ [ 'state' ] ],
 812     },
 813
 814     'part_pop_local' => {
 815       'columns' => [
 816         'localnum',  'serial',     '',     '', '', '',
 817         'popnum',    'int',     '',     '', '', '',
 818         'city',      'varchar', 'NULL', $char_d, '', '',
 819         'state',     'char',    'NULL', 2, '', '',
 820         'npa',       'char',    '',     3, '', '',
 821         'nxx',       'char',    '',     3, '', '',
 822       ],
 823       'primary_key' => 'localnum',
 824       'unique' => [],
 825       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 826     },
 827
 828     'svc_acct' => {
 829       'columns' => [
 830         'svcnum',    'int',    '',   '', '', '',
 831         'username',  'varchar',   '',   $username_len, '', '', #unique (& remove dup code)
 832         '_password', 'varchar',   '',   72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
 833         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 834         'popnum',    'int',    'NULL',   '', '', '',
 835         'uid',       'int', 'NULL',   '', '', '',
 836         'gid',       'int', 'NULL',   '', '', '',
 837         'finger',    'varchar',   'NULL',   $char_d, '', '',
 838         'dir',       'varchar',   'NULL',   $char_d, '', '',
 839         'shell',     'varchar',   'NULL',   $char_d, '', '',
 840         'quota',     'varchar',   'NULL',   $char_d, '', '',
 841         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 842         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 843         'seconds_threshold',   'int', 'NULL',   '', '', '',
 844         'upbytes',   'int', 'NULL',   '', '', '',
 845         'upbytes_threshold',   'int', 'NULL',   '', '', '',
 846         'downbytes', 'int', 'NULL',   '', '', '',
 847         'downbytes_threshold',   'int', 'NULL',   '', '', '',
 848         'totalbytes','int', 'NULL',   '', '', '',
 849         'totalbytes_threshold',   'int', 'NULL',   '', '', '',
 850         'domsvc',    'int', '',   '', '', '',
 851       ],
 852       'primary_key' => 'svcnum',
 853       #'unique' => [ [ 'username', 'domsvc' ] ],
 854       'unique' => [],
 855       'index' => [ ['username'], ['domsvc'] ],
 856     },
 857
 858     #'svc_charge' => {
 859     #  'columns' => [
 860     #    'svcnum',    'int',    '',   '',
 861     #    'amount',    @money_type,
 862     #  ],
 863     #  'primary_key' => 'svcnum',
 864     #  'unique' => [ [] ],
 865     #  'index' => [ [] ],
 866     #},
 867
 868     'svc_domain' => {
 869       'columns' => [
 870         'svcnum',    'int',    '',   '', '', '',
 871         'domain',    'varchar',    '',   $char_d, '', '',
 872         'catchall',  'int', 'NULL',    '', '', '',
 873       ],
 874       'primary_key' => 'svcnum',
 875       'unique' => [ ['domain'] ],
 876       'index' => [],
 877     },
 878
 879     'domain_record' => {
 880       'columns' => [
 881         'recnum',    'serial',     '',  '', '', '',
 882         'svcnum',    'int',     '',  '', '', '',
 883         'reczone',   'varchar', '',  255, '', '',
 884         'recaf',     'char',    '',  2, '', '',
 885         'rectype',   'varchar',    '',  5, '', '',
 886         'recdata',   'varchar', '',  255, '', '',
 887       ],
 888       'primary_key' => 'recnum',
 889       'unique'      => [],
 890       'index'       => [ ['svcnum'] ],
 891     },
 892
 893     'svc_forward' => {
 894       'columns' => [
 895         'svcnum',   'int',            '',   '', '', '',
 896         'srcsvc',   'int',        'NULL',   '', '', '',
 897         'src',      'varchar',    'NULL',  255, '', '',
 898         'dstsvc',   'int',        'NULL',   '', '', '',
 899         'dst',      'varchar',    'NULL',  255, '', '',
 900       ],
 901       'primary_key' => 'svcnum',
 902       'unique'      => [],
 903       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 904     },
 905
 906     'svc_www' => {
 907       'columns' => [
 908         'svcnum',   'int',    '',  '', '', '',
 909         'recnum',   'int',    '',  '', '', '',
 910         'usersvc',  'int',    '',  '', '', '',
 911       ],
 912       'primary_key' => 'svcnum',
 913       'unique'      => [],
 914       'index'       => [],
 915     },
 916
 917     #'svc_wo' => {
 918     #  'columns' => [
 919     #    'svcnum',    'int',    '',   '',
 920     #    'svcnum',    'int',    '',   '',
 921     #    'svcnum',    'int',    '',   '',
 922     #    'worker',    'varchar',   '',   $char_d,
 923     #    '_date',     @date_type,
 924     #  ],
 925     #  'primary_key' => 'svcnum',
 926     #  'unique' => [ [] ],
 927     #  'index' => [ [] ],
 928     #},
 929
 930     'prepay_credit' => {
 931       'columns' => [
 932         'prepaynum',   'serial',     '',   '', '', '',
 933         'identifier',  'varchar', '', $char_d, '', '',
 934         'amount',      @money_type, '', '',
 935         'seconds',     'int',     'NULL', '', '', '',
 936         'upbytes',     'int',     'NULL', '', '', '',
 937         'downbytes',   'int',     'NULL', '', '', '',
 938         'totalbytes',  'int',     'NULL', '', '', '',
 939         'agentnum',    'int',     'NULL', '', '', '',
 940       ],
 941       'primary_key' => 'prepaynum',
 942       'unique'      => [ ['identifier'] ],
 943       'index'       => [],
 944     },
 945
 946     'port' => {
 947       'columns' => [
 948         'portnum',  'serial',     '',   '', '', '',
 949         'ip',       'varchar', 'NULL', 15, '', '',
 950         'nasport',  'int',     'NULL', '', '', '',
 951         'nasnum',   'int',     '',   '', '', '',
 952       ],
 953       'primary_key' => 'portnum',
 954       'unique'      => [],
 955       'index'       => [],
 956     },
 957
 958     'nas' => {
 959       'columns' => [
 960         'nasnum',   'serial',     '',    '', '', '',
 961         'nas',      'varchar', '',    $char_d, '', '',
 962         'nasip',    'varchar', '',    15, '', '',
 963         'nasfqdn',  'varchar', '',    $char_d, '', '',
 964         'last',     'int',     '',    '', '', '',
 965       ],
 966       'primary_key' => 'nasnum',
 967       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
 968       'index'       => [ [ 'last' ] ],
 969     },
 970
 971     'session' => {
 972       'columns' => [
 973         'sessionnum', 'serial',       '',   '', '', '',
 974         'portnum',    'int',       '',   '', '', '',
 975         'svcnum',     'int',       '',   '', '', '',
 976         'login',      @date_type, '', '',
 977         'logout',     @date_type, '', '',
 978       ],
 979       'primary_key' => 'sessionnum',
 980       'unique'      => [],
 981       'index'       => [ [ 'portnum' ] ],
 982     },
 983
 984     'queue' => {
 985       'columns' => [
 986         'jobnum', 'serial', '', '', '', '',
 987         'job', 'text', '', '', '', '',
 988         '_date', 'int', '', '', '', '',
 989         'status', 'varchar', '', $char_d, '', '',
 990         'statustext', 'text', 'NULL', '', '', '',
 991         'svcnum', 'int', 'NULL', '', '', '',
 992       ],
 993       'primary_key' => 'jobnum',
 994       'unique'      => [],
 995       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
 996     },
 997
 998     'queue_arg' => {
 999       'columns' => [
1000         'argnum', 'serial', '', '', '', '',
1001         'jobnum', 'int', '', '', '', '',
1002         'arg', 'text', 'NULL', '', '', '',
1003       ],
1004       'primary_key' => 'argnum',
1005       'unique'      => [],
1006       'index'       => [ [ 'jobnum' ] ],
1007     },
1008
1009     'queue_depend' => {
1010       'columns' => [
1011         'dependnum', 'serial', '', '', '', '',
1012         'jobnum', 'int', '', '', '', '',
1013         'depend_jobnum', 'int', '', '', '', '',
1014       ],
1015       'primary_key' => 'dependnum',
1016       'unique'      => [],
1017       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1018     },
1019
1020     'export_svc' => {
1021       'columns' => [
1022         'exportsvcnum' => 'serial', '', '', '', '',
1023         'exportnum'    => 'int', '', '', '', '',
1024         'svcpart'      => 'int', '', '', '', '',
1025       ],
1026       'primary_key' => 'exportsvcnum',
1027       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1028       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1029     },
1030
1031     'part_export' => {
1032       'columns' => [
1033         'exportnum', 'serial', '', '', '', '',
1034         'machine', 'varchar', '', $char_d, '', '',
1035         'exporttype', 'varchar', '', $char_d, '', '',
1036         'nodomain',     'char', 'NULL', 1, '', '',
1037       ],
1038       'primary_key' => 'exportnum',
1039       'unique'      => [],
1040       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1041     },
1042
1043     'part_export_option' => {
1044       'columns' => [
1045         'optionnum', 'serial', '', '', '', '',
1046         'exportnum', 'int', '', '', '', '',
1047         'optionname', 'varchar', '', $char_d, '', '',
1048         'optionvalue', 'text', 'NULL', '', '', '',
1049       ],
1050       'primary_key' => 'optionnum',
1051       'unique'      => [],
1052       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1053     },
1054
1055     'radius_usergroup' => {
1056       'columns' => [
1057         'usergroupnum', 'serial', '', '', '', '',
1058         'svcnum',       'int', '', '', '', '',
1059         'groupname',    'varchar', '', $char_d, '', '',
1060       ],
1061       'primary_key' => 'usergroupnum',
1062       'unique'      => [],
1063       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1064     },
1065
1066     'msgcat' => {
1067       'columns' => [
1068         'msgnum', 'serial', '', '', '', '',
1069         'msgcode', 'varchar', '', $char_d, '', '',
1070         'locale', 'varchar', '', 16, '', '',
1071         'msg', 'text', '', '', '', '',
1072       ],
1073       'primary_key' => 'msgnum',
1074       'unique'      => [ [ 'msgcode', 'locale' ] ],
1075       'index'       => [],
1076     },
1077
1078     'cust_tax_exempt' => {
1079       'columns' => [
1080         'exemptnum', 'serial', '', '', '', '',
1081         'custnum',   'int', '', '', '', '',
1082         'taxnum',    'int', '', '', '', '',
1083         'year',      'int', '', '', '', '',
1084         'month',     'int', '', '', '', '',
1085         'amount',   @money_type, '', '',
1086       ],
1087       'primary_key' => 'exemptnum',
1088       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1089       'index'       => [],
1090     },
1091
1092     'cust_tax_exempt_pkg' => {
1093       'columns' => [
1094         'exemptpkgnum',  'serial', '', '', '', '',
1095         #'custnum',      'int', '', '', '', ''
1096         'billpkgnum',   'int', '', '', '', '',
1097         'taxnum',       'int', '', '', '', '',
1098         'year',         'int', '', '', '', '',
1099         'month',        'int', '', '', '', '',
1100         'amount',       @money_type, '', '',
1101       ],
1102       'primary_key' => 'exemptpkgnum',
1103       'unique' => [],
1104       'index'  => [ [ 'taxnum', 'year', 'month' ],
1105                     [ 'billpkgnum' ],
1106                     [ 'taxnum' ]
1107                   ],
1108     },
1109
1110     'router' => {
1111       'columns' => [
1112         'routernum', 'serial', '', '', '', '',
1113         'routername', 'varchar', '', $char_d, '', '',
1114         'svcnum', 'int', 'NULL', '', '', '',
1115       ],
1116       'primary_key' => 'routernum',
1117       'unique'      => [],
1118       'index'       => [],
1119     },
1120
1121     'part_svc_router' => {
1122       'columns' => [
1123         'svcrouternum', 'serial', '', '', '', '',
1124         'svcpart', 'int', '', '', '', '',
1125         'routernum', 'int', '', '', '', '',
1126       ],
1127       'primary_key' => 'svcrouternum',
1128       'unique'      => [],
1129       'index'       => [],
1130     },
1131
1132     'addr_block' => {
1133       'columns' => [
1134         'blocknum', 'serial', '', '', '', '',
1135         'routernum', 'int', '', '', '', '',
1136         'ip_gateway', 'varchar', '', 15, '', '',
1137         'ip_netmask', 'int', '', '', '', '',
1138       ],
1139       'primary_key' => 'blocknum',
1140       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1141       'index'       => [],
1142     },
1143
1144     'svc_broadband' => {
1145       'columns' => [
1146         'svcnum', 'int', '', '', '', '',
1147         'blocknum', 'int', '', '', '', '',
1148         'speed_up', 'int', '', '', '', '',
1149         'speed_down', 'int', '', '', '', '',
1150         'ip_addr', 'varchar', '', 15, '', '',
1151         'mac_addr', 'varchar', 'NULL', 12, '', '',
1152         'authkey',  'varchar', 'NULL', 32, '', '',
1153         'latitude', 'decimal', 'NULL', '', '', '',
1154         'longitude', 'decimal', 'NULL', '', '', '',
1155         'altitude', 'decimal', 'NULL', '', '', '',
1156         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1157       ],
1158       'primary_key' => 'svcnum',
1159       'unique'      => [],
1160       'index'       => [],
1161     },
1162
1163     'part_virtual_field' => {
1164       'columns' => [
1165         'vfieldpart', 'int', '', '', '', '',
1166         'dbtable', 'varchar', '', 32, '', '',
1167         'name', 'varchar', '', 32, '', '',
1168         'check_block', 'text', 'NULL', '', '', '',
1169         'length', 'int', 'NULL', '', '', '',
1170         'list_source', 'text', 'NULL', '', '', '',
1171         'label', 'varchar', 'NULL', 80, '', '',
1172       ],
1173       'primary_key' => 'vfieldpart',
1174       'unique' => [],
1175       'index' => [],
1176     },
1177
1178     'virtual_field' => {
1179       'columns' => [
1180         'vfieldnum', 'serial', '', '', '', '',
1181         'recnum', 'int', '', '', '', '',
1182         'vfieldpart', 'int', '', '', '', '',
1183         'value', 'varchar', '', 128, '', '',
1184       ],
1185       'primary_key' => 'vfieldnum',
1186       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1187       'index' => [],
1188     },
1189
1190     'acct_snarf' => {
1191       'columns' => [
1192         'snarfnum',  'int', '', '', '', '',
1193         'svcnum',    'int', '', '', '', '',
1194         'machine',   'varchar', '', 255, '', '',
1195         'protocol',  'varchar', '', $char_d, '', '',
1196         'username',  'varchar', '', $char_d, '', '',
1197         '_password', 'varchar', '', $char_d, '', '',
1198       ],
1199       'primary_key' => 'snarfnum',
1200       'unique' => [],
1201       'index'  => [ [ 'svcnum' ] ],
1202     },
1203
1204     'svc_external' => {
1205       'columns' => [
1206         'svcnum', 'int', '', '', '', '',
1207         'id',     'int', 'NULL', '', '', '',
1208         'title',  'varchar', 'NULL', $char_d, '', '',
1209       ],
1210       'primary_key' => 'svcnum',
1211       'unique'      => [],
1212       'index'       => [],
1213     },
1214
1215     'cust_pay_refund' => {
1216       'columns' => [
1217         'payrefundnum', 'serial', '', '', '', '',
1218         'paynum',  'int', '', '', '', '',
1219         'refundnum',  'int', '', '', '', '',
1220         '_date',    @date_type, '', '',
1221         'amount',   @money_type, '', '',
1222       ],
1223       'primary_key' => 'payrefundnum',
1224       'unique' => [],
1225       'index' => [ ['paynum'], ['refundnum'] ],
1226     },
1227
1228     'part_pkg_option' => {
1229       'columns' => [
1230         'optionnum', 'serial', '', '', '', '',
1231         'pkgpart', 'int', '', '', '', '',
1232         'optionname', 'varchar', '', $char_d, '', '',
1233         'optionvalue', 'text', 'NULL', '', '', '',
1234       ],
1235       'primary_key' => 'optionnum',
1236       'unique'      => [],
1237       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1238     },
1239
1240     'rate' => {
1241       'columns' => [
1242         'ratenum',  'serial', '', '', '', '',
1243         'ratename', 'varchar', '', $char_d, '', '',
1244       ],
1245       'primary_key' => 'ratenum',
1246       'unique'      => [],
1247       'index'       => [],
1248     },
1249
1250     'rate_detail' => {
1251       'columns' => [
1252         'ratedetailnum',   'serial', '', '', '', '',
1253         'ratenum',         'int',     '', '', '', '',
1254         'orig_regionnum',  'int', 'NULL', '', '', '',
1255         'dest_regionnum',  'int',     '', '', '', '',
1256         'min_included',    'int',     '', '', '', '',
1257         #'min_charge',      @money_type, '', '',
1258         'min_charge',      'decimal', '', '10,5', '', '',
1259         'sec_granularity', 'int',     '', '', '', '',
1260         #time period (link to table of periods)?
1261       ],
1262       'primary_key' => 'ratedetailnum',
1263       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1264       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1265     },
1266
1267     'rate_region' => {
1268       'columns' => [
1269         'regionnum',   'serial',      '', '', '', '',
1270         'regionname',  'varchar',     '', $char_d, '', '',
1271       ],
1272       'primary_key' => 'regionnum',
1273       'unique'      => [],
1274       'index'       => [],
1275     },
1276
1277     'rate_prefix' => {
1278       'columns' => [
1279         'prefixnum',   'serial',    '', '', '', '',
1280         'regionnum',   'int',       '', '',, '', '',
1281         'countrycode', 'varchar',     '', 3, '', '',
1282         'npa',         'varchar', 'NULL', 6, '', '',
1283         'nxx',         'varchar', 'NULL', 3, '', '',
1284       ],
1285       'primary_key' => 'prefixnum',
1286       'unique'      => [],
1287       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1288     },
1289
1290     'reg_code' => {
1291       'columns' => [
1292         'codenum',   'serial',    '', '', '', '',
1293         'code',      'varchar',   '', $char_d, '', '',
1294         'agentnum',  'int',       '', '', '', '',
1295       ],
1296       'primary_key' => 'codenum',
1297       'unique'      => [ [ 'agentnum', 'code' ] ],
1298       'index'       => [ [ 'agentnum' ] ],
1299     },
1300
1301     'reg_code_pkg' => {
1302       'columns' => [
1303         'codepkgnum', 'serial', '', '', '', '',
1304         'codenum',   'int',    '', '', '', '',
1305         'pkgpart',   'int',    '', '', '', '',
1306       ],
1307       'primary_key' => 'codepkgnum',
1308       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1309       'index'       => [ [ 'codenum' ] ],
1310     },
1311
1312     'clientapi_session' => {
1313       'columns' => [
1314         'sessionnum',  'serial',  '', '', '', '',
1315         'sessionid',  'varchar',  '', $char_d, '', '',
1316         'namespace',  'varchar',  '', $char_d, '', '',
1317       ],
1318       'primary_key' => 'sessionnum',
1319       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1320       'index'       => [],
1321     },
1322
1323     'clientapi_session_field' => {
1324       'columns' => [
1325         'fieldnum',    'serial',     '', '', '', '',
1326         'sessionnum',     'int',     '', '', '', '',
1327         'fieldname',  'varchar',     '', $char_d, '', '',
1328         'fieldvalue',    'text', 'NULL', '', '', '',
1329       ],
1330       'primary_key' => 'fieldnum',
1331       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1332       'index'       => [],
1333     },
1334
1335     'payment_gateway' => {
1336       'columns' => [
1337         'gatewaynum',       'serial',   '',     '', '', '',
1338         'gateway_module',   'varchar',  '',     $char_d, '', '',
1339         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1340         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1341         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1342         'disabled',   'char',  'NULL',   1, '', '',
1343       ],
1344       'primary_key' => 'gatewaynum',
1345       'unique' => [],
1346       'index'  => [ [ 'disabled' ] ],
1347     },
1348
1349     'payment_gateway_option' => {
1350       'columns' => [
1351         'optionnum',   'serial',  '',     '', '', '',
1352         'gatewaynum',  'int',     '',     '', '', '',
1353         'optionname',  'varchar', '',     $char_d, '', '',
1354         'optionvalue', 'text',    'NULL', '', '', '',
1355       ],
1356       'primary_key' => 'optionnum',
1357       'unique'      => [],
1358       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1359     },
1360
1361     'agent_payment_gateway' => {
1362       'columns' => [
1363         'agentgatewaynum', 'serial', '', '', '', '',
1364         'agentnum',        'int', '', '', '', '',
1365         'gatewaynum',      'int', '', '', '', '',
1366         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1367         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1368       ],
1369       'primary_key' => 'agentgatewaynum',
1370       'unique'      => [],
1371       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1372     },
1373
1374     'banned_pay' => {
1375       'columns' => [
1376         'bannum',  'serial',   '',     '', '', '',
1377         'payby',   'char',     '',       4, '', '',
1378         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1379         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1380         '_date',   @date_type, '', '',
1381         'otaker',  'varchar',  '',     32, '', '',
1382         'reason',  'varchar',  'NULL', $char_d, '', '',
1383       ],
1384       'primary_key' => 'bannum',
1385       'unique'      => [ [ 'payby', 'payinfo' ] ],
1386       'index'       => [],
1387     },
1388
1389     'pkg_class' => {
1390       'columns' => [
1391         'classnum',   'serial',  '', '', '', '',
1392         'classname',  'varchar', '', $char_d, '', '',
1393         'disabled',     'char', 'NULL',   1, '', '',
1394       ],
1395       'primary_key' => 'classnum',
1396       'unique' => [],
1397       'index' => [ ['disabled'] ],
1398     },
1399
1400     'cdr' => {
1401       'columns' => [
1402         # qw( name type null length default local );
1403
1404         ###
1405         #asterisk fields
1406         ###
1407
1408         'acctid',   'bigserial',  '', '', '', '',
1409         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1410         'clid',        'varchar',  '', $char_d, \"''", '',
1411         'src',         'varchar',  '', $char_d, \"''", '',
1412         'dst',         'varchar',  '', $char_d, \"''", '',
1413         'dcontext',    'varchar',  '', $char_d, \"''", '',
1414         'channel',     'varchar',  '', $char_d, \"''", '',
1415         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1416         'lastapp',     'varchar',  '', $char_d, \"''", '',
1417         'lastdata',    'varchar',  '', $char_d, \"''", '',
1418
1419         #these don't seem to be logged by most of the SQL cdr_* modules
1420         #except tds under sql-illegal names, so;
1421         # ... don't rely on them for rating?
1422         # and, what they hey, i went ahead and changed the names and data types
1423         # to freeside-style dates...
1424           #'start',  'timestamp', 'NULL',  '',    '', '',
1425           #'answer', 'timestamp', 'NULL',  '',    '', '',
1426           #'end',    'timestamp', 'NULL',  '',    '', '',
1427         'startdate',  @date_type, '', '',
1428         'answerdate', @date_type, '', '',
1429         'enddate',    @date_type, '', '',
1430         #
1431
1432         'duration',    'int',      '',      '',     0, '',
1433         'billsec',     'int',      '',      '',     0, '',
1434         'disposition', 'varchar',  '',      45, \"''", '',
1435         'amaflags',    'int',      '',      '',     0, '',
1436         'accountcode', 'varchar',  '',      20, \"''", '',
1437         'uniqueid',    'varchar',  '',      32, \"''", '',
1438         'userfield',   'varchar',  '',     255, \"''", '',
1439
1440         ###
1441         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1442         # defaults
1443         ###
1444
1445         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1446         'cdrtypenum',              'int', 'NULL',      '', '', '',
1447
1448         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1449
1450         'upstream_currency',      'char', 'NULL',       3, '', '',
1451         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1452         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1453
1454         # how it was rated internally...
1455         'ratedetailnum',           'int', 'NULL',      '', '', '',
1456         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1457
1458         'distance',            'decimal', 'NULL',      '', '', '',
1459         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1460
1461         #cdr_calltype: the big list in appendix 2
1462         'calltypenum',             'int', 'NULL',      '', '', '',
1463
1464         'description',         'varchar', 'NULL', $char_d, '', '',
1465         'quantity',                'int', 'NULL',      '', '', '',
1466
1467         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1468         'carrierid',               'int', 'NULL',      '', '', '',
1469
1470         'upstream_rateid',         'int', 'NULL',      '', '', '',
1471
1472         ###
1473         #and now for our own fields
1474         ###
1475
1476         # a svcnum... right..?
1477         'svcnum',             'int',   'NULL',     '',   '', '',
1478
1479         #NULL, done (or something)
1480         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1481
1482       ],
1483       'primary_key' => 'acctid',
1484       'unique' => [],
1485       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1486     },
1487
1488     'cdr_calltype' => {
1489       'columns' => [
1490         'calltypenum',   'serial',  '', '', '', '',
1491         'calltypename',  'varchar', '', $char_d, '', '',
1492       ],
1493       'primary_key' => 'calltypenum',
1494       'unique'      => [],
1495       'index'       => [],
1496     },
1497
1498     'cdr_type' => {
1499       'columns' => [
1500         'cdrtypenum'  => 'serial',  '', '', '', '',
1501         'cdrtypename' => 'varchar', '', '', '', '',
1502       ],
1503       'primary_key' => 'cdrtypenum',
1504       'unique'      => [],
1505       'index'       => [],
1506     },
1507
1508     'cdr_carrier' => {
1509       'columns' => [
1510         'carrierid'   => 'serial',  '', '', '', '',
1511         'carriername' => 'varchar', '', '', '', '',
1512       ],
1513       'primary_key' => 'carrierid',
1514       'unique'      => [],
1515       'index'       => [],
1516     },
1517
1518     #map upstream rateid to ours...
1519     'cdr_upstream_rate' => {
1520       'columns' => [
1521         'upstreamratenum', 'serial',  '', '', '', '',
1522         'upstream_rateid', 'varchar', '', $char_d, '', '',
1523         'ratedetailnum',   'int', 'NULL', '', '', '',
1524       ],
1525       'primary_key' => 'upstreamratenum', #XXX need a primary key
1526       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1527       'index'  => [],
1528     },
1529
1530     'inventory_item' => {
1531       'columns' => [
1532         'itemnum',  'serial',      '',      '', '', '',
1533         'classnum', 'int',         '',      '', '', '',
1534         'item',     'varchar',     '', $char_d, '', '',
1535         'svcnum',   'int',     'NULL',      '', '', '',
1536       ],
1537       'primary_key' => 'itemnum',
1538       'unique' => [ [ 'classnum', 'item' ] ],
1539       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1540     },
1541
1542     'inventory_class' => {
1543       'columns' => [
1544         'classnum',  'serial',       '',      '', '', '',
1545         'classname', 'varchar',      '', $char_d, '', '',
1546       ],
1547       'primary_key' => 'classnum',
1548       'unique' => [],
1549       'index'  => [],
1550     },
1551
1552     'access_user' => {
1553       'columns' => [
1554         'usernum',   'serial',  '',      '', '', '',
1555         'username',  'varchar', '', $char_d, '', '',
1556         '_password', 'varchar', '', $char_d, '', '',
1557         'last',      'varchar', '', $char_d, '', '',
1558         'first',     'varchar', '', $char_d, '', '',
1559         'disabled',     'char', 'NULL',   1, '', '',
1560       ],
1561       'primary_key' => 'usernum',
1562       'unique' => [ [ 'username' ] ],
1563       'index'  => [],
1564     },
1565
1566     'access_user_pref' => {
1567       'columns' => [
1568         'prefnum',    'serial',       '', '', '', '',
1569         'usernum',     'int',       '', '', '', '',
1570         'prefname', 'varchar', '', $char_d, '', '',
1571         'prefvalue', 'text', 'NULL', '', '', '',
1572       ],
1573       'primary_key' => 'prefnum',
1574       'unique' => [],
1575       'index'  => [ [ 'usernum' ] ],
1576     },
1577
1578     'access_group' => {
1579       'columns' => [
1580         'groupnum',   'serial', '',      '', '', '',
1581         'groupname', 'varchar', '', $char_d, '', '',
1582       ],
1583       'primary_key' => 'groupnum',
1584       'unique' => [ [ 'groupname' ] ],
1585       'index'  => [],
1586     },
1587
1588     'access_usergroup' => {
1589       'columns' => [
1590         'usergroupnum', 'serial', '', '', '', '',
1591         'usernum',         'int', '', '', '', '',
1592         'groupnum',        'int', '', '', '', '',
1593       ],
1594       'primary_key' => 'usergroupnum',
1595       'unique' => [ [ 'usernum', 'groupnum' ] ],
1596       'index'  => [ [ 'usernum' ] ],
1597     },
1598
1599     'access_groupagent' => {
1600       'columns' => [
1601         'groupagentnum', 'serial', '', '', '', '',
1602         'groupnum',         'int', '', '', '', '',
1603         'agentnum',         'int', '', '', '', '',
1604       ],
1605       'primary_key' => 'groupagentnum',
1606       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1607       'index'  => [ [ 'groupnum' ] ],
1608     },
1609
1610     'access_right' => {
1611       'columns' => [
1612         'rightnum',   'serial', '',      '', '', '',
1613         'righttype', 'varchar', '', $char_d, '', '',
1614         'rightobjnum',   'int', '',      '', '', '',
1615         'rightname', 'varchar', '',      '', '', '',
1616       ],
1617       'primary_key' => 'rightnum',
1618       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1619       'index'  => [],
1620     },
1621
1622     'svc_phone' => {
1623       'columns' => [
1624         'svcnum',      'int',         '',      '', '', '',
1625         'countrycode', 'varchar',     '',       3, '', '',
1626         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1627         'pin',         'varchar', 'NULL', $char_d, '', '',
1628       ],
1629       'primary_key' => 'svcnum',
1630       'unique' => [],
1631       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1632     },
1633
1634     'reason_type' => {
1635       'columns' => [
1636         'typenum',   'serial',  '', '', '', '',
1637         'class',     'char', '', 1, '', '',
1638         'type',     'varchar', '', $char_d, '', '',
1639       ],
1640       'primary_key' => 'typenum',
1641       'unique' => [],
1642       'index' => [],
1643     },
1644
1645     'reason' => {
1646       'columns' => [
1647         'reasonnum',     'serial',  '', '', '', '',
1648         'reason_type',   'int',  '', '', '', '',
1649         'reason',        'varchar', '', $char_d, '', '',
1650         'disabled',      'char',    'NULL', 1, '', '',
1651       ],
1652       'primary_key' => 'reasonnum',
1653       'unique' => [],
1654       'index' => [],
1655     },
1656
1657     # name type nullability length default local
1658
1659     #'new_table' => {
1660     #  'columns' => [
1661     #    'num', 'serial',       '', '', '', '',
1662     #  ],
1663     #  'primary_key' => 'num',
1664     #  'unique' => [],
1665     #  'index'  => [],
1666     #},
1667
1668   };
1669
1670 }
1671
1672 =back
1673
1674 =head1 BUGS
1675
1676 =head1 SEE ALSO
1677
1678 L<DBIx::DBSchema>
1679
1680 =cut
1681
1682 1;
1683