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