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       #can be removed once we depend on DBIx::DBSchema 0.39;
 106       $hash{'type'} = 'LONGTEXT'
 107         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 108
 109       unless ( defined $hash{'default'} ) {
 110         warn "$tablename:\n".
 111              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 112       }
 113
 114       push @columns, new DBIx::DBSchema::Column ( \%hash );
 115     }
 116
 117     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 118     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 119     my $unique = $tables_hashref->{$tablename}{'unique'};
 120     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 121
 122     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 123     #  specification without a key length".
 124     # better solution: teach DBIx::DBSchema to specify a default length for
 125     #  MySQL indices on text columns, or just to support an index length at all
 126     #  so we can pass something in.
 127     # best solution: eliminate need for this index in cust_main::retry_realtime
 128     @index = grep { @{$_}[0] ne 'statustext' } @index
 129       if $datasrc =~ /^dbi:mysql/i;
 130
 131     my @indices = ();
 132     push @indices, map {
 133                          DBIx::DBSchema::Index->new({
 134                            'name'    => $tablename. $indexnum++,
 135                            'unique'  => 1,
 136                            'columns' => $_,
 137                          });
 138                        }
 139                        @$unique;
 140     push @indices, map {
 141                          DBIx::DBSchema::Index->new({
 142                            'name'    => $tablename. $indexnum++,
 143                            'unique'  => 0,
 144                            'columns' => $_,
 145                          });
 146                        }
 147                        @index;
 148
 149     DBIx::DBSchema::Table->new({
 150       'name'          => $tablename,
 151       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 152       'columns'       => \@columns,
 153       'indices'       => \@indices,
 154       'local_options' => $local_options,
 155     });
 156
 157   } keys %$tables_hashref;
 158
 159   if ( $DEBUG ) {
 160     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 161     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 162   }
 163
 164   #add radius attributes to svc_acct
 165   #
 166   #my($svc_acct)=$dbdef->table('svc_acct');
 167   #
 168   #my($attribute);
 169   #foreach $attribute (@attributes) {
 170   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 171   #    'radius_'. $attribute,
 172   #    'varchar',
 173   #    'NULL',
 174   #    $char_d,
 175   #  ));
 176   #}
 177   #
 178   #foreach $attribute (@check_attributes) {
 179   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 180   #    'rc_'. $attribute,
 181   #    'varchar',
 182   #    'NULL',
 183   #    $char_d,
 184   #  ));
 185   #}
 186
 187   #create history tables (false laziness w/create-history-tables)
 188   foreach my $table (
 189     grep { ! /^clientapi_session/ }
 190     grep { ! /^h_/ }
 191     $dbdef->tables
 192   ) {
 193     my $tableobj = $dbdef->table($table)
 194       or die "unknown table $table";
 195
 196     my %indices = $tableobj->indices;
 197
 198     my %h_indices = map {
 199                           ( "h_$_" =>
 200                               DBIx::DBSchema::Index->new({
 201                                 'name'    => 'h_'. $indices{$_}->name,
 202                                 'unique'  => 0,
 203                                 'columns' => [ @{$indices{$_}->columns} ],
 204                               })
 205                           );
 206                         }
 207                         keys %indices;
 208
 209     $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
 210                                         'name'    => "h_${table}_srckey",
 211                                         'unique'  => 0,
 212                                         'columns' => [ 'history_action', #right?
 213                                                        $tableobj->primary_key,
 214                                                      ],
 215                                       });
 216
 217     $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
 218                                          'name'    => "h_${table}_srckey2",
 219                                          'unique'  => 0,
 220                                          'columns' => [ 'history_date',
 221                                                         $tableobj->primary_key,
 222                                                       ],
 223                                        });
 224
 225     my $h_tableobj = DBIx::DBSchema::Table->new( {
 226       'name'          => "h_$table",
 227       'primary_key'   => 'historynum',
 228       'indices'       => \%h_indices,
 229       'local_options' => $local_options,
 230       'columns'       => [
 231           DBIx::DBSchema::Column->new( {
 232             'name'    => 'historynum',
 233             'type'    => 'serial',
 234             'null'    => 'NOT NULL',
 235             'length'  => '',
 236             'default' => '',
 237             'local'   => '',
 238           } ),
 239           DBIx::DBSchema::Column->new( {
 240             'name'    => 'history_date',
 241             'type'    => 'int',
 242             'null'    => 'NULL',
 243             'length'  => '',
 244             'default' => '',
 245             'local'   => '',
 246           } ),
 247           DBIx::DBSchema::Column->new( {
 248             'name'    => 'history_user',
 249             'type'    => 'varchar',
 250             'null'    => 'NOT NULL',
 251             'length'  => '80',
 252             'default' => '',
 253             'local'   => '',
 254           } ),
 255           DBIx::DBSchema::Column->new( {
 256             'name'    => 'history_action',
 257             'type'    => 'varchar',
 258             'null'    => 'NOT NULL',
 259             'length'  => '80',
 260             'default' => '',
 261             'local'   => '',
 262           } ),
 263           map {
 264             my $column = $tableobj->column($_);
 265
 266             #clone so as to not disturb the original
 267             $column = DBIx::DBSchema::Column->new( {
 268               map { $_ => $column->$_() }
 269                 qw( name type null length default local )
 270             } );
 271
 272             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 273               $column->type(uc($1).'INT');
 274               $column->null('NULL');
 275             }
 276             #$column->default('')
 277             #  if $column->default =~ /^nextval\(/i;
 278             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 279             #$column->local($local);
 280             $column;
 281           } $tableobj->columns
 282       ],
 283     } );
 284     $dbdef->addtable($h_tableobj);
 285   }
 286
 287   if ( $datasrc =~ /^dbi:mysql/i ) {
 288
 289     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 290       'name'          => 'duplicate_lock',
 291       'primary_key'   => 'duplocknum',
 292       'local_options' => $local_options,
 293       'columns'       => [
 294         DBIx::DBSchema::Column->new( {
 295           'name'    => 'duplocknum',
 296           'type'    => 'serial',
 297           'null'    => 'NOT NULL',
 298           'length'  => '',
 299           'default' => '',
 300           'local'   => '',
 301         } ),
 302         DBIx::DBSchema::Column->new( {
 303           'name'    => 'lockname',
 304           'type'    => 'varchar',
 305           'null'    => 'NOT NULL',
 306           'length'  => '80',
 307           'default' => '',
 308           'local'   => '',
 309         } ),
 310       ],
 311       'indices' => { 'duplicate_lock1' =>
 312                        DBIx::DBSchema::Index->new({
 313                          'name'    => 'duplicate_lock1',
 314                          'unique'  => 1,
 315                          'columns' => [ 'lockname' ],
 316                        })
 317                    },
 318     } );
 319
 320     $dbdef->addtable($dup_lock_table);
 321
 322   }
 323
 324   $dbdef;
 325
 326 }
 327
 328 sub tables_hashref {
 329
 330   my $char_d = 80; #default maxlength for text fields
 331
 332   #my(@date_type)  = ( 'timestamp', '', ''     );
 333   my @date_type  = ( 'int', 'NULL', ''     );
 334   my @perl_type = ( 'text', 'NULL', ''  );
 335   my @money_type = ( 'decimal',   '', '10,2' );
 336   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 337   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 338   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 339
 340   my $username_len = 32; #usernamemax config file
 341
 342     # name type nullability length default local
 343
 344   return {
 345
 346     'agent' => {
 347       'columns' => [
 348         'agentnum',          'serial',    '',       '', '', '',
 349         'agent',            'varchar',    '',  $char_d, '', '',
 350         'typenum',              'int',    '',       '', '', '',
 351         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 352         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 353         'agent_custnum',        'int', 'NULL',      '', '', '',
 354         'disabled',            'char', 'NULL',       1, '', '',
 355         'username',         'varchar', 'NULL', $char_d, '', '',
 356         '_password',        'varchar', 'NULL', $char_d, '', '',
 357         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 358         'prog',                     @perl_type, '', '', #deprecated (never used)
 359       ],
 360       'primary_key' => 'agentnum',
 361       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 362                                             #insert is giving it a value, tho..
 363       #'index' => [ ['typenum'], ['disabled'] ],
 364       'unique' => [],
 365       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 366     },
 367
 368     'agent_type' => {
 369       'columns' => [
 370         'typenum',   'serial',  '', '', '', '',
 371         'atype',     'varchar', '', $char_d, '', '',
 372       ],
 373       'primary_key' => 'typenum',
 374       'unique' => [],
 375       'index' => [],
 376     },
 377
 378     'type_pkgs' => {
 379       'columns' => [
 380         'typepkgnum', 'serial', '', '', '', '',
 381         'typenum',   'int',  '', '', '', '',
 382         'pkgpart',   'int',  '', '', '', '',
 383       ],
 384       'primary_key' => 'typepkgnum',
 385       'unique' => [ ['typenum', 'pkgpart'] ],
 386       'index' => [ ['typenum'] ],
 387     },
 388
 389     'cust_attachment' => {
 390       'columns' => [
 391         'attachnum', 'serial', '', '', '', '',
 392         'custnum',   'int', '', '', '', '',
 393         '_date',     @date_type, '', '',
 394         'otaker',    'varchar', 'NULL', 32, '', '',
 395         'usernum',   'int', 'NULL', '', '', '',
 396         'filename',  'varchar', '', 255, '', '',
 397         'mime_type', 'varchar', '', $char_d, '', '',
 398         'title',     'varchar', 'NULL', $char_d, '', '',
 399         'body',      'blob', 'NULL', '', '', '',
 400         'disabled',  @date_type, '', '',
 401       ],
 402       'primary_key' => 'attachnum',
 403       'unique'      => [],
 404       'index'       => [ ['custnum'], ['usernum'], ],
 405     },
 406
 407     'cust_bill' => {
 408       'columns' => [
 409         #regular fields
 410         'invnum',    'serial',     '', '', '', '',
 411         'custnum',      'int',     '', '', '', '',
 412         '_date',        @date_type,        '', '',
 413         'charged',      @money_type,       '', '',
 414         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 415
 416         #customer balance info at invoice generation time
 417         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 418         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 419
 420         #deprecated (unused by now, right?)
 421         'printed',      'int',     '', '', '', '',
 422
 423         #specific use cases
 424         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 425         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 426         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 427       ],
 428       'primary_key' => 'invnum',
 429       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 430       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
 431     },
 432
 433     'cust_statement' => {
 434       'columns' => [
 435         'statementnum', 'serial', '', '', '', '',
 436         'custnum',         'int', '', '', '', '',
 437         '_date',           @date_type,    '', '',
 438       ],
 439       'primary_key' => 'statementnum',
 440       'unique' => [],
 441       'index' => [ ['custnum'], ['_date'], ],
 442     },
 443
 444     'cust_bill_event' => {
 445       'columns' => [
 446         'eventnum',    'serial',  '', '', '', '',
 447         'invnum',   'int',  '', '', '', '',
 448         'eventpart',   'int',  '', '', '', '',
 449         '_date',     @date_type, '', '',
 450         'status', 'varchar', '', $char_d, '', '',
 451         'statustext', 'text', 'NULL', '', '', '',
 452       ],
 453       'primary_key' => 'eventnum',
 454       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 455       'unique' => [],
 456       'index' => [ ['invnum'], ['status'], ['eventpart'],
 457                    ['statustext'], ['_date'],
 458                  ],
 459     },
 460
 461     'part_bill_event' => {
 462       'columns' => [
 463         'eventpart',    'serial',  '', '', '', '',
 464         'freq',        'varchar',       'NULL',     $char_d, '', '',
 465         'payby',       'char',  '', 4, '', '',
 466         'event',       'varchar',           '',     $char_d, '', '',
 467         'eventcode',    @perl_type, '', '',
 468         'seconds',     'int', 'NULL', '', '', '',
 469         'weight',      'int', '', '', '', '',
 470         'plan',       'varchar', 'NULL', $char_d, '', '',
 471         'plandata',   'text', 'NULL', '', '', '',
 472         'reason',     'int', 'NULL', '', '', '',
 473         'disabled',     'char', 'NULL', 1, '', '',
 474       ],
 475       'primary_key' => 'eventpart',
 476       'unique' => [],
 477       'index' => [ ['payby'], ['disabled'], ],
 478     },
 479
 480     'part_event' => {
 481       'columns' => [
 482         'eventpart',   'serial',      '',      '', '', '',
 483         'agentnum',    'int',     'NULL',      '', '', '',
 484         'event',       'varchar',     '', $char_d, '', '',
 485         'eventtable',  'varchar',     '', $char_d, '', '',
 486         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 487         'weight',      'int',         '',      '', '', '',
 488         'action',      'varchar',     '', $char_d, '', '',
 489         'disabled',     'char',   'NULL',       1, '', '',
 490       ],
 491       'primary_key' => 'eventpart',
 492       'unique' => [],
 493       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 494     },
 495
 496     'part_event_option' => {
 497       'columns' => [
 498         'optionnum', 'serial', '', '', '', '',
 499         'eventpart', 'int', '', '', '', '',
 500         'optionname', 'varchar', '', $char_d, '', '',
 501         'optionvalue', 'text', 'NULL', '', '', '',
 502       ],
 503       'primary_key' => 'optionnum',
 504       'unique'      => [],
 505       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 506     },
 507
 508     'part_event_condition' => {
 509       'columns' => [
 510         'eventconditionnum', 'serial', '', '', '', '',
 511         'eventpart', 'int', '', '', '', '',
 512         'conditionname', 'varchar', '', $char_d, '', '',
 513       ],
 514       'primary_key' => 'eventconditionnum',
 515       'unique'      => [],
 516       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 517     },
 518
 519     'part_event_condition_option' => {
 520       'columns' => [
 521         'optionnum', 'serial', '', '', '', '',
 522         'eventconditionnum', 'int', '', '', '', '',
 523         'optionname', 'varchar', '', $char_d, '', '',
 524         'optionvalue', 'text', 'NULL', '', '', '',
 525       ],
 526       'primary_key' => 'optionnum',
 527       'unique'      => [],
 528       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 529     },
 530
 531     'part_event_condition_option_option' => {
 532       'columns' => [
 533         'optionoptionnum', 'serial', '', '', '', '',
 534         'optionnum', 'int', '', '', '', '',
 535         'optionname', 'varchar', '', $char_d, '', '',
 536         'optionvalue', 'text', 'NULL', '', '', '',
 537       ],
 538       'primary_key' => 'optionoptionnum',
 539       'unique'      => [],
 540       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 541     },
 542
 543     'cust_event' => {
 544       'columns' => [
 545         'eventnum',    'serial',  '', '', '', '',
 546         'eventpart',   'int',  '', '', '', '',
 547         'tablenum',   'int',  '', '', '', '',
 548         '_date',     @date_type, '', '',
 549         'status', 'varchar', '', $char_d, '', '',
 550         'statustext', 'text', 'NULL', '', '', '',
 551       ],
 552       'primary_key' => 'eventnum',
 553       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 554       'unique' => [],
 555       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 556                    ['statustext'], ['_date'],
 557                  ],
 558     },
 559
 560     'cust_bill_pkg' => {
 561       'columns' => [
 562         'billpkgnum',        'serial',     '',      '', '', '',
 563         'invnum',               'int',     '',      '', '', '',
 564         'pkgnum',               'int',     '',      '', '', '',
 565         'pkgpart_override',     'int', 'NULL',      '', '', '',
 566         'setup',               @money_type,             '', '',
 567         'recur',               @money_type,             '', '',
 568         'sdate',               @date_type,              '', '',
 569         'edate',               @date_type,              '', '',
 570         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 571         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 572         'section',          'varchar', 'NULL', $char_d, '', '',
 573         'freq',             'varchar', 'NULL', $char_d, '', '',
 574         'quantity',             'int', 'NULL',      '', '', '',
 575         'unitsetup',           @money_typen,            '', '',
 576         'unitrecur',           @money_typen,            '', '',
 577         'hidden',              'char', 'NULL',       1, '', '',
 578       ],
 579       'primary_key' => 'billpkgnum',
 580       'unique' => [],
 581       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 582     },
 583
 584     'cust_bill_pkg_detail' => {
 585       'columns' => [
 586         'detailnum', 'serial', '', '', '', '',
 587         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 588         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 589         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 590         'amount',  'decimal', 'NULL', '10,4', '', '',
 591         'format',  'char', 'NULL', 1, '', '',
 592         'classnum', 'int', 'NULL', '', '', '',
 593         'duration', 'int', 'NULL', '',  0, '',
 594         'phonenum', 'varchar', 'NULL', 15, '', '',
 595         'regionname', 'varchar', 'NULL', $char_d, '', '',
 596         'detail',  'varchar', '', 255, '', '',
 597       ],
 598       'primary_key' => 'detailnum',
 599       'unique' => [],
 600       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 601     },
 602
 603     'cust_bill_pkg_display' => {
 604       'columns' => [
 605         'billpkgdisplaynum', 'serial', '', '', '', '',
 606         'billpkgnum', 'int', '', '', '', '',
 607         'section',  'varchar', 'NULL', $char_d, '', '',
 608         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 609         #'unitrecur', @money_typen, '', '',     #this too?
 610         'post_total', 'char', 'NULL', 1, '', '',
 611         'type',       'char', 'NULL', 1, '', '',
 612         'summary',    'char', 'NULL', 1, '', '',
 613       ],
 614       'primary_key' => 'billpkgdisplaynum',
 615       'unique' => [],
 616       'index' => [ ['billpkgnum'], ],
 617     },
 618
 619     'cust_bill_pkg_tax_location' => {
 620       'columns' => [
 621         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 622         'billpkgnum',               'int',      '', '', '', '',
 623         'taxnum',                   'int',      '', '', '', '',
 624         'taxtype',              'varchar',      '', $char_d, '', '',
 625         'pkgnum',                   'int',      '', '', '', '',
 626         'locationnum',              'int',      '', '', '', '', #redundant?
 627         'amount',                   @money_type,        '', '',
 628       ],
 629       'primary_key' => 'billpkgtaxlocationnum',
 630       'unique' => [],
 631       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 632     },
 633
 634     'cust_bill_pkg_tax_rate_location' => {
 635       'columns' => [
 636         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 637         'billpkgnum',                   'int',      '', '', '', '',
 638         'taxnum',                       'int',      '', '', '', '',
 639         'taxtype',                  'varchar',      '', $char_d, '', '',
 640         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 641         'taxratelocationnum',           'int',      '', '', '', '',
 642         'amount',                       @money_type,        '', '',
 643       ],
 644       'primary_key' => 'billpkgtaxratelocationnum',
 645       'unique' => [],
 646       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 647     },
 648
 649     'cust_credit' => {
 650       'columns' => [
 651         'crednum',  'serial', '', '', '', '',
 652         'custnum',  'int', '', '', '', '',
 653         '_date',    @date_type, '', '',
 654         'amount',   @money_type, '', '',
 655         'otaker',   'varchar', 'NULL', 32, '', '',
 656         'usernum',   'int', 'NULL', '', '', '',
 657         'reason',   'text', 'NULL', '', '', '',
 658         'reasonnum', 'int', 'NULL', '', '', '',
 659         'addlinfo', 'text', 'NULL', '', '', '',
 660         'closed',    'char', 'NULL', 1, '', '',
 661         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 662         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
 663       ],
 664       'primary_key' => 'crednum',
 665       'unique' => [],
 666       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'] ],
 667     },
 668
 669     'cust_credit_bill' => {
 670       'columns' => [
 671         'creditbillnum', 'serial', '', '', '', '',
 672         'crednum',  'int', '', '', '', '',
 673         'invnum',  'int', '', '', '', '',
 674         '_date',    @date_type, '', '',
 675         'amount',   @money_type, '', '',
 676         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 677       ],
 678       'primary_key' => 'creditbillnum',
 679       'unique' => [],
 680       'index' => [ ['crednum'], ['invnum'] ],
 681     },
 682
 683     'cust_credit_bill_pkg' => {
 684       'columns' => [
 685         'creditbillpkgnum', 'serial', '',      '', '', '',
 686         'creditbillnum',       'int', '',      '', '', '',
 687         'billpkgnum',          'int', '',      '', '', '',
 688         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
 689         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
 690         'amount',            @money_type,          '', '',
 691         'setuprecur',      'varchar', '', $char_d, '', '',
 692         'sdate',   @date_type, '', '',
 693         'edate',   @date_type, '', '',
 694       ],
 695       'primary_key' => 'creditbillpkgnum',
 696       'unique'      => [],
 697       'index'       => [ [ 'creditbillnum' ],
 698                          [ 'billpkgnum' ],
 699                          [ 'billpkgtaxlocationnum' ],
 700                          [ 'billpkgtaxratelocationnum' ],
 701                        ],
 702     },
 703
 704     'cust_main' => {
 705       'columns' => [
 706         'custnum',  'serial',  '',     '', '', '',
 707         'agentnum', 'int',  '',     '', '', '',
 708         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 709         'classnum', 'int', 'NULL', '', '', '',
 710         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 711 #        'titlenum', 'int',  'NULL',   '', '', '',
 712         'last',     'varchar', '',     $char_d, '', '',
 713 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 714         'first',    'varchar', '',     $char_d, '', '',
 715         'ss',       'varchar', 'NULL', 11, '', '',
 716         'stateid', 'varchar', 'NULL', $char_d, '', '',
 717         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 718         'birthdate' ,@date_type, '', '',
 719         'signupdate',@date_type, '', '',
 720         'dundate',   @date_type, '', '',
 721         'company',  'varchar', 'NULL', $char_d, '', '',
 722         'address1', 'varchar', '',     $char_d, '', '',
 723         'address2', 'varchar', 'NULL', $char_d, '', '',
 724         'city',     'varchar', '',     $char_d, '', '',
 725         'county',   'varchar', 'NULL', $char_d, '', '',
 726         'state',    'varchar', 'NULL', $char_d, '', '',
 727         'zip',      'varchar', 'NULL', 10, '', '',
 728         'country',  'char', '',     2, '', '',
 729         'daytime',  'varchar', 'NULL', 20, '', '',
 730         'night',    'varchar', 'NULL', 20, '', '',
 731         'fax',      'varchar', 'NULL', 12, '', '',
 732         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 733 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 734         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 735         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 736         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 737         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 738         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 739         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 740         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 741         'ship_zip',      'varchar', 'NULL', 10, '', '',
 742         'ship_country',  'char', 'NULL', 2, '', '',
 743         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 744         'ship_night',    'varchar', 'NULL', 20, '', '',
 745         'ship_fax',      'varchar', 'NULL', 12, '', '',
 746         'payby',    'char', '',     4, '', '',
 747         'payinfo',  'varchar', 'NULL', 512, '', '',
 748         'paycvv',   'varchar', 'NULL', 512, '', '',
 749         'paymask', 'varchar', 'NULL', $char_d, '', '',
 750         #'paydate',  @date_type, '', '',
 751         'paydate',  'varchar', 'NULL', 10, '', '',
 752         'paystart_month', 'int', 'NULL', '', '', '',
 753         'paystart_year',  'int', 'NULL', '', '', '',
 754         'payissue', 'varchar', 'NULL', 2, '', '',
 755         'payname',  'varchar', 'NULL', $char_d, '', '',
 756         'paystate', 'varchar', 'NULL', $char_d, '', '',
 757         'paytype',  'varchar', 'NULL', $char_d, '', '',
 758         'payip',    'varchar', 'NULL', 15, '', '',
 759         'geocode',  'varchar', 'NULL', 20,  '', '',
 760         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
 761         'tax',      'char', 'NULL', 1, '', '',
 762         'otaker',   'varchar', 'NULL',    32, '', '',
 763         'usernum',   'int', 'NULL', '', '', '',
 764         'refnum',   'int',  '',     '', '', '',
 765         'referral_custnum', 'int',  'NULL', '', '', '',
 766         'comments', 'text', 'NULL', '', '', '',
 767         'spool_cdr','char', 'NULL', 1, '', '',
 768         'squelch_cdr','char', 'NULL', 1, '', '',
 769         'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
 770         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 771         'credit_limit', @money_typen, '', '',
 772         'archived', 'char', 'NULL', 1, '', '',
 773         'email_csv_cdr', 'char', 'NULL', 1, '', '',
 774       ],
 775       'primary_key' => 'custnum',
 776       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 777       #'index' => [ ['last'], ['company'] ],
 778       'index' => [
 779                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
 780                    [ 'custbatch' ],
 781                    [ 'referral_custnum' ],
 782                    [ 'payby' ], [ 'paydate' ],
 783                    [ 'archived' ],
 784                    #billing
 785                    [ 'last' ], [ 'company' ],
 786                    [ 'county' ], [ 'state' ], [ 'country' ],
 787                    [ 'zip' ],
 788                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 789                    #shipping
 790                    [ 'ship_last' ], [ 'ship_company' ],
 791                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 792                    [ 'ship_zip' ],
 793                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 794                  ],
 795     },
 796
 797     'cust_recon' => {  # what purpose does this serve?
 798       'columns' => [
 799         'reconid',      'serial',  '',          '', '', '',
 800         'recondate',    @date_type,                 '', '',
 801         'custnum',      'int'   ,  '',          '', '', '',
 802         'agentnum',     'int',     '',          '', '', '',
 803         'last',         'varchar', '',     $char_d, '', '',
 804         'first',        'varchar', '',     $char_d, '', '',
 805         'address1',     'varchar', '',     $char_d, '', '',
 806         'address2',     'varchar', 'NULL', $char_d, '', '',
 807         'city',         'varchar', '',     $char_d, '', '',
 808         'state',        'varchar', 'NULL', $char_d, '', '',
 809         'zip',          'varchar', 'NULL',      10, '', '',
 810         'pkg',          'varchar', 'NULL', $char_d, '', '',
 811         'adjourn',      @date_type,                 '', '',
 812         'status',       'varchar', 'NULL',      10, '', '',
 813         'agent_custid', 'varchar',  '',    $char_d, '', '',
 814         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 815         'agent_adjourn', @date_type,                '', '',
 816         'comments',     'text',    'NULL',      '', '', '',
 817       ],
 818       'primary_key' => 'reconid',
 819       'unique' => [],
 820       'index' => [],
 821     },
 822
 823     #eventually for cust_main too
 824     'contact' => {
 825       'columns' => [
 826         'contactnum', 'serial',     '',      '', '', '',
 827         'prospectnum',   'int', 'NULL',      '', '', '',
 828         'custnum',       'int', 'NULL',      '', '', '',
 829         'locationnum',   'int', 'NULL',      '', '', '', #not yet
 830 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
 831         'last',      'varchar',     '', $char_d, '', '',
 832 #        'middle',    'varchar', 'NULL', $char_d, '', '',
 833         'first',     'varchar',     '', $char_d, '', '',
 834         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
 835         'comment',   'varchar', 'NULL', $char_d, '', '',
 836         'disabled',     'char', 'NULL',       1, '', '',
 837       ],
 838       'primary_key' => 'contactnum',
 839       'unique'      => [],
 840       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
 841                          [ 'last' ], [ 'first' ],
 842                        ],
 843     },
 844
 845     'contact_phone' => {
 846       'columns' => [
 847         'contactphonenum', 'serial',     '', '', '', '',
 848         'contactnum',         'int',     '', '', '', '',
 849         'phonetypenum',       'int',     '', '', '', '',
 850         'countrycode',    'varchar',     '',  3, '', '',
 851         'phonenum',       'varchar',     '', 14, '', '',
 852         'extension',      'varchar', 'NULL',  7, '', '',
 853         #?#'comment',        'varchar',     '', $char_d, '', '',
 854       ],
 855       'primary_key' => 'contactphonenum',
 856       'unique'      => [],
 857       'index'       => [],
 858     },
 859
 860     'phone_type' => {
 861       'columns' => [
 862         'phonetypenum',  'serial', '',      '', '', '',
 863         'typename',     'varchar', '', $char_d, '', '',
 864         'weight',           'int', '',      '', '', '',
 865       ],
 866       'primary_key' => 'phonetypenum',
 867       'unique'      => [ [ 'typename' ], ],
 868       'index'       => [],
 869     },
 870
 871     'contact_email' => {
 872       'columns' => [
 873         'contactemailnum', 'serial', '',      '', '', '',
 874         'contactnum',         'int', '',      '', '', '',
 875         'emailaddress',   'varchar', '', $char_d, '', '',
 876       ],
 877       'primary_key' => 'contactemailnum',
 878       'unique'      => [ [ 'emailaddress' ], ],
 879       'index'       => [],
 880     },
 881
 882     'prospect_main' => {
 883       'columns' => [
 884         'prospectnum',  'serial',     '',      '', '', '',
 885         'agentnum',        'int',     '',      '', '', '',
 886         'company',     'varchar',     '', $char_d, '', '',
 887         #'disabled',     'char', 'NULL',       1, '', '',
 888       ],
 889       'primary_key' => 'prospectnum',
 890       'unique'      => [],
 891       'index'       => [ [ 'company' ], [ 'agentnum' ], ],
 892     },
 893
 894     #eventually use for billing & ship from cust_main too
 895     #for now, just cust_pkg locations
 896     'cust_location' => { #'location' now that its prospects too, but...
 897       'columns' => [
 898         'locationnum',  'serial',     '',      '', '', '',
 899         'prospectnum',     'int', 'NULL',      '', '', '',
 900         'custnum',         'int', 'NULL',      '', '', '',
 901         'address1',    'varchar',     '', $char_d, '', '',
 902         'address2',    'varchar', 'NULL', $char_d, '', '',
 903         'city',        'varchar',     '', $char_d, '', '',
 904         'county',      'varchar', 'NULL', $char_d, '', '',
 905         'state',       'varchar', 'NULL', $char_d, '', '',
 906         'zip',         'varchar', 'NULL',      10, '', '',
 907         'country',        'char',     '',       2, '', '',
 908         'geocode',     'varchar', 'NULL',      20, '', '',
 909         'disabled',       'char', 'NULL',       1, '', '',
 910       ],
 911       'primary_key' => 'locationnum',
 912       'unique'      => [],
 913       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
 914                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 915                        ],
 916     },
 917
 918     'cust_main_invoice' => {
 919       'columns' => [
 920         'destnum',  'serial',  '',     '', '', '',
 921         'custnum',  'int',  '',     '', '', '',
 922         'dest',     'varchar', '',  $char_d, '', '',
 923       ],
 924       'primary_key' => 'destnum',
 925       'unique' => [],
 926       'index' => [ ['custnum'], ],
 927     },
 928
 929     'cust_main_note' => {
 930       'columns' => [
 931         'notenum',  'serial',  '',     '', '', '',
 932         'custnum',  'int',  '',     '', '', '',
 933         '_date',    @date_type, '', '',
 934         'otaker',   'varchar', 'NULL',    32, '', '',
 935         'usernum',   'int', 'NULL', '', '', '',
 936         'comments', 'text', 'NULL', '', '', '',
 937       ],
 938       'primary_key' => 'notenum',
 939       'unique' => [],
 940       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
 941     },
 942
 943     'cust_category' => {
 944       'columns' => [
 945         'categorynum',   'serial',  '', '', '', '',
 946         'categoryname',  'varchar', '', $char_d, '', '',
 947         'weight',         'int', 'NULL',  '', '', '',
 948         'disabled',      'char', 'NULL',   1, '', '',
 949       ],
 950       'primary_key' => 'categorynum',
 951       'unique' => [],
 952       'index' => [ ['disabled'] ],
 953     },
 954
 955     'cust_class' => {
 956       'columns' => [
 957         'classnum',    'serial',   '',      '', '', '',
 958         'classname',   'varchar',  '', $char_d, '', '',
 959         'categorynum', 'int',  'NULL',      '', '', '',
 960         'disabled',    'char', 'NULL',       1, '', '',
 961       ],
 962       'primary_key' => 'classnum',
 963       'unique' => [],
 964       'index' => [ ['disabled'] ],
 965     },
 966
 967     'cust_tag' => {
 968       'columns' => [
 969         'custtagnum', 'serial', '', '', '', '',
 970         'custnum',       'int', '', '', '', '',
 971         'tagnum',        'int', '', '', '', '',
 972       ],
 973       'primary_key' => 'custtagnum',
 974       'unique'      => [ [ 'custnum', 'tagnum' ] ],
 975       'index'       => [ [ 'custnum' ] ],
 976     },
 977
 978     'part_tag' => {
 979       'columns' => [
 980         'tagnum',    'serial',     '',      '', '', '',
 981         'tagname',  'varchar',     '', $char_d, '', '',
 982         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
 983         'tagcolor', 'varchar', 'NULL',       6, '', '',
 984         'disabled',    'char', 'NULL',       1, '', '',
 985       ],
 986       'primary_key' => 'tagnum',
 987       'unique'      => [], #[ [ 'tagname' ] ], #?
 988       'index'       => [ [ 'disabled' ] ],
 989     },
 990
 991     'cust_main_exemption' => {
 992       'columns' => [
 993         'exemptionnum', 'serial', '',      '', '', '',
 994         'custnum',         'int', '',      '', '', '',
 995         'taxname',     'varchar', '', $char_d, '', '',
 996         #start/end dates?  for reporting?
 997       ],
 998       'primary_key' => 'exemptionnum',
 999       'unique'      => [],
1000       'index'       => [ [ 'custnum' ] ],
1001     },
1002
1003     'cust_tax_adjustment' => {
1004       'columns' => [
1005         'adjustmentnum', 'serial',     '',      '', '', '',
1006         'custnum',          'int',     '',      '', '', '',
1007         'taxname',      'varchar',     '', $char_d, '', '',
1008         'amount',    @money_type,                   '', '',
1009         'comment',     'varchar',  'NULL', $char_d, '', '',
1010         'billpkgnum',       'int', 'NULL',      '', '', '',
1011         #more?  no cust_bill_pkg_tax_location?
1012       ],
1013       'primary_key' => 'adjustmentnum',
1014       'unique'      => [],
1015       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1016     },
1017
1018     'cust_main_county' => { #county+state+country are checked off the
1019                             #cust_main_county for validation and to provide
1020                             # a tax rate.
1021       'columns' => [
1022         'taxnum',   'serial',   '',    '', '', '',
1023         'city',     'varchar',  'NULL',    $char_d, '', '',
1024         'county',   'varchar',  'NULL',    $char_d, '', '',
1025         'state',    'varchar',  'NULL',    $char_d, '', '',
1026         'country',  'char',  '', 2, '', '',
1027         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1028         'exempt_amount', @money_type, '', '',
1029         'tax',      'real',  '',    '', '', '', #tax %
1030         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1031         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1032         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1033       ],
1034       'primary_key' => 'taxnum',
1035       'unique' => [],
1036   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1037       'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
1038                    [ 'taxclass' ],
1039                  ],
1040     },
1041
1042     'tax_rate'    => {
1043       'columns' => [
1044         'taxnum',       'serial',     '',      '', '', '',
1045         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1046         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1047         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1048         'taxclassnum', 'int',      '',      '', '', '',
1049         'effective_date', @date_type, '', '',
1050         'tax',        @taxrate_type,      '', '',        # tax %
1051         'excessrate', @taxrate_typen,     '', '',        # second tax %
1052         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1053         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1054         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1055         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1056         'unittype',    'int',  'NULL', '', '', '',      # for fee
1057         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1058         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1059         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1060         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1061         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1062         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1063         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1064         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1065         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1066         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1067         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1068         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1069         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1070         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1071         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1072         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1073       ],
1074       'primary_key' => 'taxnum',
1075       'unique' => [],
1076       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1077     },
1078
1079     'tax_rate_location' => {
1080       'columns' => [
1081         'taxratelocationnum', 'serial',  '',     '', '', '',
1082         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1083         'geocode',            'varchar', '',     20,      '', '',
1084         'city',               'varchar', 'NULL', $char_d, '', '',
1085         'county',             'varchar', 'NULL', $char_d, '', '',
1086         'state',              'char',    'NULL',       2, '', '',
1087         'disabled',           'char',    'NULL', 1, '', '',
1088       ],
1089       'primary_key' => 'taxratelocationnum',
1090       'unique' => [],
1091       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1092     },
1093
1094     'cust_tax_location' => {
1095       'columns' => [
1096         'custlocationnum', 'serial',  '',     '', '', '',
1097         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1098         'city',            'varchar', 'NULL', $char_d, '', '',
1099         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1100         'county',          'varchar', 'NULL', $char_d, '', '',
1101         'zip',             'char',    '',     5,  '', '',
1102         'state',           'char',    '',     2,  '', '',
1103         'plus4hi',         'char',    'NULL', 4,  '', '',
1104         'plus4lo',         'char',    'NULL', 4,  '', '',
1105         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1106         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1107         'geocode',         'varchar', '',    20,  '', '',
1108       ],
1109       'primary_key' => 'custlocationnum',
1110       'unique' => [],
1111       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1112     },
1113
1114     'tax_class' => {
1115       'columns' => [
1116         'taxclassnum',  'serial',  '',            '', '', '',
1117         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1118         'taxclass',     'varchar', '',       $char_d, '', '',
1119         'description',  'varchar', '',     2*$char_d, '', '',
1120       ],
1121       'primary_key' => 'taxclassnum',
1122       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1123       'index' => [],
1124     },
1125
1126     'cust_pay_pending' => {
1127       'columns' => [
1128         'paypendingnum','serial',      '',  '', '', '',
1129         'custnum',      'int',         '',  '', '', '',
1130         'paid',         @money_type,            '', '',
1131         '_date',        @date_type,             '', '',
1132         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1133                                                         # be index into payby
1134                                                         # table eventually
1135         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1136         'paymask',      'varchar', 'NULL', $char_d, '', '',
1137         'paydate',      'varchar', 'NULL', 10, '', '',
1138         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1139         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1140         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1141
1142         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1143         'status',       'varchar',     '', $char_d, '', '',
1144         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1145         'statustext',   'text',    'NULL',  '', '', '',
1146         'gatewaynum',   'int',     'NULL',  '', '', '',
1147         #'cust_balance', @money_type,            '', '',
1148         'paynum',       'int',     'NULL',  '', '', '',
1149         'jobnum',       'int',     'NULL',  '', '', '',
1150       ],
1151       'primary_key' => 'paypendingnum',
1152       'unique'      => [ [ 'payunique' ] ],
1153       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1154     },
1155
1156     'cust_pay' => {
1157       'columns' => [
1158         'paynum',   'serial',    '',   '', '', '',
1159         'custnum',  'int',    '',   '', '', '',
1160         '_date',    @date_type, '', '',
1161         'paid',     @money_type, '', '',
1162         'otaker',   'varchar', 'NULL', 32, '', '',
1163         'usernum',   'int', 'NULL', '', '', '',
1164         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1165                                                  # index into payby table
1166                                                  # eventually
1167         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1168         'paymask', 'varchar', 'NULL', $char_d, '', '',
1169         'paydate',  'varchar', 'NULL', 10, '', '',
1170         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1171         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1172         'closed',    'char', 'NULL', 1, '', '',
1173         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1174       ],
1175       'primary_key' => 'paynum',
1176       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1177       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1178     },
1179
1180     'cust_pay_void' => {
1181       'columns' => [
1182         'paynum',    'int',    '',   '', '', '',
1183         'custnum',   'int',    '',   '', '', '',
1184         'paid',      @money_type, '', '',
1185         '_date',     @date_type, '', '',
1186         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1187                                                   # index into payby table
1188                                                   # eventually
1189         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1190         'paymask', 'varchar', 'NULL', $char_d, '', '',
1191         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1192         'closed',    'char', 'NULL', 1, '', '',
1193         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1194         'void_date', @date_type, '', '',
1195         'reason',    'varchar',   'NULL', $char_d, '', '',
1196         'otaker',   'varchar', 'NULL', 32, '', '',
1197         'usernum',   'int', 'NULL', '', '', '',
1198         'void_usernum',   'int', 'NULL', '', '', '',
1199       ],
1200       'primary_key' => 'paynum',
1201       'unique' => [],
1202       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1203     },
1204
1205     'cust_bill_pay' => {
1206       'columns' => [
1207         'billpaynum', 'serial',     '',   '', '', '',
1208         'invnum',  'int',     '',   '', '', '',
1209         'paynum',  'int',     '',   '', '', '',
1210         'amount',  @money_type, '', '',
1211         '_date',   @date_type, '', '',
1212         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1213       ],
1214       'primary_key' => 'billpaynum',
1215       'unique' => [],
1216       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1217     },
1218
1219     'cust_bill_pay_batch' => {
1220       'columns' => [
1221         'billpaynum', 'serial',     '',   '', '', '',
1222         'invnum',  'int',     '',   '', '', '',
1223         'paybatchnum',  'int',     '',   '', '', '',
1224         'amount',  @money_type, '', '',
1225         '_date',   @date_type, '', '',
1226       ],
1227       'primary_key' => 'billpaynum',
1228       'unique' => [],
1229       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1230     },
1231
1232     'cust_bill_pay_pkg' => {
1233       'columns' => [
1234         'billpaypkgnum', 'serial', '', '', '', '',
1235         'billpaynum',       'int', '', '', '', '',
1236         'billpkgnum',       'int', '', '', '', '',
1237         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1238         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1239         'amount',         @money_type,     '', '',
1240         'setuprecur',      'varchar', '', $char_d, '', '',
1241         'sdate',   @date_type, '', '',
1242         'edate',   @date_type, '', '',
1243       ],
1244       'primary_key' => 'billpaypkgnum',
1245       'unique'      => [],
1246       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1247     },
1248
1249     'pay_batch' => { #batches of payments to an external processor
1250       'columns' => [
1251         'batchnum',   'serial',    '',   '', '', '',
1252         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1253         'status',     'char', 'NULL',     1, '', '',
1254         'download',   @date_type, '', '',
1255         'upload',     @date_type, '', '',
1256       ],
1257       'primary_key' => 'batchnum',
1258       'unique' => [],
1259       'index' => [],
1260     },
1261
1262     'cust_pay_batch' => { #what's this used for again?  list of customers
1263                           #in current CARD batch? (necessarily CARD?)
1264       'columns' => [
1265         'paybatchnum',   'serial',    '',   '', '', '',
1266         'batchnum',   'int',    '',   '', '', '',
1267         'invnum',   'int',    '',   '', '', '',
1268         'custnum',   'int',    '',   '', '', '',
1269         'last',     'varchar', '',     $char_d, '', '',
1270         'first',    'varchar', '',     $char_d, '', '',
1271         'address1', 'varchar', '',     $char_d, '', '',
1272         'address2', 'varchar', 'NULL', $char_d, '', '',
1273         'city',     'varchar', '',     $char_d, '', '',
1274         'state',    'varchar', 'NULL', $char_d, '', '',
1275         'zip',      'varchar', 'NULL', 10, '', '',
1276         'country',  'char', '',     2, '', '',
1277         #        'trancode', 'int', '', '', '', ''
1278         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1279         'payinfo',  'varchar', '',     512, '', '',
1280         #'exp',      @date_type, '', ''
1281         'exp',      'varchar', 'NULL',     11, '', '',
1282         'payname',  'varchar', 'NULL', $char_d, '', '',
1283         'amount',   @money_type, '', '',
1284         'status',   'varchar', 'NULL',     $char_d, '', '',
1285       ],
1286       'primary_key' => 'paybatchnum',
1287       'unique' => [],
1288       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1289     },
1290
1291     'cust_pkg' => {
1292       'columns' => [
1293         'pkgnum',           'serial',     '', '', '', '',
1294         'custnum',             'int',     '', '', '', '',
1295         'pkgpart',             'int',     '', '', '', '',
1296         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1297         'locationnum',         'int', 'NULL', '', '', '',
1298         'otaker',          'varchar', 'NULL', 32, '', '',
1299         'usernum',             'int', 'NULL', '', '', '',
1300         'order_date',     @date_type,             '', '',
1301         'start_date',     @date_type,             '', '',
1302         'setup',          @date_type,             '', '',
1303         'bill',           @date_type,             '', '',
1304         'last_bill',      @date_type,             '', '',
1305         'susp',           @date_type,             '', '',
1306         'adjourn',        @date_type,             '', '',
1307         'cancel',         @date_type,             '', '',
1308         'expire',         @date_type,             '', '',
1309         'contract_end',   @date_type,             '', '',
1310         'change_date',    @date_type,             '', '',
1311         'change_pkgnum',       'int', 'NULL', '', '', '',
1312         'change_pkgpart',      'int', 'NULL', '', '', '',
1313         'change_locationnum',  'int', 'NULL', '', '', '',
1314         'manual_flag',        'char', 'NULL',  1, '', '',
1315         'no_auto',            'char', 'NULL',  1, '', '',
1316         'quantity',            'int', 'NULL', '', '', '',
1317       ],
1318       'primary_key' => 'pkgnum',
1319       'unique' => [],
1320       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1321                    [ 'usernum' ],
1322                    [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1323                    ['susp'], ['adjourn'], ['expire'], ['cancel'],
1324                    ['change_date'], ['order_date'],
1325                  ],
1326     },
1327
1328     'cust_pkg_option' => {
1329       'columns' => [
1330         'optionnum', 'serial', '', '', '', '',
1331         'pkgnum', 'int', '', '', '', '',
1332         'optionname', 'varchar', '', $char_d, '', '',
1333         'optionvalue', 'text', 'NULL', '', '', '',
1334       ],
1335       'primary_key' => 'optionnum',
1336       'unique'      => [],
1337       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1338     },
1339
1340     'cust_pkg_detail' => {
1341       'columns' => [
1342         'pkgdetailnum', 'serial', '',      '', '', '',
1343         'pkgnum',          'int', '',      '', '', '',
1344         'detail',      'varchar', '', $char_d, '', '',
1345         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1346         'weight',          'int', '',      '', '', '',
1347       ],
1348       'primary_key' => 'pkgdetailnum',
1349       'unique' => [],
1350       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1351     },
1352
1353     'cust_pkg_reason' => {
1354       'columns' => [
1355         'num',      'serial',    '',   '', '', '',
1356         'pkgnum',   'int',    '',   '', '', '',
1357         'reasonnum','int',    '',   '', '', '',
1358         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1359         'otaker',   'varchar', 'NULL', 32, '', '',
1360         'usernum',   'int', 'NULL', '', '', '',
1361         'date',     @date_type, '', '',
1362       ],
1363       'primary_key' => 'num',
1364       'unique' => [],
1365       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1366     },
1367
1368     'cust_pkg_discount' => {
1369       'columns' => [
1370         'pkgdiscountnum', 'serial', '',     '', '', '',
1371         'pkgnum',            'int', '',     '', '', '',
1372         'discountnum',       'int', '',     '', '', '',
1373         'months_used',   'decimal', 'NULL', '', '', '',
1374         'end_date',     @date_type,             '', '',
1375         'otaker',        'varchar', 'NULL', 32, '', '',
1376         'usernum',           'int', 'NULL', '', '', '',
1377         'disabled',         'char', 'NULL',  1, '', '',
1378       ],
1379       'primary_key' => 'pkgdiscountnum',
1380       'unique' => [],
1381       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1382     },
1383
1384     'cust_bill_pkg_discount' => {
1385       'columns' => [
1386         'billpkgdiscountnum', 'serial',     '', '', '', '',
1387         'billpkgnum',            'int',     '', '', '', '',
1388         'pkgdiscountnum',        'int',     '', '', '', '',
1389         'amount',          @money_type,             '', '',
1390         'months',            'decimal', 'NULL', '', '', '',
1391       ],
1392       'primary_key' => 'billpkgdiscountnum',
1393       'unique' => [],
1394       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1395     },
1396
1397     'discount' => {
1398       'columns' => [
1399         'discountnum', 'serial',     '',      '', '', '',
1400         #'agentnum',       'int', 'NULL',      '', '', '',
1401         'name',       'varchar', 'NULL', $char_d, '', '',
1402         'amount',   @money_type,                  '', '',
1403         'percent',    'decimal',     '',      '', '', '',
1404         'months',     'decimal', 'NULL',      '', '', '',
1405         'disabled',      'char', 'NULL',       1, '', '',
1406       ],
1407       'primary_key' => 'discountnum',
1408       'unique' => [],
1409       'index'  => [], # [ 'agentnum' ], ],
1410     },
1411
1412     'cust_refund' => {
1413       'columns' => [
1414         'refundnum',    'serial',    '',   '', '', '',
1415         'custnum',  'int',    '',   '', '', '',
1416         '_date',        @date_type, '', '',
1417         'refund',       @money_type, '', '',
1418         'otaker',       'varchar',   'NULL',   32, '', '',
1419         'usernum',   'int', 'NULL', '', '', '',
1420         'reason',       'varchar',   '',   $char_d, '', '',
1421         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1422                                                      # be index into payby
1423                                                      # table eventually
1424         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1425         'paymask', 'varchar', 'NULL', $char_d, '', '',
1426         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1427         'closed',    'char', 'NULL', 1, '', '',
1428       ],
1429       'primary_key' => 'refundnum',
1430       'unique' => [],
1431       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1432     },
1433
1434     'cust_credit_refund' => {
1435       'columns' => [
1436         'creditrefundnum', 'serial',     '',   '', '', '',
1437         'crednum',  'int',     '',   '', '', '',
1438         'refundnum',  'int',     '',   '', '', '',
1439         'amount',  @money_type, '', '',
1440         '_date',   @date_type, '', '',
1441       ],
1442       'primary_key' => 'creditrefundnum',
1443       'unique' => [],
1444       'index' => [ ['crednum'], ['refundnum'] ],
1445     },
1446
1447
1448     'cust_svc' => {
1449       'columns' => [
1450         'svcnum',    'serial',    '',   '', '', '',
1451         'pkgnum',    'int',    'NULL',   '', '', '',
1452         'svcpart',   'int',    '',   '', '', '',
1453         'overlimit', @date_type, '', '',
1454       ],
1455       'primary_key' => 'svcnum',
1456       'unique' => [],
1457       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1458     },
1459
1460     'cust_svc_option' => {
1461       'columns' => [
1462         'optionnum',   'serial', '', '', '', '',
1463         'svcnum',      'int', '', '', '', '',
1464         'optionname',  'varchar', '', $char_d, '', '',
1465         'optionvalue', 'text', 'NULL', '', '', '',
1466       ],
1467       'primary_key' => 'optionnum',
1468       'unique'      => [],
1469       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1470     },
1471
1472     'part_pkg' => {
1473       'columns' => [
1474         'pkgpart',       'serial',    '',   '', '', '',
1475         'pkg',           'varchar',   '',   $char_d, '', '',
1476         'comment',       'varchar',   '',   $char_d, '', '',
1477         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1478         'setup',         @perl_type, '', '',
1479         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1480         'recur',         @perl_type, '', '',
1481         'setuptax',      'char', 'NULL', 1, '', '',
1482         'recurtax',      'char', 'NULL', 1, '', '',
1483         'plan',          'varchar', 'NULL', $char_d, '', '',
1484         'plandata',      'text', 'NULL', '', '', '',
1485         'disabled',      'char', 'NULL', 1, '', '',
1486         'custom',        'char', 'NULL', 1, '', '',
1487         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1488         'classnum',      'int',     'NULL', '', '', '',
1489         'addon_classnum','int',     'NULL', '', '', '',
1490         'taxproductnum', 'int',     'NULL', '', '', '',
1491         'setup_cost',    @money_typen,          '', '',
1492         'recur_cost',    @money_typen,          '', '',
1493         'pay_weight',    'real',    'NULL', '', '', '',
1494         'credit_weight', 'real',    'NULL', '', '', '',
1495         'agentnum',      'int',     'NULL', '', '', '',
1496         'fcc_ds0s',      'int',     'NULL', '', '', '',
1497         'no_auto',      'char',     'NULL',  1, '', '',
1498       ],
1499       'primary_key' => 'pkgpart',
1500       'unique' => [],
1501       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1502                    [ 'agentnum' ],
1503                  ],
1504     },
1505
1506     'part_pkg_link' => {
1507       'columns' => [
1508         'pkglinknum',  'serial',   '',      '', '', '',
1509         'src_pkgpart', 'int',      '',      '', '', '',
1510         'dst_pkgpart', 'int',      '',      '', '', '',
1511         'link_type',   'varchar',  '', $char_d, '', '',
1512         'hidden',      'char', 'NULL',       1, '', '',
1513       ],
1514       'primary_key' => 'pkglinknum',
1515       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1516       'index'  => [ [ 'src_pkgpart' ] ],
1517     },
1518     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1519     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1520
1521     'part_pkg_discount' => {
1522       'columns' => [
1523         'pkgdiscountnum', 'serial',   '',      '', '', '',
1524         'pkgpart',        'int',      '',      '', '', '',
1525         'discountnum',    'int',      '',      '', '', '',
1526       ],
1527       'primary_key' => 'pkgdiscountnum',
1528       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
1529       'index'  => [],
1530     },
1531
1532     'part_pkg_taxclass' => {
1533       'columns' => [
1534         'taxclassnum',  'serial', '',       '', '', '',
1535         'taxclass',     'varchar', '', $char_d, '', '',
1536         'disabled', 'char',   'NULL',         1, '', '',
1537       ],
1538       'primary_key' => 'taxclassnum',
1539       'unique'      => [ [ 'taxclass' ] ],
1540       'index'       => [ [ 'disabled' ] ],
1541     },
1542
1543     'part_pkg_taxproduct' => {
1544       'columns' => [
1545         'taxproductnum', 'serial',      '',        '', '', '',
1546         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1547         'taxproduct',    'varchar',     '',   $char_d, '', '',
1548         'description',   'varchar',     '', 3*$char_d, '', '',
1549       ],
1550       'primary_key' => 'taxproductnum',
1551       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1552       'index'       => [],
1553     },
1554
1555     'part_pkg_taxrate' => {
1556       'columns' => [
1557         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1558         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1559         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1560         'taxproductnum', 'int',  '',     '',       '', '',
1561         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1562         'county',           'varchar', 'NULL', $char_d, '', '',
1563         'state',            'varchar', 'NULL', $char_d, '', '',
1564         'local',            'varchar', 'NULL', $char_d, '', '',
1565         'country',          'char',    'NULL', 2,       '', '',
1566         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1567         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1568         'taxclassnum',      'int',     'NULL', '',      '', '',
1569         'effdate',          @date_type, '', '',
1570         'taxable',          'char',    'NULL', 1,       '', '',
1571       ],
1572       'primary_key' => 'pkgtaxratenum',
1573       'unique' => [],
1574       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1575     },
1576
1577     'part_pkg_taxoverride' => {
1578       'columns' => [
1579         'taxoverridenum', 'serial', '', '', '', '',
1580         'pkgpart',           'int', '', '', '', '',
1581         'taxclassnum',       'int', '', '', '', '',
1582         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1583       ],
1584       'primary_key' => 'taxoverridenum',
1585       'unique' => [],
1586       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1587     },
1588
1589 #    'part_title' => {
1590 #      'columns' => [
1591 #        'titlenum',   'int',    '',   '',
1592 #        'title',      'varchar',   '',   $char_d,
1593 #      ],
1594 #      'primary_key' => 'titlenum',
1595 #      'unique' => [ [] ],
1596 #      'index' => [ [] ],
1597 #    },
1598
1599     'pkg_svc' => {
1600       'columns' => [
1601         'pkgsvcnum',  'serial', '',  '', '', '',
1602         'pkgpart',    'int',    '',   '', '', '',
1603         'svcpart',    'int',    '',   '', '', '',
1604         'quantity',   'int',    '',   '', '', '',
1605         'primary_svc','char', 'NULL',  1, '', '',
1606         'hidden',     'char', 'NULL',  1, '', '',
1607       ],
1608       'primary_key' => 'pkgsvcnum',
1609       'unique' => [ ['pkgpart', 'svcpart'] ],
1610       'index' => [ ['pkgpart'], ['quantity'] ],
1611     },
1612
1613     'part_referral' => {
1614       'columns' => [
1615         'refnum',   'serial',     '',        '', '', '',
1616         'referral', 'varchar',    '',   $char_d, '', '',
1617         'disabled', 'char',   'NULL',         1, '', '',
1618         'agentnum', 'int',    'NULL',        '', '', '',
1619       ],
1620       'primary_key' => 'refnum',
1621       'unique' => [],
1622       'index' => [ ['disabled'], ['agentnum'], ],
1623     },
1624
1625     'part_svc' => {
1626       'columns' => [
1627         'svcpart',    'serial',    '',   '', '', '',
1628         'svc',        'varchar',   '',   $char_d, '', '',
1629         'svcdb',      'varchar',   '',   $char_d, '', '',
1630         'disabled',   'char',  'NULL',   1, '', '',
1631       ],
1632       'primary_key' => 'svcpart',
1633       'unique' => [],
1634       'index' => [ [ 'disabled' ] ],
1635     },
1636
1637     'part_svc_column' => {
1638       'columns' => [
1639         'columnnum',   'serial',         '', '', '', '',
1640         'svcpart',     'int',         '', '', '', '',
1641         'columnname',  'varchar',     '', 64, '', '',
1642         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1643         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1644         'columnflag',  'char',    'NULL', 1, '', '',
1645       ],
1646       'primary_key' => 'columnnum',
1647       'unique' => [ [ 'svcpart', 'columnname' ] ],
1648       'index' => [ [ 'svcpart' ] ],
1649     },
1650
1651     #(this should be renamed to part_pop)
1652     'svc_acct_pop' => {
1653       'columns' => [
1654         'popnum',    'serial',    '',   '', '', '',
1655         'city',      'varchar',   '',   $char_d, '', '',
1656         'state',     'varchar',   '',   $char_d, '', '',
1657         'ac',        'char',   '',   3, '', '',
1658         'exch',      'char',   '',   3, '', '',
1659         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1660       ],
1661       'primary_key' => 'popnum',
1662       'unique' => [],
1663       'index' => [ [ 'state' ] ],
1664     },
1665
1666     'part_pop_local' => {
1667       'columns' => [
1668         'localnum',  'serial',     '',     '', '', '',
1669         'popnum',    'int',     '',     '', '', '',
1670         'city',      'varchar', 'NULL', $char_d, '', '',
1671         'state',     'char',    'NULL', 2, '', '',
1672         'npa',       'char',    '',     3, '', '',
1673         'nxx',       'char',    '',     3, '', '',
1674       ],
1675       'primary_key' => 'localnum',
1676       'unique' => [],
1677       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1678     },
1679
1680     'svc_acct' => {
1681       'columns' => [
1682         'svcnum',    'int',    '',   '', '', '',
1683         'username',  'varchar',   '',   $username_len, '', '',
1684         '_password', 'varchar',   'NULL',  512, '', '',
1685         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1686         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1687         'popnum',    'int',    'NULL',   '', '', '',
1688         'uid',       'int', 'NULL',   '', '', '',
1689         'gid',       'int', 'NULL',   '', '', '',
1690         'finger',    'varchar',   'NULL',   $char_d, '', '',
1691         'dir',       'varchar',   'NULL',   $char_d, '', '',
1692         'shell',     'varchar',   'NULL',   $char_d, '', '',
1693         'quota',     'varchar',   'NULL',   $char_d, '', '',
1694         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1695         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1696         'seconds_threshold',   'int', 'NULL',   '', '', '',
1697         'upbytes',   'bigint', 'NULL',   '', '', '',
1698         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1699         'downbytes', 'bigint', 'NULL',   '', '', '',
1700         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1701         'totalbytes','bigint', 'NULL',   '', '', '',
1702         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1703         'domsvc',    'int',     '', '', '', '',
1704         'pbxsvc',    'int', 'NULL', '', '', '',
1705         'last_login',  @date_type, '', '',
1706         'last_logout', @date_type, '', '',
1707         #cardfortress field(s)
1708         'cf_privatekey',      'text', 'NULL',      '', '', '',
1709         #communigate pro fields (quota = MaxAccountSize)
1710         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1711         #settings
1712         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1713         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1714         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1715         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1716         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1717         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1718         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1719         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1720         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1721         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1722         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1723         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
1724         #XXX mailing lists
1725         #preferences
1726         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1727         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1728         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1729         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1730         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1731         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1732         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1733         #mail
1734         #XXX RPOP settings
1735       ],
1736       'primary_key' => 'svcnum',
1737       #'unique' => [ [ 'username', 'domsvc' ] ],
1738       'unique' => [],
1739       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1740     },
1741
1742     'acct_rt_transaction' => {
1743       'columns' => [
1744         'svcrtid',   'int',    '',   '', '', '',
1745         'svcnum',    'int',    '',   '', '', '',
1746         'transaction_id',       'int', '',   '', '', '',
1747         '_date',   @date_type, '', '',
1748         'seconds',   'int', '',   '', '', '', #uhhhh
1749         'support',   'int', '',   '', '', '',
1750       ],
1751       'primary_key' => 'svcrtid',
1752       'unique' => [],
1753       'index' => [ ['svcnum', 'transaction_id'] ],
1754     },
1755
1756     #'svc_charge' => {
1757     #  'columns' => [
1758     #    'svcnum',    'int',    '',   '',
1759     #    'amount',    @money_type,
1760     #  ],
1761     #  'primary_key' => 'svcnum',
1762     #  'unique' => [ [] ],
1763     #  'index' => [ [] ],
1764     #},
1765
1766     'svc_domain' => {
1767       'columns' => [
1768         'svcnum',           'int',    '',        '', '', '',
1769         'domain',       'varchar',    '',   $char_d, '', '',
1770         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1771         'catchall',         'int', 'NULL',       '', '', '',
1772         'parent_svcnum',    'int', 'NULL',       '', '', '',
1773         'registrarnum',     'int', 'NULL',       '', '', '',
1774         'registrarkey', 'varchar', 'NULL',      512, '', '',
1775         'setup_date',      @date_type, '', '',
1776         'renewal_interval', 'int', 'NULL',       '', '', '',
1777         'expiration_date', @date_type, '', '',
1778         #communigate pro fields (quota = MaxAccountSize)
1779         'max_accounts',     'int', 'NULL',       '', '', '',
1780         'trailer',         'text', 'NULL',       '', '', '',
1781         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
1782         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
1783         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
1784         #settings
1785         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
1786         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
1787         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
1788         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
1789         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
1790         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
1791         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
1792         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
1793         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
1794         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
1795         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
1796         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
1797         #preferences
1798         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
1799         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
1800         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
1801         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
1802         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
1803         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
1804         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
1805       ],
1806       'primary_key' => 'svcnum',
1807       'unique' => [ ],
1808       'index' => [ ['domain'] ],
1809     },
1810
1811     'domain_record' => {
1812       'columns' => [
1813         'recnum',    'serial',     '',  '', '', '',
1814         'svcnum',    'int',     '',  '', '', '',
1815         'reczone',   'varchar', '',  255, '', '',
1816         'recaf',     'char',    '',  2, '', '',
1817         'rectype',   'varchar',    '',  5, '', '',
1818         'recdata',   'varchar', '',  255, '', '',
1819         'ttl',       'int',     'NULL', '', '', '',
1820       ],
1821       'primary_key' => 'recnum',
1822       'unique'      => [],
1823       'index'       => [ ['svcnum'] ],
1824     },
1825
1826     'registrar' => {
1827       'columns' => [
1828         'registrarnum',   'serial', '',      '', '', '',
1829         'registrarname', 'varchar', '', $char_d, '', '',
1830       ],
1831       'primary_key' => 'registrarnum',
1832       'unique'      => [],
1833       'index'       => [],
1834     },
1835
1836     'cgp_rule' => {
1837       'columns' => [
1838         'rulenum',  'serial',     '',      '', '', '',
1839         'name',    'varchar',     '', $char_d, '', '',
1840         'comment', 'varchar', 'NULL', $char_d, '', '',
1841         'svcnum',      'int',     '',      '', '', '',
1842         'priority',    'int',     '',      '', '', '',
1843       ],
1844       'primary_key' => 'rulenum',
1845       'unique'      => [ [ 'svcnum', 'name' ] ],
1846       'index'       => [ [ 'svcnum' ] ],
1847     },
1848
1849     'cgp_rule_condition' => {
1850       'columns' => [
1851         'ruleconditionnum',  'serial',     '',      '', '', '',
1852         'conditionname',    'varchar',     '', $char_d, '', '',
1853         'op',               'varchar', 'NULL', $char_d, '', '',
1854         'params',           'varchar', 'NULL',     255, '', '',
1855         'rulenum',              'int',     '',      '', '', '',
1856       ],
1857       'primary_key' => 'ruleconditionnum',
1858       'unique'      => [],
1859       'index'       => [ [ 'rulenum' ] ],
1860     },
1861
1862     'cgp_rule_action' => {
1863        'columns' => [
1864         'ruleactionnum',  'serial',     '',      '', '', '',
1865         'action',        'varchar',     '', $char_d, '', '',
1866         'params',        'varchar', 'NULL',     255, '', '',
1867         'rulenum',           'int',     '',      '', '', '',
1868       ],
1869       'primary_key' => 'ruleactionnum',
1870       'unique'      => [],
1871       'index'       => [ [ 'rulenum' ] ],
1872    },
1873
1874     'svc_forward' => {
1875       'columns' => [
1876         'svcnum',   'int',            '',   '', '', '',
1877         'srcsvc',   'int',        'NULL',   '', '', '',
1878         'src',      'varchar',    'NULL',  255, '', '',
1879         'dstsvc',   'int',        'NULL',   '', '', '',
1880         'dst',      'varchar',    'NULL',  255, '', '',
1881       ],
1882       'primary_key' => 'svcnum',
1883       'unique'      => [],
1884       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1885     },
1886
1887     'svc_www' => {
1888       'columns' => [
1889         'svcnum',   'int',      '',  '', '', '',
1890         'recnum',   'int',      '',  '', '', '',
1891         'usersvc',  'int',  'NULL',  '', '', '',
1892         'config',   'text', 'NULL',  '', '', '',
1893       ],
1894       'primary_key' => 'svcnum',
1895       'unique'      => [],
1896       'index'       => [],
1897     },
1898
1899     #'svc_wo' => {
1900     #  'columns' => [
1901     #    'svcnum',    'int',    '',   '',
1902     #    'svcnum',    'int',    '',   '',
1903     #    'svcnum',    'int',    '',   '',
1904     #    'worker',    'varchar',   '',   $char_d,
1905     #    '_date',     @date_type,
1906     #  ],
1907     #  'primary_key' => 'svcnum',
1908     #  'unique' => [ [] ],
1909     #  'index' => [ [] ],
1910     #},
1911
1912     'prepay_credit' => {
1913       'columns' => [
1914         'prepaynum',   'serial',     '',   '', '', '',
1915         'identifier',  'varchar', '', $char_d, '', '',
1916         'amount',      @money_type, '', '',
1917         'seconds',     'int',     'NULL', '', '', '',
1918         'upbytes',     'bigint',     'NULL', '', '', '',
1919         'downbytes',   'bigint',     'NULL', '', '', '',
1920         'totalbytes',  'bigint',     'NULL', '', '', '',
1921         'agentnum',    'int',     'NULL', '', '', '',
1922       ],
1923       'primary_key' => 'prepaynum',
1924       'unique'      => [ ['identifier'] ],
1925       'index'       => [],
1926     },
1927
1928     'port' => {
1929       'columns' => [
1930         'portnum',  'serial',     '',   '', '', '',
1931         'ip',       'varchar', 'NULL', 15, '', '',
1932         'nasport',  'int',     'NULL', '', '', '',
1933         'nasnum',   'int',     '',   '', '', '',
1934       ],
1935       'primary_key' => 'portnum',
1936       'unique'      => [],
1937       'index'       => [],
1938     },
1939
1940     'nas' => {
1941       'columns' => [
1942         'nasnum',   'serial',     '',    '', '', '',
1943         'nas',      'varchar', '',    $char_d, '', '',
1944         'nasip',    'varchar', '',    15, '', '',
1945         'nasfqdn',  'varchar', '',    $char_d, '', '',
1946         'last',     'int',     '',    '', '', '',
1947       ],
1948       'primary_key' => 'nasnum',
1949       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1950       'index'       => [ [ 'last' ] ],
1951     },
1952
1953 #    'session' => {
1954 #      'columns' => [
1955 #        'sessionnum', 'serial',       '',   '', '', '',
1956 #        'portnum',    'int',       '',   '', '', '',
1957 #        'svcnum',     'int',       '',   '', '', '',
1958 #        'login',      @date_type, '', '',
1959 #        'logout',     @date_type, '', '',
1960 #      ],
1961 #      'primary_key' => 'sessionnum',
1962 #      'unique'      => [],
1963 #      'index'       => [ [ 'portnum' ] ],
1964 #    },
1965
1966     'queue' => {
1967       'columns' => [
1968         'jobnum',      'serial',     '',      '', '', '',
1969         'job',        'varchar',     '',     512, '', '',
1970         '_date',          'int',     '',      '', '', '',
1971         'status',     'varchar',     '', $char_d, '', '',
1972         'statustext',    'text', 'NULL',      '', '', '',
1973         'svcnum',         'int', 'NULL',      '', '', '',
1974         'custnum',        'int', 'NULL',      '', '', '',
1975         'secure',        'char', 'NULL',       1, '', '',
1976         'priority',       'int', 'NULL',      '', '', '',
1977       ],
1978       'primary_key' => 'jobnum',
1979       'unique'      => [],
1980       'index'       => [ [ 'secure' ], [ 'priority' ],
1981                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1982                        ],
1983     },
1984
1985     'queue_arg' => {
1986       'columns' => [
1987         'argnum', 'serial', '', '', '', '',
1988         'jobnum', 'int', '', '', '', '',
1989         'frozen', 'char', 'NULL',       1, '', '',
1990         'arg', 'text', 'NULL', '', '', '',
1991       ],
1992       'primary_key' => 'argnum',
1993       'unique'      => [],
1994       'index'       => [ [ 'jobnum' ] ],
1995     },
1996
1997     'queue_depend' => {
1998       'columns' => [
1999         'dependnum', 'serial', '', '', '', '',
2000         'jobnum', 'int', '', '', '', '',
2001         'depend_jobnum', 'int', '', '', '', '',
2002       ],
2003       'primary_key' => 'dependnum',
2004       'unique'      => [],
2005       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2006     },
2007
2008     'export_svc' => {
2009       'columns' => [
2010         'exportsvcnum' => 'serial', '', '', '', '',
2011         'exportnum'    => 'int', '', '', '', '',
2012         'svcpart'      => 'int', '', '', '', '',
2013       ],
2014       'primary_key' => 'exportsvcnum',
2015       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2016       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2017     },
2018
2019     'export_device' => {
2020       'columns' => [
2021         'exportdevicenum' => 'serial', '', '', '', '',
2022         'exportnum'    => 'int', '', '', '', '',
2023         'devicepart'      => 'int', '', '', '', '',
2024       ],
2025       'primary_key' => 'exportdevicenum',
2026       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2027       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2028     },
2029
2030     'part_export' => {
2031       'columns' => [
2032         'exportnum', 'serial', '', '', '', '',
2033         'exportname', 'varchar', 'NULL', $char_d, '', '',
2034         'machine', 'varchar', '', $char_d, '', '',
2035         'exporttype', 'varchar', '', $char_d, '', '',
2036         'nodomain',     'char', 'NULL', 1, '', '',
2037       ],
2038       'primary_key' => 'exportnum',
2039       'unique'      => [],
2040       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2041     },
2042
2043     'part_export_option' => {
2044       'columns' => [
2045         'optionnum', 'serial', '', '', '', '',
2046         'exportnum', 'int', '', '', '', '',
2047         'optionname', 'varchar', '', $char_d, '', '',
2048         'optionvalue', 'text', 'NULL', '', '', '',
2049       ],
2050       'primary_key' => 'optionnum',
2051       'unique'      => [],
2052       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2053     },
2054
2055     'radius_usergroup' => {
2056       'columns' => [
2057         'usergroupnum', 'serial', '', '', '', '',
2058         'svcnum',       'int', '', '', '', '',
2059         'groupname',    'varchar', '', $char_d, '', '',
2060       ],
2061       'primary_key' => 'usergroupnum',
2062       'unique'      => [],
2063       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2064     },
2065
2066     'msgcat' => {
2067       'columns' => [
2068         'msgnum', 'serial', '', '', '', '',
2069         'msgcode', 'varchar', '', $char_d, '', '',
2070         'locale', 'varchar', '', 16, '', '',
2071         'msg', 'text', '', '', '', '',
2072       ],
2073       'primary_key' => 'msgnum',
2074       'unique'      => [ [ 'msgcode', 'locale' ] ],
2075       'index'       => [],
2076     },
2077
2078     'cust_tax_exempt' => {
2079       'columns' => [
2080         'exemptnum', 'serial', '', '', '', '',
2081         'custnum',   'int', '', '', '', '',
2082         'taxnum',    'int', '', '', '', '',
2083         'year',      'int', '', '', '', '',
2084         'month',     'int', '', '', '', '',
2085         'amount',   @money_type, '', '',
2086       ],
2087       'primary_key' => 'exemptnum',
2088       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2089       'index'       => [],
2090     },
2091
2092     'cust_tax_exempt_pkg' => {
2093       'columns' => [
2094         'exemptpkgnum',  'serial', '', '', '', '',
2095         #'custnum',      'int', '', '', '', ''
2096         'billpkgnum',   'int', '', '', '', '',
2097         'taxnum',       'int', '', '', '', '',
2098         'year',         'int', '', '', '', '',
2099         'month',        'int', '', '', '', '',
2100         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2101         'amount',       @money_type, '', '',
2102       ],
2103       'primary_key' => 'exemptpkgnum',
2104       'unique' => [],
2105       'index'  => [ [ 'taxnum', 'year', 'month' ],
2106                     [ 'billpkgnum' ],
2107                     [ 'taxnum' ],
2108                     [ 'creditbillpkgnum' ],
2109                   ],
2110     },
2111
2112     'router' => {
2113       'columns' => [
2114         'routernum', 'serial', '', '', '', '',
2115         'routername', 'varchar', '', $char_d, '', '',
2116         'svcnum', 'int', 'NULL', '', '', '',
2117         'agentnum',   'int', 'NULL', '', '', '',
2118       ],
2119       'primary_key' => 'routernum',
2120       'unique'      => [],
2121       'index'       => [],
2122     },
2123
2124     'part_svc_router' => {
2125       'columns' => [
2126         'svcrouternum', 'serial', '', '', '', '',
2127         'svcpart', 'int', '', '', '', '',
2128         'routernum', 'int', '', '', '', '',
2129       ],
2130       'primary_key' => 'svcrouternum',
2131       'unique'      => [],
2132       'index'       => [],
2133     },
2134
2135     'addr_block' => {
2136       'columns' => [
2137         'blocknum', 'serial', '', '', '', '',
2138         'routernum', 'int', '', '', '', '',
2139         'ip_gateway', 'varchar', '', 15, '', '',
2140         'ip_netmask', 'int', '', '', '', '',
2141         'agentnum',   'int', 'NULL', '', '', '',
2142         'manual_flag', 'char', 'NULL', 1, '', '',
2143       ],
2144       'primary_key' => 'blocknum',
2145       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2146       'index'       => [],
2147     },
2148
2149     'svc_broadband' => {
2150       'columns' => [
2151         'svcnum', 'int', '', '', '', '',
2152         'description', 'varchar', 'NULL', $char_d, '', '',
2153         'blocknum', 'int', 'NULL', '', '', '',
2154         'speed_up', 'int', '', '', '', '',
2155         'speed_down', 'int', '', '', '', '',
2156         'ip_addr', 'varchar', 'NULL', 15, '', '',
2157         'mac_addr', 'varchar', 'NULL', 12, '', '',
2158         'authkey',  'varchar', 'NULL', 32, '', '',
2159         'latitude', 'decimal', 'NULL', '', '', '',
2160         'longitude', 'decimal', 'NULL', '', '', '',
2161         'altitude', 'decimal', 'NULL', '', '', '',
2162         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
2163         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2164       ],
2165       'primary_key' => 'svcnum',
2166       'unique'      => [ [ 'mac_addr' ] ],
2167       'index'       => [],
2168     },
2169
2170     'part_virtual_field' => {
2171       'columns' => [
2172         'vfieldpart', 'serial', '', '', '', '',
2173         'dbtable', 'varchar', '', 32, '', '',
2174         'name', 'varchar', '', 32, '', '',
2175         'check_block', 'text', 'NULL', '', '', '',
2176         'length', 'int', 'NULL', '', '', '',
2177         'list_source', 'text', 'NULL', '', '', '',
2178         'label', 'varchar', 'NULL', 80, '', '',
2179       ],
2180       'primary_key' => 'vfieldpart',
2181       'unique' => [],
2182       'index' => [],
2183     },
2184
2185     'virtual_field' => {
2186       'columns' => [
2187         'vfieldnum', 'serial', '', '', '', '',
2188         'recnum', 'int', '', '', '', '',
2189         'vfieldpart', 'int', '', '', '', '',
2190         'value', 'varchar', '', 128, '', '',
2191       ],
2192       'primary_key' => 'vfieldnum',
2193       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2194       'index' => [],
2195     },
2196
2197     'acct_snarf' => {
2198       'columns' => [
2199         'snarfnum',    'serial',     '',      '', '', '',
2200         'snarfname',  'varchar', 'NULL', $char_d, '', '',
2201         'svcnum',         'int',     '',      '', '', '',
2202         'machine',    'varchar',     '',     255, '', '',
2203         'protocol',   'varchar',     '', $char_d, '', '',
2204         'username',   'varchar',     '', $char_d, '', '',
2205         '_password',  'varchar',     '', $char_d, '', '',
2206         'check_freq',     'int', 'NULL',      '', '', '',
2207         'leavemail',     'char', 'NULL',       1, '', '',
2208         'apop',          'char', 'NULL',       1, '', '',
2209         'tls',           'char', 'NULL',       1, '', '',
2210         'mailbox',    'varchar', 'NULL', $char_d, '', '',
2211       ],
2212       'primary_key' => 'snarfnum',
2213       'unique' => [],
2214       'index'  => [ [ 'svcnum' ] ],
2215     },
2216
2217     'svc_external' => {
2218       'columns' => [
2219         'svcnum', 'int', '', '', '', '',
2220         'id',     'int', 'NULL', '', '', '',
2221         'title',  'varchar', 'NULL', $char_d, '', '',
2222       ],
2223       'primary_key' => 'svcnum',
2224       'unique'      => [],
2225       'index'       => [],
2226     },
2227
2228     'cust_pay_refund' => {
2229       'columns' => [
2230         'payrefundnum', 'serial', '', '', '', '',
2231         'paynum',  'int', '', '', '', '',
2232         'refundnum',  'int', '', '', '', '',
2233         '_date',    @date_type, '', '',
2234         'amount',   @money_type, '', '',
2235       ],
2236       'primary_key' => 'payrefundnum',
2237       'unique' => [],
2238       'index' => [ ['paynum'], ['refundnum'] ],
2239     },
2240
2241     'part_pkg_option' => {
2242       'columns' => [
2243         'optionnum', 'serial', '', '', '', '',
2244         'pkgpart', 'int', '', '', '', '',
2245         'optionname', 'varchar', '', $char_d, '', '',
2246         'optionvalue', 'text', 'NULL', '', '', '',
2247       ],
2248       'primary_key' => 'optionnum',
2249       'unique'      => [],
2250       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2251     },
2252
2253     'part_pkg_report_option' => {
2254       'columns' => [
2255         'num',      'serial',   '',      '', '', '',
2256         'name',     'varchar',  '', $char_d, '', '',
2257         'disabled', 'char', 'NULL',       1, '', '',
2258       ],
2259       'primary_key' => 'num',
2260       'unique' => [ [ 'name' ] ],
2261       'index' => [ [ 'disabled' ] ],
2262     },
2263
2264     'rate' => {
2265       'columns' => [
2266         'ratenum',  'serial', '', '', '', '',
2267         'ratename', 'varchar', '', $char_d, '', '',
2268       ],
2269       'primary_key' => 'ratenum',
2270       'unique'      => [],
2271       'index'       => [],
2272     },
2273
2274     'rate_detail' => {
2275       'columns' => [
2276         'ratedetailnum',   'serial',  '',     '', '', '',
2277         'ratenum',         'int',     '',     '', '', '',
2278         'orig_regionnum',  'int', 'NULL',     '', '', '',
2279         'dest_regionnum',  'int',     '',     '', '', '',
2280         'min_included',    'int',     '',     '', '', '',
2281         'conn_charge',     'decimal', '', '10,4', '0', '',
2282         'conn_sec',        'int',     '',     '', '0', '',
2283         'min_charge',      'decimal', '', '10,5', '', '', #@money_type, '', '',
2284         'sec_granularity', 'int',     '',     '', '', '',
2285         'ratetimenum',     'int', 'NULL',     '', '', '',
2286         'classnum',        'int', 'NULL',     '', '', '',
2287       ],
2288       'primary_key' => 'ratedetailnum',
2289       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2290       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2291     },
2292
2293     'rate_region' => {
2294       'columns' => [
2295         'regionnum',   'serial',      '', '', '', '',
2296         'regionname',  'varchar',     '', $char_d, '', '',
2297       ],
2298       'primary_key' => 'regionnum',
2299       'unique'      => [],
2300       'index'       => [],
2301     },
2302
2303     'rate_prefix' => {
2304       'columns' => [
2305         'prefixnum',   'serial',      '', '', '', '',
2306         'regionnum',   'int',         '', '', '', '',
2307         'countrycode', 'varchar',     '',  3, '', '',
2308         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2309         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2310       ],
2311       'primary_key' => 'prefixnum',
2312       'unique'      => [],
2313       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2314     },
2315
2316     'rate_time' => {
2317       'columns' => [
2318         'ratetimenum', 'serial',      '',      '', '', '',
2319         'ratetimename',   'varchar',      '', $char_d, '', '',
2320       ],
2321       'primary_key' => 'ratetimenum',
2322       'unique'      => [],
2323       'index'       => [],
2324     },
2325
2326     'rate_time_interval' => {
2327       'columns' => [
2328         'intervalnum', 'serial', '', '', '', '',
2329         'stime',          'int', '', '', '', '',
2330         'etime',          'int', '', '', '', '',
2331         'ratetimenum',    'int', '', '', '', '',
2332       ],
2333       'primary_key' => 'intervalnum',
2334       'unique'      => [],
2335       'index'       => [],
2336     },
2337
2338     'usage_class' => {
2339       'columns' => [
2340         'classnum',    'serial',      '',      '', '', '',
2341         'weight',      'int',     'NULL',      '', '', '',
2342         'classname',   'varchar',     '', $char_d, '', '',
2343         'format',      'varchar', 'NULL', $char_d, '', '',
2344         'disabled',    'char',    'NULL',       1, '', '',
2345       ],
2346       'primary_key' => 'classnum',
2347       'unique' => [],
2348       'index' => [ ['disabled'] ],
2349     },
2350
2351     'reg_code' => {
2352       'columns' => [
2353         'codenum',   'serial',    '', '', '', '',
2354         'code',      'varchar',   '', $char_d, '', '',
2355         'agentnum',  'int',       '', '', '', '',
2356       ],
2357       'primary_key' => 'codenum',
2358       'unique'      => [ [ 'agentnum', 'code' ] ],
2359       'index'       => [ [ 'agentnum' ] ],
2360     },
2361
2362     'reg_code_pkg' => {
2363       'columns' => [
2364         'codepkgnum', 'serial', '', '', '', '',
2365         'codenum',   'int',    '', '', '', '',
2366         'pkgpart',   'int',    '', '', '', '',
2367       ],
2368       'primary_key' => 'codepkgnum',
2369       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2370       'index'       => [ [ 'codenum' ] ],
2371     },
2372
2373     'clientapi_session' => {
2374       'columns' => [
2375         'sessionnum',  'serial',  '', '', '', '',
2376         'sessionid',  'varchar',  '', $char_d, '', '',
2377         'namespace',  'varchar',  '', $char_d, '', '',
2378       ],
2379       'primary_key' => 'sessionnum',
2380       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2381       'index'       => [],
2382     },
2383
2384     'clientapi_session_field' => {
2385       'columns' => [
2386         'fieldnum',    'serial',     '', '', '', '',
2387         'sessionnum',     'int',     '', '', '', '',
2388         'fieldname',  'varchar',     '', $char_d, '', '',
2389         'fieldvalue',    'text', 'NULL', '', '', '',
2390       ],
2391       'primary_key' => 'fieldnum',
2392       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2393       'index'       => [],
2394     },
2395
2396     'payment_gateway' => {
2397       'columns' => [
2398         'gatewaynum',       'serial',   '',     '', '', '',
2399         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2400         'gateway_module',   'varchar',  '',     $char_d, '', '',
2401         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2402         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2403         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2404         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2405         'disabled',   'char',  'NULL',   1, '', '',
2406       ],
2407       'primary_key' => 'gatewaynum',
2408       'unique' => [],
2409       'index'  => [ [ 'disabled' ] ],
2410     },
2411
2412     'payment_gateway_option' => {
2413       'columns' => [
2414         'optionnum',   'serial',  '',     '', '', '',
2415         'gatewaynum',  'int',     '',     '', '', '',
2416         'optionname',  'varchar', '',     $char_d, '', '',
2417         'optionvalue', 'text',    'NULL', '', '', '',
2418       ],
2419       'primary_key' => 'optionnum',
2420       'unique'      => [],
2421       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2422     },
2423
2424     'agent_payment_gateway' => {
2425       'columns' => [
2426         'agentgatewaynum', 'serial', '', '', '', '',
2427         'agentnum',        'int', '', '', '', '',
2428         'gatewaynum',      'int', '', '', '', '',
2429         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2430         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2431       ],
2432       'primary_key' => 'agentgatewaynum',
2433       'unique'      => [],
2434       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2435     },
2436
2437     'banned_pay' => {
2438       'columns' => [
2439         'bannum',  'serial',   '',     '', '', '',
2440         'payby',   'char',     '',       4, '', '',
2441         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2442         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2443         '_date',   @date_type, '', '',
2444         'otaker',  'varchar',  'NULL',     32, '', '',
2445         'usernum',   'int', 'NULL', '', '', '',
2446         'reason',  'varchar',  'NULL', $char_d, '', '',
2447       ],
2448       'primary_key' => 'bannum',
2449       'unique'      => [ [ 'payby', 'payinfo' ] ],
2450       'index'       => [ [ 'usernum' ] ],
2451     },
2452
2453     'pkg_category' => {
2454       'columns' => [
2455         'categorynum',   'serial',  '', '', '', '',
2456         'categoryname',  'varchar', '', $char_d, '', '',
2457         'weight',         'int', 'NULL',  '', '', '',
2458         'condense',      'char', 'NULL',   1, '', '',
2459         'disabled',      'char', 'NULL',   1, '', '',
2460       ],
2461       'primary_key' => 'categorynum',
2462       'unique' => [],
2463       'index' => [ ['disabled'] ],
2464     },
2465
2466     'pkg_class' => {
2467       'columns' => [
2468         'classnum',    'serial',   '',      '', '', '',
2469         'classname',   'varchar',  '', $char_d, '', '',
2470         'categorynum', 'int',  'NULL',      '', '', '',
2471         'disabled',    'char', 'NULL',       1, '', '',
2472       ],
2473       'primary_key' => 'classnum',
2474       'unique' => [],
2475       'index' => [ ['disabled'] ],
2476     },
2477
2478     'cdr' => {
2479       'columns' => [
2480         # qw( name type null length default local );
2481
2482         ###
2483         #asterisk fields
2484         ###
2485
2486         'acctid',   'bigserial',  '', '', '', '',
2487         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2488         'calldate', 'timestamp',   '',      '', \'now()', '',
2489         'clid',        'varchar',  '', $char_d, \"''", '',
2490         'src',         'varchar',  '', $char_d, \"''", '',
2491         'dst',         'varchar',  '', $char_d, \"''", '',
2492         'dcontext',    'varchar',  '', $char_d, \"''", '',
2493         'channel',     'varchar',  '', $char_d, \"''", '',
2494         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2495         'lastapp',     'varchar',  '', $char_d, \"''", '',
2496         'lastdata',    'varchar',  '', $char_d, \"''", '',
2497
2498         #these don't seem to be logged by most of the SQL cdr_* modules
2499         #except tds under sql-illegal names, so;
2500         # ... don't rely on them for rating?
2501         # and, what they hey, i went ahead and changed the names and data types
2502         # to freeside-style dates...
2503           #'start',  'timestamp', 'NULL',  '',    '', '',
2504           #'answer', 'timestamp', 'NULL',  '',    '', '',
2505           #'end',    'timestamp', 'NULL',  '',    '', '',
2506         'startdate',  @date_type, '', '',
2507         'answerdate', @date_type, '', '',
2508         'enddate',    @date_type, '', '',
2509         #
2510
2511         'duration',    'int',      '',      '',     0, '',
2512         'billsec',     'int',      '',      '',     0, '',
2513         'disposition', 'varchar',  '',      45, \"''", '',
2514         'amaflags',    'int',      '',      '',     0, '',
2515         'accountcode', 'varchar',  '',      20, \"''", '',
2516         'uniqueid',    'varchar',  '',      32, \"''", '',
2517         'userfield',   'varchar',  '',     255, \"''", '',
2518
2519         'max_callers', 'int',  'NULL',      '',    '', '',
2520
2521         ###
2522         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2523         # defaults
2524         # though these are now used elsewhere:
2525         # charged_party, upstream_price, rated_price, carrierid
2526         ###
2527
2528         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2529         'cdrtypenum',              'int', 'NULL',      '', '', '',
2530
2531         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2532
2533         'upstream_currency',      'char', 'NULL',       3, '', '',
2534         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2535         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2536
2537         # how it was rated internally...
2538         'ratedetailnum',           'int', 'NULL',      '', '', '',
2539         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2540
2541         'distance',            'decimal', 'NULL',      '', '', '',
2542         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2543
2544         #cdr_calltype: the big list in appendix 2
2545         'calltypenum',             'int', 'NULL',      '', '', '',
2546
2547         'description',         'varchar', 'NULL', $char_d, '', '',
2548         'quantity',                'int', 'NULL',      '', '', '',
2549
2550         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2551         'carrierid',               'int', 'NULL',      '', '', '',
2552
2553         'upstream_rateid',         'int', 'NULL',      '', '', '',
2554
2555         ###
2556         #and now for our own fields
2557         ###
2558
2559         # a svcnum... right..?
2560         'svcnum',             'int',   'NULL',     '',   '', '',
2561
2562         #NULL, done (or something)
2563         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2564
2565         #NULL, done (or something)
2566         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2567
2568         #an indexed place to put big numbers
2569         'cdrid',         'bigint',     'NULL',     '',  '', '',
2570
2571         #old
2572         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2573         #new
2574         'cdrbatchnum', 'int', 'NULL', '', '', '',
2575
2576       ],
2577       'primary_key' => 'acctid',
2578       'unique' => [],
2579       'index' => [ [ 'calldate' ],
2580                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2581                    [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2582                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2583                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2584                  ],
2585     },
2586
2587     'cdr_batch' => {
2588       'columns' => [
2589         'cdrbatchnum',   'serial',    '',   '', '', '',
2590         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2591         '_date',     @date_type, '', '',
2592       ],
2593       'primary_key' => 'cdrbatchnum',
2594       'unique' => [ [ 'cdrbatch' ] ],
2595       'index' => [],
2596     },
2597
2598     'cdr_termination' => {
2599       'columns' => [
2600         'cdrtermnum', 'bigserial',     '',      '', '', '',
2601         'acctid',        'bigint',     '',      '', '', '',
2602         'termpart',         'int',     '',      '', '', '',#future use see below
2603         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2604         'status',       'varchar', 'NULL',      32, '', '',
2605         'svcnum',           'int', 'NULL',      '', '', '',
2606       ],
2607       'primary_key' => 'cdrtermnum',
2608       'unique'      => [ [ 'acctid', 'termpart' ] ],
2609       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2610     },
2611
2612     #to handle multiple termination/settlement passes...
2613    # 'part_termination' => {
2614    #   'columns' => [
2615    #     'termpart',       'int', '',      '', '', '',
2616    #     'termname',   'varchar', '', $char_d, '', '',
2617    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2618    #   ],
2619    #   'primary_key' => 'termpart',
2620    #   'unique' => [],
2621    #   'index'  => [],
2622    # },
2623
2624     #the remaining cdr_ tables are not really used
2625     'cdr_calltype' => {
2626       'columns' => [
2627         'calltypenum',   'serial',  '', '', '', '',
2628         'calltypename',  'varchar', '', $char_d, '', '',
2629       ],
2630       'primary_key' => 'calltypenum',
2631       'unique'      => [],
2632       'index'       => [],
2633     },
2634
2635     'cdr_type' => {
2636       'columns' => [
2637         'cdrtypenum'  => 'serial',  '', '', '', '',
2638         'cdrtypename' => 'varchar', '', $char_d, '', '',
2639       ],
2640       'primary_key' => 'cdrtypenum',
2641       'unique'      => [],
2642       'index'       => [],
2643     },
2644
2645     'cdr_carrier' => {
2646       'columns' => [
2647         'carrierid'   => 'serial',  '', '', '', '',
2648         'carriername' => 'varchar', '', $char_d, '', '',
2649       ],
2650       'primary_key' => 'carrierid',
2651       'unique'      => [],
2652       'index'       => [],
2653     },
2654
2655     #'cdr_file' => {
2656     #  'columns' => [
2657     #    'filenum',    'serial',     '', '', '', '',
2658     #    'filename',  'varchar',     '', '', '', '',
2659     #    'status',    'varchar', 'NULL', '', '', '',
2660     #  ],
2661     #  'primary_key' => 'filenum',
2662     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2663     #                                   # agent-virtualize or have a customer
2664     #                                   # with dup-filename needs or something
2665     #                                   # (only used by cdr.http_and_import for
2666     #                                   #  chrissakes)
2667     #  'index'  => [],
2668     #},
2669
2670     'inventory_item' => {
2671       'columns' => [
2672         'itemnum',  'serial',      '',      '', '', '',
2673         'classnum', 'int',         '',      '', '', '',
2674         'agentnum', 'int',     'NULL',      '', '', '',
2675         'item',     'varchar',     '', $char_d, '', '',
2676         'svcnum',   'int',     'NULL',      '', '', '',
2677       ],
2678       'primary_key' => 'itemnum',
2679       'unique' => [ [ 'classnum', 'item' ] ],
2680       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
2681     },
2682
2683     'inventory_class' => {
2684       'columns' => [
2685         'classnum',  'serial',       '',      '', '', '',
2686         'classname', 'varchar',      '', $char_d, '', '',
2687       ],
2688       'primary_key' => 'classnum',
2689       'unique' => [],
2690       'index'  => [],
2691     },
2692
2693     'access_user' => {
2694       'columns' => [
2695         'usernum',   'serial',  '',      '', '', '',
2696         'username',  'varchar', '', $char_d, '', '',
2697         '_password', 'varchar', '', $char_d, '', '',
2698         'last',      'varchar', '', $char_d, '', '',
2699         'first',     'varchar', '', $char_d, '', '',
2700         'user_custnum',  'int', 'NULL',  '', '', '',
2701         'disabled',     'char', 'NULL',   1, '', '',
2702       ],
2703       'primary_key' => 'usernum',
2704       'unique' => [ [ 'username' ] ],
2705       'index'  => [ [ 'user_custnum' ] ],
2706     },
2707
2708     'access_user_pref' => {
2709       'columns' => [
2710         'prefnum',    'serial',       '', '', '', '',
2711         'usernum',     'int',       '', '', '', '',
2712         'prefname', 'varchar', '', $char_d, '', '',
2713         'prefvalue', 'text', 'NULL', '', '', '',
2714         'expiration', @date_type, '', '',
2715       ],
2716       'primary_key' => 'prefnum',
2717       'unique' => [],
2718       'index'  => [ [ 'usernum' ] ],
2719     },
2720
2721     'access_group' => {
2722       'columns' => [
2723         'groupnum',   'serial', '',      '', '', '',
2724         'groupname', 'varchar', '', $char_d, '', '',
2725       ],
2726       'primary_key' => 'groupnum',
2727       'unique' => [ [ 'groupname' ] ],
2728       'index'  => [],
2729     },
2730
2731     'access_usergroup' => {
2732       'columns' => [
2733         'usergroupnum', 'serial', '', '', '', '',
2734         'usernum',         'int', '', '', '', '',
2735         'groupnum',        'int', '', '', '', '',
2736       ],
2737       'primary_key' => 'usergroupnum',
2738       'unique' => [ [ 'usernum', 'groupnum' ] ],
2739       'index'  => [ [ 'usernum' ] ],
2740     },
2741
2742     'access_groupagent' => {
2743       'columns' => [
2744         'groupagentnum', 'serial', '', '', '', '',
2745         'groupnum',         'int', '', '', '', '',
2746         'agentnum',         'int', '', '', '', '',
2747       ],
2748       'primary_key' => 'groupagentnum',
2749       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2750       'index'  => [ [ 'groupnum' ] ],
2751     },
2752
2753     'access_right' => {
2754       'columns' => [
2755         'rightnum',   'serial', '',      '', '', '',
2756         'righttype', 'varchar', '', $char_d, '', '',
2757         'rightobjnum',   'int', '',      '', '', '',
2758         'rightname', 'varchar', '', $char_d, '', '',
2759       ],
2760       'primary_key' => 'rightnum',
2761       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2762       'index'  => [],
2763     },
2764
2765     'svc_phone' => {
2766       'columns' => [
2767         'svcnum',       'int',         '',      '', '', '',
2768         'countrycode',  'varchar',     '',       3, '', '',
2769         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2770         'pin',          'varchar', 'NULL', $char_d, '', '',
2771         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2772         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2773         'pbxsvc',           'int', 'NULL',      '', '', '',
2774         'domsvc',           'int', 'NULL',      '', '', '',
2775         'locationnum',      'int', 'NULL', '', '', '',
2776         'lnp_status',   'varchar', 'NULL', $char_d, '', '',
2777         'portable',     'char', 'NULL',       1,  '', '',
2778         'lrn',     'char',     'NULL',      10, '', '',
2779         'lnp_desired_due_date',     'int', 'NULL',       '', '', '',
2780         'lnp_due_date',     'int', 'NULL',       '', '', '',
2781         'lnp_other_provider', 'varchar', 'NULL', $char_d,  '', '',
2782         'lnp_other_provider_account', 'varchar', 'NULL', $char_d,  '', '',
2783         'lnp_reject_reason', 'varchar', 'NULL', $char_d,  '', '',
2784       ],
2785       'primary_key' => 'svcnum',
2786       'unique' => [],
2787       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
2788                     ['locationnum'],
2789                   ],
2790     },
2791
2792     'phone_device' => {
2793       'columns' => [
2794         'devicenum', 'serial',     '', '', '', '',
2795         'devicepart',   'int',     '', '', '', '',
2796         'svcnum',       'int',     '', '', '', '',
2797         'mac_addr', 'varchar', 'NULL', 12, '', '',
2798       ],
2799       'primary_key' => 'devicenum',
2800       'unique' => [ [ 'mac_addr' ], ],
2801       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
2802     },
2803
2804     'part_device' => {
2805       'columns' => [
2806         'devicepart', 'serial',  '',      '', '', '',
2807         'devicename', 'varchar', '', $char_d, '', '',
2808         #'classnum', #tie to an inventory class?
2809       ],
2810       'primary_key' => 'devicepart',
2811       'unique' => [ [ 'devicename' ] ], #?
2812       'index'  => [],
2813     },
2814
2815     'phone_avail' => {
2816       'columns' => [
2817         'availnum',    'serial',      '',      '', '', '',
2818         'exportnum',   'int',         '',      '', '', '',
2819         'countrycode', 'varchar',     '',       3, '', '',
2820         'state',       'char',    'NULL',       2, '', '',
2821         'npa',         'char',        '',       3, '', '',
2822         'nxx',         'char',    'NULL',       3, '', '',
2823         'station',     'char',    'NULL',       4, '', '',
2824         'name',        'varchar', 'NULL', $char_d, '', '',
2825         'svcnum',      'int',     'NULL',      '', '', '',
2826         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2827       ],
2828       'primary_key' => 'availnum',
2829       'unique' => [],
2830       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2831                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2832                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2833                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2834                     [ 'svcnum' ],
2835                     [ 'availbatch' ],
2836                   ],
2837     },
2838
2839     'reason_type' => {
2840       'columns' => [
2841         'typenum',   'serial',  '', '', '', '',
2842         'class',     'char', '', 1, '', '',
2843         'type',     'varchar', '', $char_d, '', '',
2844       ],
2845       'primary_key' => 'typenum',
2846       'unique' => [],
2847       'index' => [],
2848     },
2849
2850     'reason' => {
2851       'columns' => [
2852         'reasonnum',     'serial',  '', '', '', '',
2853         'reason_type',   'int',  '', '', '', '',
2854         'reason',        'text', '', '', '', '',
2855         'disabled',      'char',    'NULL', 1, '', '',
2856       ],
2857       'primary_key' => 'reasonnum',
2858       'unique' => [],
2859       'index' => [],
2860     },
2861
2862     'conf' => {
2863       'columns' => [
2864         'confnum',  'serial',  '', '', '', '',
2865         'agentnum', 'int',  'NULL', '', '', '',
2866         'name',     'varchar', '', $char_d, '', '',
2867         'value',    'text', 'NULL', '', '', '',
2868       ],
2869       'primary_key' => 'confnum',
2870       'unique' => [ [ 'agentnum', 'name' ]],
2871       'index' => [],
2872     },
2873
2874     'pkg_referral' => {
2875       'columns' => [
2876         'pkgrefnum',     'serial', '', '', '', '',
2877         'pkgnum',        'int',    '', '', '', '',
2878         'refnum',        'int',    '', '', '', '',
2879       ],
2880       'primary_key' => 'pkgrefnum',
2881       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2882       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2883     },
2884
2885     'svc_pbx' => {
2886       'columns' => [
2887         'svcnum',           'int',     '',      '', '', '',
2888         'id',               'int', 'NULL',      '', '', '',
2889         'title',        'varchar', 'NULL', $char_d, '', '',
2890         'max_extensions',   'int', 'NULL',      '', '', '',
2891         'max_simultaneous', 'int', 'NULL',      '', '', '',
2892       ],
2893       'primary_key' => 'svcnum',
2894       'unique' => [],
2895       'index'  => [ [ 'id' ] ],
2896     },
2897
2898     'svc_mailinglist' => { #svc_group?
2899       'columns' => [
2900         'svcnum',            'int',     '',            '', '', '',
2901         'username',      'varchar',     '', $username_len, '', '',
2902         'domsvc',            'int',     '',            '', '', '',
2903         'listnum',           'int',     '',            '', '', '',
2904         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
2905         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
2906         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
2907         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
2908       ],
2909       'primary_key' => 'svcnum',
2910       'unique' => [],
2911       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
2912     },
2913
2914     'mailinglist' => {
2915       'columns' => [
2916         'listnum',   'serial', '',      '', '', '',
2917         'listname', 'varchar', '', $char_d, '', '',
2918       ],
2919       'primary_key' => 'listnum',
2920       'unique' => [],
2921       'index'  => [],
2922     },
2923
2924     'mailinglistmember' => {
2925       'columns' => [
2926         'membernum',        'serial',     '',   '', '', '',
2927         'listnum',             'int',     '',   '', '', '',
2928         'svcnum',              'int', 'NULL',   '', '', '',
2929         'contactemailnum',     'int', 'NULL',   '', '', '',
2930         'email',           'varchar', 'NULL',  255, '', '',
2931       ],
2932       'primary_key' => 'membernum',
2933       'unique'      => [],
2934       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
2935     },
2936
2937     'bill_batch' => {
2938       'columns' => [
2939         'batchnum',         'serial',     '', '', '', '',
2940         'status',             'char', 'NULL','1', '', '',
2941         'pdf',                'blob', 'NULL', '', '', '',
2942       ],
2943       'primary_key' => 'batchnum',
2944       'unique'      => [],
2945       'index'       => [],
2946     },
2947
2948     'cust_bill_batch' => {
2949       'columns' => [
2950         'billbatchnum',     'serial',     '', '', '', '',
2951         'batchnum',            'int',     '', '', '', '',
2952         'invnum',              'int',     '', '', '', '',
2953       ],
2954       'primary_key' => 'billbatchnum',
2955       'unique'      => [],
2956       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
2957     },
2958
2959     'cust_bill_batch_option' => {
2960       'columns' => [
2961         'optionnum', 'serial', '', '', '', '',
2962         'billbatchnum', 'int', '', '', '', '',
2963         'optionname', 'varchar', '', $char_d, '', '',
2964         'optionvalue', 'text', 'NULL', '', '', '',
2965       ],
2966       'primary_key' => 'optionnum',
2967       'unique'      => [],
2968       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
2969     },
2970
2971     'msg_template' => {
2972       'columns' => [
2973         'msgnum',     'serial',     '',      '', '', '',
2974         'msgname',   'varchar',     '', $char_d, '', '',
2975         'agentnum',      'int', 'NULL',      '', '', '',
2976         'subject',   'varchar', 'NULL',     512, '', '',
2977         'mime_type', 'varchar',     '', $char_d, '', '',
2978         'body',         'blob', 'NULL',      '', '', '',
2979         'disabled',     'char', 'NULL',       1, '', '',
2980         'from_addr', 'varchar', 'NULL',     255, '', '',
2981         'bcc_addr',  'varchar', 'NULL',     255, '', '',
2982       ],
2983       'primary_key' => 'msgnum',
2984       'unique'      => [ ['msgname', 'mime_type'] ],
2985       'index'       => [ ['agentnum'], ]
2986     },
2987
2988     'svc_cert' => {
2989       'columns' => [
2990         'svcnum',                'int',     '',      '', '', '',
2991         'recnum',                'int', 'NULL',      '', '', '',
2992         'privatekey',           'text', 'NULL',      '', '', '',
2993         'csr',                  'text', 'NULL',      '', '', '',
2994         'certificate',          'text', 'NULL',      '', '', '',
2995         'cacert',               'text', 'NULL',      '', '', '',
2996         'common_name',       'varchar', 'NULL', $char_d, '', '',
2997         'organization',      'varchar', 'NULL', $char_d, '', '',
2998         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
2999         'city',              'varchar', 'NULL', $char_d, '', '',
3000         'state',             'varchar', 'NULL', $char_d, '', '',
3001         'country',              'char', 'NULL',       2, '', '',
3002         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
3003       ],
3004       'primary_key' => 'svcnum',
3005       'unique' => [],
3006       'index'  => [], #recnum
3007     },
3008
3009     'nms_device' => {
3010       'columns' => [
3011         'nms_devicenum', 'serial',     '',      '', '', '',
3012         #'agentnum',         'int', 'NULL',      '', '', '',
3013         'devicename',   'varchar',     '', $char_d, '', '',
3014         'ip',           'varchar',     '',      15, '', '',
3015         'protocol',     'varchar',     '', $char_d, '', '',
3016 #        'last',     'int',     '',    '', '', '',
3017       ],
3018       'primary_key' => 'nms_devicenum',
3019       'unique' => [],
3020       'index'  => [],
3021     },
3022
3023     'nms_deviceport' => {
3024       'columns' => [
3025         'portnum',       'serial',     '', '', '', '',
3026         'nms_devicenum',    'int',     '', '', '', '',
3027         'deviceport',       'int',     '', '', '', '',
3028         #'ip',       'varchar', 'NULL', 15, '', '',
3029         'svcnum',           'int', 'NULL', '', '', '',
3030       ],
3031       'primary_key' => 'portnum',
3032       'unique'      => [ [ 'nms_devicenum', 'deviceport' ] ],
3033       'index'       => [ [ 'svcnum' ] ],
3034     },
3035
3036     'svc_port' => {
3037       'columns' => [
3038         'svcnum',                'int',     '',      '', '', '',
3039       ],
3040       'primary_key' => 'svcnum',
3041       'unique' => [],
3042       'index'  => [], #recnum
3043     },
3044
3045
3046     # name type nullability length default local
3047
3048     #'new_table' => {
3049     #  'columns' => [
3050     #    'num', 'serial',       '', '', '', '',
3051     #  ],
3052     #  'primary_key' => 'num',
3053     #  'unique' => [],
3054     #  'index'  => [],
3055     #},
3056
3057   };
3058
3059 }
3060
3061 =back
3062
3063 =head1 BUGS
3064
3065 =head1 SEE ALSO
3066
3067 L<DBIx::DBSchema>
3068
3069 =cut
3070
3071 1;
3072