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