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