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         'classnum',      'int',     'NULL', '', '', '',
 934         '_date',    @date_type, '', '',
 935         'otaker',   'varchar', 'NULL',    32, '', '',
 936         'usernum',   'int', 'NULL', '', '', '',
 937         'comments', 'text', 'NULL', '', '', '',
 938       ],
 939       'primary_key' => 'notenum',
 940       'unique' => [],
 941       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
 942     },
 943
 944     'cust_note_class' => {
 945       'columns' => [
 946         'classnum',    'serial',   '',      '', '', '',
 947         'classname',   'varchar',  '', $char_d, '', '',
 948         'disabled',    'char', 'NULL',       1, '', '',
 949       ],
 950       'primary_key' => 'classnum',
 951       'unique' => [],
 952       'index' => [ ['disabled'] ],
 953     },
 954
 955     'cust_category' => {
 956       'columns' => [
 957         'categorynum',   'serial',  '', '', '', '',
 958         'categoryname',  'varchar', '', $char_d, '', '',
 959         'weight',         'int', 'NULL',  '', '', '',
 960         'disabled',      'char', 'NULL',   1, '', '',
 961       ],
 962       'primary_key' => 'categorynum',
 963       'unique' => [],
 964       'index' => [ ['disabled'] ],
 965     },
 966
 967     'cust_class' => {
 968       'columns' => [
 969         'classnum',    'serial',   '',      '', '', '',
 970         'classname',   'varchar',  '', $char_d, '', '',
 971         'categorynum', 'int',  'NULL',      '', '', '',
 972         'disabled',    'char', 'NULL',       1, '', '',
 973       ],
 974       'primary_key' => 'classnum',
 975       'unique' => [],
 976       'index' => [ ['disabled'] ],
 977     },
 978
 979     'cust_tag' => {
 980       'columns' => [
 981         'custtagnum', 'serial', '', '', '', '',
 982         'custnum',       'int', '', '', '', '',
 983         'tagnum',        'int', '', '', '', '',
 984       ],
 985       'primary_key' => 'custtagnum',
 986       'unique'      => [ [ 'custnum', 'tagnum' ] ],
 987       'index'       => [ [ 'custnum' ] ],
 988     },
 989
 990     'part_tag' => {
 991       'columns' => [
 992         'tagnum',    'serial',     '',      '', '', '',
 993         'tagname',  'varchar',     '', $char_d, '', '',
 994         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
 995         'tagcolor', 'varchar', 'NULL',       6, '', '',
 996         'disabled',    'char', 'NULL',       1, '', '',
 997       ],
 998       'primary_key' => 'tagnum',
 999       'unique'      => [], #[ [ 'tagname' ] ], #?
1000       'index'       => [ [ 'disabled' ] ],
1001     },
1002
1003     'cust_main_exemption' => {
1004       'columns' => [
1005         'exemptionnum', 'serial', '',      '', '', '',
1006         'custnum',         'int', '',      '', '', '',
1007         'taxname',     'varchar', '', $char_d, '', '',
1008         #start/end dates?  for reporting?
1009       ],
1010       'primary_key' => 'exemptionnum',
1011       'unique'      => [],
1012       'index'       => [ [ 'custnum' ] ],
1013     },
1014
1015     'cust_tax_adjustment' => {
1016       'columns' => [
1017         'adjustmentnum', 'serial',     '',      '', '', '',
1018         'custnum',          'int',     '',      '', '', '',
1019         'taxname',      'varchar',     '', $char_d, '', '',
1020         'amount',    @money_type,                   '', '',
1021         'comment',     'varchar',  'NULL', $char_d, '', '',
1022         'billpkgnum',       'int', 'NULL',      '', '', '',
1023         #more?  no cust_bill_pkg_tax_location?
1024       ],
1025       'primary_key' => 'adjustmentnum',
1026       'unique'      => [],
1027       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1028     },
1029
1030     'cust_main_county' => { #county+state+country are checked off the
1031                             #cust_main_county for validation and to provide
1032                             # a tax rate.
1033       'columns' => [
1034         'taxnum',   'serial',   '',    '', '', '',
1035         'city',     'varchar',  'NULL',    $char_d, '', '',
1036         'county',   'varchar',  'NULL',    $char_d, '', '',
1037         'state',    'varchar',  'NULL',    $char_d, '', '',
1038         'country',  'char',  '', 2, '', '',
1039         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1040         'exempt_amount', @money_type, '', '',
1041         'tax',      'real',  '',    '', '', '', #tax %
1042         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1043         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1044         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1045       ],
1046       'primary_key' => 'taxnum',
1047       'unique' => [],
1048   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1049       'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
1050                    [ 'taxclass' ],
1051                  ],
1052     },
1053
1054     'tax_rate'    => {
1055       'columns' => [
1056         'taxnum',       'serial',     '',      '', '', '',
1057         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1058         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1059         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1060         'taxclassnum', 'int',      '',      '', '', '',
1061         'effective_date', @date_type, '', '',
1062         'tax',        @taxrate_type,      '', '',        # tax %
1063         'excessrate', @taxrate_typen,     '', '',        # second tax %
1064         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1065         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1066         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1067         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1068         'unittype',    'int',  'NULL', '', '', '',      # for fee
1069         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1070         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1071         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1072         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1073         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1074         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1075         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1076         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1077         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1078         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1079         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1080         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1081         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1082         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1083         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1084         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1085       ],
1086       'primary_key' => 'taxnum',
1087       'unique' => [],
1088       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1089     },
1090
1091     'tax_rate_location' => {
1092       'columns' => [
1093         'taxratelocationnum', 'serial',  '',     '', '', '',
1094         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1095         'geocode',            'varchar', '',     20,      '', '',
1096         'city',               'varchar', 'NULL', $char_d, '', '',
1097         'county',             'varchar', 'NULL', $char_d, '', '',
1098         'state',              'char',    'NULL',       2, '', '',
1099         'disabled',           'char',    'NULL', 1, '', '',
1100       ],
1101       'primary_key' => 'taxratelocationnum',
1102       'unique' => [],
1103       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1104     },
1105
1106     'cust_tax_location' => {
1107       'columns' => [
1108         'custlocationnum', 'serial',  '',     '', '', '',
1109         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1110         'city',            'varchar', 'NULL', $char_d, '', '',
1111         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1112         'county',          'varchar', 'NULL', $char_d, '', '',
1113         'zip',             'char',    '',     5,  '', '',
1114         'state',           'char',    '',     2,  '', '',
1115         'plus4hi',         'char',    'NULL', 4,  '', '',
1116         'plus4lo',         'char',    'NULL', 4,  '', '',
1117         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1118         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1119         'geocode',         'varchar', '',    20,  '', '',
1120       ],
1121       'primary_key' => 'custlocationnum',
1122       'unique' => [],
1123       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1124     },
1125
1126     'tax_class' => {
1127       'columns' => [
1128         'taxclassnum',  'serial',  '',            '', '', '',
1129         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1130         'taxclass',     'varchar', '',       $char_d, '', '',
1131         'description',  'varchar', '',     2*$char_d, '', '',
1132       ],
1133       'primary_key' => 'taxclassnum',
1134       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1135       'index' => [],
1136     },
1137
1138     'cust_pay_pending' => {
1139       'columns' => [
1140         'paypendingnum','serial',      '',  '', '', '',
1141         'custnum',      'int',         '',  '', '', '',
1142         'paid',         @money_type,            '', '',
1143         '_date',        @date_type,             '', '',
1144         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1145                                                         # be index into payby
1146                                                         # table eventually
1147         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1148         'paymask',      'varchar', 'NULL', $char_d, '', '',
1149         'paydate',      'varchar', 'NULL', 10, '', '',
1150         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1151         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1152         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1153
1154         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1155         'status',       'varchar',     '', $char_d, '', '',
1156         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1157         'statustext',   'text',    'NULL',  '', '', '',
1158         'gatewaynum',   'int',     'NULL',  '', '', '',
1159         #'cust_balance', @money_type,            '', '',
1160         'paynum',       'int',     'NULL',  '', '', '',
1161         'jobnum',       'int',     'NULL',  '', '', '',
1162       ],
1163       'primary_key' => 'paypendingnum',
1164       'unique'      => [ [ 'payunique' ] ],
1165       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1166     },
1167
1168     'cust_pay' => {
1169       'columns' => [
1170         'paynum',   'serial',    '',   '', '', '',
1171         'custnum',  'int',    '',   '', '', '',
1172         '_date',    @date_type, '', '',
1173         'paid',     @money_type, '', '',
1174         'otaker',   'varchar', 'NULL', 32, '', '',
1175         'usernum',   'int', 'NULL', '', '', '',
1176         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1177                                                  # index into payby table
1178                                                  # eventually
1179         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1180         'paymask', 'varchar', 'NULL', $char_d, '', '',
1181         'paydate',  'varchar', 'NULL', 10, '', '',
1182         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1183         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1184         'closed',    'char', 'NULL', 1, '', '',
1185         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1186       ],
1187       'primary_key' => 'paynum',
1188       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1189       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1190     },
1191
1192     'cust_pay_void' => {
1193       'columns' => [
1194         'paynum',    'int',    '',   '', '', '',
1195         'custnum',   'int',    '',   '', '', '',
1196         'paid',      @money_type, '', '',
1197         '_date',     @date_type, '', '',
1198         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1199                                                   # index into payby table
1200                                                   # eventually
1201         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1202         'paymask', 'varchar', 'NULL', $char_d, '', '',
1203         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1204         'closed',    'char', 'NULL', 1, '', '',
1205         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1206         'void_date', @date_type, '', '',
1207         'reason',    'varchar',   'NULL', $char_d, '', '',
1208         'otaker',   'varchar', 'NULL', 32, '', '',
1209         'usernum',   'int', 'NULL', '', '', '',
1210         'void_usernum',   'int', 'NULL', '', '', '',
1211       ],
1212       'primary_key' => 'paynum',
1213       'unique' => [],
1214       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1215     },
1216
1217     'cust_bill_pay' => {
1218       'columns' => [
1219         'billpaynum', 'serial',     '',   '', '', '',
1220         'invnum',  'int',     '',   '', '', '',
1221         'paynum',  'int',     '',   '', '', '',
1222         'amount',  @money_type, '', '',
1223         '_date',   @date_type, '', '',
1224         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1225       ],
1226       'primary_key' => 'billpaynum',
1227       'unique' => [],
1228       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1229     },
1230
1231     'cust_bill_pay_batch' => {
1232       'columns' => [
1233         'billpaynum', 'serial',     '',   '', '', '',
1234         'invnum',  'int',     '',   '', '', '',
1235         'paybatchnum',  'int',     '',   '', '', '',
1236         'amount',  @money_type, '', '',
1237         '_date',   @date_type, '', '',
1238       ],
1239       'primary_key' => 'billpaynum',
1240       'unique' => [],
1241       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1242     },
1243
1244     'cust_bill_pay_pkg' => {
1245       'columns' => [
1246         'billpaypkgnum', 'serial', '', '', '', '',
1247         'billpaynum',       'int', '', '', '', '',
1248         'billpkgnum',       'int', '', '', '', '',
1249         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1250         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1251         'amount',         @money_type,     '', '',
1252         'setuprecur',      'varchar', '', $char_d, '', '',
1253         'sdate',   @date_type, '', '',
1254         'edate',   @date_type, '', '',
1255       ],
1256       'primary_key' => 'billpaypkgnum',
1257       'unique'      => [],
1258       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1259     },
1260
1261     'pay_batch' => { #batches of payments to an external processor
1262       'columns' => [
1263         'batchnum',   'serial',    '',   '', '', '',
1264         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1265         'status',     'char', 'NULL',     1, '', '',
1266         'download',   @date_type, '', '',
1267         'upload',     @date_type, '', '',
1268       ],
1269       'primary_key' => 'batchnum',
1270       'unique' => [],
1271       'index' => [],
1272     },
1273
1274     'cust_pay_batch' => { #what's this used for again?  list of customers
1275                           #in current CARD batch? (necessarily CARD?)
1276       'columns' => [
1277         'paybatchnum',   'serial',    '',   '', '', '',
1278         'batchnum',   'int',    '',   '', '', '',
1279         'invnum',   'int',    '',   '', '', '',
1280         'custnum',   'int',    '',   '', '', '',
1281         'last',     'varchar', '',     $char_d, '', '',
1282         'first',    'varchar', '',     $char_d, '', '',
1283         'address1', 'varchar', '',     $char_d, '', '',
1284         'address2', 'varchar', 'NULL', $char_d, '', '',
1285         'city',     'varchar', '',     $char_d, '', '',
1286         'state',    'varchar', 'NULL', $char_d, '', '',
1287         'zip',      'varchar', 'NULL', 10, '', '',
1288         'country',  'char', '',     2, '', '',
1289         #        'trancode', 'int', '', '', '', ''
1290         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1291         'payinfo',  'varchar', '',     512, '', '',
1292         #'exp',      @date_type, '', ''
1293         'exp',      'varchar', 'NULL',     11, '', '',
1294         'payname',  'varchar', 'NULL', $char_d, '', '',
1295         'amount',   @money_type, '', '',
1296         'status',   'varchar', 'NULL',     $char_d, '', '',
1297       ],
1298       'primary_key' => 'paybatchnum',
1299       'unique' => [],
1300       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1301     },
1302
1303     'cust_pkg' => {
1304       'columns' => [
1305         'pkgnum',           'serial',     '', '', '', '',
1306         'custnum',             'int',     '', '', '', '',
1307         'pkgpart',             'int',     '', '', '', '',
1308         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1309         'locationnum',         'int', 'NULL', '', '', '',
1310         'otaker',          'varchar', 'NULL', 32, '', '',
1311         'usernum',             'int', 'NULL', '', '', '',
1312         'order_date',     @date_type,             '', '',
1313         'start_date',     @date_type,             '', '',
1314         'setup',          @date_type,             '', '',
1315         'bill',           @date_type,             '', '',
1316         'last_bill',      @date_type,             '', '',
1317         'susp',           @date_type,             '', '',
1318         'adjourn',        @date_type,             '', '',
1319         'cancel',         @date_type,             '', '',
1320         'expire',         @date_type,             '', '',
1321         'contract_end',   @date_type,             '', '',
1322         'change_date',    @date_type,             '', '',
1323         'change_pkgnum',       'int', 'NULL', '', '', '',
1324         'change_pkgpart',      'int', 'NULL', '', '', '',
1325         'change_locationnum',  'int', 'NULL', '', '', '',
1326         'manual_flag',        'char', 'NULL',  1, '', '',
1327         'no_auto',            'char', 'NULL',  1, '', '',
1328         'quantity',            'int', 'NULL', '', '', '',
1329         'agent_pkgid',         'int', 'NULL', '', '', '',
1330       ],
1331       'primary_key' => 'pkgnum',
1332       'unique' => [],
1333       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1334                    [ 'usernum' ], [ 'agent_pkgid' ],
1335                    [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1336                    ['susp'], ['adjourn'], ['expire'], ['cancel'],
1337                    ['change_date'], ['order_date'],
1338                  ],
1339     },
1340
1341     'cust_pkg_option' => {
1342       'columns' => [
1343         'optionnum', 'serial', '', '', '', '',
1344         'pkgnum', 'int', '', '', '', '',
1345         'optionname', 'varchar', '', $char_d, '', '',
1346         'optionvalue', 'text', 'NULL', '', '', '',
1347       ],
1348       'primary_key' => 'optionnum',
1349       'unique'      => [],
1350       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1351     },
1352
1353     'cust_pkg_detail' => {
1354       'columns' => [
1355         'pkgdetailnum', 'serial', '',      '', '', '',
1356         'pkgnum',          'int', '',      '', '', '',
1357         'detail',      'varchar', '', $char_d, '', '',
1358         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1359         'weight',          'int', '',      '', '', '',
1360       ],
1361       'primary_key' => 'pkgdetailnum',
1362       'unique' => [],
1363       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1364     },
1365
1366     'cust_pkg_reason' => {
1367       'columns' => [
1368         'num',      'serial',    '',   '', '', '',
1369         'pkgnum',   'int',    '',   '', '', '',
1370         'reasonnum','int',    '',   '', '', '',
1371         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1372         'otaker',   'varchar', 'NULL', 32, '', '',
1373         'usernum',   'int', 'NULL', '', '', '',
1374         'date',     @date_type, '', '',
1375       ],
1376       'primary_key' => 'num',
1377       'unique' => [],
1378       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1379     },
1380
1381     'cust_pkg_discount' => {
1382       'columns' => [
1383         'pkgdiscountnum', 'serial', '',     '', '', '',
1384         'pkgnum',            'int', '',     '', '', '',
1385         'discountnum',       'int', '',     '', '', '',
1386         'months_used',   'decimal', 'NULL', '', '', '',
1387         'end_date',     @date_type,             '', '',
1388         'otaker',        'varchar', 'NULL', 32, '', '',
1389         'usernum',           'int', 'NULL', '', '', '',
1390         'disabled',         'char', 'NULL',  1, '', '',
1391       ],
1392       'primary_key' => 'pkgdiscountnum',
1393       'unique' => [],
1394       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1395     },
1396
1397     'cust_bill_pkg_discount' => {
1398       'columns' => [
1399         'billpkgdiscountnum', 'serial',     '', '', '', '',
1400         'billpkgnum',            'int',     '', '', '', '',
1401         'pkgdiscountnum',        'int',     '', '', '', '',
1402         'amount',          @money_type,             '', '',
1403         'months',            'decimal', 'NULL', '', '', '',
1404       ],
1405       'primary_key' => 'billpkgdiscountnum',
1406       'unique' => [],
1407       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1408     },
1409
1410     'discount' => {
1411       'columns' => [
1412         'discountnum', 'serial',     '',      '', '', '',
1413         #'agentnum',       'int', 'NULL',      '', '', '',
1414         'name',       'varchar', 'NULL', $char_d, '', '',
1415         'amount',   @money_type,                  '', '',
1416         'percent',    'decimal',     '',      '', '', '',
1417         'months',     'decimal', 'NULL',      '', '', '',
1418         'disabled',      'char', 'NULL',       1, '', '',
1419       ],
1420       'primary_key' => 'discountnum',
1421       'unique' => [],
1422       'index'  => [], # [ 'agentnum' ], ],
1423     },
1424
1425     'cust_refund' => {
1426       'columns' => [
1427         'refundnum',    'serial',    '',   '', '', '',
1428         'custnum',  'int',    '',   '', '', '',
1429         '_date',        @date_type, '', '',
1430         'refund',       @money_type, '', '',
1431         'otaker',       'varchar',   'NULL',   32, '', '',
1432         'usernum',   'int', 'NULL', '', '', '',
1433         'reason',       'varchar',   '',   $char_d, '', '',
1434         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1435                                                      # be index into payby
1436                                                      # table eventually
1437         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1438         'paymask', 'varchar', 'NULL', $char_d, '', '',
1439         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1440         'closed',    'char', 'NULL', 1, '', '',
1441       ],
1442       'primary_key' => 'refundnum',
1443       'unique' => [],
1444       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1445     },
1446
1447     'cust_credit_refund' => {
1448       'columns' => [
1449         'creditrefundnum', 'serial',     '',   '', '', '',
1450         'crednum',  'int',     '',   '', '', '',
1451         'refundnum',  'int',     '',   '', '', '',
1452         'amount',  @money_type, '', '',
1453         '_date',   @date_type, '', '',
1454       ],
1455       'primary_key' => 'creditrefundnum',
1456       'unique' => [],
1457       'index' => [ ['crednum'], ['refundnum'] ],
1458     },
1459
1460
1461     'cust_svc' => {
1462       'columns' => [
1463         'svcnum',    'serial',    '',   '', '', '',
1464         'pkgnum',    'int',    'NULL',   '', '', '',
1465         'svcpart',   'int',    '',   '', '', '',
1466         'overlimit', @date_type, '', '',
1467       ],
1468       'primary_key' => 'svcnum',
1469       'unique' => [],
1470       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1471     },
1472
1473     'cust_svc_option' => {
1474       'columns' => [
1475         'optionnum',   'serial', '', '', '', '',
1476         'svcnum',      'int', '', '', '', '',
1477         'optionname',  'varchar', '', $char_d, '', '',
1478         'optionvalue', 'text', 'NULL', '', '', '',
1479       ],
1480       'primary_key' => 'optionnum',
1481       'unique'      => [],
1482       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1483     },
1484
1485     'part_pkg' => {
1486       'columns' => [
1487         'pkgpart',       'serial',    '',   '', '', '',
1488         'pkg',           'varchar',   '',   $char_d, '', '',
1489         'comment',       'varchar',   '',   $char_d, '', '',
1490         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1491         'setup',         @perl_type, '', '',
1492         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1493         'recur',         @perl_type, '', '',
1494         'setuptax',      'char', 'NULL', 1, '', '',
1495         'recurtax',      'char', 'NULL', 1, '', '',
1496         'plan',          'varchar', 'NULL', $char_d, '', '',
1497         'plandata',      'text', 'NULL', '', '', '',
1498         'disabled',      'char', 'NULL', 1, '', '',
1499         'custom',        'char', 'NULL', 1, '', '',
1500         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1501         'classnum',      'int',     'NULL', '', '', '',
1502         'addon_classnum','int',     'NULL', '', '', '',
1503         'taxproductnum', 'int',     'NULL', '', '', '',
1504         'setup_cost',    @money_typen,          '', '',
1505         'recur_cost',    @money_typen,          '', '',
1506         'pay_weight',    'real',    'NULL', '', '', '',
1507         'credit_weight', 'real',    'NULL', '', '', '',
1508         'agentnum',      'int',     'NULL', '', '', '',
1509         'fcc_ds0s',      'int',     'NULL', '', '', '',
1510         'no_auto',      'char',     'NULL',  1, '', '',
1511       ],
1512       'primary_key' => 'pkgpart',
1513       'unique' => [],
1514       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1515                    [ 'agentnum' ],
1516                  ],
1517     },
1518
1519     'part_pkg_link' => {
1520       'columns' => [
1521         'pkglinknum',  'serial',   '',      '', '', '',
1522         'src_pkgpart', 'int',      '',      '', '', '',
1523         'dst_pkgpart', 'int',      '',      '', '', '',
1524         'link_type',   'varchar',  '', $char_d, '', '',
1525         'hidden',      'char', 'NULL',       1, '', '',
1526       ],
1527       'primary_key' => 'pkglinknum',
1528       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1529       'index'  => [ [ 'src_pkgpart' ] ],
1530     },
1531     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1532     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1533
1534     'part_pkg_discount' => {
1535       'columns' => [
1536         'pkgdiscountnum', 'serial',   '',      '', '', '',
1537         'pkgpart',        'int',      '',      '', '', '',
1538         'discountnum',    'int',      '',      '', '', '',
1539       ],
1540       'primary_key' => 'pkgdiscountnum',
1541       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
1542       'index'  => [],
1543     },
1544
1545     'part_pkg_taxclass' => {
1546       'columns' => [
1547         'taxclassnum',  'serial', '',       '', '', '',
1548         'taxclass',     'varchar', '', $char_d, '', '',
1549         'disabled', 'char',   'NULL',         1, '', '',
1550       ],
1551       'primary_key' => 'taxclassnum',
1552       'unique'      => [ [ 'taxclass' ] ],
1553       'index'       => [ [ 'disabled' ] ],
1554     },
1555
1556     'part_pkg_taxproduct' => {
1557       'columns' => [
1558         'taxproductnum', 'serial',      '',        '', '', '',
1559         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1560         'taxproduct',    'varchar',     '',   $char_d, '', '',
1561         'description',   'varchar',     '', 3*$char_d, '', '',
1562       ],
1563       'primary_key' => 'taxproductnum',
1564       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1565       'index'       => [],
1566     },
1567
1568     'part_pkg_taxrate' => {
1569       'columns' => [
1570         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1571         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1572         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1573         'taxproductnum', 'int',  '',     '',       '', '',
1574         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1575         'county',           'varchar', 'NULL', $char_d, '', '',
1576         'state',            'varchar', 'NULL', $char_d, '', '',
1577         'local',            'varchar', 'NULL', $char_d, '', '',
1578         'country',          'char',    'NULL', 2,       '', '',
1579         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1580         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1581         'taxclassnum',      'int',     'NULL', '',      '', '',
1582         'effdate',          @date_type, '', '',
1583         'taxable',          'char',    'NULL', 1,       '', '',
1584       ],
1585       'primary_key' => 'pkgtaxratenum',
1586       'unique' => [],
1587       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1588     },
1589
1590     'part_pkg_taxoverride' => {
1591       'columns' => [
1592         'taxoverridenum', 'serial', '', '', '', '',
1593         'pkgpart',           'int', '', '', '', '',
1594         'taxclassnum',       'int', '', '', '', '',
1595         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1596       ],
1597       'primary_key' => 'taxoverridenum',
1598       'unique' => [],
1599       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1600     },
1601
1602 #    'part_title' => {
1603 #      'columns' => [
1604 #        'titlenum',   'int',    '',   '',
1605 #        'title',      'varchar',   '',   $char_d,
1606 #      ],
1607 #      'primary_key' => 'titlenum',
1608 #      'unique' => [ [] ],
1609 #      'index' => [ [] ],
1610 #    },
1611
1612     'pkg_svc' => {
1613       'columns' => [
1614         'pkgsvcnum',  'serial', '',  '', '', '',
1615         'pkgpart',    'int',    '',   '', '', '',
1616         'svcpart',    'int',    '',   '', '', '',
1617         'quantity',   'int',    '',   '', '', '',
1618         'primary_svc','char', 'NULL',  1, '', '',
1619         'hidden',     'char', 'NULL',  1, '', '',
1620       ],
1621       'primary_key' => 'pkgsvcnum',
1622       'unique' => [ ['pkgpart', 'svcpart'] ],
1623       'index' => [ ['pkgpart'], ['quantity'] ],
1624     },
1625
1626     'part_referral' => {
1627       'columns' => [
1628         'refnum',   'serial',     '',        '', '', '',
1629         'referral', 'varchar',    '',   $char_d, '', '',
1630         'disabled', 'char',   'NULL',         1, '', '',
1631         'agentnum', 'int',    'NULL',        '', '', '',
1632       ],
1633       'primary_key' => 'refnum',
1634       'unique' => [],
1635       'index' => [ ['disabled'], ['agentnum'], ],
1636     },
1637
1638     'part_svc' => {
1639       'columns' => [
1640         'svcpart',    'serial',    '',   '', '', '',
1641         'svc',        'varchar',   '',   $char_d, '', '',
1642         'svcdb',      'varchar',   '',   $char_d, '', '',
1643         'disabled',   'char',  'NULL',   1, '', '',
1644       ],
1645       'primary_key' => 'svcpart',
1646       'unique' => [],
1647       'index' => [ [ 'disabled' ] ],
1648     },
1649
1650     'part_svc_column' => {
1651       'columns' => [
1652         'columnnum',   'serial',         '', '', '', '',
1653         'svcpart',     'int',         '', '', '', '',
1654         'columnname',  'varchar',     '', 64, '', '',
1655         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1656         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1657         'columnflag',  'char',    'NULL', 1, '', '',
1658       ],
1659       'primary_key' => 'columnnum',
1660       'unique' => [ [ 'svcpart', 'columnname' ] ],
1661       'index' => [ [ 'svcpart' ] ],
1662     },
1663
1664     #(this should be renamed to part_pop)
1665     'svc_acct_pop' => {
1666       'columns' => [
1667         'popnum',    'serial',    '',   '', '', '',
1668         'city',      'varchar',   '',   $char_d, '', '',
1669         'state',     'varchar',   '',   $char_d, '', '',
1670         'ac',        'char',   '',   3, '', '',
1671         'exch',      'char',   '',   3, '', '',
1672         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1673       ],
1674       'primary_key' => 'popnum',
1675       'unique' => [],
1676       'index' => [ [ 'state' ] ],
1677     },
1678
1679     'part_pop_local' => {
1680       'columns' => [
1681         'localnum',  'serial',     '',     '', '', '',
1682         'popnum',    'int',     '',     '', '', '',
1683         'city',      'varchar', 'NULL', $char_d, '', '',
1684         'state',     'char',    'NULL', 2, '', '',
1685         'npa',       'char',    '',     3, '', '',
1686         'nxx',       'char',    '',     3, '', '',
1687       ],
1688       'primary_key' => 'localnum',
1689       'unique' => [],
1690       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1691     },
1692
1693     'svc_acct' => {
1694       'columns' => [
1695         'svcnum',    'int',    '',   '', '', '',
1696         'username',  'varchar',   '',   $username_len, '', '',
1697         '_password', 'varchar',   'NULL',  512, '', '',
1698         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1699         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1700         'popnum',    'int',    'NULL',   '', '', '',
1701         'uid',       'int', 'NULL',   '', '', '',
1702         'gid',       'int', 'NULL',   '', '', '',
1703         'finger',    'varchar',   'NULL',   $char_d, '', '',
1704         'dir',       'varchar',   'NULL',   $char_d, '', '',
1705         'shell',     'varchar',   'NULL',   $char_d, '', '',
1706         'quota',     'varchar',   'NULL',   $char_d, '', '',
1707         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1708         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1709         'seconds_threshold',   'int', 'NULL',   '', '', '',
1710         'upbytes',   'bigint', 'NULL',   '', '', '',
1711         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1712         'downbytes', 'bigint', 'NULL',   '', '', '',
1713         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1714         'totalbytes','bigint', 'NULL',   '', '', '',
1715         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1716         'domsvc',    'int',     '', '', '', '',
1717         'pbxsvc',    'int', 'NULL', '', '', '',
1718         'last_login',  @date_type, '', '',
1719         'last_logout', @date_type, '', '',
1720         #cardfortress field(s)
1721         'cf_privatekey',      'text', 'NULL',      '', '', '',
1722         #communigate pro fields (quota = MaxAccountSize)
1723         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1724         #settings
1725         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1726         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1727         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1728         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1729         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1730         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1731         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1732         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1733         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1734         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1735         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1736         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
1737         #XXX mailing lists
1738         #preferences
1739         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1740         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1741         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1742         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1743         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1744         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1745         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1746         #mail
1747         #XXX RPOP settings
1748       ],
1749       'primary_key' => 'svcnum',
1750       #'unique' => [ [ 'username', 'domsvc' ] ],
1751       'unique' => [],
1752       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1753     },
1754
1755     'acct_rt_transaction' => {
1756       'columns' => [
1757         'svcrtid',   'int',    '',   '', '', '',
1758         'svcnum',    'int',    '',   '', '', '',
1759         'transaction_id',       'int', '',   '', '', '',
1760         '_date',   @date_type, '', '',
1761         'seconds',   'int', '',   '', '', '', #uhhhh
1762         'support',   'int', '',   '', '', '',
1763       ],
1764       'primary_key' => 'svcrtid',
1765       'unique' => [],
1766       'index' => [ ['svcnum', 'transaction_id'] ],
1767     },
1768
1769     #'svc_charge' => {
1770     #  'columns' => [
1771     #    'svcnum',    'int',    '',   '',
1772     #    'amount',    @money_type,
1773     #  ],
1774     #  'primary_key' => 'svcnum',
1775     #  'unique' => [ [] ],
1776     #  'index' => [ [] ],
1777     #},
1778
1779     'svc_domain' => {
1780       'columns' => [
1781         'svcnum',           'int',    '',        '', '', '',
1782         'domain',       'varchar',    '',   $char_d, '', '',
1783         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1784         'catchall',         'int', 'NULL',       '', '', '',
1785         'parent_svcnum',    'int', 'NULL',       '', '', '',
1786         'registrarnum',     'int', 'NULL',       '', '', '',
1787         'registrarkey', 'varchar', 'NULL',      512, '', '',
1788         'setup_date',      @date_type, '', '',
1789         'renewal_interval', 'int', 'NULL',       '', '', '',
1790         'expiration_date', @date_type, '', '',
1791         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
1792         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
1793         #communigate pro fields (quota = MaxAccountSize)
1794         'max_accounts',     'int', 'NULL',       '', '', '',
1795         'trailer',         'text', 'NULL',       '', '', '',
1796         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
1797         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
1798         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
1799         #settings
1800         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
1801         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
1802         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
1803         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
1804         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
1805         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
1806         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
1807         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
1808         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
1809         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
1810         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
1811         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
1812         #preferences
1813         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
1814         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
1815         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
1816         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
1817         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
1818         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
1819         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
1820       ],
1821       'primary_key' => 'svcnum',
1822       'unique' => [ ],
1823       'index' => [ ['domain'] ],
1824     },
1825
1826     'domain_record' => {
1827       'columns' => [
1828         'recnum',    'serial',     '',  '', '', '',
1829         'svcnum',    'int',     '',  '', '', '',
1830         'reczone',   'varchar', '',  255, '', '',
1831         'recaf',     'char',    '',  2, '', '',
1832         'rectype',   'varchar',    '',  5, '', '',
1833         'recdata',   'varchar', '',  255, '', '',
1834         'ttl',       'int',     'NULL', '', '', '',
1835       ],
1836       'primary_key' => 'recnum',
1837       'unique'      => [],
1838       'index'       => [ ['svcnum'] ],
1839     },
1840
1841     'registrar' => {
1842       'columns' => [
1843         'registrarnum',   'serial', '',      '', '', '',
1844         'registrarname', 'varchar', '', $char_d, '', '',
1845       ],
1846       'primary_key' => 'registrarnum',
1847       'unique'      => [],
1848       'index'       => [],
1849     },
1850
1851     'cgp_rule' => {
1852       'columns' => [
1853         'rulenum',  'serial',     '',      '', '', '',
1854         'name',    'varchar',     '', $char_d, '', '',
1855         'comment', 'varchar', 'NULL', $char_d, '', '',
1856         'svcnum',      'int',     '',      '', '', '',
1857         'priority',    'int',     '',      '', '', '',
1858       ],
1859       'primary_key' => 'rulenum',
1860       'unique'      => [ [ 'svcnum', 'name' ] ],
1861       'index'       => [ [ 'svcnum' ] ],
1862     },
1863
1864     'cgp_rule_condition' => {
1865       'columns' => [
1866         'ruleconditionnum',  'serial',     '',      '', '', '',
1867         'conditionname',    'varchar',     '', $char_d, '', '',
1868         'op',               'varchar', 'NULL', $char_d, '', '',
1869         'params',           'varchar', 'NULL',     255, '', '',
1870         'rulenum',              'int',     '',      '', '', '',
1871       ],
1872       'primary_key' => 'ruleconditionnum',
1873       'unique'      => [],
1874       'index'       => [ [ 'rulenum' ] ],
1875     },
1876
1877     'cgp_rule_action' => {
1878        'columns' => [
1879         'ruleactionnum',  'serial',     '',      '', '', '',
1880         'action',        'varchar',     '', $char_d, '', '',
1881         'params',        'varchar', 'NULL',     255, '', '',
1882         'rulenum',           'int',     '',      '', '', '',
1883       ],
1884       'primary_key' => 'ruleactionnum',
1885       'unique'      => [],
1886       'index'       => [ [ 'rulenum' ] ],
1887    },
1888
1889     'svc_forward' => {
1890       'columns' => [
1891         'svcnum',   'int',            '',   '', '', '',
1892         'srcsvc',   'int',        'NULL',   '', '', '',
1893         'src',      'varchar',    'NULL',  255, '', '',
1894         'dstsvc',   'int',        'NULL',   '', '', '',
1895         'dst',      'varchar',    'NULL',  255, '', '',
1896       ],
1897       'primary_key' => 'svcnum',
1898       'unique'      => [],
1899       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1900     },
1901
1902     'svc_www' => {
1903       'columns' => [
1904         'svcnum',   'int',      '',  '', '', '',
1905         'recnum',   'int',      '',  '', '', '',
1906         'usersvc',  'int',  'NULL',  '', '', '',
1907         'config',   'text', 'NULL',  '', '', '',
1908       ],
1909       'primary_key' => 'svcnum',
1910       'unique'      => [],
1911       'index'       => [],
1912     },
1913
1914     #'svc_wo' => {
1915     #  'columns' => [
1916     #    'svcnum',    'int',    '',   '',
1917     #    'svcnum',    'int',    '',   '',
1918     #    'svcnum',    'int',    '',   '',
1919     #    'worker',    'varchar',   '',   $char_d,
1920     #    '_date',     @date_type,
1921     #  ],
1922     #  'primary_key' => 'svcnum',
1923     #  'unique' => [ [] ],
1924     #  'index' => [ [] ],
1925     #},
1926
1927     'prepay_credit' => {
1928       'columns' => [
1929         'prepaynum',   'serial',     '',   '', '', '',
1930         'identifier',  'varchar', '', $char_d, '', '',
1931         'amount',      @money_type, '', '',
1932         'seconds',     'int',     'NULL', '', '', '',
1933         'upbytes',     'bigint',     'NULL', '', '', '',
1934         'downbytes',   'bigint',     'NULL', '', '', '',
1935         'totalbytes',  'bigint',     'NULL', '', '', '',
1936         'agentnum',    'int',     'NULL', '', '', '',
1937       ],
1938       'primary_key' => 'prepaynum',
1939       'unique'      => [ ['identifier'] ],
1940       'index'       => [],
1941     },
1942
1943     'port' => {
1944       'columns' => [
1945         'portnum',  'serial',     '',   '', '', '',
1946         'ip',       'varchar', 'NULL', 15, '', '',
1947         'nasport',  'int',     'NULL', '', '', '',
1948         'nasnum',   'int',     '',   '', '', '',
1949       ],
1950       'primary_key' => 'portnum',
1951       'unique'      => [],
1952       'index'       => [],
1953     },
1954
1955     'nas' => {
1956       'columns' => [
1957         'nasnum',   'serial',     '',    '', '', '',
1958         'nas',      'varchar', '',    $char_d, '', '',
1959         'nasip',    'varchar', '',    15, '', '',
1960         'nasfqdn',  'varchar', '',    $char_d, '', '',
1961         'last',     'int',     '',    '', '', '',
1962       ],
1963       'primary_key' => 'nasnum',
1964       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1965       'index'       => [ [ 'last' ] ],
1966     },
1967
1968 #    'session' => {
1969 #      'columns' => [
1970 #        'sessionnum', 'serial',       '',   '', '', '',
1971 #        'portnum',    'int',       '',   '', '', '',
1972 #        'svcnum',     'int',       '',   '', '', '',
1973 #        'login',      @date_type, '', '',
1974 #        'logout',     @date_type, '', '',
1975 #      ],
1976 #      'primary_key' => 'sessionnum',
1977 #      'unique'      => [],
1978 #      'index'       => [ [ 'portnum' ] ],
1979 #    },
1980
1981     'queue' => {
1982       'columns' => [
1983         'jobnum',      'serial',     '',      '', '', '',
1984         'job',        'varchar',     '',     512, '', '',
1985         '_date',          'int',     '',      '', '', '',
1986         'status',     'varchar',     '', $char_d, '', '',
1987         'statustext',    'text', 'NULL',      '', '', '',
1988         'svcnum',         'int', 'NULL',      '', '', '',
1989         'custnum',        'int', 'NULL',      '', '', '',
1990         'secure',        'char', 'NULL',       1, '', '',
1991         'priority',       'int', 'NULL',      '', '', '',
1992       ],
1993       'primary_key' => 'jobnum',
1994       'unique'      => [],
1995       'index'       => [ [ 'secure' ], [ 'priority' ],
1996                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1997                        ],
1998     },
1999
2000     'queue_arg' => {
2001       'columns' => [
2002         'argnum', 'serial', '', '', '', '',
2003         'jobnum', 'int', '', '', '', '',
2004         'frozen', 'char', 'NULL',       1, '', '',
2005         'arg', 'text', 'NULL', '', '', '',
2006       ],
2007       'primary_key' => 'argnum',
2008       'unique'      => [],
2009       'index'       => [ [ 'jobnum' ] ],
2010     },
2011
2012     'queue_depend' => {
2013       'columns' => [
2014         'dependnum', 'serial', '', '', '', '',
2015         'jobnum', 'int', '', '', '', '',
2016         'depend_jobnum', 'int', '', '', '', '',
2017       ],
2018       'primary_key' => 'dependnum',
2019       'unique'      => [],
2020       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2021     },
2022
2023     'export_svc' => {
2024       'columns' => [
2025         'exportsvcnum' => 'serial', '', '', '', '',
2026         'exportnum'    => 'int', '', '', '', '',
2027         'svcpart'      => 'int', '', '', '', '',
2028       ],
2029       'primary_key' => 'exportsvcnum',
2030       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2031       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2032     },
2033
2034     'export_device' => {
2035       'columns' => [
2036         'exportdevicenum' => 'serial', '', '', '', '',
2037         'exportnum'    => 'int', '', '', '', '',
2038         'devicepart'      => 'int', '', '', '', '',
2039       ],
2040       'primary_key' => 'exportdevicenum',
2041       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2042       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2043     },
2044
2045     'part_export' => {
2046       'columns' => [
2047         'exportnum', 'serial', '', '', '', '',
2048         'exportname', 'varchar', 'NULL', $char_d, '', '',
2049         'machine', 'varchar', '', $char_d, '', '',
2050         'exporttype', 'varchar', '', $char_d, '', '',
2051         'nodomain',     'char', 'NULL', 1, '', '',
2052       ],
2053       'primary_key' => 'exportnum',
2054       'unique'      => [],
2055       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2056     },
2057
2058     'part_export_option' => {
2059       'columns' => [
2060         'optionnum', 'serial', '', '', '', '',
2061         'exportnum', 'int', '', '', '', '',
2062         'optionname', 'varchar', '', $char_d, '', '',
2063         'optionvalue', 'text', 'NULL', '', '', '',
2064       ],
2065       'primary_key' => 'optionnum',
2066       'unique'      => [],
2067       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2068     },
2069
2070     'radius_usergroup' => {
2071       'columns' => [
2072         'usergroupnum', 'serial', '', '', '', '',
2073         'svcnum',       'int', '', '', '', '',
2074         'groupname',    'varchar', '', $char_d, '', '',
2075       ],
2076       'primary_key' => 'usergroupnum',
2077       'unique'      => [],
2078       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2079     },
2080
2081     'msgcat' => {
2082       'columns' => [
2083         'msgnum', 'serial', '', '', '', '',
2084         'msgcode', 'varchar', '', $char_d, '', '',
2085         'locale', 'varchar', '', 16, '', '',
2086         'msg', 'text', '', '', '', '',
2087       ],
2088       'primary_key' => 'msgnum',
2089       'unique'      => [ [ 'msgcode', 'locale' ] ],
2090       'index'       => [],
2091     },
2092
2093     'cust_tax_exempt' => {
2094       'columns' => [
2095         'exemptnum', 'serial', '', '', '', '',
2096         'custnum',   'int', '', '', '', '',
2097         'taxnum',    'int', '', '', '', '',
2098         'year',      'int', '', '', '', '',
2099         'month',     'int', '', '', '', '',
2100         'amount',   @money_type, '', '',
2101       ],
2102       'primary_key' => 'exemptnum',
2103       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2104       'index'       => [],
2105     },
2106
2107     'cust_tax_exempt_pkg' => {
2108       'columns' => [
2109         'exemptpkgnum',  'serial', '', '', '', '',
2110         #'custnum',      'int', '', '', '', ''
2111         'billpkgnum',   'int', '', '', '', '',
2112         'taxnum',       'int', '', '', '', '',
2113         'year',         'int', '', '', '', '',
2114         'month',        'int', '', '', '', '',
2115         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2116         'amount',       @money_type, '', '',
2117       ],
2118       'primary_key' => 'exemptpkgnum',
2119       'unique' => [],
2120       'index'  => [ [ 'taxnum', 'year', 'month' ],
2121                     [ 'billpkgnum' ],
2122                     [ 'taxnum' ],
2123                     [ 'creditbillpkgnum' ],
2124                   ],
2125     },
2126
2127     'router' => {
2128       'columns' => [
2129         'routernum', 'serial', '', '', '', '',
2130         'routername', 'varchar', '', $char_d, '', '',
2131         'svcnum', 'int', 'NULL', '', '', '',
2132         'agentnum',   'int', 'NULL', '', '', '',
2133       ],
2134       'primary_key' => 'routernum',
2135       'unique'      => [],
2136       'index'       => [],
2137     },
2138
2139     'part_svc_router' => {
2140       'columns' => [
2141         'svcrouternum', 'serial', '', '', '', '',
2142         'svcpart', 'int', '', '', '', '',
2143         'routernum', 'int', '', '', '', '',
2144       ],
2145       'primary_key' => 'svcrouternum',
2146       'unique'      => [],
2147       'index'       => [],
2148     },
2149
2150     'addr_block' => {
2151       'columns' => [
2152         'blocknum', 'serial', '', '', '', '',
2153         'routernum', 'int', '', '', '', '',
2154         'ip_gateway', 'varchar', '', 15, '', '',
2155         'ip_netmask', 'int', '', '', '', '',
2156         'agentnum',   'int', 'NULL', '', '', '',
2157         'manual_flag', 'char', 'NULL', 1, '', '',
2158       ],
2159       'primary_key' => 'blocknum',
2160       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2161       'index'       => [],
2162     },
2163
2164     'svc_broadband' => {
2165       'columns' => [
2166         'svcnum', 'int', '', '', '', '',
2167         'description', 'varchar', 'NULL', $char_d, '', '',
2168         'blocknum', 'int', 'NULL', '', '', '',
2169         'speed_up', 'int', '', '', '', '',
2170         'speed_down', 'int', '', '', '', '',
2171         'ip_addr', 'varchar', 'NULL', 15, '', '',
2172         'mac_addr', 'varchar', 'NULL', 12, '', '',
2173         'authkey',  'varchar', 'NULL', 32, '', '',
2174         'latitude', 'decimal', 'NULL', '', '', '',
2175         'longitude', 'decimal', 'NULL', '', '', '',
2176         'altitude', 'decimal', 'NULL', '', '', '',
2177         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
2178         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2179         'plan_id', 'varchar', 'NULL', $char_d, '', '',
2180       ],
2181       'primary_key' => 'svcnum',
2182       'unique'      => [ [ 'mac_addr' ] ],
2183       'index'       => [],
2184     },
2185
2186     'part_virtual_field' => {
2187       'columns' => [
2188         'vfieldpart', 'serial', '', '', '', '',
2189         'dbtable', 'varchar', '', 32, '', '',
2190         'name', 'varchar', '', 32, '', '',
2191         'check_block', 'text', 'NULL', '', '', '',
2192         'length', 'int', 'NULL', '', '', '',
2193         'list_source', 'text', 'NULL', '', '', '',
2194         'label', 'varchar', 'NULL', 80, '', '',
2195       ],
2196       'primary_key' => 'vfieldpart',
2197       'unique' => [],
2198       'index' => [],
2199     },
2200
2201     'virtual_field' => {
2202       'columns' => [
2203         'vfieldnum', 'serial', '', '', '', '',
2204         'recnum', 'int', '', '', '', '',
2205         'vfieldpart', 'int', '', '', '', '',
2206         'value', 'varchar', '', 128, '', '',
2207       ],
2208       'primary_key' => 'vfieldnum',
2209       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2210       'index' => [],
2211     },
2212
2213     'acct_snarf' => {
2214       'columns' => [
2215         'snarfnum',    'serial',     '',      '', '', '',
2216         'snarfname',  'varchar', 'NULL', $char_d, '', '',
2217         'svcnum',         'int',     '',      '', '', '',
2218         'machine',    'varchar',     '',     255, '', '',
2219         'protocol',   'varchar',     '', $char_d, '', '',
2220         'username',   'varchar',     '', $char_d, '', '',
2221         '_password',  'varchar',     '', $char_d, '', '',
2222         'check_freq',     'int', 'NULL',      '', '', '',
2223         'leavemail',     'char', 'NULL',       1, '', '',
2224         'apop',          'char', 'NULL',       1, '', '',
2225         'tls',           'char', 'NULL',       1, '', '',
2226         'mailbox',    'varchar', 'NULL', $char_d, '', '',
2227       ],
2228       'primary_key' => 'snarfnum',
2229       'unique' => [],
2230       'index'  => [ [ 'svcnum' ] ],
2231     },
2232
2233     'svc_external' => {
2234       'columns' => [
2235         'svcnum', 'int', '', '', '', '',
2236         'id',     'int', 'NULL', '', '', '',
2237         'title',  'varchar', 'NULL', $char_d, '', '',
2238       ],
2239       'primary_key' => 'svcnum',
2240       'unique'      => [],
2241       'index'       => [],
2242     },
2243
2244     'cust_pay_refund' => {
2245       'columns' => [
2246         'payrefundnum', 'serial', '', '', '', '',
2247         'paynum',  'int', '', '', '', '',
2248         'refundnum',  'int', '', '', '', '',
2249         '_date',    @date_type, '', '',
2250         'amount',   @money_type, '', '',
2251       ],
2252       'primary_key' => 'payrefundnum',
2253       'unique' => [],
2254       'index' => [ ['paynum'], ['refundnum'] ],
2255     },
2256
2257     'part_pkg_option' => {
2258       'columns' => [
2259         'optionnum', 'serial', '', '', '', '',
2260         'pkgpart', 'int', '', '', '', '',
2261         'optionname', 'varchar', '', $char_d, '', '',
2262         'optionvalue', 'text', 'NULL', '', '', '',
2263       ],
2264       'primary_key' => 'optionnum',
2265       'unique'      => [],
2266       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2267     },
2268
2269     'part_pkg_report_option' => {
2270       'columns' => [
2271         'num',      'serial',   '',      '', '', '',
2272         'name',     'varchar',  '', $char_d, '', '',
2273         'disabled', 'char', 'NULL',       1, '', '',
2274       ],
2275       'primary_key' => 'num',
2276       'unique' => [ [ 'name' ] ],
2277       'index' => [ [ 'disabled' ] ],
2278     },
2279
2280     'rate' => {
2281       'columns' => [
2282         'ratenum',  'serial', '', '', '', '',
2283         'ratename', 'varchar', '', $char_d, '', '',
2284       ],
2285       'primary_key' => 'ratenum',
2286       'unique'      => [],
2287       'index'       => [],
2288     },
2289
2290     'rate_detail' => {
2291       'columns' => [
2292         'ratedetailnum',   'serial',  '',     '', '', '',
2293         'ratenum',         'int',     '',     '', '', '',
2294         'orig_regionnum',  'int', 'NULL',     '', '', '',
2295         'dest_regionnum',  'int',     '',     '', '', '',
2296         'min_included',    'int',     '',     '', '', '',
2297         'conn_charge',     'decimal', '', '10,4', '0', '',
2298         'conn_sec',        'int',     '',     '', '0', '',
2299         'min_charge',      'decimal', '', '10,5', '', '', #@money_type, '', '',
2300         'sec_granularity', 'int',     '',     '', '', '',
2301         'ratetimenum',     'int', 'NULL',     '', '', '',
2302         'classnum',        'int', 'NULL',     '', '', '',
2303       ],
2304       'primary_key' => 'ratedetailnum',
2305       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2306       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2307     },
2308
2309     'rate_region' => {
2310       'columns' => [
2311         'regionnum',   'serial',      '', '', '', '',
2312         'regionname',  'varchar',     '', $char_d, '', '',
2313       ],
2314       'primary_key' => 'regionnum',
2315       'unique'      => [],
2316       'index'       => [],
2317     },
2318
2319     'rate_prefix' => {
2320       'columns' => [
2321         'prefixnum',   'serial',      '', '', '', '',
2322         'regionnum',   'int',         '', '', '', '',
2323         'countrycode', 'varchar',     '',  3, '', '',
2324         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2325         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2326       ],
2327       'primary_key' => 'prefixnum',
2328       'unique'      => [],
2329       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2330     },
2331
2332     'rate_time' => {
2333       'columns' => [
2334         'ratetimenum', 'serial',      '',      '', '', '',
2335         'ratetimename',   'varchar',      '', $char_d, '', '',
2336       ],
2337       'primary_key' => 'ratetimenum',
2338       'unique'      => [],
2339       'index'       => [],
2340     },
2341
2342     'rate_time_interval' => {
2343       'columns' => [
2344         'intervalnum', 'serial', '', '', '', '',
2345         'stime',          'int', '', '', '', '',
2346         'etime',          'int', '', '', '', '',
2347         'ratetimenum',    'int', '', '', '', '',
2348       ],
2349       'primary_key' => 'intervalnum',
2350       'unique'      => [],
2351       'index'       => [],
2352     },
2353
2354     'usage_class' => {
2355       'columns' => [
2356         'classnum',    'serial',      '',      '', '', '',
2357         'weight',      'int',     'NULL',      '', '', '',
2358         'classname',   'varchar',     '', $char_d, '', '',
2359         'format',      'varchar', 'NULL', $char_d, '', '',
2360         'disabled',    'char',    'NULL',       1, '', '',
2361       ],
2362       'primary_key' => 'classnum',
2363       'unique' => [],
2364       'index' => [ ['disabled'] ],
2365     },
2366
2367     'reg_code' => {
2368       'columns' => [
2369         'codenum',   'serial',    '', '', '', '',
2370         'code',      'varchar',   '', $char_d, '', '',
2371         'agentnum',  'int',       '', '', '', '',
2372       ],
2373       'primary_key' => 'codenum',
2374       'unique'      => [ [ 'agentnum', 'code' ] ],
2375       'index'       => [ [ 'agentnum' ] ],
2376     },
2377
2378     'reg_code_pkg' => {
2379       'columns' => [
2380         'codepkgnum', 'serial', '', '', '', '',
2381         'codenum',   'int',    '', '', '', '',
2382         'pkgpart',   'int',    '', '', '', '',
2383       ],
2384       'primary_key' => 'codepkgnum',
2385       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2386       'index'       => [ [ 'codenum' ] ],
2387     },
2388
2389     'clientapi_session' => {
2390       'columns' => [
2391         'sessionnum',  'serial',  '', '', '', '',
2392         'sessionid',  'varchar',  '', $char_d, '', '',
2393         'namespace',  'varchar',  '', $char_d, '', '',
2394       ],
2395       'primary_key' => 'sessionnum',
2396       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2397       'index'       => [],
2398     },
2399
2400     'clientapi_session_field' => {
2401       'columns' => [
2402         'fieldnum',    'serial',     '', '', '', '',
2403         'sessionnum',     'int',     '', '', '', '',
2404         'fieldname',  'varchar',     '', $char_d, '', '',
2405         'fieldvalue',    'text', 'NULL', '', '', '',
2406       ],
2407       'primary_key' => 'fieldnum',
2408       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2409       'index'       => [],
2410     },
2411
2412     'payment_gateway' => {
2413       'columns' => [
2414         'gatewaynum',       'serial',   '',     '', '', '',
2415         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2416         'gateway_module',   'varchar',  '',     $char_d, '', '',
2417         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2418         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2419         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2420         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2421         'disabled',   'char',  'NULL',   1, '', '',
2422       ],
2423       'primary_key' => 'gatewaynum',
2424       'unique' => [],
2425       'index'  => [ [ 'disabled' ] ],
2426     },
2427
2428     'payment_gateway_option' => {
2429       'columns' => [
2430         'optionnum',   'serial',  '',     '', '', '',
2431         'gatewaynum',  'int',     '',     '', '', '',
2432         'optionname',  'varchar', '',     $char_d, '', '',
2433         'optionvalue', 'text',    'NULL', '', '', '',
2434       ],
2435       'primary_key' => 'optionnum',
2436       'unique'      => [],
2437       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2438     },
2439
2440     'agent_payment_gateway' => {
2441       'columns' => [
2442         'agentgatewaynum', 'serial', '', '', '', '',
2443         'agentnum',        'int', '', '', '', '',
2444         'gatewaynum',      'int', '', '', '', '',
2445         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2446         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2447       ],
2448       'primary_key' => 'agentgatewaynum',
2449       'unique'      => [],
2450       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2451     },
2452
2453     'banned_pay' => {
2454       'columns' => [
2455         'bannum',  'serial',   '',     '', '', '',
2456         'payby',   'char',     '',       4, '', '',
2457         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2458         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2459         '_date',   @date_type, '', '',
2460         'otaker',  'varchar',  'NULL',     32, '', '',
2461         'usernum',   'int', 'NULL', '', '', '',
2462         'reason',  'varchar',  'NULL', $char_d, '', '',
2463       ],
2464       'primary_key' => 'bannum',
2465       'unique'      => [ [ 'payby', 'payinfo' ] ],
2466       'index'       => [ [ 'usernum' ] ],
2467     },
2468
2469     'pkg_category' => {
2470       'columns' => [
2471         'categorynum',   'serial',  '', '', '', '',
2472         'categoryname',  'varchar', '', $char_d, '', '',
2473         'weight',         'int', 'NULL',  '', '', '',
2474         'condense',      'char', 'NULL',   1, '', '',
2475         'disabled',      'char', 'NULL',   1, '', '',
2476       ],
2477       'primary_key' => 'categorynum',
2478       'unique' => [],
2479       'index' => [ ['disabled'] ],
2480     },
2481
2482     'pkg_class' => {
2483       'columns' => [
2484         'classnum',    'serial',   '',      '', '', '',
2485         'classname',   'varchar',  '', $char_d, '', '',
2486         'categorynum', 'int',  'NULL',      '', '', '',
2487         'disabled',    'char', 'NULL',       1, '', '',
2488       ],
2489       'primary_key' => 'classnum',
2490       'unique' => [],
2491       'index' => [ ['disabled'] ],
2492     },
2493
2494     'cdr' => {
2495       'columns' => [
2496         # qw( name type null length default local );
2497
2498         ###
2499         #asterisk fields
2500         ###
2501
2502         'acctid',   'bigserial',  '', '', '', '',
2503         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2504         'calldate', 'timestamp',   '',      '', \'now()', '',
2505         'clid',        'varchar',  '', $char_d, \"''", '',
2506         'src',         'varchar',  '', $char_d, \"''", '',
2507         'dst',         'varchar',  '', $char_d, \"''", '',
2508         'dcontext',    'varchar',  '', $char_d, \"''", '',
2509         'channel',     'varchar',  '', $char_d, \"''", '',
2510         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2511         'lastapp',     'varchar',  '', $char_d, \"''", '',
2512         'lastdata',    'varchar',  '', $char_d, \"''", '',
2513
2514         #these don't seem to be logged by most of the SQL cdr_* modules
2515         #except tds under sql-illegal names, so;
2516         # ... don't rely on them for rating?
2517         # and, what they hey, i went ahead and changed the names and data types
2518         # to freeside-style dates...
2519           #'start',  'timestamp', 'NULL',  '',    '', '',
2520           #'answer', 'timestamp', 'NULL',  '',    '', '',
2521           #'end',    'timestamp', 'NULL',  '',    '', '',
2522         'startdate',  @date_type, '', '',
2523         'answerdate', @date_type, '', '',
2524         'enddate',    @date_type, '', '',
2525         #
2526
2527         'duration',    'int',      '',      '',     0, '',
2528         'billsec',     'int',      '',      '',     0, '',
2529         'disposition', 'varchar',  '',      45, \"''", '',
2530         'amaflags',    'int',      '',      '',     0, '',
2531         'accountcode', 'varchar',  '',      20, \"''", '',
2532         'uniqueid',    'varchar',  '',      32, \"''", '',
2533         'userfield',   'varchar',  '',     255, \"''", '',
2534
2535         'max_callers', 'int',  'NULL',      '',    '', '',
2536
2537         ###
2538         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2539         # defaults
2540         # though these are now used elsewhere:
2541         # charged_party, upstream_price, rated_price, carrierid
2542         ###
2543
2544         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2545         'cdrtypenum',              'int', 'NULL',      '', '', '',
2546
2547         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2548
2549         'upstream_currency',      'char', 'NULL',       3, '', '',
2550         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2551         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2552
2553         # how it was rated internally...
2554         'ratedetailnum',           'int', 'NULL',      '', '', '',
2555         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2556
2557         'distance',            'decimal', 'NULL',      '', '', '',
2558         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2559
2560         #cdr_calltype: the big list in appendix 2
2561         'calltypenum',             'int', 'NULL',      '', '', '',
2562
2563         'description',         'varchar', 'NULL', $char_d, '', '',
2564         'quantity',                'int', 'NULL',      '', '', '',
2565
2566         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2567         'carrierid',               'int', 'NULL',      '', '', '',
2568
2569         'upstream_rateid',         'int', 'NULL',      '', '', '',
2570
2571         ###
2572         #and now for our own fields
2573         ###
2574
2575         # a svcnum... right..?
2576         'svcnum',             'int',   'NULL',     '',   '', '',
2577
2578         #NULL, done (or something)
2579         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2580
2581         #NULL, done (or something)
2582         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2583
2584         #an indexed place to put big numbers
2585         'cdrid',         'bigint',     'NULL',     '',  '', '',
2586
2587         #old
2588         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2589         #new
2590         'cdrbatchnum', 'int', 'NULL', '', '', '',
2591
2592       ],
2593       'primary_key' => 'acctid',
2594       'unique' => [],
2595       'index' => [ [ 'calldate' ],
2596                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2597                    [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2598                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2599                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2600                  ],
2601     },
2602
2603     'cdr_batch' => {
2604       'columns' => [
2605         'cdrbatchnum',   'serial',    '',   '', '', '',
2606         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2607         '_date',     @date_type, '', '',
2608       ],
2609       'primary_key' => 'cdrbatchnum',
2610       'unique' => [ [ 'cdrbatch' ] ],
2611       'index' => [],
2612     },
2613
2614     'cdr_termination' => {
2615       'columns' => [
2616         'cdrtermnum', 'bigserial',     '',      '', '', '',
2617         'acctid',        'bigint',     '',      '', '', '',
2618         'termpart',         'int',     '',      '', '', '',#future use see below
2619         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2620         'status',       'varchar', 'NULL',      32, '', '',
2621         'svcnum',           'int', 'NULL',      '', '', '',
2622       ],
2623       'primary_key' => 'cdrtermnum',
2624       'unique'      => [ [ 'acctid', 'termpart' ] ],
2625       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2626     },
2627
2628     #to handle multiple termination/settlement passes...
2629    # 'part_termination' => {
2630    #   'columns' => [
2631    #     'termpart',       'int', '',      '', '', '',
2632    #     'termname',   'varchar', '', $char_d, '', '',
2633    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2634    #   ],
2635    #   'primary_key' => 'termpart',
2636    #   'unique' => [],
2637    #   'index'  => [],
2638    # },
2639
2640     #the remaining cdr_ tables are not really used
2641     'cdr_calltype' => {
2642       'columns' => [
2643         'calltypenum',   'serial',  '', '', '', '',
2644         'calltypename',  'varchar', '', $char_d, '', '',
2645       ],
2646       'primary_key' => 'calltypenum',
2647       'unique'      => [],
2648       'index'       => [],
2649     },
2650
2651     'cdr_type' => {
2652       'columns' => [
2653         'cdrtypenum'  => 'serial',  '', '', '', '',
2654         'cdrtypename' => 'varchar', '', $char_d, '', '',
2655       ],
2656       'primary_key' => 'cdrtypenum',
2657       'unique'      => [],
2658       'index'       => [],
2659     },
2660
2661     'cdr_carrier' => {
2662       'columns' => [
2663         'carrierid'   => 'serial',  '', '', '', '',
2664         'carriername' => 'varchar', '', $char_d, '', '',
2665       ],
2666       'primary_key' => 'carrierid',
2667       'unique'      => [],
2668       'index'       => [],
2669     },
2670
2671     #'cdr_file' => {
2672     #  'columns' => [
2673     #    'filenum',    'serial',     '', '', '', '',
2674     #    'filename',  'varchar',     '', '', '', '',
2675     #    'status',    'varchar', 'NULL', '', '', '',
2676     #  ],
2677     #  'primary_key' => 'filenum',
2678     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2679     #                                   # agent-virtualize or have a customer
2680     #                                   # with dup-filename needs or something
2681     #                                   # (only used by cdr.http_and_import for
2682     #                                   #  chrissakes)
2683     #  'index'  => [],
2684     #},
2685
2686     'inventory_item' => {
2687       'columns' => [
2688         'itemnum',  'serial',      '',      '', '', '',
2689         'classnum', 'int',         '',      '', '', '',
2690         'agentnum', 'int',     'NULL',      '', '', '',
2691         'item',     'varchar',     '', $char_d, '', '',
2692         'svcnum',   'int',     'NULL',      '', '', '',
2693       ],
2694       'primary_key' => 'itemnum',
2695       'unique' => [ [ 'classnum', 'item' ] ],
2696       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
2697     },
2698
2699     'inventory_class' => {
2700       'columns' => [
2701         'classnum',  'serial',       '',      '', '', '',
2702         'classname', 'varchar',      '', $char_d, '', '',
2703       ],
2704       'primary_key' => 'classnum',
2705       'unique' => [],
2706       'index'  => [],
2707     },
2708
2709     'access_user' => {
2710       'columns' => [
2711         'usernum',   'serial',  '',      '', '', '',
2712         'username',  'varchar', '', $char_d, '', '',
2713         '_password', 'varchar', '', $char_d, '', '',
2714         'last',      'varchar', '', $char_d, '', '',
2715         'first',     'varchar', '', $char_d, '', '',
2716         'user_custnum',  'int', 'NULL',  '', '', '',
2717         'disabled',     'char', 'NULL',   1, '', '',
2718       ],
2719       'primary_key' => 'usernum',
2720       'unique' => [ [ 'username' ] ],
2721       'index'  => [ [ 'user_custnum' ] ],
2722     },
2723
2724     'access_user_pref' => {
2725       'columns' => [
2726         'prefnum',    'serial',       '', '', '', '',
2727         'usernum',     'int',       '', '', '', '',
2728         'prefname', 'varchar', '', $char_d, '', '',
2729         'prefvalue', 'text', 'NULL', '', '', '',
2730         'expiration', @date_type, '', '',
2731       ],
2732       'primary_key' => 'prefnum',
2733       'unique' => [],
2734       'index'  => [ [ 'usernum' ] ],
2735     },
2736
2737     'access_group' => {
2738       'columns' => [
2739         'groupnum',   'serial', '',      '', '', '',
2740         'groupname', 'varchar', '', $char_d, '', '',
2741       ],
2742       'primary_key' => 'groupnum',
2743       'unique' => [ [ 'groupname' ] ],
2744       'index'  => [],
2745     },
2746
2747     'access_usergroup' => {
2748       'columns' => [
2749         'usergroupnum', 'serial', '', '', '', '',
2750         'usernum',         'int', '', '', '', '',
2751         'groupnum',        'int', '', '', '', '',
2752       ],
2753       'primary_key' => 'usergroupnum',
2754       'unique' => [ [ 'usernum', 'groupnum' ] ],
2755       'index'  => [ [ 'usernum' ] ],
2756     },
2757
2758     'access_groupagent' => {
2759       'columns' => [
2760         'groupagentnum', 'serial', '', '', '', '',
2761         'groupnum',         'int', '', '', '', '',
2762         'agentnum',         'int', '', '', '', '',
2763       ],
2764       'primary_key' => 'groupagentnum',
2765       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2766       'index'  => [ [ 'groupnum' ] ],
2767     },
2768
2769     'access_right' => {
2770       'columns' => [
2771         'rightnum',   'serial', '',      '', '', '',
2772         'righttype', 'varchar', '', $char_d, '', '',
2773         'rightobjnum',   'int', '',      '', '', '',
2774         'rightname', 'varchar', '', $char_d, '', '',
2775       ],
2776       'primary_key' => 'rightnum',
2777       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2778       'index'  => [],
2779     },
2780
2781     'svc_phone' => {
2782       'columns' => [
2783         'svcnum',       'int',         '',      '', '', '',
2784         'countrycode',  'varchar',     '',       3, '', '',
2785         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2786         'pin',          'varchar', 'NULL', $char_d, '', '',
2787         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2788         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2789         'pbxsvc',           'int', 'NULL',      '', '', '',
2790         'domsvc',           'int', 'NULL',      '', '', '',
2791         'locationnum',      'int', 'NULL', '', '', '',
2792         'forwarddst',     'varchar',     'NULL',      15, '', '',
2793         'email',           'varchar', 'NULL',  255, '', '',
2794         'lnp_status',   'varchar', 'NULL', $char_d, '', '',
2795         'portable',     'char', 'NULL',       1,  '', '',
2796         'lrn',     'char',     'NULL',      10, '', '',
2797         'lnp_desired_due_date',     'int', 'NULL',       '', '', '',
2798         'lnp_due_date',     'int', 'NULL',       '', '', '',
2799         'lnp_other_provider', 'varchar', 'NULL', $char_d,  '', '',
2800         'lnp_other_provider_account', 'varchar', 'NULL', $char_d,  '', '',
2801         'lnp_reject_reason', 'varchar', 'NULL', $char_d,  '', '',
2802       ],
2803       'primary_key' => 'svcnum',
2804       'unique' => [],
2805       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
2806                     ['locationnum'],
2807                   ],
2808     },
2809
2810     'phone_device' => {
2811       'columns' => [
2812         'devicenum', 'serial',     '', '', '', '',
2813         'devicepart',   'int',     '', '', '', '',
2814         'svcnum',       'int',     '', '', '', '',
2815         'mac_addr', 'varchar', 'NULL', 12, '', '',
2816       ],
2817       'primary_key' => 'devicenum',
2818       'unique' => [ [ 'mac_addr' ], ],
2819       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
2820     },
2821
2822     'part_device' => {
2823       'columns' => [
2824         'devicepart', 'serial',  '',      '', '', '',
2825         'devicename', 'varchar', '', $char_d, '', '',
2826         'inventory_classnum', 'int', 'NULL', '', '', '',
2827       ],
2828       'primary_key' => 'devicepart',
2829       'unique' => [ [ 'devicename' ] ], #?
2830       'index'  => [],
2831     },
2832
2833     'phone_avail' => {
2834       'columns' => [
2835         'availnum',    'serial',      '',      '', '', '',
2836         'exportnum',   'int',         '',      '', '', '',
2837         'countrycode', 'varchar',     '',       3, '', '',
2838         'state',       'char',    'NULL',       2, '', '',
2839         'npa',         'char',        '',       3, '', '',
2840         'nxx',         'char',    'NULL',       3, '', '',
2841         'station',     'char',    'NULL',       4, '', '',
2842         'name',        'varchar', 'NULL', $char_d, '', '',
2843         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
2844         'ordernum',      'int',     'NULL',      '', '', '',
2845         'svcnum',      'int',     'NULL',      '', '', '',
2846         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2847       ],
2848       'primary_key' => 'availnum',
2849       'unique' => [],
2850       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2851                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2852                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2853                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2854                     [ 'svcnum' ],
2855                     [ 'availbatch' ],
2856                   ],
2857     },
2858
2859     'lata' => {
2860       'columns' => [
2861         'latanum',    'int',      '',      '', '', '',
2862         'description',   'varchar',    '',      $char_d, '', '',
2863       ],
2864       'primary_key' => 'latanum',
2865       'unique' => [],
2866       'index'  => [],
2867     },
2868
2869     'did_vendor' => {
2870       'columns' => [
2871         'vendornum',    'serial',      '',      '', '', '',
2872         'vendorname',   'varchar',        '',     $char_d, '', '',
2873       ],
2874       'primary_key' => 'vendornum',
2875       'unique' => [],
2876       'index'  => [],
2877     },
2878
2879     'did_order' => {
2880       'columns' => [
2881         'ordernum',    'serial',      '',      '', '', '',
2882         'vendornum',   'int',       '',      '', '', '',
2883         'vendor_order_id',   'varchar',  '',   $char_d, '', '',
2884         'msa',        'varchar', 'NULL', $char_d, '', '',
2885         'latanum',      'int',     'NULL',      '', '', '',
2886         'rate_center',        'varchar', 'NULL', $char_d, '', '',
2887         'state',       'char',    'NULL',       2, '', '',
2888         'quantity',      'int',     '',      '', '', '',
2889         'submitted',      'int',     '',      '', '', '',
2890         'confirmed',      'int',     'NULL',      '', '', '',
2891         'received',      'int',     'NULL',      '', '', '',
2892       ],
2893       'primary_key' => 'ordernum',
2894       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
2895       'index'  => [],
2896     },
2897
2898     'reason_type' => {
2899       'columns' => [
2900         'typenum',   'serial',  '', '', '', '',
2901         'class',     'char', '', 1, '', '',
2902         'type',     'varchar', '', $char_d, '', '',
2903       ],
2904       'primary_key' => 'typenum',
2905       'unique' => [],
2906       'index' => [],
2907     },
2908
2909     'reason' => {
2910       'columns' => [
2911         'reasonnum',     'serial',  '', '', '', '',
2912         'reason_type',   'int',  '', '', '', '',
2913         'reason',        'text', '', '', '', '',
2914         'disabled',      'char',    'NULL', 1, '', '',
2915       ],
2916       'primary_key' => 'reasonnum',
2917       'unique' => [],
2918       'index' => [],
2919     },
2920
2921     'conf' => {
2922       'columns' => [
2923         'confnum',  'serial',  '', '', '', '',
2924         'agentnum', 'int',  'NULL', '', '', '',
2925         'name',     'varchar', '', $char_d, '', '',
2926         'value',    'text', 'NULL', '', '', '',
2927       ],
2928       'primary_key' => 'confnum',
2929       'unique' => [ [ 'agentnum', 'name' ]],
2930       'index' => [],
2931     },
2932
2933     'pkg_referral' => {
2934       'columns' => [
2935         'pkgrefnum',     'serial', '', '', '', '',
2936         'pkgnum',        'int',    '', '', '', '',
2937         'refnum',        'int',    '', '', '', '',
2938       ],
2939       'primary_key' => 'pkgrefnum',
2940       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2941       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2942     },
2943
2944     'svc_pbx' => {
2945       'columns' => [
2946         'svcnum',           'int',     '',      '', '', '',
2947         'id',               'int', 'NULL',      '', '', '',
2948         'title',        'varchar', 'NULL', $char_d, '', '',
2949         'max_extensions',   'int', 'NULL',      '', '', '',
2950         'max_simultaneous', 'int', 'NULL',      '', '', '',
2951       ],
2952       'primary_key' => 'svcnum',
2953       'unique' => [],
2954       'index'  => [ [ 'id' ] ],
2955     },
2956
2957     'svc_mailinglist' => { #svc_group?
2958       'columns' => [
2959         'svcnum',            'int',     '',            '', '', '',
2960         'username',      'varchar',     '', $username_len, '', '',
2961         'domsvc',            'int',     '',            '', '', '',
2962         'listnum',           'int',     '',            '', '', '',
2963         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
2964         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
2965         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
2966         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
2967       ],
2968       'primary_key' => 'svcnum',
2969       'unique' => [],
2970       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
2971     },
2972
2973     'mailinglist' => {
2974       'columns' => [
2975         'listnum',   'serial', '',      '', '', '',
2976         'listname', 'varchar', '', $char_d, '', '',
2977       ],
2978       'primary_key' => 'listnum',
2979       'unique' => [],
2980       'index'  => [],
2981     },
2982
2983     'mailinglistmember' => {
2984       'columns' => [
2985         'membernum',        'serial',     '',   '', '', '',
2986         'listnum',             'int',     '',   '', '', '',
2987         'svcnum',              'int', 'NULL',   '', '', '',
2988         'contactemailnum',     'int', 'NULL',   '', '', '',
2989         'email',           'varchar', 'NULL',  255, '', '',
2990       ],
2991       'primary_key' => 'membernum',
2992       'unique'      => [],
2993       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
2994     },
2995
2996     'bill_batch' => {
2997       'columns' => [
2998         'batchnum',         'serial',     '', '', '', '',
2999         'status',             'char', 'NULL','1', '', '',
3000         'pdf',                'blob', 'NULL', '', '', '',
3001       ],
3002       'primary_key' => 'batchnum',
3003       'unique'      => [],
3004       'index'       => [],
3005     },
3006
3007     'cust_bill_batch' => {
3008       'columns' => [
3009         'billbatchnum',     'serial',     '', '', '', '',
3010         'batchnum',            'int',     '', '', '', '',
3011         'invnum',              'int',     '', '', '', '',
3012       ],
3013       'primary_key' => 'billbatchnum',
3014       'unique'      => [],
3015       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
3016     },
3017
3018     'cust_bill_batch_option' => {
3019       'columns' => [
3020         'optionnum', 'serial', '', '', '', '',
3021         'billbatchnum', 'int', '', '', '', '',
3022         'optionname', 'varchar', '', $char_d, '', '',
3023         'optionvalue', 'text', 'NULL', '', '', '',
3024       ],
3025       'primary_key' => 'optionnum',
3026       'unique'      => [],
3027       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
3028     },
3029
3030     'msg_template' => {
3031       'columns' => [
3032         'msgnum',     'serial',     '',      '', '', '',
3033         'msgname',   'varchar',     '', $char_d, '', '',
3034         'agentnum',      'int', 'NULL',      '', '', '',
3035         'subject',   'varchar', 'NULL',     512, '', '',
3036         'mime_type', 'varchar',     '', $char_d, '', '',
3037         'body',         'blob', 'NULL',      '', '', '',
3038         'disabled',     'char', 'NULL',       1, '', '',
3039         'from_addr', 'varchar', 'NULL',     255, '', '',
3040         'bcc_addr',  'varchar', 'NULL',     255, '', '',
3041       ],
3042       'primary_key' => 'msgnum',
3043       'unique'      => [ ['msgname', 'mime_type'] ],
3044       'index'       => [ ['agentnum'], ]
3045     },
3046
3047     'svc_cert' => {
3048       'columns' => [
3049         'svcnum',                'int',     '',      '', '', '',
3050         'recnum',                'int', 'NULL',      '', '', '',
3051         'privatekey',           'text', 'NULL',      '', '', '',
3052         'csr',                  'text', 'NULL',      '', '', '',
3053         'certificate',          'text', 'NULL',      '', '', '',
3054         'cacert',               'text', 'NULL',      '', '', '',
3055         'common_name',       'varchar', 'NULL', $char_d, '', '',
3056         'organization',      'varchar', 'NULL', $char_d, '', '',
3057         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
3058         'city',              'varchar', 'NULL', $char_d, '', '',
3059         'state',             'varchar', 'NULL', $char_d, '', '',
3060         'country',              'char', 'NULL',       2, '', '',
3061         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
3062       ],
3063       'primary_key' => 'svcnum',
3064       'unique' => [],
3065       'index'  => [], #recnum
3066     },
3067
3068     'nms_device' => {
3069       'columns' => [
3070         'nms_devicenum', 'serial',     '',      '', '', '',
3071         #'agentnum',         'int', 'NULL',      '', '', '',
3072         'devicename',   'varchar',     '', $char_d, '', '',
3073         'ip',           'varchar',     '',      15, '', '',
3074         'protocol',     'varchar',     '', $char_d, '', '',
3075 #        'last',     'int',     '',    '', '', '',
3076       ],
3077       'primary_key' => 'nms_devicenum',
3078       'unique' => [],
3079       'index'  => [],
3080     },
3081
3082     'nms_deviceport' => {
3083       'columns' => [
3084         'portnum',       'serial',     '', '', '', '',
3085         'nms_devicenum',    'int',     '', '', '', '',
3086         'deviceport',       'int',     '', '', '', '',
3087         #'ip',       'varchar', 'NULL', 15, '', '',
3088         'svcnum',           'int', 'NULL', '', '', '',
3089       ],
3090       'primary_key' => 'portnum',
3091       'unique'      => [ [ 'nms_devicenum', 'deviceport' ] ],
3092       'index'       => [ [ 'svcnum' ] ],
3093     },
3094
3095     'svc_port' => {
3096       'columns' => [
3097         'svcnum',                'int',     '',      '', '', '',
3098       ],
3099       'primary_key' => 'svcnum',
3100       'unique' => [],
3101       'index'  => [], #recnum
3102     },
3103
3104
3105     # name type nullability length default local
3106
3107     #'new_table' => {
3108     #  'columns' => [
3109     #    'num', 'serial',       '', '', '', '',
3110     #  ],
3111     #  'primary_key' => 'num',
3112     #  'unique' => [],
3113     #  'index'  => [],
3114     #},
3115
3116   };
3117
3118 }
3119
3120 =back
3121
3122 =head1 BUGS
3123
3124 =head1 SEE ALSO
3125
3126 L<DBIx::DBSchema>
3127
3128 =cut
3129
3130 1;
3131