FS/FS/Schema.pm

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