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