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