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