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