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