FS/FS/Schema.pm

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