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_exemption' => {
 792       'columns' => [
 793         'exemptionnum', 'serial', '',      '', '', '',
 794         'custnum',         'int', '',      '', '', '',
 795         'taxname',     'varchar', '', $char_d, '', '',
 796         #start/end dates?  for reporting?
 797       ],
 798       'primary_key' => 'exemptionnum',
 799       'unique'      => [],
 800       'index'       => [ [ 'custnum' ] ],
 801     },
 802
 803     'cust_main_county' => { #county+state+country are checked off the
 804                             #cust_main_county for validation and to provide
 805                             # a tax rate.
 806       'columns' => [
 807         'taxnum',   'serial',   '',    '', '', '',
 808         'state',    'varchar',  'NULL',    $char_d, '', '',
 809         'county',   'varchar',  'NULL',    $char_d, '', '',
 810         'country',  'char',  '', 2, '', '',
 811         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 812         'exempt_amount', @money_type, '', '',
 813         'tax',      'real',  '',    '', '', '', #tax %
 814         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 815         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 816         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 817       ],
 818       'primary_key' => 'taxnum',
 819       'unique' => [],
 820   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 821       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
 822                    [ 'taxclass' ],
 823                  ],
 824     },
 825
 826     'tax_rate'    => {
 827       'columns' => [
 828         'taxnum',       'serial',     '',      '', '', '',
 829         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 830         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 831         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 832         'taxclassnum', 'int',      '',      '', '', '',
 833         'effective_date', @date_type, '', '',
 834         'tax',        @taxrate_type,      '', '',        # tax %
 835         'excessrate', @taxrate_typen,     '', '',        # second tax %
 836         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 837         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 838         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
 839         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
 840         'unittype',    'int',  'NULL', '', '', '',      # for fee
 841         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
 842         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
 843         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
 844         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
 845         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 846         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 847         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 848         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 849         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 850         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 851         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 852         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 853         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 854         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
 855       ],
 856       'primary_key' => 'taxnum',
 857       'unique' => [],
 858       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 859     },
 860
 861     'tax_rate_location' => {
 862       'columns' => [
 863         'taxratelocationnum', 'serial',  '',     '', '', '',
 864         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
 865         'geocode',            'varchar', '',     20,      '', '',
 866         'city',               'varchar', 'NULL', $char_d, '', '',
 867         'county',             'varchar', 'NULL', $char_d, '', '',
 868         'state',              'char',    'NULL',       2, '', '',
 869         'disabled',           'char',    'NULL', 1, '', '',
 870       ],
 871       'primary_key' => 'taxratelocationnum',
 872       'unique' => [],
 873       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
 874     },
 875
 876     'cust_tax_location' => {
 877       'columns' => [
 878         'custlocationnum', 'serial',  '',     '', '', '',
 879         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 880         'city',            'varchar', 'NULL', $char_d, '', '',
 881         'postalcity',      'varchar', 'NULL', $char_d, '', '',
 882         'county',          'varchar', 'NULL', $char_d, '', '',
 883         'zip',             'char',    '',     5,  '', '',
 884         'state',           'char',    '',     2,  '', '',
 885         'plus4hi',         'char',    'NULL', 4,  '', '',
 886         'plus4lo',         'char',    'NULL', 4,  '', '',
 887         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 888         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
 889         'geocode',         'varchar', '',    20,  '', '',
 890       ],
 891       'primary_key' => 'custlocationnum',
 892       'unique' => [],
 893       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 894     },
 895
 896     'tax_class' => {
 897       'columns' => [
 898         'taxclassnum',  'serial',  '',            '', '', '',
 899         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
 900         'taxclass',     'varchar', '',       $char_d, '', '',
 901         'description',  'varchar', '',     2*$char_d, '', '',
 902       ],
 903       'primary_key' => 'taxclassnum',
 904       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
 905       'index' => [],
 906     },
 907
 908     'cust_pay_pending' => {
 909       'columns' => [
 910         'paypendingnum','serial',      '',  '', '', '',
 911         'custnum',      'int',         '',  '', '', '',
 912         'paid',         @money_type,            '', '',
 913         '_date',        @date_type,             '', '',
 914         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
 915                                                         # be index into payby
 916                                                         # table eventually
 917         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
 918         'paymask',      'varchar', 'NULL', $char_d, '', '',
 919         'paydate',      'varchar', 'NULL', 10, '', '',
 920         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
 921         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
 922         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 923
 924         'status',       'varchar',     '', $char_d, '', '',
 925         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
 926         'statustext',   'text',    'NULL',  '', '', '',
 927         'gatewaynum',   'int',     'NULL',  '', '', '',
 928         #'cust_balance', @money_type,            '', '',
 929         'paynum',       'int',     'NULL',  '', '', '',
 930         'jobnum',       'int',     'NULL',  '', '', '',
 931       ],
 932       'primary_key' => 'paypendingnum',
 933       'unique'      => [ [ 'payunique' ] ],
 934       'index'       => [ [ 'custnum' ], [ 'status' ], ],
 935     },
 936
 937     'cust_pay' => {
 938       'columns' => [
 939         'paynum',   'serial',    '',   '', '', '',
 940         'custnum',  'int',    '',   '', '', '',
 941         '_date',    @date_type, '', '',
 942         'paid',     @money_type, '', '',
 943         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
 944         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 945                                                  # index into payby table
 946                                                  # eventually
 947         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 948         'paymask', 'varchar', 'NULL', $char_d, '', '',
 949         'paydate',  'varchar', 'NULL', 10, '', '',
 950         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 951         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 952         'closed',    'char', 'NULL', 1, '', '',
 953       ],
 954       'primary_key' => 'paynum',
 955       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
 956       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 957     },
 958
 959     'cust_pay_void' => {
 960       'columns' => [
 961         'paynum',    'int',    '',   '', '', '',
 962         'custnum',   'int',    '',   '', '', '',
 963         'paid',      @money_type, '', '',
 964         '_date',     @date_type, '', '',
 965         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 966                                                   # index into payby table
 967                                                   # eventually
 968         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 969         'paymask', 'varchar', 'NULL', $char_d, '', '',
 970         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 971         'closed',    'char', 'NULL', 1, '', '',
 972         'void_date', @date_type, '', '',
 973         'reason',    'varchar',   'NULL', $char_d, '', '',
 974         'otaker',   'varchar', '', 32, '', '',
 975       ],
 976       'primary_key' => 'paynum',
 977       'unique' => [],
 978       'index' => [ [ 'custnum' ] ],
 979     },
 980
 981     'cust_bill_pay' => {
 982       'columns' => [
 983         'billpaynum', 'serial',     '',   '', '', '',
 984         'invnum',  'int',     '',   '', '', '',
 985         'paynum',  'int',     '',   '', '', '',
 986         'amount',  @money_type, '', '',
 987         '_date',   @date_type, '', '',
 988       ],
 989       'primary_key' => 'billpaynum',
 990       'unique' => [],
 991       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 992     },
 993
 994     'cust_bill_pay_batch' => {
 995       'columns' => [
 996         'billpaynum', 'serial',     '',   '', '', '',
 997         'invnum',  'int',     '',   '', '', '',
 998         'paybatchnum',  'int',     '',   '', '', '',
 999         'amount',  @money_type, '', '',
1000         '_date',   @date_type, '', '',
1001       ],
1002       'primary_key' => 'billpaynum',
1003       'unique' => [],
1004       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1005     },
1006
1007     'cust_bill_pay_pkg' => {
1008       'columns' => [
1009         'billpaypkgnum', 'serial', '', '', '', '',
1010         'billpaynum',       'int', '', '', '', '',
1011         'billpkgnum',       'int', '', '', '', '',
1012         'amount',         @money_type,     '', '',
1013         'setuprecur',      'varchar', '', $char_d, '', '',
1014         'sdate',   @date_type, '', '',
1015         'edate',   @date_type, '', '',
1016       ],
1017       'primary_key' => 'billpaypkgnum',
1018       'unique'      => [],
1019       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1020     },
1021
1022     'pay_batch' => { #batches of payments to an external processor
1023       'columns' => [
1024         'batchnum',   'serial',    '',   '', '', '',
1025         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1026         'status',     'char', 'NULL',     1, '', '',
1027         'download',   @date_type, '', '',
1028         'upload',     @date_type, '', '',
1029       ],
1030       'primary_key' => 'batchnum',
1031       'unique' => [],
1032       'index' => [],
1033     },
1034
1035     'cust_pay_batch' => { #what's this used for again?  list of customers
1036                           #in current CARD batch? (necessarily CARD?)
1037       'columns' => [
1038         'paybatchnum',   'serial',    '',   '', '', '',
1039         'batchnum',   'int',    '',   '', '', '',
1040         'invnum',   'int',    '',   '', '', '',
1041         'custnum',   'int',    '',   '', '', '',
1042         'last',     'varchar', '',     $char_d, '', '',
1043         'first',    'varchar', '',     $char_d, '', '',
1044         'address1', 'varchar', '',     $char_d, '', '',
1045         'address2', 'varchar', 'NULL', $char_d, '', '',
1046         'city',     'varchar', '',     $char_d, '', '',
1047         'state',    'varchar', 'NULL', $char_d, '', '',
1048         'zip',      'varchar', 'NULL', 10, '', '',
1049         'country',  'char', '',     2, '', '',
1050         #        'trancode', 'int', '', '', '', ''
1051         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1052         'payinfo',  'varchar', '',     512, '', '',
1053         #'exp',      @date_type, '', ''
1054         'exp',      'varchar', 'NULL',     11, '', '',
1055         'payname',  'varchar', 'NULL', $char_d, '', '',
1056         'amount',   @money_type, '', '',
1057         'status',   'varchar', 'NULL',     $char_d, '', '',
1058       ],
1059       'primary_key' => 'paybatchnum',
1060       'unique' => [],
1061       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1062     },
1063
1064     'cust_pkg' => {
1065       'columns' => [
1066         'pkgnum',           'serial',     '', '', '', '',
1067         'custnum',             'int',     '', '', '', '',
1068         'pkgpart',             'int',     '', '', '', '',
1069         'locationnum',         'int', 'NULL', '', '', '',
1070         'otaker',          'varchar',     '', 32, '', '',
1071         'setup',          @date_type,             '', '',
1072         'bill',           @date_type,             '', '',
1073         'last_bill',      @date_type,             '', '',
1074         'susp',           @date_type,             '', '',
1075         'adjourn',        @date_type,             '', '',
1076         'cancel',         @date_type,             '', '',
1077         'expire',         @date_type,             '', '',
1078         'change_date',    @date_type,             '', '',
1079         'change_pkgnum',       'int', 'NULL', '', '', '',
1080         'change_pkgpart',      'int', 'NULL', '', '', '',
1081         'change_locationnum',  'int', 'NULL', '', '', '',
1082         'manual_flag',        'char', 'NULL',  1, '', '',
1083         'quantity',            'int', 'NULL', '', '', '',
1084       ],
1085       'primary_key' => 'pkgnum',
1086       'unique' => [],
1087       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1088                    ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
1089                    ['expire'], ['cancel'],
1090                    ['change_date'],
1091                  ],
1092     },
1093
1094     'cust_pkg_option' => {
1095       'columns' => [
1096         'optionnum', 'serial', '', '', '', '',
1097         'pkgnum', 'int', '', '', '', '',
1098         'optionname', 'varchar', '', $char_d, '', '',
1099         'optionvalue', 'text', 'NULL', '', '', '',
1100       ],
1101       'primary_key' => 'optionnum',
1102       'unique'      => [],
1103       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1104     },
1105
1106     'cust_pkg_detail' => {
1107       'columns' => [
1108         'pkgdetailnum', 'serial', '',      '', '', '',
1109         'pkgnum',          'int', '',      '', '', '',
1110         'detail',      'varchar', '', $char_d, '', '',
1111         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1112         'weight',          'int', '',      '', '', '',
1113       ],
1114       'primary_key' => 'pkgdetailnum',
1115       'unique' => [],
1116       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1117     },
1118
1119     'cust_pkg_reason' => {
1120       'columns' => [
1121         'num',      'serial',    '',   '', '', '',
1122         'pkgnum',   'int',    '',   '', '', '',
1123         'reasonnum','int',    '',   '', '', '',
1124         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1125         'otaker',   'varchar', '', 32, '', '',
1126         'date',     @date_type, '', '',
1127       ],
1128       'primary_key' => 'num',
1129       'unique' => [],
1130       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1131     },
1132
1133     'cust_refund' => {
1134       'columns' => [
1135         'refundnum',    'serial',    '',   '', '', '',
1136         'custnum',  'int',    '',   '', '', '',
1137         '_date',        @date_type, '', '',
1138         'refund',       @money_type, '', '',
1139         'otaker',       'varchar',   '',   32, '', '',
1140         'reason',       'varchar',   '',   $char_d, '', '',
1141         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1142                                                      # be index into payby
1143                                                      # table eventually
1144         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1145         'paymask', 'varchar', 'NULL', $char_d, '', '',
1146         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1147         'closed',    'char', 'NULL', 1, '', '',
1148       ],
1149       'primary_key' => 'refundnum',
1150       'unique' => [],
1151       'index' => [ ['custnum'], ['_date'] ],
1152     },
1153
1154     'cust_credit_refund' => {
1155       'columns' => [
1156         'creditrefundnum', 'serial',     '',   '', '', '',
1157         'crednum',  'int',     '',   '', '', '',
1158         'refundnum',  'int',     '',   '', '', '',
1159         'amount',  @money_type, '', '',
1160         '_date',   @date_type, '', '',
1161       ],
1162       'primary_key' => 'creditrefundnum',
1163       'unique' => [],
1164       'index' => [ ['crednum'], ['refundnum'] ],
1165     },
1166
1167
1168     'cust_svc' => {
1169       'columns' => [
1170         'svcnum',    'serial',    '',   '', '', '',
1171         'pkgnum',    'int',    'NULL',   '', '', '',
1172         'svcpart',   'int',    '',   '', '', '',
1173         'overlimit', @date_type, '', '',
1174       ],
1175       'primary_key' => 'svcnum',
1176       'unique' => [],
1177       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1178     },
1179
1180     'cust_svc_option' => {
1181       'columns' => [
1182         'optionnum',   'serial', '', '', '', '',
1183         'svcnum',      'int', '', '', '', '',
1184         'optionname',  'varchar', '', $char_d, '', '',
1185         'optionvalue', 'text', 'NULL', '', '', '',
1186       ],
1187       'primary_key' => 'optionnum',
1188       'unique'      => [],
1189       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1190     },
1191
1192     'part_pkg' => {
1193       'columns' => [
1194         'pkgpart',       'serial',    '',   '', '', '',
1195         'pkg',           'varchar',   '',   $char_d, '', '',
1196         'comment',       'varchar',   '',   $char_d, '', '',
1197         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1198         'setup',         @perl_type, '', '',
1199         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1200         'recur',         @perl_type, '', '',
1201         'setuptax',      'char', 'NULL', 1, '', '',
1202         'recurtax',      'char', 'NULL', 1, '', '',
1203         'plan',          'varchar', 'NULL', $char_d, '', '',
1204         'plandata',      'text', 'NULL', '', '', '',
1205         'disabled',      'char', 'NULL', 1, '', '',
1206         'custom',        'char', 'NULL', 1, '', '',
1207         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1208         'classnum',      'int',     'NULL', '', '', '',
1209         'taxproductnum', 'int',     'NULL', '', '', '',
1210         'setup_cost',    @money_typen,          '', '',
1211         'recur_cost',    @money_typen,          '', '',
1212         'pay_weight',    'real',    'NULL', '', '', '',
1213         'credit_weight', 'real',    'NULL', '', '', '',
1214         'agentnum',      'int',     'NULL', '', '', '',
1215
1216       ],
1217       'primary_key' => 'pkgpart',
1218       'unique' => [],
1219       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1220     },
1221
1222     'part_pkg_link' => {
1223       'columns' => [
1224         'pkglinknum',  'serial',  '',      '', '', '',
1225         'src_pkgpart', 'int',     '',      '', '', '',
1226         'dst_pkgpart', 'int',     '',      '', '', '',
1227         'link_type',   'varchar', '', $char_d, '', '',
1228       ],
1229       'primary_key' => 'pkglinknum',
1230       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1231       'index'  => [ [ 'src_pkgpart' ] ],
1232     },
1233
1234     'part_pkg_taxclass' => {
1235       'columns' => [
1236         'taxclassnum',  'serial', '',       '', '', '',
1237         'taxclass',     'varchar', '', $char_d, '', '',
1238       ],
1239       'primary_key' => 'taxclassnum',
1240       'unique'      => [ [ 'taxclass' ] ],
1241       'index'       => [],
1242     },
1243
1244     'part_pkg_taxproduct' => {
1245       'columns' => [
1246         'taxproductnum', 'serial',      '',        '', '', '',
1247         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1248         'taxproduct',    'varchar',     '',   $char_d, '', '',
1249         'description',   'varchar',     '', 3*$char_d, '', '',
1250       ],
1251       'primary_key' => 'taxproductnum',
1252       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1253       'index'       => [],
1254     },
1255
1256     'part_pkg_taxrate' => {
1257       'columns' => [
1258         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1259         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1260         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1261         'taxproductnum', 'int',  '',     '',       '', '',
1262         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1263         'county',           'varchar', 'NULL', $char_d, '', '',
1264         'state',            'varchar', 'NULL', $char_d, '', '',
1265         'local',            'varchar', 'NULL', $char_d, '', '',
1266         'country',          'char',    'NULL', 2,       '', '',
1267         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1268         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1269         'taxclassnum',      'int',     'NULL', '',      '', '',
1270         'effdate',          @date_type, '', '',
1271         'taxable',          'char',    'NULL', 1,       '', '',
1272       ],
1273       'primary_key' => 'pkgtaxratenum',
1274       'unique' => [],
1275       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1276     },
1277
1278     'part_pkg_taxoverride' => {
1279       'columns' => [
1280         'taxoverridenum', 'serial', '', '', '', '',
1281         'pkgpart',        'serial', '', '', '', '',
1282         'taxclassnum',    'serial', '', '', '', '',
1283         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1284       ],
1285       'primary_key' => 'taxoverridenum',
1286       'unique' => [],
1287       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1288     },
1289
1290 #    'part_title' => {
1291 #      'columns' => [
1292 #        'titlenum',   'int',    '',   '',
1293 #        'title',      'varchar',   '',   $char_d,
1294 #      ],
1295 #      'primary_key' => 'titlenum',
1296 #      'unique' => [ [] ],
1297 #      'index' => [ [] ],
1298 #    },
1299
1300     'pkg_svc' => {
1301       'columns' => [
1302         'pkgsvcnum',  'serial', '',  '', '', '',
1303         'pkgpart',    'int',    '',   '', '', '',
1304         'svcpart',    'int',    '',   '', '', '',
1305         'quantity',   'int',    '',   '', '', '',
1306         'primary_svc','char', 'NULL',  1, '', '',
1307       ],
1308       'primary_key' => 'pkgsvcnum',
1309       'unique' => [ ['pkgpart', 'svcpart'] ],
1310       'index' => [ ['pkgpart'], ['quantity'] ],
1311     },
1312
1313     'part_referral' => {
1314       'columns' => [
1315         'refnum',   'serial',     '',        '', '', '',
1316         'referral', 'varchar',    '',   $char_d, '', '',
1317         'disabled', 'char',   'NULL',         1, '', '',
1318         'agentnum', 'int',    'NULL',        '', '', '',
1319       ],
1320       'primary_key' => 'refnum',
1321       'unique' => [],
1322       'index' => [ ['disabled'], ['agentnum'], ],
1323     },
1324
1325     'part_svc' => {
1326       'columns' => [
1327         'svcpart',    'serial',    '',   '', '', '',
1328         'svc',        'varchar',   '',   $char_d, '', '',
1329         'svcdb',      'varchar',   '',   $char_d, '', '',
1330         'disabled',   'char',  'NULL',   1, '', '',
1331       ],
1332       'primary_key' => 'svcpart',
1333       'unique' => [],
1334       'index' => [ [ 'disabled' ] ],
1335     },
1336
1337     'part_svc_column' => {
1338       'columns' => [
1339         'columnnum',   'serial',         '', '', '', '',
1340         'svcpart',     'int',         '', '', '', '',
1341         'columnname',  'varchar',     '', 64, '', '',
1342         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1343         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1344         'columnflag',  'char',    'NULL', 1, '', '',
1345       ],
1346       'primary_key' => 'columnnum',
1347       'unique' => [ [ 'svcpart', 'columnname' ] ],
1348       'index' => [ [ 'svcpart' ] ],
1349     },
1350
1351     #(this should be renamed to part_pop)
1352     'svc_acct_pop' => {
1353       'columns' => [
1354         'popnum',    'serial',    '',   '', '', '',
1355         'city',      'varchar',   '',   $char_d, '', '',
1356         'state',     'varchar',   '',   $char_d, '', '',
1357         'ac',        'char',   '',   3, '', '',
1358         'exch',      'char',   '',   3, '', '',
1359         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1360       ],
1361       'primary_key' => 'popnum',
1362       'unique' => [],
1363       'index' => [ [ 'state' ] ],
1364     },
1365
1366     'part_pop_local' => {
1367       'columns' => [
1368         'localnum',  'serial',     '',     '', '', '',
1369         'popnum',    'int',     '',     '', '', '',
1370         'city',      'varchar', 'NULL', $char_d, '', '',
1371         'state',     'char',    'NULL', 2, '', '',
1372         'npa',       'char',    '',     3, '', '',
1373         'nxx',       'char',    '',     3, '', '',
1374       ],
1375       'primary_key' => 'localnum',
1376       'unique' => [],
1377       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1378     },
1379
1380     'svc_acct' => {
1381       'columns' => [
1382         'svcnum',    'int',    '',   '', '', '',
1383         'username',  'varchar',   '',   $username_len, '', '',
1384         '_password', 'varchar',   '',  512, '', '',
1385         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1386         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1387         'popnum',    'int',    'NULL',   '', '', '',
1388         'uid',       'int', 'NULL',   '', '', '',
1389         'gid',       'int', 'NULL',   '', '', '',
1390         'finger',    'varchar',   'NULL',   $char_d, '', '',
1391         'dir',       'varchar',   'NULL',   $char_d, '', '',
1392         'shell',     'varchar',   'NULL',   $char_d, '', '',
1393         'quota',     'varchar',   'NULL',   $char_d, '', '',
1394         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1395         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1396         'seconds_threshold',   'int', 'NULL',   '', '', '',
1397         'upbytes',   'bigint', 'NULL',   '', '', '',
1398         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1399         'downbytes', 'bigint', 'NULL',   '', '', '',
1400         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1401         'totalbytes','bigint', 'NULL',   '', '', '',
1402         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1403         'domsvc',    'int', '',   '', '', '',
1404         'last_login',  @date_type, '', '',
1405         'last_logout', @date_type, '', '',
1406       ],
1407       'primary_key' => 'svcnum',
1408       #'unique' => [ [ 'username', 'domsvc' ] ],
1409       'unique' => [],
1410       'index' => [ ['username'], ['domsvc'] ],
1411     },
1412
1413     'acct_rt_transaction' => {
1414       'columns' => [
1415         'svcrtid',   'int',    '',   '', '', '',
1416         'svcnum',    'int',    '',   '', '', '',
1417         'transaction_id',       'int', '',   '', '', '',
1418         '_date',   @date_type, '', '',
1419         'seconds',   'int', '',   '', '', '', #uhhhh
1420         'support',   'int', '',   '', '', '',
1421       ],
1422       'primary_key' => 'svcrtid',
1423       'unique' => [],
1424       'index' => [ ['svcnum', 'transaction_id'] ],
1425     },
1426
1427     #'svc_charge' => {
1428     #  'columns' => [
1429     #    'svcnum',    'int',    '',   '',
1430     #    'amount',    @money_type,
1431     #  ],
1432     #  'primary_key' => 'svcnum',
1433     #  'unique' => [ [] ],
1434     #  'index' => [ [] ],
1435     #},
1436
1437     'svc_domain' => {
1438       'columns' => [
1439         'svcnum',           'int',    '',        '', '', '',
1440         'domain',       'varchar',    '',   $char_d, '', '',
1441         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1442         'catchall',         'int', 'NULL',       '', '', '',
1443         'parent_svcnum',    'int', 'NULL',       '', '', '',
1444         'registrarnum',     'int', 'NULL',       '', '', '',
1445         'registrarkey', 'varchar', 'NULL',      512, '', '',
1446         'setup_date',  @date_type, '', '',
1447         'renewal_interval', 'int', 'NULL',       '', '', '',
1448         'expiration_date', @date_type, '', '',
1449       ],
1450       'primary_key' => 'svcnum',
1451       'unique' => [ ],
1452       'index' => [ ['domain'] ],
1453     },
1454
1455     'domain_record' => {
1456       'columns' => [
1457         'recnum',    'serial',     '',  '', '', '',
1458         'svcnum',    'int',     '',  '', '', '',
1459         'reczone',   'varchar', '',  255, '', '',
1460         'recaf',     'char',    '',  2, '', '',
1461         'rectype',   'varchar',    '',  5, '', '',
1462         'recdata',   'varchar', '',  255, '', '',
1463       ],
1464       'primary_key' => 'recnum',
1465       'unique'      => [],
1466       'index'       => [ ['svcnum'] ],
1467     },
1468
1469     'registrar' => {
1470       'columns' => [
1471         'registrarnum',   'serial', '',      '', '', '',
1472         'registrarname', 'varchar', '', $char_d, '', '',
1473       ],
1474       'primary_key' => 'registrarnum',
1475       'unique'      => [],
1476       'index'       => [],
1477     },
1478
1479     'svc_forward' => {
1480       'columns' => [
1481         'svcnum',   'int',            '',   '', '', '',
1482         'srcsvc',   'int',        'NULL',   '', '', '',
1483         'src',      'varchar',    'NULL',  255, '', '',
1484         'dstsvc',   'int',        'NULL',   '', '', '',
1485         'dst',      'varchar',    'NULL',  255, '', '',
1486       ],
1487       'primary_key' => 'svcnum',
1488       'unique'      => [],
1489       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1490     },
1491
1492     'svc_www' => {
1493       'columns' => [
1494         'svcnum',   'int',      '',  '', '', '',
1495         'recnum',   'int',      '',  '', '', '',
1496         'usersvc',  'int',  'NULL',  '', '', '',
1497         'config',   'text', 'NULL',  '', '', '',
1498       ],
1499       'primary_key' => 'svcnum',
1500       'unique'      => [],
1501       'index'       => [],
1502     },
1503
1504     #'svc_wo' => {
1505     #  'columns' => [
1506     #    'svcnum',    'int',    '',   '',
1507     #    'svcnum',    'int',    '',   '',
1508     #    'svcnum',    'int',    '',   '',
1509     #    'worker',    'varchar',   '',   $char_d,
1510     #    '_date',     @date_type,
1511     #  ],
1512     #  'primary_key' => 'svcnum',
1513     #  'unique' => [ [] ],
1514     #  'index' => [ [] ],
1515     #},
1516
1517     'prepay_credit' => {
1518       'columns' => [
1519         'prepaynum',   'serial',     '',   '', '', '',
1520         'identifier',  'varchar', '', $char_d, '', '',
1521         'amount',      @money_type, '', '',
1522         'seconds',     'int',     'NULL', '', '', '',
1523         'upbytes',     'bigint',     'NULL', '', '', '',
1524         'downbytes',   'bigint',     'NULL', '', '', '',
1525         'totalbytes',  'bigint',     'NULL', '', '', '',
1526         'agentnum',    'int',     'NULL', '', '', '',
1527       ],
1528       'primary_key' => 'prepaynum',
1529       'unique'      => [ ['identifier'] ],
1530       'index'       => [],
1531     },
1532
1533     'port' => {
1534       'columns' => [
1535         'portnum',  'serial',     '',   '', '', '',
1536         'ip',       'varchar', 'NULL', 15, '', '',
1537         'nasport',  'int',     'NULL', '', '', '',
1538         'nasnum',   'int',     '',   '', '', '',
1539       ],
1540       'primary_key' => 'portnum',
1541       'unique'      => [],
1542       'index'       => [],
1543     },
1544
1545     'nas' => {
1546       'columns' => [
1547         'nasnum',   'serial',     '',    '', '', '',
1548         'nas',      'varchar', '',    $char_d, '', '',
1549         'nasip',    'varchar', '',    15, '', '',
1550         'nasfqdn',  'varchar', '',    $char_d, '', '',
1551         'last',     'int',     '',    '', '', '',
1552       ],
1553       'primary_key' => 'nasnum',
1554       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1555       'index'       => [ [ 'last' ] ],
1556     },
1557
1558 #    'session' => {
1559 #      'columns' => [
1560 #        'sessionnum', 'serial',       '',   '', '', '',
1561 #        'portnum',    'int',       '',   '', '', '',
1562 #        'svcnum',     'int',       '',   '', '', '',
1563 #        'login',      @date_type, '', '',
1564 #        'logout',     @date_type, '', '',
1565 #      ],
1566 #      'primary_key' => 'sessionnum',
1567 #      'unique'      => [],
1568 #      'index'       => [ [ 'portnum' ] ],
1569 #    },
1570
1571     'queue' => {
1572       'columns' => [
1573         'jobnum',      'serial',     '',      '', '', '',
1574         'job',           'text',     '',      '', '', '',
1575         '_date',          'int',     '',      '', '', '',
1576         'status',     'varchar',     '', $char_d, '', '',
1577         'statustext',    'text', 'NULL',      '', '', '',
1578         'svcnum',         'int', 'NULL',      '', '', '',
1579         'custnum',        'int', 'NULL',      '', '', '',
1580         'secure',        'char', 'NULL',       1, '', '',
1581         'priority',       'int', 'NULL',      '', '', '',
1582       ],
1583       'primary_key' => 'jobnum',
1584       'unique'      => [],
1585       'index'       => [ [ 'secure' ], [ 'priority' ],
1586                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1587                        ],
1588     },
1589
1590     'queue_arg' => {
1591       'columns' => [
1592         'argnum', 'serial', '', '', '', '',
1593         'jobnum', 'int', '', '', '', '',
1594         'arg', 'text', 'NULL', '', '', '',
1595       ],
1596       'primary_key' => 'argnum',
1597       'unique'      => [],
1598       'index'       => [ [ 'jobnum' ] ],
1599     },
1600
1601     'queue_depend' => {
1602       'columns' => [
1603         'dependnum', 'serial', '', '', '', '',
1604         'jobnum', 'int', '', '', '', '',
1605         'depend_jobnum', 'int', '', '', '', '',
1606       ],
1607       'primary_key' => 'dependnum',
1608       'unique'      => [],
1609       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1610     },
1611
1612     'export_svc' => {
1613       'columns' => [
1614         'exportsvcnum' => 'serial', '', '', '', '',
1615         'exportnum'    => 'int', '', '', '', '',
1616         'svcpart'      => 'int', '', '', '', '',
1617       ],
1618       'primary_key' => 'exportsvcnum',
1619       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1620       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1621     },
1622
1623     'part_export' => {
1624       'columns' => [
1625         'exportnum', 'serial', '', '', '', '',
1626         'machine', 'varchar', '', $char_d, '', '',
1627         'exporttype', 'varchar', '', $char_d, '', '',
1628         'nodomain',     'char', 'NULL', 1, '', '',
1629       ],
1630       'primary_key' => 'exportnum',
1631       'unique'      => [],
1632       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1633     },
1634
1635     'part_export_option' => {
1636       'columns' => [
1637         'optionnum', 'serial', '', '', '', '',
1638         'exportnum', 'int', '', '', '', '',
1639         'optionname', 'varchar', '', $char_d, '', '',
1640         'optionvalue', 'text', 'NULL', '', '', '',
1641       ],
1642       'primary_key' => 'optionnum',
1643       'unique'      => [],
1644       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1645     },
1646
1647     'radius_usergroup' => {
1648       'columns' => [
1649         'usergroupnum', 'serial', '', '', '', '',
1650         'svcnum',       'int', '', '', '', '',
1651         'groupname',    'varchar', '', $char_d, '', '',
1652       ],
1653       'primary_key' => 'usergroupnum',
1654       'unique'      => [],
1655       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1656     },
1657
1658     'msgcat' => {
1659       'columns' => [
1660         'msgnum', 'serial', '', '', '', '',
1661         'msgcode', 'varchar', '', $char_d, '', '',
1662         'locale', 'varchar', '', 16, '', '',
1663         'msg', 'text', '', '', '', '',
1664       ],
1665       'primary_key' => 'msgnum',
1666       'unique'      => [ [ 'msgcode', 'locale' ] ],
1667       'index'       => [],
1668     },
1669
1670     'cust_tax_exempt' => {
1671       'columns' => [
1672         'exemptnum', 'serial', '', '', '', '',
1673         'custnum',   'int', '', '', '', '',
1674         'taxnum',    'int', '', '', '', '',
1675         'year',      'int', '', '', '', '',
1676         'month',     'int', '', '', '', '',
1677         'amount',   @money_type, '', '',
1678       ],
1679       'primary_key' => 'exemptnum',
1680       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1681       'index'       => [],
1682     },
1683
1684     'cust_tax_exempt_pkg' => {
1685       'columns' => [
1686         'exemptpkgnum',  'serial', '', '', '', '',
1687         #'custnum',      'int', '', '', '', ''
1688         'billpkgnum',   'int', '', '', '', '',
1689         'taxnum',       'int', '', '', '', '',
1690         'year',         'int', '', '', '', '',
1691         'month',        'int', '', '', '', '',
1692         'amount',       @money_type, '', '',
1693       ],
1694       'primary_key' => 'exemptpkgnum',
1695       'unique' => [],
1696       'index'  => [ [ 'taxnum', 'year', 'month' ],
1697                     [ 'billpkgnum' ],
1698                     [ 'taxnum' ]
1699                   ],
1700     },
1701
1702     'router' => {
1703       'columns' => [
1704         'routernum', 'serial', '', '', '', '',
1705         'routername', 'varchar', '', $char_d, '', '',
1706         'svcnum', 'int', 'NULL', '', '', '',
1707         'agentnum',   'int', 'NULL', '', '', '',
1708       ],
1709       'primary_key' => 'routernum',
1710       'unique'      => [],
1711       'index'       => [],
1712     },
1713
1714     'part_svc_router' => {
1715       'columns' => [
1716         'svcrouternum', 'serial', '', '', '', '',
1717         'svcpart', 'int', '', '', '', '',
1718         'routernum', 'int', '', '', '', '',
1719       ],
1720       'primary_key' => 'svcrouternum',
1721       'unique'      => [],
1722       'index'       => [],
1723     },
1724
1725     'addr_block' => {
1726       'columns' => [
1727         'blocknum', 'serial', '', '', '', '',
1728         'routernum', 'int', '', '', '', '',
1729         'ip_gateway', 'varchar', '', 15, '', '',
1730         'ip_netmask', 'int', '', '', '', '',
1731         'agentnum',   'int', 'NULL', '', '', '',
1732         'manual_flag', 'char', 'NULL', 1, '', '',
1733       ],
1734       'primary_key' => 'blocknum',
1735       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1736       'index'       => [],
1737     },
1738
1739     'svc_broadband' => {
1740       'columns' => [
1741         'svcnum', 'int', '', '', '', '',
1742         'description', 'varchar', 'NULL', $char_d, '', '',
1743         'blocknum', 'int', '', '', '', '',
1744         'speed_up', 'int', '', '', '', '',
1745         'speed_down', 'int', '', '', '', '',
1746         'ip_addr', 'varchar', '', 15, '', '',
1747         'mac_addr', 'varchar', 'NULL', 12, '', '',
1748         'authkey',  'varchar', 'NULL', 32, '', '',
1749         'latitude', 'decimal', 'NULL', '', '', '',
1750         'longitude', 'decimal', 'NULL', '', '', '',
1751         'altitude', 'decimal', 'NULL', '', '', '',
1752         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1753         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1754       ],
1755       'primary_key' => 'svcnum',
1756       'unique'      => [ [ 'mac_addr' ] ],
1757       'index'       => [],
1758     },
1759
1760     'part_virtual_field' => {
1761       'columns' => [
1762         'vfieldpart', 'serial', '', '', '', '',
1763         'dbtable', 'varchar', '', 32, '', '',
1764         'name', 'varchar', '', 32, '', '',
1765         'check_block', 'text', 'NULL', '', '', '',
1766         'length', 'int', 'NULL', '', '', '',
1767         'list_source', 'text', 'NULL', '', '', '',
1768         'label', 'varchar', 'NULL', 80, '', '',
1769       ],
1770       'primary_key' => 'vfieldpart',
1771       'unique' => [],
1772       'index' => [],
1773     },
1774
1775     'virtual_field' => {
1776       'columns' => [
1777         'vfieldnum', 'serial', '', '', '', '',
1778         'recnum', 'int', '', '', '', '',
1779         'vfieldpart', 'int', '', '', '', '',
1780         'value', 'varchar', '', 128, '', '',
1781       ],
1782       'primary_key' => 'vfieldnum',
1783       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1784       'index' => [],
1785     },
1786
1787     'acct_snarf' => {
1788       'columns' => [
1789         'snarfnum',  'int', '', '', '', '',
1790         'svcnum',    'int', '', '', '', '',
1791         'machine',   'varchar', '', 255, '', '',
1792         'protocol',  'varchar', '', $char_d, '', '',
1793         'username',  'varchar', '', $char_d, '', '',
1794         '_password', 'varchar', '', $char_d, '', '',
1795       ],
1796       'primary_key' => 'snarfnum',
1797       'unique' => [],
1798       'index'  => [ [ 'svcnum' ] ],
1799     },
1800
1801     'svc_external' => {
1802       'columns' => [
1803         'svcnum', 'int', '', '', '', '',
1804         'id',     'int', 'NULL', '', '', '',
1805         'title',  'varchar', 'NULL', $char_d, '', '',
1806       ],
1807       'primary_key' => 'svcnum',
1808       'unique'      => [],
1809       'index'       => [],
1810     },
1811
1812     'cust_pay_refund' => {
1813       'columns' => [
1814         'payrefundnum', 'serial', '', '', '', '',
1815         'paynum',  'int', '', '', '', '',
1816         'refundnum',  'int', '', '', '', '',
1817         '_date',    @date_type, '', '',
1818         'amount',   @money_type, '', '',
1819       ],
1820       'primary_key' => 'payrefundnum',
1821       'unique' => [],
1822       'index' => [ ['paynum'], ['refundnum'] ],
1823     },
1824
1825     'part_pkg_option' => {
1826       'columns' => [
1827         'optionnum', 'serial', '', '', '', '',
1828         'pkgpart', 'int', '', '', '', '',
1829         'optionname', 'varchar', '', $char_d, '', '',
1830         'optionvalue', 'text', 'NULL', '', '', '',
1831       ],
1832       'primary_key' => 'optionnum',
1833       'unique'      => [],
1834       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1835     },
1836
1837     'rate' => {
1838       'columns' => [
1839         'ratenum',  'serial', '', '', '', '',
1840         'ratename', 'varchar', '', $char_d, '', '',
1841       ],
1842       'primary_key' => 'ratenum',
1843       'unique'      => [],
1844       'index'       => [],
1845     },
1846
1847     'rate_detail' => {
1848       'columns' => [
1849         'ratedetailnum',   'serial', '', '', '', '',
1850         'ratenum',         'int',     '', '', '', '',
1851         'orig_regionnum',  'int', 'NULL', '', '', '',
1852         'dest_regionnum',  'int',     '', '', '', '',
1853         'min_included',    'int',     '', '', '', '',
1854         #'min_charge',      @money_type, '', '',
1855         'min_charge',      'decimal', '', '10,5', '', '',
1856         'sec_granularity', 'int',     '', '', '', '',
1857         #time period (link to table of periods)?
1858         'classnum',        'int',     'NULL', '', '', '',
1859       ],
1860       'primary_key' => 'ratedetailnum',
1861       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1862       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1863     },
1864
1865     'rate_region' => {
1866       'columns' => [
1867         'regionnum',   'serial',      '', '', '', '',
1868         'regionname',  'varchar',     '', $char_d, '', '',
1869       ],
1870       'primary_key' => 'regionnum',
1871       'unique'      => [],
1872       'index'       => [],
1873     },
1874
1875     'rate_prefix' => {
1876       'columns' => [
1877         'prefixnum',   'serial',      '', '', '', '',
1878         'regionnum',   'int',         '', '', '', '',
1879         'countrycode', 'varchar',     '',  3, '', '',
1880         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
1881         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
1882       ],
1883       'primary_key' => 'prefixnum',
1884       'unique'      => [],
1885       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1886     },
1887
1888     'usage_class' => {
1889       'columns' => [
1890         'classnum',    'serial',   '',      '', '', '',
1891         'classname',   'varchar',  '', $char_d, '', '',
1892         'disabled',    'char', 'NULL',       1, '', '',
1893       ],
1894       'primary_key' => 'classnum',
1895       'unique' => [],
1896       'index' => [ ['disabled'] ],
1897     },
1898
1899     'reg_code' => {
1900       'columns' => [
1901         'codenum',   'serial',    '', '', '', '',
1902         'code',      'varchar',   '', $char_d, '', '',
1903         'agentnum',  'int',       '', '', '', '',
1904       ],
1905       'primary_key' => 'codenum',
1906       'unique'      => [ [ 'agentnum', 'code' ] ],
1907       'index'       => [ [ 'agentnum' ] ],
1908     },
1909
1910     'reg_code_pkg' => {
1911       'columns' => [
1912         'codepkgnum', 'serial', '', '', '', '',
1913         'codenum',   'int',    '', '', '', '',
1914         'pkgpart',   'int',    '', '', '', '',
1915       ],
1916       'primary_key' => 'codepkgnum',
1917       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1918       'index'       => [ [ 'codenum' ] ],
1919     },
1920
1921     'clientapi_session' => {
1922       'columns' => [
1923         'sessionnum',  'serial',  '', '', '', '',
1924         'sessionid',  'varchar',  '', $char_d, '', '',
1925         'namespace',  'varchar',  '', $char_d, '', '',
1926       ],
1927       'primary_key' => 'sessionnum',
1928       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1929       'index'       => [],
1930     },
1931
1932     'clientapi_session_field' => {
1933       'columns' => [
1934         'fieldnum',    'serial',     '', '', '', '',
1935         'sessionnum',     'int',     '', '', '', '',
1936         'fieldname',  'varchar',     '', $char_d, '', '',
1937         'fieldvalue',    'text', 'NULL', '', '', '',
1938       ],
1939       'primary_key' => 'fieldnum',
1940       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1941       'index'       => [],
1942     },
1943
1944     'payment_gateway' => {
1945       'columns' => [
1946         'gatewaynum',       'serial',   '',     '', '', '',
1947         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
1948         'gateway_module',   'varchar',  '',     $char_d, '', '',
1949         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1950         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1951         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1952         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
1953         'disabled',   'char',  'NULL',   1, '', '',
1954       ],
1955       'primary_key' => 'gatewaynum',
1956       'unique' => [],
1957       'index'  => [ [ 'disabled' ] ],
1958     },
1959
1960     'payment_gateway_option' => {
1961       'columns' => [
1962         'optionnum',   'serial',  '',     '', '', '',
1963         'gatewaynum',  'int',     '',     '', '', '',
1964         'optionname',  'varchar', '',     $char_d, '', '',
1965         'optionvalue', 'text',    'NULL', '', '', '',
1966       ],
1967       'primary_key' => 'optionnum',
1968       'unique'      => [],
1969       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1970     },
1971
1972     'agent_payment_gateway' => {
1973       'columns' => [
1974         'agentgatewaynum', 'serial', '', '', '', '',
1975         'agentnum',        'int', '', '', '', '',
1976         'gatewaynum',      'int', '', '', '', '',
1977         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1978         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1979       ],
1980       'primary_key' => 'agentgatewaynum',
1981       'unique'      => [],
1982       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1983     },
1984
1985     'banned_pay' => {
1986       'columns' => [
1987         'bannum',  'serial',   '',     '', '', '',
1988         'payby',   'char',     '',       4, '', '',
1989         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1990         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1991         '_date',   @date_type, '', '',
1992         'otaker',  'varchar',  '',     32, '', '',
1993         'reason',  'varchar',  'NULL', $char_d, '', '',
1994       ],
1995       'primary_key' => 'bannum',
1996       'unique'      => [ [ 'payby', 'payinfo' ] ],
1997       'index'       => [],
1998     },
1999
2000     'pkg_category' => {
2001       'columns' => [
2002         'categorynum',   'serial',  '', '', '', '',
2003         'categoryname',  'varchar', '', $char_d, '', '',
2004         'disabled',      'char', 'NULL',   1, '', '',
2005       ],
2006       'primary_key' => 'categorynum',
2007       'unique' => [],
2008       'index' => [ ['disabled'] ],
2009     },
2010
2011     'pkg_class' => {
2012       'columns' => [
2013         'classnum',    'serial',   '',      '', '', '',
2014         'classname',   'varchar',  '', $char_d, '', '',
2015         'categorynum', 'int',  'NULL',      '', '', '',
2016         'disabled',    'char', 'NULL',       1, '', '',
2017       ],
2018       'primary_key' => 'classnum',
2019       'unique' => [],
2020       'index' => [ ['disabled'] ],
2021     },
2022
2023     'cdr' => {
2024       'columns' => [
2025         # qw( name type null length default local );
2026
2027         ###
2028         #asterisk fields
2029         ###
2030
2031         'acctid',   'bigserial',  '', '', '', '',
2032         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2033         'calldate', 'timestamp',   '',      '', \'now()', '',
2034         'clid',        'varchar',  '', $char_d, \"''", '',
2035         'src',         'varchar',  '', $char_d, \"''", '',
2036         'dst',         'varchar',  '', $char_d, \"''", '',
2037         'dcontext',    'varchar',  '', $char_d, \"''", '',
2038         'channel',     'varchar',  '', $char_d, \"''", '',
2039         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2040         'lastapp',     'varchar',  '', $char_d, \"''", '',
2041         'lastdata',    'varchar',  '', $char_d, \"''", '',
2042
2043         #these don't seem to be logged by most of the SQL cdr_* modules
2044         #except tds under sql-illegal names, so;
2045         # ... don't rely on them for rating?
2046         # and, what they hey, i went ahead and changed the names and data types
2047         # to freeside-style dates...
2048           #'start',  'timestamp', 'NULL',  '',    '', '',
2049           #'answer', 'timestamp', 'NULL',  '',    '', '',
2050           #'end',    'timestamp', 'NULL',  '',    '', '',
2051         'startdate',  @date_type, '', '',
2052         'answerdate', @date_type, '', '',
2053         'enddate',    @date_type, '', '',
2054         #
2055
2056         'duration',    'int',      '',      '',     0, '',
2057         'billsec',     'int',      '',      '',     0, '',
2058         'disposition', 'varchar',  '',      45, \"''", '',
2059         'amaflags',    'int',      '',      '',     0, '',
2060         'accountcode', 'varchar',  '',      20, \"''", '',
2061         'uniqueid',    'varchar',  '',      32, \"''", '',
2062         'userfield',   'varchar',  '',     255, \"''", '',
2063
2064         ###
2065         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2066         # defaults
2067         ###
2068
2069         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2070         'cdrtypenum',              'int', 'NULL',      '', '', '',
2071
2072         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2073
2074         'upstream_currency',      'char', 'NULL',       3, '', '',
2075         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2076         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2077
2078         # how it was rated internally...
2079         'ratedetailnum',           'int', 'NULL',      '', '', '',
2080         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
2081
2082         'distance',            'decimal', 'NULL',      '', '', '',
2083         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2084
2085         #cdr_calltype: the big list in appendix 2
2086         'calltypenum',             'int', 'NULL',      '', '', '',
2087
2088         'description',         'varchar', 'NULL', $char_d, '', '',
2089         'quantity',                'int', 'NULL',      '', '', '',
2090
2091         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2092         'carrierid',               'int', 'NULL',      '', '', '',
2093
2094         'upstream_rateid',         'int', 'NULL',      '', '', '',
2095
2096         ###
2097         #and now for our own fields
2098         ###
2099
2100         # a svcnum... right..?
2101         'svcnum',             'int',   'NULL',     '',   '', '',
2102
2103         #NULL, done (or something)
2104         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2105
2106         #NULL, done (or something)
2107         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2108
2109         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2110
2111       ],
2112       'primary_key' => 'acctid',
2113       'unique' => [],
2114       'index' => [ [ 'calldate' ], [ 'src' ], [ 'dst' ], [ 'charged_party' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'freesiderewritestatus' ], [ 'cdrbatch' ], ],
2115     },
2116
2117     'cdr_calltype' => {
2118       'columns' => [
2119         'calltypenum',   'serial',  '', '', '', '',
2120         'calltypename',  'varchar', '', $char_d, '', '',
2121       ],
2122       'primary_key' => 'calltypenum',
2123       'unique'      => [],
2124       'index'       => [],
2125     },
2126
2127     'cdr_type' => {
2128       'columns' => [
2129         'cdrtypenum'  => 'serial',  '', '', '', '',
2130         'cdrtypename' => 'varchar', '', $char_d, '', '',
2131       ],
2132       'primary_key' => 'cdrtypenum',
2133       'unique'      => [],
2134       'index'       => [],
2135     },
2136
2137     'cdr_carrier' => {
2138       'columns' => [
2139         'carrierid'   => 'serial',  '', '', '', '',
2140         'carriername' => 'varchar', '', $char_d, '', '',
2141       ],
2142       'primary_key' => 'carrierid',
2143       'unique'      => [],
2144       'index'       => [],
2145     },
2146
2147     #map upstream rateid to ours...
2148     'cdr_upstream_rate' => {
2149       'columns' => [
2150         'upstreamratenum', 'serial',  '', '', '', '',
2151         'upstream_rateid', 'varchar', '', $char_d, '', '',
2152         'ratedetailnum',   'int', 'NULL', '', '', '',
2153       ],
2154       'primary_key' => 'upstreamratenum', #XXX need a primary key
2155       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2156       'index'  => [],
2157     },
2158
2159     #'cdr_file' => {
2160     #  'columns' => [
2161     #    'filenum',    'serial',     '', '', '', '',
2162     #    'filename',  'varchar',     '', '', '', '',
2163     #    'status',    'varchar', 'NULL', '', '', '',
2164     #  ],
2165     #  'primary_key' => 'filenum',
2166     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2167     #                                   # agent-virtualize or have a customer
2168     #                                   # with dup-filename needs or something
2169     #                                   # (only used by cdr.http_and_import for
2170     #                                   #  chrissakes)
2171     #  'index'  => [],
2172     #},
2173
2174     'inventory_item' => {
2175       'columns' => [
2176         'itemnum',  'serial',      '',      '', '', '',
2177         'classnum', 'int',         '',      '', '', '',
2178         'item',     'varchar',     '', $char_d, '', '',
2179         'svcnum',   'int',     'NULL',      '', '', '',
2180       ],
2181       'primary_key' => 'itemnum',
2182       'unique' => [ [ 'classnum', 'item' ] ],
2183       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2184     },
2185
2186     'inventory_class' => {
2187       'columns' => [
2188         'classnum',  'serial',       '',      '', '', '',
2189         'classname', 'varchar',      '', $char_d, '', '',
2190       ],
2191       'primary_key' => 'classnum',
2192       'unique' => [],
2193       'index'  => [],
2194     },
2195
2196     'access_user' => {
2197       'columns' => [
2198         'usernum',   'serial',  '',      '', '', '',
2199         'username',  'varchar', '', $char_d, '', '',
2200         '_password', 'varchar', '', $char_d, '', '',
2201         'last',      'varchar', '', $char_d, '', '',
2202         'first',     'varchar', '', $char_d, '', '',
2203         'disabled',     'char', 'NULL',   1, '', '',
2204       ],
2205       'primary_key' => 'usernum',
2206       'unique' => [ [ 'username' ] ],
2207       'index'  => [],
2208     },
2209
2210     'access_user_pref' => {
2211       'columns' => [
2212         'prefnum',    'serial',       '', '', '', '',
2213         'usernum',     'int',       '', '', '', '',
2214         'prefname', 'varchar', '', $char_d, '', '',
2215         'prefvalue', 'text', 'NULL', '', '', '',
2216         'expiration', @date_type, '', '',
2217       ],
2218       'primary_key' => 'prefnum',
2219       'unique' => [],
2220       'index'  => [ [ 'usernum' ] ],
2221     },
2222
2223     'access_group' => {
2224       'columns' => [
2225         'groupnum',   'serial', '',      '', '', '',
2226         'groupname', 'varchar', '', $char_d, '', '',
2227       ],
2228       'primary_key' => 'groupnum',
2229       'unique' => [ [ 'groupname' ] ],
2230       'index'  => [],
2231     },
2232
2233     'access_usergroup' => {
2234       'columns' => [
2235         'usergroupnum', 'serial', '', '', '', '',
2236         'usernum',         'int', '', '', '', '',
2237         'groupnum',        'int', '', '', '', '',
2238       ],
2239       'primary_key' => 'usergroupnum',
2240       'unique' => [ [ 'usernum', 'groupnum' ] ],
2241       'index'  => [ [ 'usernum' ] ],
2242     },
2243
2244     'access_groupagent' => {
2245       'columns' => [
2246         'groupagentnum', 'serial', '', '', '', '',
2247         'groupnum',         'int', '', '', '', '',
2248         'agentnum',         'int', '', '', '', '',
2249       ],
2250       'primary_key' => 'groupagentnum',
2251       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2252       'index'  => [ [ 'groupnum' ] ],
2253     },
2254
2255     'access_right' => {
2256       'columns' => [
2257         'rightnum',   'serial', '',      '', '', '',
2258         'righttype', 'varchar', '', $char_d, '', '',
2259         'rightobjnum',   'int', '',      '', '', '',
2260         'rightname', 'varchar', '', $char_d, '', '',
2261       ],
2262       'primary_key' => 'rightnum',
2263       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2264       'index'  => [],
2265     },
2266
2267     'svc_phone' => {
2268       'columns' => [
2269         'svcnum',       'int',         '',      '', '', '',
2270         'countrycode',  'varchar',     '',       3, '', '',
2271         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2272         'pin',          'varchar', 'NULL', $char_d, '', '',
2273         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2274         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2275       ],
2276       'primary_key' => 'svcnum',
2277       'unique' => [],
2278       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2279     },
2280
2281     'phone_avail' => {
2282       'columns' => [
2283         'availnum',    'serial',      '',      '', '', '',
2284         'exportnum',   'int',         '',      '', '', '',
2285         'countrycode', 'varchar',     '',       3, '', '',
2286         'state',       'char',    'NULL',       2, '', '',
2287         'npa',         'char',        '',       3, '', '',
2288         'nxx',         'char',    'NULL',       3, '', '',
2289         'station',     'char',    'NULL',       4, '', '',
2290         'name',        'varchar', 'NULL', $char_d, '', '',
2291         'svcnum',      'int',     'NULL',      '', '', '',
2292         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2293       ],
2294       'primary_key' => 'availnum',
2295       'unique' => [],
2296       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2297                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2298                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2299                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2300                     [ 'svcnum' ],
2301                     [ 'availbatch' ],
2302                   ],
2303     },
2304
2305     'reason_type' => {
2306       'columns' => [
2307         'typenum',   'serial',  '', '', '', '',
2308         'class',     'char', '', 1, '', '',
2309         'type',     'varchar', '', $char_d, '', '',
2310       ],
2311       'primary_key' => 'typenum',
2312       'unique' => [],
2313       'index' => [],
2314     },
2315
2316     'reason' => {
2317       'columns' => [
2318         'reasonnum',     'serial',  '', '', '', '',
2319         'reason_type',   'int',  '', '', '', '',
2320         'reason',        'text', '', '', '', '',
2321         'disabled',      'char',    'NULL', 1, '', '',
2322       ],
2323       'primary_key' => 'reasonnum',
2324       'unique' => [],
2325       'index' => [],
2326     },
2327
2328     'conf' => {
2329       'columns' => [
2330         'confnum',  'serial',  '', '', '', '',
2331         'agentnum', 'int',  'NULL', '', '', '',
2332         'name',     'varchar', '', $char_d, '', '',
2333         'value',    'text', 'NULL', '', '', '',
2334       ],
2335       'primary_key' => 'confnum',
2336       'unique' => [ [ 'agentnum', 'name' ]],
2337       'index' => [],
2338     },
2339
2340     'pkg_referral' => {
2341       'columns' => [
2342         'pkgrefnum',     'serial', '', '', '', '',
2343         'pkgnum',        'int',    '', '', '', '',
2344         'refnum',        'int',    '', '', '', '',
2345       ],
2346       'primary_key' => 'pkgrefnum',
2347       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2348       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2349     },
2350     # name type nullability length default local
2351
2352     #'new_table' => {
2353     #  'columns' => [
2354     #    'num', 'serial',       '', '', '', '',
2355     #  ],
2356     #  'primary_key' => 'num',
2357     #  'unique' => [],
2358     #  'index'  => [],
2359     #},
2360
2361   };
2362
2363 }
2364
2365 =back
2366
2367 =head1 BUGS
2368
2369 =head1 SEE ALSO
2370
2371 L<DBIx::DBSchema>
2372
2373 =cut
2374
2375 1;
2376