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