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.33;
   7 use DBIx::DBSchema::Table;
   8 use DBIx::DBSchema::Column 0.06;
   9 use DBIx::DBSchema::Index;
  10
  11 @ISA = qw(Exporter);
  12 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  13
  14 $DEBUG = 0;
  15 $me = '[FS::Schema]';
  16
  17 =head1 NAME
  18
  19 FS::Schema - Freeside database schema
  20
  21 =head1 SYNOPSYS
  22
  23     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  24
  25     $dbdef = reload_dbdef;
  26     $dbdef = reload_dbdef "/non/standard/filename";
  27     $dbdef = dbdef;
  28     $dbdef_dist = dbdef_dist;
  29
  30 =head1 DESCRIPTION
  31
  32 This class represents the database schema.
  33
  34 =head1 METHODS
  35
  36 =over 4
  37
  38 =item reload_dbdef([FILENAME])
  39
  40 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  41 non-default filename.  This command is executed at startup unless
  42 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  43
  44 =cut
  45
  46 sub reload_dbdef {
  47   my $file = shift;
  48
  49   unless ( exists $dbdef_cache{$file} ) {
  50     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  51     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  52       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  53   } else {
  54     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  55   }
  56   $dbdef = $dbdef_cache{$file};
  57 }
  58
  59 =item dbdef
  60
  61 Returns the current database definition (represents the current database,
  62 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  63
  64 =cut
  65
  66 sub dbdef { $dbdef; }
  67
  68 =item dbdef_dist [ DATASRC ]
  69
  70 Returns the current canoical database definition as defined in this file.
  71
  72 Optionally, pass a DBI data source to enable syntax specific to that database.
  73 Currently, this enables "TYPE=InnoDB" for MySQL databases.
  74
  75 =cut
  76
  77 sub dbdef_dist {
  78   my $datasrc = @_ ? shift : '';
  79
  80   my $local_options = '';
  81   if ( $datasrc =~ /^dbi:mysql/i ) {
  82     $local_options = 'TYPE=InnoDB';
  83   }
  84
  85   ###
  86   # create a dbdef object from the old data structure
  87   ###
  88
  89   my $tables_hashref = tables_hashref();
  90
  91   #turn it into objects
  92   my $dbdef = new DBIx::DBSchema map {
  93
  94     my $tablename = $_;
  95     my $indexnum = 1;
  96
  97     my @columns;
  98     while (@{$tables_hashref->{$tablename}{'columns'}}) {
  99       #my($name, $type, $null, $length, $default, $local) =
 100       my @coldef =
 101         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
 102       my %hash = map { $_ => shift @coldef }
 103                      qw( name type null length default local );
 104
 105       unless ( defined $hash{'default'} ) {
 106         warn "$tablename:\n".
 107              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 108       }
 109
 110       push @columns, new DBIx::DBSchema::Column ( \%hash );
 111     }
 112
 113     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 114     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 115     my $unique = $tables_hashref->{$tablename}{'unique'};
 116     my $index  = $tables_hashref->{$tablename}{'index'};
 117     my @indices = ();
 118     push @indices, map {
 119                          DBIx::DBSchema::Index->new({
 120                            'name'    => $tablename. $indexnum++,
 121                            'unique'  => 1,
 122                            'columns' => $_,
 123                          });
 124                        }
 125                        @$unique;
 126     push @indices, map {
 127                          DBIx::DBSchema::Index->new({
 128                            'name'    => $tablename. $indexnum++,
 129                            'unique'  => 0,
 130                            'columns' => $_,
 131                          });
 132                        }
 133                        @$index;
 134
 135     DBIx::DBSchema::Table->new({
 136       'name'          => $tablename,
 137       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 138       'columns'       => \@columns,
 139       'indices'       => \@indices,
 140       'local_options' => $local_options,
 141     });
 142
 143   } keys %$tables_hashref;
 144
 145   if ( $DEBUG ) {
 146     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 147     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 148   }
 149
 150   #add radius attributes to svc_acct
 151   #
 152   #my($svc_acct)=$dbdef->table('svc_acct');
 153   #
 154   #my($attribute);
 155   #foreach $attribute (@attributes) {
 156   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 157   #    'radius_'. $attribute,
 158   #    'varchar',
 159   #    'NULL',
 160   #    $char_d,
 161   #  ));
 162   #}
 163   #
 164   #foreach $attribute (@check_attributes) {
 165   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 166   #    'rc_'. $attribute,
 167   #    'varchar',
 168   #    'NULL',
 169   #    $char_d,
 170   #  ));
 171   #}
 172
 173   #create history tables (false laziness w/create-history-tables)
 174   foreach my $table (
 175     grep { ! /^clientapi_session/ }
 176     grep { ! /^h_/ }
 177     $dbdef->tables
 178   ) {
 179     my $tableobj = $dbdef->table($table)
 180       or die "unknown table $table";
 181
 182     my %indices = $tableobj->indices;
 183
 184     my %h_indices = map {
 185                           ( "h_$_" =>
 186                               DBIx::DBSchema::Index->new({
 187                                 'name'    => 'h_'. $indices{$_}->name,
 188                                 'unique'  => 0,
 189                                 'columns' => [ @{$indices{$_}->columns} ],
 190                               })
 191                           );
 192                         }
 193                         keys %indices;
 194
 195     my $h_tableobj = DBIx::DBSchema::Table->new( {
 196       'name'          => "h_$table",
 197       'primary_key'   => 'historynum',
 198       'indices'       => \%h_indices,
 199       'local_options' => $local_options,
 200       'columns'       => [
 201           DBIx::DBSchema::Column->new( {
 202             'name'    => 'historynum',
 203             'type'    => 'serial',
 204             'null'    => 'NOT NULL',
 205             'length'  => '',
 206             'default' => '',
 207             'local'   => '',
 208           } ),
 209           DBIx::DBSchema::Column->new( {
 210             'name'    => 'history_date',
 211             'type'    => 'int',
 212             'null'    => 'NULL',
 213             'length'  => '',
 214             'default' => '',
 215             'local'   => '',
 216           } ),
 217           DBIx::DBSchema::Column->new( {
 218             'name'    => 'history_user',
 219             'type'    => 'varchar',
 220             'null'    => 'NOT NULL',
 221             'length'  => '80',
 222             'default' => '',
 223             'local'   => '',
 224           } ),
 225           DBIx::DBSchema::Column->new( {
 226             'name'    => 'history_action',
 227             'type'    => 'varchar',
 228             'null'    => 'NOT NULL',
 229             'length'  => '80',
 230             'default' => '',
 231             'local'   => '',
 232           } ),
 233           map {
 234             my $column = $tableobj->column($_);
 235
 236             #clone so as to not disturb the original
 237             $column = DBIx::DBSchema::Column->new( {
 238               map { $_ => $column->$_() }
 239                 qw( name type null length default local )
 240             } );
 241
 242             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 243               $column->type('int');
 244               $column->null('NULL');
 245             }
 246             #$column->default('')
 247             #  if $column->default =~ /^nextval\(/i;
 248             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 249             #$column->local($local);
 250             $column;
 251           } $tableobj->columns
 252       ],
 253     } );
 254     $dbdef->addtable($h_tableobj);
 255   }
 256
 257   if ( $datasrc =~ /^dbi:mysql/i ) {
 258
 259     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 260       'name'          => 'duplicate_lock',
 261       'primary_key'   => 'duplocknum',
 262       'local_options' => $local_options,
 263       'columns'       => [
 264         DBIx::DBSchema::Column->new( {
 265           'name'    => 'duplocknum',
 266           'type'    => 'serial',
 267           'null'    => 'NOT NULL',
 268           'length'  => '',
 269           'default' => '',
 270           'local'   => '',
 271         } ),
 272         DBIx::DBSchema::Column->new( {
 273           'name'    => 'lockname',
 274           'type'    => 'varchar',
 275           'null'    => 'NOT NULL',
 276           'length'  => '80',
 277           'default' => '',
 278           'local'   => '',
 279         } ),
 280       ],
 281       'indices' => { 'duplicate_lock1' =>
 282                        DBIx::DBSchema::Index->new({
 283                          'name'    => 'duplicate_lock1',
 284                          'unique'  => 1,
 285                          'columns' => [ 'lockname' ],
 286                        })
 287                    },
 288     } );
 289
 290     $dbdef->addtable($dup_lock_table);
 291
 292   }
 293
 294   $dbdef;
 295
 296 }
 297
 298 sub tables_hashref {
 299
 300   my $char_d = 80; #default maxlength for text fields
 301
 302   #my(@date_type)  = ( 'timestamp', '', ''     );
 303   my @date_type  = ( 'int', 'NULL', ''     );
 304   my @perl_type = ( 'text', 'NULL', ''  );
 305   my @money_type = ( 'decimal',   '', '10,2' );
 306   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 307
 308   my $username_len = 32; #usernamemax config file
 309
 310     # name type nullability length default local
 311
 312   return {
 313
 314     'agent' => {
 315       'columns' => [
 316         'agentnum',          'serial',    '',       '', '', '',
 317         'agent',            'varchar',    '',  $char_d, '', '',
 318         'typenum',              'int',    '',       '', '', '',
 319         'disabled',            'char', 'NULL',       1, '', '',
 320         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 321         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 322         'username',         'varchar', 'NULL', $char_d, '', '', #deprecated
 323         '_password',        'varchar', 'NULL', $char_d, '', '', #deprecated
 324         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 325         'prog',                     @perl_type, '', '', #deprecated (never used)
 326
 327       ],
 328       'primary_key' => 'agentnum',
 329       'unique' => [],
 330       'index' => [ ['typenum'], ['disabled'] ],
 331     },
 332
 333     'agent_type' => {
 334       'columns' => [
 335         'typenum',   'serial',  '', '', '', '',
 336         'atype',     'varchar', '', $char_d, '', '',
 337       ],
 338       'primary_key' => 'typenum',
 339       'unique' => [],
 340       'index' => [],
 341     },
 342
 343     'type_pkgs' => {
 344       'columns' => [
 345         'typepkgnum', 'serial', '', '', '', '',
 346         'typenum',   'int',  '', '', '', '',
 347         'pkgpart',   'int',  '', '', '', '',
 348       ],
 349       'primary_key' => 'typepkgnum',
 350       'unique' => [ ['typenum', 'pkgpart'] ],
 351       'index' => [ ['typenum'] ],
 352     },
 353
 354     'cust_bill' => {
 355       'columns' => [
 356         'invnum',    'serial',  '', '', '', '',
 357         'custnum',   'int',  '', '', '', '',
 358         '_date',     @date_type, '', '',
 359         'charged',   @money_type, '', '',
 360         'printed',   'int',  '', '', '', '',
 361         'closed',    'char', 'NULL', 1, '', '',
 362       ],
 363       'primary_key' => 'invnum',
 364       'unique' => [],
 365       'index' => [ ['custnum'], ['_date'] ],
 366     },
 367
 368     'cust_bill_event' => {
 369       'columns' => [
 370         'eventnum',    'serial',  '', '', '', '',
 371         'invnum',   'int',  '', '', '', '',
 372         'eventpart',   'int',  '', '', '', '',
 373         '_date',     @date_type, '', '',
 374         'status', 'varchar', '', $char_d, '', '',
 375         'statustext', 'text', 'NULL', '', '', '',
 376       ],
 377       'primary_key' => 'eventnum',
 378       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 379       'unique' => [],
 380       'index' => [ ['invnum'], ['status'] ],
 381     },
 382
 383     'part_bill_event' => {
 384       'columns' => [
 385         'eventpart',    'serial',  '', '', '', '',
 386         'freq',        'varchar',       'NULL',     $char_d, '', '',
 387         'payby',       'char',  '', 4, '', '',
 388         'event',       'varchar',           '',     $char_d, '', '',
 389         'eventcode',    @perl_type, '', '',
 390         'seconds',     'int', 'NULL', '', '', '',
 391         'weight',      'int', '', '', '', '',
 392         'plan',       'varchar', 'NULL', $char_d, '', '',
 393         'plandata',   'text', 'NULL', '', '', '',
 394         'reason',     'int', 'NULL', '', '', '',
 395         'disabled',     'char', 'NULL', 1, '', '',
 396       ],
 397       'primary_key' => 'eventpart',
 398       'unique' => [],
 399       'index' => [ ['payby'], ['disabled'], ],
 400     },
 401
 402     'part_event' => {
 403       'columns' => [
 404         'eventpart',   'serial',      '',      '', '', '',
 405         'agentnum',    'int',     'NULL',      '', '', '',
 406         'event',       'varchar',     '', $char_d, '', '',
 407         'eventtable',  'varchar',     '', $char_d, '', '',
 408         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 409         'weight',      'int',         '',      '', '', '',
 410         'action',      'varchar',     '', $char_d, '', '',
 411         'disabled',     'char',   'NULL',       1, '', '',
 412       ],
 413       'primary_key' => 'eventpart',
 414       'unique' => [],
 415       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 416     },
 417
 418     'part_event_option' => {
 419       'columns' => [
 420         'optionnum', 'serial', '', '', '', '',
 421         'eventpart', 'int', '', '', '', '',
 422         'optionname', 'varchar', '', $char_d, '', '',
 423         'optionvalue', 'text', 'NULL', '', '', '',
 424       ],
 425       'primary_key' => 'optionnum',
 426       'unique'      => [],
 427       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 428     },
 429
 430     'part_event_condition' => {
 431       'columns' => [
 432         'eventconditionnum', 'serial', '', '', '', '',
 433         'eventpart', 'int', '', '', '', '',
 434         'conditionname', 'varchar', '', $char_d, '', '',
 435       ],
 436       'primary_key' => 'eventconditionnum',
 437       'unique'      => [],
 438       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 439     },
 440
 441     'part_event_condition_option' => {
 442       'columns' => [
 443         'optionnum', 'serial', '', '', '', '',
 444         'eventconditionnum', 'int', '', '', '', '',
 445         'optionname', 'varchar', '', $char_d, '', '',
 446         'optionvalue', 'text', 'NULL', '', '', '',
 447       ],
 448       'primary_key' => 'optionnum',
 449       'unique'      => [],
 450       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 451     },
 452
 453     'part_event_condition_option_option' => {
 454       'columns' => [
 455         'optionoptionnum', 'serial', '', '', '', '',
 456         'optionnum', 'int', '', '', '', '',
 457         'optionname', 'varchar', '', $char_d, '', '',
 458         'optionvalue', 'text', 'NULL', '', '', '',
 459       ],
 460       'primary_key' => 'optionoptionnum',
 461       'unique'      => [],
 462       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 463     },
 464
 465     'cust_event' => {
 466       'columns' => [
 467         'eventnum',    'serial',  '', '', '', '',
 468         'eventpart',   'int',  '', '', '', '',
 469         'tablenum',   'int',  '', '', '', '',
 470         '_date',     @date_type, '', '',
 471         'status', 'varchar', '', $char_d, '', '',
 472         'statustext', 'text', 'NULL', '', '', '',
 473       ],
 474       'primary_key' => 'eventnum',
 475       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 476       'unique' => [],
 477       'index' => [ ['eventpart'], ['tablenum'], ['status'] ],
 478     },
 479
 480     'cust_bill_pkg' => {
 481       'columns' => [
 482         'billpkgnum', 'serial', '', '', '', '',
 483         'pkgnum',  'int', '', '', '', '',
 484         'pkgpart_override',  'int', 'NULL', '', '', '',
 485         'invnum',  'int', '', '', '', '',
 486         'setup',   @money_type, '', '',
 487         'recur',   @money_type, '', '',
 488         'sdate',   @date_type, '', '',
 489         'edate',   @date_type, '', '',
 490         'itemdesc', 'varchar', 'NULL', $char_d, '', '',
 491       ],
 492       'primary_key' => 'billpkgnum',
 493       'unique' => [],
 494       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 495     },
 496
 497     'cust_bill_pkg_detail' => {
 498       'columns' => [
 499         'detailnum', 'serial', '', '', '', '',
 500         'pkgnum',  'int', '', '', '', '',
 501         'invnum',  'int', '', '', '', '',
 502         'format',  'char', 'NULL', 1, '', '',
 503         'detail',  'varchar', '', $char_d, '', '',
 504       ],
 505       'primary_key' => 'detailnum',
 506       'unique' => [],
 507       'index' => [ [ 'pkgnum', 'invnum' ] ],
 508     },
 509
 510     'cust_credit' => {
 511       'columns' => [
 512         'crednum',  'serial', '', '', '', '',
 513         'custnum',  'int', '', '', '', '',
 514         '_date',    @date_type, '', '',
 515         'amount',   @money_type, '', '',
 516         'otaker',   'varchar', '', 32, '', '',
 517         'reason',   'text', 'NULL', '', '', '',
 518         'reasonnum', 'int', 'NULL', '', '', '',
 519         'closed',    'char', 'NULL', 1, '', '',
 520       ],
 521       'primary_key' => 'crednum',
 522       'unique' => [],
 523       'index' => [ ['custnum'], ['_date'] ],
 524     },
 525
 526     'cust_credit_bill' => {
 527       'columns' => [
 528         'creditbillnum', 'serial', '', '', '', '',
 529         'crednum',  'int', '', '', '', '',
 530         'invnum',  'int', '', '', '', '',
 531         '_date',    @date_type, '', '',
 532         'amount',   @money_type, '', '',
 533       ],
 534       'primary_key' => 'creditbillnum',
 535       'unique' => [],
 536       'index' => [ ['crednum'], ['invnum'] ],
 537     },
 538
 539     'cust_credit_bill_pkg' => {
 540       'columns' => [
 541         'creditbillpkgnum', 'serial', '',      '', '', '',
 542         'creditbillnum',       'int', '',      '', '', '',
 543         'billpkgnum',          'int', '',      '', '', '',
 544         'amount',            @money_type,          '', '',
 545         'setuprecur',      'varchar', '', $char_d, '', '',
 546         'sdate',   @date_type, '', '',
 547         'edate',   @date_type, '', '',
 548       ],
 549       'primary_key' => 'creditbillpkgnum',
 550       'unique'      => [],
 551       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 552     },
 553
 554     'cust_main' => {
 555       'columns' => [
 556         'custnum',  'serial',  '',     '', '', '',
 557         'agentnum', 'int',  '',     '', '', '',
 558         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 559 #        'titlenum', 'int',  'NULL',   '', '', '',
 560         'last',     'varchar', '',     $char_d, '', '',
 561 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 562         'first',    'varchar', '',     $char_d, '', '',
 563         'ss',       'varchar', 'NULL', 11, '', '',
 564         'stateid', 'varchar', 'NULL', $char_d, '', '',
 565         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 566         'birthdate' ,@date_type, '', '',
 567         'signupdate',@date_type, '', '',
 568         'company',  'varchar', 'NULL', $char_d, '', '',
 569         'address1', 'varchar', '',     $char_d, '', '',
 570         'address2', 'varchar', 'NULL', $char_d, '', '',
 571         'city',     'varchar', '',     $char_d, '', '',
 572         'county',   'varchar', 'NULL', $char_d, '', '',
 573         'state',    'varchar', 'NULL', $char_d, '', '',
 574         'zip',      'varchar', 'NULL', 10, '', '',
 575         'country',  'char', '',     2, '', '',
 576         'daytime',  'varchar', 'NULL', 20, '', '',
 577         'night',    'varchar', 'NULL', 20, '', '',
 578         'fax',      'varchar', 'NULL', 12, '', '',
 579         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 580 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 581         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 582         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 583         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 584         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 585         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 586         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 587         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 588         'ship_zip',      'varchar', 'NULL', 10, '', '',
 589         'ship_country',  'char', 'NULL', 2, '', '',
 590         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 591         'ship_night',    'varchar', 'NULL', 20, '', '',
 592         'ship_fax',      'varchar', 'NULL', 12, '', '',
 593         'payby',    'char', '',     4, '', '',
 594         'payinfo',  'varchar', 'NULL', 512, '', '',
 595         'paycvv',   'varchar', 'NULL', 512, '', '',
 596         'paymask', 'varchar', 'NULL', $char_d, '', '',
 597         #'paydate',  @date_type, '', '',
 598         'paydate',  'varchar', 'NULL', 10, '', '',
 599         'paystart_month', 'int', 'NULL', '', '', '',
 600         'paystart_year',  'int', 'NULL', '', '', '',
 601         'payissue', 'varchar', 'NULL', 2, '', '',
 602         'payname',  'varchar', 'NULL', $char_d, '', '',
 603         'paystate', 'varchar', 'NULL', $char_d, '', '',
 604         'paytype',  'varchar', 'NULL', $char_d, '', '',
 605         'payip',    'varchar', 'NULL', 15, '', '',
 606         'tax',      'char', 'NULL', 1, '', '',
 607         'otaker',   'varchar', '',    32, '', '',
 608         'refnum',   'int',  '',     '', '', '',
 609         'referral_custnum', 'int',  'NULL', '', '', '',
 610         'comments', 'text', 'NULL', '', '', '',
 611         'spool_cdr','char', 'NULL', 1, '', '',
 612         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 613       ],
 614       'primary_key' => 'custnum',
 615       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 616       #'index' => [ ['last'], ['company'] ],
 617       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 618                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 619                    [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 620                    [ 'ship_last' ], [ 'ship_company' ],
 621                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 622                    [ 'payby' ], [ 'paydate' ],
 623                  ],
 624     },
 625
 626     'cust_main_invoice' => {
 627       'columns' => [
 628         'destnum',  'serial',  '',     '', '', '',
 629         'custnum',  'int',  '',     '', '', '',
 630         'dest',     'varchar', '',  $char_d, '', '',
 631       ],
 632       'primary_key' => 'destnum',
 633       'unique' => [],
 634       'index' => [ ['custnum'], ],
 635     },
 636
 637     'cust_main_note' => {
 638       'columns' => [
 639         'notenum',  'serial',  '',     '', '', '',
 640         'custnum',  'int',  '',     '', '', '',
 641         '_date',    @date_type, '', '',
 642         'otaker',   'varchar', '',    32, '', '',
 643         'comments', 'text', 'NULL', '', '', '',
 644       ],
 645       'primary_key' => 'notenum',
 646       'unique' => [],
 647       'index' => [ [ 'custnum' ], [ '_date' ], ],
 648     },
 649
 650     'cust_main_county' => { #county+state+country are checked off the
 651                             #cust_main_county for validation and to provide
 652                             # a tax rate.
 653       'columns' => [
 654         'taxnum',   'serial',   '',    '', '', '',
 655         'state',    'varchar',  'NULL',    $char_d, '', '',
 656         'county',   'varchar',  'NULL',    $char_d, '', '',
 657         'country',  'char',  '', 2, '', '',
 658         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 659         'exempt_amount', @money_type, '', '',
 660         'tax',      'real',  '',    '', '', '', #tax %
 661         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 662         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 663         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 664       ],
 665       'primary_key' => 'taxnum',
 666       'unique' => [],
 667   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 668       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 669     },
 670
 671     'tax_rate'    => {
 672       'columns' => [
 673         'taxnum',       'serial',     '',      '', '', '',
 674         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 675         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 676         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 677         'taxclassnum', 'int',      '',      '', '', '',
 678         'effective_date', @date_type, '', '',
 679         'tax',        'real',  '',    '', '', '',        # tax %
 680         'excessrate', 'real',  'NULL','', '', '',        # second tax %
 681         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 682         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 683         'usetax',        'real',  'NULL',    '', '', '', # tax % when non-local
 684         'useexcessrate', 'real',  'NULL',    '', '', '', # second tax % when non-local
 685         'unittype',    'int',  'NULL', '', '', '',      # for fee
 686         'fee',         'real', 'NULL', '', '', '',      # amount tax per unit
 687         'excessfee',   'real', 'NULL', '', '', '',      # second amount tax per unit
 688         'feebase',     'real', 'NULL', '', '', '',      # units taxed at first rate
 689         'feemax',      'real', 'NULL', '', '', '',      # maximum number of unit taxed
 690         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 691         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 692         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 693         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 694         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 695         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 696         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 697         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 698         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 699       ],
 700       'primary_key' => 'taxnum',
 701       'unique' => [],
 702       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 703     },
 704
 705     'cust_tax_location' => {
 706       'columns' => [
 707         'custlocationnum', 'serial',  '',     '', '', '',
 708         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 709         'zip',             'char',    '',     5,  '', '',
 710         'state',           'char',    '',     2,  '', '',
 711         'plus4hi',         'char',    '',     4,  '', '',
 712         'plus4lo',         'char',    '',     4,  '', '',
 713         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 714         'geocode',         'varchar', '',    20,  '', '',
 715       ],
 716       'primary_key' => 'custlocationnum',
 717       'unique' => [],
 718       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 719     },
 720
 721     'tax_class' => {
 722       'columns' => [
 723         'taxclassnum',  'serial',  '',            '', '', '',
 724         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
 725         'taxclass',     'varchar', '',       $char_d, '', '',
 726         'description',  'varchar', '',     2*$char_d, '', '',
 727       ],
 728       'primary_key' => 'taxclassnum',
 729       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
 730       'index' => [],
 731     },
 732
 733     'cust_pay_pending' => {
 734       'columns' => [
 735         'paypendingnum','serial',      '',  '', '', '',
 736         'custnum',      'int',         '',  '', '', '',
 737         'paid',         @money_type,            '', '',
 738         '_date',        @date_type,             '', '',
 739         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
 740                                                         # be index into payby
 741                                                         # table eventually
 742         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
 743         'paymask',      'varchar', 'NULL', $char_d, '', '',
 744         'paydate',      'varchar', 'NULL', 10, '', '',
 745         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
 746         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 747
 748         'status',       'varchar',     '', $char_d, '', '',
 749         'statustext',   'text',    'NULL',  '', '', '',
 750         'gatewaynum',   'int',     'NULL',  '', '', '',
 751         #'cust_balance', @money_type,            '', '',
 752         'paynum',       'int',     'NULL',  '', '', '',
 753       ],
 754       'primary_key' => 'paypendingnum',
 755       'unique'      => [ [ 'payunique' ] ],
 756       'index'       => [ [ 'custnum' ], [ 'status' ], ],
 757     },
 758
 759     'cust_pay' => {
 760       'columns' => [
 761         'paynum',   'serial',    '',   '', '', '',
 762         'custnum',  'int',    '',   '', '', '',
 763         '_date',    @date_type, '', '',
 764         'paid',     @money_type, '', '',
 765         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
 766         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 767                                                  # index into payby table
 768                                                  # eventually
 769         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 770         'paymask', 'varchar', 'NULL', $char_d, '', '',
 771         'paydate',  'varchar', 'NULL', 10, '', '',
 772         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 773         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 774         'closed',    'char', 'NULL', 1, '', '',
 775       ],
 776       'primary_key' => 'paynum',
 777       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
 778       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 779     },
 780
 781     'cust_pay_void' => {
 782       'columns' => [
 783         'paynum',    'int',    '',   '', '', '',
 784         'custnum',   'int',    '',   '', '', '',
 785         'paid',      @money_type, '', '',
 786         '_date',     @date_type, '', '',
 787         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 788                                                   # index into payby table
 789                                                   # eventually
 790         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 791         'paymask', 'varchar', 'NULL', $char_d, '', '',
 792         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 793         'closed',    'char', 'NULL', 1, '', '',
 794         'void_date', @date_type, '', '',
 795         'reason',    'varchar',   'NULL', $char_d, '', '',
 796         'otaker',   'varchar', '', 32, '', '',
 797       ],
 798       'primary_key' => 'paynum',
 799       'unique' => [],
 800       'index' => [ [ 'custnum' ] ],
 801     },
 802
 803     'cust_bill_pay' => {
 804       'columns' => [
 805         'billpaynum', 'serial',     '',   '', '', '',
 806         'invnum',  'int',     '',   '', '', '',
 807         'paynum',  'int',     '',   '', '', '',
 808         'amount',  @money_type, '', '',
 809         '_date',   @date_type, '', '',
 810       ],
 811       'primary_key' => 'billpaynum',
 812       'unique' => [],
 813       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 814     },
 815
 816     'cust_bill_pay_batch' => {
 817       'columns' => [
 818         'billpaynum', 'serial',     '',   '', '', '',
 819         'invnum',  'int',     '',   '', '', '',
 820         'paybatchnum',  'int',     '',   '', '', '',
 821         'amount',  @money_type, '', '',
 822         '_date',   @date_type, '', '',
 823       ],
 824       'primary_key' => 'billpaynum',
 825       'unique' => [],
 826       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 827     },
 828
 829     'cust_bill_pay_pkg' => {
 830       'columns' => [
 831         'billpaypkgnum', 'serial', '', '', '', '',
 832         'billpaynum',       'int', '', '', '', '',
 833         'billpkgnum',       'int', '', '', '', '',
 834         'amount',         @money_type,     '', '',
 835         'setuprecur',      'varchar', '', $char_d, '', '',
 836         'sdate',   @date_type, '', '',
 837         'edate',   @date_type, '', '',
 838       ],
 839       'primary_key' => 'billpaypkgnum',
 840       'unique'      => [],
 841       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 842     },
 843
 844     'pay_batch' => { #batches of payments to an external processor
 845       'columns' => [
 846         'batchnum',   'serial',    '',   '', '', '',
 847         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 848         'status',     'char', 'NULL',     1, '', '',
 849         'download',   @date_type, '', '',
 850         'upload',     @date_type, '', '',
 851       ],
 852       'primary_key' => 'batchnum',
 853       'unique' => [],
 854       'index' => [],
 855     },
 856
 857     'cust_pay_batch' => { #what's this used for again?  list of customers
 858                           #in current CARD batch? (necessarily CARD?)
 859       'columns' => [
 860         'paybatchnum',   'serial',    '',   '', '', '',
 861         'batchnum',   'int',    '',   '', '', '',
 862         'invnum',   'int',    '',   '', '', '',
 863         'custnum',   'int',    '',   '', '', '',
 864         'last',     'varchar', '',     $char_d, '', '',
 865         'first',    'varchar', '',     $char_d, '', '',
 866         'address1', 'varchar', '',     $char_d, '', '',
 867         'address2', 'varchar', 'NULL', $char_d, '', '',
 868         'city',     'varchar', '',     $char_d, '', '',
 869         'state',    'varchar', 'NULL', $char_d, '', '',
 870         'zip',      'varchar', 'NULL', 10, '', '',
 871         'country',  'char', '',     2, '', '',
 872         #        'trancode', 'int', '', '', '', ''
 873         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 874         'payinfo',  'varchar', '',     512, '', '',
 875         #'exp',      @date_type, '', ''
 876         'exp',      'varchar', 'NULL',     11, '', '',
 877         'payname',  'varchar', 'NULL', $char_d, '', '',
 878         'amount',   @money_type, '', '',
 879         'status',   'varchar', 'NULL',     $char_d, '', '',
 880       ],
 881       'primary_key' => 'paybatchnum',
 882       'unique' => [],
 883       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 884     },
 885
 886     'cust_pkg' => {
 887       'columns' => [
 888         'pkgnum',         'serial',    '',   '', '', '',
 889         'custnum',        'int',    '',   '', '', '',
 890         'pkgpart',        'int',    '',   '', '', '',
 891         'otaker',         'varchar', '', 32, '', '',
 892         'setup',          @date_type, '', '',
 893         'bill',           @date_type, '', '',
 894         'last_bill',      @date_type, '', '',
 895         'susp',           @date_type, '', '',
 896         'adjourn',        @date_type, '', '',
 897         'cancel',         @date_type, '', '',
 898         'expire',         @date_type, '', '',
 899         'change_date',    @date_type, '', '',
 900         'change_pkgnum',  'int', 'NULL', '', '', '',
 901         'change_pkgpart', 'int', 'NULL', '', '', '',
 902         'manual_flag',    'char', 'NULL', 1, '', '',
 903       ],
 904       'primary_key' => 'pkgnum',
 905       'unique' => [],
 906       'index' => [ ['custnum'], ['pkgpart'],
 907                    ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
 908                    ['expire'], ['cancel'],
 909                    ['change_date'],
 910                  ],
 911     },
 912
 913     'cust_pkg_option' => {
 914       'columns' => [
 915         'optionnum', 'serial', '', '', '', '',
 916         'pkgnum', 'int', '', '', '', '',
 917         'optionname', 'varchar', '', $char_d, '', '',
 918         'optionvalue', 'text', 'NULL', '', '', '',
 919       ],
 920       'primary_key' => 'optionnum',
 921       'unique'      => [],
 922       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
 923     },
 924
 925     'cust_pkg_reason' => {
 926       'columns' => [
 927         'num',      'serial',    '',   '', '', '',
 928         'pkgnum',   'int',    '',   '', '', '',
 929         'reasonnum','int',    '',   '', '', '',
 930         'otaker',   'varchar', '', 32, '', '',
 931         'date',     @date_type, '', '',
 932       ],
 933       'primary_key' => 'num',
 934       'unique' => [],
 935       'index' => [],
 936     },
 937
 938     'cust_refund' => {
 939       'columns' => [
 940         'refundnum',    'serial',    '',   '', '', '',
 941         'custnum',  'int',    '',   '', '', '',
 942         '_date',        @date_type, '', '',
 943         'refund',       @money_type, '', '',
 944         'otaker',       'varchar',   '',   32, '', '',
 945         'reason',       'varchar',   '',   $char_d, '', '',
 946         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 947                                                      # be index into payby
 948                                                      # table eventually
 949         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
 950         'paymask', 'varchar', 'NULL', $char_d, '', '',
 951         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 952         'closed',    'char', 'NULL', 1, '', '',
 953       ],
 954       'primary_key' => 'refundnum',
 955       'unique' => [],
 956       'index' => [ ['custnum'], ['_date'] ],
 957     },
 958
 959     'cust_credit_refund' => {
 960       'columns' => [
 961         'creditrefundnum', 'serial',     '',   '', '', '',
 962         'crednum',  'int',     '',   '', '', '',
 963         'refundnum',  'int',     '',   '', '', '',
 964         'amount',  @money_type, '', '',
 965         '_date',   @date_type, '', '',
 966       ],
 967       'primary_key' => 'creditrefundnum',
 968       'unique' => [],
 969       'index' => [ ['crednum'], ['refundnum'] ],
 970     },
 971
 972
 973     'cust_svc' => {
 974       'columns' => [
 975         'svcnum',    'serial',    '',   '', '', '',
 976         'pkgnum',    'int',    'NULL',   '', '', '',
 977         'svcpart',   'int',    '',   '', '', '',
 978         'overlimit', @date_type, '', '',
 979       ],
 980       'primary_key' => 'svcnum',
 981       'unique' => [],
 982       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 983     },
 984
 985     'part_pkg' => {
 986       'columns' => [
 987         'pkgpart',       'serial',    '',   '', '', '',
 988         'pkg',           'varchar',   '',   $char_d, '', '',
 989         'comment',       'varchar',   '',   $char_d, '', '',
 990         'promo_code',    'varchar', 'NULL', $char_d, '', '',
 991         'setup',         @perl_type, '', '',
 992         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
 993         'recur',         @perl_type, '', '',
 994         'setuptax',      'char', 'NULL', 1, '', '',
 995         'recurtax',      'char', 'NULL', 1, '', '',
 996         'plan',          'varchar', 'NULL', $char_d, '', '',
 997         'plandata',      'text', 'NULL', '', '', '',
 998         'disabled',      'char', 'NULL', 1, '', '',
 999         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1000         'classnum',      'int',     'NULL', '', '', '',
1001         'taxproductnum', 'int',     'NULL', '', '', '',
1002         'pay_weight',    'real',    'NULL', '', '', '',
1003         'credit_weight', 'real',    'NULL', '', '', '',
1004         'agentnum',      'int',     'NULL', '', '', '',
1005
1006       ],
1007       'primary_key' => 'pkgpart',
1008       'unique' => [],
1009       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1010     },
1011
1012     'part_pkg_link' => {
1013       'columns' => [
1014         'pkglinknum',  'serial',  '',      '', '', '',
1015         'src_pkgpart', 'int',     '',      '', '', '',
1016         'dst_pkgpart', 'int',     '',      '', '', '',
1017         'link_type',   'varchar', '', $char_d, '', '',
1018       ],
1019       'primary_key' => 'pkglinknum',
1020       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1021       'index'  => [ [ 'src_pkgpart' ] ],
1022     },
1023
1024     'part_pkg_taxclass' => {
1025       'columns' => [
1026         'taxclassnum',  'serial', '',       '', '', '',
1027         'taxclass',     'varchar', '', $char_d, '', '',
1028       ],
1029       'primary_key' => 'taxclassnum',
1030       'unique'      => [ [ 'taxclass' ] ],
1031       'index'       => [],
1032     },
1033
1034     'part_pkg_taxproduct' => {
1035       'columns' => [
1036         'taxproductnum', 'serial',      '',        '', '', '',
1037         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1038         'taxproduct',    'varchar',     '',   $char_d, '', '',
1039         'description',   'varchar',     '', 2*$char_d, '', '',
1040       ],
1041       'primary_key' => 'taxproductnum',
1042       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1043       'index'       => [],
1044     },
1045
1046     'part_pkg_taxrate' => {
1047       'columns' => [
1048         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1049         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1050         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1051         'taxproductnum', 'int',  '',     '',       '', '',
1052         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1053         'county',           'varchar', 'NULL', $char_d, '', '',
1054         'state',            'varchar', 'NULL', $char_d, '', '',
1055         'local',            'varchar', 'NULL', $char_d, '', '',
1056         'country',          'char',    'NULL', 2,       '', '',
1057         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1058         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1059         'taxclassnum',      'int',     'NULL', '',      '', '',
1060         'effdate',          @date_type, '', '',
1061         'taxable',          'char',    'NULL', 1,       '', '',
1062       ],
1063       'primary_key' => 'pkgtaxratenum',
1064       'unique' => [],
1065       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1066     },
1067
1068     'part_pkg_taxoverride' => {
1069       'columns' => [
1070         'taxoverridenum', 'serial', '', '', '', '',
1071         'pkgpart',        'serial', '', '', '', '',
1072         'taxclassnum',    'serial', '', '', '', '',
1073       ],
1074       'primary_key' => 'taxoverridenum',
1075       'unique' => [],
1076       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1077     },
1078
1079 #    'part_title' => {
1080 #      'columns' => [
1081 #        'titlenum',   'int',    '',   '',
1082 #        'title',      'varchar',   '',   $char_d,
1083 #      ],
1084 #      'primary_key' => 'titlenum',
1085 #      'unique' => [ [] ],
1086 #      'index' => [ [] ],
1087 #    },
1088
1089     'pkg_svc' => {
1090       'columns' => [
1091         'pkgsvcnum',  'serial', '',  '', '', '',
1092         'pkgpart',    'int',    '',   '', '', '',
1093         'svcpart',    'int',    '',   '', '', '',
1094         'quantity',   'int',    '',   '', '', '',
1095         'primary_svc','char', 'NULL',  1, '', '',
1096       ],
1097       'primary_key' => 'pkgsvcnum',
1098       'unique' => [ ['pkgpart', 'svcpart'] ],
1099       'index' => [ ['pkgpart'] ],
1100     },
1101
1102     'part_referral' => {
1103       'columns' => [
1104         'refnum',   'serial',     '',        '', '', '',
1105         'referral', 'varchar',    '',   $char_d, '', '',
1106         'disabled', 'char',   'NULL',         1, '', '',
1107         'agentnum', 'int',    'NULL',        '', '', '',
1108       ],
1109       'primary_key' => 'refnum',
1110       'unique' => [],
1111       'index' => [ ['disabled'], ['agentnum'], ],
1112     },
1113
1114     'part_svc' => {
1115       'columns' => [
1116         'svcpart',    'serial',    '',   '', '', '',
1117         'svc',        'varchar',   '',   $char_d, '', '',
1118         'svcdb',      'varchar',   '',   $char_d, '', '',
1119         'disabled',   'char',  'NULL',   1, '', '',
1120       ],
1121       'primary_key' => 'svcpart',
1122       'unique' => [],
1123       'index' => [ [ 'disabled' ] ],
1124     },
1125
1126     'part_svc_column' => {
1127       'columns' => [
1128         'columnnum',   'serial',         '', '', '', '',
1129         'svcpart',     'int',         '', '', '', '',
1130         'columnname',  'varchar',     '', 64, '', '',
1131         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1132         'columnflag',  'char',    'NULL', 1, '', '',
1133       ],
1134       'primary_key' => 'columnnum',
1135       'unique' => [ [ 'svcpart', 'columnname' ] ],
1136       'index' => [ [ 'svcpart' ] ],
1137     },
1138
1139     #(this should be renamed to part_pop)
1140     'svc_acct_pop' => {
1141       'columns' => [
1142         'popnum',    'serial',    '',   '', '', '',
1143         'city',      'varchar',   '',   $char_d, '', '',
1144         'state',     'varchar',   '',   $char_d, '', '',
1145         'ac',        'char',   '',   3, '', '',
1146         'exch',      'char',   '',   3, '', '',
1147         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1148       ],
1149       'primary_key' => 'popnum',
1150       'unique' => [],
1151       'index' => [ [ 'state' ] ],
1152     },
1153
1154     'part_pop_local' => {
1155       'columns' => [
1156         'localnum',  'serial',     '',     '', '', '',
1157         'popnum',    'int',     '',     '', '', '',
1158         'city',      'varchar', 'NULL', $char_d, '', '',
1159         'state',     'char',    'NULL', 2, '', '',
1160         'npa',       'char',    '',     3, '', '',
1161         'nxx',       'char',    '',     3, '', '',
1162       ],
1163       'primary_key' => 'localnum',
1164       'unique' => [],
1165       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1166     },
1167
1168     'svc_acct' => {
1169       'columns' => [
1170         'svcnum',    'int',    '',   '', '', '',
1171         'username',  'varchar',   '',   $username_len, '', '',
1172         '_password', 'varchar',   '',  512, '', '',
1173         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1174         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1175         'popnum',    'int',    'NULL',   '', '', '',
1176         'uid',       'int', 'NULL',   '', '', '',
1177         'gid',       'int', 'NULL',   '', '', '',
1178         'finger',    'varchar',   'NULL',   $char_d, '', '',
1179         'dir',       'varchar',   'NULL',   $char_d, '', '',
1180         'shell',     'varchar',   'NULL',   $char_d, '', '',
1181         'quota',     'varchar',   'NULL',   $char_d, '', '',
1182         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1183         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1184         'seconds_threshold',   'int', 'NULL',   '', '', '',
1185         'upbytes',   'bigint', 'NULL',   '', '', '',
1186         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1187         'downbytes', 'bigint', 'NULL',   '', '', '',
1188         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1189         'totalbytes','bigint', 'NULL',   '', '', '',
1190         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1191         'domsvc',    'int', '',   '', '', '',
1192         'last_login',  @date_type, '', '',
1193         'last_logout', @date_type, '', '',
1194       ],
1195       'primary_key' => 'svcnum',
1196       #'unique' => [ [ 'username', 'domsvc' ] ],
1197       'unique' => [],
1198       'index' => [ ['username'], ['domsvc'] ],
1199     },
1200
1201     'acct_rt_transaction' => {
1202       'columns' => [
1203         'svcrtid',   'int',    '',   '', '', '',
1204         'svcnum',    'int',    '',   '', '', '',
1205         'transaction_id',       'int', '',   '', '', '',
1206         '_date',   @date_type, '', '',
1207         'seconds',   'int', '',   '', '', '', #uhhhh
1208         'support',   'int', '',   '', '', '',
1209       ],
1210       'primary_key' => 'svcrtid',
1211       'unique' => [],
1212       'index' => [ ['svcnum', 'transaction_id'] ],
1213     },
1214
1215     #'svc_charge' => {
1216     #  'columns' => [
1217     #    'svcnum',    'int',    '',   '',
1218     #    'amount',    @money_type,
1219     #  ],
1220     #  'primary_key' => 'svcnum',
1221     #  'unique' => [ [] ],
1222     #  'index' => [ [] ],
1223     #},
1224
1225     'svc_domain' => {
1226       'columns' => [
1227         'svcnum',           'int',    '',        '', '', '',
1228         'domain',       'varchar',    '',   $char_d, '', '',
1229         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1230         'catchall',         'int', 'NULL',       '', '', '',
1231         'parent_svcnum',    'int', 'NULL',       '', '', '',
1232         'registrarnum',     'int', 'NULL',       '', '', '',
1233         'registrarkey', 'varchar', 'NULL',      512, '', '',
1234         'setup_date',  @date_type, '', '',
1235         'renewal_interval', 'int', 'NULL',       '', '', '',
1236         'expiration_date', @date_type, '', '',
1237       ],
1238       'primary_key' => 'svcnum',
1239       'unique' => [ ],
1240       'index' => [ ['domain'] ],
1241     },
1242
1243     'domain_record' => {
1244       'columns' => [
1245         'recnum',    'serial',     '',  '', '', '',
1246         'svcnum',    'int',     '',  '', '', '',
1247         'reczone',   'varchar', '',  255, '', '',
1248         'recaf',     'char',    '',  2, '', '',
1249         'rectype',   'varchar',    '',  5, '', '',
1250         'recdata',   'varchar', '',  255, '', '',
1251       ],
1252       'primary_key' => 'recnum',
1253       'unique'      => [],
1254       'index'       => [ ['svcnum'] ],
1255     },
1256
1257     'registrar' => {
1258       'columns' => [
1259         'registrarnum',   'serial', '',      '', '', '',
1260         'registrarname', 'varchar', '', $char_d, '', '',
1261       ],
1262       'primary_key' => 'registrarnum',
1263       'unique'      => [],
1264       'index'       => [],
1265     },
1266
1267     'svc_forward' => {
1268       'columns' => [
1269         'svcnum',   'int',            '',   '', '', '',
1270         'srcsvc',   'int',        'NULL',   '', '', '',
1271         'src',      'varchar',    'NULL',  255, '', '',
1272         'dstsvc',   'int',        'NULL',   '', '', '',
1273         'dst',      'varchar',    'NULL',  255, '', '',
1274       ],
1275       'primary_key' => 'svcnum',
1276       'unique'      => [],
1277       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1278     },
1279
1280     'svc_www' => {
1281       'columns' => [
1282         'svcnum',   'int',      '',  '', '', '',
1283         'recnum',   'int',      '',  '', '', '',
1284         'usersvc',  'int',  'NULL',  '', '', '',
1285         'config',   'text', 'NULL',  '', '', '',
1286       ],
1287       'primary_key' => 'svcnum',
1288       'unique'      => [],
1289       'index'       => [],
1290     },
1291
1292     #'svc_wo' => {
1293     #  'columns' => [
1294     #    'svcnum',    'int',    '',   '',
1295     #    'svcnum',    'int',    '',   '',
1296     #    'svcnum',    'int',    '',   '',
1297     #    'worker',    'varchar',   '',   $char_d,
1298     #    '_date',     @date_type,
1299     #  ],
1300     #  'primary_key' => 'svcnum',
1301     #  'unique' => [ [] ],
1302     #  'index' => [ [] ],
1303     #},
1304
1305     'prepay_credit' => {
1306       'columns' => [
1307         'prepaynum',   'serial',     '',   '', '', '',
1308         'identifier',  'varchar', '', $char_d, '', '',
1309         'amount',      @money_type, '', '',
1310         'seconds',     'int',     'NULL', '', '', '',
1311         'upbytes',     'bigint',     'NULL', '', '', '',
1312         'downbytes',   'bigint',     'NULL', '', '', '',
1313         'totalbytes',  'bigint',     'NULL', '', '', '',
1314         'agentnum',    'int',     'NULL', '', '', '',
1315       ],
1316       'primary_key' => 'prepaynum',
1317       'unique'      => [ ['identifier'] ],
1318       'index'       => [],
1319     },
1320
1321     'port' => {
1322       'columns' => [
1323         'portnum',  'serial',     '',   '', '', '',
1324         'ip',       'varchar', 'NULL', 15, '', '',
1325         'nasport',  'int',     'NULL', '', '', '',
1326         'nasnum',   'int',     '',   '', '', '',
1327       ],
1328       'primary_key' => 'portnum',
1329       'unique'      => [],
1330       'index'       => [],
1331     },
1332
1333     'nas' => {
1334       'columns' => [
1335         'nasnum',   'serial',     '',    '', '', '',
1336         'nas',      'varchar', '',    $char_d, '', '',
1337         'nasip',    'varchar', '',    15, '', '',
1338         'nasfqdn',  'varchar', '',    $char_d, '', '',
1339         'last',     'int',     '',    '', '', '',
1340       ],
1341       'primary_key' => 'nasnum',
1342       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1343       'index'       => [ [ 'last' ] ],
1344     },
1345
1346 #    'session' => {
1347 #      'columns' => [
1348 #        'sessionnum', 'serial',       '',   '', '', '',
1349 #        'portnum',    'int',       '',   '', '', '',
1350 #        'svcnum',     'int',       '',   '', '', '',
1351 #        'login',      @date_type, '', '',
1352 #        'logout',     @date_type, '', '',
1353 #      ],
1354 #      'primary_key' => 'sessionnum',
1355 #      'unique'      => [],
1356 #      'index'       => [ [ 'portnum' ] ],
1357 #    },
1358
1359     'queue' => {
1360       'columns' => [
1361         'jobnum', 'serial', '', '', '', '',
1362         'job', 'text', '', '', '', '',
1363         '_date', 'int', '', '', '', '',
1364         'status', 'varchar', '', $char_d, '', '',
1365         'statustext', 'text', 'NULL', '', '', '',
1366         'svcnum', 'int', 'NULL', '', '', '',
1367         'secure',  'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1368                                               #     w/private key
1369       ],
1370       'primary_key' => 'jobnum',
1371       'unique'      => [],
1372       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
1373     },
1374
1375     'queue_arg' => {
1376       'columns' => [
1377         'argnum', 'serial', '', '', '', '',
1378         'jobnum', 'int', '', '', '', '',
1379         'arg', 'text', 'NULL', '', '', '',
1380       ],
1381       'primary_key' => 'argnum',
1382       'unique'      => [],
1383       'index'       => [ [ 'jobnum' ] ],
1384     },
1385
1386     'queue_depend' => {
1387       'columns' => [
1388         'dependnum', 'serial', '', '', '', '',
1389         'jobnum', 'int', '', '', '', '',
1390         'depend_jobnum', 'int', '', '', '', '',
1391       ],
1392       'primary_key' => 'dependnum',
1393       'unique'      => [],
1394       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1395     },
1396
1397     'export_svc' => {
1398       'columns' => [
1399         'exportsvcnum' => 'serial', '', '', '', '',
1400         'exportnum'    => 'int', '', '', '', '',
1401         'svcpart'      => 'int', '', '', '', '',
1402       ],
1403       'primary_key' => 'exportsvcnum',
1404       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1405       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1406     },
1407
1408     'part_export' => {
1409       'columns' => [
1410         'exportnum', 'serial', '', '', '', '',
1411         'machine', 'varchar', '', $char_d, '', '',
1412         'exporttype', 'varchar', '', $char_d, '', '',
1413         'nodomain',     'char', 'NULL', 1, '', '',
1414       ],
1415       'primary_key' => 'exportnum',
1416       'unique'      => [],
1417       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1418     },
1419
1420     'part_export_option' => {
1421       'columns' => [
1422         'optionnum', 'serial', '', '', '', '',
1423         'exportnum', 'int', '', '', '', '',
1424         'optionname', 'varchar', '', $char_d, '', '',
1425         'optionvalue', 'text', 'NULL', '', '', '',
1426       ],
1427       'primary_key' => 'optionnum',
1428       'unique'      => [],
1429       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1430     },
1431
1432     'radius_usergroup' => {
1433       'columns' => [
1434         'usergroupnum', 'serial', '', '', '', '',
1435         'svcnum',       'int', '', '', '', '',
1436         'groupname',    'varchar', '', $char_d, '', '',
1437       ],
1438       'primary_key' => 'usergroupnum',
1439       'unique'      => [],
1440       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1441     },
1442
1443     'msgcat' => {
1444       'columns' => [
1445         'msgnum', 'serial', '', '', '', '',
1446         'msgcode', 'varchar', '', $char_d, '', '',
1447         'locale', 'varchar', '', 16, '', '',
1448         'msg', 'text', '', '', '', '',
1449       ],
1450       'primary_key' => 'msgnum',
1451       'unique'      => [ [ 'msgcode', 'locale' ] ],
1452       'index'       => [],
1453     },
1454
1455     'cust_tax_exempt' => {
1456       'columns' => [
1457         'exemptnum', 'serial', '', '', '', '',
1458         'custnum',   'int', '', '', '', '',
1459         'taxnum',    'int', '', '', '', '',
1460         'year',      'int', '', '', '', '',
1461         'month',     'int', '', '', '', '',
1462         'amount',   @money_type, '', '',
1463       ],
1464       'primary_key' => 'exemptnum',
1465       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1466       'index'       => [],
1467     },
1468
1469     'cust_tax_exempt_pkg' => {
1470       'columns' => [
1471         'exemptpkgnum',  'serial', '', '', '', '',
1472         #'custnum',      'int', '', '', '', ''
1473         'billpkgnum',   'int', '', '', '', '',
1474         'taxnum',       'int', '', '', '', '',
1475         'year',         'int', '', '', '', '',
1476         'month',        'int', '', '', '', '',
1477         'amount',       @money_type, '', '',
1478       ],
1479       'primary_key' => 'exemptpkgnum',
1480       'unique' => [],
1481       'index'  => [ [ 'taxnum', 'year', 'month' ],
1482                     [ 'billpkgnum' ],
1483                     [ 'taxnum' ]
1484                   ],
1485     },
1486
1487     'router' => {
1488       'columns' => [
1489         'routernum', 'serial', '', '', '', '',
1490         'routername', 'varchar', '', $char_d, '', '',
1491         'svcnum', 'int', 'NULL', '', '', '',
1492         'agentnum',   'int', 'NULL', '', '', '',
1493       ],
1494       'primary_key' => 'routernum',
1495       'unique'      => [],
1496       'index'       => [],
1497     },
1498
1499     'part_svc_router' => {
1500       'columns' => [
1501         'svcrouternum', 'serial', '', '', '', '',
1502         'svcpart', 'int', '', '', '', '',
1503         'routernum', 'int', '', '', '', '',
1504       ],
1505       'primary_key' => 'svcrouternum',
1506       'unique'      => [],
1507       'index'       => [],
1508     },
1509
1510     'addr_block' => {
1511       'columns' => [
1512         'blocknum', 'serial', '', '', '', '',
1513         'routernum', 'int', '', '', '', '',
1514         'ip_gateway', 'varchar', '', 15, '', '',
1515         'ip_netmask', 'int', '', '', '', '',
1516         'agentnum',   'int', 'NULL', '', '', '',
1517       ],
1518       'primary_key' => 'blocknum',
1519       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1520       'index'       => [],
1521     },
1522
1523     'svc_broadband' => {
1524       'columns' => [
1525         'svcnum', 'int', '', '', '', '',
1526         'description', 'varchar', 'NULL', $char_d, '', '',
1527         'blocknum', 'int', '', '', '', '',
1528         'speed_up', 'int', '', '', '', '',
1529         'speed_down', 'int', '', '', '', '',
1530         'ip_addr', 'varchar', '', 15, '', '',
1531         'mac_addr', 'varchar', 'NULL', 12, '', '',
1532         'authkey',  'varchar', 'NULL', 32, '', '',
1533         'latitude', 'decimal', 'NULL', '', '', '',
1534         'longitude', 'decimal', 'NULL', '', '', '',
1535         'altitude', 'decimal', 'NULL', '', '', '',
1536         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1537       ],
1538       'primary_key' => 'svcnum',
1539       'unique'      => [],
1540       'index'       => [],
1541     },
1542
1543     'part_virtual_field' => {
1544       'columns' => [
1545         'vfieldpart', 'serial', '', '', '', '',
1546         'dbtable', 'varchar', '', 32, '', '',
1547         'name', 'varchar', '', 32, '', '',
1548         'check_block', 'text', 'NULL', '', '', '',
1549         'length', 'int', 'NULL', '', '', '',
1550         'list_source', 'text', 'NULL', '', '', '',
1551         'label', 'varchar', 'NULL', 80, '', '',
1552       ],
1553       'primary_key' => 'vfieldpart',
1554       'unique' => [],
1555       'index' => [],
1556     },
1557
1558     'virtual_field' => {
1559       'columns' => [
1560         'vfieldnum', 'serial', '', '', '', '',
1561         'recnum', 'int', '', '', '', '',
1562         'vfieldpart', 'int', '', '', '', '',
1563         'value', 'varchar', '', 128, '', '',
1564       ],
1565       'primary_key' => 'vfieldnum',
1566       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1567       'index' => [],
1568     },
1569
1570     'acct_snarf' => {
1571       'columns' => [
1572         'snarfnum',  'int', '', '', '', '',
1573         'svcnum',    'int', '', '', '', '',
1574         'machine',   'varchar', '', 255, '', '',
1575         'protocol',  'varchar', '', $char_d, '', '',
1576         'username',  'varchar', '', $char_d, '', '',
1577         '_password', 'varchar', '', $char_d, '', '',
1578       ],
1579       'primary_key' => 'snarfnum',
1580       'unique' => [],
1581       'index'  => [ [ 'svcnum' ] ],
1582     },
1583
1584     'svc_external' => {
1585       'columns' => [
1586         'svcnum', 'int', '', '', '', '',
1587         'id',     'int', 'NULL', '', '', '',
1588         'title',  'varchar', 'NULL', $char_d, '', '',
1589       ],
1590       'primary_key' => 'svcnum',
1591       'unique'      => [],
1592       'index'       => [],
1593     },
1594
1595     'cust_pay_refund' => {
1596       'columns' => [
1597         'payrefundnum', 'serial', '', '', '', '',
1598         'paynum',  'int', '', '', '', '',
1599         'refundnum',  'int', '', '', '', '',
1600         '_date',    @date_type, '', '',
1601         'amount',   @money_type, '', '',
1602       ],
1603       'primary_key' => 'payrefundnum',
1604       'unique' => [],
1605       'index' => [ ['paynum'], ['refundnum'] ],
1606     },
1607
1608     'part_pkg_option' => {
1609       'columns' => [
1610         'optionnum', 'serial', '', '', '', '',
1611         'pkgpart', 'int', '', '', '', '',
1612         'optionname', 'varchar', '', $char_d, '', '',
1613         'optionvalue', 'text', 'NULL', '', '', '',
1614       ],
1615       'primary_key' => 'optionnum',
1616       'unique'      => [],
1617       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1618     },
1619
1620     'rate' => {
1621       'columns' => [
1622         'ratenum',  'serial', '', '', '', '',
1623         'ratename', 'varchar', '', $char_d, '', '',
1624       ],
1625       'primary_key' => 'ratenum',
1626       'unique'      => [],
1627       'index'       => [],
1628     },
1629
1630     'rate_detail' => {
1631       'columns' => [
1632         'ratedetailnum',   'serial', '', '', '', '',
1633         'ratenum',         'int',     '', '', '', '',
1634         'orig_regionnum',  'int', 'NULL', '', '', '',
1635         'dest_regionnum',  'int',     '', '', '', '',
1636         'min_included',    'int',     '', '', '', '',
1637         #'min_charge',      @money_type, '', '',
1638         'min_charge',      'decimal', '', '10,5', '', '',
1639         'sec_granularity', 'int',     '', '', '', '',
1640         #time period (link to table of periods)?
1641       ],
1642       'primary_key' => 'ratedetailnum',
1643       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1644       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1645     },
1646
1647     'rate_region' => {
1648       'columns' => [
1649         'regionnum',   'serial',      '', '', '', '',
1650         'regionname',  'varchar',     '', $char_d, '', '',
1651       ],
1652       'primary_key' => 'regionnum',
1653       'unique'      => [],
1654       'index'       => [],
1655     },
1656
1657     'rate_prefix' => {
1658       'columns' => [
1659         'prefixnum',   'serial',    '', '', '', '',
1660         'regionnum',   'int',       '', '',, '', '',
1661         'countrycode', 'varchar',     '', 3, '', '',
1662         'npa',         'varchar', 'NULL', 6, '', '',
1663         'nxx',         'varchar', 'NULL', 3, '', '',
1664       ],
1665       'primary_key' => 'prefixnum',
1666       'unique'      => [],
1667       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1668     },
1669
1670     'reg_code' => {
1671       'columns' => [
1672         'codenum',   'serial',    '', '', '', '',
1673         'code',      'varchar',   '', $char_d, '', '',
1674         'agentnum',  'int',       '', '', '', '',
1675       ],
1676       'primary_key' => 'codenum',
1677       'unique'      => [ [ 'agentnum', 'code' ] ],
1678       'index'       => [ [ 'agentnum' ] ],
1679     },
1680
1681     'reg_code_pkg' => {
1682       'columns' => [
1683         'codepkgnum', 'serial', '', '', '', '',
1684         'codenum',   'int',    '', '', '', '',
1685         'pkgpart',   'int',    '', '', '', '',
1686       ],
1687       'primary_key' => 'codepkgnum',
1688       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1689       'index'       => [ [ 'codenum' ] ],
1690     },
1691
1692     'clientapi_session' => {
1693       'columns' => [
1694         'sessionnum',  'serial',  '', '', '', '',
1695         'sessionid',  'varchar',  '', $char_d, '', '',
1696         'namespace',  'varchar',  '', $char_d, '', '',
1697       ],
1698       'primary_key' => 'sessionnum',
1699       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1700       'index'       => [],
1701     },
1702
1703     'clientapi_session_field' => {
1704       'columns' => [
1705         'fieldnum',    'serial',     '', '', '', '',
1706         'sessionnum',     'int',     '', '', '', '',
1707         'fieldname',  'varchar',     '', $char_d, '', '',
1708         'fieldvalue',    'text', 'NULL', '', '', '',
1709       ],
1710       'primary_key' => 'fieldnum',
1711       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1712       'index'       => [],
1713     },
1714
1715     'payment_gateway' => {
1716       'columns' => [
1717         'gatewaynum',       'serial',   '',     '', '', '',
1718         'gateway_module',   'varchar',  '',     $char_d, '', '',
1719         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1720         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1721         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1722         'disabled',   'char',  'NULL',   1, '', '',
1723       ],
1724       'primary_key' => 'gatewaynum',
1725       'unique' => [],
1726       'index'  => [ [ 'disabled' ] ],
1727     },
1728
1729     'payment_gateway_option' => {
1730       'columns' => [
1731         'optionnum',   'serial',  '',     '', '', '',
1732         'gatewaynum',  'int',     '',     '', '', '',
1733         'optionname',  'varchar', '',     $char_d, '', '',
1734         'optionvalue', 'text',    'NULL', '', '', '',
1735       ],
1736       'primary_key' => 'optionnum',
1737       'unique'      => [],
1738       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1739     },
1740
1741     'agent_payment_gateway' => {
1742       'columns' => [
1743         'agentgatewaynum', 'serial', '', '', '', '',
1744         'agentnum',        'int', '', '', '', '',
1745         'gatewaynum',      'int', '', '', '', '',
1746         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1747         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1748       ],
1749       'primary_key' => 'agentgatewaynum',
1750       'unique'      => [],
1751       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1752     },
1753
1754     'banned_pay' => {
1755       'columns' => [
1756         'bannum',  'serial',   '',     '', '', '',
1757         'payby',   'char',     '',       4, '', '',
1758         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1759         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1760         '_date',   @date_type, '', '',
1761         'otaker',  'varchar',  '',     32, '', '',
1762         'reason',  'varchar',  'NULL', $char_d, '', '',
1763       ],
1764       'primary_key' => 'bannum',
1765       'unique'      => [ [ 'payby', 'payinfo' ] ],
1766       'index'       => [],
1767     },
1768
1769     'pkg_class' => {
1770       'columns' => [
1771         'classnum',   'serial',  '', '', '', '',
1772         'classname',  'varchar', '', $char_d, '', '',
1773         'disabled',     'char', 'NULL',   1, '', '',
1774       ],
1775       'primary_key' => 'classnum',
1776       'unique' => [],
1777       'index' => [ ['disabled'] ],
1778     },
1779
1780     'cdr' => {
1781       'columns' => [
1782         # qw( name type null length default local );
1783
1784         ###
1785         #asterisk fields
1786         ###
1787
1788         'acctid',   'bigserial',  '', '', '', '',
1789         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1790         'calldate', 'timestamp',   '',      '', \'now()', '',
1791         'clid',        'varchar',  '', $char_d, \"''", '',
1792         'src',         'varchar',  '', $char_d, \"''", '',
1793         'dst',         'varchar',  '', $char_d, \"''", '',
1794         'dcontext',    'varchar',  '', $char_d, \"''", '',
1795         'channel',     'varchar',  '', $char_d, \"''", '',
1796         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1797         'lastapp',     'varchar',  '', $char_d, \"''", '',
1798         'lastdata',    'varchar',  '', $char_d, \"''", '',
1799
1800         #these don't seem to be logged by most of the SQL cdr_* modules
1801         #except tds under sql-illegal names, so;
1802         # ... don't rely on them for rating?
1803         # and, what they hey, i went ahead and changed the names and data types
1804         # to freeside-style dates...
1805           #'start',  'timestamp', 'NULL',  '',    '', '',
1806           #'answer', 'timestamp', 'NULL',  '',    '', '',
1807           #'end',    'timestamp', 'NULL',  '',    '', '',
1808         'startdate',  @date_type, '', '',
1809         'answerdate', @date_type, '', '',
1810         'enddate',    @date_type, '', '',
1811         #
1812
1813         'duration',    'int',      '',      '',     0, '',
1814         'billsec',     'int',      '',      '',     0, '',
1815         'disposition', 'varchar',  '',      45, \"''", '',
1816         'amaflags',    'int',      '',      '',     0, '',
1817         'accountcode', 'varchar',  '',      20, \"''", '',
1818         'uniqueid',    'varchar',  '',      32, \"''", '',
1819         'userfield',   'varchar',  '',     255, \"''", '',
1820
1821         ###
1822         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1823         # defaults
1824         ###
1825
1826         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1827         'cdrtypenum',              'int', 'NULL',      '', '', '',
1828
1829         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1830
1831         'upstream_currency',      'char', 'NULL',       3, '', '',
1832         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1833         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1834
1835         # how it was rated internally...
1836         'ratedetailnum',           'int', 'NULL',      '', '', '',
1837         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1838
1839         'distance',            'decimal', 'NULL',      '', '', '',
1840         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1841
1842         #cdr_calltype: the big list in appendix 2
1843         'calltypenum',             'int', 'NULL',      '', '', '',
1844
1845         'description',         'varchar', 'NULL', $char_d, '', '',
1846         'quantity',                'int', 'NULL',      '', '', '',
1847
1848         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1849         'carrierid',               'int', 'NULL',      '', '', '',
1850
1851         'upstream_rateid',         'int', 'NULL',      '', '', '',
1852
1853         ###
1854         #and now for our own fields
1855         ###
1856
1857         # a svcnum... right..?
1858         'svcnum',             'int',   'NULL',     '',   '', '',
1859
1860         #NULL, done (or something)
1861         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1862
1863       ],
1864       'primary_key' => 'acctid',
1865       'unique' => [],
1866       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1867     },
1868
1869     'cdr_calltype' => {
1870       'columns' => [
1871         'calltypenum',   'serial',  '', '', '', '',
1872         'calltypename',  'varchar', '', $char_d, '', '',
1873       ],
1874       'primary_key' => 'calltypenum',
1875       'unique'      => [],
1876       'index'       => [],
1877     },
1878
1879     'cdr_type' => {
1880       'columns' => [
1881         'cdrtypenum'  => 'serial',  '', '', '', '',
1882         'cdrtypename' => 'varchar', '', $char_d, '', '',
1883       ],
1884       'primary_key' => 'cdrtypenum',
1885       'unique'      => [],
1886       'index'       => [],
1887     },
1888
1889     'cdr_carrier' => {
1890       'columns' => [
1891         'carrierid'   => 'serial',  '', '', '', '',
1892         'carriername' => 'varchar', '', $char_d, '', '',
1893       ],
1894       'primary_key' => 'carrierid',
1895       'unique'      => [],
1896       'index'       => [],
1897     },
1898
1899     #map upstream rateid to ours...
1900     'cdr_upstream_rate' => {
1901       'columns' => [
1902         'upstreamratenum', 'serial',  '', '', '', '',
1903         'upstream_rateid', 'varchar', '', $char_d, '', '',
1904         'ratedetailnum',   'int', 'NULL', '', '', '',
1905       ],
1906       'primary_key' => 'upstreamratenum', #XXX need a primary key
1907       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1908       'index'  => [],
1909     },
1910
1911     'inventory_item' => {
1912       'columns' => [
1913         'itemnum',  'serial',      '',      '', '', '',
1914         'classnum', 'int',         '',      '', '', '',
1915         'item',     'varchar',     '', $char_d, '', '',
1916         'svcnum',   'int',     'NULL',      '', '', '',
1917       ],
1918       'primary_key' => 'itemnum',
1919       'unique' => [ [ 'classnum', 'item' ] ],
1920       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1921     },
1922
1923     'inventory_class' => {
1924       'columns' => [
1925         'classnum',  'serial',       '',      '', '', '',
1926         'classname', 'varchar',      '', $char_d, '', '',
1927       ],
1928       'primary_key' => 'classnum',
1929       'unique' => [],
1930       'index'  => [],
1931     },
1932
1933     'access_user' => {
1934       'columns' => [
1935         'usernum',   'serial',  '',      '', '', '',
1936         'username',  'varchar', '', $char_d, '', '',
1937         '_password', 'varchar', '', $char_d, '', '',
1938         'last',      'varchar', '', $char_d, '', '',
1939         'first',     'varchar', '', $char_d, '', '',
1940         'disabled',     'char', 'NULL',   1, '', '',
1941       ],
1942       'primary_key' => 'usernum',
1943       'unique' => [ [ 'username' ] ],
1944       'index'  => [],
1945     },
1946
1947     'access_user_pref' => {
1948       'columns' => [
1949         'prefnum',    'serial',       '', '', '', '',
1950         'usernum',     'int',       '', '', '', '',
1951         'prefname', 'varchar', '', $char_d, '', '',
1952         'prefvalue', 'text', 'NULL', '', '', '',
1953         'expiration', @date_type, '', '',
1954       ],
1955       'primary_key' => 'prefnum',
1956       'unique' => [],
1957       'index'  => [ [ 'usernum' ] ],
1958     },
1959
1960     'access_group' => {
1961       'columns' => [
1962         'groupnum',   'serial', '',      '', '', '',
1963         'groupname', 'varchar', '', $char_d, '', '',
1964       ],
1965       'primary_key' => 'groupnum',
1966       'unique' => [ [ 'groupname' ] ],
1967       'index'  => [],
1968     },
1969
1970     'access_usergroup' => {
1971       'columns' => [
1972         'usergroupnum', 'serial', '', '', '', '',
1973         'usernum',         'int', '', '', '', '',
1974         'groupnum',        'int', '', '', '', '',
1975       ],
1976       'primary_key' => 'usergroupnum',
1977       'unique' => [ [ 'usernum', 'groupnum' ] ],
1978       'index'  => [ [ 'usernum' ] ],
1979     },
1980
1981     'access_groupagent' => {
1982       'columns' => [
1983         'groupagentnum', 'serial', '', '', '', '',
1984         'groupnum',         'int', '', '', '', '',
1985         'agentnum',         'int', '', '', '', '',
1986       ],
1987       'primary_key' => 'groupagentnum',
1988       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1989       'index'  => [ [ 'groupnum' ] ],
1990     },
1991
1992     'access_right' => {
1993       'columns' => [
1994         'rightnum',   'serial', '',      '', '', '',
1995         'righttype', 'varchar', '', $char_d, '', '',
1996         'rightobjnum',   'int', '',      '', '', '',
1997         'rightname', 'varchar', '', $char_d, '', '',
1998       ],
1999       'primary_key' => 'rightnum',
2000       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2001       'index'  => [],
2002     },
2003
2004     'svc_phone' => {
2005       'columns' => [
2006         'svcnum',      'int',         '',      '', '', '',
2007         'countrycode', 'varchar',     '',       3, '', '',
2008         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
2009         'pin',         'varchar', 'NULL', $char_d, '', '',
2010       ],
2011       'primary_key' => 'svcnum',
2012       'unique' => [],
2013       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2014     },
2015
2016     'reason_type' => {
2017       'columns' => [
2018         'typenum',   'serial',  '', '', '', '',
2019         'class',     'char', '', 1, '', '',
2020         'type',     'varchar', '', $char_d, '', '',
2021       ],
2022       'primary_key' => 'typenum',
2023       'unique' => [],
2024       'index' => [],
2025     },
2026
2027     'reason' => {
2028       'columns' => [
2029         'reasonnum',     'serial',  '', '', '', '',
2030         'reason_type',   'int',  '', '', '', '',
2031         'reason',        'text', '', '', '', '',
2032         'disabled',      'char',    'NULL', 1, '', '',
2033       ],
2034       'primary_key' => 'reasonnum',
2035       'unique' => [],
2036       'index' => [],
2037     },
2038
2039     'conf' => {
2040       'columns' => [
2041         'confnum',  'serial',  '', '', '', '',
2042         'agentnum', 'int',  'NULL', '', '', '',
2043         'name',     'varchar', '', $char_d, '', '',
2044         'value',    'text', 'NULL', '', '', '',
2045       ],
2046       'primary_key' => 'confnum',
2047       'unique' => [ [ 'agentnum', 'name' ]],
2048       'index' => [],
2049     },
2050
2051     'pkg_referral' => {
2052       'columns' => [
2053         'pkgrefnum',     'serial', '', '', '', '',
2054         'pkgnum',        'int',    '', '', '', '',
2055         'refnum',        'int',    '', '', '', '',
2056       ],
2057       'primary_key' => 'pkgrefnum',
2058       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2059       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2060     },
2061     # name type nullability length default local
2062
2063     #'new_table' => {
2064     #  'columns' => [
2065     #    'num', 'serial',       '', '', '', '',
2066     #  ],
2067     #  'primary_key' => 'num',
2068     #  'unique' => [],
2069     #  'index'  => [],
2070     #},
2071
2072   };
2073
2074 }
2075
2076 =back
2077
2078 =head1 BUGS
2079
2080 =head1 SEE ALSO
2081
2082 L<DBIx::DBSchema>
2083
2084 =cut
2085
2086 1;
2087