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