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