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