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