FS/FS/Schema.pm

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