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       #can be removed once we depend on DBIx::DBSchema 0.39;
 106       $hash{'type'} = 'LONGTEXT'
 107         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 108
 109       unless ( defined $hash{'default'} ) {
 110         warn "$tablename:\n".
 111              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 112       }
 113
 114       push @columns, new DBIx::DBSchema::Column ( \%hash );
 115     }
 116
 117     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 118     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 119     my $unique = $tables_hashref->{$tablename}{'unique'};
 120     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 121
 122     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 123     #  specification without a key length".
 124     # better solution: teach DBIx::DBSchema to specify a default length for
 125     #  MySQL indices on text columns, or just to support an index length at all
 126     #  so we can pass something in.
 127     # best solution: eliminate need for this index in cust_main::retry_realtime
 128     @index = grep { @{$_}[0] ne 'statustext' } @index
 129       if $datasrc =~ /^dbi:mysql/i;
 130
 131     my @indices = ();
 132     push @indices, map {
 133                          DBIx::DBSchema::Index->new({
 134                            'name'    => $tablename. $indexnum++,
 135                            'unique'  => 1,
 136                            'columns' => $_,
 137                          });
 138                        }
 139                        @$unique;
 140     push @indices, map {
 141                          DBIx::DBSchema::Index->new({
 142                            'name'    => $tablename. $indexnum++,
 143                            'unique'  => 0,
 144                            'columns' => $_,
 145                          });
 146                        }
 147                        @index;
 148
 149     DBIx::DBSchema::Table->new({
 150       'name'          => $tablename,
 151       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 152       'columns'       => \@columns,
 153       'indices'       => \@indices,
 154       'local_options' => $local_options,
 155     });
 156
 157   } keys %$tables_hashref;
 158
 159   if ( $DEBUG ) {
 160     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 161     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 162   }
 163
 164   #add radius attributes to svc_acct
 165   #
 166   #my($svc_acct)=$dbdef->table('svc_acct');
 167   #
 168   #my($attribute);
 169   #foreach $attribute (@attributes) {
 170   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 171   #    'radius_'. $attribute,
 172   #    'varchar',
 173   #    'NULL',
 174   #    $char_d,
 175   #  ));
 176   #}
 177   #
 178   #foreach $attribute (@check_attributes) {
 179   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 180   #    'rc_'. $attribute,
 181   #    'varchar',
 182   #    'NULL',
 183   #    $char_d,
 184   #  ));
 185   #}
 186
 187   #create history tables (false laziness w/create-history-tables)
 188   foreach my $table (
 189     grep { ! /^clientapi_session/ }
 190     grep { ! /^h_/ }
 191     $dbdef->tables
 192   ) {
 193     my $tableobj = $dbdef->table($table)
 194       or die "unknown table $table";
 195
 196     my %indices = $tableobj->indices;
 197
 198     my %h_indices = map {
 199                           ( "h_$_" =>
 200                               DBIx::DBSchema::Index->new({
 201                                 'name'    => 'h_'. $indices{$_}->name,
 202                                 'unique'  => 0,
 203                                 'columns' => [ @{$indices{$_}->columns} ],
 204                               })
 205                           );
 206                         }
 207                         keys %indices;
 208
 209     $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
 210                                         'name'    => "h_${table}_srckey",
 211                                         'unique'  => 0,
 212                                         'columns' => [ 'history_action', #right?
 213                                                        $tableobj->primary_key,
 214                                                      ],
 215                                       });
 216
 217     $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
 218                                          'name'    => "h_${table}_srckey2",
 219                                          'unique'  => 0,
 220                                          'columns' => [ 'history_date',
 221                                                         $tableobj->primary_key,
 222                                                       ],
 223                                        });
 224
 225     my $h_tableobj = DBIx::DBSchema::Table->new( {
 226       'name'          => "h_$table",
 227       'primary_key'   => 'historynum',
 228       'indices'       => \%h_indices,
 229       'local_options' => $local_options,
 230       'columns'       => [
 231           DBIx::DBSchema::Column->new( {
 232             'name'    => 'historynum',
 233             'type'    => 'serial',
 234             'null'    => 'NOT NULL',
 235             'length'  => '',
 236             'default' => '',
 237             'local'   => '',
 238           } ),
 239           DBIx::DBSchema::Column->new( {
 240             'name'    => 'history_date',
 241             'type'    => 'int',
 242             'null'    => 'NULL',
 243             'length'  => '',
 244             'default' => '',
 245             'local'   => '',
 246           } ),
 247           DBIx::DBSchema::Column->new( {
 248             'name'    => 'history_user',
 249             'type'    => 'varchar',
 250             'null'    => 'NOT NULL',
 251             'length'  => '80',
 252             'default' => '',
 253             'local'   => '',
 254           } ),
 255           DBIx::DBSchema::Column->new( {
 256             'name'    => 'history_action',
 257             'type'    => 'varchar',
 258             'null'    => 'NOT NULL',
 259             'length'  => '80',
 260             'default' => '',
 261             'local'   => '',
 262           } ),
 263           map {
 264             my $column = $tableobj->column($_);
 265
 266             #clone so as to not disturb the original
 267             $column = DBIx::DBSchema::Column->new( {
 268               map { $_ => $column->$_() }
 269                 qw( name type null length default local )
 270             } );
 271
 272             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 273               $column->type(uc($1).'INT');
 274               $column->null('NULL');
 275             }
 276             #$column->default('')
 277             #  if $column->default =~ /^nextval\(/i;
 278             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 279             #$column->local($local);
 280             $column;
 281           } $tableobj->columns
 282       ],
 283     } );
 284     $dbdef->addtable($h_tableobj);
 285   }
 286
 287   if ( $datasrc =~ /^dbi:mysql/i ) {
 288
 289     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 290       'name'          => 'duplicate_lock',
 291       'primary_key'   => 'duplocknum',
 292       'local_options' => $local_options,
 293       'columns'       => [
 294         DBIx::DBSchema::Column->new( {
 295           'name'    => 'duplocknum',
 296           'type'    => 'serial',
 297           'null'    => 'NOT NULL',
 298           'length'  => '',
 299           'default' => '',
 300           'local'   => '',
 301         } ),
 302         DBIx::DBSchema::Column->new( {
 303           'name'    => 'lockname',
 304           'type'    => 'varchar',
 305           'null'    => 'NOT NULL',
 306           'length'  => '80',
 307           'default' => '',
 308           'local'   => '',
 309         } ),
 310       ],
 311       'indices' => { 'duplicate_lock1' =>
 312                        DBIx::DBSchema::Index->new({
 313                          'name'    => 'duplicate_lock1',
 314                          'unique'  => 1,
 315                          'columns' => [ 'lockname' ],
 316                        })
 317                    },
 318     } );
 319
 320     $dbdef->addtable($dup_lock_table);
 321
 322   }
 323
 324   $dbdef;
 325
 326 }
 327
 328 sub tables_hashref {
 329
 330   my $char_d = 80; #default maxlength for text fields
 331
 332   #my(@date_type)  = ( 'timestamp', '', ''     );
 333   my @date_type  = ( 'int', 'NULL', ''     );
 334   my @perl_type = ( 'text', 'NULL', ''  );
 335   my @money_type = ( 'decimal',   '', '10,2' );
 336   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 337   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 338   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 339
 340   my $username_len = 32; #usernamemax config file
 341
 342     # name type nullability length default local
 343
 344   return {
 345
 346     'agent' => {
 347       'columns' => [
 348         'agentnum',          'serial',    '',       '', '', '',
 349         'agent',            'varchar',    '',  $char_d, '', '',
 350         'typenum',              'int',    '',       '', '', '',
 351         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 352         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 353         'agent_custnum',        'int', 'NULL',      '', '', '',
 354         'disabled',            'char', 'NULL',       1, '', '',
 355         'username',         'varchar', 'NULL', $char_d, '', '', #deprecated
 356         '_password',        'varchar', 'NULL', $char_d, '', '', #deprecated
 357         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 358         'prog',                     @perl_type, '', '', #deprecated (never used)
 359       ],
 360       'primary_key' => 'agentnum',
 361       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 362                                             #insert is giving it a value, tho..
 363       #'index' => [ ['typenum'], ['disabled'] ],
 364       'unique' => [],
 365       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 366     },
 367
 368     'agent_type' => {
 369       'columns' => [
 370         'typenum',   'serial',  '', '', '', '',
 371         'atype',     'varchar', '', $char_d, '', '',
 372       ],
 373       'primary_key' => 'typenum',
 374       'unique' => [],
 375       'index' => [],
 376     },
 377
 378     'type_pkgs' => {
 379       'columns' => [
 380         'typepkgnum', 'serial', '', '', '', '',
 381         'typenum',   'int',  '', '', '', '',
 382         'pkgpart',   'int',  '', '', '', '',
 383       ],
 384       'primary_key' => 'typepkgnum',
 385       'unique' => [ ['typenum', 'pkgpart'] ],
 386       'index' => [ ['typenum'] ],
 387     },
 388
 389     'cust_attachment' => {
 390       'columns' => [
 391         'attachnum', 'serial', '', '', '', '',
 392         'custnum',   'int', '', '', '', '',
 393         '_date',     @date_type, '', '',
 394         'otaker',    'varchar', '', 32, '', '',
 395         'filename',  'varchar', '', 255, '', '',
 396         'mime_type', 'varchar', '', $char_d, '', '',
 397         'title',     'varchar', 'NULL', $char_d, '', '',
 398         'body',      'blob', 'NULL', '', '', '',
 399         'disabled',  @date_type, '', '',
 400       ],
 401       'primary_key' => 'attachnum',
 402       'unique'      => [],
 403       'index'       => [ ['custnum'] ],
 404     },
 405
 406     'cust_bill' => {
 407       'columns' => [
 408         #regular fields
 409         'invnum',    'serial',     '', '', '', '',
 410         'custnum',      'int',     '', '', '', '',
 411         '_date',        @date_type,        '', '',
 412         'charged',      @money_type,       '', '',
 413         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 414
 415         #customer balance info at invoice generation time
 416         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 417         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 418
 419         #deprecated (unused by now, right?)
 420         'printed',      'int',     '', '', '', '',
 421
 422         #specific use cases
 423         'closed',      'char', 'NULL',  1, '', '',
 424         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 425       ],
 426       'primary_key' => 'invnum',
 427       'unique' => [],
 428       'index' => [ ['custnum'], ['_date'], ['statementnum'], ],
 429     },
 430
 431     'cust_statement' => {
 432       'columns' => [
 433         'statementnum', 'serial', '', '', '', '',
 434         'custnum',         'int', '', '', '', '',
 435         '_date',           @date_type,    '', '',
 436       ],
 437       'primary_key' => 'statementnum',
 438       'unique' => [],
 439       'index' => [ ['custnum'], ['_date'], ],
 440     },
 441
 442     'cust_bill_event' => {
 443       'columns' => [
 444         'eventnum',    'serial',  '', '', '', '',
 445         'invnum',   'int',  '', '', '', '',
 446         'eventpart',   'int',  '', '', '', '',
 447         '_date',     @date_type, '', '',
 448         'status', 'varchar', '', $char_d, '', '',
 449         'statustext', 'text', 'NULL', '', '', '',
 450       ],
 451       'primary_key' => 'eventnum',
 452       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 453       'unique' => [],
 454       'index' => [ ['invnum'], ['status'], ['eventpart'],
 455                    ['statustext'], ['_date'],
 456                  ],
 457     },
 458
 459     'part_bill_event' => {
 460       'columns' => [
 461         'eventpart',    'serial',  '', '', '', '',
 462         'freq',        'varchar',       'NULL',     $char_d, '', '',
 463         'payby',       'char',  '', 4, '', '',
 464         'event',       'varchar',           '',     $char_d, '', '',
 465         'eventcode',    @perl_type, '', '',
 466         'seconds',     'int', 'NULL', '', '', '',
 467         'weight',      'int', '', '', '', '',
 468         'plan',       'varchar', 'NULL', $char_d, '', '',
 469         'plandata',   'text', 'NULL', '', '', '',
 470         'reason',     'int', 'NULL', '', '', '',
 471         'disabled',     'char', 'NULL', 1, '', '',
 472       ],
 473       'primary_key' => 'eventpart',
 474       'unique' => [],
 475       'index' => [ ['payby'], ['disabled'], ],
 476     },
 477
 478     'part_event' => {
 479       'columns' => [
 480         'eventpart',   'serial',      '',      '', '', '',
 481         'agentnum',    'int',     'NULL',      '', '', '',
 482         'event',       'varchar',     '', $char_d, '', '',
 483         'eventtable',  'varchar',     '', $char_d, '', '',
 484         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 485         'weight',      'int',         '',      '', '', '',
 486         'action',      'varchar',     '', $char_d, '', '',
 487         'disabled',     'char',   'NULL',       1, '', '',
 488       ],
 489       'primary_key' => 'eventpart',
 490       'unique' => [],
 491       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 492     },
 493
 494     'part_event_option' => {
 495       'columns' => [
 496         'optionnum', 'serial', '', '', '', '',
 497         'eventpart', 'int', '', '', '', '',
 498         'optionname', 'varchar', '', $char_d, '', '',
 499         'optionvalue', 'text', 'NULL', '', '', '',
 500       ],
 501       'primary_key' => 'optionnum',
 502       'unique'      => [],
 503       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 504     },
 505
 506     'part_event_condition' => {
 507       'columns' => [
 508         'eventconditionnum', 'serial', '', '', '', '',
 509         'eventpart', 'int', '', '', '', '',
 510         'conditionname', 'varchar', '', $char_d, '', '',
 511       ],
 512       'primary_key' => 'eventconditionnum',
 513       'unique'      => [],
 514       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 515     },
 516
 517     'part_event_condition_option' => {
 518       'columns' => [
 519         'optionnum', 'serial', '', '', '', '',
 520         'eventconditionnum', 'int', '', '', '', '',
 521         'optionname', 'varchar', '', $char_d, '', '',
 522         'optionvalue', 'text', 'NULL', '', '', '',
 523       ],
 524       'primary_key' => 'optionnum',
 525       'unique'      => [],
 526       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 527     },
 528
 529     'part_event_condition_option_option' => {
 530       'columns' => [
 531         'optionoptionnum', 'serial', '', '', '', '',
 532         'optionnum', 'int', '', '', '', '',
 533         'optionname', 'varchar', '', $char_d, '', '',
 534         'optionvalue', 'text', 'NULL', '', '', '',
 535       ],
 536       'primary_key' => 'optionoptionnum',
 537       'unique'      => [],
 538       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 539     },
 540
 541     'cust_event' => {
 542       'columns' => [
 543         'eventnum',    'serial',  '', '', '', '',
 544         'eventpart',   'int',  '', '', '', '',
 545         'tablenum',   'int',  '', '', '', '',
 546         '_date',     @date_type, '', '',
 547         'status', 'varchar', '', $char_d, '', '',
 548         'statustext', 'text', 'NULL', '', '', '',
 549       ],
 550       'primary_key' => 'eventnum',
 551       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 552       'unique' => [],
 553       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 554                    ['statustext'], ['_date'],
 555                  ],
 556     },
 557
 558     'cust_bill_pkg' => {
 559       'columns' => [
 560         'billpkgnum',        'serial',     '',      '', '', '',
 561         'invnum',               'int',     '',      '', '', '',
 562         'pkgnum',               'int',     '',      '', '', '',
 563         'pkgpart_override',     'int', 'NULL',      '', '', '',
 564         'setup',               @money_type,             '', '',
 565         'recur',               @money_type,             '', '',
 566         'sdate',               @date_type,              '', '',
 567         'edate',               @date_type,              '', '',
 568         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 569         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 570         'section',          'varchar', 'NULL', $char_d, '', '',
 571         'quantity',             'int', 'NULL',      '', '', '',
 572         'unitsetup',           @money_typen,            '', '',
 573         'unitrecur',           @money_typen,            '', '',
 574         'hidden',              'char', 'NULL',       1, '', '',
 575       ],
 576       'primary_key' => 'billpkgnum',
 577       'unique' => [],
 578       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 579     },
 580
 581     'cust_bill_pkg_detail' => {
 582       'columns' => [
 583         'detailnum', 'serial', '', '', '', '',
 584         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 585         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 586         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 587         'amount',  'decimal', 'NULL', '10,4', '', '',
 588         'format',  'char', 'NULL', 1, '', '',
 589         'classnum', 'int', 'NULL', '', '', '',
 590         'duration', 'int', 'NULL', '',  0, '',
 591         'phonenum', 'varchar', 'NULL', 15, '', '',
 592         'regionname', 'varchar', 'NULL', $char_d, '', '',
 593         'detail',  'varchar', '', 255, '', '',
 594       ],
 595       'primary_key' => 'detailnum',
 596       'unique' => [],
 597       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 598     },
 599
 600     'cust_bill_pkg_display' => {
 601       'columns' => [
 602         'billpkgdisplaynum', 'serial', '', '', '', '',
 603         'billpkgnum', 'int', '', '', '', '',
 604         'section',  'varchar', 'NULL', $char_d, '', '',
 605         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 606         #'unitrecur', @money_typen, '', '',     #this too?
 607         'post_total', 'char', 'NULL', 1, '', '',
 608         'type',       'char', 'NULL', 1, '', '',
 609         'summary',    'char', 'NULL', 1, '', '',
 610       ],
 611       'primary_key' => 'billpkgdisplaynum',
 612       'unique' => [],
 613       'index' => [ ['billpkgnum'], ],
 614     },
 615
 616     'cust_bill_pkg_tax_location' => {
 617       'columns' => [
 618         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 619         'billpkgnum',               'int',      '', '', '', '',
 620         'taxnum',                   'int',      '', '', '', '',
 621         'taxtype',              'varchar',      '', $char_d, '', '',
 622         'pkgnum',                   'int',      '', '', '', '',
 623         'locationnum',              'int',      '', '', '', '', #redundant?
 624         'amount',                   @money_type,        '', '',
 625       ],
 626       'primary_key' => 'billpkgtaxlocationnum',
 627       'unique' => [],
 628       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 629     },
 630
 631     'cust_bill_pkg_tax_rate_location' => {
 632       'columns' => [
 633         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 634         'billpkgnum',                   'int',      '', '', '', '',
 635         'taxnum',                       'int',      '', '', '', '',
 636         'taxtype',                  'varchar',      '', $char_d, '', '',
 637         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 638         'taxratelocationnum',           'int',      '', '', '', '',
 639         'amount',                       @money_type,        '', '',
 640       ],
 641       'primary_key' => 'billpkgtaxratelocationnum',
 642       'unique' => [],
 643       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 644     },
 645
 646     'cust_credit' => {
 647       'columns' => [
 648         'crednum',  'serial', '', '', '', '',
 649         'custnum',  'int', '', '', '', '',
 650         '_date',    @date_type, '', '',
 651         'amount',   @money_type, '', '',
 652         'otaker',   'varchar', '', 32, '', '',
 653         'reason',   'text', 'NULL', '', '', '',
 654         'reasonnum', 'int', 'NULL', '', '', '',
 655         'addlinfo', 'text', 'NULL', '', '', '',
 656         'closed',    'char', 'NULL', 1, '', '',
 657         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 658         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
 659       ],
 660       'primary_key' => 'crednum',
 661       'unique' => [],
 662       'index' => [ ['custnum'], ['_date'], ['eventnum'] ],
 663     },
 664
 665     'cust_credit_bill' => {
 666       'columns' => [
 667         'creditbillnum', 'serial', '', '', '', '',
 668         'crednum',  'int', '', '', '', '',
 669         'invnum',  'int', '', '', '', '',
 670         '_date',    @date_type, '', '',
 671         'amount',   @money_type, '', '',
 672         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 673       ],
 674       'primary_key' => 'creditbillnum',
 675       'unique' => [],
 676       'index' => [ ['crednum'], ['invnum'] ],
 677     },
 678
 679     'cust_credit_bill_pkg' => {
 680       'columns' => [
 681         'creditbillpkgnum', 'serial', '',      '', '', '',
 682         'creditbillnum',       'int', '',      '', '', '',
 683         'billpkgnum',          'int', '',      '', '', '',
 684         'amount',            @money_type,          '', '',
 685         'setuprecur',      'varchar', '', $char_d, '', '',
 686         'sdate',   @date_type, '', '',
 687         'edate',   @date_type, '', '',
 688       ],
 689       'primary_key' => 'creditbillpkgnum',
 690       'unique'      => [],
 691       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 692     },
 693
 694     'cust_main' => {
 695       'columns' => [
 696         'custnum',  'serial',  '',     '', '', '',
 697         'agentnum', 'int',  '',     '', '', '',
 698         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 699         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 700 #        'titlenum', 'int',  'NULL',   '', '', '',
 701         'last',     'varchar', '',     $char_d, '', '',
 702 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 703         'first',    'varchar', '',     $char_d, '', '',
 704         'ss',       'varchar', 'NULL', 11, '', '',
 705         'stateid', 'varchar', 'NULL', $char_d, '', '',
 706         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 707         'birthdate' ,@date_type, '', '',
 708         'signupdate',@date_type, '', '',
 709         'dundate',   @date_type, '', '',
 710         'company',  'varchar', 'NULL', $char_d, '', '',
 711         'address1', 'varchar', '',     $char_d, '', '',
 712         'address2', 'varchar', 'NULL', $char_d, '', '',
 713         'city',     'varchar', '',     $char_d, '', '',
 714         'county',   'varchar', 'NULL', $char_d, '', '',
 715         'state',    'varchar', 'NULL', $char_d, '', '',
 716         'zip',      'varchar', 'NULL', 10, '', '',
 717         'country',  'char', '',     2, '', '',
 718         'daytime',  'varchar', 'NULL', 20, '', '',
 719         'night',    'varchar', 'NULL', 20, '', '',
 720         'fax',      'varchar', 'NULL', 12, '', '',
 721         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 722 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 723         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 724         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 725         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 726         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 727         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 728         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 729         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 730         'ship_zip',      'varchar', 'NULL', 10, '', '',
 731         'ship_country',  'char', 'NULL', 2, '', '',
 732         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 733         'ship_night',    'varchar', 'NULL', 20, '', '',
 734         'ship_fax',      'varchar', 'NULL', 12, '', '',
 735         'payby',    'char', '',     4, '', '',
 736         'payinfo',  'varchar', 'NULL', 512, '', '',
 737         'paycvv',   'varchar', 'NULL', 512, '', '',
 738         'paymask', 'varchar', 'NULL', $char_d, '', '',
 739         #'paydate',  @date_type, '', '',
 740         'paydate',  'varchar', 'NULL', 10, '', '',
 741         'paystart_month', 'int', 'NULL', '', '', '',
 742         'paystart_year',  'int', 'NULL', '', '', '',
 743         'payissue', 'varchar', 'NULL', 2, '', '',
 744         'payname',  'varchar', 'NULL', $char_d, '', '',
 745         'paystate', 'varchar', 'NULL', $char_d, '', '',
 746         'paytype',  'varchar', 'NULL', $char_d, '', '',
 747         'payip',    'varchar', 'NULL', 15, '', '',
 748         'geocode',  'varchar', 'NULL', 20,  '', '',
 749         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
 750         'tax',      'char', 'NULL', 1, '', '',
 751         'otaker',   'varchar', '',    32, '', '',
 752         'refnum',   'int',  '',     '', '', '',
 753         'referral_custnum', 'int',  'NULL', '', '', '',
 754         'comments', 'text', 'NULL', '', '', '',
 755         'spool_cdr','char', 'NULL', 1, '', '',
 756         'squelch_cdr','char', 'NULL', 1, '', '',
 757         'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
 758         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 759         'archived', 'char', 'NULL', 1, '', '',
 760         'email_csv_cdr', 'char', 'NULL', 1, '', '',
 761       ],
 762       'primary_key' => 'custnum',
 763       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 764       #'index' => [ ['last'], ['company'] ],
 765       'index' => [
 766                    [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
 767                    [ 'referral_custnum' ],
 768                    [ 'payby' ], [ 'paydate' ],
 769                    [ 'archived' ],
 770                    #billing
 771                    [ 'last' ], [ 'company' ],
 772                    [ 'county' ], [ 'state' ], [ 'country' ],
 773                    [ 'zip' ],
 774                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 775                    #shipping
 776                    [ 'ship_last' ], [ 'ship_company' ],
 777                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 778                    [ 'ship_zip' ],
 779                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 780                  ],
 781     },
 782
 783     'cust_recon' => {  # what purpose does this serve?
 784       'columns' => [
 785         'reconid',      'serial',  '',          '', '', '',
 786         'recondate',    @date_type,                 '', '',
 787         'custnum',      'int'   ,  '',          '', '', '',
 788         'agentnum',     'int',     '',          '', '', '',
 789         'last',         'varchar', '',     $char_d, '', '',
 790         'first',        'varchar', '',     $char_d, '', '',
 791         'address1',     'varchar', '',     $char_d, '', '',
 792         'address2',     'varchar', 'NULL', $char_d, '', '',
 793         'city',         'varchar', '',     $char_d, '', '',
 794         'state',        'varchar', 'NULL', $char_d, '', '',
 795         'zip',          'varchar', 'NULL',      10, '', '',
 796         'pkg',          'varchar', 'NULL', $char_d, '', '',
 797         'adjourn',      @date_type,                 '', '',
 798         'status',       'varchar', 'NULL',      10, '', '',
 799         'agent_custid', 'varchar',  '',    $char_d, '', '',
 800         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 801         'agent_adjourn', @date_type,                '', '',
 802         'comments',     'text',    'NULL',      '', '', '',
 803       ],
 804       'primary_key' => 'reconid',
 805       'unique' => [],
 806       'index' => [],
 807     },
 808
 809     #eventually use for billing & ship from cust_main too
 810     #for now, just cust_pkg locations
 811     'cust_location' => {
 812       'columns' => [
 813         'locationnum',  'serial',     '',      '', '', '',
 814         'custnum',         'int',     '',      '', '', '',
 815         'address1',    'varchar',     '', $char_d, '', '',
 816         'address2',    'varchar', 'NULL', $char_d, '', '',
 817         'city',        'varchar',     '', $char_d, '', '',
 818         'county',      'varchar', 'NULL', $char_d, '', '',
 819         'state',       'varchar', 'NULL', $char_d, '', '',
 820         'zip',         'varchar', 'NULL',      10, '', '',
 821         'country',        'char',     '',       2, '', '',
 822         'geocode',     'varchar', 'NULL',      20, '', '',
 823       ],
 824       'primary_key' => 'locationnum',
 825       'unique'      => [],
 826       'index'       => [ [ 'custnum' ],
 827                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 828                        ],
 829     },
 830
 831     'cust_main_invoice' => {
 832       'columns' => [
 833         'destnum',  'serial',  '',     '', '', '',
 834         'custnum',  'int',  '',     '', '', '',
 835         'dest',     'varchar', '',  $char_d, '', '',
 836       ],
 837       'primary_key' => 'destnum',
 838       'unique' => [],
 839       'index' => [ ['custnum'], ],
 840     },
 841
 842     'cust_main_note' => {
 843       'columns' => [
 844         'notenum',  'serial',  '',     '', '', '',
 845         'custnum',  'int',  '',     '', '', '',
 846         '_date',    @date_type, '', '',
 847         'otaker',   'varchar', '',    32, '', '',
 848         'comments', 'text', 'NULL', '', '', '',
 849       ],
 850       'primary_key' => 'notenum',
 851       'unique' => [],
 852       'index' => [ [ 'custnum' ], [ '_date' ], ],
 853     },
 854
 855     'cust_main_exemption' => {
 856       'columns' => [
 857         'exemptionnum', 'serial', '',      '', '', '',
 858         'custnum',         'int', '',      '', '', '',
 859         'taxname',     'varchar', '', $char_d, '', '',
 860         #start/end dates?  for reporting?
 861       ],
 862       'primary_key' => 'exemptionnum',
 863       'unique'      => [],
 864       'index'       => [ [ 'custnum' ] ],
 865     },
 866
 867     'cust_tax_adjustment' => {
 868       'columns' => [
 869         'adjustmentnum', 'serial',     '',      '', '', '',
 870         'custnum',          'int',     '',      '', '', '',
 871         'taxname',      'varchar',     '', $char_d, '', '',
 872         'amount',    @money_type,                   '', '',
 873         'comment',     'varchar',  'NULL', $char_d, '', '',
 874         'billpkgnum',       'int', 'NULL',      '', '', '',
 875         #more?  no cust_bill_pkg_tax_location?
 876       ],
 877       'primary_key' => 'adjustmentnum',
 878       'unique'      => [],
 879       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
 880     },
 881
 882     'cust_main_county' => { #county+state+country are checked off the
 883                             #cust_main_county for validation and to provide
 884                             # a tax rate.
 885       'columns' => [
 886         'taxnum',   'serial',   '',    '', '', '',
 887         'state',    'varchar',  'NULL',    $char_d, '', '',
 888         'county',   'varchar',  'NULL',    $char_d, '', '',
 889         'country',  'char',  '', 2, '', '',
 890         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 891         'exempt_amount', @money_type, '', '',
 892         'tax',      'real',  '',    '', '', '', #tax %
 893         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 894         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 895         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 896       ],
 897       'primary_key' => 'taxnum',
 898       'unique' => [],
 899   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 900       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
 901                    [ 'taxclass' ],
 902                  ],
 903     },
 904
 905     'tax_rate'    => {
 906       'columns' => [
 907         'taxnum',       'serial',     '',      '', '', '',
 908         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 909         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 910         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 911         'taxclassnum', 'int',      '',      '', '', '',
 912         'effective_date', @date_type, '', '',
 913         'tax',        @taxrate_type,      '', '',        # tax %
 914         'excessrate', @taxrate_typen,     '', '',        # second tax %
 915         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 916         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 917         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
 918         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
 919         'unittype',    'int',  'NULL', '', '', '',      # for fee
 920         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
 921         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
 922         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
 923         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
 924         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 925         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 926         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 927         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 928         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 929         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 930         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 931         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 932         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
 933         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
 934         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 935         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
 936       ],
 937       'primary_key' => 'taxnum',
 938       'unique' => [],
 939       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 940     },
 941
 942     'tax_rate_location' => {
 943       'columns' => [
 944         'taxratelocationnum', 'serial',  '',     '', '', '',
 945         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
 946         'geocode',            'varchar', '',     20,      '', '',
 947         'city',               'varchar', 'NULL', $char_d, '', '',
 948         'county',             'varchar', 'NULL', $char_d, '', '',
 949         'state',              'char',    'NULL',       2, '', '',
 950         'disabled',           'char',    'NULL', 1, '', '',
 951       ],
 952       'primary_key' => 'taxratelocationnum',
 953       'unique' => [],
 954       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
 955     },
 956
 957     'cust_tax_location' => {
 958       'columns' => [
 959         'custlocationnum', 'serial',  '',     '', '', '',
 960         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 961         'city',            'varchar', 'NULL', $char_d, '', '',
 962         'postalcity',      'varchar', 'NULL', $char_d, '', '',
 963         'county',          'varchar', 'NULL', $char_d, '', '',
 964         'zip',             'char',    '',     5,  '', '',
 965         'state',           'char',    '',     2,  '', '',
 966         'plus4hi',         'char',    'NULL', 4,  '', '',
 967         'plus4lo',         'char',    'NULL', 4,  '', '',
 968         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 969         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
 970         'geocode',         'varchar', '',    20,  '', '',
 971       ],
 972       'primary_key' => 'custlocationnum',
 973       'unique' => [],
 974       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 975     },
 976
 977     'tax_class' => {
 978       'columns' => [
 979         'taxclassnum',  'serial',  '',            '', '', '',
 980         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
 981         'taxclass',     'varchar', '',       $char_d, '', '',
 982         'description',  'varchar', '',     2*$char_d, '', '',
 983       ],
 984       'primary_key' => 'taxclassnum',
 985       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
 986       'index' => [],
 987     },
 988
 989     'cust_pay_pending' => {
 990       'columns' => [
 991         'paypendingnum','serial',      '',  '', '', '',
 992         'custnum',      'int',         '',  '', '', '',
 993         'paid',         @money_type,            '', '',
 994         '_date',        @date_type,             '', '',
 995         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
 996                                                         # be index into payby
 997                                                         # table eventually
 998         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
 999         'paymask',      'varchar', 'NULL', $char_d, '', '',
1000         'paydate',      'varchar', 'NULL', 10, '', '',
1001         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1002         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1003         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1004
1005         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1006         'status',       'varchar',     '', $char_d, '', '',
1007         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1008         'statustext',   'text',    'NULL',  '', '', '',
1009         'gatewaynum',   'int',     'NULL',  '', '', '',
1010         #'cust_balance', @money_type,            '', '',
1011         'paynum',       'int',     'NULL',  '', '', '',
1012         'jobnum',       'int',     'NULL',  '', '', '',
1013       ],
1014       'primary_key' => 'paypendingnum',
1015       'unique'      => [ [ 'payunique' ] ],
1016       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1017     },
1018
1019     'cust_pay' => {
1020       'columns' => [
1021         'paynum',   'serial',    '',   '', '', '',
1022         'custnum',  'int',    '',   '', '', '',
1023         '_date',    @date_type, '', '',
1024         'paid',     @money_type, '', '',
1025         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
1026         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1027                                                  # index into payby table
1028                                                  # eventually
1029         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1030         'paymask', 'varchar', 'NULL', $char_d, '', '',
1031         'paydate',  'varchar', 'NULL', 10, '', '',
1032         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1033         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1034         'closed',    'char', 'NULL', 1, '', '',
1035         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1036       ],
1037       'primary_key' => 'paynum',
1038       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1039       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
1040     },
1041
1042     'cust_pay_void' => {
1043       'columns' => [
1044         'paynum',    'int',    '',   '', '', '',
1045         'custnum',   'int',    '',   '', '', '',
1046         'paid',      @money_type, '', '',
1047         '_date',     @date_type, '', '',
1048         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1049                                                   # index into payby table
1050                                                   # eventually
1051         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1052         'paymask', 'varchar', 'NULL', $char_d, '', '',
1053         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1054         'closed',    'char', 'NULL', 1, '', '',
1055         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1056         'void_date', @date_type, '', '',
1057         'reason',    'varchar',   'NULL', $char_d, '', '',
1058         'otaker',   'varchar', '', 32, '', '',
1059       ],
1060       'primary_key' => 'paynum',
1061       'unique' => [],
1062       'index' => [ [ 'custnum' ] ],
1063     },
1064
1065     'cust_bill_pay' => {
1066       'columns' => [
1067         'billpaynum', 'serial',     '',   '', '', '',
1068         'invnum',  'int',     '',   '', '', '',
1069         'paynum',  'int',     '',   '', '', '',
1070         'amount',  @money_type, '', '',
1071         '_date',   @date_type, '', '',
1072         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1073       ],
1074       'primary_key' => 'billpaynum',
1075       'unique' => [],
1076       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1077     },
1078
1079     'cust_bill_pay_batch' => {
1080       'columns' => [
1081         'billpaynum', 'serial',     '',   '', '', '',
1082         'invnum',  'int',     '',   '', '', '',
1083         'paybatchnum',  'int',     '',   '', '', '',
1084         'amount',  @money_type, '', '',
1085         '_date',   @date_type, '', '',
1086       ],
1087       'primary_key' => 'billpaynum',
1088       'unique' => [],
1089       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1090     },
1091
1092     'cust_bill_pay_pkg' => {
1093       'columns' => [
1094         'billpaypkgnum', 'serial', '', '', '', '',
1095         'billpaynum',       'int', '', '', '', '',
1096         'billpkgnum',       'int', '', '', '', '',
1097         'amount',         @money_type,     '', '',
1098         'setuprecur',      'varchar', '', $char_d, '', '',
1099         'sdate',   @date_type, '', '',
1100         'edate',   @date_type, '', '',
1101       ],
1102       'primary_key' => 'billpaypkgnum',
1103       'unique'      => [],
1104       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1105     },
1106
1107     'pay_batch' => { #batches of payments to an external processor
1108       'columns' => [
1109         'batchnum',   'serial',    '',   '', '', '',
1110         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1111         'status',     'char', 'NULL',     1, '', '',
1112         'download',   @date_type, '', '',
1113         'upload',     @date_type, '', '',
1114       ],
1115       'primary_key' => 'batchnum',
1116       'unique' => [],
1117       'index' => [],
1118     },
1119
1120     'cust_pay_batch' => { #what's this used for again?  list of customers
1121                           #in current CARD batch? (necessarily CARD?)
1122       'columns' => [
1123         'paybatchnum',   'serial',    '',   '', '', '',
1124         'batchnum',   'int',    '',   '', '', '',
1125         'invnum',   'int',    '',   '', '', '',
1126         'custnum',   'int',    '',   '', '', '',
1127         'last',     'varchar', '',     $char_d, '', '',
1128         'first',    'varchar', '',     $char_d, '', '',
1129         'address1', 'varchar', '',     $char_d, '', '',
1130         'address2', 'varchar', 'NULL', $char_d, '', '',
1131         'city',     'varchar', '',     $char_d, '', '',
1132         'state',    'varchar', 'NULL', $char_d, '', '',
1133         'zip',      'varchar', 'NULL', 10, '', '',
1134         'country',  'char', '',     2, '', '',
1135         #        'trancode', 'int', '', '', '', ''
1136         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1137         'payinfo',  'varchar', '',     512, '', '',
1138         #'exp',      @date_type, '', ''
1139         'exp',      'varchar', 'NULL',     11, '', '',
1140         'payname',  'varchar', 'NULL', $char_d, '', '',
1141         'amount',   @money_type, '', '',
1142         'status',   'varchar', 'NULL',     $char_d, '', '',
1143       ],
1144       'primary_key' => 'paybatchnum',
1145       'unique' => [],
1146       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1147     },
1148
1149     'cust_pkg' => {
1150       'columns' => [
1151         'pkgnum',           'serial',     '', '', '', '',
1152         'custnum',             'int',     '', '', '', '',
1153         'pkgpart',             'int',     '', '', '', '',
1154         'locationnum',         'int', 'NULL', '', '', '',
1155         'otaker',          'varchar',     '', 32, '', '',
1156         'start_date',     @date_type,             '', '',
1157         'setup',          @date_type,             '', '',
1158         'bill',           @date_type,             '', '',
1159         'last_bill',      @date_type,             '', '',
1160         'susp',           @date_type,             '', '',
1161         'adjourn',        @date_type,             '', '',
1162         'cancel',         @date_type,             '', '',
1163         'expire',         @date_type,             '', '',
1164         'change_date',    @date_type,             '', '',
1165         'change_pkgnum',       'int', 'NULL', '', '', '',
1166         'change_pkgpart',      'int', 'NULL', '', '', '',
1167         'change_locationnum',  'int', 'NULL', '', '', '',
1168         'manual_flag',        'char', 'NULL',  1, '', '',
1169         'quantity',            'int', 'NULL', '', '', '',
1170       ],
1171       'primary_key' => 'pkgnum',
1172       'unique' => [],
1173       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1174                    [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1175                    ['susp'], ['adjourn'], ['expire'], ['cancel'],
1176                    ['change_date'],
1177                  ],
1178     },
1179
1180     'cust_pkg_option' => {
1181       'columns' => [
1182         'optionnum', 'serial', '', '', '', '',
1183         'pkgnum', 'int', '', '', '', '',
1184         'optionname', 'varchar', '', $char_d, '', '',
1185         'optionvalue', 'text', 'NULL', '', '', '',
1186       ],
1187       'primary_key' => 'optionnum',
1188       'unique'      => [],
1189       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1190     },
1191
1192     'cust_pkg_detail' => {
1193       'columns' => [
1194         'pkgdetailnum', 'serial', '',      '', '', '',
1195         'pkgnum',          'int', '',      '', '', '',
1196         'detail',      'varchar', '', $char_d, '', '',
1197         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1198         'weight',          'int', '',      '', '', '',
1199       ],
1200       'primary_key' => 'pkgdetailnum',
1201       'unique' => [],
1202       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1203     },
1204
1205     'cust_pkg_reason' => {
1206       'columns' => [
1207         'num',      'serial',    '',   '', '', '',
1208         'pkgnum',   'int',    '',   '', '', '',
1209         'reasonnum','int',    '',   '', '', '',
1210         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1211         'otaker',   'varchar', '', 32, '', '',
1212         'date',     @date_type, '', '',
1213       ],
1214       'primary_key' => 'num',
1215       'unique' => [],
1216       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1217     },
1218
1219     'cust_refund' => {
1220       'columns' => [
1221         'refundnum',    'serial',    '',   '', '', '',
1222         'custnum',  'int',    '',   '', '', '',
1223         '_date',        @date_type, '', '',
1224         'refund',       @money_type, '', '',
1225         'otaker',       'varchar',   '',   32, '', '',
1226         'reason',       'varchar',   '',   $char_d, '', '',
1227         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1228                                                      # be index into payby
1229                                                      # table eventually
1230         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1231         'paymask', 'varchar', 'NULL', $char_d, '', '',
1232         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1233         'closed',    'char', 'NULL', 1, '', '',
1234       ],
1235       'primary_key' => 'refundnum',
1236       'unique' => [],
1237       'index' => [ ['custnum'], ['_date'] ],
1238     },
1239
1240     'cust_credit_refund' => {
1241       'columns' => [
1242         'creditrefundnum', 'serial',     '',   '', '', '',
1243         'crednum',  'int',     '',   '', '', '',
1244         'refundnum',  'int',     '',   '', '', '',
1245         'amount',  @money_type, '', '',
1246         '_date',   @date_type, '', '',
1247       ],
1248       'primary_key' => 'creditrefundnum',
1249       'unique' => [],
1250       'index' => [ ['crednum'], ['refundnum'] ],
1251     },
1252
1253
1254     'cust_svc' => {
1255       'columns' => [
1256         'svcnum',    'serial',    '',   '', '', '',
1257         'pkgnum',    'int',    'NULL',   '', '', '',
1258         'svcpart',   'int',    '',   '', '', '',
1259         'overlimit', @date_type, '', '',
1260       ],
1261       'primary_key' => 'svcnum',
1262       'unique' => [],
1263       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1264     },
1265
1266     'cust_svc_option' => {
1267       'columns' => [
1268         'optionnum',   'serial', '', '', '', '',
1269         'svcnum',      'int', '', '', '', '',
1270         'optionname',  'varchar', '', $char_d, '', '',
1271         'optionvalue', 'text', 'NULL', '', '', '',
1272       ],
1273       'primary_key' => 'optionnum',
1274       'unique'      => [],
1275       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1276     },
1277
1278     'part_pkg' => {
1279       'columns' => [
1280         'pkgpart',       'serial',    '',   '', '', '',
1281         'pkg',           'varchar',   '',   $char_d, '', '',
1282         'comment',       'varchar',   '',   $char_d, '', '',
1283         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1284         'setup',         @perl_type, '', '',
1285         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1286         'recur',         @perl_type, '', '',
1287         'setuptax',      'char', 'NULL', 1, '', '',
1288         'recurtax',      'char', 'NULL', 1, '', '',
1289         'plan',          'varchar', 'NULL', $char_d, '', '',
1290         'plandata',      'text', 'NULL', '', '', '',
1291         'disabled',      'char', 'NULL', 1, '', '',
1292         'custom',        'char', 'NULL', 1, '', '',
1293         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1294         'classnum',      'int',     'NULL', '', '', '',
1295         'taxproductnum', 'int',     'NULL', '', '', '',
1296         'setup_cost',    @money_typen,          '', '',
1297         'recur_cost',    @money_typen,          '', '',
1298         'pay_weight',    'real',    'NULL', '', '', '',
1299         'credit_weight', 'real',    'NULL', '', '', '',
1300         'agentnum',      'int',     'NULL', '', '', '',
1301
1302       ],
1303       'primary_key' => 'pkgpart',
1304       'unique' => [],
1305       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1306     },
1307
1308     'part_pkg_link' => {
1309       'columns' => [
1310         'pkglinknum',  'serial',   '',      '', '', '',
1311         'src_pkgpart', 'int',      '',      '', '', '',
1312         'dst_pkgpart', 'int',      '',      '', '', '',
1313         'link_type',   'varchar',  '', $char_d, '', '',
1314         'hidden',      'char', 'NULL',       1, '', '',
1315       ],
1316       'primary_key' => 'pkglinknum',
1317       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1318       'index'  => [ [ 'src_pkgpart' ] ],
1319     },
1320     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1321     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1322
1323     'part_pkg_taxclass' => {
1324       'columns' => [
1325         'taxclassnum',  'serial', '',       '', '', '',
1326         'taxclass',     'varchar', '', $char_d, '', '',
1327         'disabled', 'char',   'NULL',         1, '', '',
1328       ],
1329       'primary_key' => 'taxclassnum',
1330       'unique'      => [ [ 'taxclass' ] ],
1331       'index'       => [ [ 'disabled' ] ],
1332     },
1333
1334     'part_pkg_taxproduct' => {
1335       'columns' => [
1336         'taxproductnum', 'serial',      '',        '', '', '',
1337         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1338         'taxproduct',    'varchar',     '',   $char_d, '', '',
1339         'description',   'varchar',     '', 3*$char_d, '', '',
1340       ],
1341       'primary_key' => 'taxproductnum',
1342       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1343       'index'       => [],
1344     },
1345
1346     'part_pkg_taxrate' => {
1347       'columns' => [
1348         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1349         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1350         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1351         'taxproductnum', 'int',  '',     '',       '', '',
1352         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1353         'county',           'varchar', 'NULL', $char_d, '', '',
1354         'state',            'varchar', 'NULL', $char_d, '', '',
1355         'local',            'varchar', 'NULL', $char_d, '', '',
1356         'country',          'char',    'NULL', 2,       '', '',
1357         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1358         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1359         'taxclassnum',      'int',     'NULL', '',      '', '',
1360         'effdate',          @date_type, '', '',
1361         'taxable',          'char',    'NULL', 1,       '', '',
1362       ],
1363       'primary_key' => 'pkgtaxratenum',
1364       'unique' => [],
1365       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1366     },
1367
1368     'part_pkg_taxoverride' => {
1369       'columns' => [
1370         'taxoverridenum', 'serial', '', '', '', '',
1371         'pkgpart',           'int', '', '', '', '',
1372         'taxclassnum',       'int', '', '', '', '',
1373         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1374       ],
1375       'primary_key' => 'taxoverridenum',
1376       'unique' => [],
1377       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1378     },
1379
1380 #    'part_title' => {
1381 #      'columns' => [
1382 #        'titlenum',   'int',    '',   '',
1383 #        'title',      'varchar',   '',   $char_d,
1384 #      ],
1385 #      'primary_key' => 'titlenum',
1386 #      'unique' => [ [] ],
1387 #      'index' => [ [] ],
1388 #    },
1389
1390     'pkg_svc' => {
1391       'columns' => [
1392         'pkgsvcnum',  'serial', '',  '', '', '',
1393         'pkgpart',    'int',    '',   '', '', '',
1394         'svcpart',    'int',    '',   '', '', '',
1395         'quantity',   'int',    '',   '', '', '',
1396         'primary_svc','char', 'NULL',  1, '', '',
1397       ],
1398       'primary_key' => 'pkgsvcnum',
1399       'unique' => [ ['pkgpart', 'svcpart'] ],
1400       'index' => [ ['pkgpart'], ['quantity'] ],
1401     },
1402
1403     'part_referral' => {
1404       'columns' => [
1405         'refnum',   'serial',     '',        '', '', '',
1406         'referral', 'varchar',    '',   $char_d, '', '',
1407         'disabled', 'char',   'NULL',         1, '', '',
1408         'agentnum', 'int',    'NULL',        '', '', '',
1409       ],
1410       'primary_key' => 'refnum',
1411       'unique' => [],
1412       'index' => [ ['disabled'], ['agentnum'], ],
1413     },
1414
1415     'part_svc' => {
1416       'columns' => [
1417         'svcpart',    'serial',    '',   '', '', '',
1418         'svc',        'varchar',   '',   $char_d, '', '',
1419         'svcdb',      'varchar',   '',   $char_d, '', '',
1420         'disabled',   'char',  'NULL',   1, '', '',
1421       ],
1422       'primary_key' => 'svcpart',
1423       'unique' => [],
1424       'index' => [ [ 'disabled' ] ],
1425     },
1426
1427     'part_svc_column' => {
1428       'columns' => [
1429         'columnnum',   'serial',         '', '', '', '',
1430         'svcpart',     'int',         '', '', '', '',
1431         'columnname',  'varchar',     '', 64, '', '',
1432         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1433         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1434         'columnflag',  'char',    'NULL', 1, '', '',
1435       ],
1436       'primary_key' => 'columnnum',
1437       'unique' => [ [ 'svcpart', 'columnname' ] ],
1438       'index' => [ [ 'svcpart' ] ],
1439     },
1440
1441     #(this should be renamed to part_pop)
1442     'svc_acct_pop' => {
1443       'columns' => [
1444         'popnum',    'serial',    '',   '', '', '',
1445         'city',      'varchar',   '',   $char_d, '', '',
1446         'state',     'varchar',   '',   $char_d, '', '',
1447         'ac',        'char',   '',   3, '', '',
1448         'exch',      'char',   '',   3, '', '',
1449         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1450       ],
1451       'primary_key' => 'popnum',
1452       'unique' => [],
1453       'index' => [ [ 'state' ] ],
1454     },
1455
1456     'part_pop_local' => {
1457       'columns' => [
1458         'localnum',  'serial',     '',     '', '', '',
1459         'popnum',    'int',     '',     '', '', '',
1460         'city',      'varchar', 'NULL', $char_d, '', '',
1461         'state',     'char',    'NULL', 2, '', '',
1462         'npa',       'char',    '',     3, '', '',
1463         'nxx',       'char',    '',     3, '', '',
1464       ],
1465       'primary_key' => 'localnum',
1466       'unique' => [],
1467       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1468     },
1469
1470     'svc_acct' => {
1471       'columns' => [
1472         'svcnum',    'int',    '',   '', '', '',
1473         'username',  'varchar',   '',   $username_len, '', '',
1474         '_password', 'varchar',   'NULL',  512, '', '',
1475         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1476         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1477         'popnum',    'int',    'NULL',   '', '', '',
1478         'uid',       'int', 'NULL',   '', '', '',
1479         'gid',       'int', 'NULL',   '', '', '',
1480         'finger',    'varchar',   'NULL',   $char_d, '', '',
1481         'dir',       'varchar',   'NULL',   $char_d, '', '',
1482         'shell',     'varchar',   'NULL',   $char_d, '', '',
1483         'quota',     'varchar',   'NULL',   $char_d, '', '',
1484         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1485         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1486         'seconds_threshold',   'int', 'NULL',   '', '', '',
1487         'upbytes',   'bigint', 'NULL',   '', '', '',
1488         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1489         'downbytes', 'bigint', 'NULL',   '', '', '',
1490         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1491         'totalbytes','bigint', 'NULL',   '', '', '',
1492         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1493         'domsvc',    'int',     '', '', '', '',
1494         'pbxsvc',    'int', 'NULL', '', '', '',
1495         'last_login',  @date_type, '', '',
1496         'last_logout', @date_type, '', '',
1497         #communigate pro fields (quota = MaxAccountSize)
1498         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1499         #settings
1500         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1501         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1502         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1503         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1504         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1505         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1506         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1507         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1508         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1509         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1510         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1511         #XXX archive messages, mailing lists
1512         #preferences
1513         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1514         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1515         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1516         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1517         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1518         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1519         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1520         #mail
1521 #vacation message, redirect all mail, mail rules
1522         #XXX RPOP settings
1523       ],
1524       'primary_key' => 'svcnum',
1525       #'unique' => [ [ 'username', 'domsvc' ] ],
1526       'unique' => [],
1527       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1528     },
1529
1530     'acct_rt_transaction' => {
1531       'columns' => [
1532         'svcrtid',   'int',    '',   '', '', '',
1533         'svcnum',    'int',    '',   '', '', '',
1534         'transaction_id',       'int', '',   '', '', '',
1535         '_date',   @date_type, '', '',
1536         'seconds',   'int', '',   '', '', '', #uhhhh
1537         'support',   'int', '',   '', '', '',
1538       ],
1539       'primary_key' => 'svcrtid',
1540       'unique' => [],
1541       'index' => [ ['svcnum', 'transaction_id'] ],
1542     },
1543
1544     #'svc_charge' => {
1545     #  'columns' => [
1546     #    'svcnum',    'int',    '',   '',
1547     #    'amount',    @money_type,
1548     #  ],
1549     #  'primary_key' => 'svcnum',
1550     #  'unique' => [ [] ],
1551     #  'index' => [ [] ],
1552     #},
1553
1554     'svc_domain' => {
1555       'columns' => [
1556         'svcnum',           'int',    '',        '', '', '',
1557         'domain',       'varchar',    '',   $char_d, '', '',
1558         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1559         'catchall',         'int', 'NULL',       '', '', '',
1560         'parent_svcnum',    'int', 'NULL',       '', '', '',
1561         'registrarnum',     'int', 'NULL',       '', '', '',
1562         'registrarkey', 'varchar', 'NULL',      512, '', '',
1563         'setup_date',      @date_type, '', '',
1564         'renewal_interval', 'int', 'NULL',       '', '', '',
1565         'expiration_date', @date_type, '', '',
1566         #communigate pro fields (quota = MaxAccountSize)
1567         'max_accounts',     'int', 'NULL',       '', '', '',
1568         'trailer',         'text', 'NULL',       '', '', '',
1569         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
1570         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
1571         #settings
1572         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
1573         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
1574         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
1575         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
1576         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
1577         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
1578         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
1579         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
1580         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
1581         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
1582         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
1583         #XXX archive messages
1584         #preferences
1585         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
1586         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
1587         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
1588         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
1589         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
1590         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
1591         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
1592         #mail
1593         #XXX rules, archive rule, spam foldering rule(s)
1594       ],
1595       'primary_key' => 'svcnum',
1596       'unique' => [ ],
1597       'index' => [ ['domain'] ],
1598     },
1599
1600     'domain_record' => {
1601       'columns' => [
1602         'recnum',    'serial',     '',  '', '', '',
1603         'svcnum',    'int',     '',  '', '', '',
1604         'reczone',   'varchar', '',  255, '', '',
1605         'recaf',     'char',    '',  2, '', '',
1606         'rectype',   'varchar',    '',  5, '', '',
1607         'recdata',   'varchar', '',  255, '', '',
1608       ],
1609       'primary_key' => 'recnum',
1610       'unique'      => [],
1611       'index'       => [ ['svcnum'] ],
1612     },
1613
1614     'registrar' => {
1615       'columns' => [
1616         'registrarnum',   'serial', '',      '', '', '',
1617         'registrarname', 'varchar', '', $char_d, '', '',
1618       ],
1619       'primary_key' => 'registrarnum',
1620       'unique'      => [],
1621       'index'       => [],
1622     },
1623
1624     'svc_forward' => {
1625       'columns' => [
1626         'svcnum',   'int',            '',   '', '', '',
1627         'srcsvc',   'int',        'NULL',   '', '', '',
1628         'src',      'varchar',    'NULL',  255, '', '',
1629         'dstsvc',   'int',        'NULL',   '', '', '',
1630         'dst',      'varchar',    'NULL',  255, '', '',
1631       ],
1632       'primary_key' => 'svcnum',
1633       'unique'      => [],
1634       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1635     },
1636
1637     'svc_www' => {
1638       'columns' => [
1639         'svcnum',   'int',      '',  '', '', '',
1640         'recnum',   'int',      '',  '', '', '',
1641         'usersvc',  'int',  'NULL',  '', '', '',
1642         'config',   'text', 'NULL',  '', '', '',
1643       ],
1644       'primary_key' => 'svcnum',
1645       'unique'      => [],
1646       'index'       => [],
1647     },
1648
1649     #'svc_wo' => {
1650     #  'columns' => [
1651     #    'svcnum',    'int',    '',   '',
1652     #    'svcnum',    'int',    '',   '',
1653     #    'svcnum',    'int',    '',   '',
1654     #    'worker',    'varchar',   '',   $char_d,
1655     #    '_date',     @date_type,
1656     #  ],
1657     #  'primary_key' => 'svcnum',
1658     #  'unique' => [ [] ],
1659     #  'index' => [ [] ],
1660     #},
1661
1662     'prepay_credit' => {
1663       'columns' => [
1664         'prepaynum',   'serial',     '',   '', '', '',
1665         'identifier',  'varchar', '', $char_d, '', '',
1666         'amount',      @money_type, '', '',
1667         'seconds',     'int',     'NULL', '', '', '',
1668         'upbytes',     'bigint',     'NULL', '', '', '',
1669         'downbytes',   'bigint',     'NULL', '', '', '',
1670         'totalbytes',  'bigint',     'NULL', '', '', '',
1671         'agentnum',    'int',     'NULL', '', '', '',
1672       ],
1673       'primary_key' => 'prepaynum',
1674       'unique'      => [ ['identifier'] ],
1675       'index'       => [],
1676     },
1677
1678     'port' => {
1679       'columns' => [
1680         'portnum',  'serial',     '',   '', '', '',
1681         'ip',       'varchar', 'NULL', 15, '', '',
1682         'nasport',  'int',     'NULL', '', '', '',
1683         'nasnum',   'int',     '',   '', '', '',
1684       ],
1685       'primary_key' => 'portnum',
1686       'unique'      => [],
1687       'index'       => [],
1688     },
1689
1690     'nas' => {
1691       'columns' => [
1692         'nasnum',   'serial',     '',    '', '', '',
1693         'nas',      'varchar', '',    $char_d, '', '',
1694         'nasip',    'varchar', '',    15, '', '',
1695         'nasfqdn',  'varchar', '',    $char_d, '', '',
1696         'last',     'int',     '',    '', '', '',
1697       ],
1698       'primary_key' => 'nasnum',
1699       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1700       'index'       => [ [ 'last' ] ],
1701     },
1702
1703 #    'session' => {
1704 #      'columns' => [
1705 #        'sessionnum', 'serial',       '',   '', '', '',
1706 #        'portnum',    'int',       '',   '', '', '',
1707 #        'svcnum',     'int',       '',   '', '', '',
1708 #        'login',      @date_type, '', '',
1709 #        'logout',     @date_type, '', '',
1710 #      ],
1711 #      'primary_key' => 'sessionnum',
1712 #      'unique'      => [],
1713 #      'index'       => [ [ 'portnum' ] ],
1714 #    },
1715
1716     'queue' => {
1717       'columns' => [
1718         'jobnum',      'serial',     '',      '', '', '',
1719         'job',        'varchar',     '',     512, '', '',
1720         '_date',          'int',     '',      '', '', '',
1721         'status',     'varchar',     '', $char_d, '', '',
1722         'statustext',    'text', 'NULL',      '', '', '',
1723         'svcnum',         'int', 'NULL',      '', '', '',
1724         'custnum',        'int', 'NULL',      '', '', '',
1725         'secure',        'char', 'NULL',       1, '', '',
1726         'priority',       'int', 'NULL',      '', '', '',
1727       ],
1728       'primary_key' => 'jobnum',
1729       'unique'      => [],
1730       'index'       => [ [ 'secure' ], [ 'priority' ],
1731                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1732                        ],
1733     },
1734
1735     'queue_arg' => {
1736       'columns' => [
1737         'argnum', 'serial', '', '', '', '',
1738         'jobnum', 'int', '', '', '', '',
1739         'frozen', 'char', 'NULL',       1, '', '',
1740         'arg', 'text', 'NULL', '', '', '',
1741       ],
1742       'primary_key' => 'argnum',
1743       'unique'      => [],
1744       'index'       => [ [ 'jobnum' ] ],
1745     },
1746
1747     'queue_depend' => {
1748       'columns' => [
1749         'dependnum', 'serial', '', '', '', '',
1750         'jobnum', 'int', '', '', '', '',
1751         'depend_jobnum', 'int', '', '', '', '',
1752       ],
1753       'primary_key' => 'dependnum',
1754       'unique'      => [],
1755       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1756     },
1757
1758     'export_svc' => {
1759       'columns' => [
1760         'exportsvcnum' => 'serial', '', '', '', '',
1761         'exportnum'    => 'int', '', '', '', '',
1762         'svcpart'      => 'int', '', '', '', '',
1763       ],
1764       'primary_key' => 'exportsvcnum',
1765       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1766       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1767     },
1768
1769     'export_device' => {
1770       'columns' => [
1771         'exportdevicenum' => 'serial', '', '', '', '',
1772         'exportnum'    => 'int', '', '', '', '',
1773         'devicepart'      => 'int', '', '', '', '',
1774       ],
1775       'primary_key' => 'exportdevicenum',
1776       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
1777       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
1778     },
1779
1780     'part_export' => {
1781       'columns' => [
1782         'exportnum', 'serial', '', '', '', '',
1783         'machine', 'varchar', '', $char_d, '', '',
1784         'exporttype', 'varchar', '', $char_d, '', '',
1785         'nodomain',     'char', 'NULL', 1, '', '',
1786       ],
1787       'primary_key' => 'exportnum',
1788       'unique'      => [],
1789       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1790     },
1791
1792     'part_export_option' => {
1793       'columns' => [
1794         'optionnum', 'serial', '', '', '', '',
1795         'exportnum', 'int', '', '', '', '',
1796         'optionname', 'varchar', '', $char_d, '', '',
1797         'optionvalue', 'text', 'NULL', '', '', '',
1798       ],
1799       'primary_key' => 'optionnum',
1800       'unique'      => [],
1801       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1802     },
1803
1804     'radius_usergroup' => {
1805       'columns' => [
1806         'usergroupnum', 'serial', '', '', '', '',
1807         'svcnum',       'int', '', '', '', '',
1808         'groupname',    'varchar', '', $char_d, '', '',
1809       ],
1810       'primary_key' => 'usergroupnum',
1811       'unique'      => [],
1812       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1813     },
1814
1815     'msgcat' => {
1816       'columns' => [
1817         'msgnum', 'serial', '', '', '', '',
1818         'msgcode', 'varchar', '', $char_d, '', '',
1819         'locale', 'varchar', '', 16, '', '',
1820         'msg', 'text', '', '', '', '',
1821       ],
1822       'primary_key' => 'msgnum',
1823       'unique'      => [ [ 'msgcode', 'locale' ] ],
1824       'index'       => [],
1825     },
1826
1827     'cust_tax_exempt' => {
1828       'columns' => [
1829         'exemptnum', 'serial', '', '', '', '',
1830         'custnum',   'int', '', '', '', '',
1831         'taxnum',    'int', '', '', '', '',
1832         'year',      'int', '', '', '', '',
1833         'month',     'int', '', '', '', '',
1834         'amount',   @money_type, '', '',
1835       ],
1836       'primary_key' => 'exemptnum',
1837       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1838       'index'       => [],
1839     },
1840
1841     'cust_tax_exempt_pkg' => {
1842       'columns' => [
1843         'exemptpkgnum',  'serial', '', '', '', '',
1844         #'custnum',      'int', '', '', '', ''
1845         'billpkgnum',   'int', '', '', '', '',
1846         'taxnum',       'int', '', '', '', '',
1847         'year',         'int', '', '', '', '',
1848         'month',        'int', '', '', '', '',
1849         'amount',       @money_type, '', '',
1850       ],
1851       'primary_key' => 'exemptpkgnum',
1852       'unique' => [],
1853       'index'  => [ [ 'taxnum', 'year', 'month' ],
1854                     [ 'billpkgnum' ],
1855                     [ 'taxnum' ]
1856                   ],
1857     },
1858
1859     'router' => {
1860       'columns' => [
1861         'routernum', 'serial', '', '', '', '',
1862         'routername', 'varchar', '', $char_d, '', '',
1863         'svcnum', 'int', 'NULL', '', '', '',
1864         'agentnum',   'int', 'NULL', '', '', '',
1865       ],
1866       'primary_key' => 'routernum',
1867       'unique'      => [],
1868       'index'       => [],
1869     },
1870
1871     'part_svc_router' => {
1872       'columns' => [
1873         'svcrouternum', 'serial', '', '', '', '',
1874         'svcpart', 'int', '', '', '', '',
1875         'routernum', 'int', '', '', '', '',
1876       ],
1877       'primary_key' => 'svcrouternum',
1878       'unique'      => [],
1879       'index'       => [],
1880     },
1881
1882     'addr_block' => {
1883       'columns' => [
1884         'blocknum', 'serial', '', '', '', '',
1885         'routernum', 'int', '', '', '', '',
1886         'ip_gateway', 'varchar', '', 15, '', '',
1887         'ip_netmask', 'int', '', '', '', '',
1888         'agentnum',   'int', 'NULL', '', '', '',
1889         'manual_flag', 'char', 'NULL', 1, '', '',
1890       ],
1891       'primary_key' => 'blocknum',
1892       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1893       'index'       => [],
1894     },
1895
1896     'svc_broadband' => {
1897       'columns' => [
1898         'svcnum', 'int', '', '', '', '',
1899         'description', 'varchar', 'NULL', $char_d, '', '',
1900         'blocknum', 'int', 'NULL', '', '', '',
1901         'speed_up', 'int', '', '', '', '',
1902         'speed_down', 'int', '', '', '', '',
1903         'ip_addr', 'varchar', 'NULL', 15, '', '',
1904         'mac_addr', 'varchar', 'NULL', 12, '', '',
1905         'authkey',  'varchar', 'NULL', 32, '', '',
1906         'latitude', 'decimal', 'NULL', '', '', '',
1907         'longitude', 'decimal', 'NULL', '', '', '',
1908         'altitude', 'decimal', 'NULL', '', '', '',
1909         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1910         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1911       ],
1912       'primary_key' => 'svcnum',
1913       'unique'      => [ [ 'mac_addr' ] ],
1914       'index'       => [],
1915     },
1916
1917     'part_virtual_field' => {
1918       'columns' => [
1919         'vfieldpart', 'serial', '', '', '', '',
1920         'dbtable', 'varchar', '', 32, '', '',
1921         'name', 'varchar', '', 32, '', '',
1922         'check_block', 'text', 'NULL', '', '', '',
1923         'length', 'int', 'NULL', '', '', '',
1924         'list_source', 'text', 'NULL', '', '', '',
1925         'label', 'varchar', 'NULL', 80, '', '',
1926       ],
1927       'primary_key' => 'vfieldpart',
1928       'unique' => [],
1929       'index' => [],
1930     },
1931
1932     'virtual_field' => {
1933       'columns' => [
1934         'vfieldnum', 'serial', '', '', '', '',
1935         'recnum', 'int', '', '', '', '',
1936         'vfieldpart', 'int', '', '', '', '',
1937         'value', 'varchar', '', 128, '', '',
1938       ],
1939       'primary_key' => 'vfieldnum',
1940       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1941       'index' => [],
1942     },
1943
1944     'acct_snarf' => {
1945       'columns' => [
1946         'snarfnum',  'int', '', '', '', '',
1947         'svcnum',    'int', '', '', '', '',
1948         'machine',   'varchar', '', 255, '', '',
1949         'protocol',  'varchar', '', $char_d, '', '',
1950         'username',  'varchar', '', $char_d, '', '',
1951         '_password', 'varchar', '', $char_d, '', '',
1952       ],
1953       'primary_key' => 'snarfnum',
1954       'unique' => [],
1955       'index'  => [ [ 'svcnum' ] ],
1956     },
1957
1958     'svc_external' => {
1959       'columns' => [
1960         'svcnum', 'int', '', '', '', '',
1961         'id',     'int', 'NULL', '', '', '',
1962         'title',  'varchar', 'NULL', $char_d, '', '',
1963       ],
1964       'primary_key' => 'svcnum',
1965       'unique'      => [],
1966       'index'       => [],
1967     },
1968
1969     'cust_pay_refund' => {
1970       'columns' => [
1971         'payrefundnum', 'serial', '', '', '', '',
1972         'paynum',  'int', '', '', '', '',
1973         'refundnum',  'int', '', '', '', '',
1974         '_date',    @date_type, '', '',
1975         'amount',   @money_type, '', '',
1976       ],
1977       'primary_key' => 'payrefundnum',
1978       'unique' => [],
1979       'index' => [ ['paynum'], ['refundnum'] ],
1980     },
1981
1982     'part_pkg_option' => {
1983       'columns' => [
1984         'optionnum', 'serial', '', '', '', '',
1985         'pkgpart', 'int', '', '', '', '',
1986         'optionname', 'varchar', '', $char_d, '', '',
1987         'optionvalue', 'text', 'NULL', '', '', '',
1988       ],
1989       'primary_key' => 'optionnum',
1990       'unique'      => [],
1991       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1992     },
1993
1994     'part_pkg_report_option' => {
1995       'columns' => [
1996         'num',      'serial',   '',      '', '', '',
1997         'name',     'varchar',  '', $char_d, '', '',
1998         'disabled', 'char', 'NULL',       1, '', '',
1999       ],
2000       'primary_key' => 'num',
2001       'unique' => [ [ 'name' ] ],
2002       'index' => [ [ 'disabled' ] ],
2003     },
2004
2005     'rate' => {
2006       'columns' => [
2007         'ratenum',  'serial', '', '', '', '',
2008         'ratename', 'varchar', '', $char_d, '', '',
2009       ],
2010       'primary_key' => 'ratenum',
2011       'unique'      => [],
2012       'index'       => [],
2013     },
2014
2015     'rate_detail' => {
2016       'columns' => [
2017         'ratedetailnum',   'serial',  '',     '', '', '',
2018         'ratenum',         'int',     '',     '', '', '',
2019         'orig_regionnum',  'int', 'NULL',     '', '', '',
2020         'dest_regionnum',  'int',     '',     '', '', '',
2021         'min_included',    'int',     '',     '', '', '',
2022         'conn_charge',     @money_type, '0', '', #'decimal','','10,5','0','',
2023         'conn_sec',        'int',     '',     '', '0', '',
2024         'min_charge',      'decimal', '', '10,5', '', '', #@money_type, '', '',
2025         'sec_granularity', 'int',     '',     '', '', '',
2026         #time period (link to table of periods)?
2027         'classnum',        'int', 'NULL',     '', '', '',
2028       ],
2029       'primary_key' => 'ratedetailnum',
2030       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2031       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2032     },
2033
2034     'rate_region' => {
2035       'columns' => [
2036         'regionnum',   'serial',      '', '', '', '',
2037         'regionname',  'varchar',     '', $char_d, '', '',
2038       ],
2039       'primary_key' => 'regionnum',
2040       'unique'      => [],
2041       'index'       => [],
2042     },
2043
2044     'rate_prefix' => {
2045       'columns' => [
2046         'prefixnum',   'serial',      '', '', '', '',
2047         'regionnum',   'int',         '', '', '', '',
2048         'countrycode', 'varchar',     '',  3, '', '',
2049         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2050         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2051       ],
2052       'primary_key' => 'prefixnum',
2053       'unique'      => [],
2054       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2055     },
2056
2057     'usage_class' => {
2058       'columns' => [
2059         'classnum',    'serial',      '',      '', '', '',
2060         'weight',      'int',     'NULL',      '', '', '',
2061         'classname',   'varchar',     '', $char_d, '', '',
2062         'format',      'varchar', 'NULL', $char_d, '', '',
2063         'disabled',    'char',    'NULL',       1, '', '',
2064       ],
2065       'primary_key' => 'classnum',
2066       'unique' => [],
2067       'index' => [ ['disabled'] ],
2068     },
2069
2070     'reg_code' => {
2071       'columns' => [
2072         'codenum',   'serial',    '', '', '', '',
2073         'code',      'varchar',   '', $char_d, '', '',
2074         'agentnum',  'int',       '', '', '', '',
2075       ],
2076       'primary_key' => 'codenum',
2077       'unique'      => [ [ 'agentnum', 'code' ] ],
2078       'index'       => [ [ 'agentnum' ] ],
2079     },
2080
2081     'reg_code_pkg' => {
2082       'columns' => [
2083         'codepkgnum', 'serial', '', '', '', '',
2084         'codenum',   'int',    '', '', '', '',
2085         'pkgpart',   'int',    '', '', '', '',
2086       ],
2087       'primary_key' => 'codepkgnum',
2088       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2089       'index'       => [ [ 'codenum' ] ],
2090     },
2091
2092     'clientapi_session' => {
2093       'columns' => [
2094         'sessionnum',  'serial',  '', '', '', '',
2095         'sessionid',  'varchar',  '', $char_d, '', '',
2096         'namespace',  'varchar',  '', $char_d, '', '',
2097       ],
2098       'primary_key' => 'sessionnum',
2099       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2100       'index'       => [],
2101     },
2102
2103     'clientapi_session_field' => {
2104       'columns' => [
2105         'fieldnum',    'serial',     '', '', '', '',
2106         'sessionnum',     'int',     '', '', '', '',
2107         'fieldname',  'varchar',     '', $char_d, '', '',
2108         'fieldvalue',    'text', 'NULL', '', '', '',
2109       ],
2110       'primary_key' => 'fieldnum',
2111       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2112       'index'       => [],
2113     },
2114
2115     'payment_gateway' => {
2116       'columns' => [
2117         'gatewaynum',       'serial',   '',     '', '', '',
2118         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2119         'gateway_module',   'varchar',  '',     $char_d, '', '',
2120         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2121         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2122         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2123         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2124         'disabled',   'char',  'NULL',   1, '', '',
2125       ],
2126       'primary_key' => 'gatewaynum',
2127       'unique' => [],
2128       'index'  => [ [ 'disabled' ] ],
2129     },
2130
2131     'payment_gateway_option' => {
2132       'columns' => [
2133         'optionnum',   'serial',  '',     '', '', '',
2134         'gatewaynum',  'int',     '',     '', '', '',
2135         'optionname',  'varchar', '',     $char_d, '', '',
2136         'optionvalue', 'text',    'NULL', '', '', '',
2137       ],
2138       'primary_key' => 'optionnum',
2139       'unique'      => [],
2140       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2141     },
2142
2143     'agent_payment_gateway' => {
2144       'columns' => [
2145         'agentgatewaynum', 'serial', '', '', '', '',
2146         'agentnum',        'int', '', '', '', '',
2147         'gatewaynum',      'int', '', '', '', '',
2148         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2149         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2150       ],
2151       'primary_key' => 'agentgatewaynum',
2152       'unique'      => [],
2153       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2154     },
2155
2156     'banned_pay' => {
2157       'columns' => [
2158         'bannum',  'serial',   '',     '', '', '',
2159         'payby',   'char',     '',       4, '', '',
2160         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2161         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2162         '_date',   @date_type, '', '',
2163         'otaker',  'varchar',  '',     32, '', '',
2164         'reason',  'varchar',  'NULL', $char_d, '', '',
2165       ],
2166       'primary_key' => 'bannum',
2167       'unique'      => [ [ 'payby', 'payinfo' ] ],
2168       'index'       => [],
2169     },
2170
2171     'pkg_category' => {
2172       'columns' => [
2173         'categorynum',   'serial',  '', '', '', '',
2174         'categoryname',  'varchar', '', $char_d, '', '',
2175         'weight',         'int', 'NULL',  '', '', '',
2176         'condense',      'char', 'NULL',   1, '', '',
2177         'disabled',      'char', 'NULL',   1, '', '',
2178       ],
2179       'primary_key' => 'categorynum',
2180       'unique' => [],
2181       'index' => [ ['disabled'] ],
2182     },
2183
2184     'pkg_class' => {
2185       'columns' => [
2186         'classnum',    'serial',   '',      '', '', '',
2187         'classname',   'varchar',  '', $char_d, '', '',
2188         'categorynum', 'int',  'NULL',      '', '', '',
2189         'disabled',    'char', 'NULL',       1, '', '',
2190       ],
2191       'primary_key' => 'classnum',
2192       'unique' => [],
2193       'index' => [ ['disabled'] ],
2194     },
2195
2196     'cdr' => {
2197       'columns' => [
2198         # qw( name type null length default local );
2199
2200         ###
2201         #asterisk fields
2202         ###
2203
2204         'acctid',   'bigserial',  '', '', '', '',
2205         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2206         'calldate', 'timestamp',   '',      '', \'now()', '',
2207         'clid',        'varchar',  '', $char_d, \"''", '',
2208         'src',         'varchar',  '', $char_d, \"''", '',
2209         'dst',         'varchar',  '', $char_d, \"''", '',
2210         'dcontext',    'varchar',  '', $char_d, \"''", '',
2211         'channel',     'varchar',  '', $char_d, \"''", '',
2212         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2213         'lastapp',     'varchar',  '', $char_d, \"''", '',
2214         'lastdata',    'varchar',  '', $char_d, \"''", '',
2215
2216         #these don't seem to be logged by most of the SQL cdr_* modules
2217         #except tds under sql-illegal names, so;
2218         # ... don't rely on them for rating?
2219         # and, what they hey, i went ahead and changed the names and data types
2220         # to freeside-style dates...
2221           #'start',  'timestamp', 'NULL',  '',    '', '',
2222           #'answer', 'timestamp', 'NULL',  '',    '', '',
2223           #'end',    'timestamp', 'NULL',  '',    '', '',
2224         'startdate',  @date_type, '', '',
2225         'answerdate', @date_type, '', '',
2226         'enddate',    @date_type, '', '',
2227         #
2228
2229         'duration',    'int',      '',      '',     0, '',
2230         'billsec',     'int',      '',      '',     0, '',
2231         'disposition', 'varchar',  '',      45, \"''", '',
2232         'amaflags',    'int',      '',      '',     0, '',
2233         'accountcode', 'varchar',  '',      20, \"''", '',
2234         'uniqueid',    'varchar',  '',      32, \"''", '',
2235         'userfield',   'varchar',  '',     255, \"''", '',
2236
2237         ###
2238         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2239         # defaults
2240         # though these are now used elsewhere:
2241         # charged_party, upstream_price, rated_price, carrierid
2242         ###
2243
2244         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2245         'cdrtypenum',              'int', 'NULL',      '', '', '',
2246
2247         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2248
2249         'upstream_currency',      'char', 'NULL',       3, '', '',
2250         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2251         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2252
2253         # how it was rated internally...
2254         'ratedetailnum',           'int', 'NULL',      '', '', '',
2255         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2256
2257         'distance',            'decimal', 'NULL',      '', '', '',
2258         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2259
2260         #cdr_calltype: the big list in appendix 2
2261         'calltypenum',             'int', 'NULL',      '', '', '',
2262
2263         'description',         'varchar', 'NULL', $char_d, '', '',
2264         'quantity',                'int', 'NULL',      '', '', '',
2265
2266         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2267         'carrierid',               'int', 'NULL',      '', '', '',
2268
2269         'upstream_rateid',         'int', 'NULL',      '', '', '',
2270
2271         ###
2272         #and now for our own fields
2273         ###
2274
2275         # a svcnum... right..?
2276         'svcnum',             'int',   'NULL',     '',   '', '',
2277
2278         #NULL, done (or something)
2279         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2280
2281         #NULL, done (or something)
2282         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2283
2284         #an indexed place to put big numbers
2285         'cdrid',         'bigint',     'NULL',     '',  '', '',
2286
2287         #old
2288         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2289         #new
2290         'cdrbatchnum', 'int', 'NULL', '', '', '',
2291
2292       ],
2293       'primary_key' => 'acctid',
2294       'unique' => [],
2295       'index' => [ [ 'calldate' ],
2296                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2297                    [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2298                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2299                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2300                  ],
2301     },
2302
2303     'cdr_batch' => {
2304       'columns' => [
2305         'cdrbatchnum',   'serial',    '',   '', '', '',
2306         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2307         '_date',     @date_type, '', '',
2308       ],
2309       'primary_key' => 'cdrbatchnum',
2310       'unique' => [ [ 'cdrbatch' ] ],
2311       'index' => [],
2312     },
2313
2314     'cdr_termination' => {
2315       'columns' => [
2316         'cdrtermnum', 'bigserial',     '',      '', '', '',
2317         'acctid',        'bigint',     '',      '', '', '',
2318         'termpart',         'int',     '',      '', '', '',#future use see below
2319         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2320         'status',       'varchar', 'NULL',      32, '', '',
2321       ],
2322       'primary_key' => 'cdrtermnum',
2323       'unique'      => [ [ 'acctid', 'termpart' ] ],
2324       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2325     },
2326
2327     #to handle multiple termination/settlement passes...
2328    # 'part_termination' => {
2329    #   'columns' => [
2330    #     'termpart',       'int', '',      '', '', '',
2331    #     'termname',   'varchar', '', $char_d, '', '',
2332    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2333    #   ],
2334    #   'primary_key' => 'termpart',
2335    #   'unique' => [],
2336    #   'index'  => [],
2337    # },
2338
2339     #the remaining cdr_ tables are not really used
2340     'cdr_calltype' => {
2341       'columns' => [
2342         'calltypenum',   'serial',  '', '', '', '',
2343         'calltypename',  'varchar', '', $char_d, '', '',
2344       ],
2345       'primary_key' => 'calltypenum',
2346       'unique'      => [],
2347       'index'       => [],
2348     },
2349
2350     'cdr_type' => {
2351       'columns' => [
2352         'cdrtypenum'  => 'serial',  '', '', '', '',
2353         'cdrtypename' => 'varchar', '', $char_d, '', '',
2354       ],
2355       'primary_key' => 'cdrtypenum',
2356       'unique'      => [],
2357       'index'       => [],
2358     },
2359
2360     'cdr_carrier' => {
2361       'columns' => [
2362         'carrierid'   => 'serial',  '', '', '', '',
2363         'carriername' => 'varchar', '', $char_d, '', '',
2364       ],
2365       'primary_key' => 'carrierid',
2366       'unique'      => [],
2367       'index'       => [],
2368     },
2369
2370     #'cdr_file' => {
2371     #  'columns' => [
2372     #    'filenum',    'serial',     '', '', '', '',
2373     #    'filename',  'varchar',     '', '', '', '',
2374     #    'status',    'varchar', 'NULL', '', '', '',
2375     #  ],
2376     #  'primary_key' => 'filenum',
2377     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2378     #                                   # agent-virtualize or have a customer
2379     #                                   # with dup-filename needs or something
2380     #                                   # (only used by cdr.http_and_import for
2381     #                                   #  chrissakes)
2382     #  'index'  => [],
2383     #},
2384
2385     'inventory_item' => {
2386       'columns' => [
2387         'itemnum',  'serial',      '',      '', '', '',
2388         'classnum', 'int',         '',      '', '', '',
2389         'item',     'varchar',     '', $char_d, '', '',
2390         'svcnum',   'int',     'NULL',      '', '', '',
2391       ],
2392       'primary_key' => 'itemnum',
2393       'unique' => [ [ 'classnum', 'item' ] ],
2394       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2395     },
2396
2397     'inventory_class' => {
2398       'columns' => [
2399         'classnum',  'serial',       '',      '', '', '',
2400         'classname', 'varchar',      '', $char_d, '', '',
2401       ],
2402       'primary_key' => 'classnum',
2403       'unique' => [],
2404       'index'  => [],
2405     },
2406
2407     'access_user' => {
2408       'columns' => [
2409         'usernum',   'serial',  '',      '', '', '',
2410         'username',  'varchar', '', $char_d, '', '',
2411         '_password', 'varchar', '', $char_d, '', '',
2412         'last',      'varchar', '', $char_d, '', '',
2413         'first',     'varchar', '', $char_d, '', '',
2414         'user_custnum',  'int', 'NULL',  '', '', '',
2415         'disabled',     'char', 'NULL',   1, '', '',
2416       ],
2417       'primary_key' => 'usernum',
2418       'unique' => [ [ 'username' ] ],
2419       'index'  => [ [ 'user_custnum' ] ],
2420     },
2421
2422     'access_user_pref' => {
2423       'columns' => [
2424         'prefnum',    'serial',       '', '', '', '',
2425         'usernum',     'int',       '', '', '', '',
2426         'prefname', 'varchar', '', $char_d, '', '',
2427         'prefvalue', 'text', 'NULL', '', '', '',
2428         'expiration', @date_type, '', '',
2429       ],
2430       'primary_key' => 'prefnum',
2431       'unique' => [],
2432       'index'  => [ [ 'usernum' ] ],
2433     },
2434
2435     'access_group' => {
2436       'columns' => [
2437         'groupnum',   'serial', '',      '', '', '',
2438         'groupname', 'varchar', '', $char_d, '', '',
2439       ],
2440       'primary_key' => 'groupnum',
2441       'unique' => [ [ 'groupname' ] ],
2442       'index'  => [],
2443     },
2444
2445     'access_usergroup' => {
2446       'columns' => [
2447         'usergroupnum', 'serial', '', '', '', '',
2448         'usernum',         'int', '', '', '', '',
2449         'groupnum',        'int', '', '', '', '',
2450       ],
2451       'primary_key' => 'usergroupnum',
2452       'unique' => [ [ 'usernum', 'groupnum' ] ],
2453       'index'  => [ [ 'usernum' ] ],
2454     },
2455
2456     'access_groupagent' => {
2457       'columns' => [
2458         'groupagentnum', 'serial', '', '', '', '',
2459         'groupnum',         'int', '', '', '', '',
2460         'agentnum',         'int', '', '', '', '',
2461       ],
2462       'primary_key' => 'groupagentnum',
2463       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2464       'index'  => [ [ 'groupnum' ] ],
2465     },
2466
2467     'access_right' => {
2468       'columns' => [
2469         'rightnum',   'serial', '',      '', '', '',
2470         'righttype', 'varchar', '', $char_d, '', '',
2471         'rightobjnum',   'int', '',      '', '', '',
2472         'rightname', 'varchar', '', $char_d, '', '',
2473       ],
2474       'primary_key' => 'rightnum',
2475       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2476       'index'  => [],
2477     },
2478
2479     'svc_phone' => {
2480       'columns' => [
2481         'svcnum',       'int',         '',      '', '', '',
2482         'countrycode',  'varchar',     '',       3, '', '',
2483         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2484         'pin',          'varchar', 'NULL', $char_d, '', '',
2485         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2486         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2487         'pbxsvc',           'int', 'NULL',      '', '', '',
2488         'domsvc',           'int', 'NULL',      '', '', '',
2489         'locationnum',      'int', 'NULL', '', '', '',
2490       ],
2491       'primary_key' => 'svcnum',
2492       'unique' => [],
2493       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
2494                     ['locationnum'],
2495                   ],
2496     },
2497
2498     'phone_device' => {
2499       'columns' => [
2500         'devicenum', 'serial',     '', '', '', '',
2501         'devicepart',   'int',     '', '', '', '',
2502         'svcnum',       'int',     '', '', '', '',
2503         'mac_addr', 'varchar', 'NULL', 12, '', '',
2504       ],
2505       'primary_key' => 'devicenum',
2506       'unique' => [ [ 'mac_addr' ], ],
2507       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
2508     },
2509
2510     'part_device' => {
2511       'columns' => [
2512         'devicepart', 'serial',  '',      '', '', '',
2513         'devicename', 'varchar', '', $char_d, '', '',
2514         #'classnum', #tie to an inventory class?
2515       ],
2516       'primary_key' => 'devicepart',
2517       'unique' => [ [ 'devicename' ] ], #?
2518       'index'  => [],
2519     },
2520
2521     'phone_avail' => {
2522       'columns' => [
2523         'availnum',    'serial',      '',      '', '', '',
2524         'exportnum',   'int',         '',      '', '', '',
2525         'countrycode', 'varchar',     '',       3, '', '',
2526         'state',       'char',    'NULL',       2, '', '',
2527         'npa',         'char',        '',       3, '', '',
2528         'nxx',         'char',    'NULL',       3, '', '',
2529         'station',     'char',    'NULL',       4, '', '',
2530         'name',        'varchar', 'NULL', $char_d, '', '',
2531         'svcnum',      'int',     'NULL',      '', '', '',
2532         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2533       ],
2534       'primary_key' => 'availnum',
2535       'unique' => [],
2536       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2537                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2538                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2539                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2540                     [ 'svcnum' ],
2541                     [ 'availbatch' ],
2542                   ],
2543     },
2544
2545     'reason_type' => {
2546       'columns' => [
2547         'typenum',   'serial',  '', '', '', '',
2548         'class',     'char', '', 1, '', '',
2549         'type',     'varchar', '', $char_d, '', '',
2550       ],
2551       'primary_key' => 'typenum',
2552       'unique' => [],
2553       'index' => [],
2554     },
2555
2556     'reason' => {
2557       'columns' => [
2558         'reasonnum',     'serial',  '', '', '', '',
2559         'reason_type',   'int',  '', '', '', '',
2560         'reason',        'text', '', '', '', '',
2561         'disabled',      'char',    'NULL', 1, '', '',
2562       ],
2563       'primary_key' => 'reasonnum',
2564       'unique' => [],
2565       'index' => [],
2566     },
2567
2568     'conf' => {
2569       'columns' => [
2570         'confnum',  'serial',  '', '', '', '',
2571         'agentnum', 'int',  'NULL', '', '', '',
2572         'name',     'varchar', '', $char_d, '', '',
2573         'value',    'text', 'NULL', '', '', '',
2574       ],
2575       'primary_key' => 'confnum',
2576       'unique' => [ [ 'agentnum', 'name' ]],
2577       'index' => [],
2578     },
2579
2580     'pkg_referral' => {
2581       'columns' => [
2582         'pkgrefnum',     'serial', '', '', '', '',
2583         'pkgnum',        'int',    '', '', '', '',
2584         'refnum',        'int',    '', '', '', '',
2585       ],
2586       'primary_key' => 'pkgrefnum',
2587       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2588       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2589     },
2590
2591     'svc_pbx' => {
2592       'columns' => [
2593         'svcnum',         'int',     '',      '', '', '',
2594         'id',             'int', 'NULL',      '', '', '',
2595         'title',      'varchar', 'NULL', $char_d, '', '',
2596         'max_extensions', 'int', 'NULL',      '', '', '',
2597       ],
2598       'primary_key' => 'svcnum',
2599       'unique' => [],
2600       'index'  => [ [ 'id' ] ],
2601     },
2602
2603     'svc_mailinglist' => { #svc_group?
2604       'columns' => [
2605         'svcnum',            'int',     '',            '', '', '',
2606         'username',      'varchar',     '', $username_len, '', '',
2607         'domsvc',            'int',     '',            '', '', '',
2608         'listnum',           'int',     '',            '', '', '',
2609         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
2610         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
2611         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
2612         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
2613       ],
2614       'primary_key' => 'svcnum',
2615       'unique' => [],
2616       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
2617     },
2618
2619     'mailinglist' => {
2620       'columns' => [
2621         'listnum',   'serial', '',      '', '', '',
2622         'listname', 'varchar', '', $char_d, '', '',
2623       ],
2624       'primary_key' => 'listnum',
2625       'unique' => [],
2626       'index'  => [],
2627     },
2628
2629     'mailinglistmember' => {
2630       'columns' => [
2631         'membernum',        'serial',     '',   '', '', '',
2632         'listnum',             'int',     '',   '', '', '',
2633         'svcnum',              'int', 'NULL',   '', '', '',
2634         'email',           'varchar', 'NULL',  255, '', '',
2635       ],
2636       'primary_key' => 'membernum',
2637       'unique'      => [],
2638       'index'       => [['listnum'],['svcnum'],['email']],
2639     },
2640
2641
2642     # name type nullability length default local
2643
2644     #'new_table' => {
2645     #  'columns' => [
2646     #    'num', 'serial',       '', '', '', '',
2647     #  ],
2648     #  'primary_key' => 'num',
2649     #  'unique' => [],
2650     #  'index'  => [],
2651     #},
2652
2653   };
2654
2655 }
2656
2657 =back
2658
2659 =head1 BUGS
2660
2661 =head1 SEE ALSO
2662
2663 L<DBIx::DBSchema>
2664
2665 =cut
2666
2667 1;
2668