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