FS/FS/Schema.pm

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