FS/FS/Schema.pm

   1 package FS::Schema;
   2
   3 use vars qw(@ISA @EXPORT_OK $DEBUG $setup_hack %dbdef_cache);
   4 use subs qw(reload_dbdef);
   5 use Exporter;
   6 use DBIx::DBSchema 0.30;
   7 use DBIx::DBSchema::Table;
   8 use DBIx::DBSchema::Column 0.06;
   9 use DBIx::DBSchema::ColGroup::Unique;
  10 use DBIx::DBSchema::ColGroup::Index;
  11 use FS::UID qw(datasrc);
  12
  13 @ISA = qw(Exporter);
  14 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  15
  16 $DEBUG = 0;
  17 $me = '[FS::Schema]';
  18
  19 =head1 NAME
  20
  21 FS::Schema - Freeside database schema
  22
  23 =head1 SYNOPSYS
  24
  25     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  26
  27     $dbdef = reload_dbdef;
  28     $dbdef = reload_dbdef "/non/standard/filename";
  29     $dbdef = dbdef;
  30     $dbdef_dist = dbdef_dist;
  31
  32 =head1 DESCRIPTION
  33
  34 This class represents the database schema.
  35
  36 =head1 METHODS
  37
  38 =over 4
  39
  40 =item reload_dbdef([FILENAME])
  41
  42 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  43 non-default filename.  This command is executed at startup unless
  44 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  45
  46 =cut
  47
  48 sub reload_dbdef {
  49   my $file = shift;
  50
  51   unless ( exists $dbdef_cache{$file} ) {
  52     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  53     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  54       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  55   } else {
  56     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  57   }
  58   $dbdef = $dbdef_cache{$file};
  59 }
  60
  61 =item dbdef
  62
  63 Returns the current database definition (represents the current database,
  64 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  65
  66 =cut
  67
  68 sub dbdef { $dbdef; }
  69
  70 =item dbdef_dist [ OPTION => VALUE ... ]
  71
  72 Returns the current canoical database definition as defined in this file.
  73
  74 =cut
  75
  76 sub dbdef_dist {
  77
  78   ###
  79   # create a dbdef object from the old data structure
  80   ###
  81
  82   my $tables_hashref = tables_hashref();
  83
  84   #turn it into objects
  85   my $dbdef = new DBIx::DBSchema map {
  86     my @columns;
  87     while (@{$tables_hashref->{$_}{'columns'}}) {
  88       #my($name, $type, $null, $length, $default, $local) =
  89       my @coldef =
  90         splice @{$tables_hashref->{$_}{'columns'}}, 0, 6;
  91       my %hash = map { $_ => shift @coldef }
  92                      qw( name type null length default local );
  93
  94       unless ( defined $hash{'default'} ) {
  95         warn "$_:\n".
  96              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
  97       }
  98
  99       push @columns, new DBIx::DBSchema::Column ( \%hash );
 100     }
 101     DBIx::DBSchema::Table->new(
 102       $_,
 103       $tables_hashref->{$_}{'primary_key'},
 104       DBIx::DBSchema::ColGroup::Unique->new($tables_hashref->{$_}{'unique'}),
 105       DBIx::DBSchema::ColGroup::Index->new($tables_hashref->{$_}{'index'}),
 106       @columns,
 107     );
 108   } keys %$tables_hashref;
 109
 110   if ( $DEBUG ) {
 111     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 112     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 113   }
 114
 115   my $cust_main = $dbdef->table('cust_main');
 116   #unless ($ship) { #remove ship_ from cust_main
 117   #  $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
 118   #} else { #add indices
 119     push @{$cust_main->index->lol_ref},
 120       map { [ "ship_$_" ] } qw( last company daytime night fax );
 121   #}
 122
 123   #add radius attributes to svc_acct
 124   #
 125   #my($svc_acct)=$dbdef->table('svc_acct');
 126   #
 127   #my($attribute);
 128   #foreach $attribute (@attributes) {
 129   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 130   #    'radius_'. $attribute,
 131   #    'varchar',
 132   #    'NULL',
 133   #    $char_d,
 134   #  ));
 135   #}
 136   #
 137   #foreach $attribute (@check_attributes) {
 138   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 139   #    'rc_'. $attribute,
 140   #    'varchar',
 141   #    'NULL',
 142   #    $char_d,
 143   #  ));
 144   #}
 145
 146   #create history tables (false laziness w/create-history-tables)
 147   foreach my $table (
 148     grep { ! /^clientapi_session/ }
 149     grep { ! /^h_/ }
 150     $dbdef->tables
 151   ) {
 152     my $tableobj = $dbdef->table($table)
 153       or die "unknown table $table";
 154
 155     die "unique->lol_ref undefined for $table"
 156       unless defined $tableobj->unique->lol_ref;
 157     die "index->lol_ref undefined for $table"
 158       unless defined $tableobj->index->lol_ref;
 159
 160     my $h_tableobj = DBIx::DBSchema::Table->new( {
 161       name        => "h_$table",
 162       primary_key => 'historynum',
 163       unique      => DBIx::DBSchema::ColGroup::Unique->new( [] ),
 164       'index'     => DBIx::DBSchema::ColGroup::Index->new( [
 165                        @{$tableobj->unique->lol_ref},
 166                        @{$tableobj->index->lol_ref}
 167                      ] ),
 168       columns     => [
 169                        DBIx::DBSchema::Column->new( {
 170                          'name'    => 'historynum',
 171                          'type'    => 'serial',
 172                          'null'    => 'NOT NULL',
 173                          'length'  => '',
 174                          'default' => '',
 175                          'local'   => '',
 176                        } ),
 177                        DBIx::DBSchema::Column->new( {
 178                          'name'    => 'history_date',
 179                          'type'    => 'int',
 180                          'null'    => 'NULL',
 181                          'length'  => '',
 182                          'default' => '',
 183                          'local'   => '',
 184                        } ),
 185                        DBIx::DBSchema::Column->new( {
 186                          'name'    => 'history_user',
 187                          'type'    => 'varchar',
 188                          'null'    => 'NOT NULL',
 189                          'length'  => '80',
 190                          'default' => '',
 191                          'local'   => '',
 192                        } ),
 193                        DBIx::DBSchema::Column->new( {
 194                          'name'    => 'history_action',
 195                          'type'    => 'varchar',
 196                          'null'    => 'NOT NULL',
 197                          'length'  => '80',
 198                          'default' => '',
 199                          'local'   => '',
 200                        } ),
 201                        map {
 202                          my $column = $tableobj->column($_);
 203
 204                          #clone so as to not disturb the original
 205                          $column = DBIx::DBSchema::Column->new( {
 206                            map { $_ => $column->$_() }
 207                              qw( name type null length default local )
 208                          } );
 209
 210                          if ( $column->type eq 'serial' ) {
 211                            $column->type('int');
 212                            $column->null('NULL');
 213                          }
 214                          #$column->default('')
 215                          #  if $column->default =~ /^nextval\(/i;
 216                          #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 217                          #$column->local($local);
 218                          $column;
 219                        } $tableobj->columns
 220                      ],
 221     } );
 222     $dbdef->addtable($h_tableobj);
 223   }
 224
 225   $dbdef;
 226
 227 }
 228
 229 sub tables_hashref {
 230
 231   my $char_d = 80; #default maxlength for text fields
 232
 233   #my(@date_type)  = ( 'timestamp', '', ''     );
 234   my @date_type  = ( 'int', 'NULL', ''     );
 235   my @perl_type = ( 'text', 'NULL', ''  );
 236   my @money_type = ( 'decimal',   '', '10,2' );
 237
 238   my $username_len = 32; #usernamemax config file
 239
 240     # name type nullability length default local
 241
 242   return {
 243
 244     'agent' => {
 245       'columns' => [
 246         'agentnum', 'serial',            '',     '', '', '',
 247         'agent',    'varchar',           '',     $char_d, '', '',
 248         'typenum',  'int',            '',     '', '', '',
 249         'freq',     'int',       'NULL', '', '', '',
 250         'prog',     @perl_type, '', '',
 251         'disabled',     'char', 'NULL', 1, '', '',
 252         'username', 'varchar',       'NULL',     $char_d, '', '',
 253         '_password','varchar',       'NULL',     $char_d, '', '',
 254         'ticketing_queueid', 'int', 'NULL', '', '', '',
 255       ],
 256       'primary_key' => 'agentnum',
 257       'unique' => [],
 258       'index' => [ ['typenum'], ['disabled'] ],
 259     },
 260
 261     'agent_type' => {
 262       'columns' => [
 263         'typenum',   'serial',  '', '', '', '',
 264         'atype',     'varchar', '', $char_d, '', '',
 265       ],
 266       'primary_key' => 'typenum',
 267       'unique' => [],
 268       'index' => [],
 269     },
 270
 271     'type_pkgs' => {
 272       'columns' => [
 273         'typepkgnum', 'serial', '', '', '', '',
 274         'typenum',   'int',  '', '', '', '',
 275         'pkgpart',   'int',  '', '', '', '',
 276       ],
 277       'primary_key' => 'typepkgnum',
 278       'unique' => [ ['typenum', 'pkgpart'] ],
 279       'index' => [ ['typenum'] ],
 280     },
 281
 282     'cust_bill' => {
 283       'columns' => [
 284         'invnum',    'serial',  '', '', '', '',
 285         'custnum',   'int',  '', '', '', '',
 286         '_date',     @date_type, '', '',
 287         'charged',   @money_type, '', '',
 288         'printed',   'int',  '', '', '', '',
 289         'closed',    'char', 'NULL', 1, '', '',
 290       ],
 291       'primary_key' => 'invnum',
 292       'unique' => [],
 293       'index' => [ ['custnum'], ['_date'] ],
 294     },
 295
 296     'cust_bill_event' => {
 297       'columns' => [
 298         'eventnum',    'serial',  '', '', '', '',
 299         'invnum',   'int',  '', '', '', '',
 300         'eventpart',   'int',  '', '', '', '',
 301         '_date',     @date_type, '', '',
 302         'status', 'varchar', '', $char_d, '', '',
 303         'statustext', 'text', 'NULL', '', '', '',
 304       ],
 305       'primary_key' => 'eventnum',
 306       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 307       'unique' => [],
 308       'index' => [ ['invnum'], ['status'] ],
 309     },
 310
 311     'part_bill_event' => {
 312       'columns' => [
 313         'eventpart',    'serial',  '', '', '', '',
 314         'freq',        'varchar',       'NULL',     $char_d, '', '',
 315         'payby',       'char',  '', 4, '', '',
 316         'event',       'varchar',           '',     $char_d, '', '',
 317         'eventcode',    @perl_type, '', '',
 318         'seconds',     'int', 'NULL', '', '', '',
 319         'weight',      'int', '', '', '', '',
 320         'plan',       'varchar', 'NULL', $char_d, '', '',
 321         'plandata',   'text', 'NULL', '', '', '',
 322         'reason',     'int', 'NULL', '', '', '',
 323         'disabled',     'char', 'NULL', 1, '', '',
 324       ],
 325       'primary_key' => 'eventpart',
 326       'unique' => [],
 327       'index' => [ ['payby'], ['disabled'], ],
 328     },
 329
 330     'cust_bill_pkg' => {
 331       'columns' => [
 332         'billpkgnum', 'serial', '', '', '', '',
 333         'pkgnum',  'int', '', '', '', '',
 334         'invnum',  'int', '', '', '', '',
 335         'setup',   @money_type, '', '',
 336         'recur',   @money_type, '', '',
 337         'sdate',   @date_type, '', '',
 338         'edate',   @date_type, '', '',
 339         'itemdesc', 'varchar', 'NULL', $char_d, '', '',
 340       ],
 341       'primary_key' => 'billpkgnum',
 342       'unique' => [],
 343       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 344     },
 345
 346     'cust_bill_pkg_detail' => {
 347       'columns' => [
 348         'detailnum', 'serial', '', '', '', '',
 349         'pkgnum',  'int', '', '', '', '',
 350         'invnum',  'int', '', '', '', '',
 351         'detail',  'varchar', '', $char_d, '', '',
 352       ],
 353       'primary_key' => 'detailnum',
 354       'unique' => [],
 355       'index' => [ [ 'pkgnum', 'invnum' ] ],
 356     },
 357
 358     'cust_credit' => {
 359       'columns' => [
 360         'crednum',  'serial', '', '', '', '',
 361         'custnum',  'int', '', '', '', '',
 362         '_date',    @date_type, '', '',
 363         'amount',   @money_type, '', '',
 364         'otaker',   'varchar', '', 32, '', '',
 365         'reason',   'text', 'NULL', '', '', '',
 366         'closed',    'char', 'NULL', 1, '', '',
 367       ],
 368       'primary_key' => 'crednum',
 369       'unique' => [],
 370       'index' => [ ['custnum'] ],
 371     },
 372
 373     'cust_credit_bill' => {
 374       'columns' => [
 375         'creditbillnum', 'serial', '', '', '', '',
 376         'crednum',  'int', '', '', '', '',
 377         'invnum',  'int', '', '', '', '',
 378         '_date',    @date_type, '', '',
 379         'amount',   @money_type, '', '',
 380       ],
 381       'primary_key' => 'creditbillnum',
 382       'unique' => [],
 383       'index' => [ ['crednum'], ['invnum'] ],
 384     },
 385
 386     'cust_credit_bill_pkg' => {
 387       'columns' => [
 388         'creditbillpkgnum', 'serial', '',      '', '', '',
 389         'creditbillnum',       'int', '',      '', '', '',
 390         'billpkgnum',          'int', '',      '', '', '',
 391         'amount',            @money_type,          '', '',
 392         'setuprecur',      'varchar', '', $char_d, '', '',
 393         'sdate',   @date_type, '', '',
 394         'edate',   @date_type, '', '',
 395       ],
 396       'primary_key' => 'creditbillpkgnum',
 397       'unique'      => [],
 398       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 399     },
 400
 401     'cust_main' => {
 402       'columns' => [
 403         'custnum',  'serial',  '',     '', '', '',
 404         'agentnum', 'int',  '',     '', '', '',
 405         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 406 #        'titlenum', 'int',  'NULL',   '', '', '',
 407         'last',     'varchar', '',     $char_d, '', '',
 408 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 409         'first',    'varchar', '',     $char_d, '', '',
 410         'ss',       'varchar', 'NULL', 11, '', '',
 411         'birthdate' ,@date_type, '', '',
 412         'signupdate',@date_type, '', '',
 413         'company',  'varchar', 'NULL', $char_d, '', '',
 414         'address1', 'varchar', '',     $char_d, '', '',
 415         'address2', 'varchar', 'NULL', $char_d, '', '',
 416         'city',     'varchar', '',     $char_d, '', '',
 417         'county',   'varchar', 'NULL', $char_d, '', '',
 418         'state',    'varchar', 'NULL', $char_d, '', '',
 419         'zip',      'varchar', 'NULL', 10, '', '',
 420         'country',  'char', '',     2, '', '',
 421         'daytime',  'varchar', 'NULL', 20, '', '',
 422         'night',    'varchar', 'NULL', 20, '', '',
 423         'fax',      'varchar', 'NULL', 12, '', '',
 424         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 425 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 426         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 427         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 428         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 429         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 430         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 431         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 432         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 433         'ship_zip',      'varchar', 'NULL', 10, '', '',
 434         'ship_country',  'char', 'NULL', 2, '', '',
 435         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 436         'ship_night',    'varchar', 'NULL', 20, '', '',
 437         'ship_fax',      'varchar', 'NULL', 12, '', '',
 438         'payby',    'char', '',     4, '', '',
 439         'payinfo',  'varchar', 'NULL', 512, '', '',
 440         'paycvv',   'varchar', 'NULL', 512, '', '',
 441         'paymask', 'varchar', 'NULL', $char_d, '', '',
 442         #'paydate',  @date_type, '', '',
 443         'paydate',  'varchar', 'NULL', 10, '', '',
 444         'paystart_month', 'int', 'NULL', '', '', '',
 445         'paystart_year',  'int', 'NULL', '', '', '',
 446         'payissue', 'varchar', 'NULL', 2, '', '',
 447         'payname',  'varchar', 'NULL', $char_d, '', '',
 448         'payip',    'varchar', 'NULL', 15, '', '',
 449         'tax',      'char', 'NULL', 1, '', '',
 450         'otaker',   'varchar', '',    32, '', '',
 451         'refnum',   'int',  '',     '', '', '',
 452         'referral_custnum', 'int',  'NULL', '', '', '',
 453         'comments', 'text', 'NULL', '', '', '',
 454         'spool_cdr','char', 'NULL', 1, '', '',
 455       ],
 456       'primary_key' => 'custnum',
 457       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 458       #'index' => [ ['last'], ['company'] ],
 459       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 460                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 461                    [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 462                    [ 'ship_last' ], [ 'ship_company' ],
 463                    [ 'payby' ], [ 'paydate' ],
 464
 465                  ],
 466     },
 467
 468     'cust_main_invoice' => {
 469       'columns' => [
 470         'destnum',  'serial',  '',     '', '', '',
 471         'custnum',  'int',  '',     '', '', '',
 472         'dest',     'varchar', '',  $char_d, '', '',
 473       ],
 474       'primary_key' => 'destnum',
 475       'unique' => [],
 476       'index' => [ ['custnum'], ],
 477     },
 478
 479     'cust_main_note' => {
 480       'columns' => [
 481         'notenum',  'serial',  '',     '', '', '',
 482         'custnum',  'int',  '',     '', '', '',
 483         '_date',    @date_type, '', '',
 484         'otaker',   'varchar', '',    32, '', '',
 485         'comments', 'text', 'NULL', '', '', '',
 486       ],
 487       'primary_key' => 'notenum',
 488       'unique' => [],
 489       'index' => [ [ 'custnum' ], [ '_date' ], ],
 490     },
 491
 492     'cust_main_county' => { #county+state+country are checked off the
 493                             #cust_main_county for validation and to provide
 494                             # a tax rate.
 495       'columns' => [
 496         'taxnum',   'serial',   '',    '', '', '',
 497         'state',    'varchar',  'NULL',    $char_d, '', '',
 498         'county',   'varchar',  'NULL',    $char_d, '', '',
 499         'country',  'char',  '', 2, '', '',
 500         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 501         'exempt_amount', @money_type, '', '',
 502         'tax',      'real',  '',    '', '', '', #tax %
 503         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 504         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 505         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 506       ],
 507       'primary_key' => 'taxnum',
 508       'unique' => [],
 509   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 510       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 511     },
 512
 513     'cust_pay' => {
 514       'columns' => [
 515         'paynum',   'serial',    '',   '', '', '',
 516         #now cust_bill_pay #'invnum',   'int',    '',   '', '', '',
 517         'custnum',  'int',    '',   '', '', '',
 518         'paid',     @money_type, '', '',
 519         '_date',    @date_type, '', '',
 520         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 521                                                  # index into payby table
 522                                                  # eventually
 523         'payinfo',  'varchar',   'NULL', $char_d, '', '', #see cust_main above
 524         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 525         'closed',    'char', 'NULL', 1, '', '',
 526       ],
 527       'primary_key' => 'paynum',
 528       'unique' => [],
 529       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 530     },
 531
 532     'cust_pay_void' => {
 533       'columns' => [
 534         'paynum',    'int',    '',   '', '', '',
 535         'custnum',   'int',    '',   '', '', '',
 536         'paid',      @money_type, '', '',
 537         '_date',     @date_type, '', '',
 538         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 539                                                   # index into payby table
 540                                                   # eventually
 541         'payinfo',   'varchar',   'NULL', $char_d, '', '', #see cust_main above
 542         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 543         'closed',    'char', 'NULL', 1, '', '',
 544         'void_date', @date_type, '', '',
 545         'reason',    'varchar',   'NULL', $char_d, '', '',
 546         'otaker',   'varchar', '', 32, '', '',
 547       ],
 548       'primary_key' => 'paynum',
 549       'unique' => [],
 550       'index' => [ [ 'custnum' ] ],
 551     },
 552
 553     'cust_bill_pay' => {
 554       'columns' => [
 555         'billpaynum', 'serial',     '',   '', '', '',
 556         'invnum',  'int',     '',   '', '', '',
 557         'paynum',  'int',     '',   '', '', '',
 558         'amount',  @money_type, '', '',
 559         '_date',   @date_type, '', '',
 560       ],
 561       'primary_key' => 'billpaynum',
 562       'unique' => [],
 563       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 564     },
 565
 566     'cust_bill_pay_batch' => {
 567       'columns' => [
 568         'billpaynum', 'serial',     '',   '', '', '',
 569         'invnum',  'int',     '',   '', '', '',
 570         'paybatchnum',  'int',     '',   '', '', '',
 571         'amount',  @money_type, '', '',
 572         '_date',   @date_type, '', '',
 573       ],
 574       'primary_key' => 'billpaynum',
 575       'unique' => [],
 576       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 577     },
 578
 579     'cust_bill_pay_pkg' => {
 580       'columns' => [
 581         'billpaypkgnum', 'serial', '', '', '', '',
 582         'billpaynum',       'int', '', '', '', '',
 583         'billpkgnum',       'int', '', '', '', '',
 584         'amount',         @money_type,     '', '',
 585         'setuprecur',      'varchar', '', $char_d, '', '',
 586         'sdate',   @date_type, '', '',
 587         'edate',   @date_type, '', '',
 588       ],
 589       'primary_key' => 'billpaypkgnum',
 590       'unique'      => [],
 591       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 592     },
 593
 594     'pay_batch' => { #batches of payments to an external processor
 595       'columns' => [
 596         'batchnum',   'serial',    '',   '', '', '',
 597         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 598         'status',     'char', 'NULL',     1, '', '',
 599         'download',   @date_type, '', '',
 600         'upload',     @date_type, '', '',
 601       ],
 602       'primary_key' => 'batchnum',
 603       'unique' => [],
 604       'index' => [],
 605     },
 606
 607     'cust_pay_batch' => { #what's this used for again?  list of customers
 608                           #in current CARD batch? (necessarily CARD?)
 609       'columns' => [
 610         'paybatchnum',   'serial',    '',   '', '', '',
 611         'batchnum',   'int',    '',   '', '', '',
 612         'invnum',   'int',    '',   '', '', '',
 613         'custnum',   'int',    '',   '', '', '',
 614         'last',     'varchar', '',     $char_d, '', '',
 615         'first',    'varchar', '',     $char_d, '', '',
 616         'address1', 'varchar', '',     $char_d, '', '',
 617         'address2', 'varchar', 'NULL', $char_d, '', '',
 618         'city',     'varchar', '',     $char_d, '', '',
 619         'state',    'varchar', 'NULL', $char_d, '', '',
 620         'zip',      'varchar', 'NULL', 10, '', '',
 621         'country',  'char', '',     2, '', '',
 622         #        'trancode', 'int', '', '', '', ''
 623         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 624         'payinfo',  'varchar', '',     512, '', '',
 625         #'exp',      @date_type, '', ''
 626         'exp',      'varchar', 'NULL',     11, '', '',
 627         'payname',  'varchar', 'NULL', $char_d, '', '',
 628         'amount',   @money_type, '', '',
 629         'status',   'varchar', 'NULL',     $char_d, '', '',
 630       ],
 631       'primary_key' => 'paybatchnum',
 632       'unique' => [],
 633       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 634     },
 635
 636     'cust_pkg' => {
 637       'columns' => [
 638         'pkgnum',    'serial',    '',   '', '', '',
 639         'custnum',   'int',    '',   '', '', '',
 640         'pkgpart',   'int',    '',   '', '', '',
 641         'otaker',    'varchar', '', 32, '', '',
 642         'setup',     @date_type, '', '',
 643         'bill',      @date_type, '', '',
 644         'last_bill', @date_type, '', '',
 645         'susp',      @date_type, '', '',
 646         'cancel',    @date_type, '', '',
 647         'expire',    @date_type, '', '',
 648         'manual_flag', 'char', 'NULL', 1, '', '',
 649       ],
 650       'primary_key' => 'pkgnum',
 651       'unique' => [],
 652       'index' => [ ['custnum'], ['pkgpart'] ],
 653     },
 654
 655     'cust_pkg_reason' => {
 656       'columns' => [
 657         'num',      'serial',    '',   '', '', '',
 658         'pkgnum',   'int',    '',   '', '', '',
 659         'reasonnum','int',    '',   '', '', '',
 660         'otaker',   'varchar', '', 32, '', '',
 661         'date',     @date_type, '', '',
 662       ],
 663       'primary_key' => 'num',
 664       'unique' => [],
 665       'index' => [],
 666     },
 667
 668     'cust_refund' => {
 669       'columns' => [
 670         'refundnum',    'serial',    '',   '', '', '',
 671         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 672         'custnum',  'int',    '',   '', '', '',
 673         '_date',        @date_type, '', '',
 674         'refund',       @money_type, '', '',
 675         'otaker',       'varchar',   '',   32, '', '',
 676         'reason',       'varchar',   '',   $char_d, '', '',
 677         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 678                                                      # be index into payby
 679                                                      # table eventually
 680         'payinfo',      'varchar',   'NULL', $char_d, '', '', #see cust_main above
 681         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 682         'closed',    'char', 'NULL', 1, '', '',
 683       ],
 684       'primary_key' => 'refundnum',
 685       'unique' => [],
 686       'index' => [],
 687     },
 688
 689     'cust_credit_refund' => {
 690       'columns' => [
 691         'creditrefundnum', 'serial',     '',   '', '', '',
 692         'crednum',  'int',     '',   '', '', '',
 693         'refundnum',  'int',     '',   '', '', '',
 694         'amount',  @money_type, '', '',
 695         '_date',   @date_type, '', '',
 696       ],
 697       'primary_key' => 'creditrefundnum',
 698       'unique' => [],
 699       'index' => [ [ 'crednum', 'refundnum' ] ],
 700     },
 701
 702
 703     'cust_svc' => {
 704       'columns' => [
 705         'svcnum',    'serial',    '',   '', '', '',
 706         'pkgnum',    'int',    'NULL',   '', '', '',
 707         'svcpart',   'int',    '',   '', '', '',
 708       ],
 709       'primary_key' => 'svcnum',
 710       'unique' => [],
 711       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 712     },
 713
 714     'part_pkg' => {
 715       'columns' => [
 716         'pkgpart',    'serial',    '',   '', '', '',
 717         'pkg',        'varchar',   '',   $char_d, '', '',
 718         'comment',    'varchar',   '',   $char_d, '', '',
 719         'promo_code', 'varchar', 'NULL', $char_d, '', '',
 720         'setup',      @perl_type, '', '',
 721         'freq',       'varchar',   '',   $char_d, '', '', #billing frequency
 722         'recur',      @perl_type, '', '',
 723         'setuptax',  'char', 'NULL', 1, '', '',
 724         'recurtax',  'char', 'NULL', 1, '', '',
 725         'plan',       'varchar', 'NULL', $char_d, '', '',
 726         'plandata',   'text', 'NULL', '', '', '',
 727         'disabled',   'char', 'NULL', 1, '', '',
 728         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 729         'classnum',   'int',     'NULL', '', '', '',
 730       ],
 731       'primary_key' => 'pkgpart',
 732       'unique' => [],
 733       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 734     },
 735
 736 #    'part_title' => {
 737 #      'columns' => [
 738 #        'titlenum',   'int',    '',   '',
 739 #        'title',      'varchar',   '',   $char_d,
 740 #      ],
 741 #      'primary_key' => 'titlenum',
 742 #      'unique' => [ [] ],
 743 #      'index' => [ [] ],
 744 #    },
 745
 746     'pkg_svc' => {
 747       'columns' => [
 748         'pkgsvcnum',  'serial', '',  '', '', '',
 749         'pkgpart',    'int',    '',   '', '', '',
 750         'svcpart',    'int',    '',   '', '', '',
 751         'quantity',   'int',    '',   '', '', '',
 752         'primary_svc','char', 'NULL',  1, '', '',
 753       ],
 754       'primary_key' => 'pkgsvcnum',
 755       'unique' => [ ['pkgpart', 'svcpart'] ],
 756       'index' => [ ['pkgpart'] ],
 757     },
 758
 759     'part_referral' => {
 760       'columns' => [
 761         'refnum',   'serial',     '',        '', '', '',
 762         'referral', 'varchar',    '',   $char_d, '', '',
 763         'disabled', 'char',   'NULL',         1, '', '',
 764         'agentnum', 'int',    'NULL',        '', '', '',
 765       ],
 766       'primary_key' => 'refnum',
 767       'unique' => [],
 768       'index' => [ ['disabled'] ],
 769     },
 770
 771     'part_svc' => {
 772       'columns' => [
 773         'svcpart',    'serial',    '',   '', '', '',
 774         'svc',        'varchar',   '',   $char_d, '', '',
 775         'svcdb',      'varchar',   '',   $char_d, '', '',
 776         'disabled',   'char',  'NULL',   1, '', '',
 777       ],
 778       'primary_key' => 'svcpart',
 779       'unique' => [],
 780       'index' => [ [ 'disabled' ] ],
 781     },
 782
 783     'part_svc_column' => {
 784       'columns' => [
 785         'columnnum',   'serial',         '', '', '', '',
 786         'svcpart',     'int',         '', '', '', '',
 787         'columnname',  'varchar',     '', 64, '', '',
 788         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 789         'columnflag',  'char',    'NULL', 1, '', '',
 790       ],
 791       'primary_key' => 'columnnum',
 792       'unique' => [ [ 'svcpart', 'columnname' ] ],
 793       'index' => [ [ 'svcpart' ] ],
 794     },
 795
 796     #(this should be renamed to part_pop)
 797     'svc_acct_pop' => {
 798       'columns' => [
 799         'popnum',    'serial',    '',   '', '', '',
 800         'city',      'varchar',   '',   $char_d, '', '',
 801         'state',     'varchar',   '',   $char_d, '', '',
 802         'ac',        'char',   '',   3, '', '',
 803         'exch',      'char',   '',   3, '', '',
 804         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 805       ],
 806       'primary_key' => 'popnum',
 807       'unique' => [],
 808       'index' => [ [ 'state' ] ],
 809     },
 810
 811     'part_pop_local' => {
 812       'columns' => [
 813         'localnum',  'serial',     '',     '', '', '',
 814         'popnum',    'int',     '',     '', '', '',
 815         'city',      'varchar', 'NULL', $char_d, '', '',
 816         'state',     'char',    'NULL', 2, '', '',
 817         'npa',       'char',    '',     3, '', '',
 818         'nxx',       'char',    '',     3, '', '',
 819       ],
 820       'primary_key' => 'localnum',
 821       'unique' => [],
 822       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 823     },
 824
 825     'svc_acct' => {
 826       'columns' => [
 827         'svcnum',    'int',    '',   '', '', '',
 828         'username',  'varchar',   '',   $username_len, '', '', #unique (& remove dup code)
 829         '_password', 'varchar',   '',   72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
 830         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 831         'popnum',    'int',    'NULL',   '', '', '',
 832         'uid',       'int', 'NULL',   '', '', '',
 833         'gid',       'int', 'NULL',   '', '', '',
 834         'finger',    'varchar',   'NULL',   $char_d, '', '',
 835         'dir',       'varchar',   'NULL',   $char_d, '', '',
 836         'shell',     'varchar',   'NULL',   $char_d, '', '',
 837         'quota',     'varchar',   'NULL',   $char_d, '', '',
 838         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 839         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 840         'seconds_threshold',   'int', 'NULL',   '', '', '',
 841         'upbytes',   'int', 'NULL',   '', '', '',
 842         'upbytes_threshold',   'int', 'NULL',   '', '', '',
 843         'downbytes', 'int', 'NULL',   '', '', '',
 844         'downbytes_threshold',   'int', 'NULL',   '', '', '',
 845         'totalbytes','int', 'NULL',   '', '', '',
 846         'totalbytes_threshold',   'int', 'NULL',   '', '', '',
 847         'domsvc',    'int', '',   '', '', '',
 848       ],
 849       'primary_key' => 'svcnum',
 850       #'unique' => [ [ 'username', 'domsvc' ] ],
 851       'unique' => [],
 852       'index' => [ ['username'], ['domsvc'] ],
 853     },
 854
 855     #'svc_charge' => {
 856     #  'columns' => [
 857     #    'svcnum',    'int',    '',   '',
 858     #    'amount',    @money_type,
 859     #  ],
 860     #  'primary_key' => 'svcnum',
 861     #  'unique' => [ [] ],
 862     #  'index' => [ [] ],
 863     #},
 864
 865     'svc_domain' => {
 866       'columns' => [
 867         'svcnum',    'int',    '',   '', '', '',
 868         'domain',    'varchar',    '',   $char_d, '', '',
 869         'catchall',  'int', 'NULL',    '', '', '',
 870       ],
 871       'primary_key' => 'svcnum',
 872       'unique' => [ ['domain'] ],
 873       'index' => [],
 874     },
 875
 876     'domain_record' => {
 877       'columns' => [
 878         'recnum',    'serial',     '',  '', '', '',
 879         'svcnum',    'int',     '',  '', '', '',
 880         'reczone',   'varchar', '',  255, '', '',
 881         'recaf',     'char',    '',  2, '', '',
 882         'rectype',   'varchar',    '',  5, '', '',
 883         'recdata',   'varchar', '',  255, '', '',
 884       ],
 885       'primary_key' => 'recnum',
 886       'unique'      => [],
 887       'index'       => [ ['svcnum'] ],
 888     },
 889
 890     'svc_forward' => {
 891       'columns' => [
 892         'svcnum',   'int',            '',   '', '', '',
 893         'srcsvc',   'int',        'NULL',   '', '', '',
 894         'src',      'varchar',    'NULL',  255, '', '',
 895         'dstsvc',   'int',        'NULL',   '', '', '',
 896         'dst',      'varchar',    'NULL',  255, '', '',
 897       ],
 898       'primary_key' => 'svcnum',
 899       'unique'      => [],
 900       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 901     },
 902
 903     'svc_www' => {
 904       'columns' => [
 905         'svcnum',   'int',    '',  '', '', '',
 906         'recnum',   'int',    '',  '', '', '',
 907         'usersvc',  'int',    '',  '', '', '',
 908       ],
 909       'primary_key' => 'svcnum',
 910       'unique'      => [],
 911       'index'       => [],
 912     },
 913
 914     #'svc_wo' => {
 915     #  'columns' => [
 916     #    'svcnum',    'int',    '',   '',
 917     #    'svcnum',    'int',    '',   '',
 918     #    'svcnum',    'int',    '',   '',
 919     #    'worker',    'varchar',   '',   $char_d,
 920     #    '_date',     @date_type,
 921     #  ],
 922     #  'primary_key' => 'svcnum',
 923     #  'unique' => [ [] ],
 924     #  'index' => [ [] ],
 925     #},
 926
 927     'prepay_credit' => {
 928       'columns' => [
 929         'prepaynum',   'serial',     '',   '', '', '',
 930         'identifier',  'varchar', '', $char_d, '', '',
 931         'amount',      @money_type, '', '',
 932         'seconds',     'int',     'NULL', '', '', '',
 933         'upbytes',     'int',     'NULL', '', '', '',
 934         'downbytes',   'int',     'NULL', '', '', '',
 935         'agentnum',    'int',     'NULL', '', '', '',
 936       ],
 937       'primary_key' => 'prepaynum',
 938       'unique'      => [ ['identifier'] ],
 939       'index'       => [],
 940     },
 941
 942     'port' => {
 943       'columns' => [
 944         'portnum',  'serial',     '',   '', '', '',
 945         'ip',       'varchar', 'NULL', 15, '', '',
 946         'nasport',  'int',     'NULL', '', '', '',
 947         'nasnum',   'int',     '',   '', '', '',
 948       ],
 949       'primary_key' => 'portnum',
 950       'unique'      => [],
 951       'index'       => [],
 952     },
 953
 954     'nas' => {
 955       'columns' => [
 956         'nasnum',   'serial',     '',    '', '', '',
 957         'nas',      'varchar', '',    $char_d, '', '',
 958         'nasip',    'varchar', '',    15, '', '',
 959         'nasfqdn',  'varchar', '',    $char_d, '', '',
 960         'last',     'int',     '',    '', '', '',
 961       ],
 962       'primary_key' => 'nasnum',
 963       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
 964       'index'       => [ [ 'last' ] ],
 965     },
 966
 967     'session' => {
 968       'columns' => [
 969         'sessionnum', 'serial',       '',   '', '', '',
 970         'portnum',    'int',       '',   '', '', '',
 971         'svcnum',     'int',       '',   '', '', '',
 972         'login',      @date_type, '', '',
 973         'logout',     @date_type, '', '',
 974       ],
 975       'primary_key' => 'sessionnum',
 976       'unique'      => [],
 977       'index'       => [ [ 'portnum' ] ],
 978     },
 979
 980     'queue' => {
 981       'columns' => [
 982         'jobnum', 'serial', '', '', '', '',
 983         'job', 'text', '', '', '', '',
 984         '_date', 'int', '', '', '', '',
 985         'status', 'varchar', '', $char_d, '', '',
 986         'statustext', 'text', 'NULL', '', '', '',
 987         'svcnum', 'int', 'NULL', '', '', '',
 988       ],
 989       'primary_key' => 'jobnum',
 990       'unique'      => [],
 991       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
 992     },
 993
 994     'queue_arg' => {
 995       'columns' => [
 996         'argnum', 'serial', '', '', '', '',
 997         'jobnum', 'int', '', '', '', '',
 998         'arg', 'text', 'NULL', '', '', '',
 999       ],
1000       'primary_key' => 'argnum',
1001       'unique'      => [],
1002       'index'       => [ [ 'jobnum' ] ],
1003     },
1004
1005     'queue_depend' => {
1006       'columns' => [
1007         'dependnum', 'serial', '', '', '', '',
1008         'jobnum', 'int', '', '', '', '',
1009         'depend_jobnum', 'int', '', '', '', '',
1010       ],
1011       'primary_key' => 'dependnum',
1012       'unique'      => [],
1013       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1014     },
1015
1016     'export_svc' => {
1017       'columns' => [
1018         'exportsvcnum' => 'serial', '', '', '', '',
1019         'exportnum'    => 'int', '', '', '', '',
1020         'svcpart'      => 'int', '', '', '', '',
1021       ],
1022       'primary_key' => 'exportsvcnum',
1023       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1024       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1025     },
1026
1027     'part_export' => {
1028       'columns' => [
1029         'exportnum', 'serial', '', '', '', '',
1030         'machine', 'varchar', '', $char_d, '', '',
1031         'exporttype', 'varchar', '', $char_d, '', '',
1032         'nodomain',     'char', 'NULL', 1, '', '',
1033       ],
1034       'primary_key' => 'exportnum',
1035       'unique'      => [],
1036       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1037     },
1038
1039     'part_export_option' => {
1040       'columns' => [
1041         'optionnum', 'serial', '', '', '', '',
1042         'exportnum', 'int', '', '', '', '',
1043         'optionname', 'varchar', '', $char_d, '', '',
1044         'optionvalue', 'text', 'NULL', '', '', '',
1045       ],
1046       'primary_key' => 'optionnum',
1047       'unique'      => [],
1048       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1049     },
1050
1051     'radius_usergroup' => {
1052       'columns' => [
1053         'usergroupnum', 'serial', '', '', '', '',
1054         'svcnum',       'int', '', '', '', '',
1055         'groupname',    'varchar', '', $char_d, '', '',
1056       ],
1057       'primary_key' => 'usergroupnum',
1058       'unique'      => [],
1059       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1060     },
1061
1062     'msgcat' => {
1063       'columns' => [
1064         'msgnum', 'serial', '', '', '', '',
1065         'msgcode', 'varchar', '', $char_d, '', '',
1066         'locale', 'varchar', '', 16, '', '',
1067         'msg', 'text', '', '', '', '',
1068       ],
1069       'primary_key' => 'msgnum',
1070       'unique'      => [ [ 'msgcode', 'locale' ] ],
1071       'index'       => [],
1072     },
1073
1074     'cust_tax_exempt' => {
1075       'columns' => [
1076         'exemptnum', 'serial', '', '', '', '',
1077         'custnum',   'int', '', '', '', '',
1078         'taxnum',    'int', '', '', '', '',
1079         'year',      'int', '', '', '', '',
1080         'month',     'int', '', '', '', '',
1081         'amount',   @money_type, '', '',
1082       ],
1083       'primary_key' => 'exemptnum',
1084       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1085       'index'       => [],
1086     },
1087
1088     'cust_tax_exempt_pkg' => {
1089       'columns' => [
1090         'exemptpkgnum',  'serial', '', '', '', '',
1091         #'custnum',      'int', '', '', '', ''
1092         'billpkgnum',   'int', '', '', '', '',
1093         'taxnum',       'int', '', '', '', '',
1094         'year',         'int', '', '', '', '',
1095         'month',        'int', '', '', '', '',
1096         'amount',       @money_type, '', '',
1097       ],
1098       'primary_key' => 'exemptpkgnum',
1099       'unique' => [],
1100       'index'  => [ [ 'taxnum', 'year', 'month' ],
1101                     [ 'billpkgnum' ],
1102                     [ 'taxnum' ]
1103                   ],
1104     },
1105
1106     'router' => {
1107       'columns' => [
1108         'routernum', 'serial', '', '', '', '',
1109         'routername', 'varchar', '', $char_d, '', '',
1110         'svcnum', 'int', 'NULL', '', '', '',
1111       ],
1112       'primary_key' => 'routernum',
1113       'unique'      => [],
1114       'index'       => [],
1115     },
1116
1117     'part_svc_router' => {
1118       'columns' => [
1119         'svcrouternum', 'serial', '', '', '', '',
1120         'svcpart', 'int', '', '', '', '',
1121         'routernum', 'int', '', '', '', '',
1122       ],
1123       'primary_key' => 'svcrouternum',
1124       'unique'      => [],
1125       'index'       => [],
1126     },
1127
1128     'addr_block' => {
1129       'columns' => [
1130         'blocknum', 'serial', '', '', '', '',
1131         'routernum', 'int', '', '', '', '',
1132         'ip_gateway', 'varchar', '', 15, '', '',
1133         'ip_netmask', 'int', '', '', '', '',
1134       ],
1135       'primary_key' => 'blocknum',
1136       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1137       'index'       => [],
1138     },
1139
1140     'svc_broadband' => {
1141       'columns' => [
1142         'svcnum', 'int', '', '', '', '',
1143         'blocknum', 'int', '', '', '', '',
1144         'speed_up', 'int', '', '', '', '',
1145         'speed_down', 'int', '', '', '', '',
1146         'ip_addr', 'varchar', '', 15, '', '',
1147       ],
1148       'primary_key' => 'svcnum',
1149       'unique'      => [],
1150       'index'       => [],
1151     },
1152
1153     'part_virtual_field' => {
1154       'columns' => [
1155         'vfieldpart', 'int', '', '', '', '',
1156         'dbtable', 'varchar', '', 32, '', '',
1157         'name', 'varchar', '', 32, '', '',
1158         'check_block', 'text', 'NULL', '', '', '',
1159         'length', 'int', 'NULL', '', '', '',
1160         'list_source', 'text', 'NULL', '', '', '',
1161         'label', 'varchar', 'NULL', 80, '', '',
1162       ],
1163       'primary_key' => 'vfieldpart',
1164       'unique' => [],
1165       'index' => [],
1166     },
1167
1168     'virtual_field' => {
1169       'columns' => [
1170         'vfieldnum', 'serial', '', '', '', '',
1171         'recnum', 'int', '', '', '', '',
1172         'vfieldpart', 'int', '', '', '', '',
1173         'value', 'varchar', '', 128, '', '',
1174       ],
1175       'primary_key' => 'vfieldnum',
1176       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1177       'index' => [],
1178     },
1179
1180     'acct_snarf' => {
1181       'columns' => [
1182         'snarfnum',  'int', '', '', '', '',
1183         'svcnum',    'int', '', '', '', '',
1184         'machine',   'varchar', '', 255, '', '',
1185         'protocol',  'varchar', '', $char_d, '', '',
1186         'username',  'varchar', '', $char_d, '', '',
1187         '_password', 'varchar', '', $char_d, '', '',
1188       ],
1189       'primary_key' => 'snarfnum',
1190       'unique' => [],
1191       'index'  => [ [ 'svcnum' ] ],
1192     },
1193
1194     'svc_external' => {
1195       'columns' => [
1196         'svcnum', 'int', '', '', '', '',
1197         'id',     'int', 'NULL', '', '', '',
1198         'title',  'varchar', 'NULL', $char_d, '', '',
1199       ],
1200       'primary_key' => 'svcnum',
1201       'unique'      => [],
1202       'index'       => [],
1203     },
1204
1205     'cust_pay_refund' => {
1206       'columns' => [
1207         'payrefundnum', 'serial', '', '', '', '',
1208         'paynum',  'int', '', '', '', '',
1209         'refundnum',  'int', '', '', '', '',
1210         '_date',    @date_type, '', '',
1211         'amount',   @money_type, '', '',
1212       ],
1213       'primary_key' => 'payrefundnum',
1214       'unique' => [],
1215       'index' => [ ['paynum'], ['refundnum'] ],
1216     },
1217
1218     'part_pkg_option' => {
1219       'columns' => [
1220         'optionnum', 'serial', '', '', '', '',
1221         'pkgpart', 'int', '', '', '', '',
1222         'optionname', 'varchar', '', $char_d, '', '',
1223         'optionvalue', 'text', 'NULL', '', '', '',
1224       ],
1225       'primary_key' => 'optionnum',
1226       'unique'      => [],
1227       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1228     },
1229
1230     'rate' => {
1231       'columns' => [
1232         'ratenum',  'serial', '', '', '', '',
1233         'ratename', 'varchar', '', $char_d, '', '',
1234       ],
1235       'primary_key' => 'ratenum',
1236       'unique'      => [],
1237       'index'       => [],
1238     },
1239
1240     'rate_detail' => {
1241       'columns' => [
1242         'ratedetailnum',   'serial', '', '', '', '',
1243         'ratenum',         'int',     '', '', '', '',
1244         'orig_regionnum',  'int', 'NULL', '', '', '',
1245         'dest_regionnum',  'int',     '', '', '', '',
1246         'min_included',    'int',     '', '', '', '',
1247         #'min_charge',      @money_type, '', '',
1248         'min_charge',      'decimal', '', '10,5', '', '',
1249         'sec_granularity', 'int',     '', '', '', '',
1250         #time period (link to table of periods)?
1251       ],
1252       'primary_key' => 'ratedetailnum',
1253       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1254       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1255     },
1256
1257     'rate_region' => {
1258       'columns' => [
1259         'regionnum',   'serial',      '', '', '', '',
1260         'regionname',  'varchar',     '', $char_d, '', '',
1261       ],
1262       'primary_key' => 'regionnum',
1263       'unique'      => [],
1264       'index'       => [],
1265     },
1266
1267     'rate_prefix' => {
1268       'columns' => [
1269         'prefixnum',   'serial',    '', '', '', '',
1270         'regionnum',   'int',       '', '',, '', '',
1271         'countrycode', 'varchar',     '', 3, '', '',
1272         'npa',         'varchar', 'NULL', 6, '', '',
1273         'nxx',         'varchar', 'NULL', 3, '', '',
1274       ],
1275       'primary_key' => 'prefixnum',
1276       'unique'      => [],
1277       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1278     },
1279
1280     'reg_code' => {
1281       'columns' => [
1282         'codenum',   'serial',    '', '', '', '',
1283         'code',      'varchar',   '', $char_d, '', '',
1284         'agentnum',  'int',       '', '', '', '',
1285       ],
1286       'primary_key' => 'codenum',
1287       'unique'      => [ [ 'agentnum', 'code' ] ],
1288       'index'       => [ [ 'agentnum' ] ],
1289     },
1290
1291     'reg_code_pkg' => {
1292       'columns' => [
1293         'codepkgnum', 'serial', '', '', '', '',
1294         'codenum',   'int',    '', '', '', '',
1295         'pkgpart',   'int',    '', '', '', '',
1296       ],
1297       'primary_key' => 'codepkgnum',
1298       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1299       'index'       => [ [ 'codenum' ] ],
1300     },
1301
1302     'clientapi_session' => {
1303       'columns' => [
1304         'sessionnum',  'serial',  '', '', '', '',
1305         'sessionid',  'varchar',  '', $char_d, '', '',
1306         'namespace',  'varchar',  '', $char_d, '', '',
1307       ],
1308       'primary_key' => 'sessionnum',
1309       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1310       'index'       => [],
1311     },
1312
1313     'clientapi_session_field' => {
1314       'columns' => [
1315         'fieldnum',    'serial',     '', '', '', '',
1316         'sessionnum',     'int',     '', '', '', '',
1317         'fieldname',  'varchar',     '', $char_d, '', '',
1318         'fieldvalue',    'text', 'NULL', '', '', '',
1319       ],
1320       'primary_key' => 'fieldnum',
1321       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1322       'index'       => [],
1323     },
1324
1325     'payment_gateway' => {
1326       'columns' => [
1327         'gatewaynum',       'serial',   '',     '', '', '',
1328         'gateway_module',   'varchar',  '',     $char_d, '', '',
1329         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1330         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1331         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1332         'disabled',   'char',  'NULL',   1, '', '',
1333       ],
1334       'primary_key' => 'gatewaynum',
1335       'unique' => [],
1336       'index'  => [ [ 'disabled' ] ],
1337     },
1338
1339     'payment_gateway_option' => {
1340       'columns' => [
1341         'optionnum',   'serial',  '',     '', '', '',
1342         'gatewaynum',  'int',     '',     '', '', '',
1343         'optionname',  'varchar', '',     $char_d, '', '',
1344         'optionvalue', 'text',    'NULL', '', '', '',
1345       ],
1346       'primary_key' => 'optionnum',
1347       'unique'      => [],
1348       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1349     },
1350
1351     'agent_payment_gateway' => {
1352       'columns' => [
1353         'agentgatewaynum', 'serial', '', '', '', '',
1354         'agentnum',        'int', '', '', '', '',
1355         'gatewaynum',      'int', '', '', '', '',
1356         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1357         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1358       ],
1359       'primary_key' => 'agentgatewaynum',
1360       'unique'      => [],
1361       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1362     },
1363
1364     'banned_pay' => {
1365       'columns' => [
1366         'bannum',  'serial',   '',     '', '', '',
1367         'payby',   'char',     '',       4, '', '',
1368         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1369         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1370         '_date',   @date_type, '', '',
1371         'otaker',  'varchar',  '',     32, '', '',
1372         'reason',  'varchar',  'NULL', $char_d, '', '',
1373       ],
1374       'primary_key' => 'bannum',
1375       'unique'      => [ [ 'payby', 'payinfo' ] ],
1376       'index'       => [],
1377     },
1378
1379     'pkg_class' => {
1380       'columns' => [
1381         'classnum',   'serial',  '', '', '', '',
1382         'classname',  'varchar', '', $char_d, '', '',
1383       ],
1384       'primary_key' => 'classnum',
1385       'unique' => [],
1386       'index' => [],
1387     },
1388
1389     'cdr' => {
1390       'columns' => [
1391         # qw( name type null length default local );
1392
1393         ###
1394         #asterisk fields
1395         ###
1396
1397         'acctid',   'bigserial',  '', '', '', '',
1398         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1399         'clid',        'varchar',  '', $char_d, \"''", '',
1400         'src',         'varchar',  '', $char_d, \"''", '',
1401         'dst',         'varchar',  '', $char_d, \"''", '',
1402         'dcontext',    'varchar',  '', $char_d, \"''", '',
1403         'channel',     'varchar',  '', $char_d, \"''", '',
1404         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1405         'lastapp',     'varchar',  '', $char_d, \"''", '',
1406         'lastdata',    'varchar',  '', $char_d, \"''", '',
1407
1408         #these don't seem to be logged by most of the SQL cdr_* modules
1409         #except tds under sql-illegal names, so;
1410         # ... don't rely on them for rating?
1411         # and, what they hey, i went ahead and changed the names and data types
1412         # to freeside-style dates...
1413           #'start',  'timestamp', 'NULL',  '',    '', '',
1414           #'answer', 'timestamp', 'NULL',  '',    '', '',
1415           #'end',    'timestamp', 'NULL',  '',    '', '',
1416         'startdate',  @date_type, '', '',
1417         'answerdate', @date_type, '', '',
1418         'enddate',    @date_type, '', '',
1419         #
1420
1421         'duration',    'int',      '',      '',     0, '',
1422         'billsec',     'int',      '',      '',     0, '',
1423         'disposition', 'varchar',  '',      45, \"''", '',
1424         'amaflags',    'int',      '',      '',     0, '',
1425         'accountcode', 'varchar',  '',      20, \"''", '',
1426         'uniqueid',    'varchar',  '',      32, \"''", '',
1427         'userfield',   'varchar',  '',     255, \"''", '',
1428
1429         ###
1430         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1431         # defaults
1432         ###
1433
1434         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1435         'cdrtypenum',              'int', 'NULL',      '', '', '',
1436
1437         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1438
1439         'upstream_currency',      'char', 'NULL',       3, '', '',
1440         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1441         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1442
1443         # how it was rated internally...
1444         'ratedetailnum',           'int', 'NULL',      '', '', '',
1445         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1446
1447         'distance',            'decimal', 'NULL',      '', '', '',
1448         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1449
1450         #cdr_calltype: the big list in appendix 2
1451         'calltypenum',             'int', 'NULL',      '', '', '',
1452
1453         'description',         'varchar', 'NULL', $char_d, '', '',
1454         'quantity',                'int', 'NULL',      '', '', '',
1455
1456         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1457         'carrierid',               'int', 'NULL',      '', '', '',
1458
1459         'upstream_rateid',         'int', 'NULL',      '', '', '',
1460
1461         ###
1462         #and now for our own fields
1463         ###
1464
1465         # a svcnum... right..?
1466         'svcnum',             'int',   'NULL',     '',   '', '',
1467
1468         #NULL, done (or something)
1469         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1470
1471       ],
1472       'primary_key' => 'acctid',
1473       'unique' => [],
1474       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1475     },
1476
1477     'cdr_calltype' => {
1478       'columns' => [
1479         'calltypenum',   'serial',  '', '', '', '',
1480         'calltypename',  'varchar', '', $char_d, '', '',
1481       ],
1482       'primary_key' => 'calltypenum',
1483       'unique'      => [],
1484       'index'       => [],
1485     },
1486
1487     'cdr_type' => {
1488       'columns' => [
1489         'cdrtypenum'  => 'serial',  '', '', '', '',
1490         'cdrtypename' => 'varchar', '', '', '', '',
1491       ],
1492       'primary_key' => 'cdrtypenum',
1493       'unique'      => [],
1494       'index'       => [],
1495     },
1496
1497     'cdr_carrier' => {
1498       'columns' => [
1499         'carrierid'   => 'serial',  '', '', '', '',
1500         'carriername' => 'varchar', '', '', '', '',
1501       ],
1502       'primary_key' => 'carrierid',
1503       'unique'      => [],
1504       'index'       => [],
1505     },
1506
1507     #map upstream rateid to ours...
1508     'cdr_upstream_rate' => {
1509       'columns' => [
1510         'upstreamratenum', 'serial',  '', '', '', '',
1511         'upstream_rateid', 'varchar', '', $char_d, '', '',
1512         'ratedetailnum',   'int', 'NULL', '', '', '',
1513       ],
1514       'primary_key' => 'upstreamratenum', #XXX need a primary key
1515       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1516       'index'  => [],
1517     },
1518
1519     'inventory_item' => {
1520       'columns' => [
1521         'itemnum',  'serial',      '',      '', '', '',
1522         'classnum', 'int',         '',      '', '', '',
1523         'item',     'varchar',     '', $char_d, '', '',
1524         'svcnum',   'int',     'NULL',      '', '', '',
1525       ],
1526       'primary_key' => 'itemnum',
1527       'unique' => [ [ 'classnum', 'item' ] ],
1528       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1529     },
1530
1531     'inventory_class' => {
1532       'columns' => [
1533         'classnum',  'serial',       '',      '', '', '',
1534         'classname', 'varchar',      '', $char_d, '', '',
1535       ],
1536       'primary_key' => 'classnum',
1537       'unique' => [],
1538       'index'  => [],
1539     },
1540
1541     'access_user' => {
1542       'columns' => [
1543         'usernum',   'serial',  '',      '', '', '',
1544         'username',  'varchar', '', $char_d, '', '',
1545         '_password', 'varchar', '', $char_d, '', '',
1546         'last',      'varchar', '', $char_d, '', '',
1547         'first',     'varchar', '', $char_d, '', '',
1548         'disabled',     'char', 'NULL',   1, '', '',
1549       ],
1550       'primary_key' => 'usernum',
1551       'unique' => [ [ 'username' ] ],
1552       'index'  => [],
1553     },
1554
1555     'access_user_pref' => {
1556       'columns' => [
1557         'prefnum',    'serial',       '', '', '', '',
1558         'usernum',     'int',       '', '', '', '',
1559         'prefname', 'varchar', '', $char_d, '', '',
1560         'prefvalue', 'text', 'NULL', '', '', '',
1561       ],
1562       'primary_key' => 'prefnum',
1563       'unique' => [],
1564       'index'  => [ [ 'usernum' ] ],
1565     },
1566
1567     'access_group' => {
1568       'columns' => [
1569         'groupnum',   'serial', '',      '', '', '',
1570         'groupname', 'varchar', '', $char_d, '', '',
1571       ],
1572       'primary_key' => 'groupnum',
1573       'unique' => [ [ 'groupname' ] ],
1574       'index'  => [],
1575     },
1576
1577     'access_usergroup' => {
1578       'columns' => [
1579         'usergroupnum', 'serial', '', '', '', '',
1580         'usernum',         'int', '', '', '', '',
1581         'groupnum',        'int', '', '', '', '',
1582       ],
1583       'primary_key' => 'usergroupnum',
1584       'unique' => [ [ 'usernum', 'groupnum' ] ],
1585       'index'  => [ [ 'usernum' ] ],
1586     },
1587
1588     'access_groupagent' => {
1589       'columns' => [
1590         'groupagentnum', 'serial', '', '', '', '',
1591         'groupnum',         'int', '', '', '', '',
1592         'agentnum',         'int', '', '', '', '',
1593       ],
1594       'primary_key' => 'groupagentnum',
1595       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1596       'index'  => [ [ 'groupnum' ] ],
1597     },
1598
1599     'access_right' => {
1600       'columns' => [
1601         'rightnum',   'serial', '',      '', '', '',
1602         'righttype', 'varchar', '', $char_d, '', '',
1603         'rightobjnum',   'int', '',      '', '', '',
1604         'rightname', 'varchar', '',      '', '', '',
1605       ],
1606       'primary_key' => 'rightnum',
1607       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1608       'index'  => [],
1609     },
1610
1611     'svc_phone' => {
1612       'columns' => [
1613         'svcnum',      'int',         '',      '', '', '',
1614         'countrycode', 'varchar',     '',       3, '', '',
1615         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1616         'pin',         'varchar', 'NULL', $char_d, '', '',
1617       ],
1618       'primary_key' => 'svcnum',
1619       'unique' => [],
1620       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1621     },
1622
1623     'reason_type' => {
1624       'columns' => [
1625         'typenum',   'serial',  '', '', '', '',
1626         'class',     'char', '', 1, '', '',
1627         'type',     'varchar', '', $char_d, '', '',
1628       ],
1629       'primary_key' => 'typenum',
1630       'unique' => [],
1631       'index' => [],
1632     },
1633
1634     'reason' => {
1635       'columns' => [
1636         'reasonnum',     'serial',  '', '', '', '',
1637         'reason_type',   'int',  '', '', '', '',
1638         'reason',        'varchar', '', $char_d, '', '',
1639         'disabled',      'char',    'NULL', 1, '', '',
1640       ],
1641       'primary_key' => 'reasonnum',
1642       'unique' => [],
1643       'index' => [],
1644     },
1645
1646     # name type nullability length default local
1647
1648     #'new_table' => {
1649     #  'columns' => [
1650     #    'num', 'serial',       '', '', '', '',
1651     #  ],
1652     #  'primary_key' => 'num',
1653     #  'unique' => [],
1654     #  'index'  => [],
1655     #},
1656
1657   };
1658
1659 }
1660
1661 =back
1662
1663 =head1 BUGS
1664
1665 =head1 SEE ALSO
1666
1667 L<DBIx::DBSchema>
1668
1669 =cut
1670
1671 1;
1672