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         'config',   'text',   'NULL',  '', '', '',
 944       ],
 945       'primary_key' => 'svcnum',
 946       'unique'      => [],
 947       'index'       => [],
 948     },
 949
 950     #'svc_wo' => {
 951     #  'columns' => [
 952     #    'svcnum',    'int',    '',   '',
 953     #    'svcnum',    'int',    '',   '',
 954     #    'svcnum',    'int',    '',   '',
 955     #    'worker',    'varchar',   '',   $char_d,
 956     #    '_date',     @date_type,
 957     #  ],
 958     #  'primary_key' => 'svcnum',
 959     #  'unique' => [ [] ],
 960     #  'index' => [ [] ],
 961     #},
 962
 963     'prepay_credit' => {
 964       'columns' => [
 965         'prepaynum',   'serial',     '',   '', '', '',
 966         'identifier',  'varchar', '', $char_d, '', '',
 967         'amount',      @money_type, '', '',
 968         'seconds',     'int',     'NULL', '', '', '',
 969         'upbytes',     'bigint',     'NULL', '', '', '',
 970         'downbytes',   'bigint',     'NULL', '', '', '',
 971         'totalbytes',  'bigint',     'NULL', '', '', '',
 972         'agentnum',    'int',     'NULL', '', '', '',
 973       ],
 974       'primary_key' => 'prepaynum',
 975       'unique'      => [ ['identifier'] ],
 976       'index'       => [],
 977     },
 978
 979     'port' => {
 980       'columns' => [
 981         'portnum',  'serial',     '',   '', '', '',
 982         'ip',       'varchar', 'NULL', 15, '', '',
 983         'nasport',  'int',     'NULL', '', '', '',
 984         'nasnum',   'int',     '',   '', '', '',
 985       ],
 986       'primary_key' => 'portnum',
 987       'unique'      => [],
 988       'index'       => [],
 989     },
 990
 991     'nas' => {
 992       'columns' => [
 993         'nasnum',   'serial',     '',    '', '', '',
 994         'nas',      'varchar', '',    $char_d, '', '',
 995         'nasip',    'varchar', '',    15, '', '',
 996         'nasfqdn',  'varchar', '',    $char_d, '', '',
 997         'last',     'int',     '',    '', '', '',
 998       ],
 999       'primary_key' => 'nasnum',
1000       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1001       'index'       => [ [ 'last' ] ],
1002     },
1003
1004     'session' => {
1005       'columns' => [
1006         'sessionnum', 'serial',       '',   '', '', '',
1007         'portnum',    'int',       '',   '', '', '',
1008         'svcnum',     'int',       '',   '', '', '',
1009         'login',      @date_type, '', '',
1010         'logout',     @date_type, '', '',
1011       ],
1012       'primary_key' => 'sessionnum',
1013       'unique'      => [],
1014       'index'       => [ [ 'portnum' ] ],
1015     },
1016
1017     'queue' => {
1018       'columns' => [
1019         'jobnum', 'serial', '', '', '', '',
1020         'job', 'text', '', '', '', '',
1021         '_date', 'int', '', '', '', '',
1022         'status', 'varchar', '', $char_d, '', '',
1023         'statustext', 'text', 'NULL', '', '', '',
1024         'svcnum', 'int', 'NULL', '', '', '',
1025       ],
1026       'primary_key' => 'jobnum',
1027       'unique'      => [],
1028       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
1029     },
1030
1031     'queue_arg' => {
1032       'columns' => [
1033         'argnum', 'serial', '', '', '', '',
1034         'jobnum', 'int', '', '', '', '',
1035         'arg', 'text', 'NULL', '', '', '',
1036       ],
1037       'primary_key' => 'argnum',
1038       'unique'      => [],
1039       'index'       => [ [ 'jobnum' ] ],
1040     },
1041
1042     'queue_depend' => {
1043       'columns' => [
1044         'dependnum', 'serial', '', '', '', '',
1045         'jobnum', 'int', '', '', '', '',
1046         'depend_jobnum', 'int', '', '', '', '',
1047       ],
1048       'primary_key' => 'dependnum',
1049       'unique'      => [],
1050       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1051     },
1052
1053     'export_svc' => {
1054       'columns' => [
1055         'exportsvcnum' => 'serial', '', '', '', '',
1056         'exportnum'    => 'int', '', '', '', '',
1057         'svcpart'      => 'int', '', '', '', '',
1058       ],
1059       'primary_key' => 'exportsvcnum',
1060       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1061       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1062     },
1063
1064     'part_export' => {
1065       'columns' => [
1066         'exportnum', 'serial', '', '', '', '',
1067         'machine', 'varchar', '', $char_d, '', '',
1068         'exporttype', 'varchar', '', $char_d, '', '',
1069         'nodomain',     'char', 'NULL', 1, '', '',
1070       ],
1071       'primary_key' => 'exportnum',
1072       'unique'      => [],
1073       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1074     },
1075
1076     'part_export_option' => {
1077       'columns' => [
1078         'optionnum', 'serial', '', '', '', '',
1079         'exportnum', 'int', '', '', '', '',
1080         'optionname', 'varchar', '', $char_d, '', '',
1081         'optionvalue', 'text', 'NULL', '', '', '',
1082       ],
1083       'primary_key' => 'optionnum',
1084       'unique'      => [],
1085       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1086     },
1087
1088     'radius_usergroup' => {
1089       'columns' => [
1090         'usergroupnum', 'serial', '', '', '', '',
1091         'svcnum',       'int', '', '', '', '',
1092         'groupname',    'varchar', '', $char_d, '', '',
1093       ],
1094       'primary_key' => 'usergroupnum',
1095       'unique'      => [],
1096       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1097     },
1098
1099     'msgcat' => {
1100       'columns' => [
1101         'msgnum', 'serial', '', '', '', '',
1102         'msgcode', 'varchar', '', $char_d, '', '',
1103         'locale', 'varchar', '', 16, '', '',
1104         'msg', 'text', '', '', '', '',
1105       ],
1106       'primary_key' => 'msgnum',
1107       'unique'      => [ [ 'msgcode', 'locale' ] ],
1108       'index'       => [],
1109     },
1110
1111     'cust_tax_exempt' => {
1112       'columns' => [
1113         'exemptnum', 'serial', '', '', '', '',
1114         'custnum',   'int', '', '', '', '',
1115         'taxnum',    'int', '', '', '', '',
1116         'year',      'int', '', '', '', '',
1117         'month',     'int', '', '', '', '',
1118         'amount',   @money_type, '', '',
1119       ],
1120       'primary_key' => 'exemptnum',
1121       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1122       'index'       => [],
1123     },
1124
1125     'cust_tax_exempt_pkg' => {
1126       'columns' => [
1127         'exemptpkgnum',  'serial', '', '', '', '',
1128         #'custnum',      'int', '', '', '', ''
1129         'billpkgnum',   'int', '', '', '', '',
1130         'taxnum',       'int', '', '', '', '',
1131         'year',         'int', '', '', '', '',
1132         'month',        'int', '', '', '', '',
1133         'amount',       @money_type, '', '',
1134       ],
1135       'primary_key' => 'exemptpkgnum',
1136       'unique' => [],
1137       'index'  => [ [ 'taxnum', 'year', 'month' ],
1138                     [ 'billpkgnum' ],
1139                     [ 'taxnum' ]
1140                   ],
1141     },
1142
1143     'router' => {
1144       'columns' => [
1145         'routernum', 'serial', '', '', '', '',
1146         'routername', 'varchar', '', $char_d, '', '',
1147         'svcnum', 'int', 'NULL', '', '', '',
1148       ],
1149       'primary_key' => 'routernum',
1150       'unique'      => [],
1151       'index'       => [],
1152     },
1153
1154     'part_svc_router' => {
1155       'columns' => [
1156         'svcrouternum', 'serial', '', '', '', '',
1157         'svcpart', 'int', '', '', '', '',
1158         'routernum', 'int', '', '', '', '',
1159       ],
1160       'primary_key' => 'svcrouternum',
1161       'unique'      => [],
1162       'index'       => [],
1163     },
1164
1165     'addr_block' => {
1166       'columns' => [
1167         'blocknum', 'serial', '', '', '', '',
1168         'routernum', 'int', '', '', '', '',
1169         'ip_gateway', 'varchar', '', 15, '', '',
1170         'ip_netmask', 'int', '', '', '', '',
1171       ],
1172       'primary_key' => 'blocknum',
1173       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1174       'index'       => [],
1175     },
1176
1177     'svc_broadband' => {
1178       'columns' => [
1179         'svcnum', 'int', '', '', '', '',
1180         'description', 'varchar', 'NULL', $char_d, '', '',
1181         'blocknum', 'int', '', '', '', '',
1182         'speed_up', 'int', '', '', '', '',
1183         'speed_down', 'int', '', '', '', '',
1184         'ip_addr', 'varchar', '', 15, '', '',
1185         'mac_addr', 'varchar', 'NULL', 12, '', '',
1186         'authkey',  'varchar', 'NULL', 32, '', '',
1187         'latitude', 'decimal', 'NULL', '', '', '',
1188         'longitude', 'decimal', 'NULL', '', '', '',
1189         'altitude', 'decimal', 'NULL', '', '', '',
1190         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1191       ],
1192       'primary_key' => 'svcnum',
1193       'unique'      => [],
1194       'index'       => [],
1195     },
1196
1197     'part_virtual_field' => {
1198       'columns' => [
1199         'vfieldpart', 'serial', '', '', '', '',
1200         'dbtable', 'varchar', '', 32, '', '',
1201         'name', 'varchar', '', 32, '', '',
1202         'check_block', 'text', 'NULL', '', '', '',
1203         'length', 'int', 'NULL', '', '', '',
1204         'list_source', 'text', 'NULL', '', '', '',
1205         'label', 'varchar', 'NULL', 80, '', '',
1206       ],
1207       'primary_key' => 'vfieldpart',
1208       'unique' => [],
1209       'index' => [],
1210     },
1211
1212     'virtual_field' => {
1213       'columns' => [
1214         'vfieldnum', 'serial', '', '', '', '',
1215         'recnum', 'int', '', '', '', '',
1216         'vfieldpart', 'int', '', '', '', '',
1217         'value', 'varchar', '', 128, '', '',
1218       ],
1219       'primary_key' => 'vfieldnum',
1220       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1221       'index' => [],
1222     },
1223
1224     'acct_snarf' => {
1225       'columns' => [
1226         'snarfnum',  'int', '', '', '', '',
1227         'svcnum',    'int', '', '', '', '',
1228         'machine',   'varchar', '', 255, '', '',
1229         'protocol',  'varchar', '', $char_d, '', '',
1230         'username',  'varchar', '', $char_d, '', '',
1231         '_password', 'varchar', '', $char_d, '', '',
1232       ],
1233       'primary_key' => 'snarfnum',
1234       'unique' => [],
1235       'index'  => [ [ 'svcnum' ] ],
1236     },
1237
1238     'svc_external' => {
1239       'columns' => [
1240         'svcnum', 'int', '', '', '', '',
1241         'id',     'int', 'NULL', '', '', '',
1242         'title',  'varchar', 'NULL', $char_d, '', '',
1243       ],
1244       'primary_key' => 'svcnum',
1245       'unique'      => [],
1246       'index'       => [],
1247     },
1248
1249     'cust_pay_refund' => {
1250       'columns' => [
1251         'payrefundnum', 'serial', '', '', '', '',
1252         'paynum',  'int', '', '', '', '',
1253         'refundnum',  'int', '', '', '', '',
1254         '_date',    @date_type, '', '',
1255         'amount',   @money_type, '', '',
1256       ],
1257       'primary_key' => 'payrefundnum',
1258       'unique' => [],
1259       'index' => [ ['paynum'], ['refundnum'] ],
1260     },
1261
1262     'part_pkg_option' => {
1263       'columns' => [
1264         'optionnum', 'serial', '', '', '', '',
1265         'pkgpart', 'int', '', '', '', '',
1266         'optionname', 'varchar', '', $char_d, '', '',
1267         'optionvalue', 'text', 'NULL', '', '', '',
1268       ],
1269       'primary_key' => 'optionnum',
1270       'unique'      => [],
1271       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1272     },
1273
1274     'rate' => {
1275       'columns' => [
1276         'ratenum',  'serial', '', '', '', '',
1277         'ratename', 'varchar', '', $char_d, '', '',
1278       ],
1279       'primary_key' => 'ratenum',
1280       'unique'      => [],
1281       'index'       => [],
1282     },
1283
1284     'rate_detail' => {
1285       'columns' => [
1286         'ratedetailnum',   'serial', '', '', '', '',
1287         'ratenum',         'int',     '', '', '', '',
1288         'orig_regionnum',  'int', 'NULL', '', '', '',
1289         'dest_regionnum',  'int',     '', '', '', '',
1290         'min_included',    'int',     '', '', '', '',
1291         #'min_charge',      @money_type, '', '',
1292         'min_charge',      'decimal', '', '10,5', '', '',
1293         'sec_granularity', 'int',     '', '', '', '',
1294         #time period (link to table of periods)?
1295       ],
1296       'primary_key' => 'ratedetailnum',
1297       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1298       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1299     },
1300
1301     'rate_region' => {
1302       'columns' => [
1303         'regionnum',   'serial',      '', '', '', '',
1304         'regionname',  'varchar',     '', $char_d, '', '',
1305       ],
1306       'primary_key' => 'regionnum',
1307       'unique'      => [],
1308       'index'       => [],
1309     },
1310
1311     'rate_prefix' => {
1312       'columns' => [
1313         'prefixnum',   'serial',    '', '', '', '',
1314         'regionnum',   'int',       '', '',, '', '',
1315         'countrycode', 'varchar',     '', 3, '', '',
1316         'npa',         'varchar', 'NULL', 6, '', '',
1317         'nxx',         'varchar', 'NULL', 3, '', '',
1318       ],
1319       'primary_key' => 'prefixnum',
1320       'unique'      => [],
1321       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1322     },
1323
1324     'reg_code' => {
1325       'columns' => [
1326         'codenum',   'serial',    '', '', '', '',
1327         'code',      'varchar',   '', $char_d, '', '',
1328         'agentnum',  'int',       '', '', '', '',
1329       ],
1330       'primary_key' => 'codenum',
1331       'unique'      => [ [ 'agentnum', 'code' ] ],
1332       'index'       => [ [ 'agentnum' ] ],
1333     },
1334
1335     'reg_code_pkg' => {
1336       'columns' => [
1337         'codepkgnum', 'serial', '', '', '', '',
1338         'codenum',   'int',    '', '', '', '',
1339         'pkgpart',   'int',    '', '', '', '',
1340       ],
1341       'primary_key' => 'codepkgnum',
1342       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1343       'index'       => [ [ 'codenum' ] ],
1344     },
1345
1346     'clientapi_session' => {
1347       'columns' => [
1348         'sessionnum',  'serial',  '', '', '', '',
1349         'sessionid',  'varchar',  '', $char_d, '', '',
1350         'namespace',  'varchar',  '', $char_d, '', '',
1351       ],
1352       'primary_key' => 'sessionnum',
1353       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1354       'index'       => [],
1355     },
1356
1357     'clientapi_session_field' => {
1358       'columns' => [
1359         'fieldnum',    'serial',     '', '', '', '',
1360         'sessionnum',     'int',     '', '', '', '',
1361         'fieldname',  'varchar',     '', $char_d, '', '',
1362         'fieldvalue',    'text', 'NULL', '', '', '',
1363       ],
1364       'primary_key' => 'fieldnum',
1365       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1366       'index'       => [],
1367     },
1368
1369     'payment_gateway' => {
1370       'columns' => [
1371         'gatewaynum',       'serial',   '',     '', '', '',
1372         'gateway_module',   'varchar',  '',     $char_d, '', '',
1373         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1374         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1375         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1376         'disabled',   'char',  'NULL',   1, '', '',
1377       ],
1378       'primary_key' => 'gatewaynum',
1379       'unique' => [],
1380       'index'  => [ [ 'disabled' ] ],
1381     },
1382
1383     'payment_gateway_option' => {
1384       'columns' => [
1385         'optionnum',   'serial',  '',     '', '', '',
1386         'gatewaynum',  'int',     '',     '', '', '',
1387         'optionname',  'varchar', '',     $char_d, '', '',
1388         'optionvalue', 'text',    'NULL', '', '', '',
1389       ],
1390       'primary_key' => 'optionnum',
1391       'unique'      => [],
1392       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1393     },
1394
1395     'agent_payment_gateway' => {
1396       'columns' => [
1397         'agentgatewaynum', 'serial', '', '', '', '',
1398         'agentnum',        'int', '', '', '', '',
1399         'gatewaynum',      'int', '', '', '', '',
1400         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1401         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1402       ],
1403       'primary_key' => 'agentgatewaynum',
1404       'unique'      => [],
1405       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1406     },
1407
1408     'banned_pay' => {
1409       'columns' => [
1410         'bannum',  'serial',   '',     '', '', '',
1411         'payby',   'char',     '',       4, '', '',
1412         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1413         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1414         '_date',   @date_type, '', '',
1415         'otaker',  'varchar',  '',     32, '', '',
1416         'reason',  'varchar',  'NULL', $char_d, '', '',
1417       ],
1418       'primary_key' => 'bannum',
1419       'unique'      => [ [ 'payby', 'payinfo' ] ],
1420       'index'       => [],
1421     },
1422
1423     'pkg_class' => {
1424       'columns' => [
1425         'classnum',   'serial',  '', '', '', '',
1426         'classname',  'varchar', '', $char_d, '', '',
1427         'disabled',     'char', 'NULL',   1, '', '',
1428       ],
1429       'primary_key' => 'classnum',
1430       'unique' => [],
1431       'index' => [ ['disabled'] ],
1432     },
1433
1434     'cdr' => {
1435       'columns' => [
1436         # qw( name type null length default local );
1437
1438         ###
1439         #asterisk fields
1440         ###
1441
1442         'acctid',   'bigserial',  '', '', '', '',
1443         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1444         'clid',        'varchar',  '', $char_d, \"''", '',
1445         'src',         'varchar',  '', $char_d, \"''", '',
1446         'dst',         'varchar',  '', $char_d, \"''", '',
1447         'dcontext',    'varchar',  '', $char_d, \"''", '',
1448         'channel',     'varchar',  '', $char_d, \"''", '',
1449         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1450         'lastapp',     'varchar',  '', $char_d, \"''", '',
1451         'lastdata',    'varchar',  '', $char_d, \"''", '',
1452
1453         #these don't seem to be logged by most of the SQL cdr_* modules
1454         #except tds under sql-illegal names, so;
1455         # ... don't rely on them for rating?
1456         # and, what they hey, i went ahead and changed the names and data types
1457         # to freeside-style dates...
1458           #'start',  'timestamp', 'NULL',  '',    '', '',
1459           #'answer', 'timestamp', 'NULL',  '',    '', '',
1460           #'end',    'timestamp', 'NULL',  '',    '', '',
1461         'startdate',  @date_type, '', '',
1462         'answerdate', @date_type, '', '',
1463         'enddate',    @date_type, '', '',
1464         #
1465
1466         'duration',    'int',      '',      '',     0, '',
1467         'billsec',     'int',      '',      '',     0, '',
1468         'disposition', 'varchar',  '',      45, \"''", '',
1469         'amaflags',    'int',      '',      '',     0, '',
1470         'accountcode', 'varchar',  '',      20, \"''", '',
1471         'uniqueid',    'varchar',  '',      32, \"''", '',
1472         'userfield',   'varchar',  '',     255, \"''", '',
1473
1474         ###
1475         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1476         # defaults
1477         ###
1478
1479         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1480         'cdrtypenum',              'int', 'NULL',      '', '', '',
1481
1482         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1483
1484         'upstream_currency',      'char', 'NULL',       3, '', '',
1485         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1486         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1487
1488         # how it was rated internally...
1489         'ratedetailnum',           'int', 'NULL',      '', '', '',
1490         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1491
1492         'distance',            'decimal', 'NULL',      '', '', '',
1493         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1494
1495         #cdr_calltype: the big list in appendix 2
1496         'calltypenum',             'int', 'NULL',      '', '', '',
1497
1498         'description',         'varchar', 'NULL', $char_d, '', '',
1499         'quantity',                'int', 'NULL',      '', '', '',
1500
1501         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1502         'carrierid',               'int', 'NULL',      '', '', '',
1503
1504         'upstream_rateid',         'int', 'NULL',      '', '', '',
1505
1506         ###
1507         #and now for our own fields
1508         ###
1509
1510         # a svcnum... right..?
1511         'svcnum',             'int',   'NULL',     '',   '', '',
1512
1513         #NULL, done (or something)
1514         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1515
1516       ],
1517       'primary_key' => 'acctid',
1518       'unique' => [],
1519       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1520     },
1521
1522     'cdr_calltype' => {
1523       'columns' => [
1524         'calltypenum',   'serial',  '', '', '', '',
1525         'calltypename',  'varchar', '', $char_d, '', '',
1526       ],
1527       'primary_key' => 'calltypenum',
1528       'unique'      => [],
1529       'index'       => [],
1530     },
1531
1532     'cdr_type' => {
1533       'columns' => [
1534         'cdrtypenum'  => 'serial',  '', '', '', '',
1535         'cdrtypename' => 'varchar', '', '', '', '',
1536       ],
1537       'primary_key' => 'cdrtypenum',
1538       'unique'      => [],
1539       'index'       => [],
1540     },
1541
1542     'cdr_carrier' => {
1543       'columns' => [
1544         'carrierid'   => 'serial',  '', '', '', '',
1545         'carriername' => 'varchar', '', '', '', '',
1546       ],
1547       'primary_key' => 'carrierid',
1548       'unique'      => [],
1549       'index'       => [],
1550     },
1551
1552     #map upstream rateid to ours...
1553     'cdr_upstream_rate' => {
1554       'columns' => [
1555         'upstreamratenum', 'serial',  '', '', '', '',
1556         'upstream_rateid', 'varchar', '', $char_d, '', '',
1557         'ratedetailnum',   'int', 'NULL', '', '', '',
1558       ],
1559       'primary_key' => 'upstreamratenum', #XXX need a primary key
1560       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1561       'index'  => [],
1562     },
1563
1564     'inventory_item' => {
1565       'columns' => [
1566         'itemnum',  'serial',      '',      '', '', '',
1567         'classnum', 'int',         '',      '', '', '',
1568         'item',     'varchar',     '', $char_d, '', '',
1569         'svcnum',   'int',     'NULL',      '', '', '',
1570       ],
1571       'primary_key' => 'itemnum',
1572       'unique' => [ [ 'classnum', 'item' ] ],
1573       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1574     },
1575
1576     'inventory_class' => {
1577       'columns' => [
1578         'classnum',  'serial',       '',      '', '', '',
1579         'classname', 'varchar',      '', $char_d, '', '',
1580       ],
1581       'primary_key' => 'classnum',
1582       'unique' => [],
1583       'index'  => [],
1584     },
1585
1586     'access_user' => {
1587       'columns' => [
1588         'usernum',   'serial',  '',      '', '', '',
1589         'username',  'varchar', '', $char_d, '', '',
1590         '_password', 'varchar', '', $char_d, '', '',
1591         'last',      'varchar', '', $char_d, '', '',
1592         'first',     'varchar', '', $char_d, '', '',
1593         'disabled',     'char', 'NULL',   1, '', '',
1594       ],
1595       'primary_key' => 'usernum',
1596       'unique' => [ [ 'username' ] ],
1597       'index'  => [],
1598     },
1599
1600     'access_user_pref' => {
1601       'columns' => [
1602         'prefnum',    'serial',       '', '', '', '',
1603         'usernum',     'int',       '', '', '', '',
1604         'prefname', 'varchar', '', $char_d, '', '',
1605         'prefvalue', 'text', 'NULL', '', '', '',
1606       ],
1607       'primary_key' => 'prefnum',
1608       'unique' => [],
1609       'index'  => [ [ 'usernum' ] ],
1610     },
1611
1612     'access_group' => {
1613       'columns' => [
1614         'groupnum',   'serial', '',      '', '', '',
1615         'groupname', 'varchar', '', $char_d, '', '',
1616       ],
1617       'primary_key' => 'groupnum',
1618       'unique' => [ [ 'groupname' ] ],
1619       'index'  => [],
1620     },
1621
1622     'access_usergroup' => {
1623       'columns' => [
1624         'usergroupnum', 'serial', '', '', '', '',
1625         'usernum',         'int', '', '', '', '',
1626         'groupnum',        'int', '', '', '', '',
1627       ],
1628       'primary_key' => 'usergroupnum',
1629       'unique' => [ [ 'usernum', 'groupnum' ] ],
1630       'index'  => [ [ 'usernum' ] ],
1631     },
1632
1633     'access_groupagent' => {
1634       'columns' => [
1635         'groupagentnum', 'serial', '', '', '', '',
1636         'groupnum',         'int', '', '', '', '',
1637         'agentnum',         'int', '', '', '', '',
1638       ],
1639       'primary_key' => 'groupagentnum',
1640       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1641       'index'  => [ [ 'groupnum' ] ],
1642     },
1643
1644     'access_right' => {
1645       'columns' => [
1646         'rightnum',   'serial', '',      '', '', '',
1647         'righttype', 'varchar', '', $char_d, '', '',
1648         'rightobjnum',   'int', '',      '', '', '',
1649         'rightname', 'varchar', '',      '', '', '',
1650       ],
1651       'primary_key' => 'rightnum',
1652       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1653       'index'  => [],
1654     },
1655
1656     'svc_phone' => {
1657       'columns' => [
1658         'svcnum',      'int',         '',      '', '', '',
1659         'countrycode', 'varchar',     '',       3, '', '',
1660         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1661         'pin',         'varchar', 'NULL', $char_d, '', '',
1662       ],
1663       'primary_key' => 'svcnum',
1664       'unique' => [],
1665       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1666     },
1667
1668     'reason_type' => {
1669       'columns' => [
1670         'typenum',   'serial',  '', '', '', '',
1671         'class',     'char', '', 1, '', '',
1672         'type',     'varchar', '', $char_d, '', '',
1673       ],
1674       'primary_key' => 'typenum',
1675       'unique' => [],
1676       'index' => [],
1677     },
1678
1679     'reason' => {
1680       'columns' => [
1681         'reasonnum',     'serial',  '', '', '', '',
1682         'reason_type',   'int',  '', '', '', '',
1683         'reason',        'varchar', '', $char_d, '', '',
1684         'disabled',      'char',    'NULL', 1, '', '',
1685       ],
1686       'primary_key' => 'reasonnum',
1687       'unique' => [],
1688       'index' => [],
1689     },
1690
1691     'conf' => {
1692       'columns' => [
1693         'confnum',  'serial',  '', '', '', '',
1694         'agentnum', 'int',  'NULL', '', '', '',
1695         'name',     'varchar', '', $char_d, '', '',
1696         'value',    'varchar', 'NULL', '', '', '',       # Pg specific
1697       ],
1698       'primary_key' => 'confnum',
1699       'unique' => [ [ 'agentnum', 'name' ]],
1700       'index' => [],
1701     },
1702
1703     # name type nullability length default local
1704
1705     #'new_table' => {
1706     #  'columns' => [
1707     #    'num', 'serial',       '', '', '', '',
1708     #  ],
1709     #  'primary_key' => 'num',
1710     #  'unique' => [],
1711     #  'index'  => [],
1712     #},
1713
1714   };
1715
1716 }
1717
1718 =back
1719
1720 =head1 BUGS
1721
1722 =head1 SEE ALSO
1723
1724 L<DBIx::DBSchema>
1725
1726 =cut
1727
1728 1;
1729