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