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