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