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