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