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         'invnum',  'int', '', '', '', '',
 485         'setup',   @money_type, '', '',
 486         'recur',   @money_type, '', '',
 487         'sdate',   @date_type, '', '',
 488         'edate',   @date_type, '', '',
 489         'itemdesc', 'varchar', 'NULL', $char_d, '', '',
 490       ],
 491       'primary_key' => 'billpkgnum',
 492       'unique' => [],
 493       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 494     },
 495
 496     'cust_bill_pkg_detail' => {
 497       'columns' => [
 498         'detailnum', 'serial', '', '', '', '',
 499         'pkgnum',  'int', '', '', '', '',
 500         'invnum',  'int', '', '', '', '',
 501         'detail',  'varchar', '', $char_d, '', '',
 502       ],
 503       'primary_key' => 'detailnum',
 504       'unique' => [],
 505       'index' => [ [ 'pkgnum', 'invnum' ] ],
 506     },
 507
 508     'cust_credit' => {
 509       'columns' => [
 510         'crednum',  'serial', '', '', '', '',
 511         'custnum',  'int', '', '', '', '',
 512         '_date',    @date_type, '', '',
 513         'amount',   @money_type, '', '',
 514         'otaker',   'varchar', '', 32, '', '',
 515         'reason',   'text', 'NULL', '', '', '',
 516         'reasonnum', 'int', 'NULL', '', '', '',
 517         'closed',    'char', 'NULL', 1, '', '',
 518       ],
 519       'primary_key' => 'crednum',
 520       'unique' => [],
 521       'index' => [ ['custnum'], ['_date'] ],
 522     },
 523
 524     'cust_credit_bill' => {
 525       'columns' => [
 526         'creditbillnum', 'serial', '', '', '', '',
 527         'crednum',  'int', '', '', '', '',
 528         'invnum',  'int', '', '', '', '',
 529         '_date',    @date_type, '', '',
 530         'amount',   @money_type, '', '',
 531       ],
 532       'primary_key' => 'creditbillnum',
 533       'unique' => [],
 534       'index' => [ ['crednum'], ['invnum'] ],
 535     },
 536
 537     'cust_credit_bill_pkg' => {
 538       'columns' => [
 539         'creditbillpkgnum', 'serial', '',      '', '', '',
 540         'creditbillnum',       'int', '',      '', '', '',
 541         'billpkgnum',          'int', '',      '', '', '',
 542         'amount',            @money_type,          '', '',
 543         'setuprecur',      'varchar', '', $char_d, '', '',
 544         'sdate',   @date_type, '', '',
 545         'edate',   @date_type, '', '',
 546       ],
 547       'primary_key' => 'creditbillpkgnum',
 548       'unique'      => [],
 549       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 550     },
 551
 552     'cust_main' => {
 553       'columns' => [
 554         'custnum',  'serial',  '',     '', '', '',
 555         'agentnum', 'int',  '',     '', '', '',
 556         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 557 #        'titlenum', 'int',  'NULL',   '', '', '',
 558         'last',     'varchar', '',     $char_d, '', '',
 559 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 560         'first',    'varchar', '',     $char_d, '', '',
 561         'ss',       'varchar', 'NULL', 11, '', '',
 562         'stateid', 'varchar', 'NULL', $char_d, '', '',
 563         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 564         'birthdate' ,@date_type, '', '',
 565         'signupdate',@date_type, '', '',
 566         'company',  'varchar', 'NULL', $char_d, '', '',
 567         'address1', 'varchar', '',     $char_d, '', '',
 568         'address2', 'varchar', 'NULL', $char_d, '', '',
 569         'city',     'varchar', '',     $char_d, '', '',
 570         'county',   'varchar', 'NULL', $char_d, '', '',
 571         'state',    'varchar', 'NULL', $char_d, '', '',
 572         'zip',      'varchar', 'NULL', 10, '', '',
 573         'country',  'char', '',     2, '', '',
 574         'daytime',  'varchar', 'NULL', 20, '', '',
 575         'night',    'varchar', 'NULL', 20, '', '',
 576         'fax',      'varchar', 'NULL', 12, '', '',
 577         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 578 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 579         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 580         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 581         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 582         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 583         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 584         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 585         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 586         'ship_zip',      'varchar', 'NULL', 10, '', '',
 587         'ship_country',  'char', 'NULL', 2, '', '',
 588         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 589         'ship_night',    'varchar', 'NULL', 20, '', '',
 590         'ship_fax',      'varchar', 'NULL', 12, '', '',
 591         'payby',    'char', '',     4, '', '',
 592         'payinfo',  'varchar', 'NULL', 512, '', '',
 593         'paycvv',   'varchar', 'NULL', 512, '', '',
 594         'paymask', 'varchar', 'NULL', $char_d, '', '',
 595         #'paydate',  @date_type, '', '',
 596         'paydate',  'varchar', 'NULL', 10, '', '',
 597         'paystart_month', 'int', 'NULL', '', '', '',
 598         'paystart_year',  'int', 'NULL', '', '', '',
 599         'payissue', 'varchar', 'NULL', 2, '', '',
 600         'payname',  'varchar', 'NULL', $char_d, '', '',
 601         'paystate', 'varchar', 'NULL', $char_d, '', '',
 602         'paytype',  'varchar', 'NULL', $char_d, '', '',
 603         'payip',    'varchar', 'NULL', 15, '', '',
 604         'tax',      'char', 'NULL', 1, '', '',
 605         'otaker',   'varchar', '',    32, '', '',
 606         'refnum',   'int',  '',     '', '', '',
 607         'referral_custnum', 'int',  'NULL', '', '', '',
 608         'comments', 'text', 'NULL', '', '', '',
 609         'spool_cdr','char', 'NULL', 1, '', '',
 610         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 611       ],
 612       'primary_key' => 'custnum',
 613       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 614       #'index' => [ ['last'], ['company'] ],
 615       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 616                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 617                    [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 618                    [ 'ship_last' ], [ 'ship_company' ],
 619                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 620                    [ 'payby' ], [ 'paydate' ],
 621                  ],
 622     },
 623
 624     'cust_main_invoice' => {
 625       'columns' => [
 626         'destnum',  'serial',  '',     '', '', '',
 627         'custnum',  'int',  '',     '', '', '',
 628         'dest',     'varchar', '',  $char_d, '', '',
 629       ],
 630       'primary_key' => 'destnum',
 631       'unique' => [],
 632       'index' => [ ['custnum'], ],
 633     },
 634
 635     'cust_main_note' => {
 636       'columns' => [
 637         'notenum',  'serial',  '',     '', '', '',
 638         'custnum',  'int',  '',     '', '', '',
 639         '_date',    @date_type, '', '',
 640         'otaker',   'varchar', '',    32, '', '',
 641         'comments', 'text', 'NULL', '', '', '',
 642       ],
 643       'primary_key' => 'notenum',
 644       'unique' => [],
 645       'index' => [ [ 'custnum' ], [ '_date' ], ],
 646     },
 647
 648     'cust_main_county' => { #county+state+country are checked off the
 649                             #cust_main_county for validation and to provide
 650                             # a tax rate.
 651       'columns' => [
 652         'taxnum',   'serial',   '',    '', '', '',
 653         'state',    'varchar',  'NULL',    $char_d, '', '',
 654         'county',   'varchar',  'NULL',    $char_d, '', '',
 655         'country',  'char',  '', 2, '', '',
 656         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 657         'exempt_amount', @money_type, '', '',
 658         'tax',      'real',  '',    '', '', '', #tax %
 659         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 660         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 661         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 662       ],
 663       'primary_key' => 'taxnum',
 664       'unique' => [],
 665   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 666       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 667     },
 668
 669     'tax_rate'    => {
 670       'columns' => [
 671         'taxnum',       'serial',     '',      '', '', '',
 672         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 673         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 674         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 675         'taxclassnum', 'int',      '',      '', '', '',
 676         'effective_date', @date_type, '', '',
 677         'tax',        'real',  '',    '', '', '',        # tax %
 678         'excessrate', 'real',  'NULL','', '', '',        # second tax %
 679         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 680         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 681         'usetax',        'real',  'NULL',    '', '', '', # tax % when non-local
 682         'useexcessrate', 'real',  'NULL',    '', '', '', # second tax % when non-local
 683         'unittype',    'int',  'NULL', '', '', '',      # for fee
 684         'fee',         'real', 'NULL', '', '', '',      # amount tax per unit
 685         'excessfee',   'real', 'NULL', '', '', '',      # second amount tax per unit
 686         'feebase',     'real', 'NULL', '', '', '',      # units taxed at first rate
 687         'feemax',      'real', 'NULL', '', '', '',      # maximum number of unit taxed
 688         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 689         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 690         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 691         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 692         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 693         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 694         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 695         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 696         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 697       ],
 698       'primary_key' => 'taxnum',
 699       'unique' => [],
 700       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 701     },
 702
 703     'cust_tax_location' => {
 704       'columns' => [
 705         'custlocationnum', 'serial',  '',     '', '', '',
 706         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 707         'zip',             'char',    '',     5,  '', '',
 708         'state',           'char',    '',     2,  '', '',
 709         'plus4hi',         'char',    '',     4,  '', '',
 710         'plus4lo',         'char',    '',     4,  '', '',
 711         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 712         'geocode',         'varchar', '',    20,  '', '',
 713       ],
 714       'primary_key' => 'custlocationnum',
 715       'unique' => [],
 716       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 717     },
 718
 719     'tax_class' => {
 720       'columns' => [
 721         'taxclassnum',  'serial',  '',            '', '', '',
 722         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
 723         'taxclass',     'varchar', '',       $char_d, '', '',
 724         'description',  'varchar', '',     2*$char_d, '', '',
 725       ],
 726       'primary_key' => 'taxclassnum',
 727       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
 728       'index' => [],
 729     },
 730
 731     'cust_pay_pending' => {
 732       'columns' => [
 733         'paypendingnum','serial',      '',  '', '', '',
 734         'custnum',      'int',         '',  '', '', '',
 735         'paid',         @money_type,            '', '',
 736         '_date',        @date_type,             '', '',
 737         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
 738                                                         # be index into payby
 739                                                         # table eventually
 740         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
 741         'paymask',      'varchar', 'NULL', $char_d, '', '',
 742         'paydate',      'varchar', 'NULL', 10, '', '',
 743         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
 744         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 745
 746         'status',       'varchar',     '', $char_d, '', '',
 747         'statustext',   'text',    'NULL',  '', '', '',
 748         'gatewaynum',   'int',     'NULL',  '', '', '',
 749         #'cust_balance', @money_type,            '', '',
 750         'paynum',       'int',     'NULL',  '', '', '',
 751       ],
 752       'primary_key' => 'paypendingnum',
 753       'unique'      => [ [ 'payunique' ] ],
 754       'index'       => [ [ 'custnum' ], [ 'status' ], ],
 755     },
 756
 757     'cust_pay' => {
 758       'columns' => [
 759         'paynum',   'serial',    '',   '', '', '',
 760         'custnum',  'int',    '',   '', '', '',
 761         '_date',    @date_type, '', '',
 762         'paid',     @money_type, '', '',
 763         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
 764         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 765                                                  # index into payby table
 766                                                  # eventually
 767         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 768         'paymask', 'varchar', 'NULL', $char_d, '', '',
 769         'paydate',  'varchar', 'NULL', 10, '', '',
 770         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 771         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 772         'closed',    'char', 'NULL', 1, '', '',
 773       ],
 774       'primary_key' => 'paynum',
 775       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
 776       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 777     },
 778
 779     'cust_pay_void' => {
 780       'columns' => [
 781         'paynum',    'int',    '',   '', '', '',
 782         'custnum',   'int',    '',   '', '', '',
 783         'paid',      @money_type, '', '',
 784         '_date',     @date_type, '', '',
 785         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 786                                                   # index into payby table
 787                                                   # eventually
 788         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 789         'paymask', 'varchar', 'NULL', $char_d, '', '',
 790         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 791         'closed',    'char', 'NULL', 1, '', '',
 792         'void_date', @date_type, '', '',
 793         'reason',    'varchar',   'NULL', $char_d, '', '',
 794         'otaker',   'varchar', '', 32, '', '',
 795       ],
 796       'primary_key' => 'paynum',
 797       'unique' => [],
 798       'index' => [ [ 'custnum' ] ],
 799     },
 800
 801     'cust_bill_pay' => {
 802       'columns' => [
 803         'billpaynum', 'serial',     '',   '', '', '',
 804         'invnum',  'int',     '',   '', '', '',
 805         'paynum',  'int',     '',   '', '', '',
 806         'amount',  @money_type, '', '',
 807         '_date',   @date_type, '', '',
 808       ],
 809       'primary_key' => 'billpaynum',
 810       'unique' => [],
 811       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 812     },
 813
 814     'cust_bill_pay_batch' => {
 815       'columns' => [
 816         'billpaynum', 'serial',     '',   '', '', '',
 817         'invnum',  'int',     '',   '', '', '',
 818         'paybatchnum',  'int',     '',   '', '', '',
 819         'amount',  @money_type, '', '',
 820         '_date',   @date_type, '', '',
 821       ],
 822       'primary_key' => 'billpaynum',
 823       'unique' => [],
 824       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 825     },
 826
 827     'cust_bill_pay_pkg' => {
 828       'columns' => [
 829         'billpaypkgnum', 'serial', '', '', '', '',
 830         'billpaynum',       'int', '', '', '', '',
 831         'billpkgnum',       'int', '', '', '', '',
 832         'amount',         @money_type,     '', '',
 833         'setuprecur',      'varchar', '', $char_d, '', '',
 834         'sdate',   @date_type, '', '',
 835         'edate',   @date_type, '', '',
 836       ],
 837       'primary_key' => 'billpaypkgnum',
 838       'unique'      => [],
 839       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 840     },
 841
 842     'pay_batch' => { #batches of payments to an external processor
 843       'columns' => [
 844         'batchnum',   'serial',    '',   '', '', '',
 845         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 846         'status',     'char', 'NULL',     1, '', '',
 847         'download',   @date_type, '', '',
 848         'upload',     @date_type, '', '',
 849       ],
 850       'primary_key' => 'batchnum',
 851       'unique' => [],
 852       'index' => [],
 853     },
 854
 855     'cust_pay_batch' => { #what's this used for again?  list of customers
 856                           #in current CARD batch? (necessarily CARD?)
 857       'columns' => [
 858         'paybatchnum',   'serial',    '',   '', '', '',
 859         'batchnum',   'int',    '',   '', '', '',
 860         'invnum',   'int',    '',   '', '', '',
 861         'custnum',   'int',    '',   '', '', '',
 862         'last',     'varchar', '',     $char_d, '', '',
 863         'first',    'varchar', '',     $char_d, '', '',
 864         'address1', 'varchar', '',     $char_d, '', '',
 865         'address2', 'varchar', 'NULL', $char_d, '', '',
 866         'city',     'varchar', '',     $char_d, '', '',
 867         'state',    'varchar', 'NULL', $char_d, '', '',
 868         'zip',      'varchar', 'NULL', 10, '', '',
 869         'country',  'char', '',     2, '', '',
 870         #        'trancode', 'int', '', '', '', ''
 871         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 872         'payinfo',  'varchar', '',     512, '', '',
 873         #'exp',      @date_type, '', ''
 874         'exp',      'varchar', 'NULL',     11, '', '',
 875         'payname',  'varchar', 'NULL', $char_d, '', '',
 876         'amount',   @money_type, '', '',
 877         'status',   'varchar', 'NULL',     $char_d, '', '',
 878       ],
 879       'primary_key' => 'paybatchnum',
 880       'unique' => [],
 881       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 882     },
 883
 884     'cust_pkg' => {
 885       'columns' => [
 886         'pkgnum',         'serial',    '',   '', '', '',
 887         'custnum',        'int',    '',   '', '', '',
 888         'pkgpart',        'int',    '',   '', '', '',
 889         'otaker',         'varchar', '', 32, '', '',
 890         'setup',          @date_type, '', '',
 891         'bill',           @date_type, '', '',
 892         'last_bill',      @date_type, '', '',
 893         'susp',           @date_type, '', '',
 894         'adjourn',        @date_type, '', '',
 895         'cancel',         @date_type, '', '',
 896         'expire',         @date_type, '', '',
 897         'change_date',    @date_type, '', '',
 898         'change_pkgnum',  'int', 'NULL', '', '', '',
 899         'change_pkgpart', 'int', 'NULL', '', '', '',
 900         'manual_flag',    'char', 'NULL', 1, '', '',
 901       ],
 902       'primary_key' => 'pkgnum',
 903       'unique' => [],
 904       'index' => [ ['custnum'], ['pkgpart'],
 905                    ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
 906                    ['expire'], ['cancel'],
 907                    ['change_date'],
 908                  ],
 909     },
 910
 911     'cust_pkg_option' => {
 912       'columns' => [
 913         'optionnum', 'serial', '', '', '', '',
 914         'pkgnum', 'int', '', '', '', '',
 915         'optionname', 'varchar', '', $char_d, '', '',
 916         'optionvalue', 'text', 'NULL', '', '', '',
 917       ],
 918       'primary_key' => 'optionnum',
 919       'unique'      => [],
 920       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
 921     },
 922
 923     'cust_pkg_reason' => {
 924       'columns' => [
 925         'num',      'serial',    '',   '', '', '',
 926         'pkgnum',   'int',    '',   '', '', '',
 927         'reasonnum','int',    '',   '', '', '',
 928         'otaker',   'varchar', '', 32, '', '',
 929         'date',     @date_type, '', '',
 930       ],
 931       'primary_key' => 'num',
 932       'unique' => [],
 933       'index' => [],
 934     },
 935
 936     'cust_refund' => {
 937       'columns' => [
 938         'refundnum',    'serial',    '',   '', '', '',
 939         'custnum',  'int',    '',   '', '', '',
 940         '_date',        @date_type, '', '',
 941         'refund',       @money_type, '', '',
 942         'otaker',       'varchar',   '',   32, '', '',
 943         'reason',       'varchar',   '',   $char_d, '', '',
 944         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 945                                                      # be index into payby
 946                                                      # table eventually
 947         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
 948         'paymask', 'varchar', 'NULL', $char_d, '', '',
 949         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 950         'closed',    'char', 'NULL', 1, '', '',
 951       ],
 952       'primary_key' => 'refundnum',
 953       'unique' => [],
 954       'index' => [ ['custnum'], ['_date'] ],
 955     },
 956
 957     'cust_credit_refund' => {
 958       'columns' => [
 959         'creditrefundnum', 'serial',     '',   '', '', '',
 960         'crednum',  'int',     '',   '', '', '',
 961         'refundnum',  'int',     '',   '', '', '',
 962         'amount',  @money_type, '', '',
 963         '_date',   @date_type, '', '',
 964       ],
 965       'primary_key' => 'creditrefundnum',
 966       'unique' => [],
 967       'index' => [ ['crednum'], ['refundnum'] ],
 968     },
 969
 970
 971     'cust_svc' => {
 972       'columns' => [
 973         'svcnum',    'serial',    '',   '', '', '',
 974         'pkgnum',    'int',    'NULL',   '', '', '',
 975         'svcpart',   'int',    '',   '', '', '',
 976         'overlimit', @date_type, '', '',
 977       ],
 978       'primary_key' => 'svcnum',
 979       'unique' => [],
 980       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 981     },
 982
 983     'part_pkg' => {
 984       'columns' => [
 985         'pkgpart',       'serial',    '',   '', '', '',
 986         'pkg',           'varchar',   '',   $char_d, '', '',
 987         'comment',       'varchar',   '',   $char_d, '', '',
 988         'promo_code',    'varchar', 'NULL', $char_d, '', '',
 989         'setup',         @perl_type, '', '',
 990         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
 991         'recur',         @perl_type, '', '',
 992         'setuptax',      'char', 'NULL', 1, '', '',
 993         'recurtax',      'char', 'NULL', 1, '', '',
 994         'plan',          'varchar', 'NULL', $char_d, '', '',
 995         'plandata',      'text', 'NULL', '', '', '',
 996         'disabled',      'char', 'NULL', 1, '', '',
 997         'taxclass',      'varchar', 'NULL', $char_d, '', '',
 998         'classnum',      'int',     'NULL', '', '', '',
 999         'taxproductnum', 'int',     'NULL', '', '', '',
1000         'pay_weight',    'real',    'NULL', '', '', '',
1001         'credit_weight', 'real',    'NULL', '', '', '',
1002         'agentnum',      'int',     'NULL', '', '', '',
1003
1004       ],
1005       'primary_key' => 'pkgpart',
1006       'unique' => [],
1007       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1008     },
1009
1010     'part_pkg_taxclass' => {
1011       'columns' => [
1012         'taxclassnum',  'serial', '',       '', '', '',
1013         'taxclass',     'varchar', '', $char_d, '', '',
1014       ],
1015       'primary_key' => 'taxclassnum',
1016       'unique'      => [ [ 'taxclass' ] ],
1017       'index'       => [],
1018     },
1019
1020     'part_pkg_taxproduct' => {
1021       'columns' => [
1022         'taxproductnum', 'serial',      '',        '', '', '',
1023         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1024         'taxproduct',    'varchar',     '',   $char_d, '', '',
1025         'description',   'varchar',     '', 2*$char_d, '', '',
1026       ],
1027       'primary_key' => 'taxproductnum',
1028       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1029       'index'       => [],
1030     },
1031
1032     'part_pkg_taxrate' => {
1033       'columns' => [
1034         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1035         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1036         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1037         'taxproductnum', 'int',  '',     '',       '', '',
1038         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1039         'county',           'varchar', 'NULL', $char_d, '', '',
1040         'state',            'varchar', 'NULL', $char_d, '', '',
1041         'local',            'varchar', 'NULL', $char_d, '', '',
1042         'country',          'char',    'NULL', 2,       '', '',
1043         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1044         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1045         'taxclassnum',      'int',     'NULL', '',      '', '',
1046         'effdate',          @date_type, '', '',
1047         'taxable',          'char',    'NULL', 1,       '', '',
1048       ],
1049       'primary_key' => 'pkgtaxratenum',
1050       'unique' => [],
1051       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1052     },
1053
1054     'part_pkg_taxoverride' => {
1055       'columns' => [
1056         'taxoverridenum', 'serial', '', '', '', '',
1057         'pkgpart',        'serial', '', '', '', '',
1058         'taxnum',         'serial', '', '', '', '',
1059       ],
1060       'primary_key' => 'taxoverridenum',
1061       'unique' => [],
1062       'index' => [ [ 'pkgpart' ], [ 'taxnum' ] ],
1063     },
1064
1065 #    'part_title' => {
1066 #      'columns' => [
1067 #        'titlenum',   'int',    '',   '',
1068 #        'title',      'varchar',   '',   $char_d,
1069 #      ],
1070 #      'primary_key' => 'titlenum',
1071 #      'unique' => [ [] ],
1072 #      'index' => [ [] ],
1073 #    },
1074
1075     'pkg_svc' => {
1076       'columns' => [
1077         'pkgsvcnum',  'serial', '',  '', '', '',
1078         'pkgpart',    'int',    '',   '', '', '',
1079         'svcpart',    'int',    '',   '', '', '',
1080         'quantity',   'int',    '',   '', '', '',
1081         'primary_svc','char', 'NULL',  1, '', '',
1082       ],
1083       'primary_key' => 'pkgsvcnum',
1084       'unique' => [ ['pkgpart', 'svcpart'] ],
1085       'index' => [ ['pkgpart'] ],
1086     },
1087
1088     'part_referral' => {
1089       'columns' => [
1090         'refnum',   'serial',     '',        '', '', '',
1091         'referral', 'varchar',    '',   $char_d, '', '',
1092         'disabled', 'char',   'NULL',         1, '', '',
1093         'agentnum', 'int',    'NULL',        '', '', '',
1094       ],
1095       'primary_key' => 'refnum',
1096       'unique' => [],
1097       'index' => [ ['disabled'], ['agentnum'], ],
1098     },
1099
1100     'part_svc' => {
1101       'columns' => [
1102         'svcpart',    'serial',    '',   '', '', '',
1103         'svc',        'varchar',   '',   $char_d, '', '',
1104         'svcdb',      'varchar',   '',   $char_d, '', '',
1105         'disabled',   'char',  'NULL',   1, '', '',
1106       ],
1107       'primary_key' => 'svcpart',
1108       'unique' => [],
1109       'index' => [ [ 'disabled' ] ],
1110     },
1111
1112     'part_svc_column' => {
1113       'columns' => [
1114         'columnnum',   'serial',         '', '', '', '',
1115         'svcpart',     'int',         '', '', '', '',
1116         'columnname',  'varchar',     '', 64, '', '',
1117         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1118         'columnflag',  'char',    'NULL', 1, '', '',
1119       ],
1120       'primary_key' => 'columnnum',
1121       'unique' => [ [ 'svcpart', 'columnname' ] ],
1122       'index' => [ [ 'svcpart' ] ],
1123     },
1124
1125     #(this should be renamed to part_pop)
1126     'svc_acct_pop' => {
1127       'columns' => [
1128         'popnum',    'serial',    '',   '', '', '',
1129         'city',      'varchar',   '',   $char_d, '', '',
1130         'state',     'varchar',   '',   $char_d, '', '',
1131         'ac',        'char',   '',   3, '', '',
1132         'exch',      'char',   '',   3, '', '',
1133         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1134       ],
1135       'primary_key' => 'popnum',
1136       'unique' => [],
1137       'index' => [ [ 'state' ] ],
1138     },
1139
1140     'part_pop_local' => {
1141       'columns' => [
1142         'localnum',  'serial',     '',     '', '', '',
1143         'popnum',    'int',     '',     '', '', '',
1144         'city',      'varchar', 'NULL', $char_d, '', '',
1145         'state',     'char',    'NULL', 2, '', '',
1146         'npa',       'char',    '',     3, '', '',
1147         'nxx',       'char',    '',     3, '', '',
1148       ],
1149       'primary_key' => 'localnum',
1150       'unique' => [],
1151       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1152     },
1153
1154     'svc_acct' => {
1155       'columns' => [
1156         'svcnum',    'int',    '',   '', '', '',
1157         'username',  'varchar',   '',   $username_len, '', '',
1158         '_password', 'varchar',   '',  512, '', '',
1159         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1160         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1161         'popnum',    'int',    'NULL',   '', '', '',
1162         'uid',       'int', 'NULL',   '', '', '',
1163         'gid',       'int', 'NULL',   '', '', '',
1164         'finger',    'varchar',   'NULL',   $char_d, '', '',
1165         'dir',       'varchar',   'NULL',   $char_d, '', '',
1166         'shell',     'varchar',   'NULL',   $char_d, '', '',
1167         'quota',     'varchar',   'NULL',   $char_d, '', '',
1168         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1169         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1170         'seconds_threshold',   'int', 'NULL',   '', '', '',
1171         'upbytes',   'bigint', 'NULL',   '', '', '',
1172         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1173         'downbytes', 'bigint', 'NULL',   '', '', '',
1174         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1175         'totalbytes','bigint', 'NULL',   '', '', '',
1176         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1177         'domsvc',    'int', '',   '', '', '',
1178         'last_login',  @date_type, '', '',
1179         'last_logout', @date_type, '', '',
1180       ],
1181       'primary_key' => 'svcnum',
1182       #'unique' => [ [ 'username', 'domsvc' ] ],
1183       'unique' => [],
1184       'index' => [ ['username'], ['domsvc'] ],
1185     },
1186
1187     'acct_rt_transaction' => {
1188       'columns' => [
1189         'svcrtid',   'int',    '',   '', '', '',
1190         'svcnum',    'int',    '',   '', '', '',
1191         'transaction_id',       'int', '',   '', '', '',
1192         '_date',   @date_type, '', '',
1193         'seconds',   'int', '',   '', '', '', #uhhhh
1194         'support',   'int', '',   '', '', '',
1195       ],
1196       'primary_key' => 'svcrtid',
1197       'unique' => [],
1198       'index' => [ ['svcnum', 'transaction_id'] ],
1199     },
1200
1201     #'svc_charge' => {
1202     #  'columns' => [
1203     #    'svcnum',    'int',    '',   '',
1204     #    'amount',    @money_type,
1205     #  ],
1206     #  'primary_key' => 'svcnum',
1207     #  'unique' => [ [] ],
1208     #  'index' => [ [] ],
1209     #},
1210
1211     'svc_domain' => {
1212       'columns' => [
1213         'svcnum',           'int',    '',        '', '', '',
1214         'domain',       'varchar',    '',   $char_d, '', '',
1215         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1216         'catchall',         'int', 'NULL',       '', '', '',
1217         'parent_svcnum',    'int', 'NULL',       '', '', '',
1218         'registrarnum',     'int', 'NULL',       '', '', '',
1219         'registrarkey', 'varchar', 'NULL',      512, '', '',
1220         'setup_date',  @date_type, '', '',
1221         'renewal_interval', 'int', 'NULL',       '', '', '',
1222         'expiration_date', @date_type, '', '',
1223       ],
1224       'primary_key' => 'svcnum',
1225       'unique' => [ ],
1226       'index' => [ ['domain'] ],
1227     },
1228
1229     'domain_record' => {
1230       'columns' => [
1231         'recnum',    'serial',     '',  '', '', '',
1232         'svcnum',    'int',     '',  '', '', '',
1233         'reczone',   'varchar', '',  255, '', '',
1234         'recaf',     'char',    '',  2, '', '',
1235         'rectype',   'varchar',    '',  5, '', '',
1236         'recdata',   'varchar', '',  255, '', '',
1237       ],
1238       'primary_key' => 'recnum',
1239       'unique'      => [],
1240       'index'       => [ ['svcnum'] ],
1241     },
1242
1243     'registrar' => {
1244       'columns' => [
1245         'registrarnum',   'serial', '',      '', '', '',
1246         'registrarname', 'varchar', '', $char_d, '', '',
1247       ],
1248       'primary_key' => 'registrarnum',
1249       'unique'      => [],
1250       'index'       => [],
1251     },
1252
1253     'svc_forward' => {
1254       'columns' => [
1255         'svcnum',   'int',            '',   '', '', '',
1256         'srcsvc',   'int',        'NULL',   '', '', '',
1257         'src',      'varchar',    'NULL',  255, '', '',
1258         'dstsvc',   'int',        'NULL',   '', '', '',
1259         'dst',      'varchar',    'NULL',  255, '', '',
1260       ],
1261       'primary_key' => 'svcnum',
1262       'unique'      => [],
1263       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1264     },
1265
1266     'svc_www' => {
1267       'columns' => [
1268         'svcnum',   'int',      '',  '', '', '',
1269         'recnum',   'int',      '',  '', '', '',
1270         'usersvc',  'int',  'NULL',  '', '', '',
1271         'config',   'text', 'NULL',  '', '', '',
1272       ],
1273       'primary_key' => 'svcnum',
1274       'unique'      => [],
1275       'index'       => [],
1276     },
1277
1278     #'svc_wo' => {
1279     #  'columns' => [
1280     #    'svcnum',    'int',    '',   '',
1281     #    'svcnum',    'int',    '',   '',
1282     #    'svcnum',    'int',    '',   '',
1283     #    'worker',    'varchar',   '',   $char_d,
1284     #    '_date',     @date_type,
1285     #  ],
1286     #  'primary_key' => 'svcnum',
1287     #  'unique' => [ [] ],
1288     #  'index' => [ [] ],
1289     #},
1290
1291     'prepay_credit' => {
1292       'columns' => [
1293         'prepaynum',   'serial',     '',   '', '', '',
1294         'identifier',  'varchar', '', $char_d, '', '',
1295         'amount',      @money_type, '', '',
1296         'seconds',     'int',     'NULL', '', '', '',
1297         'upbytes',     'bigint',     'NULL', '', '', '',
1298         'downbytes',   'bigint',     'NULL', '', '', '',
1299         'totalbytes',  'bigint',     'NULL', '', '', '',
1300         'agentnum',    'int',     'NULL', '', '', '',
1301       ],
1302       'primary_key' => 'prepaynum',
1303       'unique'      => [ ['identifier'] ],
1304       'index'       => [],
1305     },
1306
1307     'port' => {
1308       'columns' => [
1309         'portnum',  'serial',     '',   '', '', '',
1310         'ip',       'varchar', 'NULL', 15, '', '',
1311         'nasport',  'int',     'NULL', '', '', '',
1312         'nasnum',   'int',     '',   '', '', '',
1313       ],
1314       'primary_key' => 'portnum',
1315       'unique'      => [],
1316       'index'       => [],
1317     },
1318
1319     'nas' => {
1320       'columns' => [
1321         'nasnum',   'serial',     '',    '', '', '',
1322         'nas',      'varchar', '',    $char_d, '', '',
1323         'nasip',    'varchar', '',    15, '', '',
1324         'nasfqdn',  'varchar', '',    $char_d, '', '',
1325         'last',     'int',     '',    '', '', '',
1326       ],
1327       'primary_key' => 'nasnum',
1328       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1329       'index'       => [ [ 'last' ] ],
1330     },
1331
1332 #    'session' => {
1333 #      'columns' => [
1334 #        'sessionnum', 'serial',       '',   '', '', '',
1335 #        'portnum',    'int',       '',   '', '', '',
1336 #        'svcnum',     'int',       '',   '', '', '',
1337 #        'login',      @date_type, '', '',
1338 #        'logout',     @date_type, '', '',
1339 #      ],
1340 #      'primary_key' => 'sessionnum',
1341 #      'unique'      => [],
1342 #      'index'       => [ [ 'portnum' ] ],
1343 #    },
1344
1345     'queue' => {
1346       'columns' => [
1347         'jobnum', 'serial', '', '', '', '',
1348         'job', 'text', '', '', '', '',
1349         '_date', 'int', '', '', '', '',
1350         'status', 'varchar', '', $char_d, '', '',
1351         'statustext', 'text', 'NULL', '', '', '',
1352         'svcnum', 'int', 'NULL', '', '', '',
1353         'secure',  'char', 'NULL', 1, '', '', # Y = needs to be run on machine
1354                                               #     w/private key
1355       ],
1356       'primary_key' => 'jobnum',
1357       'unique'      => [],
1358       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
1359     },
1360
1361     'queue_arg' => {
1362       'columns' => [
1363         'argnum', 'serial', '', '', '', '',
1364         'jobnum', 'int', '', '', '', '',
1365         'arg', 'text', 'NULL', '', '', '',
1366       ],
1367       'primary_key' => 'argnum',
1368       'unique'      => [],
1369       'index'       => [ [ 'jobnum' ] ],
1370     },
1371
1372     'queue_depend' => {
1373       'columns' => [
1374         'dependnum', 'serial', '', '', '', '',
1375         'jobnum', 'int', '', '', '', '',
1376         'depend_jobnum', 'int', '', '', '', '',
1377       ],
1378       'primary_key' => 'dependnum',
1379       'unique'      => [],
1380       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1381     },
1382
1383     'export_svc' => {
1384       'columns' => [
1385         'exportsvcnum' => 'serial', '', '', '', '',
1386         'exportnum'    => 'int', '', '', '', '',
1387         'svcpart'      => 'int', '', '', '', '',
1388       ],
1389       'primary_key' => 'exportsvcnum',
1390       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1391       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1392     },
1393
1394     'part_export' => {
1395       'columns' => [
1396         'exportnum', 'serial', '', '', '', '',
1397         'machine', 'varchar', '', $char_d, '', '',
1398         'exporttype', 'varchar', '', $char_d, '', '',
1399         'nodomain',     'char', 'NULL', 1, '', '',
1400       ],
1401       'primary_key' => 'exportnum',
1402       'unique'      => [],
1403       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1404     },
1405
1406     'part_export_option' => {
1407       'columns' => [
1408         'optionnum', 'serial', '', '', '', '',
1409         'exportnum', 'int', '', '', '', '',
1410         'optionname', 'varchar', '', $char_d, '', '',
1411         'optionvalue', 'text', 'NULL', '', '', '',
1412       ],
1413       'primary_key' => 'optionnum',
1414       'unique'      => [],
1415       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1416     },
1417
1418     'radius_usergroup' => {
1419       'columns' => [
1420         'usergroupnum', 'serial', '', '', '', '',
1421         'svcnum',       'int', '', '', '', '',
1422         'groupname',    'varchar', '', $char_d, '', '',
1423       ],
1424       'primary_key' => 'usergroupnum',
1425       'unique'      => [],
1426       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1427     },
1428
1429     'msgcat' => {
1430       'columns' => [
1431         'msgnum', 'serial', '', '', '', '',
1432         'msgcode', 'varchar', '', $char_d, '', '',
1433         'locale', 'varchar', '', 16, '', '',
1434         'msg', 'text', '', '', '', '',
1435       ],
1436       'primary_key' => 'msgnum',
1437       'unique'      => [ [ 'msgcode', 'locale' ] ],
1438       'index'       => [],
1439     },
1440
1441     'cust_tax_exempt' => {
1442       'columns' => [
1443         'exemptnum', 'serial', '', '', '', '',
1444         'custnum',   'int', '', '', '', '',
1445         'taxnum',    'int', '', '', '', '',
1446         'year',      'int', '', '', '', '',
1447         'month',     'int', '', '', '', '',
1448         'amount',   @money_type, '', '',
1449       ],
1450       'primary_key' => 'exemptnum',
1451       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1452       'index'       => [],
1453     },
1454
1455     'cust_tax_exempt_pkg' => {
1456       'columns' => [
1457         'exemptpkgnum',  'serial', '', '', '', '',
1458         #'custnum',      'int', '', '', '', ''
1459         'billpkgnum',   'int', '', '', '', '',
1460         'taxnum',       'int', '', '', '', '',
1461         'year',         'int', '', '', '', '',
1462         'month',        'int', '', '', '', '',
1463         'amount',       @money_type, '', '',
1464       ],
1465       'primary_key' => 'exemptpkgnum',
1466       'unique' => [],
1467       'index'  => [ [ 'taxnum', 'year', 'month' ],
1468                     [ 'billpkgnum' ],
1469                     [ 'taxnum' ]
1470                   ],
1471     },
1472
1473     'router' => {
1474       'columns' => [
1475         'routernum', 'serial', '', '', '', '',
1476         'routername', 'varchar', '', $char_d, '', '',
1477         'svcnum', 'int', 'NULL', '', '', '',
1478         'agentnum',   'int', 'NULL', '', '', '',
1479       ],
1480       'primary_key' => 'routernum',
1481       'unique'      => [],
1482       'index'       => [],
1483     },
1484
1485     'part_svc_router' => {
1486       'columns' => [
1487         'svcrouternum', 'serial', '', '', '', '',
1488         'svcpart', 'int', '', '', '', '',
1489         'routernum', 'int', '', '', '', '',
1490       ],
1491       'primary_key' => 'svcrouternum',
1492       'unique'      => [],
1493       'index'       => [],
1494     },
1495
1496     'addr_block' => {
1497       'columns' => [
1498         'blocknum', 'serial', '', '', '', '',
1499         'routernum', 'int', '', '', '', '',
1500         'ip_gateway', 'varchar', '', 15, '', '',
1501         'ip_netmask', 'int', '', '', '', '',
1502         'agentnum',   'int', 'NULL', '', '', '',
1503       ],
1504       'primary_key' => 'blocknum',
1505       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1506       'index'       => [],
1507     },
1508
1509     'svc_broadband' => {
1510       'columns' => [
1511         'svcnum', 'int', '', '', '', '',
1512         'description', 'varchar', 'NULL', $char_d, '', '',
1513         'blocknum', 'int', '', '', '', '',
1514         'speed_up', 'int', '', '', '', '',
1515         'speed_down', 'int', '', '', '', '',
1516         'ip_addr', 'varchar', '', 15, '', '',
1517         'mac_addr', 'varchar', 'NULL', 12, '', '',
1518         'authkey',  'varchar', 'NULL', 32, '', '',
1519         'latitude', 'decimal', 'NULL', '', '', '',
1520         'longitude', 'decimal', 'NULL', '', '', '',
1521         'altitude', 'decimal', 'NULL', '', '', '',
1522         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1523       ],
1524       'primary_key' => 'svcnum',
1525       'unique'      => [],
1526       'index'       => [],
1527     },
1528
1529     'part_virtual_field' => {
1530       'columns' => [
1531         'vfieldpart', 'serial', '', '', '', '',
1532         'dbtable', 'varchar', '', 32, '', '',
1533         'name', 'varchar', '', 32, '', '',
1534         'check_block', 'text', 'NULL', '', '', '',
1535         'length', 'int', 'NULL', '', '', '',
1536         'list_source', 'text', 'NULL', '', '', '',
1537         'label', 'varchar', 'NULL', 80, '', '',
1538       ],
1539       'primary_key' => 'vfieldpart',
1540       'unique' => [],
1541       'index' => [],
1542     },
1543
1544     'virtual_field' => {
1545       'columns' => [
1546         'vfieldnum', 'serial', '', '', '', '',
1547         'recnum', 'int', '', '', '', '',
1548         'vfieldpart', 'int', '', '', '', '',
1549         'value', 'varchar', '', 128, '', '',
1550       ],
1551       'primary_key' => 'vfieldnum',
1552       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1553       'index' => [],
1554     },
1555
1556     'acct_snarf' => {
1557       'columns' => [
1558         'snarfnum',  'int', '', '', '', '',
1559         'svcnum',    'int', '', '', '', '',
1560         'machine',   'varchar', '', 255, '', '',
1561         'protocol',  'varchar', '', $char_d, '', '',
1562         'username',  'varchar', '', $char_d, '', '',
1563         '_password', 'varchar', '', $char_d, '', '',
1564       ],
1565       'primary_key' => 'snarfnum',
1566       'unique' => [],
1567       'index'  => [ [ 'svcnum' ] ],
1568     },
1569
1570     'svc_external' => {
1571       'columns' => [
1572         'svcnum', 'int', '', '', '', '',
1573         'id',     'int', 'NULL', '', '', '',
1574         'title',  'varchar', 'NULL', $char_d, '', '',
1575       ],
1576       'primary_key' => 'svcnum',
1577       'unique'      => [],
1578       'index'       => [],
1579     },
1580
1581     'cust_pay_refund' => {
1582       'columns' => [
1583         'payrefundnum', 'serial', '', '', '', '',
1584         'paynum',  'int', '', '', '', '',
1585         'refundnum',  'int', '', '', '', '',
1586         '_date',    @date_type, '', '',
1587         'amount',   @money_type, '', '',
1588       ],
1589       'primary_key' => 'payrefundnum',
1590       'unique' => [],
1591       'index' => [ ['paynum'], ['refundnum'] ],
1592     },
1593
1594     'part_pkg_option' => {
1595       'columns' => [
1596         'optionnum', 'serial', '', '', '', '',
1597         'pkgpart', 'int', '', '', '', '',
1598         'optionname', 'varchar', '', $char_d, '', '',
1599         'optionvalue', 'text', 'NULL', '', '', '',
1600       ],
1601       'primary_key' => 'optionnum',
1602       'unique'      => [],
1603       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1604     },
1605
1606     'rate' => {
1607       'columns' => [
1608         'ratenum',  'serial', '', '', '', '',
1609         'ratename', 'varchar', '', $char_d, '', '',
1610       ],
1611       'primary_key' => 'ratenum',
1612       'unique'      => [],
1613       'index'       => [],
1614     },
1615
1616     'rate_detail' => {
1617       'columns' => [
1618         'ratedetailnum',   'serial', '', '', '', '',
1619         'ratenum',         'int',     '', '', '', '',
1620         'orig_regionnum',  'int', 'NULL', '', '', '',
1621         'dest_regionnum',  'int',     '', '', '', '',
1622         'min_included',    'int',     '', '', '', '',
1623         #'min_charge',      @money_type, '', '',
1624         'min_charge',      'decimal', '', '10,5', '', '',
1625         'sec_granularity', 'int',     '', '', '', '',
1626         #time period (link to table of periods)?
1627       ],
1628       'primary_key' => 'ratedetailnum',
1629       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1630       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1631     },
1632
1633     'rate_region' => {
1634       'columns' => [
1635         'regionnum',   'serial',      '', '', '', '',
1636         'regionname',  'varchar',     '', $char_d, '', '',
1637       ],
1638       'primary_key' => 'regionnum',
1639       'unique'      => [],
1640       'index'       => [],
1641     },
1642
1643     'rate_prefix' => {
1644       'columns' => [
1645         'prefixnum',   'serial',    '', '', '', '',
1646         'regionnum',   'int',       '', '',, '', '',
1647         'countrycode', 'varchar',     '', 3, '', '',
1648         'npa',         'varchar', 'NULL', 6, '', '',
1649         'nxx',         'varchar', 'NULL', 3, '', '',
1650       ],
1651       'primary_key' => 'prefixnum',
1652       'unique'      => [],
1653       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1654     },
1655
1656     'reg_code' => {
1657       'columns' => [
1658         'codenum',   'serial',    '', '', '', '',
1659         'code',      'varchar',   '', $char_d, '', '',
1660         'agentnum',  'int',       '', '', '', '',
1661       ],
1662       'primary_key' => 'codenum',
1663       'unique'      => [ [ 'agentnum', 'code' ] ],
1664       'index'       => [ [ 'agentnum' ] ],
1665     },
1666
1667     'reg_code_pkg' => {
1668       'columns' => [
1669         'codepkgnum', 'serial', '', '', '', '',
1670         'codenum',   'int',    '', '', '', '',
1671         'pkgpart',   'int',    '', '', '', '',
1672       ],
1673       'primary_key' => 'codepkgnum',
1674       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1675       'index'       => [ [ 'codenum' ] ],
1676     },
1677
1678     'clientapi_session' => {
1679       'columns' => [
1680         'sessionnum',  'serial',  '', '', '', '',
1681         'sessionid',  'varchar',  '', $char_d, '', '',
1682         'namespace',  'varchar',  '', $char_d, '', '',
1683       ],
1684       'primary_key' => 'sessionnum',
1685       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1686       'index'       => [],
1687     },
1688
1689     'clientapi_session_field' => {
1690       'columns' => [
1691         'fieldnum',    'serial',     '', '', '', '',
1692         'sessionnum',     'int',     '', '', '', '',
1693         'fieldname',  'varchar',     '', $char_d, '', '',
1694         'fieldvalue',    'text', 'NULL', '', '', '',
1695       ],
1696       'primary_key' => 'fieldnum',
1697       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1698       'index'       => [],
1699     },
1700
1701     'payment_gateway' => {
1702       'columns' => [
1703         'gatewaynum',       'serial',   '',     '', '', '',
1704         'gateway_module',   'varchar',  '',     $char_d, '', '',
1705         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1706         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1707         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1708         'disabled',   'char',  'NULL',   1, '', '',
1709       ],
1710       'primary_key' => 'gatewaynum',
1711       'unique' => [],
1712       'index'  => [ [ 'disabled' ] ],
1713     },
1714
1715     'payment_gateway_option' => {
1716       'columns' => [
1717         'optionnum',   'serial',  '',     '', '', '',
1718         'gatewaynum',  'int',     '',     '', '', '',
1719         'optionname',  'varchar', '',     $char_d, '', '',
1720         'optionvalue', 'text',    'NULL', '', '', '',
1721       ],
1722       'primary_key' => 'optionnum',
1723       'unique'      => [],
1724       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1725     },
1726
1727     'agent_payment_gateway' => {
1728       'columns' => [
1729         'agentgatewaynum', 'serial', '', '', '', '',
1730         'agentnum',        'int', '', '', '', '',
1731         'gatewaynum',      'int', '', '', '', '',
1732         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1733         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1734       ],
1735       'primary_key' => 'agentgatewaynum',
1736       'unique'      => [],
1737       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1738     },
1739
1740     'banned_pay' => {
1741       'columns' => [
1742         'bannum',  'serial',   '',     '', '', '',
1743         'payby',   'char',     '',       4, '', '',
1744         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1745         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1746         '_date',   @date_type, '', '',
1747         'otaker',  'varchar',  '',     32, '', '',
1748         'reason',  'varchar',  'NULL', $char_d, '', '',
1749       ],
1750       'primary_key' => 'bannum',
1751       'unique'      => [ [ 'payby', 'payinfo' ] ],
1752       'index'       => [],
1753     },
1754
1755     'pkg_class' => {
1756       'columns' => [
1757         'classnum',   'serial',  '', '', '', '',
1758         'classname',  'varchar', '', $char_d, '', '',
1759         'disabled',     'char', 'NULL',   1, '', '',
1760       ],
1761       'primary_key' => 'classnum',
1762       'unique' => [],
1763       'index' => [ ['disabled'] ],
1764     },
1765
1766     'cdr' => {
1767       'columns' => [
1768         # qw( name type null length default local );
1769
1770         ###
1771         #asterisk fields
1772         ###
1773
1774         'acctid',   'bigserial',  '', '', '', '',
1775         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1776         'calldate', 'timestamp',   '',      '', \'now()', '',
1777         'clid',        'varchar',  '', $char_d, \"''", '',
1778         'src',         'varchar',  '', $char_d, \"''", '',
1779         'dst',         'varchar',  '', $char_d, \"''", '',
1780         'dcontext',    'varchar',  '', $char_d, \"''", '',
1781         'channel',     'varchar',  '', $char_d, \"''", '',
1782         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1783         'lastapp',     'varchar',  '', $char_d, \"''", '',
1784         'lastdata',    'varchar',  '', $char_d, \"''", '',
1785
1786         #these don't seem to be logged by most of the SQL cdr_* modules
1787         #except tds under sql-illegal names, so;
1788         # ... don't rely on them for rating?
1789         # and, what they hey, i went ahead and changed the names and data types
1790         # to freeside-style dates...
1791           #'start',  'timestamp', 'NULL',  '',    '', '',
1792           #'answer', 'timestamp', 'NULL',  '',    '', '',
1793           #'end',    'timestamp', 'NULL',  '',    '', '',
1794         'startdate',  @date_type, '', '',
1795         'answerdate', @date_type, '', '',
1796         'enddate',    @date_type, '', '',
1797         #
1798
1799         'duration',    'int',      '',      '',     0, '',
1800         'billsec',     'int',      '',      '',     0, '',
1801         'disposition', 'varchar',  '',      45, \"''", '',
1802         'amaflags',    'int',      '',      '',     0, '',
1803         'accountcode', 'varchar',  '',      20, \"''", '',
1804         'uniqueid',    'varchar',  '',      32, \"''", '',
1805         'userfield',   'varchar',  '',     255, \"''", '',
1806
1807         ###
1808         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1809         # defaults
1810         ###
1811
1812         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1813         'cdrtypenum',              'int', 'NULL',      '', '', '',
1814
1815         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1816
1817         'upstream_currency',      'char', 'NULL',       3, '', '',
1818         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1819         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1820
1821         # how it was rated internally...
1822         'ratedetailnum',           'int', 'NULL',      '', '', '',
1823         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1824
1825         'distance',            'decimal', 'NULL',      '', '', '',
1826         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1827
1828         #cdr_calltype: the big list in appendix 2
1829         'calltypenum',             'int', 'NULL',      '', '', '',
1830
1831         'description',         'varchar', 'NULL', $char_d, '', '',
1832         'quantity',                'int', 'NULL',      '', '', '',
1833
1834         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1835         'carrierid',               'int', 'NULL',      '', '', '',
1836
1837         'upstream_rateid',         'int', 'NULL',      '', '', '',
1838
1839         ###
1840         #and now for our own fields
1841         ###
1842
1843         # a svcnum... right..?
1844         'svcnum',             'int',   'NULL',     '',   '', '',
1845
1846         #NULL, done (or something)
1847         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1848
1849       ],
1850       'primary_key' => 'acctid',
1851       'unique' => [],
1852       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1853     },
1854
1855     'cdr_calltype' => {
1856       'columns' => [
1857         'calltypenum',   'serial',  '', '', '', '',
1858         'calltypename',  'varchar', '', $char_d, '', '',
1859       ],
1860       'primary_key' => 'calltypenum',
1861       'unique'      => [],
1862       'index'       => [],
1863     },
1864
1865     'cdr_type' => {
1866       'columns' => [
1867         'cdrtypenum'  => 'serial',  '', '', '', '',
1868         'cdrtypename' => 'varchar', '', $char_d, '', '',
1869       ],
1870       'primary_key' => 'cdrtypenum',
1871       'unique'      => [],
1872       'index'       => [],
1873     },
1874
1875     'cdr_carrier' => {
1876       'columns' => [
1877         'carrierid'   => 'serial',  '', '', '', '',
1878         'carriername' => 'varchar', '', $char_d, '', '',
1879       ],
1880       'primary_key' => 'carrierid',
1881       'unique'      => [],
1882       'index'       => [],
1883     },
1884
1885     #map upstream rateid to ours...
1886     'cdr_upstream_rate' => {
1887       'columns' => [
1888         'upstreamratenum', 'serial',  '', '', '', '',
1889         'upstream_rateid', 'varchar', '', $char_d, '', '',
1890         'ratedetailnum',   'int', 'NULL', '', '', '',
1891       ],
1892       'primary_key' => 'upstreamratenum', #XXX need a primary key
1893       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1894       'index'  => [],
1895     },
1896
1897     'inventory_item' => {
1898       'columns' => [
1899         'itemnum',  'serial',      '',      '', '', '',
1900         'classnum', 'int',         '',      '', '', '',
1901         'item',     'varchar',     '', $char_d, '', '',
1902         'svcnum',   'int',     'NULL',      '', '', '',
1903       ],
1904       'primary_key' => 'itemnum',
1905       'unique' => [ [ 'classnum', 'item' ] ],
1906       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1907     },
1908
1909     'inventory_class' => {
1910       'columns' => [
1911         'classnum',  'serial',       '',      '', '', '',
1912         'classname', 'varchar',      '', $char_d, '', '',
1913       ],
1914       'primary_key' => 'classnum',
1915       'unique' => [],
1916       'index'  => [],
1917     },
1918
1919     'access_user' => {
1920       'columns' => [
1921         'usernum',   'serial',  '',      '', '', '',
1922         'username',  'varchar', '', $char_d, '', '',
1923         '_password', 'varchar', '', $char_d, '', '',
1924         'last',      'varchar', '', $char_d, '', '',
1925         'first',     'varchar', '', $char_d, '', '',
1926         'disabled',     'char', 'NULL',   1, '', '',
1927       ],
1928       'primary_key' => 'usernum',
1929       'unique' => [ [ 'username' ] ],
1930       'index'  => [],
1931     },
1932
1933     'access_user_pref' => {
1934       'columns' => [
1935         'prefnum',    'serial',       '', '', '', '',
1936         'usernum',     'int',       '', '', '', '',
1937         'prefname', 'varchar', '', $char_d, '', '',
1938         'prefvalue', 'text', 'NULL', '', '', '',
1939         'expiration', @date_type, '', '',
1940       ],
1941       'primary_key' => 'prefnum',
1942       'unique' => [],
1943       'index'  => [ [ 'usernum' ] ],
1944     },
1945
1946     'access_group' => {
1947       'columns' => [
1948         'groupnum',   'serial', '',      '', '', '',
1949         'groupname', 'varchar', '', $char_d, '', '',
1950       ],
1951       'primary_key' => 'groupnum',
1952       'unique' => [ [ 'groupname' ] ],
1953       'index'  => [],
1954     },
1955
1956     'access_usergroup' => {
1957       'columns' => [
1958         'usergroupnum', 'serial', '', '', '', '',
1959         'usernum',         'int', '', '', '', '',
1960         'groupnum',        'int', '', '', '', '',
1961       ],
1962       'primary_key' => 'usergroupnum',
1963       'unique' => [ [ 'usernum', 'groupnum' ] ],
1964       'index'  => [ [ 'usernum' ] ],
1965     },
1966
1967     'access_groupagent' => {
1968       'columns' => [
1969         'groupagentnum', 'serial', '', '', '', '',
1970         'groupnum',         'int', '', '', '', '',
1971         'agentnum',         'int', '', '', '', '',
1972       ],
1973       'primary_key' => 'groupagentnum',
1974       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1975       'index'  => [ [ 'groupnum' ] ],
1976     },
1977
1978     'access_right' => {
1979       'columns' => [
1980         'rightnum',   'serial', '',      '', '', '',
1981         'righttype', 'varchar', '', $char_d, '', '',
1982         'rightobjnum',   'int', '',      '', '', '',
1983         'rightname', 'varchar', '', $char_d, '', '',
1984       ],
1985       'primary_key' => 'rightnum',
1986       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1987       'index'  => [],
1988     },
1989
1990     'svc_phone' => {
1991       'columns' => [
1992         'svcnum',      'int',         '',      '', '', '',
1993         'countrycode', 'varchar',     '',       3, '', '',
1994         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1995         'pin',         'varchar', 'NULL', $char_d, '', '',
1996       ],
1997       'primary_key' => 'svcnum',
1998       'unique' => [],
1999       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2000     },
2001
2002     'reason_type' => {
2003       'columns' => [
2004         'typenum',   'serial',  '', '', '', '',
2005         'class',     'char', '', 1, '', '',
2006         'type',     'varchar', '', $char_d, '', '',
2007       ],
2008       'primary_key' => 'typenum',
2009       'unique' => [],
2010       'index' => [],
2011     },
2012
2013     'reason' => {
2014       'columns' => [
2015         'reasonnum',     'serial',  '', '', '', '',
2016         'reason_type',   'int',  '', '', '', '',
2017         'reason',        'text', '', '', '', '',
2018         'disabled',      'char',    'NULL', 1, '', '',
2019       ],
2020       'primary_key' => 'reasonnum',
2021       'unique' => [],
2022       'index' => [],
2023     },
2024
2025     'conf' => {
2026       'columns' => [
2027         'confnum',  'serial',  '', '', '', '',
2028         'agentnum', 'int',  'NULL', '', '', '',
2029         'name',     'varchar', '', $char_d, '', '',
2030         'value',    'text', 'NULL', '', '', '',
2031       ],
2032       'primary_key' => 'confnum',
2033       'unique' => [ [ 'agentnum', 'name' ]],
2034       'index' => [],
2035     },
2036
2037     'pkg_referral' => {
2038       'columns' => [
2039         'pkgrefnum',     'serial', '', '', '', '',
2040         'pkgnum',        'int',    '', '', '', '',
2041         'refnum',        'int',    '', '', '', '',
2042       ],
2043       'primary_key' => 'pkgrefnum',
2044       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2045       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2046     },
2047     # name type nullability length default local
2048
2049     #'new_table' => {
2050     #  'columns' => [
2051     #    'num', 'serial',       '', '', '', '',
2052     #  ],
2053     #  'primary_key' => 'num',
2054     #  'unique' => [],
2055     #  'index'  => [],
2056     #},
2057
2058   };
2059
2060 }
2061
2062 =back
2063
2064 =head1 BUGS
2065
2066 =head1 SEE ALSO
2067
2068 L<DBIx::DBSchema>
2069
2070 =cut
2071
2072 1;
2073