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, '', '',
 356         '_password',        'varchar', 'NULL', $char_d, '', '',
 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', 'NULL', 32, '', '',
 395         'usernum',   'int', 'NULL', '', '', '',
 396         'filename',  'varchar', '', 255, '', '',
 397         'mime_type', 'varchar', '', $char_d, '', '',
 398         'title',     'varchar', 'NULL', $char_d, '', '',
 399         'body',      'blob', 'NULL', '', '', '',
 400         'disabled',  @date_type, '', '',
 401       ],
 402       'primary_key' => 'attachnum',
 403       'unique'      => [],
 404       'index'       => [ ['custnum'], ['usernum'], ],
 405     },
 406
 407     'cust_bill' => {
 408       'columns' => [
 409         #regular fields
 410         'invnum',    'serial',     '', '', '', '',
 411         'custnum',      'int',     '', '', '', '',
 412         '_date',        @date_type,        '', '',
 413         'charged',      @money_type,       '', '',
 414         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 415
 416         #customer balance info at invoice generation time
 417         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 418         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 419
 420         #deprecated (unused by now, right?)
 421         'printed',      'int',     '', '', '', '',
 422
 423         #specific use cases
 424         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 425         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 426         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 427       ],
 428       'primary_key' => 'invnum',
 429       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 430       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
 431     },
 432
 433     'cust_statement' => {
 434       'columns' => [
 435         'statementnum', 'serial', '', '', '', '',
 436         'custnum',         'int', '', '', '', '',
 437         '_date',           @date_type,    '', '',
 438       ],
 439       'primary_key' => 'statementnum',
 440       'unique' => [],
 441       'index' => [ ['custnum'], ['_date'], ],
 442     },
 443
 444     'cust_bill_event' => {
 445       'columns' => [
 446         'eventnum',    'serial',  '', '', '', '',
 447         'invnum',   'int',  '', '', '', '',
 448         'eventpart',   'int',  '', '', '', '',
 449         '_date',     @date_type, '', '',
 450         'status', 'varchar', '', $char_d, '', '',
 451         'statustext', 'text', 'NULL', '', '', '',
 452       ],
 453       'primary_key' => 'eventnum',
 454       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 455       'unique' => [],
 456       'index' => [ ['invnum'], ['status'], ['eventpart'],
 457                    ['statustext'], ['_date'],
 458                  ],
 459     },
 460
 461     'part_bill_event' => {
 462       'columns' => [
 463         'eventpart',    'serial',  '', '', '', '',
 464         'freq',        'varchar',       'NULL',     $char_d, '', '',
 465         'payby',       'char',  '', 4, '', '',
 466         'event',       'varchar',           '',     $char_d, '', '',
 467         'eventcode',    @perl_type, '', '',
 468         'seconds',     'int', 'NULL', '', '', '',
 469         'weight',      'int', '', '', '', '',
 470         'plan',       'varchar', 'NULL', $char_d, '', '',
 471         'plandata',   'text', 'NULL', '', '', '',
 472         'reason',     'int', 'NULL', '', '', '',
 473         'disabled',     'char', 'NULL', 1, '', '',
 474       ],
 475       'primary_key' => 'eventpart',
 476       'unique' => [],
 477       'index' => [ ['payby'], ['disabled'], ],
 478     },
 479
 480     'part_event' => {
 481       'columns' => [
 482         'eventpart',   'serial',      '',      '', '', '',
 483         'agentnum',    'int',     'NULL',      '', '', '',
 484         'event',       'varchar',     '', $char_d, '', '',
 485         'eventtable',  'varchar',     '', $char_d, '', '',
 486         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 487         'weight',      'int',         '',      '', '', '',
 488         'action',      'varchar',     '', $char_d, '', '',
 489         'disabled',     'char',   'NULL',       1, '', '',
 490       ],
 491       'primary_key' => 'eventpart',
 492       'unique' => [],
 493       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 494     },
 495
 496     'part_event_option' => {
 497       'columns' => [
 498         'optionnum', 'serial', '', '', '', '',
 499         'eventpart', 'int', '', '', '', '',
 500         'optionname', 'varchar', '', $char_d, '', '',
 501         'optionvalue', 'text', 'NULL', '', '', '',
 502       ],
 503       'primary_key' => 'optionnum',
 504       'unique'      => [],
 505       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 506     },
 507
 508     'part_event_condition' => {
 509       'columns' => [
 510         'eventconditionnum', 'serial', '', '', '', '',
 511         'eventpart', 'int', '', '', '', '',
 512         'conditionname', 'varchar', '', $char_d, '', '',
 513       ],
 514       'primary_key' => 'eventconditionnum',
 515       'unique'      => [],
 516       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 517     },
 518
 519     'part_event_condition_option' => {
 520       'columns' => [
 521         'optionnum', 'serial', '', '', '', '',
 522         'eventconditionnum', 'int', '', '', '', '',
 523         'optionname', 'varchar', '', $char_d, '', '',
 524         'optionvalue', 'text', 'NULL', '', '', '',
 525       ],
 526       'primary_key' => 'optionnum',
 527       'unique'      => [],
 528       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 529     },
 530
 531     'part_event_condition_option_option' => {
 532       'columns' => [
 533         'optionoptionnum', 'serial', '', '', '', '',
 534         'optionnum', 'int', '', '', '', '',
 535         'optionname', 'varchar', '', $char_d, '', '',
 536         'optionvalue', 'text', 'NULL', '', '', '',
 537       ],
 538       'primary_key' => 'optionoptionnum',
 539       'unique'      => [],
 540       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 541     },
 542
 543     'cust_event' => {
 544       'columns' => [
 545         'eventnum',    'serial',  '', '', '', '',
 546         'eventpart',   'int',  '', '', '', '',
 547         'tablenum',   'int',  '', '', '', '',
 548         '_date',     @date_type, '', '',
 549         'status', 'varchar', '', $char_d, '', '',
 550         'statustext', 'text', 'NULL', '', '', '',
 551       ],
 552       'primary_key' => 'eventnum',
 553       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 554       'unique' => [],
 555       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 556                    ['statustext'], ['_date'],
 557                  ],
 558     },
 559
 560     'cust_bill_pkg' => {
 561       'columns' => [
 562         'billpkgnum',        'serial',     '',      '', '', '',
 563         'invnum',               'int',     '',      '', '', '',
 564         'pkgnum',               'int',     '',      '', '', '',
 565         'pkgpart_override',     'int', 'NULL',      '', '', '',
 566         'setup',               @money_type,             '', '',
 567         'recur',               @money_type,             '', '',
 568         'sdate',               @date_type,              '', '',
 569         'edate',               @date_type,              '', '',
 570         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 571         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 572         'section',          'varchar', 'NULL', $char_d, '', '',
 573         'freq',             'varchar', 'NULL', $char_d, '', '',
 574         'quantity',             'int', 'NULL',      '', '', '',
 575         'unitsetup',           @money_typen,            '', '',
 576         'unitrecur',           @money_typen,            '', '',
 577         'hidden',              'char', 'NULL',       1, '', '',
 578       ],
 579       'primary_key' => 'billpkgnum',
 580       'unique' => [],
 581       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 582     },
 583
 584     'cust_bill_pkg_detail' => {
 585       'columns' => [
 586         'detailnum', 'serial', '', '', '', '',
 587         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 588         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 589         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 590         'amount',  'decimal', 'NULL', '10,4', '', '',
 591         'format',  'char', 'NULL', 1, '', '',
 592         'classnum', 'int', 'NULL', '', '', '',
 593         'duration', 'int', 'NULL', '',  0, '',
 594         'phonenum', 'varchar', 'NULL', 15, '', '',
 595         'regionname', 'varchar', 'NULL', $char_d, '', '',
 596         'detail',  'varchar', '', 255, '', '',
 597       ],
 598       'primary_key' => 'detailnum',
 599       'unique' => [],
 600       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 601     },
 602
 603     'cust_bill_pkg_display' => {
 604       'columns' => [
 605         'billpkgdisplaynum', 'serial', '', '', '', '',
 606         'billpkgnum', 'int', '', '', '', '',
 607         'section',  'varchar', 'NULL', $char_d, '', '',
 608         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 609         #'unitrecur', @money_typen, '', '',     #this too?
 610         'post_total', 'char', 'NULL', 1, '', '',
 611         'type',       'char', 'NULL', 1, '', '',
 612         'summary',    'char', 'NULL', 1, '', '',
 613       ],
 614       'primary_key' => 'billpkgdisplaynum',
 615       'unique' => [],
 616       'index' => [ ['billpkgnum'], ],
 617     },
 618
 619     'cust_bill_pkg_tax_location' => {
 620       'columns' => [
 621         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 622         'billpkgnum',               'int',      '', '', '', '',
 623         'taxnum',                   'int',      '', '', '', '',
 624         'taxtype',              'varchar',      '', $char_d, '', '',
 625         'pkgnum',                   'int',      '', '', '', '',
 626         'locationnum',              'int',      '', '', '', '', #redundant?
 627         'amount',                   @money_type,        '', '',
 628       ],
 629       'primary_key' => 'billpkgtaxlocationnum',
 630       'unique' => [],
 631       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 632     },
 633
 634     'cust_bill_pkg_tax_rate_location' => {
 635       'columns' => [
 636         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 637         'billpkgnum',                   'int',      '', '', '', '',
 638         'taxnum',                       'int',      '', '', '', '',
 639         'taxtype',                  'varchar',      '', $char_d, '', '',
 640         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 641         'taxratelocationnum',           'int',      '', '', '', '',
 642         'amount',                       @money_type,        '', '',
 643       ],
 644       'primary_key' => 'billpkgtaxratelocationnum',
 645       'unique' => [],
 646       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 647     },
 648
 649     'cust_credit' => {
 650       'columns' => [
 651         'crednum',  'serial', '', '', '', '',
 652         'custnum',  'int', '', '', '', '',
 653         '_date',    @date_type, '', '',
 654         'amount',   @money_type, '', '',
 655         'otaker',   'varchar', 'NULL', 32, '', '',
 656         'usernum',   'int', 'NULL', '', '', '',
 657         'reason',   'text', 'NULL', '', '', '',
 658         'reasonnum', 'int', 'NULL', '', '', '',
 659         'addlinfo', 'text', 'NULL', '', '', '',
 660         'closed',    'char', 'NULL', 1, '', '',
 661         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 662         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
 663       ],
 664       'primary_key' => 'crednum',
 665       'unique' => [],
 666       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'] ],
 667     },
 668
 669     'cust_credit_bill' => {
 670       'columns' => [
 671         'creditbillnum', 'serial', '', '', '', '',
 672         'crednum',  'int', '', '', '', '',
 673         'invnum',  'int', '', '', '', '',
 674         '_date',    @date_type, '', '',
 675         'amount',   @money_type, '', '',
 676         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 677       ],
 678       'primary_key' => 'creditbillnum',
 679       'unique' => [],
 680       'index' => [ ['crednum'], ['invnum'] ],
 681     },
 682
 683     'cust_credit_bill_pkg' => {
 684       'columns' => [
 685         'creditbillpkgnum', 'serial', '',      '', '', '',
 686         'creditbillnum',       'int', '',      '', '', '',
 687         'billpkgnum',          'int', '',      '', '', '',
 688         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
 689         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
 690         'amount',            @money_type,          '', '',
 691         'setuprecur',      'varchar', '', $char_d, '', '',
 692         'sdate',   @date_type, '', '',
 693         'edate',   @date_type, '', '',
 694       ],
 695       'primary_key' => 'creditbillpkgnum',
 696       'unique'      => [],
 697       'index'       => [ [ 'creditbillnum' ],
 698                          [ 'billpkgnum' ],
 699                          [ 'billpkgtaxlocationnum' ],
 700                          [ 'billpkgtaxratelocationnum' ],
 701                        ],
 702     },
 703
 704     'cust_main' => {
 705       'columns' => [
 706         'custnum',  'serial',  '',     '', '', '',
 707         'agentnum', 'int',  '',     '', '', '',
 708         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 709         'classnum', 'int', 'NULL', '', '', '',
 710         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 711 #        'titlenum', 'int',  'NULL',   '', '', '',
 712         'last',     'varchar', '',     $char_d, '', '',
 713 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 714         'first',    'varchar', '',     $char_d, '', '',
 715         'ss',       'varchar', 'NULL', 11, '', '',
 716         'stateid', 'varchar', 'NULL', $char_d, '', '',
 717         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 718         'birthdate' ,@date_type, '', '',
 719         'signupdate',@date_type, '', '',
 720         'dundate',   @date_type, '', '',
 721         'company',  'varchar', 'NULL', $char_d, '', '',
 722         'address1', 'varchar', '',     $char_d, '', '',
 723         'address2', 'varchar', 'NULL', $char_d, '', '',
 724         'city',     'varchar', '',     $char_d, '', '',
 725         'county',   'varchar', 'NULL', $char_d, '', '',
 726         'state',    'varchar', 'NULL', $char_d, '', '',
 727         'zip',      'varchar', 'NULL', 10, '', '',
 728         'country',  'char', '',     2, '', '',
 729         'daytime',  'varchar', 'NULL', 20, '', '',
 730         'night',    'varchar', 'NULL', 20, '', '',
 731         'fax',      'varchar', 'NULL', 12, '', '',
 732         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 733 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 734         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 735         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 736         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 737         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 738         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 739         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 740         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 741         'ship_zip',      'varchar', 'NULL', 10, '', '',
 742         'ship_country',  'char', 'NULL', 2, '', '',
 743         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 744         'ship_night',    'varchar', 'NULL', 20, '', '',
 745         'ship_fax',      'varchar', 'NULL', 12, '', '',
 746         'payby',    'char', '',     4, '', '',
 747         'payinfo',  'varchar', 'NULL', 512, '', '',
 748         'paycvv',   'varchar', 'NULL', 512, '', '',
 749         'paymask', 'varchar', 'NULL', $char_d, '', '',
 750         #'paydate',  @date_type, '', '',
 751         'paydate',  'varchar', 'NULL', 10, '', '',
 752         'paystart_month', 'int', 'NULL', '', '', '',
 753         'paystart_year',  'int', 'NULL', '', '', '',
 754         'payissue', 'varchar', 'NULL', 2, '', '',
 755         'payname',  'varchar', 'NULL', $char_d, '', '',
 756         'paystate', 'varchar', 'NULL', $char_d, '', '',
 757         'paytype',  'varchar', 'NULL', $char_d, '', '',
 758         'payip',    'varchar', 'NULL', 15, '', '',
 759         'geocode',  'varchar', 'NULL', 20,  '', '',
 760         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
 761         'tax',      'char', 'NULL', 1, '', '',
 762         'otaker',   'varchar', 'NULL',    32, '', '',
 763         'usernum',   'int', 'NULL', '', '', '',
 764         'refnum',   'int',  '',     '', '', '',
 765         'referral_custnum', 'int',  'NULL', '', '', '',
 766         'comments', 'text', 'NULL', '', '', '',
 767         'spool_cdr','char', 'NULL', 1, '', '',
 768         'squelch_cdr','char', 'NULL', 1, '', '',
 769         'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
 770         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 771         'credit_limit', @money_typen, '', '',
 772         'archived', 'char', 'NULL', 1, '', '',
 773         'email_csv_cdr', 'char', 'NULL', 1, '', '',
 774         'accountcode_cdr', 'char', 'NULL', 1, '', '',
 775       ],
 776       'primary_key' => 'custnum',
 777       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 778       #'index' => [ ['last'], ['company'] ],
 779       'index' => [
 780                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
 781                    [ 'custbatch' ],
 782                    [ 'referral_custnum' ],
 783                    [ 'payby' ], [ 'paydate' ],
 784                    [ 'archived' ],
 785                    #billing
 786                    [ 'last' ], [ 'company' ],
 787                    [ 'county' ], [ 'state' ], [ 'country' ],
 788                    [ 'zip' ],
 789                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 790                    #shipping
 791                    [ 'ship_last' ], [ 'ship_company' ],
 792                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 793                    [ 'ship_zip' ],
 794                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 795                  ],
 796     },
 797
 798     'cust_recon' => {  # what purpose does this serve?
 799       'columns' => [
 800         'reconid',      'serial',  '',          '', '', '',
 801         'recondate',    @date_type,                 '', '',
 802         'custnum',      'int'   ,  '',          '', '', '',
 803         'agentnum',     'int',     '',          '', '', '',
 804         'last',         'varchar', '',     $char_d, '', '',
 805         'first',        'varchar', '',     $char_d, '', '',
 806         'address1',     'varchar', '',     $char_d, '', '',
 807         'address2',     'varchar', 'NULL', $char_d, '', '',
 808         'city',         'varchar', '',     $char_d, '', '',
 809         'state',        'varchar', 'NULL', $char_d, '', '',
 810         'zip',          'varchar', 'NULL',      10, '', '',
 811         'pkg',          'varchar', 'NULL', $char_d, '', '',
 812         'adjourn',      @date_type,                 '', '',
 813         'status',       'varchar', 'NULL',      10, '', '',
 814         'agent_custid', 'varchar',  '',    $char_d, '', '',
 815         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 816         'agent_adjourn', @date_type,                '', '',
 817         'comments',     'text',    'NULL',      '', '', '',
 818       ],
 819       'primary_key' => 'reconid',
 820       'unique' => [],
 821       'index' => [],
 822     },
 823
 824     #eventually for cust_main too
 825     'contact' => {
 826       'columns' => [
 827         'contactnum', 'serial',     '',      '', '', '',
 828         'prospectnum',   'int', 'NULL',      '', '', '',
 829         'custnum',       'int', 'NULL',      '', '', '',
 830         'locationnum',   'int', 'NULL',      '', '', '', #not yet
 831 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
 832         'last',      'varchar',     '', $char_d, '', '',
 833 #        'middle',    'varchar', 'NULL', $char_d, '', '',
 834         'first',     'varchar',     '', $char_d, '', '',
 835         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
 836         'comment',   'varchar', 'NULL', $char_d, '', '',
 837         'disabled',     'char', 'NULL',       1, '', '',
 838       ],
 839       'primary_key' => 'contactnum',
 840       'unique'      => [],
 841       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
 842                          [ 'last' ], [ 'first' ],
 843                        ],
 844     },
 845
 846     'contact_phone' => {
 847       'columns' => [
 848         'contactphonenum', 'serial',     '', '', '', '',
 849         'contactnum',         'int',     '', '', '', '',
 850         'phonetypenum',       'int',     '', '', '', '',
 851         'countrycode',    'varchar',     '',  3, '', '',
 852         'phonenum',       'varchar',     '', 14, '', '',
 853         'extension',      'varchar', 'NULL',  7, '', '',
 854         #?#'comment',        'varchar',     '', $char_d, '', '',
 855       ],
 856       'primary_key' => 'contactphonenum',
 857       'unique'      => [],
 858       'index'       => [],
 859     },
 860
 861     'phone_type' => {
 862       'columns' => [
 863         'phonetypenum',  'serial', '',      '', '', '',
 864         'typename',     'varchar', '', $char_d, '', '',
 865         'weight',           'int', '',      '', '', '',
 866       ],
 867       'primary_key' => 'phonetypenum',
 868       'unique'      => [ [ 'typename' ], ],
 869       'index'       => [],
 870     },
 871
 872     'contact_email' => {
 873       'columns' => [
 874         'contactemailnum', 'serial', '',      '', '', '',
 875         'contactnum',         'int', '',      '', '', '',
 876         'emailaddress',   'varchar', '', $char_d, '', '',
 877       ],
 878       'primary_key' => 'contactemailnum',
 879       'unique'      => [ [ 'emailaddress' ], ],
 880       'index'       => [],
 881     },
 882
 883     'prospect_main' => {
 884       'columns' => [
 885         'prospectnum',  'serial',     '',      '', '', '',
 886         'agentnum',        'int',     '',      '', '', '',
 887         'company',     'varchar',     '', $char_d, '', '',
 888         #'disabled',     'char', 'NULL',       1, '', '',
 889       ],
 890       'primary_key' => 'prospectnum',
 891       'unique'      => [],
 892       'index'       => [ [ 'company' ], [ 'agentnum' ], ],
 893     },
 894
 895     #eventually use for billing & ship from cust_main too
 896     #for now, just cust_pkg locations
 897     'cust_location' => { #'location' now that its prospects too, but...
 898       'columns' => [
 899         'locationnum',  'serial',     '',      '', '', '',
 900         'prospectnum',     'int', 'NULL',      '', '', '',
 901         'custnum',         'int', 'NULL',      '', '', '',
 902         'address1',    'varchar',     '', $char_d, '', '',
 903         'address2',    'varchar', 'NULL', $char_d, '', '',
 904         'city',        'varchar',     '', $char_d, '', '',
 905         'county',      'varchar', 'NULL', $char_d, '', '',
 906         'state',       'varchar', 'NULL', $char_d, '', '',
 907         'zip',         'varchar', 'NULL',      10, '', '',
 908         'country',        'char',     '',       2, '', '',
 909         'geocode',     'varchar', 'NULL',      20, '', '',
 910         'disabled',       'char', 'NULL',       1, '', '',
 911       ],
 912       'primary_key' => 'locationnum',
 913       'unique'      => [],
 914       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
 915                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 916                        ],
 917     },
 918
 919     'cust_main_invoice' => {
 920       'columns' => [
 921         'destnum',  'serial',  '',     '', '', '',
 922         'custnum',  'int',  '',     '', '', '',
 923         'dest',     'varchar', '',  $char_d, '', '',
 924       ],
 925       'primary_key' => 'destnum',
 926       'unique' => [],
 927       'index' => [ ['custnum'], ],
 928     },
 929
 930     'cust_main_note' => {
 931       'columns' => [
 932         'notenum',  'serial',  '',     '', '', '',
 933         'custnum',  'int',  '',     '', '', '',
 934         'classnum',      'int',     'NULL', '', '', '',
 935         '_date',    @date_type, '', '',
 936         'otaker',   'varchar', 'NULL',    32, '', '',
 937         'usernum',   'int', 'NULL', '', '', '',
 938         'comments', 'text', 'NULL', '', '', '',
 939       ],
 940       'primary_key' => 'notenum',
 941       'unique' => [],
 942       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
 943     },
 944
 945     'cust_note_class' => {
 946       'columns' => [
 947         'classnum',    'serial',   '',      '', '', '',
 948         'classname',   'varchar',  '', $char_d, '', '',
 949         'disabled',    'char', 'NULL',       1, '', '',
 950       ],
 951       'primary_key' => 'classnum',
 952       'unique' => [],
 953       'index' => [ ['disabled'] ],
 954     },
 955
 956     'cust_category' => {
 957       'columns' => [
 958         'categorynum',   'serial',  '', '', '', '',
 959         'categoryname',  'varchar', '', $char_d, '', '',
 960         'weight',         'int', 'NULL',  '', '', '',
 961         'disabled',      'char', 'NULL',   1, '', '',
 962       ],
 963       'primary_key' => 'categorynum',
 964       'unique' => [],
 965       'index' => [ ['disabled'] ],
 966     },
 967
 968     'cust_class' => {
 969       'columns' => [
 970         'classnum',    'serial',   '',      '', '', '',
 971         'classname',   'varchar',  '', $char_d, '', '',
 972         'categorynum', 'int',  'NULL',      '', '', '',
 973         'disabled',    'char', 'NULL',       1, '', '',
 974       ],
 975       'primary_key' => 'classnum',
 976       'unique' => [],
 977       'index' => [ ['disabled'] ],
 978     },
 979
 980     'cust_tag' => {
 981       'columns' => [
 982         'custtagnum', 'serial', '', '', '', '',
 983         'custnum',       'int', '', '', '', '',
 984         'tagnum',        'int', '', '', '', '',
 985       ],
 986       'primary_key' => 'custtagnum',
 987       'unique'      => [ [ 'custnum', 'tagnum' ] ],
 988       'index'       => [ [ 'custnum' ] ],
 989     },
 990
 991     'part_tag' => {
 992       'columns' => [
 993         'tagnum',    'serial',     '',      '', '', '',
 994         'tagname',  'varchar',     '', $char_d, '', '',
 995         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
 996         'tagcolor', 'varchar', 'NULL',       6, '', '',
 997         'disabled',    'char', 'NULL',       1, '', '',
 998       ],
 999       'primary_key' => 'tagnum',
1000       'unique'      => [], #[ [ 'tagname' ] ], #?
1001       'index'       => [ [ 'disabled' ] ],
1002     },
1003
1004     'cust_main_exemption' => {
1005       'columns' => [
1006         'exemptionnum', 'serial', '',      '', '', '',
1007         'custnum',         'int', '',      '', '', '',
1008         'taxname',     'varchar', '', $char_d, '', '',
1009         #start/end dates?  for reporting?
1010       ],
1011       'primary_key' => 'exemptionnum',
1012       'unique'      => [],
1013       'index'       => [ [ 'custnum' ] ],
1014     },
1015
1016     'cust_tax_adjustment' => {
1017       'columns' => [
1018         'adjustmentnum', 'serial',     '',      '', '', '',
1019         'custnum',          'int',     '',      '', '', '',
1020         'taxname',      'varchar',     '', $char_d, '', '',
1021         'amount',    @money_type,                   '', '',
1022         'comment',     'varchar',  'NULL', $char_d, '', '',
1023         'billpkgnum',       'int', 'NULL',      '', '', '',
1024         #more?  no cust_bill_pkg_tax_location?
1025       ],
1026       'primary_key' => 'adjustmentnum',
1027       'unique'      => [],
1028       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1029     },
1030
1031     'cust_main_county' => { #county+state+country are checked off the
1032                             #cust_main_county for validation and to provide
1033                             # a tax rate.
1034       'columns' => [
1035         'taxnum',   'serial',   '',    '', '', '',
1036         'city',     'varchar',  'NULL',    $char_d, '', '',
1037         'county',   'varchar',  'NULL',    $char_d, '', '',
1038         'state',    'varchar',  'NULL',    $char_d, '', '',
1039         'country',  'char',  '', 2, '', '',
1040         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1041         'exempt_amount', @money_type, '', '',
1042         'tax',      'real',  '',    '', '', '', #tax %
1043         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1044         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1045         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1046       ],
1047       'primary_key' => 'taxnum',
1048       'unique' => [],
1049   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1050       'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
1051                    [ 'taxclass' ],
1052                  ],
1053     },
1054
1055     'tax_rate'    => {
1056       'columns' => [
1057         'taxnum',       'serial',     '',      '', '', '',
1058         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1059         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1060         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1061         'taxclassnum', 'int',      '',      '', '', '',
1062         'effective_date', @date_type, '', '',
1063         'tax',        @taxrate_type,      '', '',        # tax %
1064         'excessrate', @taxrate_typen,     '', '',        # second tax %
1065         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1066         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1067         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1068         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1069         'unittype',    'int',  'NULL', '', '', '',      # for fee
1070         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1071         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1072         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1073         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1074         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1075         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1076         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1077         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1078         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1079         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1080         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1081         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1082         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1083         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1084         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1085         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1086       ],
1087       'primary_key' => 'taxnum',
1088       'unique' => [],
1089       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1090     },
1091
1092     'tax_rate_location' => {
1093       'columns' => [
1094         'taxratelocationnum', 'serial',  '',     '', '', '',
1095         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1096         'geocode',            'varchar', '',     20,      '', '',
1097         'city',               'varchar', 'NULL', $char_d, '', '',
1098         'county',             'varchar', 'NULL', $char_d, '', '',
1099         'state',              'char',    'NULL',       2, '', '',
1100         'disabled',           'char',    'NULL', 1, '', '',
1101       ],
1102       'primary_key' => 'taxratelocationnum',
1103       'unique' => [],
1104       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1105     },
1106
1107     'cust_tax_location' => {
1108       'columns' => [
1109         'custlocationnum', 'serial',  '',     '', '', '',
1110         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1111         'city',            'varchar', 'NULL', $char_d, '', '',
1112         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1113         'county',          'varchar', 'NULL', $char_d, '', '',
1114         'zip',             'char',    '',     5,  '', '',
1115         'state',           'char',    '',     2,  '', '',
1116         'plus4hi',         'char',    'NULL', 4,  '', '',
1117         'plus4lo',         'char',    'NULL', 4,  '', '',
1118         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1119         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1120         'geocode',         'varchar', '',    20,  '', '',
1121       ],
1122       'primary_key' => 'custlocationnum',
1123       'unique' => [],
1124       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1125     },
1126
1127     'tax_class' => {
1128       'columns' => [
1129         'taxclassnum',  'serial',  '',            '', '', '',
1130         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1131         'taxclass',     'varchar', '',       $char_d, '', '',
1132         'description',  'varchar', '',     2*$char_d, '', '',
1133       ],
1134       'primary_key' => 'taxclassnum',
1135       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1136       'index' => [],
1137     },
1138
1139     'cust_pay_pending' => {
1140       'columns' => [
1141         'paypendingnum','serial',      '',  '', '', '',
1142         'custnum',      'int',         '',  '', '', '',
1143         'paid',         @money_type,            '', '',
1144         '_date',        @date_type,             '', '',
1145         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1146                                                         # be index into payby
1147                                                         # table eventually
1148         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1149         'paymask',      'varchar', 'NULL', $char_d, '', '',
1150         'paydate',      'varchar', 'NULL', 10, '', '',
1151         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1152         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1153         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1154
1155         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1156         'status',       'varchar',     '', $char_d, '', '',
1157         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1158         'statustext',   'text',    'NULL',  '', '', '',
1159         'gatewaynum',   'int',     'NULL',  '', '', '',
1160         #'cust_balance', @money_type,            '', '',
1161         'paynum',       'int',     'NULL',  '', '', '',
1162         'jobnum',       'int',     'NULL',  '', '', '',
1163       ],
1164       'primary_key' => 'paypendingnum',
1165       'unique'      => [ [ 'payunique' ] ],
1166       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1167     },
1168
1169     'cust_pay' => {
1170       'columns' => [
1171         'paynum',   'serial',    '',   '', '', '',
1172         'custnum',  'int',    '',   '', '', '',
1173         '_date',    @date_type, '', '',
1174         'paid',     @money_type, '', '',
1175         'otaker',   'varchar', 'NULL', 32, '', '',
1176         'usernum',   'int', 'NULL', '', '', '',
1177         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1178                                                  # index into payby table
1179                                                  # eventually
1180         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1181         'paymask', 'varchar', 'NULL', $char_d, '', '',
1182         'paydate',  'varchar', 'NULL', 10, '', '',
1183         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1184         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1185         'closed',    'char', 'NULL', 1, '', '',
1186         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1187       ],
1188       'primary_key' => 'paynum',
1189       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1190       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1191     },
1192
1193     'cust_pay_void' => {
1194       'columns' => [
1195         'paynum',    'int',    '',   '', '', '',
1196         'custnum',   'int',    '',   '', '', '',
1197         'paid',      @money_type, '', '',
1198         '_date',     @date_type, '', '',
1199         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1200                                                   # index into payby table
1201                                                   # eventually
1202         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1203         'paymask', 'varchar', 'NULL', $char_d, '', '',
1204         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1205         'closed',    'char', 'NULL', 1, '', '',
1206         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1207         'void_date', @date_type, '', '',
1208         'reason',    'varchar',   'NULL', $char_d, '', '',
1209         'otaker',   'varchar', 'NULL', 32, '', '',
1210         'usernum',   'int', 'NULL', '', '', '',
1211         'void_usernum',   'int', 'NULL', '', '', '',
1212       ],
1213       'primary_key' => 'paynum',
1214       'unique' => [],
1215       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1216     },
1217
1218     'cust_bill_pay' => {
1219       'columns' => [
1220         'billpaynum', 'serial',     '',   '', '', '',
1221         'invnum',  'int',     '',   '', '', '',
1222         'paynum',  'int',     '',   '', '', '',
1223         'amount',  @money_type, '', '',
1224         '_date',   @date_type, '', '',
1225         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1226       ],
1227       'primary_key' => 'billpaynum',
1228       'unique' => [],
1229       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1230     },
1231
1232     'cust_bill_pay_batch' => {
1233       'columns' => [
1234         'billpaynum', 'serial',     '',   '', '', '',
1235         'invnum',  'int',     '',   '', '', '',
1236         'paybatchnum',  'int',     '',   '', '', '',
1237         'amount',  @money_type, '', '',
1238         '_date',   @date_type, '', '',
1239       ],
1240       'primary_key' => 'billpaynum',
1241       'unique' => [],
1242       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1243     },
1244
1245     'cust_bill_pay_pkg' => {
1246       'columns' => [
1247         'billpaypkgnum', 'serial', '', '', '', '',
1248         'billpaynum',       'int', '', '', '', '',
1249         'billpkgnum',       'int', '', '', '', '',
1250         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1251         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1252         'amount',         @money_type,     '', '',
1253         'setuprecur',      'varchar', '', $char_d, '', '',
1254         'sdate',   @date_type, '', '',
1255         'edate',   @date_type, '', '',
1256       ],
1257       'primary_key' => 'billpaypkgnum',
1258       'unique'      => [],
1259       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1260     },
1261
1262     'pay_batch' => { #batches of payments to an external processor
1263       'columns' => [
1264         'batchnum',   'serial',    '',   '', '', '',
1265         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1266         'status',     'char', 'NULL',     1, '', '',
1267         'download',   @date_type, '', '',
1268         'upload',     @date_type, '', '',
1269       ],
1270       'primary_key' => 'batchnum',
1271       'unique' => [],
1272       'index' => [],
1273     },
1274
1275     'cust_pay_batch' => { #what's this used for again?  list of customers
1276                           #in current CARD batch? (necessarily CARD?)
1277       'columns' => [
1278         'paybatchnum',   'serial',    '',   '', '', '',
1279         'batchnum',   'int',    '',   '', '', '',
1280         'invnum',   'int',    '',   '', '', '',
1281         'custnum',   'int',    '',   '', '', '',
1282         'last',     'varchar', '',     $char_d, '', '',
1283         'first',    'varchar', '',     $char_d, '', '',
1284         'address1', 'varchar', '',     $char_d, '', '',
1285         'address2', 'varchar', 'NULL', $char_d, '', '',
1286         'city',     'varchar', '',     $char_d, '', '',
1287         'state',    'varchar', 'NULL', $char_d, '', '',
1288         'zip',      'varchar', 'NULL', 10, '', '',
1289         'country',  'char', '',     2, '', '',
1290         #        'trancode', 'int', '', '', '', ''
1291         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1292         'payinfo',  'varchar', '',     512, '', '',
1293         #'exp',      @date_type, '', ''
1294         'exp',      'varchar', 'NULL',     11, '', '',
1295         'payname',  'varchar', 'NULL', $char_d, '', '',
1296         'amount',   @money_type, '', '',
1297         'status',   'varchar', 'NULL',     $char_d, '', '',
1298       ],
1299       'primary_key' => 'paybatchnum',
1300       'unique' => [],
1301       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1302     },
1303
1304     'cust_pkg' => {
1305       'columns' => [
1306         'pkgnum',           'serial',     '', '', '', '',
1307         'custnum',             'int',     '', '', '', '',
1308         'pkgpart',             'int',     '', '', '', '',
1309         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1310         'locationnum',         'int', 'NULL', '', '', '',
1311         'otaker',          'varchar', 'NULL', 32, '', '',
1312         'usernum',             'int', 'NULL', '', '', '',
1313         'order_date',     @date_type,             '', '',
1314         'start_date',     @date_type,             '', '',
1315         'setup',          @date_type,             '', '',
1316         'bill',           @date_type,             '', '',
1317         'last_bill',      @date_type,             '', '',
1318         'susp',           @date_type,             '', '',
1319         'adjourn',        @date_type,             '', '',
1320         'cancel',         @date_type,             '', '',
1321         'expire',         @date_type,             '', '',
1322         'contract_end',   @date_type,             '', '',
1323         'change_date',    @date_type,             '', '',
1324         'change_pkgnum',       'int', 'NULL', '', '', '',
1325         'change_pkgpart',      'int', 'NULL', '', '', '',
1326         'change_locationnum',  'int', 'NULL', '', '', '',
1327         'manual_flag',        'char', 'NULL',  1, '', '',
1328         'no_auto',            'char', 'NULL',  1, '', '',
1329         'quantity',            'int', 'NULL', '', '', '',
1330         'agent_pkgid',         'int', 'NULL', '', '', '',
1331       ],
1332       'primary_key' => 'pkgnum',
1333       'unique' => [],
1334       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1335                    [ 'usernum' ], [ 'agent_pkgid' ],
1336                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1337                    ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
1338                    ['expire'], ['contract_end'], ['change_date'],
1339                  ],
1340     },
1341
1342     'cust_pkg_option' => {
1343       'columns' => [
1344         'optionnum', 'serial', '', '', '', '',
1345         'pkgnum', 'int', '', '', '', '',
1346         'optionname', 'varchar', '', $char_d, '', '',
1347         'optionvalue', 'text', 'NULL', '', '', '',
1348       ],
1349       'primary_key' => 'optionnum',
1350       'unique'      => [],
1351       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1352     },
1353
1354     'cust_pkg_detail' => {
1355       'columns' => [
1356         'pkgdetailnum', 'serial', '',      '', '', '',
1357         'pkgnum',          'int', '',      '', '', '',
1358         'detail',      'varchar', '', $char_d, '', '',
1359         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1360         'weight',          'int', '',      '', '', '',
1361       ],
1362       'primary_key' => 'pkgdetailnum',
1363       'unique' => [],
1364       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1365     },
1366
1367     'cust_pkg_reason' => {
1368       'columns' => [
1369         'num',      'serial',    '',   '', '', '',
1370         'pkgnum',   'int',    '',   '', '', '',
1371         'reasonnum','int',    '',   '', '', '',
1372         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1373         'otaker',   'varchar', 'NULL', 32, '', '',
1374         'usernum',   'int', 'NULL', '', '', '',
1375         'date',     @date_type, '', '',
1376       ],
1377       'primary_key' => 'num',
1378       'unique' => [],
1379       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1380     },
1381
1382     'cust_pkg_discount' => {
1383       'columns' => [
1384         'pkgdiscountnum', 'serial', '',     '', '', '',
1385         'pkgnum',            'int', '',     '', '', '',
1386         'discountnum',       'int', '',     '', '', '',
1387         'months_used',   'decimal', 'NULL', '', '', '',
1388         'end_date',     @date_type,             '', '',
1389         'otaker',        'varchar', 'NULL', 32, '', '',
1390         'usernum',           'int', 'NULL', '', '', '',
1391         'disabled',         'char', 'NULL',  1, '', '',
1392       ],
1393       'primary_key' => 'pkgdiscountnum',
1394       'unique' => [],
1395       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1396     },
1397
1398     'cust_bill_pkg_discount' => {
1399       'columns' => [
1400         'billpkgdiscountnum', 'serial',     '', '', '', '',
1401         'billpkgnum',            'int',     '', '', '', '',
1402         'pkgdiscountnum',        'int',     '', '', '', '',
1403         'amount',          @money_type,             '', '',
1404         'months',            'decimal', 'NULL', '', '', '',
1405       ],
1406       'primary_key' => 'billpkgdiscountnum',
1407       'unique' => [],
1408       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1409     },
1410
1411     'discount' => {
1412       'columns' => [
1413         'discountnum', 'serial',     '',      '', '', '',
1414         #'agentnum',       'int', 'NULL',      '', '', '',
1415         'name',       'varchar', 'NULL', $char_d, '', '',
1416         'amount',   @money_type,                  '', '',
1417         'percent',    'decimal',     '',      '', '', '',
1418         'months',     'decimal', 'NULL',      '', '', '',
1419         'disabled',      'char', 'NULL',       1, '', '',
1420       ],
1421       'primary_key' => 'discountnum',
1422       'unique' => [],
1423       'index'  => [], # [ 'agentnum' ], ],
1424     },
1425
1426     'cust_refund' => {
1427       'columns' => [
1428         'refundnum',    'serial',    '',   '', '', '',
1429         'custnum',  'int',    '',   '', '', '',
1430         '_date',        @date_type, '', '',
1431         'refund',       @money_type, '', '',
1432         'otaker',       'varchar',   'NULL',   32, '', '',
1433         'usernum',   'int', 'NULL', '', '', '',
1434         'reason',       'varchar',   '',   $char_d, '', '',
1435         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1436                                                      # be index into payby
1437                                                      # table eventually
1438         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1439         'paymask', 'varchar', 'NULL', $char_d, '', '',
1440         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1441         'closed',    'char', 'NULL', 1, '', '',
1442       ],
1443       'primary_key' => 'refundnum',
1444       'unique' => [],
1445       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1446     },
1447
1448     'cust_credit_refund' => {
1449       'columns' => [
1450         'creditrefundnum', 'serial',     '',   '', '', '',
1451         'crednum',  'int',     '',   '', '', '',
1452         'refundnum',  'int',     '',   '', '', '',
1453         'amount',  @money_type, '', '',
1454         '_date',   @date_type, '', '',
1455       ],
1456       'primary_key' => 'creditrefundnum',
1457       'unique' => [],
1458       'index' => [ ['crednum'], ['refundnum'] ],
1459     },
1460
1461
1462     'cust_svc' => {
1463       'columns' => [
1464         'svcnum',    'serial',    '',   '', '', '',
1465         'pkgnum',    'int',    'NULL',   '', '', '',
1466         'svcpart',   'int',    '',   '', '', '',
1467         'overlimit', @date_type, '', '',
1468       ],
1469       'primary_key' => 'svcnum',
1470       'unique' => [],
1471       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1472     },
1473
1474     'cust_svc_option' => {
1475       'columns' => [
1476         'optionnum',   'serial', '', '', '', '',
1477         'svcnum',      'int', '', '', '', '',
1478         'optionname',  'varchar', '', $char_d, '', '',
1479         'optionvalue', 'text', 'NULL', '', '', '',
1480       ],
1481       'primary_key' => 'optionnum',
1482       'unique'      => [],
1483       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1484     },
1485
1486     'part_pkg' => {
1487       'columns' => [
1488         'pkgpart',       'serial',    '',   '', '', '',
1489         'pkg',           'varchar',   '',   $char_d, '', '',
1490         'comment',       'varchar',   '',   $char_d, '', '',
1491         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1492         'setup',         @perl_type, '', '',
1493         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1494         'recur',         @perl_type, '', '',
1495         'setuptax',      'char', 'NULL', 1, '', '',
1496         'recurtax',      'char', 'NULL', 1, '', '',
1497         'plan',          'varchar', 'NULL', $char_d, '', '',
1498         'plandata',      'text', 'NULL', '', '', '',
1499         'disabled',      'char', 'NULL', 1, '', '',
1500         'custom',        'char', 'NULL', 1, '', '',
1501         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1502         'classnum',      'int',     'NULL', '', '', '',
1503         'addon_classnum','int',     'NULL', '', '', '',
1504         'taxproductnum', 'int',     'NULL', '', '', '',
1505         'setup_cost',    @money_typen,          '', '',
1506         'recur_cost',    @money_typen,          '', '',
1507         'pay_weight',    'real',    'NULL', '', '', '',
1508         'credit_weight', 'real',    'NULL', '', '', '',
1509         'agentnum',      'int',     'NULL', '', '', '',
1510         'fcc_ds0s',      'int',     'NULL', '', '', '',
1511         'no_auto',      'char',     'NULL',  1, '', '',
1512       ],
1513       'primary_key' => 'pkgpart',
1514       'unique' => [],
1515       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1516                    [ 'agentnum' ],
1517                  ],
1518     },
1519
1520     'part_pkg_link' => {
1521       'columns' => [
1522         'pkglinknum',  'serial',   '',      '', '', '',
1523         'src_pkgpart', 'int',      '',      '', '', '',
1524         'dst_pkgpart', 'int',      '',      '', '', '',
1525         'link_type',   'varchar',  '', $char_d, '', '',
1526         'hidden',      'char', 'NULL',       1, '', '',
1527       ],
1528       'primary_key' => 'pkglinknum',
1529       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1530       'index'  => [ [ 'src_pkgpart' ] ],
1531     },
1532     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1533     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1534
1535     'part_pkg_discount' => {
1536       'columns' => [
1537         'pkgdiscountnum', 'serial',   '',      '', '', '',
1538         'pkgpart',        'int',      '',      '', '', '',
1539         'discountnum',    'int',      '',      '', '', '',
1540       ],
1541       'primary_key' => 'pkgdiscountnum',
1542       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
1543       'index'  => [],
1544     },
1545
1546     'part_pkg_taxclass' => {
1547       'columns' => [
1548         'taxclassnum',  'serial', '',       '', '', '',
1549         'taxclass',     'varchar', '', $char_d, '', '',
1550         'disabled', 'char',   'NULL',         1, '', '',
1551       ],
1552       'primary_key' => 'taxclassnum',
1553       'unique'      => [ [ 'taxclass' ] ],
1554       'index'       => [ [ 'disabled' ] ],
1555     },
1556
1557     'part_pkg_taxproduct' => {
1558       'columns' => [
1559         'taxproductnum', 'serial',      '',        '', '', '',
1560         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1561         'taxproduct',    'varchar',     '',   $char_d, '', '',
1562         'description',   'varchar',     '', 3*$char_d, '', '',
1563       ],
1564       'primary_key' => 'taxproductnum',
1565       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1566       'index'       => [],
1567     },
1568
1569     'part_pkg_taxrate' => {
1570       'columns' => [
1571         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1572         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1573         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1574         'taxproductnum', 'int',  '',     '',       '', '',
1575         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1576         'county',           'varchar', 'NULL', $char_d, '', '',
1577         'state',            'varchar', 'NULL', $char_d, '', '',
1578         'local',            'varchar', 'NULL', $char_d, '', '',
1579         'country',          'char',    'NULL', 2,       '', '',
1580         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1581         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1582         'taxclassnum',      'int',     'NULL', '',      '', '',
1583         'effdate',          @date_type, '', '',
1584         'taxable',          'char',    'NULL', 1,       '', '',
1585       ],
1586       'primary_key' => 'pkgtaxratenum',
1587       'unique' => [],
1588       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1589     },
1590
1591     'part_pkg_taxoverride' => {
1592       'columns' => [
1593         'taxoverridenum', 'serial', '', '', '', '',
1594         'pkgpart',           'int', '', '', '', '',
1595         'taxclassnum',       'int', '', '', '', '',
1596         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1597       ],
1598       'primary_key' => 'taxoverridenum',
1599       'unique' => [],
1600       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1601     },
1602
1603 #    'part_title' => {
1604 #      'columns' => [
1605 #        'titlenum',   'int',    '',   '',
1606 #        'title',      'varchar',   '',   $char_d,
1607 #      ],
1608 #      'primary_key' => 'titlenum',
1609 #      'unique' => [ [] ],
1610 #      'index' => [ [] ],
1611 #    },
1612
1613     'pkg_svc' => {
1614       'columns' => [
1615         'pkgsvcnum',  'serial', '',  '', '', '',
1616         'pkgpart',    'int',    '',   '', '', '',
1617         'svcpart',    'int',    '',   '', '', '',
1618         'quantity',   'int',    '',   '', '', '',
1619         'primary_svc','char', 'NULL',  1, '', '',
1620         'hidden',     'char', 'NULL',  1, '', '',
1621       ],
1622       'primary_key' => 'pkgsvcnum',
1623       'unique' => [ ['pkgpart', 'svcpart'] ],
1624       'index' => [ ['pkgpart'], ['quantity'] ],
1625     },
1626
1627     'part_referral' => {
1628       'columns' => [
1629         'refnum',   'serial',     '',        '', '', '',
1630         'referral', 'varchar',    '',   $char_d, '', '',
1631         'disabled', 'char',   'NULL',         1, '', '',
1632         'agentnum', 'int',    'NULL',        '', '', '',
1633       ],
1634       'primary_key' => 'refnum',
1635       'unique' => [],
1636       'index' => [ ['disabled'], ['agentnum'], ],
1637     },
1638
1639     'part_svc' => {
1640       'columns' => [
1641         'svcpart',    'serial',    '',   '', '', '',
1642         'svc',        'varchar',   '',   $char_d, '', '',
1643         'svcdb',      'varchar',   '',   $char_d, '', '',
1644         'disabled',   'char',  'NULL',   1, '', '',
1645       ],
1646       'primary_key' => 'svcpart',
1647       'unique' => [],
1648       'index' => [ [ 'disabled' ] ],
1649     },
1650
1651     'part_svc_column' => {
1652       'columns' => [
1653         'columnnum',   'serial',         '', '', '', '',
1654         'svcpart',     'int',         '', '', '', '',
1655         'columnname',  'varchar',     '', 64, '', '',
1656         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1657         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1658         'columnflag',  'char',    'NULL', 1, '', '',
1659       ],
1660       'primary_key' => 'columnnum',
1661       'unique' => [ [ 'svcpart', 'columnname' ] ],
1662       'index' => [ [ 'svcpart' ] ],
1663     },
1664
1665     #(this should be renamed to part_pop)
1666     'svc_acct_pop' => {
1667       'columns' => [
1668         'popnum',    'serial',    '',   '', '', '',
1669         'city',      'varchar',   '',   $char_d, '', '',
1670         'state',     'varchar',   '',   $char_d, '', '',
1671         'ac',        'char',   '',   3, '', '',
1672         'exch',      'char',   '',   3, '', '',
1673         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1674       ],
1675       'primary_key' => 'popnum',
1676       'unique' => [],
1677       'index' => [ [ 'state' ] ],
1678     },
1679
1680     'part_pop_local' => {
1681       'columns' => [
1682         'localnum',  'serial',     '',     '', '', '',
1683         'popnum',    'int',     '',     '', '', '',
1684         'city',      'varchar', 'NULL', $char_d, '', '',
1685         'state',     'char',    'NULL', 2, '', '',
1686         'npa',       'char',    '',     3, '', '',
1687         'nxx',       'char',    '',     3, '', '',
1688       ],
1689       'primary_key' => 'localnum',
1690       'unique' => [],
1691       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1692     },
1693
1694     'svc_acct' => {
1695       'columns' => [
1696         'svcnum',    'int',    '',   '', '', '',
1697         'username',  'varchar',   '',   $username_len, '', '',
1698         '_password', 'varchar',   'NULL',  512, '', '',
1699         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1700         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1701         'popnum',    'int',    'NULL',   '', '', '',
1702         'uid',       'int', 'NULL',   '', '', '',
1703         'gid',       'int', 'NULL',   '', '', '',
1704         'finger',    'varchar',   'NULL',   $char_d, '', '',
1705         'dir',       'varchar',   'NULL',   $char_d, '', '',
1706         'shell',     'varchar',   'NULL',   $char_d, '', '',
1707         'quota',     'varchar',   'NULL',   $char_d, '', '',
1708         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1709         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1710         'seconds_threshold',   'int', 'NULL',   '', '', '',
1711         'upbytes',   'bigint', 'NULL',   '', '', '',
1712         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1713         'downbytes', 'bigint', 'NULL',   '', '', '',
1714         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1715         'totalbytes','bigint', 'NULL',   '', '', '',
1716         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1717         'domsvc',    'int',     '', '', '', '',
1718         'pbxsvc',    'int', 'NULL', '', '', '',
1719         'last_login',  @date_type, '', '',
1720         'last_logout', @date_type, '', '',
1721         #cardfortress field(s)
1722         'cf_privatekey',      'text', 'NULL',      '', '', '',
1723         #communigate pro fields (quota = MaxAccountSize)
1724         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1725         #settings
1726         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1727         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1728         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1729         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1730         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1731         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1732         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1733         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1734         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1735         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1736         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1737         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
1738         #XXX mailing lists
1739         #preferences
1740         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1741         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1742         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1743         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1744         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1745         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1746         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1747         #mail
1748         #XXX RPOP settings
1749       ],
1750       'primary_key' => 'svcnum',
1751       #'unique' => [ [ 'username', 'domsvc' ] ],
1752       'unique' => [],
1753       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1754     },
1755
1756     'acct_rt_transaction' => {
1757       'columns' => [
1758         'svcrtid',   'int',    '',   '', '', '',
1759         'svcnum',    'int',    '',   '', '', '',
1760         'transaction_id',       'int', '',   '', '', '',
1761         '_date',   @date_type, '', '',
1762         'seconds',   'int', '',   '', '', '', #uhhhh
1763         'support',   'int', '',   '', '', '',
1764       ],
1765       'primary_key' => 'svcrtid',
1766       'unique' => [],
1767       'index' => [ ['svcnum', 'transaction_id'] ],
1768     },
1769
1770     #'svc_charge' => {
1771     #  'columns' => [
1772     #    'svcnum',    'int',    '',   '',
1773     #    'amount',    @money_type,
1774     #  ],
1775     #  'primary_key' => 'svcnum',
1776     #  'unique' => [ [] ],
1777     #  'index' => [ [] ],
1778     #},
1779
1780     'svc_domain' => {
1781       'columns' => [
1782         'svcnum',           'int',    '',        '', '', '',
1783         'domain',       'varchar',    '',   $char_d, '', '',
1784         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1785         'catchall',         'int', 'NULL',       '', '', '',
1786         'parent_svcnum',    'int', 'NULL',       '', '', '',
1787         'registrarnum',     'int', 'NULL',       '', '', '',
1788         'registrarkey', 'varchar', 'NULL',      512, '', '',
1789         'setup_date',      @date_type, '', '',
1790         'renewal_interval', 'int', 'NULL',       '', '', '',
1791         'expiration_date', @date_type, '', '',
1792         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
1793         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
1794         #communigate pro fields (quota = MaxAccountSize)
1795         'max_accounts',     'int', 'NULL',       '', '', '',
1796         'trailer',         'text', 'NULL',       '', '', '',
1797         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
1798         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
1799         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
1800         #settings
1801         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
1802         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
1803         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
1804         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
1805         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
1806         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
1807         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
1808         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
1809         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
1810         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
1811         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
1812         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
1813         #preferences
1814         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
1815         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
1816         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
1817         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
1818         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
1819         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
1820         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
1821       ],
1822       'primary_key' => 'svcnum',
1823       'unique' => [ ],
1824       'index' => [ ['domain'] ],
1825     },
1826
1827     'domain_record' => {
1828       'columns' => [
1829         'recnum',    'serial',     '',  '', '', '',
1830         'svcnum',    'int',     '',  '', '', '',
1831         'reczone',   'varchar', '',  255, '', '',
1832         'recaf',     'char',    '',  2, '', '',
1833         'rectype',   'varchar',    '',  5, '', '',
1834         'recdata',   'varchar', '',  255, '', '',
1835         'ttl',       'int',     'NULL', '', '', '',
1836       ],
1837       'primary_key' => 'recnum',
1838       'unique'      => [],
1839       'index'       => [ ['svcnum'] ],
1840     },
1841
1842     'registrar' => {
1843       'columns' => [
1844         'registrarnum',   'serial', '',      '', '', '',
1845         'registrarname', 'varchar', '', $char_d, '', '',
1846       ],
1847       'primary_key' => 'registrarnum',
1848       'unique'      => [],
1849       'index'       => [],
1850     },
1851
1852     'cgp_rule' => {
1853       'columns' => [
1854         'rulenum',  'serial',     '',      '', '', '',
1855         'name',    'varchar',     '', $char_d, '', '',
1856         'comment', 'varchar', 'NULL', $char_d, '', '',
1857         'svcnum',      'int',     '',      '', '', '',
1858         'priority',    'int',     '',      '', '', '',
1859       ],
1860       'primary_key' => 'rulenum',
1861       'unique'      => [ [ 'svcnum', 'name' ] ],
1862       'index'       => [ [ 'svcnum' ] ],
1863     },
1864
1865     'cgp_rule_condition' => {
1866       'columns' => [
1867         'ruleconditionnum',  'serial',     '',      '', '', '',
1868         'conditionname',    'varchar',     '', $char_d, '', '',
1869         'op',               'varchar', 'NULL', $char_d, '', '',
1870         'params',           'varchar', 'NULL',     255, '', '',
1871         'rulenum',              'int',     '',      '', '', '',
1872       ],
1873       'primary_key' => 'ruleconditionnum',
1874       'unique'      => [],
1875       'index'       => [ [ 'rulenum' ] ],
1876     },
1877
1878     'cgp_rule_action' => {
1879        'columns' => [
1880         'ruleactionnum',  'serial',     '',      '', '', '',
1881         'action',        'varchar',     '', $char_d, '', '',
1882         'params',        'varchar', 'NULL',     255, '', '',
1883         'rulenum',           'int',     '',      '', '', '',
1884       ],
1885       'primary_key' => 'ruleactionnum',
1886       'unique'      => [],
1887       'index'       => [ [ 'rulenum' ] ],
1888    },
1889
1890     'svc_forward' => {
1891       'columns' => [
1892         'svcnum',   'int',            '',   '', '', '',
1893         'srcsvc',   'int',        'NULL',   '', '', '',
1894         'src',      'varchar',    'NULL',  255, '', '',
1895         'dstsvc',   'int',        'NULL',   '', '', '',
1896         'dst',      'varchar',    'NULL',  255, '', '',
1897       ],
1898       'primary_key' => 'svcnum',
1899       'unique'      => [],
1900       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1901     },
1902
1903     'svc_www' => {
1904       'columns' => [
1905         'svcnum',   'int',      '',  '', '', '',
1906         'recnum',   'int',      '',  '', '', '',
1907         'usersvc',  'int',  'NULL',  '', '', '',
1908         'config',   'text', 'NULL',  '', '', '',
1909       ],
1910       'primary_key' => 'svcnum',
1911       'unique'      => [],
1912       'index'       => [],
1913     },
1914
1915     #'svc_wo' => {
1916     #  'columns' => [
1917     #    'svcnum',    'int',    '',   '',
1918     #    'svcnum',    'int',    '',   '',
1919     #    'svcnum',    'int',    '',   '',
1920     #    'worker',    'varchar',   '',   $char_d,
1921     #    '_date',     @date_type,
1922     #  ],
1923     #  'primary_key' => 'svcnum',
1924     #  'unique' => [ [] ],
1925     #  'index' => [ [] ],
1926     #},
1927
1928     'prepay_credit' => {
1929       'columns' => [
1930         'prepaynum',   'serial',     '',   '', '', '',
1931         'identifier',  'varchar', '', $char_d, '', '',
1932         'amount',      @money_type, '', '',
1933         'seconds',     'int',     'NULL', '', '', '',
1934         'upbytes',     'bigint',     'NULL', '', '', '',
1935         'downbytes',   'bigint',     'NULL', '', '', '',
1936         'totalbytes',  'bigint',     'NULL', '', '', '',
1937         'agentnum',    'int',     'NULL', '', '', '',
1938       ],
1939       'primary_key' => 'prepaynum',
1940       'unique'      => [ ['identifier'] ],
1941       'index'       => [],
1942     },
1943
1944     'port' => {
1945       'columns' => [
1946         'portnum',  'serial',     '',   '', '', '',
1947         'ip',       'varchar', 'NULL', 15, '', '',
1948         'nasport',  'int',     'NULL', '', '', '',
1949         'nasnum',   'int',     '',   '', '', '',
1950       ],
1951       'primary_key' => 'portnum',
1952       'unique'      => [],
1953       'index'       => [],
1954     },
1955
1956     'nas' => {
1957       'columns' => [
1958         'nasnum',   'serial',     '',    '', '', '',
1959         'nas',      'varchar', '',    $char_d, '', '',
1960         'nasip',    'varchar', '',    15, '', '',
1961         'nasfqdn',  'varchar', '',    $char_d, '', '',
1962         'last',     'int',     '',    '', '', '',
1963       ],
1964       'primary_key' => 'nasnum',
1965       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1966       'index'       => [ [ 'last' ] ],
1967     },
1968
1969 #    'session' => {
1970 #      'columns' => [
1971 #        'sessionnum', 'serial',       '',   '', '', '',
1972 #        'portnum',    'int',       '',   '', '', '',
1973 #        'svcnum',     'int',       '',   '', '', '',
1974 #        'login',      @date_type, '', '',
1975 #        'logout',     @date_type, '', '',
1976 #      ],
1977 #      'primary_key' => 'sessionnum',
1978 #      'unique'      => [],
1979 #      'index'       => [ [ 'portnum' ] ],
1980 #    },
1981
1982     'queue' => {
1983       'columns' => [
1984         'jobnum',      'serial',     '',      '', '', '',
1985         'job',        'varchar',     '',     512, '', '',
1986         '_date',          'int',     '',      '', '', '',
1987         'status',     'varchar',     '', $char_d, '', '',
1988         'statustext',    'text', 'NULL',      '', '', '',
1989         'svcnum',         'int', 'NULL',      '', '', '',
1990         'custnum',        'int', 'NULL',      '', '', '',
1991         'secure',        'char', 'NULL',       1, '', '',
1992         'priority',       'int', 'NULL',      '', '', '',
1993       ],
1994       'primary_key' => 'jobnum',
1995       'unique'      => [],
1996       'index'       => [ [ 'secure' ], [ 'priority' ],
1997                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1998                        ],
1999     },
2000
2001     'queue_arg' => {
2002       'columns' => [
2003         'argnum', 'serial', '', '', '', '',
2004         'jobnum', 'int', '', '', '', '',
2005         'frozen', 'char', 'NULL',       1, '', '',
2006         'arg', 'text', 'NULL', '', '', '',
2007       ],
2008       'primary_key' => 'argnum',
2009       'unique'      => [],
2010       'index'       => [ [ 'jobnum' ] ],
2011     },
2012
2013     'queue_depend' => {
2014       'columns' => [
2015         'dependnum', 'serial', '', '', '', '',
2016         'jobnum', 'int', '', '', '', '',
2017         'depend_jobnum', 'int', '', '', '', '',
2018       ],
2019       'primary_key' => 'dependnum',
2020       'unique'      => [],
2021       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2022     },
2023
2024     'export_svc' => {
2025       'columns' => [
2026         'exportsvcnum' => 'serial', '', '', '', '',
2027         'exportnum'    => 'int', '', '', '', '',
2028         'svcpart'      => 'int', '', '', '', '',
2029       ],
2030       'primary_key' => 'exportsvcnum',
2031       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2032       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2033     },
2034
2035     'export_device' => {
2036       'columns' => [
2037         'exportdevicenum' => 'serial', '', '', '', '',
2038         'exportnum'    => 'int', '', '', '', '',
2039         'devicepart'      => 'int', '', '', '', '',
2040       ],
2041       'primary_key' => 'exportdevicenum',
2042       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2043       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2044     },
2045
2046     'part_export' => {
2047       'columns' => [
2048         'exportnum', 'serial', '', '', '', '',
2049         'exportname', 'varchar', 'NULL', $char_d, '', '',
2050         'machine', 'varchar', '', $char_d, '', '',
2051         'exporttype', 'varchar', '', $char_d, '', '',
2052         'nodomain',     'char', 'NULL', 1, '', '',
2053       ],
2054       'primary_key' => 'exportnum',
2055       'unique'      => [],
2056       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2057     },
2058
2059     'part_export_option' => {
2060       'columns' => [
2061         'optionnum', 'serial', '', '', '', '',
2062         'exportnum', 'int', '', '', '', '',
2063         'optionname', 'varchar', '', $char_d, '', '',
2064         'optionvalue', 'text', 'NULL', '', '', '',
2065       ],
2066       'primary_key' => 'optionnum',
2067       'unique'      => [],
2068       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2069     },
2070
2071     'radius_usergroup' => {
2072       'columns' => [
2073         'usergroupnum', 'serial', '', '', '', '',
2074         'svcnum',       'int', '', '', '', '',
2075         'groupname',    'varchar', '', $char_d, '', '',
2076       ],
2077       'primary_key' => 'usergroupnum',
2078       'unique'      => [],
2079       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2080     },
2081
2082     'msgcat' => {
2083       'columns' => [
2084         'msgnum', 'serial', '', '', '', '',
2085         'msgcode', 'varchar', '', $char_d, '', '',
2086         'locale', 'varchar', '', 16, '', '',
2087         'msg', 'text', '', '', '', '',
2088       ],
2089       'primary_key' => 'msgnum',
2090       'unique'      => [ [ 'msgcode', 'locale' ] ],
2091       'index'       => [],
2092     },
2093
2094     'cust_tax_exempt' => {
2095       'columns' => [
2096         'exemptnum', 'serial', '', '', '', '',
2097         'custnum',   'int', '', '', '', '',
2098         'taxnum',    'int', '', '', '', '',
2099         'year',      'int', '', '', '', '',
2100         'month',     'int', '', '', '', '',
2101         'amount',   @money_type, '', '',
2102       ],
2103       'primary_key' => 'exemptnum',
2104       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2105       'index'       => [],
2106     },
2107
2108     'cust_tax_exempt_pkg' => {
2109       'columns' => [
2110         'exemptpkgnum',  'serial', '', '', '', '',
2111         #'custnum',      'int', '', '', '', ''
2112         'billpkgnum',   'int', '', '', '', '',
2113         'taxnum',       'int', '', '', '', '',
2114         'year',         'int', '', '', '', '',
2115         'month',        'int', '', '', '', '',
2116         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2117         'amount',       @money_type, '', '',
2118       ],
2119       'primary_key' => 'exemptpkgnum',
2120       'unique' => [],
2121       'index'  => [ [ 'taxnum', 'year', 'month' ],
2122                     [ 'billpkgnum' ],
2123                     [ 'taxnum' ],
2124                     [ 'creditbillpkgnum' ],
2125                   ],
2126     },
2127
2128     'router' => {
2129       'columns' => [
2130         'routernum', 'serial', '', '', '', '',
2131         'routername', 'varchar', '', $char_d, '', '',
2132         'svcnum', 'int', 'NULL', '', '', '',
2133         'agentnum',   'int', 'NULL', '', '', '',
2134       ],
2135       'primary_key' => 'routernum',
2136       'unique'      => [],
2137       'index'       => [],
2138     },
2139
2140     'part_svc_router' => {
2141       'columns' => [
2142         'svcrouternum', 'serial', '', '', '', '',
2143         'svcpart', 'int', '', '', '', '',
2144         'routernum', 'int', '', '', '', '',
2145       ],
2146       'primary_key' => 'svcrouternum',
2147       'unique'      => [],
2148       'index'       => [],
2149     },
2150
2151     'addr_block' => {
2152       'columns' => [
2153         'blocknum', 'serial', '', '', '', '',
2154         'routernum', 'int', '', '', '', '',
2155         'ip_gateway', 'varchar', '', 15, '', '',
2156         'ip_netmask', 'int', '', '', '', '',
2157         'agentnum',   'int', 'NULL', '', '', '',
2158         'manual_flag', 'char', 'NULL', 1, '', '',
2159       ],
2160       'primary_key' => 'blocknum',
2161       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2162       'index'       => [],
2163     },
2164
2165     'svc_broadband' => {
2166       'columns' => [
2167         'svcnum', 'int', '', '', '', '',
2168         'description', 'varchar', 'NULL', $char_d, '', '',
2169         'blocknum', 'int', 'NULL', '', '', '',
2170         'speed_up', 'int', '', '', '', '',
2171         'speed_down', 'int', '', '', '', '',
2172         'ip_addr', 'varchar', 'NULL', 15, '', '',
2173         'mac_addr', 'varchar', 'NULL', 12, '', '',
2174         'authkey',  'varchar', 'NULL', 32, '', '',
2175         'latitude', 'decimal', 'NULL', '', '', '',
2176         'longitude', 'decimal', 'NULL', '', '', '',
2177         'altitude', 'decimal', 'NULL', '', '', '',
2178         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
2179         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2180         'plan_id', 'varchar', 'NULL', $char_d, '', '',
2181       ],
2182       'primary_key' => 'svcnum',
2183       'unique'      => [ [ 'mac_addr' ] ],
2184       'index'       => [],
2185     },
2186
2187     'part_virtual_field' => {
2188       'columns' => [
2189         'vfieldpart', 'serial', '', '', '', '',
2190         'dbtable', 'varchar', '', 32, '', '',
2191         'name', 'varchar', '', 32, '', '',
2192         'check_block', 'text', 'NULL', '', '', '',
2193         'length', 'int', 'NULL', '', '', '',
2194         'list_source', 'text', 'NULL', '', '', '',
2195         'label', 'varchar', 'NULL', 80, '', '',
2196       ],
2197       'primary_key' => 'vfieldpart',
2198       'unique' => [],
2199       'index' => [],
2200     },
2201
2202     'virtual_field' => {
2203       'columns' => [
2204         'vfieldnum', 'serial', '', '', '', '',
2205         'recnum', 'int', '', '', '', '',
2206         'vfieldpart', 'int', '', '', '', '',
2207         'value', 'varchar', '', 128, '', '',
2208       ],
2209       'primary_key' => 'vfieldnum',
2210       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2211       'index' => [],
2212     },
2213
2214     'acct_snarf' => {
2215       'columns' => [
2216         'snarfnum',    'serial',     '',      '', '', '',
2217         'snarfname',  'varchar', 'NULL', $char_d, '', '',
2218         'svcnum',         'int',     '',      '', '', '',
2219         'machine',    'varchar',     '',     255, '', '',
2220         'protocol',   'varchar',     '', $char_d, '', '',
2221         'username',   'varchar',     '', $char_d, '', '',
2222         '_password',  'varchar',     '', $char_d, '', '',
2223         'check_freq',     'int', 'NULL',      '', '', '',
2224         'leavemail',     'char', 'NULL',       1, '', '',
2225         'apop',          'char', 'NULL',       1, '', '',
2226         'tls',           'char', 'NULL',       1, '', '',
2227         'mailbox',    'varchar', 'NULL', $char_d, '', '',
2228       ],
2229       'primary_key' => 'snarfnum',
2230       'unique' => [],
2231       'index'  => [ [ 'svcnum' ] ],
2232     },
2233
2234     'svc_external' => {
2235       'columns' => [
2236         'svcnum',     'int',     '',      '', '', '',
2237         'id',      'bigint', 'NULL',      '', '', '',
2238         'title',  'varchar', 'NULL', $char_d, '', '',
2239       ],
2240       'primary_key' => 'svcnum',
2241       'unique'      => [],
2242       'index'       => [],
2243     },
2244
2245     'cust_pay_refund' => {
2246       'columns' => [
2247         'payrefundnum', 'serial', '', '', '', '',
2248         'paynum',  'int', '', '', '', '',
2249         'refundnum',  'int', '', '', '', '',
2250         '_date',    @date_type, '', '',
2251         'amount',   @money_type, '', '',
2252       ],
2253       'primary_key' => 'payrefundnum',
2254       'unique' => [],
2255       'index' => [ ['paynum'], ['refundnum'] ],
2256     },
2257
2258     'part_pkg_option' => {
2259       'columns' => [
2260         'optionnum', 'serial', '', '', '', '',
2261         'pkgpart', 'int', '', '', '', '',
2262         'optionname', 'varchar', '', $char_d, '', '',
2263         'optionvalue', 'text', 'NULL', '', '', '',
2264       ],
2265       'primary_key' => 'optionnum',
2266       'unique'      => [],
2267       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2268     },
2269
2270     'part_pkg_report_option' => {
2271       'columns' => [
2272         'num',      'serial',   '',      '', '', '',
2273         'name',     'varchar',  '', $char_d, '', '',
2274         'disabled', 'char', 'NULL',       1, '', '',
2275       ],
2276       'primary_key' => 'num',
2277       'unique' => [ [ 'name' ] ],
2278       'index' => [ [ 'disabled' ] ],
2279     },
2280
2281     'rate' => {
2282       'columns' => [
2283         'ratenum',  'serial', '', '', '', '',
2284         'ratename', 'varchar', '', $char_d, '', '',
2285       ],
2286       'primary_key' => 'ratenum',
2287       'unique'      => [],
2288       'index'       => [],
2289     },
2290
2291     'rate_detail' => {
2292       'columns' => [
2293         'ratedetailnum',   'serial',  '',     '', '', '',
2294         'ratenum',         'int',     '',     '', '', '',
2295         'orig_regionnum',  'int', 'NULL',     '', '', '',
2296         'dest_regionnum',  'int',     '',     '', '', '',
2297         'min_included',    'int',     '',     '', '', '',
2298         'conn_charge',     'decimal', '', '10,4', '0', '',
2299         'conn_sec',        'int',     '',     '', '0', '',
2300         'min_charge',      'decimal', '', '10,5', '', '', #@money_type, '', '',
2301         'sec_granularity', 'int',     '',     '', '', '',
2302         'ratetimenum',     'int', 'NULL',     '', '', '',
2303         'classnum',        'int', 'NULL',     '', '', '',
2304       ],
2305       'primary_key' => 'ratedetailnum',
2306       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2307       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2308     },
2309
2310     'rate_region' => {
2311       'columns' => [
2312         'regionnum',   'serial',      '', '', '', '',
2313         'regionname',  'varchar',     '', $char_d, '', '',
2314       ],
2315       'primary_key' => 'regionnum',
2316       'unique'      => [],
2317       'index'       => [],
2318     },
2319
2320     'rate_prefix' => {
2321       'columns' => [
2322         'prefixnum',   'serial',      '', '', '', '',
2323         'regionnum',   'int',         '', '', '', '',
2324         'countrycode', 'varchar',     '',  3, '', '',
2325         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2326         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2327       ],
2328       'primary_key' => 'prefixnum',
2329       'unique'      => [],
2330       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2331     },
2332
2333     'rate_time' => {
2334       'columns' => [
2335         'ratetimenum', 'serial',      '',      '', '', '',
2336         'ratetimename',   'varchar',      '', $char_d, '', '',
2337       ],
2338       'primary_key' => 'ratetimenum',
2339       'unique'      => [],
2340       'index'       => [],
2341     },
2342
2343     'rate_time_interval' => {
2344       'columns' => [
2345         'intervalnum', 'serial', '', '', '', '',
2346         'stime',          'int', '', '', '', '',
2347         'etime',          'int', '', '', '', '',
2348         'ratetimenum',    'int', '', '', '', '',
2349       ],
2350       'primary_key' => 'intervalnum',
2351       'unique'      => [],
2352       'index'       => [],
2353     },
2354
2355     'usage_class' => {
2356       'columns' => [
2357         'classnum',    'serial',      '',      '', '', '',
2358         'weight',      'int',     'NULL',      '', '', '',
2359         'classname',   'varchar',     '', $char_d, '', '',
2360         'format',      'varchar', 'NULL', $char_d, '', '',
2361         'disabled',    'char',    'NULL',       1, '', '',
2362       ],
2363       'primary_key' => 'classnum',
2364       'unique' => [],
2365       'index' => [ ['disabled'] ],
2366     },
2367
2368     'reg_code' => {
2369       'columns' => [
2370         'codenum',   'serial',    '', '', '', '',
2371         'code',      'varchar',   '', $char_d, '', '',
2372         'agentnum',  'int',       '', '', '', '',
2373       ],
2374       'primary_key' => 'codenum',
2375       'unique'      => [ [ 'agentnum', 'code' ] ],
2376       'index'       => [ [ 'agentnum' ] ],
2377     },
2378
2379     'reg_code_pkg' => {
2380       'columns' => [
2381         'codepkgnum', 'serial', '', '', '', '',
2382         'codenum',   'int',    '', '', '', '',
2383         'pkgpart',   'int',    '', '', '', '',
2384       ],
2385       'primary_key' => 'codepkgnum',
2386       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2387       'index'       => [ [ 'codenum' ] ],
2388     },
2389
2390     'clientapi_session' => {
2391       'columns' => [
2392         'sessionnum',  'serial',  '', '', '', '',
2393         'sessionid',  'varchar',  '', $char_d, '', '',
2394         'namespace',  'varchar',  '', $char_d, '', '',
2395       ],
2396       'primary_key' => 'sessionnum',
2397       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2398       'index'       => [],
2399     },
2400
2401     'clientapi_session_field' => {
2402       'columns' => [
2403         'fieldnum',    'serial',     '', '', '', '',
2404         'sessionnum',     'int',     '', '', '', '',
2405         'fieldname',  'varchar',     '', $char_d, '', '',
2406         'fieldvalue',    'text', 'NULL', '', '', '',
2407       ],
2408       'primary_key' => 'fieldnum',
2409       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2410       'index'       => [],
2411     },
2412
2413     'payment_gateway' => {
2414       'columns' => [
2415         'gatewaynum',       'serial',   '',     '', '', '',
2416         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2417         'gateway_module',   'varchar',  '',     $char_d, '', '',
2418         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2419         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2420         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2421         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2422         'disabled',   'char',  'NULL',   1, '', '',
2423       ],
2424       'primary_key' => 'gatewaynum',
2425       'unique' => [],
2426       'index'  => [ [ 'disabled' ] ],
2427     },
2428
2429     'payment_gateway_option' => {
2430       'columns' => [
2431         'optionnum',   'serial',  '',     '', '', '',
2432         'gatewaynum',  'int',     '',     '', '', '',
2433         'optionname',  'varchar', '',     $char_d, '', '',
2434         'optionvalue', 'text',    'NULL', '', '', '',
2435       ],
2436       'primary_key' => 'optionnum',
2437       'unique'      => [],
2438       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2439     },
2440
2441     'agent_payment_gateway' => {
2442       'columns' => [
2443         'agentgatewaynum', 'serial', '', '', '', '',
2444         'agentnum',        'int', '', '', '', '',
2445         'gatewaynum',      'int', '', '', '', '',
2446         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2447         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2448       ],
2449       'primary_key' => 'agentgatewaynum',
2450       'unique'      => [],
2451       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2452     },
2453
2454     'banned_pay' => {
2455       'columns' => [
2456         'bannum',  'serial',   '',     '', '', '',
2457         'payby',   'char',     '',       4, '', '',
2458         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2459         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2460         '_date',   @date_type, '', '',
2461         'otaker',  'varchar',  'NULL',     32, '', '',
2462         'usernum',   'int', 'NULL', '', '', '',
2463         'reason',  'varchar',  'NULL', $char_d, '', '',
2464       ],
2465       'primary_key' => 'bannum',
2466       'unique'      => [ [ 'payby', 'payinfo' ] ],
2467       'index'       => [ [ 'usernum' ] ],
2468     },
2469
2470     'pkg_category' => {
2471       'columns' => [
2472         'categorynum',   'serial',  '', '', '', '',
2473         'categoryname',  'varchar', '', $char_d, '', '',
2474         'weight',         'int', 'NULL',  '', '', '',
2475         'condense',      'char', 'NULL',   1, '', '',
2476         'disabled',      'char', 'NULL',   1, '', '',
2477       ],
2478       'primary_key' => 'categorynum',
2479       'unique' => [],
2480       'index' => [ ['disabled'] ],
2481     },
2482
2483     'pkg_class' => {
2484       'columns' => [
2485         'classnum',    'serial',   '',      '', '', '',
2486         'classname',   'varchar',  '', $char_d, '', '',
2487         'categorynum', 'int',  'NULL',      '', '', '',
2488         'disabled',    'char', 'NULL',       1, '', '',
2489       ],
2490       'primary_key' => 'classnum',
2491       'unique' => [],
2492       'index' => [ ['disabled'] ],
2493     },
2494
2495     'cdr' => {
2496       'columns' => [
2497         # qw( name type null length default local );
2498
2499         ###
2500         #asterisk fields
2501         ###
2502
2503         'acctid',   'bigserial',  '', '', '', '',
2504         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2505         'calldate', 'timestamp',   '',      '', \'now()', '',
2506         'clid',        'varchar',  '', $char_d, \"''", '',
2507         'src',         'varchar',  '', $char_d, \"''", '',
2508         'dst',         'varchar',  '', $char_d, \"''", '',
2509         'dcontext',    'varchar',  '', $char_d, \"''", '',
2510         'channel',     'varchar',  '', $char_d, \"''", '',
2511         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2512         'lastapp',     'varchar',  '', $char_d, \"''", '',
2513         'lastdata',    'varchar',  '', $char_d, \"''", '',
2514
2515         #these don't seem to be logged by most of the SQL cdr_* modules
2516         #except tds under sql-illegal names, so;
2517         # ... don't rely on them for rating?
2518         # and, what they hey, i went ahead and changed the names and data types
2519         # to freeside-style dates...
2520           #'start',  'timestamp', 'NULL',  '',    '', '',
2521           #'answer', 'timestamp', 'NULL',  '',    '', '',
2522           #'end',    'timestamp', 'NULL',  '',    '', '',
2523         'startdate',  @date_type, '', '',
2524         'answerdate', @date_type, '', '',
2525         'enddate',    @date_type, '', '',
2526         #
2527
2528         'duration',    'int',      '',      '',     0, '',
2529         'billsec',     'int',      '',      '',     0, '',
2530         'disposition', 'varchar',  '',      45, \"''", '',
2531         'amaflags',    'int',      '',      '',     0, '',
2532         'accountcode', 'varchar',  '',      20, \"''", '',
2533         'uniqueid',    'varchar',  '',      32, \"''", '',
2534         'userfield',   'varchar',  '',     255, \"''", '',
2535
2536         'max_callers', 'int',  'NULL',      '',    '', '',
2537
2538         ###
2539         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2540         # defaults
2541         # though these are now used elsewhere:
2542         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
2543         ###
2544
2545         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2546         'cdrtypenum',              'int', 'NULL',      '', '', '',
2547
2548         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2549
2550         'upstream_currency',      'char', 'NULL',       3, '', '',
2551         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2552         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2553
2554         # how it was rated internally...
2555         'ratedetailnum',           'int', 'NULL',      '', '', '',
2556         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2557
2558         'distance',            'decimal', 'NULL',      '', '', '',
2559         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2560
2561         #cdr_calltype: the big list in appendix 2
2562         'calltypenum',             'int', 'NULL',      '', '', '',
2563
2564         'description',         'varchar', 'NULL', $char_d, '', '',
2565         'quantity',                'int', 'NULL',      '', '', '',
2566
2567         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2568         'carrierid',               'int', 'NULL',      '', '', '',
2569
2570         'upstream_rateid',         'int', 'NULL',      '', '', '',
2571
2572         ###
2573         #and now for our own fields
2574         ###
2575
2576         # a svcnum... right..?
2577         'svcnum',             'int',   'NULL',     '',   '', '',
2578
2579         #NULL, done (or something)
2580         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2581
2582         #NULL, done (or something)
2583         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2584
2585         #an indexed place to put big numbers
2586         'cdrid',         'bigint',     'NULL',     '',  '', '',
2587
2588         #for taqua accountcode rewriting, for starters
2589         'sessionnum',       'int',    'NULL',      '', '', '',
2590         'subscriber',   'varchar',    'NULL', $char_d, '', '',
2591
2592         #old
2593         'cdrbatch',     'varchar',    'NULL',     255, '', '',
2594         #new
2595         'cdrbatchnum',      'int',    'NULL',      '', '', '',
2596
2597       ],
2598       'primary_key' => 'acctid',
2599       'unique' => [],
2600       'index' => [ [ 'calldate' ],
2601                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2602                    [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2603                    [ 'sessionnum' ], [ 'subscriber' ],
2604                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2605                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2606                  ],
2607     },
2608
2609     'cdr_batch' => {
2610       'columns' => [
2611         'cdrbatchnum',   'serial',    '',   '', '', '',
2612         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2613         '_date',     @date_type, '', '',
2614       ],
2615       'primary_key' => 'cdrbatchnum',
2616       'unique' => [ [ 'cdrbatch' ] ],
2617       'index' => [],
2618     },
2619
2620     'cdr_termination' => {
2621       'columns' => [
2622         'cdrtermnum', 'bigserial',     '',      '', '', '',
2623         'acctid',        'bigint',     '',      '', '', '',
2624         'termpart',         'int',     '',      '', '', '',#future use see below
2625         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2626         'status',       'varchar', 'NULL',      32, '', '',
2627         'svcnum',           'int', 'NULL',      '', '', '',
2628       ],
2629       'primary_key' => 'cdrtermnum',
2630       'unique'      => [ [ 'acctid', 'termpart' ] ],
2631       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2632     },
2633
2634     #to handle multiple termination/settlement passes...
2635    # 'part_termination' => {
2636    #   'columns' => [
2637    #     'termpart',       'int', '',      '', '', '',
2638    #     'termname',   'varchar', '', $char_d, '', '',
2639    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2640    #   ],
2641    #   'primary_key' => 'termpart',
2642    #   'unique' => [],
2643    #   'index'  => [],
2644    # },
2645
2646     #the remaining cdr_ tables are not really used
2647     'cdr_calltype' => {
2648       'columns' => [
2649         'calltypenum',   'serial',  '', '', '', '',
2650         'calltypename',  'varchar', '', $char_d, '', '',
2651       ],
2652       'primary_key' => 'calltypenum',
2653       'unique'      => [],
2654       'index'       => [],
2655     },
2656
2657     'cdr_type' => {
2658       'columns' => [
2659         'cdrtypenum'  => 'serial',  '', '', '', '',
2660         'cdrtypename' => 'varchar', '', $char_d, '', '',
2661       ],
2662       'primary_key' => 'cdrtypenum',
2663       'unique'      => [],
2664       'index'       => [],
2665     },
2666
2667     'cdr_carrier' => {
2668       'columns' => [
2669         'carrierid'   => 'serial',  '', '', '', '',
2670         'carriername' => 'varchar', '', $char_d, '', '',
2671       ],
2672       'primary_key' => 'carrierid',
2673       'unique'      => [],
2674       'index'       => [],
2675     },
2676
2677     #'cdr_file' => {
2678     #  'columns' => [
2679     #    'filenum',    'serial',     '', '', '', '',
2680     #    'filename',  'varchar',     '', '', '', '',
2681     #    'status',    'varchar', 'NULL', '', '', '',
2682     #  ],
2683     #  'primary_key' => 'filenum',
2684     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2685     #                                   # agent-virtualize or have a customer
2686     #                                   # with dup-filename needs or something
2687     #                                   # (only used by cdr.http_and_import for
2688     #                                   #  chrissakes)
2689     #  'index'  => [],
2690     #},
2691
2692     'inventory_item' => {
2693       'columns' => [
2694         'itemnum',  'serial',      '',      '', '', '',
2695         'classnum', 'int',         '',      '', '', '',
2696         'agentnum', 'int',     'NULL',      '', '', '',
2697         'item',     'varchar',     '', $char_d, '', '',
2698         'svcnum',   'int',     'NULL',      '', '', '',
2699       ],
2700       'primary_key' => 'itemnum',
2701       'unique' => [ [ 'classnum', 'item' ] ],
2702       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
2703     },
2704
2705     'inventory_class' => {
2706       'columns' => [
2707         'classnum',  'serial',       '',      '', '', '',
2708         'classname', 'varchar',      '', $char_d, '', '',
2709       ],
2710       'primary_key' => 'classnum',
2711       'unique' => [],
2712       'index'  => [],
2713     },
2714
2715     'access_user' => {
2716       'columns' => [
2717         'usernum',   'serial',  '',      '', '', '',
2718         'username',  'varchar', '', $char_d, '', '',
2719         '_password', 'varchar', '', $char_d, '', '',
2720         'last',      'varchar', '', $char_d, '', '',
2721         'first',     'varchar', '', $char_d, '', '',
2722         'user_custnum',  'int', 'NULL',  '', '', '',
2723         'disabled',     'char', 'NULL',   1, '', '',
2724       ],
2725       'primary_key' => 'usernum',
2726       'unique' => [ [ 'username' ] ],
2727       'index'  => [ [ 'user_custnum' ] ],
2728     },
2729
2730     'access_user_pref' => {
2731       'columns' => [
2732         'prefnum',    'serial',       '', '', '', '',
2733         'usernum',     'int',       '', '', '', '',
2734         'prefname', 'varchar', '', $char_d, '', '',
2735         'prefvalue', 'text', 'NULL', '', '', '',
2736         'expiration', @date_type, '', '',
2737       ],
2738       'primary_key' => 'prefnum',
2739       'unique' => [],
2740       'index'  => [ [ 'usernum' ] ],
2741     },
2742
2743     'access_group' => {
2744       'columns' => [
2745         'groupnum',   'serial', '',      '', '', '',
2746         'groupname', 'varchar', '', $char_d, '', '',
2747       ],
2748       'primary_key' => 'groupnum',
2749       'unique' => [ [ 'groupname' ] ],
2750       'index'  => [],
2751     },
2752
2753     'access_usergroup' => {
2754       'columns' => [
2755         'usergroupnum', 'serial', '', '', '', '',
2756         'usernum',         'int', '', '', '', '',
2757         'groupnum',        'int', '', '', '', '',
2758       ],
2759       'primary_key' => 'usergroupnum',
2760       'unique' => [ [ 'usernum', 'groupnum' ] ],
2761       'index'  => [ [ 'usernum' ] ],
2762     },
2763
2764     'access_groupagent' => {
2765       'columns' => [
2766         'groupagentnum', 'serial', '', '', '', '',
2767         'groupnum',         'int', '', '', '', '',
2768         'agentnum',         'int', '', '', '', '',
2769       ],
2770       'primary_key' => 'groupagentnum',
2771       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2772       'index'  => [ [ 'groupnum' ] ],
2773     },
2774
2775     'access_right' => {
2776       'columns' => [
2777         'rightnum',   'serial', '',      '', '', '',
2778         'righttype', 'varchar', '', $char_d, '', '',
2779         'rightobjnum',   'int', '',      '', '', '',
2780         'rightname', 'varchar', '', $char_d, '', '',
2781       ],
2782       'primary_key' => 'rightnum',
2783       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2784       'index'  => [],
2785     },
2786
2787     'svc_phone' => {
2788       'columns' => [
2789         'svcnum',       'int',         '',      '', '', '',
2790         'countrycode',  'varchar',     '',       3, '', '',
2791         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2792         'pin',          'varchar', 'NULL', $char_d, '', '',
2793         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2794         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2795         'pbxsvc',           'int', 'NULL',      '', '', '',
2796         'domsvc',           'int', 'NULL',      '', '', '',
2797         'locationnum',      'int', 'NULL', '', '', '',
2798         'forwarddst',     'varchar',     'NULL',      15, '', '',
2799         'email',           'varchar', 'NULL',  255, '', '',
2800         'lnp_status',   'varchar', 'NULL', $char_d, '', '',
2801         'portable',     'char', 'NULL',       1,  '', '',
2802         'lrn',     'char',     'NULL',      10, '', '',
2803         'lnp_desired_due_date',     'int', 'NULL',       '', '', '',
2804         'lnp_due_date',     'int', 'NULL',       '', '', '',
2805         'lnp_other_provider', 'varchar', 'NULL', $char_d,  '', '',
2806         'lnp_other_provider_account', 'varchar', 'NULL', $char_d,  '', '',
2807         'lnp_reject_reason', 'varchar', 'NULL', $char_d,  '', '',
2808       ],
2809       'primary_key' => 'svcnum',
2810       'unique' => [],
2811       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
2812                     ['locationnum'],
2813                   ],
2814     },
2815
2816     'phone_device' => {
2817       'columns' => [
2818         'devicenum', 'serial',     '', '', '', '',
2819         'devicepart',   'int',     '', '', '', '',
2820         'svcnum',       'int',     '', '', '', '',
2821         'mac_addr', 'varchar', 'NULL', 12, '', '',
2822       ],
2823       'primary_key' => 'devicenum',
2824       'unique' => [ [ 'mac_addr' ], ],
2825       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
2826     },
2827
2828     'part_device' => {
2829       'columns' => [
2830         'devicepart', 'serial',  '',      '', '', '',
2831         'devicename', 'varchar', '', $char_d, '', '',
2832         'inventory_classnum', 'int', 'NULL', '', '', '',
2833       ],
2834       'primary_key' => 'devicepart',
2835       'unique' => [ [ 'devicename' ] ], #?
2836       'index'  => [],
2837     },
2838
2839     'phone_avail' => {
2840       'columns' => [
2841         'availnum',    'serial',      '',      '', '', '',
2842         'exportnum',   'int',         '',      '', '', '',
2843         'countrycode', 'varchar',     '',       3, '', '',
2844         'state',       'char',    'NULL',       2, '', '',
2845         'npa',         'char',        '',       3, '', '',
2846         'nxx',         'char',    'NULL',       3, '', '',
2847         'station',     'char',    'NULL',       4, '', '',
2848         'name',        'varchar', 'NULL', $char_d, '', '',
2849         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
2850         'latanum',      'int',     'NULL',      '', '', '',
2851         'msanum',       'int', 'NULL', '', '', '',
2852         'ordernum',      'int',     'NULL',      '', '', '',
2853         'svcnum',      'int',     'NULL',      '', '', '',
2854         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2855       ],
2856       'primary_key' => 'availnum',
2857       'unique' => [],
2858       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2859                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2860                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2861                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2862                     [ 'svcnum' ],
2863                     [ 'availbatch' ],
2864                   ],
2865     },
2866
2867     'lata' => {
2868       'columns' => [
2869         'latanum',    'int',      '',      '', '', '',
2870         'description',   'varchar',    '',      $char_d, '', '',
2871       ],
2872       'primary_key' => 'latanum',
2873       'unique' => [],
2874       'index'  => [],
2875     },
2876
2877     'msa' => {
2878       'columns' => [
2879         'msanum',    'int',      '',      '', '', '',
2880         'description',   'varchar',    '',      $char_d, '', '',
2881       ],
2882       'primary_key' => 'msanum',
2883       'unique' => [],
2884       'index'  => [],
2885     },
2886
2887     'rate_center' => {
2888       'columns' => [
2889         'ratecenternum',    'serial',      '',      '', '', '',
2890         'description',   'varchar',    '',      $char_d, '', '',
2891       ],
2892       'primary_key' => 'ratecenternum',
2893       'unique' => [],
2894       'index'  => [],
2895     },
2896
2897     'did_vendor' => {
2898       'columns' => [
2899         'vendornum',    'serial',      '',      '', '', '',
2900         'vendorname',   'varchar',        '',     $char_d, '', '',
2901       ],
2902       'primary_key' => 'vendornum',
2903       'unique' => [],
2904       'index'  => [],
2905     },
2906
2907     'did_order_item' => {
2908       'columns' => [
2909         'orderitemnum',    'serial',      '',      '', '', '',
2910         'ordernum',    'int',      '',      '', '', '',
2911         'msanum',      'int',     'NULL',      '', '', '',
2912         'npa',      'int',     'NULL',      '', '', '',
2913         'latanum',      'int',     'NULL',      '', '', '',
2914         'ratecenternum',      'int',     'NULL',      '', '', '',
2915         'state',       'char',    'NULL',       2, '', '',
2916         'quantity',      'int',     '',      '', '', '',
2917       ],
2918       'primary_key' => 'orderitemnum',
2919       'unique' => [],
2920       'index'  => [],
2921     },
2922
2923     'did_order' => {
2924       'columns' => [
2925         'ordernum',    'serial',      '',      '', '', '',
2926         'vendornum',   'int',       '',      '', '', '',
2927         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
2928         'custnum',   'int', 'NULL', '', '', '',
2929         'submitted',      'int',     '',      '', '', '',
2930         'confirmed',      'int',     'NULL',      '', '', '',
2931         'received',      'int',     'NULL',      '', '', '',
2932       ],
2933       'primary_key' => 'ordernum',
2934       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
2935       'index'  => [],
2936     },
2937
2938     'reason_type' => {
2939       'columns' => [
2940         'typenum',   'serial',  '', '', '', '',
2941         'class',     'char', '', 1, '', '',
2942         'type',     'varchar', '', $char_d, '', '',
2943       ],
2944       'primary_key' => 'typenum',
2945       'unique' => [],
2946       'index' => [],
2947     },
2948
2949     'reason' => {
2950       'columns' => [
2951         'reasonnum',     'serial',  '', '', '', '',
2952         'reason_type',   'int',  '', '', '', '',
2953         'reason',        'text', '', '', '', '',
2954         'disabled',      'char',    'NULL', 1, '', '',
2955       ],
2956       'primary_key' => 'reasonnum',
2957       'unique' => [],
2958       'index' => [],
2959     },
2960
2961     'conf' => {
2962       'columns' => [
2963         'confnum',  'serial',  '', '', '', '',
2964         'agentnum', 'int',  'NULL', '', '', '',
2965         'name',     'varchar', '', $char_d, '', '',
2966         'value',    'text', 'NULL', '', '', '',
2967       ],
2968       'primary_key' => 'confnum',
2969       'unique' => [ [ 'agentnum', 'name' ]],
2970       'index' => [],
2971     },
2972
2973     'pkg_referral' => {
2974       'columns' => [
2975         'pkgrefnum',     'serial', '', '', '', '',
2976         'pkgnum',        'int',    '', '', '', '',
2977         'refnum',        'int',    '', '', '', '',
2978       ],
2979       'primary_key' => 'pkgrefnum',
2980       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2981       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2982     },
2983
2984     'svc_pbx' => {
2985       'columns' => [
2986         'svcnum',           'int',     '',      '', '', '',
2987         'id',               'int', 'NULL',      '', '', '',
2988         'title',        'varchar', 'NULL', $char_d, '', '',
2989         'max_extensions',   'int', 'NULL',      '', '', '',
2990         'max_simultaneous', 'int', 'NULL',      '', '', '',
2991       ],
2992       'primary_key' => 'svcnum',
2993       'unique' => [],
2994       'index'  => [ [ 'id' ] ],
2995     },
2996
2997     'svc_mailinglist' => { #svc_group?
2998       'columns' => [
2999         'svcnum',            'int',     '',            '', '', '',
3000         'username',      'varchar',     '', $username_len, '', '',
3001         'domsvc',            'int',     '',            '', '', '',
3002         'listnum',           'int',     '',            '', '', '',
3003         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
3004         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
3005         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
3006         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
3007       ],
3008       'primary_key' => 'svcnum',
3009       'unique' => [],
3010       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
3011     },
3012
3013     'mailinglist' => {
3014       'columns' => [
3015         'listnum',   'serial', '',      '', '', '',
3016         'listname', 'varchar', '', $char_d, '', '',
3017       ],
3018       'primary_key' => 'listnum',
3019       'unique' => [],
3020       'index'  => [],
3021     },
3022
3023     'mailinglistmember' => {
3024       'columns' => [
3025         'membernum',        'serial',     '',   '', '', '',
3026         'listnum',             'int',     '',   '', '', '',
3027         'svcnum',              'int', 'NULL',   '', '', '',
3028         'contactemailnum',     'int', 'NULL',   '', '', '',
3029         'email',           'varchar', 'NULL',  255, '', '',
3030       ],
3031       'primary_key' => 'membernum',
3032       'unique'      => [],
3033       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
3034     },
3035
3036     'bill_batch' => {
3037       'columns' => [
3038         'batchnum',         'serial',     '', '', '', '',
3039         'status',             'char', 'NULL','1', '', '',
3040         'pdf',                'blob', 'NULL', '', '', '',
3041       ],
3042       'primary_key' => 'batchnum',
3043       'unique'      => [],
3044       'index'       => [],
3045     },
3046
3047     'cust_bill_batch' => {
3048       'columns' => [
3049         'billbatchnum',     'serial',     '', '', '', '',
3050         'batchnum',            'int',     '', '', '', '',
3051         'invnum',              'int',     '', '', '', '',
3052       ],
3053       'primary_key' => 'billbatchnum',
3054       'unique'      => [],
3055       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
3056     },
3057
3058     'cust_bill_batch_option' => {
3059       'columns' => [
3060         'optionnum', 'serial', '', '', '', '',
3061         'billbatchnum', 'int', '', '', '', '',
3062         'optionname', 'varchar', '', $char_d, '', '',
3063         'optionvalue', 'text', 'NULL', '', '', '',
3064       ],
3065       'primary_key' => 'optionnum',
3066       'unique'      => [],
3067       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
3068     },
3069
3070     'msg_template' => {
3071       'columns' => [
3072         'msgnum',     'serial',     '',      '', '', '',
3073         'msgname',   'varchar',     '', $char_d, '', '',
3074         'agentnum',      'int', 'NULL',      '', '', '',
3075         'subject',   'varchar', 'NULL',     512, '', '',
3076         'mime_type', 'varchar',     '', $char_d, '', '',
3077         'body',         'blob', 'NULL',      '', '', '',
3078         'disabled',     'char', 'NULL',       1, '', '',
3079         'from_addr', 'varchar', 'NULL',     255, '', '',
3080         'bcc_addr',  'varchar', 'NULL',     255, '', '',
3081       ],
3082       'primary_key' => 'msgnum',
3083       'unique'      => [ ['msgname', 'mime_type'] ],
3084       'index'       => [ ['agentnum'], ]
3085     },
3086
3087     'svc_cert' => {
3088       'columns' => [
3089         'svcnum',                'int',     '',      '', '', '',
3090         'recnum',                'int', 'NULL',      '', '', '',
3091         'privatekey',           'text', 'NULL',      '', '', '',
3092         'csr',                  'text', 'NULL',      '', '', '',
3093         'certificate',          'text', 'NULL',      '', '', '',
3094         'cacert',               'text', 'NULL',      '', '', '',
3095         'common_name',       'varchar', 'NULL', $char_d, '', '',
3096         'organization',      'varchar', 'NULL', $char_d, '', '',
3097         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
3098         'city',              'varchar', 'NULL', $char_d, '', '',
3099         'state',             'varchar', 'NULL', $char_d, '', '',
3100         'country',              'char', 'NULL',       2, '', '',
3101         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
3102       ],
3103       'primary_key' => 'svcnum',
3104       'unique' => [],
3105       'index'  => [], #recnum
3106     },
3107
3108     'areacode'  => {
3109       'columns' => [
3110       'areanum',   'serial',        '',      '', '', '',
3111       'code',        'char',        '',       3, '', '',
3112       'country',     'char',    'NULL',       2, '', '',
3113       'state',       'char',    'NULL',       2, '', '',
3114       'description','varchar',  'NULL',     255, '', '',
3115       ],
3116       'primary_key' => 'areanum',
3117       'unique' => [ [ 'code' ] ],
3118       'index'  => [],
3119     },
3120
3121     'nms_device' => {
3122       'columns' => [
3123         'nms_devicenum', 'serial',     '',      '', '', '',
3124         #'agentnum',         'int', 'NULL',      '', '', '',
3125         'devicename',   'varchar',     '', $char_d, '', '',
3126         'ip',           'varchar',     '',      15, '', '',
3127         'protocol',     'varchar',     '', $char_d, '', '',
3128 #        'last',     'int',     '',    '', '', '',
3129       ],
3130       'primary_key' => 'nms_devicenum',
3131       'unique' => [],
3132       'index'  => [],
3133     },
3134
3135     'nms_deviceport' => {
3136       'columns' => [
3137         'portnum',       'serial',     '', '', '', '',
3138         'nms_devicenum',    'int',     '', '', '', '',
3139         'deviceport',       'int',     '', '', '', '',
3140         #'ip',       'varchar', 'NULL', 15, '', '',
3141         'svcnum',           'int', 'NULL', '', '', '',
3142       ],
3143       'primary_key' => 'portnum',
3144       'unique'      => [ [ 'nms_devicenum', 'deviceport' ] ],
3145       'index'       => [ [ 'svcnum' ] ],
3146     },
3147
3148     'svc_port' => {
3149       'columns' => [
3150         'svcnum',                'int',     '',      '', '', '',
3151       ],
3152       'primary_key' => 'svcnum',
3153       'unique' => [],
3154       'index'  => [], #recnum
3155     },
3156
3157
3158     # name type nullability length default local
3159
3160     #'new_table' => {
3161     #  'columns' => [
3162     #    'num', 'serial',       '', '', '', '',
3163     #  ],
3164     #  'primary_key' => 'num',
3165     #  'unique' => [],
3166     #  'index'  => [],
3167     #},
3168
3169   };
3170
3171 }
3172
3173 =back
3174
3175 =head1 BUGS
3176
3177 =head1 SEE ALSO
3178
3179 L<DBIx::DBSchema>
3180
3181 =cut
3182
3183 1;
3184