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.44; #for foreign keys with MATCH / ON DELETE/UPDATE
   7 use DBIx::DBSchema::Table;
   8 use DBIx::DBSchema::Column;
   9 use DBIx::DBSchema::Index;
  10 use DBIx::DBSchema::ForeignKey;
  11 #can't use this yet, dependency bs #use FS::Conf;
  12
  13 @ISA = qw(Exporter);
  14 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  15
  16 $DEBUG = 0;
  17 $me = '[FS::Schema]';
  18
  19 =head1 NAME
  20
  21 FS::Schema - Freeside database schema
  22
  23 =head1 SYNOPSYS
  24
  25     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  26
  27     $dbdef = reload_dbdef;
  28     $dbdef = reload_dbdef "/non/standard/filename";
  29     $dbdef = dbdef;
  30     $dbdef_dist = dbdef_dist;
  31
  32 =head1 DESCRIPTION
  33
  34 This class represents the database schema.
  35
  36 =head1 METHODS
  37
  38 =over 4
  39
  40 =item reload_dbdef([FILENAME])
  41
  42 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  43 non-default filename.  This command is executed at startup unless
  44 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  45
  46 =cut
  47
  48 sub reload_dbdef {
  49   my $file = shift;
  50
  51   unless ( exists $dbdef_cache{$file} ) {
  52     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  53     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  54       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  55   } else {
  56     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  57   }
  58   $dbdef = $dbdef_cache{$file};
  59   FS::Record::fk_methods_init();
  60 }
  61
  62 =item dbdef
  63
  64 Returns the current database definition (represents the current database,
  65 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  66
  67 =cut
  68
  69 sub dbdef { $dbdef; }
  70
  71 =item dbdef_dist [ DATASRC ]
  72
  73 Returns the current canoical database definition as defined in this file.
  74
  75 Optionally, pass a DBI data source to enable syntax specific to that database.
  76 Currently, this enables "ENGINE=InnoDB" for MySQL databases.
  77
  78 =cut
  79
  80 sub dbdef_dist {
  81   my $datasrc = @_ && !ref($_[0]) ? shift : '';
  82   my $opt = @_ ? shift : {};
  83
  84   my $local_options = '';
  85   if ( $datasrc =~ /^dbi:mysql/i ) {
  86     $local_options = 'ENGINE=InnoDB';
  87   }
  88
  89   ###
  90   # create a dbdef object from the old data structure
  91   ###
  92
  93   my $tables_hashref = tables_hashref();
  94
  95   #turn it into objects
  96   my $dbdef = new DBIx::DBSchema map {
  97
  98     my $tablename = $_;
  99     my $indexnum = 1;
 100
 101     my @columns;
 102     while (@{$tables_hashref->{$tablename}{'columns'}}) {
 103       #my($name, $type, $null, $length, $default, $local) =
 104       my @coldef =
 105         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
 106       my %hash = map { $_ => shift @coldef }
 107                      qw( name type null length default local );
 108
 109       #can be removed once we depend on DBIx::DBSchema 0.39;
 110       $hash{'type'} = 'LONGTEXT'
 111         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 112
 113       unless ( defined $hash{'default'} ) {
 114         warn "$tablename:\n".
 115              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 116       }
 117
 118       push @columns, new DBIx::DBSchema::Column ( \%hash );
 119     }
 120
 121     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 122     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 123     my $unique = $tables_hashref->{$tablename}{'unique'};
 124     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
 125     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 126
 127     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 128     #  specification without a key length".
 129     # better solution: teach DBIx::DBSchema to specify a default length for
 130     #  MySQL indices on text columns, or just to support an index length at all
 131     #  so we can pass something in.
 132     # best solution: eliminate need for this index in cust_main::retry_realtime
 133     @index = grep { @{$_}[0] ne 'statustext' } @index
 134       if $datasrc =~ /^dbi:mysql/i;
 135
 136     my @indices = ();
 137     push @indices, map {
 138                          DBIx::DBSchema::Index->new({
 139                            'name'    => $tablename. $indexnum++,
 140                            'unique'  => 1,
 141                            'columns' => $_,
 142                          });
 143                        }
 144                        @$unique;
 145     push @indices, map {
 146                          DBIx::DBSchema::Index->new({
 147                            'name'    => $tablename. $indexnum++,
 148                            'unique'  => 0,
 149                            'columns' => $_,
 150                          });
 151                        }
 152                        @index;
 153
 154     my @foreign_keys =
 155       map DBIx::DBSchema::ForeignKey->new($_),
 156         @{ $tables_hashref->{$tablename}{'foreign_keys'} || [] };
 157
 158     DBIx::DBSchema::Table->new({
 159       name          => $tablename,
 160       primary_key   => $tables_hashref->{$tablename}{'primary_key'},
 161       columns       => \@columns,
 162       indices       => \@indices,
 163       foreign_keys  => \@foreign_keys,
 164       local_options => $local_options,
 165     });
 166
 167   } keys %$tables_hashref;
 168
 169   if ( $DEBUG ) {
 170     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 171     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 172   }
 173
 174   #add radius attributes to svc_acct
 175   #
 176   #my($svc_acct)=$dbdef->table('svc_acct');
 177   #
 178   #my($attribute);
 179   #foreach $attribute (@attributes) {
 180   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 181   #    'radius_'. $attribute,
 182   #    'varchar',
 183   #    'NULL',
 184   #    $char_d,
 185   #  ));
 186   #}
 187   #
 188   #foreach $attribute (@check_attributes) {
 189   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 190   #    'rc_'. $attribute,
 191   #    'varchar',
 192   #    'NULL',
 193   #    $char_d,
 194   #  ));
 195   #}
 196
 197   my $tables_hashref_torrus = tables_hashref_torrus();
 198
 199   #create history tables
 200   foreach my $table (
 201     grep {    ! /^(clientapi|access_user)_session/
 202            && ! /^h_/
 203            && ! /^log(_context)?$/
 204            && ! /^(legacy_cust_history|cacti_page|template_image|access_user_log)$/
 205            && ( ! /^queue(_arg|_depend|_stat)?$/ || ! $opt->{'queue-no_history'} )
 206            && ! $tables_hashref_torrus->{$_}
 207          }
 208       $dbdef->tables
 209   ) {
 210     my $tableobj = $dbdef->table($table)
 211       or die "unknown table $table";
 212
 213     my %h_indices = ();
 214
 215     unless ( $table eq 'cust_event' || $table eq 'cdr' ) { #others?
 216
 217       my %indices = $tableobj->indices;
 218
 219       %h_indices = map {
 220                          ( "h_$_" =>
 221                              DBIx::DBSchema::Index->new({
 222                                'name'    => 'h_'. $indices{$_}->name,
 223                                'unique'  => 0,
 224                                'columns' => [ @{$indices{$_}->columns} ],
 225                              })
 226                          );
 227                        }
 228                        keys %indices;
 229
 230       $h_indices{"h_${table}_srckey"} =
 231         DBIx::DBSchema::Index->new({
 232           'name'    => "h_${table}_srckey",
 233           'unique'  => 0,
 234           'columns' => [ 'history_action', #right?
 235                          $tableobj->primary_key,
 236                        ],
 237         });
 238
 239       $h_indices{"h_${table}_srckey2"} =
 240          DBIx::DBSchema::Index->new({
 241            'name'    => "h_${table}_srckey2",
 242            'unique'  => 0,
 243            'columns' => [ 'history_date',
 244                           $tableobj->primary_key,
 245                         ],
 246          });
 247
 248         #necessary for queries that want to look at *who* made changes
 249       $h_indices{"h_${table}_usernum"} =
 250          DBIx::DBSchema::Index->new({
 251            'name'    => "h_${table}_usernum",
 252            'unique'  => 0,
 253            'columns' => [ 'history_usernum'],
 254          });
 255
 256         # necessary because of the evil OR username for older data, be really nice if everything was just migrated to usernum and we could drop username
 257         # This will not be helpful to mysql, but postgres smartly does a bitmap across both indexes, mysql will just use one
 258
 259       $h_indices{"h_${table}_user"} =
 260          DBIx::DBSchema::Index->new({
 261            'name'    => "h_${table}_user",
 262            'unique'  => 0,
 263            'columns' => [ 'history_user'],
 264          });
 265     }
 266
 267     my $primary_key_col = $tableobj->column($tableobj->primary_key)
 268       or die "$table: primary key declared as ". $tableobj->primary_key.
 269              ", but no column of that name\n";
 270
 271     my $historynum_type = ( $tableobj->column($tableobj->primary_key)->type
 272                               =~ /^(bigserial|bigint|int8)$/i
 273                                 ? 'bigserial'
 274                                 : 'serial'
 275                           );
 276
 277     my $h_tableobj = DBIx::DBSchema::Table->new( {
 278       'name'          => "h_$table",
 279       'primary_key'   => 'historynum',
 280       'indices'       => \%h_indices,
 281       'local_options' => $local_options,
 282       'columns'       => [
 283           DBIx::DBSchema::Column->new( {
 284             'name'    => 'historynum',
 285             'type'    => $historynum_type,
 286             'null'    => 'NOT NULL',
 287             'length'  => '',
 288             'default' => '',
 289             'local'   => '',
 290           } ),
 291           DBIx::DBSchema::Column->new( {
 292             'name'    => 'history_date',
 293             'type'    => 'int',
 294             'null'    => 'NULL',
 295             'length'  => '',
 296             'default' => '',
 297             'local'   => '',
 298           } ),
 299           DBIx::DBSchema::Column->new( {
 300             'name'    => 'history_user',
 301             'type'    => 'varchar',
 302             'null'    => 'NULL',
 303             'length'  => '80',
 304             'default' => '',
 305             'local'   => '',
 306           } ),
 307           DBIx::DBSchema::Column->new( {
 308             'name'    => 'history_usernum',
 309             'type'    => 'int',
 310             'null'    => 'NULL',
 311             'length'  => '',
 312             'default' => '',
 313             'local'   => '',
 314           } ),
 315           DBIx::DBSchema::Column->new( {
 316             'name'    => 'history_action',
 317             'type'    => 'varchar',
 318             'null'    => 'NOT NULL',
 319             'length'  => '80',
 320             'default' => '',
 321             'local'   => '',
 322           } ),
 323           map {
 324             my $column = $tableobj->column($_);
 325
 326             #clone so as to not disturb the original
 327             $column = DBIx::DBSchema::Column->new( {
 328               map { $_ => $column->$_() }
 329                 qw( name type null length default local )
 330             } );
 331
 332             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 333               $column->type(uc($1).'INT');
 334               $column->null('NULL');
 335             }
 336             #$column->default('')
 337             #  if $column->default =~ /^nextval\(/i;
 338             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 339             #$column->local($local);
 340             $column;
 341           } $tableobj->columns
 342       ],
 343     } );
 344     $dbdef->addtable($h_tableobj);
 345   }
 346
 347   if ( $datasrc =~ /^dbi:mysql/i ) {
 348
 349     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 350       'name'          => 'duplicate_lock',
 351       'primary_key'   => 'duplocknum',
 352       'local_options' => $local_options,
 353       'columns'       => [
 354         DBIx::DBSchema::Column->new( {
 355           'name'    => 'duplocknum',
 356           'type'    => 'serial',
 357           'null'    => 'NOT NULL',
 358           'length'  => '',
 359           'default' => '',
 360           'local'   => '',
 361         } ),
 362         DBIx::DBSchema::Column->new( {
 363           'name'    => 'lockname',
 364           'type'    => 'varchar',
 365           'null'    => 'NOT NULL',
 366           'length'  => '80',
 367           'default' => '',
 368           'local'   => '',
 369         } ),
 370       ],
 371       'indices' => { 'duplicate_lock1' =>
 372                        DBIx::DBSchema::Index->new({
 373                          'name'    => 'duplicate_lock1',
 374                          'unique'  => 1,
 375                          'columns' => [ 'lockname' ],
 376                        })
 377                    },
 378     } );
 379
 380     $dbdef->addtable($dup_lock_table);
 381
 382   }
 383
 384   $dbdef;
 385
 386 }
 387
 388 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
 389 sub tables_hashref_torrus {
 390
 391   return {
 392
 393     # Collector export table. It usually grows at several megabytes
 394     # per month, and is updated every 5 minutes
 395     'srvexport' => {
 396       'columns' => [
 397         'id',         'serial', '', '', '', '',
 398         'srv_date',     'date', '', '', '', '',#date and time of the data sample
 399         'srv_time',     'time', '', '', '', '',
 400         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
 401         'value',     'double precision', '', '', '', '',#collected rate or gauge value
 402         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
 403       ],
 404       'primary_key' => 'id',
 405       'unique' => [],
 406       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
 407     },
 408
 409     #Tables for (currently monthly only) report contents.
 410     #These are updated usually once per month, and read at the moment of
 411     #rendering the report output (HTML now, PDF or XML or Excel or whatever
 412     #in the future)
 413
 414     #DBIx::Sequence backend, theplatform-independent inplementation
 415     #of sequences
 416     'dbix_sequence_state' => {
 417       'columns' => [
 418         'id',       'serial', '', '', '', '',
 419         'dataset', 'varchar', '', 50, '', '',
 420         'state_id',    'int', '', '', '', '',
 421       ],
 422       'primary_key' => 'id',
 423       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
 424       'unique' => [ [ 'dataset', 'state_id' ], ],
 425       'index'  => [],
 426     },
 427
 428     'dbix_sequence_release' => {
 429       'columns' => [
 430         'id',       'serial', '', '', '', '',
 431         'dataset', 'varchar', '', 50, '', '',
 432         'released_id', 'int', '', '', '', '',
 433       ],
 434       'primary_key' => 'id',
 435       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
 436       'unique' => [ [ 'dataset', 'released_id', ] ],
 437       'index'  => [],
 438     },
 439
 440     #Each report is characterized by name, date and time.
 441     #Monthly reports are automatically assigned 00:00 of the 1st day
 442     #in the month. The report contains fields for every service ID
 443     #defined across all datasource trees.
 444     'reports' => {
 445       'columns' => [
 446         'id',          'serial', '', '', '', '',
 447         'rep_date',      'date', '', '', '', '',#Start date of the report
 448         'rep_time',      'time', '', '', '', '',#Start time of the report
 449         'reportname', 'varchar', '', 64, '', '',#Report name, such as
 450                                                 # MonthlyUsage
 451         'iscomplete',     'int', '', '', '', '',#0 when the report is in
 452                                                 # progress, 1 when it is ready
 453       ],
 454       'primary_key' => 'id',
 455       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
 456       'index'  => [ [ 'rep_date' ] ],
 457     },
 458
 459     #Each report contains fields. For each service ID,
 460     #the report may contain several fields for various statistics.
 461     #Each field contains information about the units of the value it
 462     #contains
 463     'reportfields' => {
 464       'columns' => [
 465         'id',              'serial',     '', '',    '', '',
 466         'rep_id',             'int', 'NULL', '',    '', '',
 467         'name',           'varchar',     '', 64,    '', '',#name of the field,
 468                                                            # such as AVG or MAX
 469         'serviceid',      'varchar',     '', 64,    '', '',#service ID
 470         'value', 'double precision',     '', '',    '', '',#Numeric value
 471         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
 472                                                            # or Mbps
 473       ],
 474       'primary_key', => 'id',
 475       'unique' => [ [ qw(rep_id name serviceid) ] ],
 476       'index'  => [],
 477     },
 478
 479   };
 480
 481 }
 482
 483 sub tables_hashref {
 484
 485   my $char_d = 80; #default maxlength for text fields
 486
 487   #my(@date_type)  = ( 'timestamp', '', ''     );
 488   my @date_type = ( 'int', 'NULL', ''     );
 489   my @perl_type = ( 'text', 'NULL', ''  );
 490   my @money_type = ( 'decimal',   '', '10,2' );
 491   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 492   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 493   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 494
 495   my $username_len = 64; #usernamemax config file
 496
 497     # name type nullability length default local
 498
 499   return {
 500
 501     'agent' => {
 502       'columns' => [
 503         'agentnum',          'serial',    '',       '', '', '',
 504         'agent',            'varchar',    '',  $char_d, '', '',
 505         'typenum',              'int',    '',       '', '', '',
 506         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 507         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 508         'agent_custnum',        'int', 'NULL',      '', '', '',
 509         'disabled',            'char', 'NULL',       1, '', '',
 510         'username',         'varchar', 'NULL', $char_d, '', '',
 511         '_password',        'varchar', 'NULL', $char_d, '', '',
 512         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 513         'prog',                     @perl_type, '', '', #deprecated (never used)
 514       ],
 515       'primary_key'  => 'agentnum',
 516       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 517                                             #insert is giving it a value, tho..
 518       #'index' => [ ['typenum'], ['disabled'] ],
 519       'unique'       => [],
 520       'index'        => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 521       'foreign_keys' => [
 522                           { columns    => [ 'typenum' ],
 523                             table      => 'agent_type',
 524                           },
 525                           # 1. RT tables aren't part of our data structure, so
 526                           #     we can't make sure Queue is created already
 527                           # 2. Future ability to plug in other ticketing systems
 528                           #{ columns    => [ 'ticketing_queueid' ],
 529                           #  table      => 'Queue',
 530                           #  references => [ 'id' ],
 531                           #},
 532                           { columns    => [ 'agent_custnum' ],
 533                             table      => 'cust_main',
 534                             references => [ 'custnum' ],
 535                           },
 536                         ],
 537     },
 538
 539     'agent_pkg_class' => {
 540       'columns' => [
 541         'agentpkgclassnum',    'serial',     '',    '', '', '',
 542         'agentnum',               'int',     '',    '', '', '',
 543         'classnum',               'int', 'NULL',    '', '', '',
 544         'commission_percent', 'decimal',     '', '7,4', '', '',
 545       ],
 546       'primary_key'  => 'agentpkgclassnum',
 547       'unique'       => [ [ 'agentnum', 'classnum' ], ],
 548       'index'        => [],
 549       'foreign_keys' => [
 550                           { columns    => [ 'agentnum' ],
 551                             table      => 'agent',
 552                           },
 553                           { columns    => [ 'classnum' ],
 554                             table      => 'pkg_class',
 555                           },
 556                         ],
 557     },
 558
 559     'agent_type' => {
 560       'columns' => [
 561         'typenum',  'serial',      '',      '', '', '',
 562         'atype',    'varchar',     '', $char_d, '', '',
 563         'disabled',    'char', 'NULL',       1, '', '',
 564       ],
 565       'primary_key' => 'typenum',
 566       'unique' => [],
 567       'index' => [ ['disabled'] ],
 568     },
 569
 570     'type_pkgs' => {
 571       'columns' => [
 572         'typepkgnum', 'serial', '', '', '', '',
 573         'typenum',   'int',  '', '', '', '',
 574         'pkgpart',   'int',  '', '', '', '',
 575       ],
 576       'primary_key'  => 'typepkgnum',
 577       'unique'       => [ ['typenum', 'pkgpart'] ],
 578       'index'        => [ ['typenum'] ],
 579       'foreign_keys' => [
 580                           { columns    => [ 'typenum' ],
 581                             table      => 'agent_type',
 582                           },
 583                           { columns    => [ 'pkgpart' ],
 584                             table      => 'part_pkg',
 585                           },
 586                         ],
 587     },
 588
 589     'agent_currency' => {
 590       'columns' => [
 591         'agentcurrencynum', 'serial', '', '', '', '',
 592         'agentnum',            'int', '', '', '', '',
 593         'currency',           'char', '',  3, '', '',
 594       ],
 595       'primary_key'  => 'agentcurrencynum',
 596       'unique'       => [],
 597       'index'        => [ ['agentnum'] ],
 598       'foreign_keys' => [
 599                           { columns    => [ 'agentnum' ],
 600                             table      => 'agent',
 601                           },
 602                         ],
 603     },
 604
 605     'sales' => {
 606       'columns' => [
 607         'salesnum',          'serial',    '',       '', '', '',
 608         'salesperson',      'varchar',    '',  $char_d, '', '',
 609         'agentnum',             'int', 'NULL',      '', '', '',
 610         'sales_custnum',        'int', 'NULL',      '', '', '',
 611         'disabled',            'char', 'NULL',       1, '', '',
 612       ],
 613       'primary_key'  => 'salesnum',
 614       'unique'       => [],
 615       'index'        => [ ['salesnum'], ['disabled'] ],
 616       'foreign_keys' => [
 617                           { columns    => [ 'agentnum' ],
 618                             table      => 'agent',
 619                           },
 620                           { columns    => [ 'sales_custnum' ],
 621                             table      => 'cust_main',
 622                             references => [ 'custnum' ],
 623                           },
 624                         ],
 625     },
 626
 627     'sales_pkg_class' => {
 628       'columns' => [
 629         'salespkgclassnum',    'serial',     '',    '', '', '',
 630         'salesnum',               'int',     '',    '', '', '',
 631         'classnum',               'int', 'NULL',    '', '', '',
 632         'commission_percent', 'decimal',     '', '7,4', '', '',
 633         'commission_duration',    'int', 'NULL',    '', '', '',
 634       ],
 635       'primary_key'  => 'salespkgclassnum',
 636       'unique'       => [ [ 'salesnum', 'classnum' ], ],
 637       'index'        => [],
 638       'foreign_keys' => [
 639                           { columns    => [ 'salesnum' ],
 640                             table      => 'sales',
 641                           },
 642                           { columns    => [ 'classnum' ],
 643                             table      => 'pkg_class',
 644                           },
 645                         ],
 646     },
 647
 648     'cust_attachment' => {
 649       'columns' => [
 650         'attachnum', 'serial', '', '', '', '',
 651         'custnum',   'int', '', '', '', '',
 652         '_date',     @date_type, '', '',
 653         'otaker',    'varchar', 'NULL', 32, '', '',
 654         'usernum',   'int', 'NULL', '', '', '',
 655         'filename',  'varchar', '', 255, '', '',
 656         'mime_type', 'varchar', '', $char_d, '', '',
 657         'title',     'varchar', 'NULL', $char_d, '', '',
 658         'body',      'blob', 'NULL', '', '', '',
 659         'disabled',  @date_type, '', '',
 660       ],
 661       'primary_key'  => 'attachnum',
 662       'unique'       => [],
 663       'index'        => [ ['custnum'], ['usernum'], ],
 664       'foreign_keys' => [
 665                           { columns    => [ 'custnum' ],
 666                             table      => 'cust_main',
 667                           },
 668                           { columns    => [ 'usernum' ],
 669                             table      => 'access_user',
 670                           },
 671                         ],
 672    },
 673
 674     'cust_bill' => {
 675       'columns' => [
 676         #regular fields
 677         'invnum',         'serial',     '',      '', '', '',
 678         'custnum',           'int',     '',      '', '', '',
 679         '_date',        @date_type,                  '', '',
 680         'charged',     @money_type,                  '', '',
 681         'currency',         'char', 'NULL',       3, '', '',
 682         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 683
 684         #customer balance info at invoice generation time
 685         #(deprecated)
 686         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 687         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 688
 689         #deprecated (unused by now, right?)
 690         'printed',      'int',     '', '', '', '',
 691
 692         #specific use cases
 693         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 694         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 695         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 696         'promised_date', @date_type,       '', '',
 697
 698         'pending',     'char', 'NULL',  1, '', '',
 699       ],
 700       'primary_key'  => 'invnum',
 701       'unique'       => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 702       'index'        => [ ['custnum'], ['_date'], ['statementnum'],
 703                           ['agent_invid'],
 704                         ],
 705       'foreign_keys' => [
 706                           { columns    => [ 'custnum' ],
 707                             table      => 'cust_main',
 708                           },
 709                           { columns    => [ 'statementnum' ],
 710                             table      => 'cust_statement',
 711                           },
 712                         ],
 713     },
 714
 715     'cust_bill_void' => {
 716       'columns' => [
 717         #regular fields
 718         'invnum',            'int',     '',      '', '', '',
 719         'custnum',           'int',     '',      '', '', '',
 720         '_date',        @date_type,                  '', '',
 721         'charged',     @money_type,                  '', '',
 722         'currency',         'char', 'NULL',       3, '', '',
 723         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 724
 725         #customer balance info at invoice generation time
 726         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 727         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 728
 729         #specific use cases
 730         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 731         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 732         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 733         'promised_date', @date_type,       '', '',
 734
 735         #void fields
 736         'void_date', @date_type, '', '',
 737         'reason',     'varchar', 'NULL', $char_d, '', '',
 738         'reasonnum',      'int', 'NULL',      '', '', '',
 739         'void_usernum',   'int', 'NULL',      '', '', '',
 740       ],
 741       'primary_key'  => 'invnum',
 742       'unique'       => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 743       'index'        => [ ['custnum'], ['_date'], ['statementnum'],
 744                           ['agent_invid'], [ 'void_usernum' ],
 745                         ],
 746       'foreign_keys' => [
 747                           { columns    => [ 'custnum' ],
 748                             table      => 'cust_main',
 749                           },
 750                           { columns    => [ 'statementnum' ],
 751                             table      => 'cust_statement', #_void? both?
 752                           },
 753                           { columns    => [ 'reasonnum' ],
 754                             table      => 'reason',
 755                           },
 756                           { columns    => [ 'void_usernum' ],
 757                             table      => 'access_user',
 758                             references => [ 'usernum' ],
 759                           },
 760                         ],
 761     },
 762
 763     #for importing invoices from a legacy system for display purposes only
 764     # no effect upon balance
 765     'legacy_cust_bill' => {
 766       'columns' => [
 767         'legacyinvnum',  'serial',     '',      '', '', '',
 768         'legacyid',     'varchar', 'NULL', $char_d, '', '',
 769         'custnum',          'int',     '',      '', '', '',
 770         '_date',       @date_type,                  '', '',
 771         'charged',    @money_type,                  '', '',
 772         'currency',        'char', 'NULL',       3, '', '',
 773         'content_pdf',     'blob', 'NULL',      '', '', '',
 774         'content_html',    'text', 'NULL',      '', '', '',
 775         'locale',       'varchar', 'NULL',      16, '', '',
 776       ],
 777       'primary_key'  => 'legacyinvnum',
 778       'unique'       => [],
 779       'index'        => [ ['legacyid', 'custnum', 'locale' ], ],
 780       'foreign_keys' => [
 781                           { columns    => [ 'custnum' ],
 782                             table      => 'cust_main',
 783                           },
 784                         ],
 785     },
 786
 787     'legacy_cust_history' => {
 788       'columns' => [
 789         'legacyhistorynum', 'serial',     '',        '', '', '',
 790         'custnum',             'int',     '',        '', '', '',
 791         'history_action',  'varchar',     '',   $char_d, '', '',
 792         'history_date',           @date_type,            '', '',
 793         'history_usernum',     'int', 'NULL',        '', '', '',
 794         'item',            'varchar', 'NULL',   $char_d, '', '',
 795         'description',     'varchar', 'NULL', 2*$char_d, '', '',
 796         'change_data',        'text', 'NULL',        '', '', '',
 797       ],
 798       'primary_key'  => 'legacyhistorynum',
 799       'unique'       => [],
 800       'index'        => [ ['custnum'], ['history_date'], ],
 801       'foreign_keys' => [
 802                           { columns    => [ 'custnum' ],
 803                             table      => 'cust_main',
 804                           },
 805                           { columns    => [ 'history_usernum' ],
 806                             table      => 'access_user',
 807                             references => [ 'usernum' ],
 808                           },
 809                         ],
 810     },
 811
 812     'cust_statement' => {
 813       'columns' => [
 814         'statementnum', 'serial', '', '', '', '',
 815         'custnum',         'int', '', '', '', '',
 816         '_date',           @date_type,    '', '',
 817       ],
 818       'primary_key'  => 'statementnum',
 819       'unique'       => [],
 820       'index'        => [ ['custnum'], ['_date'], ],
 821       'foreign_keys' => [
 822                           { columns    => [ 'custnum' ],
 823                             table      => 'cust_main',
 824                           },
 825                         ],
 826     },
 827
 828     'part_event' => {
 829       'columns' => [
 830         'eventpart',   'serial',      '',      '', '', '',
 831         'agentnum',    'int',     'NULL',      '', '', '',
 832         'event',       'varchar',     '', $char_d, '', '',
 833         'eventtable',  'varchar',     '', $char_d, '', '',
 834         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 835         'weight',      'int',         '',      '', '', '',
 836         'action',      'varchar',     '', $char_d, '', '',
 837         'disabled',     'char',   'NULL',       1, '', '',
 838       ],
 839       'primary_key'  => 'eventpart',
 840       'unique'       => [],
 841       'index'        => [ ['agentnum'], ['eventtable'], ['check_freq'],
 842                           ['disabled'],
 843                         ],
 844       'foreign_keys' => [
 845                           { columns    => [ 'agentnum' ],
 846                             table      => 'agent',
 847                           },
 848                         ],
 849     },
 850
 851     'part_event_option' => {
 852       'columns' => [
 853         'optionnum', 'serial', '', '', '', '',
 854         'eventpart', 'int', '', '', '', '',
 855         'optionname', 'varchar', '', $char_d, '', '',
 856         'optionvalue', 'text', 'NULL', '', '', '',
 857       ],
 858       'primary_key'  => 'optionnum',
 859       'unique'       => [],
 860       'index'        => [ [ 'eventpart' ], [ 'optionname' ] ],
 861       'foreign_keys' => [
 862                           { columns    => [ 'eventpart' ],
 863                             table      => 'part_event',
 864                           },
 865                         ],
 866     },
 867
 868     'part_event_condition' => {
 869       'columns' => [
 870         'eventconditionnum', 'serial', '', '', '', '',
 871         'eventpart', 'int', '', '', '', '',
 872         'conditionname', 'varchar', '', $char_d, '', '',
 873       ],
 874       'primary_key'  => 'eventconditionnum',
 875       'unique'       => [],
 876       'index'        => [ [ 'eventpart' ], [ 'conditionname' ] ],
 877       'foreign_keys' => [
 878                           { columns    => [ 'eventpart' ],
 879                             table      => 'part_event',
 880                           },
 881                         ],
 882     },
 883
 884     'part_event_condition_option' => {
 885       'columns' => [
 886         'optionnum', 'serial', '', '', '', '',
 887         'eventconditionnum', 'int', '', '', '', '',
 888         'optionname', 'varchar', '', $char_d, '', '',
 889         'optionvalue', 'text', 'NULL', '', '', '',
 890       ],
 891       'primary_key'  => 'optionnum',
 892       'unique'       => [],
 893       'index'        => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 894       'foreign_keys' => [
 895                           { columns    => [ 'eventconditionnum' ],
 896                             table      => 'part_event_condition',
 897                           },
 898                         ],
 899     },
 900
 901     'part_event_condition_option_option' => {
 902       'columns' => [
 903         'optionoptionnum', 'serial', '', '', '', '',
 904         'optionnum', 'int', '', '', '', '',
 905         'optionname', 'varchar', '', $char_d, '', '',
 906         'optionvalue', 'text', 'NULL', '', '', '',
 907       ],
 908       'primary_key'  => 'optionoptionnum',
 909       'unique'       => [],
 910       'index'        => [ [ 'optionnum' ], [ 'optionname' ] ],
 911       'foreign_keys' => [
 912                           { columns    => [ 'optionnum' ],
 913                             table      => 'part_event_condition_option',
 914                           },
 915                         ],
 916     },
 917
 918     'cust_event' => {
 919       'columns' => [
 920         'eventnum',    'serial',  '', '', '', '',
 921         'eventpart',   'int',  '', '', '', '',
 922         'tablenum',   'int',  '', '', '', '',
 923         '_date',     @date_type, '', '',
 924         'status', 'varchar', '', $char_d, '', '',
 925         'statustext', 'text', 'NULL', '', '', '',
 926         'no_action',  'char', 'NULL',  1, '', '',
 927       ],
 928       'primary_key'  => 'eventnum',
 929       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 930       'unique'       => [],
 931       'index'        => [ ['eventpart'], ['tablenum'], ['status'],
 932                           ['statustext'], ['_date'], ['no_action'],
 933                         ],
 934       'foreign_keys' => [
 935                           { columns    => [ 'eventpart' ],
 936                             table      => 'part_event',
 937                           },
 938                         ],
 939     },
 940
 941     'cust_event_fee' => {
 942       'columns' => [
 943         'eventfeenum', 'serial', '', '', '', '',
 944         'eventnum',       'int', '', '', '', '',
 945         'billpkgnum',     'int', 'NULL', '', '', '',
 946         'feepart',        'int', '', '', '', '',
 947         'nextbill',      'char', 'NULL',  1, '', '',
 948       ],
 949       'primary_key'  => 'eventfeenum', # I'd rather just use eventnum
 950       'unique' => [ [ 'billpkgnum' ], [ 'eventnum' ] ], # one-to-one link
 951       'index'  => [ [ 'feepart' ] ],
 952       'foreign_keys' => [
 953                           { columns => [ 'eventnum' ],
 954                             table   => 'cust_event',
 955                           },
 956                           #{ columns => [ 'billpkgnum' ],
 957                           #  table   => 'cust_bill_pkg',
 958                           #},
 959                           { columns => [ 'feepart' ],
 960                             table   => 'part_fee',
 961                           },
 962                         ],
 963     },
 964
 965     'cust_bill_pkg' => {
 966       'columns' => [
 967         'billpkgnum',          'serial',     '',      '', '', '',
 968         'invnum',                 'int',     '',      '', '', '',
 969         'pkgnum',                 'int',     '',      '', '', '',
 970         'pkgpart_override',       'int', 'NULL',      '', '', '',
 971         'setup',                 @money_type,             '', '',
 972         'unitsetup',             @money_typen,            '', '',
 973         'setup_billed_currency', 'char', 'NULL',       3, '', '',
 974         'setup_billed_amount',   @money_typen,            '', '',
 975         'recur',                 @money_type,             '', '',
 976         'unitrecur',             @money_typen,            '', '',
 977         'recur_billed_currency', 'char', 'NULL',       3, '', '',
 978         'recur_billed_amount',   @money_typen,            '', '',
 979         'sdate',                 @date_type,              '', '',
 980         'edate',                 @date_type,              '', '',
 981         'itemdesc',           'varchar', 'NULL', $char_d, '', '',
 982         'itemcomment',        'varchar', 'NULL', $char_d, '', '',
 983         'section',            'varchar', 'NULL', $char_d, '', '',
 984         'freq',               'varchar', 'NULL', $char_d, '', '',
 985         'quantity',               'int', 'NULL',      '', '', '',
 986         'hidden',                'char', 'NULL',       1, '', '',
 987         'feepart',                'int', 'NULL',      '', '', '',
 988       ],
 989       'primary_key'  => 'billpkgnum',
 990       'unique'       => [],
 991       'index'        => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 992       'foreign_keys' => [
 993                           { columns    => [ 'invnum' ],
 994                             table      => 'cust_bill',
 995                           },
 996                           #pkgnum 0 and -1 are used for special things
 997                           #{ columns    => [ 'pkgnum' ],
 998                           #  table      => 'cust_pkg',
 999                           #},
1000                           { columns    => [ 'pkgpart_override' ],
1001                             table      => 'part_pkg',
1002                             references => [ 'pkgpart' ],
1003                           },
1004                           { columns    => [ 'feepart' ],
1005                             table      => 'part_fee',
1006                           },
1007                         ],
1008     },
1009
1010     'cust_bill_pkg_detail' => {
1011       'columns' => [
1012         'detailnum', 'serial', '', '', '', '',
1013           # bigserial? this table will eventually be as big as cdr...
1014         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
1015         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
1016         'invnum',  'int', 'NULL', '', '', '',           # deprecated
1017         'amount',  'decimal', 'NULL', '10,4', '', '',
1018         'format',  'char', 'NULL', 1, '', '',
1019         'classnum', 'int', 'NULL', '', '', '',
1020         'duration', 'int', 'NULL', '',  0, '',
1021         'phonenum', 'varchar', 'NULL', 255, '', '', # has to hold a service label
1022         'accountcode', 'varchar',  'NULL',      32, '', '',
1023         'startdate',  @date_type, '', '',
1024         'regionname', 'varchar', 'NULL', $char_d, '', '',
1025         'detail',  'varchar', '', 255, '', '',
1026       ],
1027       'primary_key'  => 'detailnum',
1028       'unique'       => [],
1029       'index'        => [ [ 'billpkgnum' ], [ 'classnum' ],
1030                           [ 'pkgnum', 'invnum' ],
1031                         ],
1032       'foreign_keys' => [
1033                           { columns    => [ 'billpkgnum' ],
1034                             table      => 'cust_bill_pkg',
1035                           },
1036                           #{ columns    => [ 'pkgnum' ],
1037                           #  table      => 'cust_pkg',
1038                           #},
1039                           #{ columns    => [ 'invnum' ],
1040                           #  table      => 'cust_bill',
1041                           #},
1042                           { columns    => [ 'classnum' ],
1043                             table      => 'usage_class',
1044                           },
1045                         ],
1046     },
1047
1048     'cust_bill_pkg_display' => {
1049       'columns' => [
1050         'billpkgdisplaynum', 'serial', '', '', '', '',
1051         'billpkgnum', 'int', '', '', '', '',
1052         'section',  'varchar', 'NULL', $char_d, '', '',
1053         #'unitsetup', @money_typen, '', '',     #override the linked real one?
1054         #'unitrecur', @money_typen, '', '',     #this too?
1055         'post_total', 'char', 'NULL', 1, '', '',
1056         'type',       'char', 'NULL', 1, '', '',
1057         'summary',    'char', 'NULL', 1, '', '',
1058       ],
1059       'primary_key'  => 'billpkgdisplaynum',
1060       'unique'       => [],
1061       'index'        => [ ['billpkgnum'], ],
1062       'foreign_keys' => [
1063                           { columns    => [ 'billpkgnum' ],
1064                             table      => 'cust_bill_pkg',
1065                           },
1066                         ],
1067     },
1068
1069     'cust_bill_pkg_fee' => {
1070       'columns' => [
1071         'billpkgfeenum',    'serial', '', '', '', '',
1072         'billpkgnum',          'int', '', '', '', '',
1073         'base_invnum',       'int', '', '', '', '',
1074         'base_billpkgnum',   'int', 'NULL', '', '', '',
1075         'amount',        @money_type,         '', '',
1076       ],
1077       'primary_key' => 'billpkgfeenum',
1078       'unique'      => [],
1079       'index'       => [ ['billpkgnum'],
1080                          ['base_invnum'],
1081                          ['base_billpkgnum'],
1082                        ],
1083       'foreign_keys' => [
1084                           { columns     => [ 'billpkgnum' ],
1085                             table       => 'cust_bill_pkg',
1086                           },
1087                         ],
1088     },
1089
1090     'cust_bill_pkg_fee_void' => {
1091       'columns' => [
1092         'billpkgfeenum',    'serial', '', '', '', '',
1093         'billpkgnum',          'int', '', '', '', '',
1094         'base_invnum',       'int', '', '', '', '',
1095         'base_billpkgnum',   'int', 'NULL', '', '', '',
1096         'amount',        @money_type,         '', '',
1097       ],
1098       'primary_key' => 'billpkgfeenum',
1099       'unique'      => [],
1100       'index'       => [ ['billpkgnum'],
1101                          ['base_invnum'],
1102                          ['base_billpkgnum'],
1103                        ],
1104       'foreign_keys' => [
1105                           { columns     => [ 'billpkgnum' ],
1106                             table       => 'cust_bill_pkg_void',
1107                           },
1108                         ],
1109     },
1110
1111
1112     'cust_bill_pkg_tax_location' => {
1113       'columns' => [
1114         'billpkgtaxlocationnum', 'serial',     '',      '', '', '',
1115         'billpkgnum',               'int',     '',      '', '', '',
1116         'taxnum',                   'int',     '',      '', '', '',
1117         'taxtype',              'varchar',     '', $char_d, '', '',
1118         'pkgnum',                   'int',     '',      '', '', '', #redundant
1119         'locationnum',              'int',     '',      '', '', '', #redundant
1120         'amount',             @money_type,                  '', '',
1121         'currency',                'char', 'NULL',       3, '', '',
1122         'taxable_billpkgnum',       'int', 'NULL',      '', '', '',
1123       ],
1124       'primary_key'  => 'billpkgtaxlocationnum',
1125       'unique'       => [],
1126       'index'        => [ [ 'billpkgnum' ],
1127                           [ 'taxnum' ],
1128                           [ 'pkgnum' ],
1129                           [ 'locationnum' ],
1130                           [ 'taxable_billpkgnum' ],
1131                         ],
1132       'foreign_keys' => [
1133                           { columns    => [ 'billpkgnum' ],
1134                             table      => 'cust_bill_pkg',
1135                           },
1136                           #{ columns    => [ 'pkgnum' ],
1137                           #  table      => 'cust_pkg',
1138                           #}, # taxes can apply to fees
1139                           { columns    => [ 'locationnum' ],
1140                             table      => 'cust_location',
1141                           },
1142                           #{ columns    => [ 'taxable_billpkgnum' ],
1143                           #  table      => 'cust_bill_pkg',
1144                           #  references => [ 'billpkgnum' ],
1145                           #},
1146                         ],
1147     },
1148
1149     'cust_bill_pkg_tax_rate_location' => {
1150       'columns' => [
1151         'billpkgtaxratelocationnum', 'serial',      '',      '', '', '',
1152         'billpkgnum',                   'int',      '',      '', '', '',
1153         'taxnum',                       'int',      '',      '', '', '',
1154         'taxtype',                  'varchar',      '', $char_d, '', '',
1155         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
1156         'taxratelocationnum',           'int',      '',      '', '', '',
1157         'amount',                 @money_type,                   '', '',
1158         'currency',                    'char', 'NULL',        3, '', '',
1159         'taxable_billpkgnum',           'int', 'NULL',       '', '', '',
1160         'taxclass',                 'varchar', 'NULL',       10, '', '',
1161       ],
1162       'primary_key'  => 'billpkgtaxratelocationnum',
1163       'unique'       => [],
1164       'index'        => [ ['billpkgnum'], ['taxnum'], ['taxratelocationnum'],
1165                           ['taxable_billpkgnum'],
1166                         ],
1167       'foreign_keys' => [
1168                           { columns    => [ 'billpkgnum' ],
1169                             table      => 'cust_bill_pkg',
1170                           },
1171                           { columns    => [ 'taxratelocationnum' ],
1172                             table      => 'tax_rate_location',
1173                           },
1174                           #{ columns    => [ 'taxable_billpkgnum' ],
1175                           #  table      => 'cust_bill_pkg',
1176                           #  references => [ 'billpkgnum' ],
1177                           #},
1178                         ],
1179     },
1180
1181     'cust_bill_pkg_void' => {
1182       'columns' => [
1183         'billpkgnum',           'int',     '',      '', '', '',
1184         'invnum',               'int',     '',      '', '', '',
1185         'pkgnum',               'int',     '',      '', '', '',
1186         'pkgpart_override',     'int', 'NULL',      '', '', '',
1187         'setup',               @money_type,             '', '',
1188         'recur',               @money_type,             '', '',
1189         #XXX a currency for a line item?  or just one for the entire invoice
1190         #'currency',            'char', 'NULL',       3, '', '',
1191         'sdate',               @date_type,              '', '',
1192         'edate',               @date_type,              '', '',
1193         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
1194         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
1195         'section',          'varchar', 'NULL', $char_d, '', '',
1196         'freq',             'varchar', 'NULL', $char_d, '', '',
1197         'quantity',             'int', 'NULL',      '', '', '',
1198         'unitsetup',           @money_typen,            '', '',
1199         'unitrecur',           @money_typen,            '', '',
1200         'hidden',              'char', 'NULL',       1, '', '',
1201         'feepart',              'int', 'NULL',      '', '', '',
1202         #void fields
1203         'void_date', @date_type, '', '',
1204         'reason',     'varchar', 'NULL', $char_d, '', '',
1205         'reasonnum',      'int', 'NULL',      '', '', '',
1206         'void_usernum',   'int', 'NULL',      '', '', '',
1207       ],
1208       'primary_key'  => 'billpkgnum',
1209       'unique'       => [],
1210       'index'        => [ ['invnum'], ['pkgnum'], ['itemdesc'],
1211                           ['void_usernum'],
1212                         ],
1213       'foreign_keys' => [
1214                           { columns    => [ 'invnum' ],
1215                             table      => 'cust_bill_void',
1216                           },
1217                           { columns    => [ 'reasonnum' ],
1218                             table      => 'reason',
1219                           },
1220                           #pkgnum 0 and -1 are used for special things
1221                           #{ columns    => [ 'pkgnum' ],
1222                           #  table      => 'cust_pkg',
1223                           #},
1224                           { columns    => [ 'pkgpart_override' ],
1225                             table      => 'part_pkg',
1226                             references => [ 'pkgpart' ],
1227                           },
1228                           { columns    => [ 'void_usernum' ],
1229                             table      => 'access_user',
1230                             references => [ 'usernum' ],
1231                           },
1232                         ],
1233     },
1234
1235     'cust_bill_pkg_detail_void' => {
1236       'columns' => [
1237         'detailnum',  'int', '', '', '', '',
1238         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
1239         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
1240         'invnum',  'int', 'NULL', '', '', '',           # deprecated
1241         'amount',  'decimal', 'NULL', '10,4', '', '',
1242         'format',  'char', 'NULL', 1, '', '',
1243         'classnum', 'int', 'NULL', '', '', '',
1244         'duration', 'int', 'NULL', '',  0, '',
1245         'phonenum', 'varchar', 'NULL', 255, '', '',
1246         'accountcode', 'varchar',  'NULL',      32, '', '',
1247         'startdate',  @date_type, '', '',
1248         'regionname', 'varchar', 'NULL', $char_d, '', '',
1249         'detail',  'varchar', '', 255, '', '',
1250       ],
1251       'primary_key'  => 'detailnum',
1252       'unique'       => [],
1253       'index'        => [ ['billpkgnum'], ['classnum'], ['pkgnum', 'invnum'] ],
1254       'foreign_keys' => [
1255                           { columns    => [ 'billpkgnum' ],
1256                             table      => 'cust_bill_pkg_void',
1257                           },
1258                           #{ columns    => [ 'pkgnum' ],
1259                           #  table      => 'cust_pkg',
1260                           #},
1261                           #{ columns    => [ 'invnum' ],
1262                           #  table      => 'cust_bill',
1263                           #},
1264                           { columns    => [ 'classnum' ],
1265                             table      => 'usage_class',
1266                           },
1267                         ],
1268     },
1269
1270     'cust_bill_pkg_display_void' => {
1271       'columns' => [
1272         'billpkgdisplaynum',    'int', '', '', '', '',
1273         'billpkgnum', 'int', '', '', '', '',
1274         'section',  'varchar', 'NULL', $char_d, '', '',
1275         #'unitsetup', @money_typen, '', '',     #override the linked real one?
1276         #'unitrecur', @money_typen, '', '',     #this too?
1277         'post_total', 'char', 'NULL', 1, '', '',
1278         'type',       'char', 'NULL', 1, '', '',
1279         'summary',    'char', 'NULL', 1, '', '',
1280       ],
1281       'primary_key'  => 'billpkgdisplaynum',
1282       'unique'       => [],
1283       'index'        => [ ['billpkgnum'], ],
1284       'foreign_keys' => [
1285                           { columns    => [ 'billpkgnum' ],
1286                             table      => 'cust_bill_pkg_void',
1287                           },
1288                         ],
1289     },
1290
1291     'cust_bill_pkg_tax_location_void' => {
1292       'columns' => [
1293         'billpkgtaxlocationnum',    'int',     '',      '', '', '',
1294         'billpkgnum',               'int',     '',      '', '', '',
1295         'taxnum',                   'int',     '',      '', '', '',
1296         'taxtype',              'varchar',     '', $char_d, '', '',
1297         'pkgnum',                   'int',     '',      '', '', '',
1298         'locationnum',              'int',     '',      '', '', '', #redundant?
1299         'amount',             @money_type,                  '', '',
1300         'currency',                'char', 'NULL',       3, '', '',
1301         'taxable_billpkgnum',       'int', 'NULL',      '', '', '',
1302       ],
1303       'primary_key'  => 'billpkgtaxlocationnum',
1304       'unique'       => [],
1305       'index'        => [ ['billpkgnum'], ['taxnum'], ['pkgnum'],
1306                           ['locationnum'],
1307                         ],
1308       'foreign_keys' => [
1309                           { columns    => [ 'billpkgnum' ],
1310                             table      => 'cust_bill_pkg_void',
1311                           },
1312                           { columns    => [ 'locationnum' ],
1313                             table      => 'cust_location',
1314                           },
1315                           #{ columns    => [ 'taxable_billpkgnum' ],
1316                           #  table      => 'cust_bill_pkg_void',
1317                           #  references => [ 'billpkgnum' ],
1318                           #},
1319                         ],
1320     },
1321
1322     'cust_bill_pkg_tax_rate_location_void' => {
1323       'columns' => [
1324         'billpkgtaxratelocationnum',    'int',     '',      '', '', '',
1325         'billpkgnum',                   'int',     '',      '', '', '',
1326         'taxnum',                       'int',     '',      '', '', '',
1327         'taxtype',                  'varchar',     '', $char_d, '', '',
1328         'locationtaxid',            'varchar', 'NULL', $char_d, '', '',
1329         'taxratelocationnum',           'int',     '',      '', '', '',
1330         'amount',                 @money_type,                  '', '',
1331         'currency',                    'char', 'NULL',       3, '', '',
1332       ],
1333       'primary_key'  => 'billpkgtaxratelocationnum',
1334       'unique'       => [],
1335       'index'        => [ ['billpkgnum'], ['taxnum'], ['taxratelocationnum'] ],
1336       'foreign_keys' => [
1337                           { columns    => [ 'billpkgnum' ],
1338                             table      => 'cust_bill_pkg_void',
1339                           },
1340                           { columns    => [ 'taxratelocationnum' ],
1341                             table      => 'tax_rate_location',
1342                           },
1343                         ],
1344     },
1345
1346     'cust_credit' => {
1347       'columns' => [
1348         'crednum',  'serial',     '', '', '', '',
1349         'custnum',     'int',     '', '', '', '',
1350         '_date',  @date_type,             '', '',
1351         'amount',@money_type,             '', '',
1352         'currency',   'char', 'NULL',  3, '', '',
1353         'otaker',  'varchar', 'NULL', 32, '', '',
1354         'usernum',     'int', 'NULL', '', '', '',
1355         'reason',     'text', 'NULL', '', '', '',
1356         'reasonnum',   'int', 'NULL', '', '', '',
1357         'addlinfo',   'text', 'NULL', '', '', '',
1358         'closed',     'char', 'NULL',  1, '', '',
1359         'pkgnum',      'int', 'NULL', '', '','',#desired pkgnum for pkg-balances
1360         'eventnum',    'int', 'NULL', '', '','',#triggering event for commission
1361         'commission_agentnum', 'int', 'NULL', '', '', '', #
1362         'commission_salesnum', 'int', 'NULL', '', '', '', #
1363         'commission_pkgnum',   'int', 'NULL', '', '', '', #
1364         'credbatch',    'varchar', 'NULL', $char_d, '', '',
1365       ],
1366       'primary_key'  => 'crednum',
1367       'unique'       => [],
1368       'index'        => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1369                           ['commission_salesnum'], ['credbatch'],
1370                         ],
1371       'foreign_keys' => [
1372                           { columns    => [ 'custnum' ],
1373                             table      => 'cust_main',
1374                           },
1375                           { columns    => [ 'usernum' ],
1376                             table      => 'access_user',
1377                           },
1378                           { columns    => [ 'reasonnum' ],
1379                             table      => 'reason',
1380                           },
1381                           { columns    => [ 'pkgnum' ],
1382                             table      => 'cust_pkg',
1383                           },
1384                           { columns    => [ 'eventnum' ],
1385                             table      => 'cust_event',
1386                           },
1387                           { columns    => [ 'commission_agentnum' ],
1388                             table      => 'agent',
1389                             references => [ 'agentnum' ],
1390                           },
1391                           { columns    => [ 'commission_salesnum' ],
1392                             table      => 'sales',
1393                             references => [ 'salesnum' ],
1394                           },
1395                           { columns    => [ 'commission_pkgnum' ],
1396                             table      => 'cust_pkg',
1397                             references => [ 'pkgnum' ],
1398                           },
1399                         ],
1400     },
1401
1402     'cust_credit_void' => {
1403       'columns' => [
1404         'crednum',  'serial',     '', '', '', '',
1405         'custnum',     'int',     '', '', '', '',
1406         '_date',  @date_type,             '', '',
1407         'amount',@money_type,             '', '',
1408         'currency',   'char', 'NULL',  3, '', '',
1409         'otaker',  'varchar', 'NULL', 32, '', '',
1410         'usernum',     'int', 'NULL', '', '', '',
1411         'reason',     'text', 'NULL', '', '', '',
1412         'reasonnum',   'int', 'NULL', '', '', '',
1413         'addlinfo',   'text', 'NULL', '', '', '',
1414         'closed',     'char', 'NULL',  1, '', '',
1415         'pkgnum',      'int', 'NULL', '', '','',
1416         'eventnum',    'int', 'NULL', '', '','',
1417         'commission_agentnum', 'int', 'NULL', '', '', '',
1418         'commission_salesnum', 'int', 'NULL', '', '', '',
1419         'commission_pkgnum',   'int', 'NULL', '', '', '',
1420         #void fields
1421         'void_date',  @date_type,                  '', '',
1422         'void_reason', 'varchar', 'NULL', $char_d, '', '',
1423         'void_reasonnum', 'int', 'NULL', '', '', '',
1424         'void_usernum',    'int', 'NULL',      '', '', '',
1425       ],
1426       'primary_key'  => 'crednum',
1427       'unique'       => [],
1428       'index'        => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1429                           ['commission_salesnum'],
1430                         ],
1431       'foreign_keys' => [
1432                           { columns    => [ 'custnum' ],
1433                             table      => 'cust_main',
1434                           },
1435                           { columns    => [ 'usernum' ],
1436                             table      => 'access_user',
1437                           },
1438                           { columns    => [ 'reasonnum' ],
1439                             table      => 'reason',
1440                           },
1441                           { columns    => [ 'pkgnum' ],
1442                             table      => 'cust_pkg',
1443                           },
1444                           { columns    => [ 'eventnum' ],
1445                             table      => 'cust_event',
1446                           },
1447                           { columns    => [ 'commission_agentnum' ],
1448                             table      => 'agent',
1449                             references => [ 'agentnum' ],
1450                           },
1451                           { columns    => [ 'commission_salesnum' ],
1452                             table      => 'sales',
1453                             references => [ 'salesnum' ],
1454                           },
1455                           { columns    => [ 'commission_pkgnum' ],
1456                             table      => 'cust_pkg',
1457                             references => [ 'pkgnum' ],
1458                           },
1459                           { columns    => [ 'void_reasonnum' ],
1460                             table      => 'reason',
1461                             references => [ 'reasonnum' ],
1462                           },
1463                           { columns    => [ 'void_usernum' ],
1464                             table      => 'access_user',
1465                             references => [ 'usernum' ],
1466                           },
1467                         ],
1468     },
1469
1470
1471     'cust_credit_bill' => {
1472       'columns' => [
1473         'creditbillnum', 'serial', '', '', '', '',
1474         'crednum',  'int', '', '', '', '',
1475         'invnum',  'int', '', '', '', '',
1476         '_date',    @date_type, '', '',
1477         'amount',   @money_type, '', '',
1478         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1479       ],
1480       'primary_key'  => 'creditbillnum',
1481       'unique'       => [],
1482       'index'        => [ ['crednum'], ['invnum'] ],
1483       'foreign_keys' => [
1484                           { columns    => [ 'crednum' ],
1485                             table      => 'cust_credit',
1486                           },
1487                           { columns    => [ 'invnum' ],
1488                             table      => 'cust_bill',
1489                           },
1490                           { columns    => [ 'pkgnum' ],
1491                             table      => 'cust_pkg',
1492                           },
1493                         ],
1494     },
1495
1496     'cust_credit_bill_pkg' => {
1497       'columns' => [
1498         'creditbillpkgnum', 'serial', '',      '', '', '',
1499         'creditbillnum',       'int', '',      '', '', '',
1500         'billpkgnum',          'int', '',      '', '', '',
1501         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1502         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1503         'amount',            @money_type,          '', '',
1504         'setuprecur',      'varchar', '', $char_d, '', '',
1505         'sdate',   @date_type, '', '',
1506         'edate',   @date_type, '', '',
1507       ],
1508       'primary_key'  => 'creditbillpkgnum',
1509       'unique'       => [],
1510       'index'        => [ [ 'creditbillnum' ],
1511                           [ 'billpkgnum' ],
1512                           [ 'billpkgtaxlocationnum' ],
1513                           [ 'billpkgtaxratelocationnum' ],
1514                         ],
1515       'foreign_keys' => [
1516                           { columns    => [ 'creditbillnum' ],
1517                             table      => 'cust_credit_bill',
1518                           },
1519                           { columns    => [ 'billpkgnum' ],
1520                             table      => 'cust_bill_pkg',
1521                           },
1522                           { columns    => [ 'billpkgtaxlocationnum' ],
1523                             table      => 'cust_bill_pkg_tax_location',
1524                           },
1525                           { columns    => [ 'billpkgtaxratelocationnum' ],
1526                             table      => 'cust_bill_pkg_tax_rate_location',
1527                           },
1528                         ],
1529     },
1530
1531     'cust_credit_source_bill_pkg' => {
1532       'columns' => [
1533         'creditsourcebillpkgnum', 'serial',     '', '', '', '',
1534         'crednum',                   'int',     '', '', '', '',
1535         'billpkgnum',                'int',     '', '', '', '',
1536         'amount',              @money_type,             '', '',
1537         'currency',                 'char', 'NULL',  3, '', '',
1538       ],
1539       'primary_key'  => 'creditsourcebillpkgnum',
1540       'unique'       => [],
1541       'index'        => [ ['crednum'], ['billpkgnum'] ],
1542       'foreign_keys' => [
1543                           { columns => ['billpkgnum'],
1544                             table   => 'cust_bill_pkg',
1545                           },
1546                           { columns => ['crednum'],
1547                             table   => 'cust_credit',
1548                           },
1549                         ],
1550     },
1551
1552     'cust_main' => {
1553       'columns' => [
1554         'custnum',  'serial',  '',     '', '', '',
1555         'agentnum', 'int',  '',     '', '', '',
1556         'salesnum', 'int',  'NULL', '', '', '',
1557         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
1558         'classnum', 'int', 'NULL', '', '', '',
1559         'custbatch', 'varchar', 'NULL', $char_d, '', '',
1560 #        'titlenum', 'int',  'NULL',   '', '', '',
1561         'last',     'varchar', '',   2*$char_d, '', '',
1562 #        'middle',   'varchar', 'NULL', $char_d, '', '',
1563         'first',    'varchar', '',     $char_d, '', '',
1564         'ss',       'varchar', 'NULL', 11, '', '',
1565         'stateid', 'varchar', 'NULL', $char_d, '', '',
1566         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
1567         'national_id', 'varchar', 'NULL', $char_d, '', '',
1568         'birthdate' ,@date_type, '', '',
1569         'spouse_last',  'varchar', 'NULL', 2*$char_d, '', '',
1570         'spouse_first', 'varchar', 'NULL', $char_d, '', '',
1571         'spouse_birthdate', @date_type, '', '',
1572         'anniversary_date', @date_type, '', '',
1573         'signupdate',@date_type, '', '',
1574         'dundate',   @date_type, '', '',
1575         'company',  'varchar', 'NULL', $char_d, '', '',
1576         'address1', 'varchar', 'NULL', $char_d, '', '',
1577         'address2', 'varchar', 'NULL', $char_d, '', '',
1578         'city',     'varchar', 'NULL', $char_d, '', '',
1579         'county',   'varchar', 'NULL', $char_d, '', '',
1580         'state',    'varchar', 'NULL', $char_d, '', '',
1581         'zip',      'varchar', 'NULL', 10, '', '',
1582         'country',  'char',    'NULL',  2, '', '',
1583         'latitude', 'decimal', 'NULL', '10,7', '', '',
1584         'longitude','decimal', 'NULL', '10,7', '', '',
1585         'coord_auto',  'char', 'NULL',  1, '', '',
1586         'addr_clean',  'char', 'NULL',  1, '', '',
1587         'daytime',  'varchar', 'NULL', 20, '', '',
1588         'night',    'varchar', 'NULL', 20, '', '',
1589         'fax',      'varchar', 'NULL', 12, '', '',
1590         'mobile',   'varchar', 'NULL', 12, '', '',
1591         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '',
1592 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
1593         'ship_first',    'varchar', 'NULL', $char_d, '', '',
1594         'ship_company',  'varchar', 'NULL', $char_d, '', '',
1595         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
1596         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
1597         'ship_city',     'varchar', 'NULL', $char_d, '', '',
1598         'ship_county',   'varchar', 'NULL', $char_d, '', '',
1599         'ship_state',    'varchar', 'NULL', $char_d, '', '',
1600         'ship_zip',      'varchar', 'NULL', 10, '', '',
1601         'ship_country',  'char', 'NULL', 2, '', '',
1602         'ship_latitude', 'decimal', 'NULL', '10,7', '', '',
1603         'ship_longitude','decimal', 'NULL', '10,7', '', '',
1604         'ship_coord_auto',  'char', 'NULL',  1, '', '',
1605         'ship_addr_clean',  'char', 'NULL',  1, '', '',
1606         'ship_daytime',  'varchar', 'NULL', 20, '', '',
1607         'ship_night',    'varchar', 'NULL', 20, '', '',
1608         'ship_fax',      'varchar', 'NULL', 12, '', '',
1609         'ship_mobile',   'varchar', 'NULL', 12, '', '',
1610         'currency',         'char', 'NULL',  3, '', '',
1611
1612         'geocode',  'varchar', 'NULL', 20,  '', '',
1613         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
1614         'censusyear', 'char', 'NULL', 4, '', '',
1615         'district', 'varchar', 'NULL', 20, '', '',
1616         'tax',      'char', 'NULL', 1, '', '',
1617         'otaker',   'varchar', 'NULL',    32, '', '',
1618         'usernum',   'int', 'NULL', '', '', '',
1619         'refnum',   'int',  '',     '', '', '',
1620         'referral_custnum', 'int',  'NULL', '', '', '',
1621         'comments', 'text', 'NULL', '', '', '',
1622         'spool_cdr','char', 'NULL', 1, '', '',
1623         'squelch_cdr','char', 'NULL', 1, '', '',
1624         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
1625         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
1626         'credit_limit', @money_typen, '', '',
1627         'credit_limit_currency', 'char', 'NULL',  3, '', '',
1628         'archived', 'char', 'NULL', 1, '', '',
1629         'email_csv_cdr', 'char', 'NULL', 1, '', '',
1630         'accountcode_cdr', 'char', 'NULL', 1, '', '',
1631         'billday',   'int', 'NULL', '', '', '',
1632         'prorate_day',   'int', 'NULL', '', '', '',
1633         'edit_subject', 'char', 'NULL', 1, '', '',
1634         'locale', 'varchar', 'NULL', 16, '', '',
1635         'calling_list_exempt', 'char', 'NULL', 1, '', '',
1636         'invoice_noemail', 'char', 'NULL', 1, '', '',
1637         'message_noemail', 'char', 'NULL', 1, '', '',
1638         'bill_locationnum', 'int', 'NULL', '', '', '',
1639         'ship_locationnum', 'int', 'NULL', '', '', '',
1640         'taxstatusnum',   'int', 'NULL', '', '', '',
1641         'complimentary', 'char', 'NULL', 1, '', '',
1642         'po_number', 'varchar', 'NULL', $char_d, '', '',
1643         'invoice_attn', 'varchar', 'NULL', $char_d, '', '',
1644         'invoice_ship_address', 'char', 'NULL', 1, '', '',
1645         'postal_invoice', 'char', 'NULL', 1, '', '',
1646       ],
1647       'primary_key'  => 'custnum',
1648       'unique'       => [ [ 'agentnum', 'agent_custid' ] ],
1649       #'index'        => [ ['last'], ['company'] ],
1650       'index'        => [
1651                           ['agentnum'], ['refnum'], ['classnum'], ['usernum'],
1652                           [ 'custbatch' ],
1653                           [ 'referral_custnum' ],
1654                           [ 'archived' ],
1655                           [ 'ship_locationnum' ],
1656                           [ 'bill_locationnum' ],
1657                         ],
1658       'foreign_keys' => [
1659                           { columns    => [ 'agentnum' ],
1660                             table      => 'agent',
1661                           },
1662                           { columns    => [ 'salesnum' ],
1663                             table      => 'sales',
1664                           },
1665                           { columns    => [ 'refnum' ],
1666                             table      => 'part_referral',
1667                           },
1668                           { columns    => [ 'classnum' ],
1669                             table      => 'cust_class',
1670                           },
1671                           { columns    => [ 'usernum' ],
1672                             table      => 'access_user',
1673                           },
1674                           { columns    => [ 'referral_custnum' ],
1675                             table      => 'cust_main',
1676                             references => [ 'custnum' ],
1677                           },
1678                           { columns    => [ 'bill_locationnum' ],
1679                             table      => 'cust_location',
1680                             references => [ 'locationnum' ],
1681                           },
1682                           { columns    => [ 'ship_locationnum' ],
1683                             table      => 'cust_location',
1684                             references => [ 'locationnum' ],
1685                           },
1686                         ],
1687     },
1688
1689     'cust_payby' => {
1690       'columns' => [
1691         'custpaybynum', 'serial',     '',        '', '', '',
1692         'custnum',         'int',     '',        '', '', '',
1693         'weight',          'int', 'NULL',        '', '', '',
1694         'payby',          'char',     '',         4, '', '',
1695         'payinfo',     'varchar', 'NULL',       512, '', '',
1696         'cardtype',    'varchar', 'NULL',   $char_d, '', '',
1697         'paycvv',      'varchar', 'NULL',       512, '', '',
1698         'paymask',     'varchar', 'NULL',   $char_d, '', '',
1699         #'paydate',   @date_type, '', '',
1700         'paydate',     'varchar', 'NULL',        10, '', '',
1701         'paystart_month',  'int', 'NULL',        '', '', '',
1702         'paystart_year',   'int', 'NULL',        '', '', '',
1703         'payissue',    'varchar', 'NULL',         2, '', '',
1704         'payname',     'varchar', 'NULL', 2*$char_d, '', '',
1705         'paystate',    'varchar', 'NULL',   $char_d, '', '',
1706         'paytype',     'varchar', 'NULL',   $char_d, '', '',
1707         'payip',       'varchar', 'NULL',        15, '', '',
1708         'locationnum',     'int', 'NULL',        '', '', '',
1709       ],
1710       'primary_key'  => 'custpaybynum',
1711       'unique'       => [],
1712       'index'        => [ [ 'custnum' ] ],
1713       'foreign_keys' => [
1714                           { columns    => [ 'custnum' ],
1715                             table      => 'cust_main',
1716                           },
1717                           { columns    => [ 'locationnum' ],
1718                             table      => 'cust_location',
1719                           },
1720                         ],
1721     },
1722
1723     'contact_class' => {
1724       'columns' => [
1725         'classnum',    'serial',   '',      '', '', '',
1726         'classname',   'varchar',  '', $char_d, '', '',
1727         'disabled',    'char', 'NULL',       1, '', '',
1728       ],
1729       'primary_key' => 'classnum',
1730       'unique' => [],
1731       'index' => [ ['disabled'] ],
1732     },
1733
1734     'cust_contact' => {
1735       'columns' => [
1736         'custcontactnum',     'serial',     '',  '', '', '',
1737         'custnum',               'int',     '',  '', '', '',
1738         'contactnum',            'int',     '',  '', '', '',
1739         'classnum',              'int', 'NULL',  '', '', '',
1740         'comment',           'varchar', 'NULL', 255, '', '',
1741         'selfservice_access',   'char', 'NULL',   1, '', '',
1742         'invoice_dest',         'char', 'NULL',       1, '', '',
1743       ],
1744       'primary_key'  => 'custcontactnum',
1745       'unique'       => [ [ 'custnum', 'contactnum' ], ],
1746       'index'        => [ [ 'custnum' ], [ 'contactnum' ], ],
1747       'foreign_keys' => [
1748                           { columns    => [ 'custnum' ],
1749                             table      => 'cust_main',
1750                           },
1751                           { columns    => [ 'contactnum' ],
1752                             table      => 'contact',
1753                           },
1754                           { columns    => [ 'classnum' ],
1755                             table      => 'contact_class',
1756                           },
1757                         ],
1758     },
1759
1760     'prospect_contact' => {
1761       'columns' => [
1762         'prospectcontactnum', 'serial',     '',  '', '', '',
1763         'prospectnum',       'int',     '',  '', '', '',
1764         'contactnum',        'int',     '',  '', '', '',
1765         'classnum',          'int', 'NULL',  '', '', '',
1766         'comment',       'varchar', 'NULL', 255, '', '',
1767       ],
1768       'primary_key'  => 'prospectcontactnum',
1769       'unique'       => [ [ 'prospectnum', 'contactnum' ], ],
1770       'index'        => [ [ 'prospectnum' ], [ 'contactnum' ], ],
1771       'foreign_keys' => [
1772                           { columns    => [ 'prospectnum' ],
1773                             table      => 'prospect_main',
1774                           },
1775                           { columns    => [ 'contactnum' ],
1776                             table      => 'contact',
1777                           },
1778                           { columns    => [ 'classnum' ],
1779                             table      => 'contact_class',
1780                           },
1781                         ],
1782     },
1783
1784     'contact' => {
1785       'columns' => [
1786         'contactnum', 'serial',     '',      '', '', '',
1787         'prospectnum',   'int', 'NULL',      '', '', '', #deprecated, now prospect_contact table
1788         'custnum',       'int', 'NULL',      '', '', '', #deprecated, now cust_contact table
1789         'locationnum',   'int', 'NULL',      '', '', '', #not yet
1790         'classnum',      'int', 'NULL',      '', '', '', #deprecated, now prospect_contact or cust_contact
1791 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1792         'last',      'varchar',     '', $char_d, '', '',
1793 #        'middle',    'varchar', 'NULL', $char_d, '', '',
1794         'first',     'varchar',     '', $char_d, '', '',
1795         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1796         'comment',   'varchar', 'NULL',     255, '', '',  #depredated, now prospect_contact or cust_contact
1797         'selfservice_access',    'char', 'NULL',       1, '', '', #deprecated, now cust_contact
1798         '_password',          'varchar', 'NULL', $char_d, '', '',
1799         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1800         'disabled',              'char', 'NULL',       1, '', '',
1801         'invoice_dest',          'char', 'NULL',       1, '', '',
1802       ],
1803       'primary_key'  => 'contactnum',
1804       'unique'       => [],
1805       'index'        => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1806                           [ 'last' ], [ 'first' ],
1807                         ],
1808       'foreign_keys' => [
1809                           { columns    => [ 'prospectnum' ],
1810                             table      => 'prospect_main',
1811                           },
1812                           { columns    => [ 'custnum' ],
1813                             table      => 'cust_main',
1814                           },
1815                           { columns    => [ 'locationnum' ],
1816                             table      => 'cust_location',
1817                           },
1818                           { columns    => [ 'classnum' ],
1819                             table      => 'contact_class',
1820                           },
1821                         ],
1822     },
1823
1824     'contact_phone' => {
1825       'columns' => [
1826         'contactphonenum', 'serial',     '', '', '', '',
1827         'contactnum',         'int',     '', '', '', '',
1828         'phonetypenum',       'int',     '', '', '', '',
1829         'countrycode',    'varchar',     '',  3, '', '',
1830         'phonenum',       'varchar',     '', 14, '', '',
1831         'extension',      'varchar', 'NULL',  7, '', '',
1832         #?#'comment',        'varchar',     '', $char_d, '', '',
1833       ],
1834       'primary_key'  => 'contactphonenum',
1835       'unique'       => [],
1836       'index'        => [],
1837       'foreign_keys' => [
1838                           { columns    => [ 'contactnum' ],
1839                             table      => 'contact',
1840                           },
1841                           { columns    => [ 'phonetypenum' ],
1842                             table      => 'phone_type',
1843                           },
1844                         ],
1845     },
1846
1847     'phone_type' => {
1848       'columns' => [
1849         'phonetypenum',  'serial', '',      '', '', '',
1850         'typename',     'varchar', '', $char_d, '', '',
1851         'weight',           'int', '',      '', '', '',
1852       ],
1853       'primary_key' => 'phonetypenum',
1854       'unique'      => [ [ 'typename' ], ],
1855       'index'       => [],
1856     },
1857
1858     'contact_email' => {
1859       'columns' => [
1860         'contactemailnum', 'serial', '',      '', '', '',
1861         'contactnum',         'int', '',      '', '', '',
1862         'emailaddress',   'varchar', '', $char_d, '', '',
1863       ],
1864       'primary_key'  => 'contactemailnum',
1865       #'unique'       => [ [ 'contactnum', 'emailaddress' ], ],
1866       'unique'       => [ [ 'emailaddress' ], ],
1867       'index'        => [],
1868       'foreign_keys' => [
1869                           { columns    => [ 'contactnum' ],
1870                             table      => 'contact',
1871                           },
1872                         ],
1873     },
1874
1875     'prospect_main' => {
1876       'columns' => [
1877         'prospectnum',  'serial',     '',      '', '', '',
1878         'agentnum',        'int',     '',      '', '', '',
1879         'company',     'varchar', 'NULL', $char_d, '', '',
1880         'add_date',   @date_type,                  '', '',
1881         'disabled',       'char', 'NULL',       1, '', '',
1882         'custnum',         'int', 'NULL',      '', '', '',
1883         'refnum',          'int', 'NULL',      '', '', '',
1884         'taxstatusnum',    'int', 'NULL',      '', '', '',
1885       ],
1886       'primary_key'  => 'prospectnum',
1887       'unique'       => [],
1888       'index'        => [ ['company'], ['agentnum'], ['disabled'], ['refnum'] ],
1889       'foreign_keys' => [
1890                           { columns    => [ 'agentnum' ],
1891                             table      => 'agent',
1892                           },
1893                           { columns    => [ 'custnum' ],
1894                             table      => 'cust_main',
1895                           },
1896                           { columns    => [ 'refnum' ],
1897                             table      => 'part_referral',
1898                           },
1899                         ],
1900     },
1901
1902     'quotation' => {
1903       'columns' => [
1904         #regular fields
1905         'quotationnum',   'serial',     '', '', '', '',
1906         'prospectnum',       'int', 'NULL', '', '', '',
1907         'custnum',           'int', 'NULL', '', '', '',
1908         '_date',        @date_type,             '', '',
1909         'disabled',         'char', 'NULL',  1, '', '',
1910         'usernum',           'int', 'NULL', '', '', '',
1911         'close_date',   @date_type,             '', '',
1912         'confidence',        'int', 'NULL', '', '', '',
1913         #'total',      @money_type,       '', '',
1914         #'quotation_term', 'varchar', 'NULL', $char_d, '', '',
1915       ],
1916       'primary_key'  => 'quotationnum',
1917       'unique'       => [],
1918       'index'        => [ [ 'prospectnum' ], ['custnum'], ['disabled'], ],
1919       'foreign_keys' => [
1920                           { columns    => [ 'prospectnum' ],
1921                             table      => 'prospect_main',
1922                           },
1923                           { columns    => [ 'custnum' ],
1924                             table      => 'cust_main',
1925                           },
1926                           { columns    => [ 'usernum' ],
1927                             table      => 'access_user',
1928                           },
1929                         ],
1930     },
1931
1932     'quotation_pkg' => {
1933       'columns' => [
1934         'quotationpkgnum',   'serial',     '', '', '', '',
1935         'quotationnum',         'int', 'NULL', '', '', '', #shouldn't be null,
1936                                                            # but history...
1937         'pkgpart',              'int',     '', '', '', '',
1938         'locationnum',          'int', 'NULL', '', '', '',
1939         'start_date',      @date_type,             '', '',
1940         'contract_end',    @date_type,             '', '',
1941         'quantity',             'int', 'NULL', '', '', '',
1942         'waive_setup',         'char', 'NULL',  1, '', '',
1943         'unitsetup',     @money_typen,             '', '',
1944         'unitrecur',     @money_typen,             '', '',
1945       ],
1946       'primary_key'  => 'quotationpkgnum',
1947       'unique'       => [],
1948       'index'        => [ ['pkgpart'], ],
1949       'foreign_keys' => [
1950                           { columns    => [ 'quotationnum' ],
1951                             table      => 'quotation',
1952                           },
1953                           { columns    => [ 'pkgpart' ],
1954                             table      => 'part_pkg',
1955                           },
1956                           { columns    => [ 'locationnum' ],
1957                             table      => 'cust_location',
1958                           },
1959                         ],
1960     },
1961
1962     'quotation_pkg_detail' => {
1963       'columns' => [
1964         'detailnum', 'serial', '', '', '', '',
1965         'quotationpkgnum', 'int', '', '', '', '',
1966         'format',  'char', 'NULL', 1, '', '',       # not used for anything
1967         'detail',  'varchar', '', 255, '', '',
1968         'copy_on_order',        'char', 'NULL',  1, '', '', # 'Y' to copy when ordering
1969       ],
1970       'primary_key'  => 'detailnum',
1971       'unique'       => [],
1972       'index'        => [ [ 'quotationpkgnum' ] ],
1973       'foreign_keys' => [
1974                           { columns    => [ 'quotationpkgnum' ],
1975                             table      => 'quotation_pkg',
1976                             references => [ 'quotationpkgnum' ],
1977                           },
1978                         ],
1979     },
1980
1981     'quotation_pkg_discount' => {
1982       'columns' => [
1983         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1984         'quotationpkgnum',            'int', '', '', '', '',
1985         'discountnum',                'int', '', '', '', '',
1986         'setuprecur',             'varchar', 'NULL', $char_d, '', '',
1987         'amount',              @money_typen, '', '',
1988         #'end_date',              @date_type,         '', '',
1989       ],
1990       'primary_key'  => 'quotationpkgdiscountnum',
1991       'unique'       => [],
1992       'index'        => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
1993       'foreign_keys' => [
1994                           { columns    => [ 'quotationpkgnum' ],
1995                             table      => 'quotation_pkg',
1996                           },
1997                           { columns    => [ 'discountnum' ],
1998                             table      => 'discount',
1999                           },
2000                         ],
2001     },
2002
2003     'quotation_pkg_tax' => {
2004       'columns' => [
2005         'quotationtaxnum',  'serial',     '',      '', '', '',
2006         'quotationpkgnum',     'int',     '',      '', '', '',
2007         'itemdesc',        'varchar',     '', $char_d, '', '',
2008         'setup_amount',    @money_type,                '', '',
2009         'recur_amount',    @money_type,                '', '',
2010       ],
2011       'primary_key' => 'quotationtaxnum',
2012       'unique' => [],
2013       'index'  => [ [ 'quotationpkgnum' ] ],
2014       'foreign_keys' => [
2015                           { columns    => [ 'quotationpkgnum' ],
2016                             table      => 'quotation_pkg',
2017                           },
2018                         ],
2019     },
2020
2021     'cust_location' => { #'location' now that its prospects too, but...
2022       'columns' => [
2023         'locationnum',      'serial',     '',      '', '', '',
2024         'prospectnum',         'int', 'NULL',      '', '', '',
2025         'custnum',             'int', 'NULL',      '', '', '',
2026         'locationname',    'varchar', 'NULL', $char_d, '', '',
2027         'address1',        'varchar',     '', $char_d, '', '',
2028         'address2',        'varchar', 'NULL', $char_d, '', '',
2029         'city',            'varchar', 'NULL', $char_d, '', '',
2030         'county',          'varchar', 'NULL', $char_d, '', '',
2031         'state',           'varchar', 'NULL', $char_d, '', '',
2032         'zip',             'varchar', 'NULL',      10, '', '',
2033         'latitude',        'decimal', 'NULL',  '10,7', '', '',
2034         'longitude',       'decimal', 'NULL',  '10,7', '', '',
2035         'coord_auto',         'char', 'NULL',       1, '', '',
2036         'addr_clean',         'char', 'NULL',       1, '', '',
2037         'country',            'char',     '',       2, '', '',
2038         'geocode',         'varchar', 'NULL',      20, '', '',
2039         'district',        'varchar', 'NULL',      20, '', '',
2040         'censustract',     'varchar', 'NULL',      20, '', '',
2041         'censusyear',         'char', 'NULL',       4, '', '',
2042         'location_type',   'varchar', 'NULL',      20, '', '',
2043         'location_number', 'varchar', 'NULL',      20, '', '',
2044         'location_kind',      'char', 'NULL',       1, '', '',
2045         'incorporated',       'char', 'NULL',       1, '', '',
2046         'disabled',           'char', 'NULL',       1, '', '',
2047       ],
2048       'primary_key'  => 'locationnum',
2049       'unique'       => [],
2050       'index'        => [ [ 'prospectnum' ], [ 'custnum' ],
2051                           [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
2052                           [ 'city' ], [ 'district' ]
2053                         ],
2054       'foreign_keys' => [
2055                           { columns    => [ 'prospectnum' ],
2056                             table      => 'prospect_main',
2057                           },
2058                           { columns    => [ 'custnum' ],
2059                             table      => 'cust_main',
2060                           },
2061                         ],
2062     },
2063
2064     'cust_main_invoice' => {
2065       'columns' => [
2066         'destnum',  'serial',  '',     '', '', '',
2067         'custnum',  'int',  '',     '', '', '',
2068         'dest',     'varchar', '',  $char_d, '', '',
2069       ],
2070       'primary_key'  => 'destnum',
2071       'unique'       => [],
2072       'index'        => [ ['custnum'], ],
2073       'foreign_keys' => [
2074                           { columns    => [ 'custnum' ],
2075                             table      => 'cust_main',
2076                           },
2077                         ],
2078     },
2079
2080     'cust_main_credit_limit' => {
2081       'columns' => [
2082         'creditlimitnum',   'serial', '', '', '', '',
2083         'custnum',             'int', '', '', '', '',
2084         '_date',          @date_type,         '', '',
2085         'amount',       @money_typen,         '', '',
2086         #'amount_currency', 'char', 'NULL',  3, '', '',
2087         'credit_limit', @money_typen,         '', '',
2088         #'credit_limit_currency', 'char', 'NULL',  3, '', '',
2089       ],
2090       'primary_key'  => 'creditlimitnum',
2091       'unique'       => [],
2092       'index'        => [ ['custnum'], ],
2093       'foreign_keys' => [
2094                           { columns    => [ 'custnum' ],
2095                             table      => 'cust_main',
2096                           },
2097                         ],
2098     },
2099
2100     'cust_main_note' => {
2101       'columns' => [
2102         'notenum',   'serial',    '',  '', '', '',
2103         'custnum',      'int',    '',  '', '', '',
2104         'classnum',     'int', 'NULL', '', '', '',
2105         '_date',          @date_type,      '', '',
2106         'otaker',   'varchar', 'NULL', 32, '', '',
2107         'usernum',      'int', 'NULL', '', '', '',
2108         'comments',    'text', 'NULL', '', '', '',
2109         'sticky',       'int',     '', '',  0, '',
2110       ],
2111       'primary_key'  => 'notenum',
2112       'unique'       => [],
2113       'index'        => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
2114       'foreign_keys' => [
2115                           { columns    => [ 'custnum' ],
2116                             table      => 'cust_main',
2117                           },
2118                           { columns    => [ 'classnum' ],
2119                             table      => 'cust_note_class',
2120                           },
2121                           { columns    => [ 'usernum' ],
2122                             table      => 'access_user',
2123                           },
2124                         ],
2125     },
2126
2127     'cust_note_class' => {
2128       'columns' => [
2129         'classnum',    'serial',   '',      '', '', '',
2130         'classname',   'varchar',  '', $char_d, '', '',
2131         'disabled',    'char', 'NULL',       1, '', '',
2132       ],
2133       'primary_key' => 'classnum',
2134       'unique' => [],
2135       'index' => [ ['disabled'] ],
2136     },
2137
2138     'cust_category' => {
2139       'columns' => [
2140         'categorynum',   'serial',  '', '', '', '',
2141         'categoryname',  'varchar', '', $char_d, '', '',
2142         'weight',         'int', 'NULL',  '', '', '',
2143         'disabled',      'char', 'NULL',   1, '', '',
2144       ],
2145       'primary_key' => 'categorynum',
2146       'unique' => [],
2147       'index' => [ ['disabled'] ],
2148     },
2149
2150     'cust_class' => {
2151       'columns' => [
2152         'classnum',     'serial',     '',      '', '', '',
2153         'classname',   'varchar',     '', $char_d, '', '',
2154         'categorynum',     'int', 'NULL',      '', '', '',
2155         'tax',            'char', 'NULL',       1, '', '',
2156         'disabled',       'char', 'NULL',       1, '', '',
2157       ],
2158       'primary_key'  => 'classnum',
2159       'unique'       => [],
2160       'index'        => [ ['disabled'] ],
2161       'foreign_keys' => [
2162                           { columns    => [ 'categorynum' ],
2163                             table      => 'cust_category',
2164                           },
2165                         ],
2166     },
2167
2168     'cust_tag' => {
2169       'columns' => [
2170         'custtagnum', 'serial', '', '', '', '',
2171         'custnum',       'int', '', '', '', '',
2172         'tagnum',        'int', '', '', '', '',
2173       ],
2174       'primary_key'  => 'custtagnum',
2175       'unique'       => [ [ 'custnum', 'tagnum' ] ],
2176       'index'        => [ [ 'custnum' ] ],
2177       'foreign_keys' => [
2178                           { columns    => [ 'custnum' ],
2179                             table      => 'cust_main',
2180                           },
2181                           { columns    => [ 'tagnum' ],
2182                             table      => 'part_tag',
2183                           },
2184                         ],
2185     },
2186
2187     'part_tag' => {
2188       'columns' => [
2189         'tagnum',    'serial',     '',      '', '', '',
2190         'tagname',  'varchar',     '', $char_d, '', '',
2191         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
2192         'tagcolor', 'varchar', 'NULL',       6, '', '',
2193         'by_default',  'char', 'NULL',       1, '', '',
2194         'disabled',    'char', 'NULL',       1, '', '',
2195       ],
2196       'primary_key' => 'tagnum',
2197       'unique'      => [], #[ [ 'tagname' ] ], #?
2198       'index'       => [ [ 'disabled' ] ],
2199     },
2200
2201     'cust_main_exemption' => {
2202       'columns' => [
2203         'exemptionnum',   'serial',     '',      '', '', '',
2204         'custnum',           'int',     '',      '', '', '',
2205         'taxname',       'varchar',     '', $char_d, '', '',
2206         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
2207         #start/end dates?  for reporting?
2208       ],
2209       'primary_key'  => 'exemptionnum',
2210       'unique'       => [],
2211       'index'        => [ [ 'custnum' ] ],
2212       'foreign_keys' => [
2213                           { columns    => [ 'custnum' ],
2214                             table      => 'cust_main',
2215                           },
2216                         ],
2217     },
2218
2219     'cust_tax_adjustment' => {
2220       'columns' => [
2221         'adjustmentnum', 'serial',     '',      '', '', '',
2222         'custnum',          'int',     '',      '', '', '',
2223         'taxname',      'varchar',     '', $char_d, '', '',
2224         'amount',     @money_type,                  '', '',
2225         'currency',        'char', 'NULL',       3, '', '',
2226         'comment',      'varchar', 'NULL', $char_d, '', '',
2227         'billpkgnum',       'int', 'NULL',      '', '', '',
2228         #more?  no cust_bill_pkg_tax_location?
2229       ],
2230       'primary_key'  => 'adjustmentnum',
2231       'unique'       => [],
2232       'index'        => [ [ 'custnum' ], [ 'billpkgnum' ] ],
2233       'foreign_keys' => [
2234                           { columns    => [ 'custnum' ],
2235                             table      => 'cust_main',
2236                           },
2237                           { columns    => [ 'billpkgnum' ],
2238                             table      => 'cust_bill_pkg',
2239                           },
2240                         ],
2241     },
2242
2243     'cust_main_county' => { #district+city+county+state+country are checked
2244                             #off the cust_main_county for validation and to
2245                             #provide a tax rate.
2246       'columns' => [
2247         'taxnum',    'serial',     '',      '', '', '',
2248         'district', 'varchar', 'NULL',      20, '', '',
2249         'city',     'varchar', 'NULL', $char_d, '', '',
2250         'county',   'varchar', 'NULL', $char_d, '', '',
2251         'state',    'varchar', 'NULL', $char_d, '', '',
2252         'country',     'char',     '',       2, '', '',
2253         'taxclass', 'varchar', 'NULL', $char_d, '', '',
2254         'exempt_amount', @money_type,            '', '',
2255         'exempt_amount_currency', 'char', 'NULL', 3, '', '',
2256         'tax',         'real',     '',      '', '', '', #tax %
2257         'taxname',  'varchar', 'NULL', $char_d, '', '',
2258         'setuptax',    'char', 'NULL',       1, '', '', # Y = setup tax exempt
2259         'recurtax',    'char', 'NULL',       1, '', '', # Y = recur tax exempt
2260         'source',   'varchar', 'NULL', $char_d, '', '',
2261       ],
2262       'primary_key' => 'taxnum',
2263       'unique' => [],
2264   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
2265       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ],
2266                    [ 'country' ],
2267                    [ 'taxclass' ],
2268                  ],
2269     },
2270
2271     'tax_rate'    => {
2272       'columns' => [
2273         'taxnum',       'serial',     '',      '', '', '',
2274         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
2275         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
2276         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
2277         'taxclassnum', 'int',     'NULL',      '', '', '',
2278         'effective_date', @date_type, '', '',
2279         'tax',        @taxrate_type,      '', '',        # tax %
2280         'excessrate', @taxrate_typen,     '', '',        # second tax %
2281         'taxbase',    @money_typen, '', '',              # amount at first tax rate
2282         'taxmax',     @money_typen, '', '',              # maximum about at both rates
2283         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
2284         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
2285         'unittype',    'int',  'NULL', '', '', '',      # for fee
2286         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
2287         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
2288         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
2289         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
2290         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
2291         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
2292         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
2293         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
2294         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
2295         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
2296         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
2297         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
2298         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
2299         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
2300         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
2301         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
2302       ],
2303       'primary_key'  => 'taxnum',
2304       'unique'       => [],
2305       'index'        => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
2306       'foreign_keys' => [
2307                           { columns    => [ 'taxclassnum' ],
2308                             table      => 'tax_class',
2309                           },
2310                         ],
2311     },
2312
2313     'tax_rate_location' => {
2314       'columns' => [
2315         'taxratelocationnum', 'serial',  '',     '', '', '',
2316         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
2317         'geocode',            'varchar', '',     20,      '', '',
2318         'city',               'varchar', 'NULL', $char_d, '', '',
2319         'county',             'varchar', 'NULL', $char_d, '', '',
2320         'state',              'char',    'NULL',       2, '', '',
2321         'country',            'char',    'NULL',       2, '', '',
2322         'disabled',           'char',    'NULL', 1, '', '',
2323       ],
2324       'primary_key' => 'taxratelocationnum',
2325       'unique' => [],
2326       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
2327     },
2328
2329     'cust_tax_location' => {
2330       'columns' => [
2331         'custlocationnum', 'serial',  '',     '', '', '',
2332         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
2333         'city',            'varchar', 'NULL', $char_d, '', '',
2334         'postalcity',      'varchar', 'NULL', $char_d, '', '',
2335         'county',          'varchar', 'NULL', $char_d, '', '',
2336         'zip',             'char',    'NULL', 5,  '', '',
2337         'state',           'char',    '',     2,  '', '',
2338         'country',         'char',    'NULL', 2,  '', '', # should not actually be NULL, but cch...
2339         'ziphi',           'char',    'NULL', 10, '', '',
2340         'ziplo',           'char',    'NULL', 10, '', '',
2341         'plus4hi',         'char',    'NULL', 4,  '', '',
2342         'plus4lo',         'char',    'NULL', 4,  '', '',
2343         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
2344         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
2345         'geocode',         'varchar', '',    20,  '', '',
2346       ],
2347       'primary_key' => 'custlocationnum',
2348       'unique' => [],
2349       'index' => [ [ 'zip', 'plus4lo', 'plus4hi', 'ziphi', 'ziplo' ] ],
2350     },
2351
2352     'tax_class' => {
2353       'columns' => [
2354         'taxclassnum',  'serial',  '',            '', '', '',
2355         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
2356         'taxclass',     'varchar', '',       $char_d, '', '',
2357         'description',  'varchar', '',     2*$char_d, '', '',
2358       ],
2359       'primary_key' => 'taxclassnum',
2360       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
2361       'index' => [],
2362     },
2363
2364     'tax_status' => {
2365       'columns' => [
2366         'taxstatusnum', 'serial', '',             '', '', '',
2367         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
2368         'taxstatus',    'varchar', '',       $char_d, '', '',
2369         'description',  'varchar', '',       $char_d, '', '',
2370       ],
2371       'primary_key' => 'taxstatusnum',
2372       'unique'      => [ [ 'data_vendor', 'taxstatus' ] ],
2373       'index' => [],
2374     },
2375
2376     'cust_pay_pending' => {
2377       'columns' => [
2378         'paypendingnum',      'serial',     '',      '', '', '',
2379         'custnum',               'int',     '',      '', '', '',
2380         'paid',            @money_type,                  '', '',
2381         'currency',             'char', 'NULL',       3, '', '',
2382         '_date',            @date_type,                  '', '',
2383         'payby',                'char',     '',       4, '', '',
2384         'payinfo',           'varchar', 'NULL',     512, '', '',
2385         'paymask',           'varchar', 'NULL', $char_d, '', '',
2386         'paydate',           'varchar', 'NULL',     10, '', '',
2387         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
2388         'payunique',         'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
2389
2390         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2391         'status',       'varchar',     '', $char_d, '', '',
2392         'session_id',   'varchar', 'NULL', 1024, '', '', # SHA-512-hex
2393         'statustext',   'text',    'NULL',  '', '', '',
2394         'gatewaynum',   'int',     'NULL',  '', '', '',
2395         #'cust_balance', @money_type,            '', '',
2396         'paynum',       'int',     'NULL',  '', '', '',
2397         'void_paynum',  'int',     'NULL',  '', '', '',
2398         'jobnum',    'bigint',     'NULL',  '', '', '',
2399         'invnum',       'int',     'NULL',  '', '', '',
2400         'manual',       'char',    'NULL',   1, '', '',
2401         'discount_term','int',     'NULL',  '', '', '',
2402         'failure_status','varchar','NULL',  16, '', '',
2403       ],
2404       'primary_key'  => 'paypendingnum',
2405       'unique'       => [ [ 'payunique' ] ],
2406       'index'        => [ [ 'custnum' ], [ 'status' ],
2407                           ['paynum'], ['void_paynum'], ['jobnum'], ['invnum'],
2408                         ],
2409       'foreign_keys' => [
2410                           { columns    => [ 'custnum' ],
2411                             table      => 'cust_main',
2412                           },
2413                           { columns    => [ 'pkgnum' ],
2414                             table      => 'cust_pkg',
2415                           },
2416                           { columns    => [ 'gatewaynum' ],
2417                             table      => 'payment_gateway',
2418                           },
2419                           { columns    => [ 'paynum' ],
2420                             table      => 'cust_pay',
2421                           },
2422                           { columns    => [ 'void_paynum' ],
2423                             table      => 'cust_pay_void',
2424                             references => [ 'paynum' ],
2425                           },
2426                           { columns    => [ 'jobnum' ],
2427                             table      => 'queue',
2428                           },
2429                           { columns    => [ 'invnum' ],
2430                             table      => 'cust_bill',
2431                           },
2432                         ],
2433     },
2434
2435     'cust_pay' => {
2436       'columns' => [
2437         'paynum',       'serial',    '',       '', '', '',
2438         'custnum',         'int',    '',       '', '', '',
2439         '_date',     @date_type,                   '', '',
2440         'paid',      @money_type,                  '', '',
2441         'currency',       'char', 'NULL',       3, '', '',
2442         'otaker',      'varchar', 'NULL',      32, '', '',
2443         'usernum',         'int', 'NULL',      '', '', '',
2444         'payby',          'char',     '',       4, '', '',
2445         'payinfo',     'varchar', 'NULL',     512, '', '',
2446         'paymask',     'varchar', 'NULL', $char_d, '', '',
2447         'paydate',     'varchar', 'NULL',      10, '', '',
2448         'paybatch',    'varchar', 'NULL', $char_d, '', '',#for auditing purposes
2449         'payunique',   'varchar', 'NULL', $char_d, '', '',#separate paybatch "unique" functions from current usage
2450         'closed',         'char', 'NULL',       1, '', '',
2451         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2452         'no_auto_apply',  'char', 'NULL',       1, '', '',
2453
2454         # cash/check deposit info fields
2455         'bank',        'varchar', 'NULL', $char_d, '', '',
2456         'depositor',   'varchar', 'NULL', $char_d, '', '',
2457         'account',     'varchar', 'NULL',      20, '', '',
2458         'teller',      'varchar', 'NULL',      20, '', '',
2459
2460         'batchnum',        'int', 'NULL',      '', '', '',#pay_batch foreign key
2461
2462         # credit card/EFT fields (formerly in paybatch)
2463         'gatewaynum',      'int', 'NULL',      '', '', '', # payment_gateway FK
2464         'processor',   'varchar', 'NULL', $char_d, '', '', # module name
2465         'auth',        'varchar', 'NULL',      16, '', '', # CC auth number
2466         'order_number','varchar', 'NULL', $char_d, '', '', # transaction number
2467       ],
2468       'primary_key'  => 'paynum',
2469       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
2470       'index'        => [ ['custnum'], ['paybatch'], ['payby'], ['_date'],
2471                           ['usernum'],
2472                         ],
2473       'foreign_keys' => [
2474                           { columns    => [ 'custnum' ],
2475                             table      => 'cust_main',
2476                           },
2477                           { columns    => [ 'usernum' ],
2478                             table      => 'access_user',
2479                           },
2480                           { columns    => [ 'pkgnum' ],
2481                             table      => 'cust_pkg',
2482                           },
2483                           { columns    => [ 'batchnum' ],
2484                             table      => 'pay_batch',
2485                           },
2486                           { columns    => [ 'gatewaynum' ],
2487                             table      => 'payment_gateway',
2488                           },
2489                         ],
2490     },
2491
2492     'cust_pay_void' => {
2493       'columns' => [
2494         'paynum',          'int',    '',       '', '', '',
2495         'custnum',         'int',    '',       '', '', '',
2496         '_date',      @date_type,                  '', '',
2497         'paid',      @money_type,                  '', '',
2498         'currency',       'char', 'NULL',       3, '', '',
2499         'otaker',      'varchar', 'NULL',      32, '', '',
2500         'usernum',         'int', 'NULL',      '', '', '',
2501         'payby',          'char',     '',       4, '', '',
2502         'payinfo',     'varchar', 'NULL',     512, '', '',
2503         'paymask',     'varchar', 'NULL', $char_d, '', '',
2504         #'paydate' ?
2505         'paybatch',    'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
2506         'closed',        'char',  'NULL',       1, '', '',
2507         'pkgnum', 'int',   'NULL', '', '', '', #desired pkgnum for pkg-balances
2508
2509         # cash/check deposit info fields
2510         'bank',       'varchar', 'NULL', $char_d, '', '',
2511         'depositor',  'varchar', 'NULL', $char_d, '', '',
2512         'account',    'varchar', 'NULL',      20, '', '',
2513         'teller',     'varchar', 'NULL',      20, '', '',
2514         'batchnum',       'int', 'NULL',      '', '', '', #pay_batch foreign key
2515
2516         # credit card/EFT fields (formerly in paybatch)
2517         'gatewaynum',      'int', 'NULL',      '', '', '', # payment_gateway FK
2518         'processor',   'varchar', 'NULL', $char_d, '', '', # module name
2519         'auth',        'varchar', 'NULL',      16, '', '', # CC auth number
2520         'order_number','varchar', 'NULL', $char_d, '', '', # transaction number
2521
2522         #void fields
2523         'void_date',  @date_type,                  '', '',
2524         'reason',      'varchar', 'NULL', $char_d, '', '',
2525         'reasonnum',       'int', 'NULL',      '', '', '',
2526         'void_usernum',    'int', 'NULL',      '', '', '',
2527       ],
2528       'primary_key'  => 'paynum',
2529       'unique'       => [],
2530       'index'        => [ ['custnum'], ['usernum'], ['void_usernum'] ],
2531       'foreign_keys' => [
2532                           { columns    => [ 'custnum' ],
2533                             table      => 'cust_main',
2534                           },
2535                           { columns    => [ 'usernum' ],
2536                             table      => 'access_user',
2537                           },
2538                           { columns    => [ 'pkgnum' ],
2539                             table      => 'cust_pkg',
2540                           },
2541                           { columns    => [ 'batchnum' ],
2542                             table      => 'pay_batch',
2543                           },
2544                           { columns    => [ 'gatewaynum' ],
2545                             table      => 'payment_gateway',
2546                           },
2547                           { columns    => [ 'reasonnum' ],
2548                             table      => 'reason',
2549                           },
2550                           { columns    => [ 'void_usernum' ],
2551                             table      => 'access_user',
2552                             references => [ 'usernum' ],
2553                           },
2554                         ],
2555     },
2556
2557     'cust_bill_pay' => {
2558       'columns' => [
2559         'billpaynum', 'serial',     '',   '', '', '',
2560         'invnum',  'int',     '',   '', '', '',
2561         'paynum',  'int',     '',   '', '', '',
2562         'amount',  @money_type, '', '',
2563         '_date',   @date_type, '', '',
2564         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
2565       ],
2566       'primary_key'  => 'billpaynum',
2567       'unique'       => [],
2568       'index'        => [ [ 'paynum' ], [ 'invnum' ] ],
2569       'foreign_keys' => [
2570                           { columns    => [ 'invnum' ],
2571                             table      => 'cust_bill',
2572                           },
2573                           { columns    => [ 'paynum' ],
2574                             table      => 'cust_pay',
2575                           },
2576                           { columns    => [ 'pkgnum' ],
2577                             table      => 'cust_pkg',
2578                           },
2579                         ],
2580     },
2581
2582     'cust_bill_pay_batch' => {
2583       'columns' => [
2584         'billpaynum', 'serial',     '',   '', '', '',
2585         'invnum',  'int',     '',   '', '', '',
2586         'paybatchnum',  'int',     '',   '', '', '',
2587         'amount',  @money_type, '', '',
2588         '_date',   @date_type, '', '',
2589       ],
2590       'primary_key'  => 'billpaynum',
2591       'unique'       => [],
2592       'index'        => [ [ 'paybatchnum' ], [ 'invnum' ] ],
2593       'foreign_keys' => [
2594                           { columns    => [ 'invnum' ],
2595                             table      => 'cust_bill',
2596                           },
2597                           { columns    => [ 'paybatchnum' ],
2598                             table      => 'cust_pay_batch',
2599                           },
2600                         ],
2601     },
2602
2603     'cust_bill_pay_pkg' => {
2604       'columns' => [
2605         'billpaypkgnum', 'serial', '', '', '', '',
2606         'billpaynum',       'int', '', '', '', '',
2607         'billpkgnum',       'int', '', '', '', '',
2608         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
2609         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
2610         'amount',         @money_type,     '', '',
2611         'setuprecur',      'varchar', '', $char_d, '', '',
2612         'sdate',   @date_type, '', '',
2613         'edate',   @date_type, '', '',
2614       ],
2615       'primary_key'  => 'billpaypkgnum',
2616       'unique'       => [],
2617       'index'        => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
2618       'foreign_keys' => [
2619                           { columns    => [ 'billpaynum' ],
2620                             table      => 'cust_bill_pay',
2621                           },
2622                           { columns    => [ 'billpkgnum' ],
2623                             table      => 'cust_bill_pkg',
2624                           },
2625                           { columns    => [ 'billpkgtaxlocationnum' ],
2626                             table      => 'cust_bill_pkg_tax_location',
2627                           },
2628                           { columns    => [ 'billpkgtaxratelocationnum' ],
2629                             table      => 'cust_bill_pkg_tax_rate_location',
2630                           },
2631                         ],
2632     },
2633
2634     'pay_batch' => { #batches of payments to an external processor
2635       'columns' => [
2636         'batchnum', 'serial',     '', '', '', '',
2637         'agentnum',    'int', 'NULL', '', '', '',
2638         'payby',      'char',     '',  4, '', '', # CARD/CHEK
2639         'status',     'char', 'NULL',  1, '', '',
2640         'download',       @date_type,     '', '',
2641         'upload',         @date_type,     '', '',
2642         'title',   'varchar', 'NULL',255, '', '',
2643         'processor_id',   'varchar', 'NULL',255, '', '',
2644       ],
2645       'primary_key'  => 'batchnum',
2646       'unique'       => [],
2647       'index'        => [],
2648       'foreign_keys' => [
2649                           { columns    => [ 'agentnum' ],
2650                             table      => 'agent',
2651                           },
2652                         ],
2653     },
2654
2655     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
2656       'columns' => [
2657         'paybatchnum',    'serial',     '',      '', '', '',
2658         'batchnum',          'int',     '',      '', '', '',
2659         'invnum',            'int',     '',      '', '', '',
2660         'custnum',           'int',     '',      '', '', '',
2661         'last',          'varchar',     '', $char_d, '', '',
2662         'first',         'varchar',     '', $char_d, '', '',
2663         'address1',      'varchar',     '', $char_d, '', '',
2664         'address2',      'varchar', 'NULL', $char_d, '', '',
2665         'city',          'varchar', 'NULL', $char_d, '', '',
2666         'state',         'varchar', 'NULL', $char_d, '', '',
2667         'zip',           'varchar', 'NULL',      10, '', '',
2668         'country',          'char',     '',       2, '', '',
2669         'payby',            'char',     '',       4, '', '',
2670         'payinfo',       'varchar', 'NULL',     512, '', '',
2671         #'exp',          @date_type,                  '', '',
2672         'exp',           'varchar', 'NULL',      11, '', '',
2673         'payname',       'varchar', 'NULL', $char_d, '', '',
2674         'paytype',       'varchar', 'NULL', $char_d, '', '',
2675         'amount',      @money_type,                  '', '',
2676         'currency',         'char', 'NULL',       3, '', '',
2677         'status',        'varchar', 'NULL', $char_d, '', '',
2678         'failure_status','varchar', 'NULL',      16, '', '',
2679         'error_message', 'varchar', 'NULL', $char_d, '', '',
2680       ],
2681       'primary_key'  => 'paybatchnum',
2682       'unique'       => [],
2683       'index'        => [ ['batchnum'], ['invnum'], ['custnum'] ],
2684       'foreign_keys' => [
2685                           { columns    => [ 'batchnum' ],
2686                             table      => 'pay_batch',
2687                           },
2688                           #{ columns    => [ 'invnum' ],
2689                           #  table      => 'cust_bill',
2690                           #},
2691                           { columns    => [ 'custnum' ],
2692                             table      => 'cust_main',
2693                           },
2694                         ],
2695     },
2696
2697     'fcc477map' => {
2698       'columns' => [
2699         'formkey',   'varchar',     '', 255, '', '',
2700         'formvalue',    'text', 'NULL',  '', '', '',
2701       ],
2702       'primary_key' => 'formkey',
2703       'unique'      => [],
2704       'index'       => [],
2705     },
2706
2707     'cust_pkg' => {
2708       'columns' => [
2709         'pkgnum',           'serial',     '', '', '', '',
2710         'custnum',             'int',     '', '', '', '',
2711         'pkgpart',             'int',     '', '', '', '',
2712         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
2713         'contactnum',          'int', 'NULL', '', '', '',
2714         'locationnum',         'int', 'NULL', '', '', '',
2715         'otaker',          'varchar', 'NULL', 32, '', '',
2716         'usernum',             'int', 'NULL', '', '', '',
2717         'salesnum',            'int', 'NULL', '', '', '',
2718         'order_date',     @date_type,             '', '',
2719         'start_date',     @date_type,             '', '',
2720         'setup',          @date_type,             '', '',
2721         'bill',           @date_type,             '', '',
2722         'last_bill',      @date_type,             '', '',
2723         'susp',           @date_type,             '', '',
2724         'adjourn',        @date_type,             '', '',
2725         'resume',         @date_type,             '', '',
2726         'cancel',         @date_type,             '', '',
2727         'uncancel',       @date_type,             '', '',
2728         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
2729         'expire',         @date_type,             '', '',
2730         'contract_end',   @date_type,             '', '',
2731         'dundate',        @date_type,             '', '',
2732         'change_date',    @date_type,             '', '',
2733         'change_pkgnum',       'int', 'NULL', '', '', '',
2734         'change_pkgpart',      'int', 'NULL', '', '', '',
2735         'change_locationnum',  'int', 'NULL', '', '', '',
2736         'change_custnum',      'int', 'NULL', '', '', '',
2737         'main_pkgnum',         'int', 'NULL', '', '', '',
2738         'pkglinknum',          'int', 'NULL', '', '', '',
2739         'no_auto',            'char', 'NULL',  1, '', '',
2740         'quantity',            'int', 'NULL', '', '', '',
2741         'agent_pkgid',     'varchar', 'NULL', $char_d, '', '',
2742         'waive_setup',        'char', 'NULL',  1, '', '',
2743         'recur_show_zero',    'char', 'NULL',  1, '', '',
2744         'setup_show_zero',    'char', 'NULL',  1, '', '',
2745         'change_to_pkgnum',    'int', 'NULL', '', '', '',
2746         'separate_bill',      'char', 'NULL',  1, '', '',
2747       ],
2748       'primary_key'  => 'pkgnum',
2749       'unique'       => [],
2750       'index'        => [ ['custnum'], ['pkgpart'], ['pkgbatch'],
2751                           ['locationnum'], ['usernum'], ['agent_pkgid'],
2752                           ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
2753                           ['last_bill'], ['susp'], ['adjourn'], ['resume'],
2754                           ['cancel'], ['expire'], ['contract_end'],
2755                           ['change_date'],
2756                           ['no_auto'],
2757                           #['contactnum'],
2758                           ['salesnum'],
2759                           #['uncancel_pkgnum'],
2760                           #['change_pkgnum'], ['change_locationnum'],
2761                           #['change_custnum'],
2762                           ['main_pkgnum'],
2763                           #['pkglinknum'], ['change_to_pkgnum'],
2764                         ],
2765       'foreign_keys' => [
2766                           { columns    => [ 'custnum' ],
2767                             table      => 'cust_main',
2768                           },
2769                           { columns    => [ 'pkgpart' ],
2770                             table      => 'part_pkg',
2771                           },
2772                           { columns    => [ 'contactnum' ],
2773                             table      => 'contact',
2774                           },
2775                           { columns    => [ 'locationnum' ],
2776                             table      => 'cust_location',
2777                           },
2778                           { columns    => [ 'usernum' ],
2779                             table      => 'access_user',
2780                           },
2781                           { columns    => [ 'salesnum' ],
2782                             table      => 'sales',
2783                           },
2784                           { columns    => [ 'uncancel_pkgnum' ],
2785                             table      => 'cust_pkg',
2786                             references => [ 'pkgnum' ],
2787                           },
2788                           { columns    => [ 'change_pkgnum' ],
2789                             table      => 'cust_pkg',
2790                             references => [ 'pkgnum' ],
2791                           },
2792                           { columns    => [ 'change_pkgpart' ],
2793                             table      => 'part_pkg',
2794                             references => [ 'pkgpart' ],
2795                           },
2796                           { columns    => [ 'change_locationnum' ],
2797                             table      => 'cust_location',
2798                             references => [ 'locationnum' ],
2799                           },
2800                           { columns    => [ 'change_custnum' ],
2801                             table      => 'cust_main',
2802                             references => [ 'custnum' ],
2803                           },
2804                           { columns    => [ 'main_pkgnum' ],
2805                             table      => 'cust_pkg',
2806                             references => [ 'pkgnum' ],
2807                           },
2808                           { columns    => [ 'pkglinknum' ],
2809                             table      => 'part_pkg_link',
2810                           },
2811                           { columns    => [ 'change_to_pkgnum' ],
2812                             table      => 'cust_pkg',
2813                             references => [ 'pkgnum' ],
2814                           },
2815                         ],
2816    },
2817
2818     'cust_pkg_option' => {
2819       'columns' => [
2820         'optionnum', 'serial', '', '', '', '',
2821         'pkgnum', 'int', '', '', '', '',
2822         'optionname', 'varchar', '', $char_d, '', '',
2823         'optionvalue', 'text', 'NULL', '', '', '',
2824       ],
2825       'primary_key'  => 'optionnum',
2826       'unique'       => [],
2827       'index'        => [ [ 'pkgnum' ], [ 'optionname' ] ],
2828       'foreign_keys' => [
2829                           { columns    => [ 'pkgnum' ],
2830                             table      => 'cust_pkg',
2831                           },
2832                         ],
2833     },
2834
2835     'cust_pkg_detail' => {
2836       'columns' => [
2837         'pkgdetailnum', 'serial', '',        '', '', '',
2838         'pkgnum',          'int', '',        '', '', '',
2839         'detail',      'varchar', '', 2*$char_d, '', '',
2840         'detailtype',     'char', '',         1, '', '', #"I"nvoice or "C"omment
2841         'weight',          'int', '',        '', '', '',
2842       ],
2843       'primary_key'  => 'pkgdetailnum',
2844       'unique'       => [],
2845       'index'        => [ [ 'pkgnum', 'detailtype' ] ],
2846       'foreign_keys' => [
2847                           { columns    => [ 'pkgnum' ],
2848                             table      => 'cust_pkg',
2849                           },
2850                         ],
2851     },
2852
2853     'cust_pkg_reason' => {
2854       'columns' => [
2855         'num',      'serial',    '',   '', '', '',
2856         'pkgnum',   'int',    '',   '', '', '',
2857         'reasonnum','int',    '',   '', '', '',
2858         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
2859         'otaker',   'varchar', 'NULL', 32, '', '',
2860         'usernum',   'int', 'NULL', '', '', '',
2861         'date',     @date_type, '', '',
2862       ],
2863       'primary_key'  => 'num',
2864       'unique'       => [],
2865       'index'        => [ ['pkgnum'], ['reasonnum'], ['action'], ['usernum'], ],
2866       'foreign_keys' => [
2867                           { columns    => [ 'pkgnum' ],
2868                             table      => 'cust_pkg',
2869                           },
2870                           { columns    => [ 'reasonnum' ],
2871                             table      => 'reason',
2872                           },
2873                           { columns    => [ 'usernum' ],
2874                             table      => 'access_user',
2875                           },
2876                         ],
2877     },
2878
2879     'cust_pkg_reason_fee' => {
2880       'columns' => [
2881         'pkgreasonfeenum', 'serial', '', '', '', '',
2882         'pkgreasonnum',       'int', '', '', '', '',
2883         'billpkgnum',         'int', 'NULL', '', '', '',
2884         'feepart',            'int', '', '', '', '',
2885         'nextbill',          'char', 'NULL',  1, '', '',
2886       ],
2887       'primary_key'  => 'pkgreasonfeenum',
2888       'unique' => [ [ 'billpkgnum' ], [ 'pkgreasonnum' ] ], # one-to-one link
2889       'index'  => [ [ 'feepart' ] ],
2890       'foreign_keys' => [
2891                           { columns     => [ 'pkgreasonnum' ],
2892                             table       => 'cust_pkg_reason',
2893                             references  => [ 'num' ],
2894                           },
2895                           { columns     => [ 'feepart' ],
2896                             table       => 'part_fee',
2897                           },
2898                           # can't link billpkgnum, because of voids
2899       ],
2900     },
2901
2902     'cust_pkg_discount' => {
2903       'columns' => [
2904         'pkgdiscountnum', 'serial', '',        '', '', '',
2905         'pkgnum',            'int', '',        '', '', '',
2906         'discountnum',       'int', '',        '', '', '',
2907         'months_used',   'decimal', 'NULL', '7,4', '', '',
2908         'end_date',     @date_type,                '', '',
2909         'otaker',        'varchar', 'NULL',    32, '', '',
2910         'usernum',           'int', 'NULL',    '', '', '',
2911         'disabled',         'char', 'NULL',     1, '', '',
2912         'setuprecur',       'char', 'NULL',     5, '', '',
2913       ],
2914       'primary_key'  => 'pkgdiscountnum',
2915       'unique'       => [],
2916       'index'        => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
2917       'foreign_keys' => [
2918                           { columns    => [ 'pkgnum' ],
2919                             table      => 'cust_pkg',
2920                           },
2921                           { columns    => [ 'discountnum' ],
2922                             table      => 'discount',
2923                           },
2924                           { columns    => [ 'usernum' ],
2925                             table      => 'access_user',
2926                           },
2927                         ],
2928     },
2929
2930     'cust_pkg_usage' => {
2931       'columns' => [
2932         'pkgusagenum', 'serial', '', '', '', '',
2933         'pkgnum',         'int', '', '', '', '',
2934         'minutes',        'double precision', '', '', '', '',
2935         'pkgusagepart',   'int', '', '', '', '',
2936       ],
2937       'primary_key'  => 'pkgusagenum',
2938       'unique'       => [],
2939       'index'        => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
2940       'foreign_keys' => [
2941                           { columns    => [ 'pkgnum' ],
2942                             table      => 'cust_pkg',
2943                           },
2944                           { columns    => [ 'pkgusagepart' ],
2945                             table      => 'part_pkg_usage',
2946                           },
2947                         ],
2948     },
2949
2950     'cdr_cust_pkg_usage' => {
2951       'columns' => [
2952         'cdrusagenum', 'bigserial', '', '', '', '',
2953         'acctid',      'bigint',    '', '', '', '',
2954         'pkgusagenum', 'int',       '', '', '', '',
2955         'minutes',     'double precision',       '', '', '', '',
2956       ],
2957       'primary_key'  => 'cdrusagenum',
2958       'unique'       => [],
2959       'index'        => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
2960       'foreign_keys' => [
2961                           { columns    => [ 'acctid' ],
2962                             table      => 'cdr',
2963                           },
2964                           { columns    => [ 'pkgusagenum' ],
2965                             table      => 'cust_pkg_usage',
2966                           },
2967                         ],
2968     },
2969
2970     'cust_bill_pkg_discount' => {
2971       'columns' => [
2972         'billpkgdiscountnum', 'serial',        '', '', '', '',
2973         'billpkgnum',            'int',        '', '', '', '',
2974         'pkgdiscountnum',        'int',        '', '', '', '',
2975         'amount',          @money_type,                '', '',
2976         'months',            'decimal', 'NULL', '7,4', '', '',
2977       ],
2978       'primary_key'  => 'billpkgdiscountnum',
2979       'unique'       => [],
2980       'index'        => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2981       'foreign_keys' => [
2982                           { columns    => [ 'billpkgnum' ],
2983                             table      => 'cust_bill_pkg',
2984                           },
2985                           { columns    => [ 'pkgdiscountnum' ],
2986                             table      => 'cust_pkg_discount',
2987                           },
2988                         ],
2989     },
2990
2991     'cust_bill_pkg_discount_void' => {
2992       'columns' => [
2993         'billpkgdiscountnum',    'int',        '', '', '', '',
2994         'billpkgnum',            'int',        '', '', '', '',
2995         'pkgdiscountnum',        'int',        '', '', '', '',
2996         'amount',          @money_type,                '', '',
2997         'months',            'decimal', 'NULL', '7,4', '', '',
2998       ],
2999       'primary_key'  => 'billpkgdiscountnum',
3000       'unique'       => [],
3001       'index'        => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
3002       'foreign_keys' => [
3003                           { columns    => [ 'billpkgnum' ],
3004                             table      => 'cust_bill_pkg_void',
3005                           },
3006                           { columns    => [ 'pkgdiscountnum' ],
3007                             table      => 'cust_pkg_discount',
3008                           },
3009                         ],
3010     },
3011
3012     'discount' => {
3013       'columns' => [
3014         'discountnum', 'serial',     '',      '', '', '',
3015         #'agentnum',       'int', 'NULL',      '', '', '',
3016         'classnum',       'int', 'NULL',      '', '', '',
3017         'name',       'varchar', 'NULL', $char_d, '', '',
3018         'amount',   @money_type,                  '', '',
3019         'percent',    'decimal',     '',   '7,4', '', '',
3020         'months',     'decimal', 'NULL',   '7,4', '', '',
3021         'disabled',      'char', 'NULL',       1, '', '',
3022         'setup',         'char', 'NULL',       1, '', '',
3023         #'linked',        'char', 'NULL',       1, '', '',
3024       ],
3025       'primary_key'  => 'discountnum',
3026       'unique'       => [],
3027       'index'        => [], # [ 'agentnum' ], ],
3028       'foreign_keys' => [
3029                           { columns    => [ 'classnum' ],
3030                             table      => 'discount_class',
3031                           },
3032                         ],
3033     },
3034
3035     'discount_class' => {
3036       'columns' => [
3037         'classnum',    'serial',   '',      '', '', '',
3038         'classname',   'varchar',  '', $char_d, '', '',
3039         #'categorynum', 'int',  'NULL',      '', '', '',
3040         'disabled',    'char', 'NULL',       1, '', '',
3041       ],
3042       'primary_key' => 'classnum',
3043       'unique' => [],
3044       'index' => [ ['disabled'] ],
3045     },
3046
3047     'cust_refund' => {
3048       'columns' => [
3049         'refundnum',    'serial',    '',   '', '', '',
3050         'custnum',  'int',    '',   '', '', '',
3051         '_date',        @date_type, '', '',
3052         'refund',       @money_type, '', '',
3053         'currency',       'char', 'NULL',       3, '', '',
3054         'otaker',       'varchar',   'NULL',   32, '', '',
3055         'usernum',   'int', 'NULL', '', '', '',
3056         'reason',       'varchar',   'NULL',   $char_d, '', '',
3057         'reasonnum',   'int', 'NULL', '', '', '',
3058         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
3059                                                      # be index into payby
3060                                                      # table eventually
3061         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
3062         'paymask', 'varchar', 'NULL', $char_d, '', '',
3063         'paybatch',     'varchar',   'NULL', $char_d, '', '',
3064         'closed',    'char', 'NULL', 1, '', '',
3065         'source_paynum', 'int', 'NULL', '', '', '', # link to cust_payby, to prevent unapply of gateway-generated refunds
3066         # credit card/EFT fields (formerly in paybatch)
3067         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
3068         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
3069         'auth',       'varchar','NULL',16, '', '', # CC auth number
3070         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
3071       ],
3072       'primary_key'  => 'refundnum',
3073       'unique'       => [],
3074       'index'        => [ ['custnum'], ['_date'], [ 'usernum' ], ],
3075       'foreign_keys' => [
3076                           { columns    => [ 'custnum' ],
3077                             table      => 'cust_main',
3078                           },
3079                           { columns    => [ 'usernum' ],
3080                             table      => 'access_user',
3081                           },
3082                           { columns    => [ 'reasonnum' ],
3083                             table      => 'reason',
3084                           },
3085                           { columns    => [ 'gatewaynum' ],
3086                             table      => 'payment_gateway',
3087                           },
3088                           { columns    => [ 'source_paynum' ],
3089                             table      => 'cust_pay',
3090                             references => [ 'paynum' ],
3091                           },
3092                         ],
3093     },
3094
3095     'cust_credit_refund' => {
3096       'columns' => [
3097         'creditrefundnum', 'serial',     '',   '', '', '',
3098         'crednum',  'int',     '',   '', '', '',
3099         'refundnum',  'int',     '',   '', '', '',
3100         'amount',  @money_type, '', '',
3101         '_date',   @date_type, '', '',
3102       ],
3103       'primary_key'  => 'creditrefundnum',
3104       'unique'       => [],
3105       'index'        => [ ['crednum'], ['refundnum'] ],
3106       'foreign_keys' => [
3107                           { columns    => [ 'crednum' ],
3108                             table      => 'cust_credit',
3109                           },
3110                           { columns    => [ 'refundnum' ],
3111                             table      => 'cust_refund',
3112                           },
3113                         ],
3114     },
3115
3116
3117     'cust_svc' => {
3118       'columns' => [
3119         'svcnum',      'serial',     '', '', '', '',
3120         'pkgnum',         'int', 'NULL', '', '', '',
3121         'svcpart',        'int',     '', '', '', '',
3122         'agent_svcid',    'int', 'NULL', '', '', '',
3123         'overlimit',           @date_type,   '', '',
3124       ],
3125       'primary_key'  => 'svcnum',
3126       'unique'       => [],
3127       'index'        => [ ['svcnum'], ['pkgnum'], ['svcpart'],
3128                           ['agent_svcid'],
3129                         ],
3130       'foreign_keys' => [
3131                           { columns    => [ 'pkgnum' ],
3132                             table      => 'cust_pkg',
3133                           },
3134                           { columns    => [ 'svcpart' ],
3135                             table      => 'part_svc',
3136                           },
3137                         ],
3138     },
3139
3140     'cust_svc_option' => {
3141       'columns' => [
3142         'optionnum',   'serial', '', '', '', '',
3143         'svcnum',      'int', '', '', '', '',
3144         'optionname',  'varchar', '', $char_d, '', '',
3145         'optionvalue', 'text', 'NULL', '', '', '',
3146       ],
3147       'primary_key'  => 'optionnum',
3148       'unique'       => [],
3149       'index'        => [ [ 'svcnum' ], [ 'optionname' ] ],
3150       'foreign_keys' => [
3151                           { columns    => [ 'svcnum' ],
3152                             table      => 'cust_svc',
3153                           },
3154                         ],
3155     },
3156
3157     'svc_export_machine' => {
3158       'columns' => [
3159         'svcexportmachinenum', 'serial', '', '', '', '',
3160         'svcnum',                 'int', '', '', '', '',
3161         'exportnum',              'int', '', '', '', '',
3162         'machinenum',             'int', '', '', '', '',
3163       ],
3164       'primary_key'  => 'svcexportmachinenum',
3165       'unique'       => [ ['svcnum', 'exportnum'] ],
3166       'index'        => [],
3167       'foreign_keys' => [
3168                           { columns    => [ 'svcnum' ],
3169                             table      => 'cust_svc',
3170                           },
3171                           { columns    => [ 'exportnum' ],
3172                             table      => 'part_export',
3173                           },
3174                           { columns    => [ 'machinenum' ],
3175                             table      => 'part_export_machine',
3176                           },
3177                         ],
3178     },
3179
3180     'part_export_machine' => {
3181       'columns' => [
3182         'machinenum', 'serial', '', '', '', '',
3183         'exportnum',     'int', '', '', '', '',
3184         'machine',    'varchar', 'NULL', $char_d, '', '',
3185         'disabled',      'char', 'NULL',       1, '', '',
3186       ],
3187       'primary_key'  => 'machinenum',
3188       'unique'       => [ [ 'exportnum', 'machine' ] ],
3189       'index'        => [ [ 'exportnum' ] ],
3190       'foreign_keys' => [
3191                           { columns    => [ 'exportnum' ],
3192                             table      => 'part_export',
3193                           },
3194                         ],
3195     },
3196
3197     'part_pkg' => {
3198       'columns' => [
3199         'pkgpart',       'serial',    '',   '', '', '',
3200         'pkgpartbatch',  'varchar', 'NULL', $char_d, '', '',
3201         'pkg',           'varchar',   '',   $char_d, '', '',
3202         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
3203         'promo_code',    'varchar', 'NULL', $char_d, '', '',
3204         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
3205         'setuptax',      'char', 'NULL', 1, '', '',
3206         'recurtax',      'char', 'NULL', 1, '', '',
3207         'plan',          'varchar', 'NULL', $char_d, '', '',
3208         'disabled',      'char', 'NULL', 1, '', '',
3209         'custom',        'char', 'NULL', 1, '', '',
3210         'taxclass',      'varchar', 'NULL', $char_d, '', '',
3211         'classnum',      'int',     'NULL', '', '', '',
3212         'addon_classnum','int',     'NULL', '', '', '',
3213         'taxproductnum', 'int',     'NULL', '', '', '',
3214         'setup_cost',    @money_typen,          '', '',
3215         'recur_cost',    @money_typen,          '', '',
3216         'pay_weight',    'real',    'NULL', '', '', '',
3217         'credit_weight', 'real',    'NULL', '', '', '',
3218         'agentnum',      'int',     'NULL', '', '', '',
3219         'fcc_ds0s',      'int',     'NULL', '', '', '',
3220         'fcc_voip_class','char',    'NULL',  1, '', '',
3221         'no_auto',          'char', 'NULL',  1, '', '',
3222         'recur_show_zero',  'char', 'NULL',  1, '', '',
3223         'setup_show_zero',  'char', 'NULL',  1, '', '',
3224         'successor',     'int',     'NULL', '', '', '',
3225         'family_pkgpart','int',     'NULL', '', '', '',
3226         'delay_start',   'int',     'NULL', '', '', '',
3227         'start_on_hold', 'char',    'NULL',  1, '', '',
3228         'agent_pkgpartid', 'varchar', 'NULL', 20, '', '',
3229         'expire_months', 'int',     'NULL', '', '', '',
3230         'adjourn_months', 'int',    'NULL', '', '', '',
3231         'contract_end_months','int','NULL', '', '', '',
3232         'change_to_pkgpart', 'int', 'NULL', '', '', '',
3233       ],
3234       'primary_key'  => 'pkgpart',
3235       'unique'       => [],
3236       'index'        => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
3237                           [ 'agentnum' ], ['no_auto'], ['agent_pkgpartid'],
3238                         ],
3239       'foreign_keys' => [
3240                           { columns    => [ 'classnum' ],
3241                             table      => 'pkg_class',
3242                           },
3243                           { columns    => [ 'addon_classnum' ],
3244                             table      => 'pkg_class',
3245                             references => [ 'classnum' ],
3246                           },
3247                           { columns    => [ 'taxproductnum' ],
3248                             table      => 'part_pkg_taxproduct',
3249                           },
3250                           { columns    => [ 'agentnum' ],
3251                             table      => 'agent',
3252                           },
3253                           { columns    => [ 'successor' ],
3254                             table      => 'part_pkg',
3255                             references => [ 'pkgpart' ],
3256                           },
3257                           { columns    => [ 'family_pkgpart' ],
3258                             table      => 'part_pkg',
3259                             references => [ 'pkgpart' ],
3260                           },
3261                           { columns    => [ 'change_to_pkgpart' ],
3262                             table      => 'part_pkg',
3263                             references => [ 'pkgpart' ],
3264                           },
3265                         ],
3266     },
3267
3268     'part_pkg_msgcat' => {
3269       'columns' => [
3270         'pkgpartmsgnum',  'serial',     '',        '', '', '',
3271         'pkgpart',           'int',     '',        '', '', '',
3272         'locale',        'varchar',     '',        16, '', '',
3273         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
3274         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
3275       ],
3276       'primary_key'  => 'pkgpartmsgnum',
3277       'unique'       => [ [ 'pkgpart', 'locale' ] ],
3278       'index'        => [],
3279       'foreign_keys' => [
3280                           { columns    => [ 'pkgpart' ],
3281                             table      => 'part_pkg',
3282                           },
3283                         ],
3284     },
3285
3286     'part_pkg_currency' => {
3287       'columns' => [
3288         'pkgcurrencynum', 'serial', '',      '', '', '',
3289         'pkgpart',           'int', '',      '', '', '',
3290         'currency',         'char', '',       3, '', '',
3291         'optionname',    'varchar', '', $char_d, '', '',
3292         'optionvalue',      'text', '',      '', '', '',
3293       ],
3294       'primary_key'  => 'pkgcurrencynum',
3295       'unique'       => [ [ 'pkgpart', 'currency', 'optionname' ] ],
3296       'index'        => [ ['pkgpart'] ],
3297       'foreign_keys' => [
3298                           { columns    => [ 'pkgpart' ],
3299                             table      => 'part_pkg',
3300                           },
3301                         ],
3302     },
3303
3304     'currency_exchange' => {
3305       'columns' => [
3306         'currencyratenum', 'serial', '',    '', '', '',
3307         'from_currency',     'char', '',     3, '', '',
3308         'to_currency',       'char', '',     3, '', '',
3309         'rate',           'decimal', '', '7,6', '', '',
3310       ],
3311       'primary_key' => 'currencyratenum',
3312       'unique'      => [ [ 'from_currency', 'to_currency' ] ],
3313       'index'       => [],
3314     },
3315
3316     'part_pkg_usageprice' => {
3317       'columns' => [
3318         'usagepricepart', 'serial',      '',      '', '', '',
3319         'pkgpart',           'int',      '',      '', '', '',
3320         'price',          @money_type,                '', '',
3321         'currency',         'char',  'NULL',       3, '', '',
3322         'action',        'varchar',      '', $char_d, '', '',
3323         'target',        'varchar',      '', $char_d, '', '',
3324         'amount',        'varchar',      '', $char_d, '', '',
3325       ],
3326       'primary_key'  => 'usagepricepart',
3327       'unique'       => [ [ 'pkgpart', 'currency', 'target' ] ],
3328       'index'        => [ [ 'pkgpart' ] ],
3329       'foreign_keys' => [
3330                           { columns    => [ 'pkgpart' ],
3331                             table      => 'part_pkg',
3332                           },
3333                         ],
3334     },
3335
3336     'cust_pkg_usageprice' => {
3337       'columns' => [
3338         'usagepricenum', 'serial',      '',      '', '', '',
3339         'pkgnum',           'int',      '',      '', '', '',
3340         'usagepricepart',   'int',      '',      '', '', '',
3341         'quantity',         'int',      '',      '', '', '',
3342       ],
3343       'primary_key'  => 'usagepricenum',
3344       'unique'       => [ [ 'pkgnum', 'usagepricepart' ] ],
3345       'index'        => [ [ 'pkgnum' ] ],
3346       'foreign_keys' => [
3347                           { columns    => [ 'pkgnum' ],
3348                             table      => 'cust_pkg',
3349                           },
3350                           { columns    => [ 'usagepricepart' ],
3351                             table      => 'part_pkg_usageprice',
3352                           },
3353                         ],
3354     },
3355
3356     'part_fee' => {
3357       'columns' => [
3358         'feepart',       'serial',    '',   '', '', '',
3359         'itemdesc',      'varchar',   '',   $char_d,   '', '',
3360         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
3361         'disabled',      'char',    'NULL',  1, '', '',
3362         'classnum',      'int',     'NULL', '', '', '',
3363         'taxclass',      'varchar', 'NULL', $char_d, '', '',
3364         'taxproductnum', 'int',     'NULL', '', '', '',
3365         'pay_weight',    'real',    'NULL', '', '', '',
3366         'credit_weight', 'real',    'NULL', '', '', '',
3367         'agentnum',      'int',     'NULL', '', '', '',
3368         'amount',   @money_type,                '', '',
3369         'percent',     'decimal',    '', '7,4', '', '',
3370         'basis',         'varchar',  '',    16, '', '',
3371         'minimum',    @money_typen,             '', '',
3372         'maximum',    @money_typen,             '', '',
3373         'limit_credit',  'char',    'NULL',  1, '', '',
3374         'setuprecur',    'char',     '',     5, '', '',
3375         'taxable',       'char',    'NULL',  1, '', '',
3376       ],
3377       'primary_key'  => 'feepart',
3378       'unique'       => [],
3379       'index'        => [ [ 'disabled' ], [ 'classnum' ], [ 'agentnum' ]
3380                         ],
3381       'foreign_keys' => [
3382                           { columns    => [ 'classnum' ],
3383                             table      => 'pkg_class',
3384                           },
3385                           { columns    => [ 'taxproductnum' ],
3386                             table      => 'part_pkg_taxproduct',
3387                           },
3388                           { columns    => [ 'agentnum' ],
3389                             table      => 'agent',
3390                           },
3391                         ],
3392     },
3393
3394     'part_fee_msgcat' => {
3395       'columns' => [
3396         'feepartmsgnum',  'serial',     '',        '', '', '',
3397         'feepart',           'int',     '',        '', '', '',
3398         'locale',        'varchar',     '',        16, '', '',
3399         'itemdesc',      'varchar',     '',   $char_d, '', '', #longer/no limit?
3400         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
3401       ],
3402       'primary_key'  => 'feepartmsgnum',
3403       'unique'       => [ [ 'feepart', 'locale' ] ],
3404       'index'        => [],
3405       'foreign_keys' => [
3406                           { columns    => [ 'feepart' ],
3407                             table      => 'part_fee',
3408                           },
3409                         ],
3410     },
3411
3412     'part_fee_usage' => {
3413       'columns' => [
3414         'feepartusagenum','serial',     '',        '', '', '',
3415         'feepart',           'int',     '',        '', '', '',
3416         'classnum',          'int',     '',        '', '', '',
3417         'amount',   @money_type,                '', '',
3418         'percent',     'decimal',    '', '7,4', '', '',
3419       ],
3420       'primary_key'  => 'feepartusagenum',
3421       'unique'       => [ [ 'feepart', 'classnum' ] ],
3422       'index'        => [],
3423       'foreign_keys' => [
3424                           { columns    => [ 'feepart' ],
3425                             table      => 'part_fee',
3426                           },
3427                           { columns    => [ 'classnum' ],
3428                             table      => 'usage_class',
3429                           },
3430                         ],
3431     },
3432
3433     'part_pkg_link' => {
3434       'columns' => [
3435         'pkglinknum',  'serial',   '',      '', '', '',
3436         'src_pkgpart', 'int',      '',      '', '', '',
3437         'dst_pkgpart', 'int',      '',      '', '', '',
3438         'link_type',   'varchar',  '', $char_d, '', '',
3439         'hidden',      'char', 'NULL',       1, '', '',
3440       ],
3441       'primary_key'  => 'pkglinknum',
3442       'unique'       => [ ['src_pkgpart','dst_pkgpart','link_type','hidden'] ],
3443       'index'        => [ [ 'src_pkgpart' ] ],
3444       'foreign_keys' => [
3445                           { columns    => [ 'src_pkgpart' ],
3446                             table      => 'part_pkg',
3447                             references => [ 'pkgpart' ]
3448                           },
3449                           { columns    => [ 'dst_pkgpart' ],
3450                             table      => 'part_pkg',
3451                             references => [ 'pkgpart' ]
3452                           },
3453                         ],
3454     },
3455     # XXX somewhat borked unique: we don't really want a hidden and unhidden
3456     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
3457
3458     'part_pkg_discount' => {
3459       'columns' => [
3460         'pkgdiscountnum', 'serial',   '',      '', '', '',
3461         'pkgpart',        'int',      '',      '', '', '',
3462         'discountnum',    'int',      '',      '', '', '',
3463       ],
3464       'primary_key'  => 'pkgdiscountnum',
3465       'unique'       => [ [ 'pkgpart', 'discountnum' ] ],
3466       'index'        => [],
3467       'foreign_keys' => [
3468                           { columns    => [ 'pkgpart' ],
3469                             table      => 'part_pkg',
3470                           },
3471                           { columns    => [ 'discountnum' ],
3472                             table      => 'discount',
3473                           },
3474                         ],
3475     },
3476
3477     'part_pkg_taxclass' => {
3478       'columns' => [
3479         'taxclassnum',  'serial', '',       '', '', '',
3480         'taxclass',     'varchar', '', $char_d, '', '',
3481         'disabled', 'char',   'NULL',         1, '', '',
3482       ],
3483       'primary_key' => 'taxclassnum',
3484       'unique'      => [ [ 'taxclass' ] ],
3485       'index'       => [ [ 'disabled' ] ],
3486     },
3487
3488     'part_pkg_taxproduct' => {
3489       'columns' => [
3490         'taxproductnum', 'serial',      '',        '', '', '',
3491         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
3492         'taxproduct',    'varchar',     '',   $char_d, '', '',
3493         'description',   'varchar',     '', 3*$char_d, '', '',
3494         'note',             'text', 'NULL',        '', '', '',
3495       ],
3496       'primary_key' => 'taxproductnum',
3497       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
3498       'index'       => [],
3499     },
3500
3501     'part_pkg_taxrate' => {
3502       'columns' => [
3503         'pkgtaxratenum', 'serial',  '',     '',      '', '',
3504         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
3505         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
3506         'taxproductnum', 'int',  '',     '',       '', '',
3507         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
3508         'county',           'varchar', 'NULL', $char_d, '', '',
3509         'state',            'varchar', 'NULL', $char_d, '', '',
3510         'local',            'varchar', 'NULL', $char_d, '', '',
3511         'country',          'char',    'NULL', 2,       '', '',
3512         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
3513         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
3514         'taxclassnum',      'int',     'NULL', '',      '', '',
3515         'effdate',          @date_type, '', '',
3516         'taxable',          'char',    'NULL', 1,       '', '',
3517       ],
3518       'primary_key'  => 'pkgtaxratenum',
3519       'unique'       => [],
3520       'index'        => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
3521       'foreign_keys' => [
3522                           { columns    => [ 'taxproductnum' ],
3523                             table      => 'part_pkg_taxproduct',
3524                           },
3525                           { columns    => [ 'taxclassnumtaxed' ],
3526                             table      => 'tax_class',
3527                             references => [ 'taxclassnum' ],
3528                           },
3529                           { columns    => [ 'taxclassnum' ],
3530                             table      => 'tax_class',
3531                           },
3532                         ],
3533     },
3534
3535     'part_pkg_taxoverride' => {
3536       'columns' => [
3537         'taxoverridenum', 'serial', '', '', '', '',
3538         'pkgpart',           'int', '', '', '', '',
3539         'taxclassnum',       'int', '', '', '', '',
3540         'usage_class',    'varchar', 'NULL', $char_d, '', '',
3541       ],
3542       'primary_key'  => 'taxoverridenum',
3543       'unique'       => [],
3544       'index'        => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
3545       'foreign_keys' => [
3546                           { columns    => [ 'pkgpart' ],
3547                             table      => 'part_pkg',
3548                           },
3549                           { columns    => [ 'taxclassnum' ],
3550                             table      => 'tax_class',
3551                           },
3552                         ],
3553     },
3554
3555 #    'part_title' => {
3556 #      'columns' => [
3557 #        'titlenum',   'int',    '',   '',
3558 #        'title',      'varchar',   '',   $char_d,
3559 #      ],
3560 #      'primary_key' => 'titlenum',
3561 #      'unique' => [ [] ],
3562 #      'index' => [ [] ],
3563 #    },
3564
3565     'pkg_svc' => {
3566       'columns' => [
3567         'pkgsvcnum',   'serial',    '', '', '', '',
3568         'pkgpart',        'int',    '', '', '', '',
3569         'svcpart',        'int',    '', '', '', '',
3570         'quantity',       'int',    '', '', '', '',
3571         'primary_svc',   'char', 'NULL', 1, '', '',
3572         'hidden',        'char', 'NULL', 1, '', '',
3573         'bulk_skip',     'char', 'NULL', 1, '', '',
3574         'provision_hold', 'char', 'NULL', 1, '', '',
3575       ],
3576       'primary_key'  => 'pkgsvcnum',
3577       'unique'       => [ ['pkgpart', 'svcpart'] ],
3578       'index'        => [ ['pkgpart'], ['quantity'] ],
3579       'foreign_keys' => [
3580                           { columns    => [ 'pkgpart' ],
3581                             table      => 'part_pkg',
3582                           },
3583                           { columns    => [ 'svcpart' ],
3584                             table      => 'part_svc',
3585                           },
3586                         ],
3587     },
3588
3589     'part_referral' => {
3590       'columns' => [
3591         'refnum',   'serial',     '',        '', '', '',
3592         'referral', 'varchar',    '',   $char_d, '', '',
3593         'disabled', 'char',   'NULL',         1, '', '',
3594         'agentnum', 'int',    'NULL',        '', '', '',
3595       ],
3596       'primary_key'  => 'refnum',
3597       'unique'       => [],
3598       'index'        => [ ['disabled'], ['agentnum'], ],
3599       'foreign_keys' => [
3600                           { columns    => [ 'agentnum' ],
3601                             table      => 'agent',
3602                           },
3603                         ],
3604     },
3605
3606     'part_svc' => {
3607       'columns' => [
3608         'svcpart',             'serial',     '',        '', '', '',
3609         'svc',                'varchar',     '',   $char_d, '', '',
3610         'svcdb',              'varchar',     '',   $char_d, '', '',
3611         'disabled',              'char', 'NULL',         1, '', '',
3612         'preserve',              'char', 'NULL',         1, '', '',
3613         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
3614         'classnum',               'int', 'NULL',        '', '', '',
3615         'restrict_edit_password','char', 'NULL',         1, '', '',
3616         'has_router',            'char', 'NULL',         1, '', '',
3617 ],
3618       'primary_key'  => 'svcpart',
3619       'unique'       => [],
3620       'index'        => [ [ 'disabled' ] ],
3621       'foreign_keys' => [
3622                           { columns    => [ 'classnum' ],
3623                             table      => 'part_svc_class',
3624                           },
3625                         ],
3626     },
3627
3628     'part_svc_column' => {
3629       'columns' => [
3630         'columnnum',   'serial',      '',      '', '', '',
3631         'svcpart',     'int',         '',      '', '', '',
3632         'columnname',  'varchar',     '',      64, '', '',
3633         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
3634         'columnvalue', 'varchar', 'NULL',     512, '', '',
3635         'columnflag',  'char',    'NULL',       1, '', '',
3636         'required',    'char',    'NULL',       1, '', '',
3637       ],
3638       'primary_key'  => 'columnnum',
3639       'unique'       => [ [ 'svcpart', 'columnname' ] ],
3640       'index'        => [ [ 'svcpart' ] ],
3641       'foreign_keys' => [
3642                           { columns    => [ 'svcpart' ],
3643                             table      => 'part_svc',
3644                           },
3645                         ],
3646     },
3647
3648     'part_svc_class' => {
3649       'columns' => [
3650         'classnum',    'serial',   '',      '', '', '',
3651         'classname',   'varchar',  '', $char_d, '', '',
3652         'disabled',    'char', 'NULL',       1, '', '',
3653       ],
3654       'primary_key' => 'classnum',
3655       'unique' => [],
3656       'index' => [ ['disabled'] ],
3657     },
3658
3659     'part_svc_link' => {
3660       'columns' => [
3661         'svclinknum',  'serial',   '',      '', '', '',
3662         #'linkname',    'varchar', 'NULL', $char_d, '', '',
3663         'agentnum',    'int',     'NULL', '', '', '',
3664         'src_svcpart', 'int',      '',      '', '', '',
3665         'dst_svcpart', 'int',      '',      '', '', '',
3666         'link_type',   'varchar',  '', $char_d, '', '',
3667         'disabled',    'char', 'NULL',   1, '', '',
3668       ],
3669       'primary_key'  => 'svclinknum',
3670       'unique'       => [ ['agentnum','src_svcpart','dst_svcpart','link_type'] ],
3671       'index'        => [ [ 'src_svcpart' ], [ 'src_svcpart', 'link_type' ], [ 'disabled' ] ],
3672       'foreign_keys' => [
3673                           { columns    => [ 'src_svcpart' ],
3674                             table      => 'part_svc',
3675                             references => [ 'svcpart' ]
3676                           },
3677                           { columns    => [ 'dst_svcpart' ],
3678                             table      => 'part_svc',
3679                             references => [ 'svcpart' ]
3680                           },
3681                         ],
3682     },
3683
3684     #(this should be renamed to part_pop)
3685     'svc_acct_pop' => {
3686       'columns' => [
3687         'popnum',    'serial',    '',   '', '', '',
3688         'city',      'varchar',   '',   $char_d, '', '',
3689         'state',     'varchar',   '',   $char_d, '', '',
3690         'ac',        'char',   '',   3, '', '',
3691         'exch',      'char',   '',   3, '', '',
3692         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
3693       ],
3694       'primary_key' => 'popnum',
3695       'unique' => [],
3696       'index' => [ [ 'state' ] ],
3697     },
3698
3699     'part_pop_local' => {
3700       'columns' => [
3701         'localnum',  'serial',     '',     '', '', '',
3702         'popnum',    'int',     '',     '', '', '',
3703         'city',      'varchar', 'NULL', $char_d, '', '',
3704         'state',     'char',    'NULL', 2, '', '',
3705         'npa',       'char',    '',     3, '', '',
3706         'nxx',       'char',    '',     3, '', '',
3707       ],
3708       'primary_key'  => 'localnum',
3709       'unique'       => [],
3710       'index'        => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
3711       'foreign_keys' => [
3712                          { columns    => [ 'popnum' ],
3713                            table      => 'svc_acct_pop',
3714                          },
3715                        ],
3716     },
3717
3718     'qual' => {
3719       'columns' => [
3720         'qualnum',  'serial',     '',     '', '', '',
3721         'custnum',    'int',     'NULL',     '', '', '',
3722         'prospectnum',    'int',     'NULL',     '', '', '',
3723         'locationnum',    'int',     'NULL',     '', '', '',
3724         'phonenum',     'varchar', 'NULL',       24, '', '',
3725         'exportnum',      'int', 'NULL', '', '', '',
3726         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
3727         'status',      'char', '', 1, '', '',
3728       ],
3729       'primary_key'  => 'qualnum',
3730       'unique'       => [],
3731       'index'        => [ ['locationnum'], ['custnum'], ['prospectnum'],
3732                           ['phonenum'], ['vendor_qual_id'],
3733                         ],
3734       'foreign_keys' => [
3735                           { columns    => [ 'custnum' ],
3736                             table      => 'cust_main',
3737                           },
3738                           { columns    => [ 'prospectnum' ],
3739                             table      => 'prospect_main',
3740                           },
3741                           { columns    => [ 'locationnum' ],
3742                             table      => 'cust_location',
3743                           },
3744                           { columns    => [ 'exportnum' ],
3745                             table      => 'part_export',
3746                           },
3747                         ],
3748     },
3749
3750     'qual_option' => {
3751       'columns' => [
3752         'optionnum', 'serial', '', '', '', '',
3753         'qualnum',  'int',     '',     '', '', '',
3754         'optionname', 'varchar', '', $char_d, '', '',
3755         'optionvalue', 'text', 'NULL', '', '', '',
3756       ],
3757       'primary_key'  => 'optionnum',
3758       'unique'       => [],
3759       'index'        => [],
3760       'foreign_keys' => [
3761                           { columns    => [ 'qualnum' ],
3762                             table      => 'qual',
3763                           },
3764                         ],
3765     },
3766
3767     'svc_acct' => {
3768       'columns' => [
3769         'svcnum',    'int',    '',   '', '', '',
3770         'username',  'varchar',   '',   $username_len, '', '',
3771         '_password', 'varchar',   'NULL',  512, '', '',
3772         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
3773         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
3774         'popnum',    'int',    'NULL',   '', '', '',
3775         'sectornum', 'int', 'NULL',      '', '', '',
3776         'uid',       'int', 'NULL',   '', '', '',
3777         'gid',       'int', 'NULL',   '', '', '',
3778         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
3779         'dir',       'varchar',   'NULL',   $char_d, '', '',
3780         'shell',     'varchar',   'NULL',   $char_d, '', '',
3781         'quota',     'varchar',   'NULL',   $char_d, '', '',
3782         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
3783         # IP address mgmt
3784         'routernum', 'int', 'NULL',      '', '', '',
3785         'blocknum',  'int', 'NULL',      '', '', '',
3786         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
3787         'seconds_threshold',   'int', 'NULL',   '', '', '',
3788         'upbytes',   'bigint', 'NULL',   '', '', '',
3789         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
3790         'downbytes', 'bigint', 'NULL',   '', '', '',
3791         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
3792         'totalbytes','bigint', 'NULL',   '', '', '',
3793         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
3794         'domsvc',    'int',     '', '', '', '',
3795         'pbxsvc',    'int', 'NULL', '', '', '',
3796         'last_login',  @date_type, '', '',
3797         'last_logout', @date_type, '', '',
3798         #cardfortress field(s)
3799         'cf_privatekey',      'text', 'NULL',      '', '', '',
3800         #communigate pro fields (quota = MaxAccountSize)
3801         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
3802         #settings
3803         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
3804         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
3805         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
3806         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
3807         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
3808         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
3809         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
3810         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
3811         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
3812         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
3813         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
3814         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
3815         #XXX mailing lists
3816         #preferences
3817         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
3818         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
3819         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
3820         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
3821         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
3822         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
3823         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
3824         #mail
3825         #XXX RPOP settings
3826         #
3827       ],
3828       'primary_key'  => 'svcnum',
3829       #'unique'       => [ [ 'username', 'domsvc' ] ],
3830       'unique'       => [],
3831       'index'        => [ ['username'], ['domsvc'], ['pbxsvc'] ],
3832       'foreign_keys' => [
3833                           { columns    => [ 'svcnum' ],
3834                             table      => 'cust_svc',
3835                           },
3836                           { columns    => [ 'popnum' ],
3837                             table      => 'svc_acct_pop',
3838                           },
3839                           { columns    => [ 'sectornum' ],
3840                             table      => 'tower_sector',
3841                           },
3842                           { columns    => [ 'routernum' ],
3843                             table      => 'router',
3844                           },
3845                           { columns    => [ 'blocknum' ],
3846                             table      => 'addr_block',
3847                           },
3848                           { columns    => [ 'domsvc' ],
3849                             table      => 'svc_domain', #'cust_svc',
3850                             references => [ 'svcnum' ],
3851                           },
3852                           { columns    => [ 'pbxsvc' ],
3853                             table      => 'svc_pbx', #'cust_svc',
3854                             references => [ 'svcnum' ],
3855                           },
3856                         ],
3857     },
3858
3859     'acct_rt_transaction' => {
3860       'columns' => [
3861         'svcrtid',   'int',    '',   '', '', '', #why am i not a serial
3862         'svcnum',    'int',    '',   '', '', '',
3863         'transaction_id',       'int', '',   '', '', '',
3864         '_date',   @date_type, '', '',
3865         'seconds',   'int', '',   '', '', '', #uhhhh
3866         'support',   'int', '',   '', '', '',
3867       ],
3868       'primary_key'  => 'svcrtid',
3869       'unique'       => [],
3870       'index'        => [ ['svcnum', 'transaction_id'] ],
3871       'foreign_keys' => [
3872                           { columns    => [ 'svcnum' ],
3873                             table      => 'svc_acct', #'cust_svc',
3874                           },
3875                           # 1. RT tables aren't part of our data structure, so
3876                           #     we can't make sure Queue is created already
3877                           # 2. This is our internal hack for time tracking, not
3878                           #     a user-facing feature
3879                           #{ columns    => [ 'transaction_id' ],
3880                           #  table      => 'Transaction',
3881                           #  references => [ 'id' ],
3882                           #},
3883                         ],
3884     },
3885
3886     #'svc_charge' => {
3887     #  'columns' => [
3888     #    'svcnum',    'int',    '',   '',
3889     #    'amount',    @money_type,
3890     #  ],
3891     #  'primary_key' => 'svcnum',
3892     #  'unique' => [ [] ],
3893     #  'index' => [ [] ],
3894     #},
3895
3896     'svc_domain' => {
3897       'columns' => [
3898         'svcnum',           'int',    '',        '', '', '',
3899         'domain',       'varchar',    '',   $char_d, '', '',
3900         'suffix',       'varchar', 'NULL',  $char_d, '', '',
3901         'catchall',         'int', 'NULL',       '', '', '',
3902         'parent_svcnum',    'int', 'NULL',       '', '', '',
3903         'quota',        'varchar', 'NULL',  $char_d, '', '',
3904
3905         #registration info
3906         'registrarnum',     'int', 'NULL',       '', '', '',
3907         'registrarkey', 'varchar', 'NULL',      512, '', '',
3908         'setup_date',      @date_type, '', '',
3909         'renewal_interval', 'int', 'NULL',       '', '', '',
3910         'expiration_date', @date_type, '', '',
3911
3912         #some weird shit australia-specific shit?  yuck.. seems totally unused
3913         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
3914         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
3915
3916         #communigate pro fields (quota = MaxAccountSize)
3917         'max_accounts',     'int', 'NULL',       '', '', '',
3918         'trailer',         'text', 'NULL',       '', '', '',
3919         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
3920         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
3921         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
3922
3923         #(account default) settings
3924         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
3925         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
3926         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
3927         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
3928         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
3929         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
3930         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
3931         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
3932         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
3933         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
3934         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
3935         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
3936
3937         #(account default) preferences
3938         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
3939         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
3940         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
3941         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
3942         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
3943         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
3944         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
3945       ],
3946       'primary_key'  => 'svcnum',
3947       'unique'       => [],
3948       'index'        => [ ['domain'] ],
3949       'foreign_keys' => [
3950                           { columns    => [ 'svcnum' ],
3951                             table      => 'cust_svc',
3952                           },
3953                           { columns    => [ 'catchall' ],
3954                             table      => 'svc_acct',
3955                             references => [ 'svcnum' ],
3956                           },
3957                           { columns    => [ 'parent_svcnum' ],
3958                             table      => 'cust_svc',
3959                             references => [ 'svcnum' ],
3960                           },
3961                           { columns    => [ 'registrarnum' ],
3962                             table      => 'registrar',
3963                           },
3964                         ],
3965     },
3966
3967     'svc_dsl' => {
3968       'columns' => [
3969         'svcnum',                    'int',    '',        '', '', '',
3970         'pushed',                    'int', 'NULL',       '', '', '',
3971         'desired_due_date',          'int', 'NULL',       '', '', '',
3972         'due_date',                  'int', 'NULL',       '', '', '',
3973         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
3974         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
3975         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
3976         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
3977         'first',                 'varchar', 'NULL', $char_d,  '', '',
3978         'last',                  'varchar', 'NULL', $char_d,  '', '',
3979         'company',               'varchar', 'NULL', $char_d,  '', '',
3980         'phonenum',              'varchar', 'NULL',      24, '', '',
3981         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
3982         'loop_type',                'char', 'NULL',       1, '', '',
3983         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
3984         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
3985         'rate_band',             'varchar', 'NULL', $char_d, '', '',
3986         'vpi',                       'int', 'NULL',      '', '', '',
3987         'vci',                       'int', 'NULL',      '', '', '',
3988         'isp_chg',                  'char', 'NULL',       1, '', '',
3989         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
3990         'username',              'varchar', 'NULL', $char_d, '', '',
3991         'password',              'varchar', 'NULL', $char_d, '', '',
3992         'staticips',                'text', 'NULL',      '', '', '',
3993         'monitored',                'char', 'NULL',       1, '', '',
3994         'last_pull',                 'int', 'NULL',      '', '', '',
3995       ],
3996       'primary_key'  => 'svcnum',
3997       'unique'       => [ ],
3998       'index'        => [ ['phonenum'], ['vendor_order_id'] ],
3999       'foreign_keys' => [
4000                           { columns    => [ 'svcnum' ],
4001                             table      => 'cust_svc',
4002                           },
4003                         ],
4004     },
4005
4006     'dsl_device' => {
4007       'columns' => [
4008         'devicenum', 'serial',     '', '', '', '',
4009         #part_device?  or our own part_dsl_device?
4010         #'devicepart',   'int',     '', '', '', '',
4011         'svcnum',       'int',     '', '', '', '',
4012         'mac_addr', 'varchar',     '', 12, '', '',
4013       ],
4014       'primary_key'  => 'devicenum',
4015       'unique'       => [ [ 'mac_addr' ], ],
4016       'index'        => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
4017       'foreign_keys' => [
4018                           { columns    => [ 'svcnum' ],
4019                             table      => 'svc_dsl',
4020                           },
4021                         ],
4022     },
4023
4024     'dsl_note' => {
4025       'columns' => [
4026         'notenum',           'serial',    '',        '', '', '',
4027         'svcnum',     'int', '',       '', '', '',
4028         'author',     'varchar', 'NULL', $char_d,  '', '',
4029         'priority',   'char', 'NULL',       1,  '', '',
4030         '_date',     'int', 'NULL',       '', '', '',
4031         'note',     'text', '',       '', '', '',
4032       ],
4033       'primary_key'  => 'notenum',
4034       'unique'       => [],
4035       'index'        => [ ['svcnum'] ],
4036       'foreign_keys' => [
4037                           { columns    => [ 'svcnum' ],
4038                             table      => 'svc_dsl',
4039                           },
4040                         ],
4041     },
4042
4043     'svc_dish' => {
4044       'columns' => [
4045         'svcnum',   'int',     '',     '', '', '',
4046         'acctnum',  'varchar', '',     16, '', '',
4047         'installdate', @date_type,         '', '',
4048         'note',     'text',    'NULL', '', '', '',
4049       ],
4050       'primary_key'  => 'svcnum',
4051       'unique'       => [],
4052       'index'        => [],
4053       'foreign_keys' => [
4054                           { columns    => [ 'svcnum' ],
4055                             table      => 'cust_svc',
4056                           },
4057                         ],
4058     },
4059
4060     'svc_hardware' => {
4061       'columns' => [
4062         'svcnum',   'int',     '',          '', '', '',
4063         'typenum',  'int',     '',          '', '', '',
4064         'serial',   'varchar', 'NULL', $char_d, '', '',
4065         'ip_addr',  'varchar', 'NULL',      40, '', '',
4066         'hw_addr',  'varchar', 'NULL',      12, '', '',
4067         'smartcard','varchar', 'NULL',      30, '', '',
4068         'statusnum','int',     'NULL',      '', '', '',
4069         'note',     'text',    'NULL',      '', '', '',
4070       ],
4071       'primary_key'  => 'svcnum',
4072       'unique'       => [],
4073       'index'        => [],
4074       'foreign_keys' => [
4075                           { columns    => [ 'svcnum' ],
4076                             table      => 'cust_svc',
4077                           },
4078                           { columns    => [ 'typenum' ],
4079                             table      => 'hardware_type',
4080                           },
4081                           { columns    => [ 'statusnum' ],
4082                             table      => 'hardware_status',
4083                           },
4084                         ],
4085     },
4086
4087     'hardware_class' => {
4088       'columns' => [
4089         'classnum',   'serial', '',      '', '', '',
4090         'classname', 'varchar', '', $char_d, '', '',
4091       ],
4092       'primary_key' => 'classnum',
4093       'unique' => [],
4094       'index'  => [],
4095     },
4096
4097     'hardware_type' => {
4098       'columns' => [
4099         'typenum',  'serial',     '',      '', '', '',
4100         'classnum',    'int',     '',      '', '', '',
4101         'model',   'varchar',     '', $char_d, '', '',
4102         'revision','varchar', 'NULL', $char_d, '', '',
4103       ],
4104       'primary_key'  => 'typenum',
4105       'unique'       => [ [ 'classnum', 'model', 'revision' ] ],
4106       'index'        => [],
4107       'foreign_keys' => [
4108                           { columns    => [ 'classnum' ],
4109                             table      => 'hardware_class',
4110                           },
4111                         ],
4112     },
4113
4114     'hardware_status' => {
4115       'columns' => [
4116         'statusnum', 'serial', '',      '', '', '',
4117         'label'    ,'varchar', '', $char_d, '', '',
4118         'disabled',    'char', 'NULL',   1, '', '',
4119       ],
4120       'primary_key' => 'statusnum',
4121       'unique' => [],
4122       'index'  => [],
4123     },
4124
4125     'domain_record' => {
4126       'columns' => [
4127         'recnum',    'serial',     '',  '', '', '',
4128         'svcnum',    'int',     '',  '', '', '',
4129         'reczone',   'varchar', '',  255, '', '',
4130         'recaf',     'char',    '',  2, '', '',
4131         'rectype',   'varchar',    '',  5, '', '',
4132         'recdata',   'varchar', '',  255, '', '',
4133         'ttl',       'int',     'NULL', '', '', '',
4134       ],
4135       'primary_key'  => 'recnum',
4136       'unique'       => [],
4137       'index'        => [ ['svcnum'] ],
4138       'foreign_keys' => [
4139                           { columns    => [ 'svcnum' ],
4140                             table      => 'svc_domain',
4141                           },
4142                         ],
4143     },
4144
4145     'registrar' => {
4146       'columns' => [
4147         'registrarnum',   'serial', '',      '', '', '',
4148         'registrarname', 'varchar', '', $char_d, '', '',
4149       ],
4150       'primary_key' => 'registrarnum',
4151       'unique'      => [],
4152       'index'       => [],
4153     },
4154
4155     'cgp_rule' => {
4156       'columns' => [
4157         'rulenum',  'serial',     '',      '', '', '',
4158         'name',    'varchar',     '', $char_d, '', '',
4159         'comment', 'varchar', 'NULL', $char_d, '', '',
4160         'svcnum',      'int',     '',      '', '', '',
4161         'priority',    'int',     '',      '', '', '',
4162       ],
4163       'primary_key' => 'rulenum',
4164       'unique'      => [ [ 'svcnum', 'name' ] ],
4165       'index'       => [ [ 'svcnum' ] ],
4166       'foreign_keys' => [
4167                           { columns    => [ 'svcnum' ],
4168                             table      => 'cust_svc', #svc_acct / svc_domain
4169                           },
4170                         ],
4171     },
4172
4173     'cgp_rule_condition' => {
4174       'columns' => [
4175         'ruleconditionnum',  'serial',     '',      '', '', '',
4176         'conditionname',    'varchar',     '', $char_d, '', '',
4177         'op',               'varchar', 'NULL', $char_d, '', '',
4178         'params',           'varchar', 'NULL',     255, '', '',
4179         'rulenum',              'int',     '',      '', '', '',
4180       ],
4181       'primary_key'  => 'ruleconditionnum',
4182       'unique'       => [],
4183       'index'        => [ [ 'rulenum' ] ],
4184       'foreign_keys' => [
4185                           { columns    => [ 'rulenum' ],
4186                             table      => 'cgp_rule',
4187                           },
4188                         ],
4189     },
4190
4191     'cgp_rule_action' => {
4192        'columns' => [
4193         'ruleactionnum',  'serial',     '',      '', '', '',
4194         'action',        'varchar',     '', $char_d, '', '',
4195         'params',        'varchar', 'NULL',     255, '', '',
4196         'rulenum',           'int',     '',      '', '', '',
4197       ],
4198       'primary_key'  => 'ruleactionnum',
4199       'unique'       => [],
4200       'index'        => [ [ 'rulenum' ] ],
4201       'foreign_keys' => [
4202                           { columns    => [ 'rulenum' ],
4203                             table      => 'cgp_rule',
4204                           },
4205                         ],
4206    },
4207
4208     'svc_forward' => {
4209       'columns' => [
4210         'svcnum',   'int',            '',   '', '', '',
4211         'srcsvc',   'int',        'NULL',   '', '', '',
4212         'src',      'varchar',    'NULL',  255, '', '',
4213         'dstsvc',   'int',        'NULL',   '', '', '',
4214         'dst',      'varchar',    'NULL',  255, '', '',
4215       ],
4216       'primary_key'  => 'svcnum',
4217       'unique'       => [],
4218       'index'        => [ ['srcsvc'], ['dstsvc'] ],
4219       'foreign_keys' => [
4220                           { columns    => [ 'svcnum' ],
4221                             table      => 'cust_svc',
4222                           },
4223                           { columns    => [ 'srcsvc' ],
4224                             table      => 'svc_acct',
4225                             references => [ 'svcnum' ]
4226                           },
4227                           { columns    => [ 'dstsvc' ],
4228                             table      => 'svc_acct',
4229                             references => [ 'svcnum' ]
4230                           },
4231                         ],
4232     },
4233
4234     'svc_www' => {
4235       'columns' => [
4236         'svcnum',   'int',      '',  '', '', '',
4237         'recnum',   'int',      '',  '', '', '',
4238         'usersvc',  'int',  'NULL',  '', '', '',
4239         'config',   'text', 'NULL',  '', '', '',
4240       ],
4241       'primary_key' => 'svcnum',
4242       'unique'      => [],
4243       'index'       => [],
4244       'foreign_keys' => [
4245                           { columns    => [ 'svcnum' ],
4246                             table      => 'cust_svc',
4247                           },
4248                           { columns    => [ 'recnum' ],
4249                             table      => 'domain_record',
4250                           },
4251                           { columns    => [ 'usersvc' ],
4252                             table      => 'svc_acct',
4253                             references => [ 'svcnum' ]
4254                           },
4255                         ],
4256     },
4257
4258     #'svc_wo' => {
4259     #  'columns' => [
4260     #    'svcnum',    'int',    '',   '',
4261     #    'svcnum',    'int',    '',   '',
4262     #    'svcnum',    'int',    '',   '',
4263     #    'worker',    'varchar',   '',   $char_d,
4264     #    '_date',     @date_type,
4265     #  ],
4266     #  'primary_key' => 'svcnum',
4267     #  'unique' => [ [] ],
4268     #  'index' => [ [] ],
4269     #},
4270
4271     'prepay_credit' => {
4272       'columns' => [
4273         'prepaynum',   'serial',     '',   '', '', '',
4274         'identifier',  'varchar', '', $char_d, '', '',
4275         'amount',      @money_type, '', '',
4276         'seconds',     'int',     'NULL', '', '', '',
4277         'upbytes',     'bigint',     'NULL', '', '', '',
4278         'downbytes',   'bigint',     'NULL', '', '', '',
4279         'totalbytes',  'bigint',     'NULL', '', '', '',
4280         'agentnum',    'int',     'NULL', '', '', '',
4281       ],
4282       'primary_key'  => 'prepaynum',
4283       'unique'       => [ ['identifier'] ],
4284       'index'        => [ ['agentnum'] ],
4285       'foreign_keys' => [
4286                           { columns    => [ 'agentnum' ],
4287                             table      => 'agent',
4288                           },
4289                         ],
4290     },
4291
4292     'port' => {
4293       'columns' => [
4294         'portnum',  'serial',     '',   '', '', '',
4295         'ip',       'varchar', 'NULL', 15, '', '',
4296         'nasport',  'int',     'NULL', '', '', '',
4297         'nasnum',   'int',     '',   '', '', '',
4298       ],
4299       'primary_key'  => 'portnum',
4300       'unique'       => [],
4301       'index'        => [],
4302       'foreign_keys' => [
4303                           { columns    => [ 'nasnum' ],
4304                             table      => 'nas',
4305                           },
4306                         ],
4307     },
4308
4309     'nas' => {
4310       'columns' => [
4311         'nasnum',       'serial',     '',  '',              '', '',
4312         'nasname',     'varchar',     '', 128,              '', '',
4313         'shortname',   'varchar', 'NULL',  32,              '', '',
4314         'type',        'varchar',     '',  30,         'other', '',
4315         'ports',           'int', 'NULL',  '',              '', '',
4316         'secret',      'varchar',     '',  60,        'secret', '',
4317         'server',      'varchar', 'NULL',  64,              '', '',
4318         'community',   'varchar', 'NULL',  50,              '', '',
4319         'description', 'varchar',     '', 200, 'RADIUS Client', '',
4320         'svcnum',          'int', 'NULL',  '',              '', '',
4321       ],
4322       'primary_key'  => 'nasnum',
4323       'unique'       => [ [ 'nasname' ], ],
4324       'index'        => [],
4325       'foreign_keys' => [
4326                           { columns    => [ 'svcnum' ],
4327                             table      => 'svc_broadband',#no? could be _acct?
4328                                                           #remove or cust_svc?
4329                           },
4330                         ],
4331     },
4332
4333     'export_nas' => {
4334       'columns' => [
4335         'exportnasnum', 'serial', '', '', '', '',
4336         'exportnum',       'int', '', '', '', '',
4337         'nasnum',          'int', '', '', '', '',
4338       ],
4339       'primary_key'  => 'exportnasnum',
4340       'unique'       => [ [ 'exportnum', 'nasnum' ] ],
4341       'index'        => [ [ 'exportnum' ], [ 'nasnum' ] ],
4342       'foreign_keys' => [
4343                           { columns    => [ 'exportnum' ],
4344                             table      => 'part_export',
4345                           },
4346                           { columns    => [ 'nasnum' ],
4347                             table      => 'nas',
4348                           },
4349                         ],
4350     },
4351
4352     'queue' => {
4353       'columns' => [
4354         'jobnum',   'bigserial',     '',      '', '', '',
4355         'job',        'varchar',     '',     512, '', '',
4356         '_date',          'int',     '',      '', '', '',
4357         'status',     'varchar',     '', $char_d, '', '',
4358         'statustext',    'text', 'NULL',      '', '', '',
4359         'svcnum',         'int', 'NULL',      '', '', '',
4360         'custnum',        'int', 'NULL',      '', '', '',
4361         'secure',        'char', 'NULL',       1, '', '',
4362         'priority',       'int', 'NULL',      '', '', '',
4363         'usernum',        'int', 'NULL',      '', '', '',
4364       ],
4365       'primary_key'  => 'jobnum',
4366       'unique'       => [],
4367       'index'        => [ [ 'secure' ], [ 'priority' ],
4368                           [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
4369                         ],
4370       'foreign_keys' => [
4371 #                          { columns    => [ 'svcnum' ],
4372 #                            table      => 'cust_svc',
4373 #                          },
4374                           { columns    => [ 'custnum' ],
4375                             table      => 'cust_main',
4376                           },
4377                           { columns    => [ 'usernum' ],
4378                             table      => 'access_user',
4379                           },
4380                         ],
4381     },
4382
4383     'queue_arg' => {
4384       'columns' => [
4385         'argnum', 'bigserial',     '', '', '', '',
4386         'jobnum',    'bigint',     '', '', '', '',
4387         'frozen',      'char', 'NULL',  1, '', '',
4388         'arg',         'text', 'NULL', '', '', '',
4389       ],
4390       'primary_key'  => 'argnum',
4391       'unique'       => [],
4392       'index'        => [ [ 'jobnum' ] ],
4393       'foreign_keys' => [
4394                           { columns    => [ 'jobnum' ],
4395                             table      => 'queue',
4396                             on_delete  => 'CASCADE',
4397                           },
4398                         ],
4399     },
4400
4401     'queue_depend' => {
4402       'columns' => [
4403         'dependnum',  'bigserial', '', '', '', '',
4404         'jobnum',        'bigint', '', '', '', '',
4405         'depend_jobnum', 'bigint', '', '', '', '',
4406       ],
4407       'primary_key'  => 'dependnum',
4408       'unique'       => [],
4409       'index'        => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
4410       'foreign_keys' => [
4411                           { columns    => [ 'jobnum' ],
4412                             table      => 'queue',
4413                           },
4414                           { columns    => [ 'depend_jobnum' ],
4415                             table      => 'queue',
4416                             references => [ 'jobnum' ],
4417                             on_delete  => 'CASCADE',
4418                           },
4419                         ],
4420     },
4421
4422     'queue_stat' => {
4423       'columns' => [
4424         'statnum', 'bigserial',     '',  '', '', '',
4425         'jobnum',     'bigint',     '',  '', '', '',
4426         'job',       'varchar',     '', 512, '', '',
4427         'custnum',       'int', 'NULL',  '', '', '',
4428         'insert_date', @date_type, '', '',
4429         'start_date',  @date_type, '', '',
4430         'end_date',    @date_type, '', '',
4431       ],
4432       'primary_key'  => 'statnum',
4433       'unique'       => [], #[ ['jobnum'] ],
4434       'index'        => [],
4435     },
4436
4437     'export_svc' => {
4438       'columns' => [
4439         'exportsvcnum' => 'serial', '', '', '', '',
4440         'exportnum'    => 'int', '', '', '', '',
4441         'svcpart'      => 'int', '', '', '', '',
4442         'role'         => 'varchar', 'NULL', 16, '', '',
4443       ],
4444       'primary_key'  => 'exportsvcnum',
4445       'unique'       => [ [ 'exportnum', 'svcpart' ] ],
4446       'index'        => [ [ 'exportnum' ], [ 'svcpart' ] ],
4447       'foreign_keys' => [
4448                           { columns    => [ 'exportnum' ],
4449                             table      => 'part_export',
4450                           },
4451                           { columns    => [ 'svcpart' ],
4452                             table      => 'part_svc',
4453                           },
4454                         ],
4455     },
4456
4457     'export_cust_svc' => {
4458       'columns' => [
4459         'exportcustsvcnum', 'serial', '', '', '', '',
4460         'exportnum', 'int', '', '', '', '',
4461         'svcnum', 'int', '', '', '', '',
4462         'remoteid', 'varchar', '', 512, '', '',
4463       ],
4464       'primary_key'  => 'exportcustsvcnum',
4465       'unique'       => [ [ 'exportnum', 'svcnum' ] ],
4466       'index'        => [ [ 'exportnum', 'svcnum' ] ],
4467       'foreign_keys' => [
4468                           { columns    => [ 'exportnum' ],
4469                             table      => 'part_export',
4470                           },
4471                           { columns    => [ 'svcnum' ],
4472                             table      => 'cust_svc',
4473                           },
4474                         ],
4475     },
4476
4477     'export_device' => {
4478       'columns' => [
4479         'exportdevicenum' => 'serial', '', '', '', '',
4480         'exportnum'       => 'int', '', '', '', '',
4481         'devicepart'      => 'int', '', '', '', '',
4482       ],
4483       'primary_key'  => 'exportdevicenum',
4484       'unique'       => [ [ 'exportnum', 'devicepart' ] ],
4485       'index'        => [ [ 'exportnum' ], [ 'devicepart' ] ],
4486       'foreign_keys' => [
4487                           { columns    => [ 'exportnum' ],
4488                             table      => 'part_export',
4489                           },
4490                           { columns    => [ 'devicepart' ],
4491                             table      => 'part_device',
4492                           },
4493                         ],
4494     },
4495
4496     'part_export' => {
4497       'columns' => [
4498         'exportnum',   'serial',     '',      '', '', '',
4499         'exportname', 'varchar', 'NULL', $char_d, '', '',
4500         'machine',    'varchar', 'NULL', $char_d, '', '',
4501         'exporttype', 'varchar',     '', $char_d, '', '',
4502         'nodomain',      'char', 'NULL',       1, '', '',
4503         'default_machine','int', 'NULL',      '', '', '',
4504         'no_suspend',    'char', 'NULL',       1, '', '',
4505         # could also have 'no_insert', 'no_replace', etc.
4506       ],
4507       'primary_key'  => 'exportnum',
4508       'unique'       => [],
4509       'index'        => [ [ 'machine' ], [ 'exporttype' ] ],
4510       'foreign_keys' => [
4511                           { columns    => [ 'default_machine' ],
4512                             table      => 'part_export_machine',
4513                             references => [ 'machinenum' ]
4514                           },
4515                         ],
4516     },
4517
4518     'part_export_option' => {
4519       'columns' => [
4520         'optionnum', 'serial', '', '', '', '',
4521         'exportnum', 'int', '', '', '', '',
4522         'optionname', 'varchar', '', $char_d, '', '',
4523         'optionvalue', 'text', 'NULL', '', '', '',
4524       ],
4525       'primary_key'  => 'optionnum',
4526       'unique'       => [],
4527       'index'        => [ [ 'exportnum' ], [ 'optionname' ] ],
4528       'foreign_keys' => [
4529                           { columns    => [ 'exportnum' ],
4530                             table      => 'part_export',
4531                           },
4532                         ],
4533     },
4534
4535     'radius_usergroup' => {
4536       'columns' => [
4537         'usergroupnum', 'serial', '', '', '', '',
4538         'svcnum',       'int', '', '', '', '',
4539         'groupname',    'varchar', 'NULL', $char_d, '', '', #deprecated
4540         'groupnum',     'int', 'NULL', '', '', '',
4541       ],
4542       'primary_key'  => 'usergroupnum',
4543       'unique'       => [],
4544       'index'        => [ [ 'svcnum' ], [ 'groupname' ] ],
4545       'foreign_keys' => [
4546                           { columns    => [ 'svcnum' ],
4547                             table      => 'cust_svc', #svc_acct / svc_broadband
4548                           },
4549                           { columns    => [ 'groupnum' ],
4550                             table      => 'radius_group',
4551                           },
4552                         ],
4553     },
4554
4555     'radius_group' => {
4556       'columns' => [
4557         'groupnum', 'serial', '', '', '', '',
4558         'groupname',    'varchar', '', $char_d, '', '',
4559         'description',  'varchar', 'NULL', $char_d, '', '',
4560         'priority', 'int', '', '', '1', '',
4561         'speed_up', 'int', 'NULL', '', '', '',
4562         'speed_down', 'int', 'NULL', '', '', '',
4563       ],
4564       'primary_key' => 'groupnum',
4565       'unique'      => [ ['groupname'] ],
4566       'index'       => [],
4567     },
4568
4569     'radius_attr' => {
4570       'columns' => [
4571         'attrnum',   'serial', '',      '', '', '',
4572         'groupnum',     'int', '',      '', '', '',
4573         'attrname', 'varchar', '', $char_d, '', '',
4574         'value',    'varchar', '',     255, '', '',
4575         'attrtype',    'char', '',       1, '', '',
4576         'op',          'char', '',       2, '', '',
4577       ],
4578       'primary_key'  => 'attrnum',
4579       'unique'       => [],
4580       'index'        => [ ['groupnum'], ],
4581       'foreign_keys' => [
4582                           { columns    => [ 'groupnum' ],
4583                             table      => 'radius_group',
4584                           },
4585                         ],
4586     },
4587
4588     'msgcat' => {
4589       'columns' => [
4590         'msgnum', 'serial', '', '', '', '',
4591         'msgcode', 'varchar', '', 255, '', '',
4592         'locale', 'varchar', '', 16, '', '',
4593         'msg', 'text', '', '', '', '',
4594       ],
4595       'primary_key' => 'msgnum',
4596       'unique'      => [ [ 'msgcode', 'locale' ] ],
4597       'index'       => [],
4598     },
4599
4600     'cust_tax_exempt' => {
4601       'columns' => [
4602         'exemptnum', 'serial', '', '', '', '',
4603         'custnum',   'int', '', '', '', '',
4604         'taxnum',    'int', '', '', '', '',
4605         'year',      'int', '', '', '', '',
4606         'month',     'int', '', '', '', '',
4607         'amount',   @money_type, '', '',
4608       ],
4609       'primary_key'  => 'exemptnum',
4610       'unique'       => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
4611       'index'        => [],
4612       'foreign_keys' => [
4613                           { columns    => [ 'custnum' ],
4614                             table      => 'cust_main',
4615                           },
4616                           { columns    => [ 'taxnum' ],
4617                             table      => 'cust_main_county',
4618                           },
4619                         ],
4620     },
4621
4622     'cust_tax_exempt_pkg' => {
4623       'columns' => [
4624         'exemptpkgnum',  'serial', '', '', '', '',
4625         #'custnum',      'int', '', '', '', ''
4626         'billpkgnum',   'int', '', '', '', '',
4627         'taxnum',       'int', '', '', '', '',
4628         'taxtype',  'varchar', 'NULL', $char_d, '', '',
4629         'year',         'int', 'NULL', '', '', '',
4630         'month',        'int', 'NULL', '', '', '',
4631         'creditbillpkgnum', 'int', 'NULL', '', '', '',
4632         'amount',       @money_type, '', '',
4633         # exemption type flags
4634         'exempt_cust',          'char', 'NULL', 1, '', '',
4635         'exempt_setup',         'char', 'NULL', 1, '', '',
4636         'exempt_recur',         'char', 'NULL', 1, '', '',
4637         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
4638         'exempt_monthly',       'char', 'NULL', 1, '', '',
4639       ],
4640       'primary_key'  => 'exemptpkgnum',
4641       'unique'       => [],
4642       'index'        => [ [ 'taxnum', 'year', 'month' ],
4643                           [ 'billpkgnum' ],
4644                           [ 'taxnum', 'taxtype' ],
4645                           [ 'creditbillpkgnum' ],
4646                         ],
4647       'foreign_keys' => [
4648                           { columns    => [ 'billpkgnum' ],
4649                             table      => 'cust_bill_pkg',
4650                           },
4651                           { columns    => [ 'creditbillpkgnum' ],
4652                             table      => 'cust_credit_bill_pkg',
4653                           },
4654                         ],
4655     },
4656
4657     'cust_tax_exempt_pkg_void' => {
4658       'columns' => [
4659         'exemptpkgnum',  'int', '', '', '', '',
4660         #'custnum',      'int', '', '', '', ''
4661         'billpkgnum',   'int', '', '', '', '',
4662         'taxnum',       'int', '', '', '', '',
4663         'taxtype',  'varchar', 'NULL', $char_d, '', '',
4664         'year',         'int', 'NULL', '', '', '',
4665         'month',        'int', 'NULL', '', '', '',
4666         'creditbillpkgnum', 'int', 'NULL', '', '', '',
4667         'amount',       @money_type, '', '',
4668         # exemption type flags
4669         'exempt_cust',          'char', 'NULL', 1, '', '',
4670         'exempt_setup',         'char', 'NULL', 1, '', '',
4671         'exempt_recur',         'char', 'NULL', 1, '', '',
4672         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
4673         'exempt_monthly',       'char', 'NULL', 1, '', '',
4674       ],
4675       'primary_key'  => 'exemptpkgnum',
4676       'unique'       => [],
4677       'index'        => [ [ 'taxnum', 'year', 'month' ],
4678                           [ 'billpkgnum' ],
4679                           [ 'taxnum', 'taxtype' ],
4680                           [ 'creditbillpkgnum' ],
4681                         ],
4682       'foreign_keys' => [
4683                           { columns    => [ 'billpkgnum' ],
4684                             table      => 'cust_bill_pkg_void',
4685                           },
4686                           { columns    => [ 'taxnum' ],
4687                             table      => 'cust_main_county',
4688                           },
4689                           { columns    => [ 'creditbillpkgnum' ],
4690                             table      => 'cust_credit_bill_pkg',
4691                           },
4692                         ],
4693     },
4694
4695     'router' => {
4696       'columns' => [
4697         'routernum', 'serial', '', '', '', '',
4698         'routername', 'varchar', '', $char_d, '', '',
4699         'svcnum', 'int', 'NULL', '', '', '',
4700         'agentnum',   'int', 'NULL', '', '', '',
4701         'manual_addr', 'char', 'NULL', 1, '', '',
4702       ],
4703       'primary_key'  => 'routernum',
4704       'unique'       => [],
4705       'index'        => [],
4706       'foreign_keys' => [
4707                           { columns    => [ 'svcnum' ],
4708                             table      => 'cust_svc', #svc_acct / svc_broadband
4709                           },
4710                           { columns    => [ 'agentnum' ],
4711                             table      => 'agent',
4712                           },
4713                         ],
4714     },
4715
4716     'part_svc_router' => {
4717       'columns' => [
4718         'svcrouternum', 'serial', '', '', '', '',
4719         'svcpart', 'int', '', '', '', '',
4720         'routernum', 'int', '', '', '', '',
4721       ],
4722       'primary_key'  => 'svcrouternum',
4723       'unique'       => [],
4724       'index'        => [],
4725       'foreign_keys' => [
4726                           { columns    => [ 'svcpart' ],
4727                             table      => 'part_svc',
4728                           },
4729                           { columns    => [ 'routernum' ],
4730                             table      => 'router',
4731                           },
4732                         ],
4733     },
4734
4735     'addr_block' => {
4736       'columns' => [
4737         'blocknum', 'serial', '', '', '', '',
4738         'routernum', 'int', '', '', '', '',
4739         'ip_gateway', 'varchar', '', 15, '', '',
4740         'ip_netmask', 'int', '', '', '', '',
4741         'agentnum',   'int', 'NULL', '', '', '',
4742         'manual_flag', 'char', 'NULL', 1, '', '',
4743       ],
4744       'primary_key'  => 'blocknum',
4745       'unique'       => [ [ 'blocknum', 'routernum' ] ],
4746       'index'        => [],
4747       'foreign_keys' => [
4748                           #{ columns    => [ 'routernum' ],
4749                           #   table      => 'router',
4750                           #},
4751                           { columns    => [ 'agentnum' ],
4752                             table      => 'agent',
4753                           },
4754                         ],
4755     },
4756
4757     'addr_range' => {
4758       'columns' => [
4759         'rangenum', 'serial', '', '', '', '',
4760         'start',    'varchar', '', 15, '', '',
4761         'length',   'int', '', '', '', '',
4762         'status',   'varchar', 'NULL', 32, '', '',
4763       ],
4764       'primary_key' => 'rangenum',
4765       'unique'      => [],
4766       'index'       => [],
4767     },
4768
4769     'svc_broadband' => {
4770       'columns' => [
4771         'svcnum',                  'int',     '',        '', '', '',
4772         'description',         'varchar', 'NULL',   $char_d, '', '',
4773         'routernum',               'int', 'NULL',        '', '', '',
4774         'blocknum',                'int', 'NULL',        '', '', '',
4775         'sectornum',               'int', 'NULL',        '', '', '',
4776         'speed_up',                'int', 'NULL',        '', '', '',
4777         'speed_down',              'int', 'NULL',        '', '', '',
4778         'ip_addr',             'varchar', 'NULL',        15, '', '',
4779         'mac_addr',            'varchar', 'NULL',        12, '', '',
4780         'authkey',             'varchar', 'NULL',        32, '', '',
4781         'latitude',            'decimal', 'NULL',    '10,7', '', '',
4782         'longitude',           'decimal', 'NULL',    '10,7', '', '',
4783         'altitude',            'decimal', 'NULL',        '', '', '',
4784         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
4785         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
4786         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
4787         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
4788         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
4789         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
4790         'rssi',                    'int', 'NULL',        '', '', '',
4791         'suid',                    'int', 'NULL',        '', '', '',
4792         'shared_svcnum',           'int', 'NULL',        '', '', '',
4793         'serviceid',           'varchar', 'NULL',        64, '', '',#srvexport/reportfields
4794       ],
4795       'primary_key'  => 'svcnum',
4796       'unique'       => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
4797       'index'        => [],
4798       'foreign_keys' => [
4799                           { columns    => [ 'svcnum' ],
4800                             table      => 'cust_svc',
4801                           },
4802                           { columns    => [ 'routernum' ],
4803                             table      => 'router',
4804                           },
4805                           { columns    => [ 'blocknum' ],
4806                             table      => 'addr_block',
4807                           },
4808                           { columns    => [ 'sectornum' ],
4809                             table      => 'tower_sector',
4810                           },
4811                           { columns    => [ 'shared_svcnum' ],
4812                             table      => 'svc_broadband',
4813                             references => [ 'svcnum' ],
4814                           },
4815                         ],
4816     },
4817
4818     'tower' => {
4819       'columns' => [
4820         'towernum',    'serial',     '',      '', '', '',
4821         #'agentnum',       'int', 'NULL',      '', '', '',
4822         'towername',  'varchar',     '', $char_d, '', '',
4823         'disabled',      'char', 'NULL',       1, '', '',
4824         'latitude',   'decimal', 'NULL',  '10,7', '', '',
4825         'longitude',  'decimal', 'NULL',  '10,7', '', '',
4826         'coord_auto',    'char', 'NULL',       1, '', '',
4827         'altitude',   'decimal', 'NULL',      '', '', '',
4828         'height',     'decimal', 'NULL',      '', '', '',
4829         'veg_height', 'decimal', 'NULL',      '', '', '',
4830         'color',      'varchar', 'NULL',       6, '', '',
4831       ],
4832       'primary_key' => 'towernum',
4833       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
4834       'index'       => [],
4835     },
4836
4837     'tower_sector' => {
4838       'columns' => [
4839         'sectornum',     'serial',     '',      '', '', '',
4840         'towernum',         'int',     '',      '', '', '',
4841         'sectorname',   'varchar',     '', $char_d, '', '',
4842         'ip_addr',      'varchar', 'NULL',      15, '', '',
4843         'height',       'decimal', 'NULL',      '', '', '',
4844         'freq_mhz',         'int', 'NULL',      '', '', '',
4845         'direction',        'int', 'NULL',      '', '', '',
4846         'width',            'int', 'NULL',      '', '', '',
4847         #downtilt etc? rfpath has profile files for devices/antennas you upload?
4848         'sector_range', 'decimal', 'NULL',      '', '', '',  #?
4849       ],
4850       'primary_key'  => 'sectornum',
4851       'unique'       => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
4852       'index'        => [ [ 'towernum' ] ],
4853       'foreign_keys' => [
4854                           { columns    => [ 'towernum' ],
4855                             table      => 'tower',
4856                           },
4857                         ],
4858     },
4859
4860     'part_virtual_field' => {
4861       'columns' => [
4862         'vfieldpart', 'serial', '', '', '', '',
4863         'dbtable', 'varchar', '', 32, '', '',
4864         'name', 'varchar', '', 32, '', '',
4865         'length', 'int', 'NULL', '', '', '',
4866         'label', 'varchar', 'NULL', 80, '', '',
4867       ],
4868       'primary_key' => 'vfieldpart',
4869       'unique' => [],
4870       'index' => [],
4871     },
4872
4873     'virtual_field' => {
4874       'columns' => [
4875         'vfieldnum', 'serial', '', '', '', '',
4876         'recnum', 'int', '', '', '', '',
4877         'vfieldpart', 'int', '', '', '', '',
4878         'value', 'varchar', '', 128, '', '',
4879       ],
4880       'primary_key'  => 'vfieldnum',
4881       'unique'       => [ [ 'vfieldpart', 'recnum' ] ],
4882       'index'        => [],
4883       'foreign_keys' => [
4884                           { columns    => [ 'vfieldpart' ],
4885                             table      => 'part_virtual_field',
4886                           },
4887                         ],
4888     },
4889
4890     'acct_snarf' => {
4891       'columns' => [
4892         'snarfnum',    'serial',     '',      '', '', '',
4893         'snarfname',  'varchar', 'NULL', $char_d, '', '',
4894         'svcnum',         'int',     '',      '', '', '',
4895         'machine',    'varchar',     '',     255, '', '',
4896         'protocol',   'varchar',     '', $char_d, '', '',
4897         'username',   'varchar',     '', $char_d, '', '',
4898         '_password',  'varchar',     '', $char_d, '', '',
4899         'check_freq',     'int', 'NULL',      '', '', '',
4900         'leavemail',     'char', 'NULL',       1, '', '',
4901         'apop',          'char', 'NULL',       1, '', '',
4902         'tls',           'char', 'NULL',       1, '', '',
4903         'mailbox',    'varchar', 'NULL', $char_d, '', '',
4904       ],
4905       'primary_key'  => 'snarfnum',
4906       'unique'       => [],
4907       'index'        => [ [ 'svcnum' ] ],
4908       'foreign_keys' => [
4909                           { columns    => [ 'svcnum' ],
4910                             table      => 'svc_acct',
4911                           },
4912                         ],
4913     },
4914
4915     'svc_external' => {
4916       'columns' => [
4917         'svcnum',     'int',     '',      '', '', '',
4918         'id',      'bigint', 'NULL',      '', '', '',
4919         'title',  'varchar', 'NULL', $char_d, '', '',
4920       ],
4921       'primary_key'  => 'svcnum',
4922       'unique'       => [],
4923       'index'        => [],
4924       'foreign_keys' => [
4925                           { columns    => [ 'svcnum' ],
4926                             table      => 'cust_svc',
4927                           },
4928                         ],
4929     },
4930
4931     'cust_pay_refund' => {
4932       'columns' => [
4933         'payrefundnum', 'serial', '', '', '', '',
4934         'paynum',  'int', '', '', '', '',
4935         'refundnum',  'int', '', '', '', '',
4936         '_date',    @date_type, '', '',
4937         'amount',   @money_type, '', '',
4938       ],
4939       'primary_key'  => 'payrefundnum',
4940       'unique'       => [],
4941       'index'        => [ ['paynum'], ['refundnum'] ],
4942       'foreign_keys' => [
4943                           { columns    => [ 'paynum' ],
4944                             table      => 'cust_pay',
4945                           },
4946                           { columns    => [ 'refundnum' ],
4947                             table      => 'cust_refund',
4948                           },
4949                         ],
4950     },
4951
4952     'part_pkg_option' => {
4953       'columns' => [
4954         'optionnum', 'serial', '', '', '', '',
4955         'pkgpart', 'int', '', '', '', '',
4956         'optionname', 'varchar', '', $char_d, '', '',
4957         'optionvalue', 'text', 'NULL', '', '', '',
4958       ],
4959       'primary_key'  => 'optionnum',
4960       'unique'       => [],
4961       'index'        => [ [ 'pkgpart' ], [ 'optionname' ] ],
4962       'foreign_keys' => [
4963                           { columns    => [ 'pkgpart' ],
4964                             table      => 'part_pkg',
4965                           },
4966                         ],
4967     },
4968
4969     'part_pkg_vendor' => {
4970       'columns' => [
4971         'num', 'serial', '', '', '', '',
4972         'pkgpart', 'int', '', '', '', '',
4973         'exportnum', 'int', '', '', '', '',
4974         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
4975       ],
4976       'primary_key'  => 'num',
4977       'unique'       => [ [ 'pkgpart', 'exportnum' ] ],
4978       'index'        => [ [ 'pkgpart' ] ],
4979       'foreign_keys' => [
4980                           { columns    => [ 'pkgpart' ],
4981                             table      => 'part_pkg',
4982                           },
4983                           { columns    => [ 'exportnum' ],
4984                             table      => 'part_export',
4985                           },
4986                         ],
4987     },
4988
4989     'part_pkg_report_option' => {
4990       'columns' => [
4991         'num',      'serial',   '',      '', '', '',
4992         'name',     'varchar',  '', $char_d, '', '',
4993         'disabled', 'char', 'NULL',       1, '', '',
4994       ],
4995       'primary_key' => 'num',
4996       'unique' => [ [ 'name' ] ],
4997       'index' => [ [ 'disabled' ] ],
4998     },
4999
5000     'part_pkg_usage' => {
5001       'columns' => [
5002         'pkgusagepart', 'serial',   '', '', '', '',
5003         'pkgpart',  'int',      '', '', '', '',
5004         'minutes',  'double precision',      '', '', '', '',
5005         'priority', 'int',  'NULL', '', '', '',
5006         'shared',   'char', 'NULL',  1, '', '',
5007         'rollover', 'char', 'NULL',  1, '', '',
5008         'description',  'varchar', 'NULL', $char_d, '', '',
5009       ],
5010       'primary_key'  => 'pkgusagepart',
5011       'unique'       => [],
5012       'index'        => [ [ 'pkgpart' ] ],
5013       'foreign_keys' => [
5014                           { columns    => [ 'pkgpart' ],
5015                             table      => 'part_pkg',
5016                           },
5017                         ],
5018     },
5019
5020     'part_pkg_usage_class' => {
5021       'columns' => [
5022         'num',       'serial',  '', '', '', '',
5023         'pkgusagepart', 'int',  '', '', '', '',
5024         'classnum',     'int','NULL', '', '', '',
5025       ],
5026       'primary_key'  => 'num',
5027       'unique'       => [ [ 'pkgusagepart', 'classnum' ] ],
5028       'index'        => [],
5029       'foreign_keys' => [
5030                           { columns    => [ 'pkgusagepart' ],
5031                             table      => 'part_pkg_usage',
5032                           },
5033                           { columns    => [ 'classnum' ],
5034                             table      => 'usage_class',
5035                           },
5036                         ],
5037     },
5038
5039     'part_pkg_fcc_option' => {
5040       'columns' => [
5041         'num',        'serial', '', '', '', '',
5042         'fccoptionname', 'varchar', '', $char_d, '', '',
5043         'pkgpart',       'int', '', '', '', '',
5044         'optionvalue',   'varchar', 'NULL', $char_d, '', '',
5045       ],
5046       'primary_key' => 'num',
5047       'unique'      => [ [ 'fccoptionname', 'pkgpart' ] ],
5048       'index'       => [],
5049     },
5050
5051     'rate' => {
5052       'columns' => [
5053         'ratenum',          'serial',     '', '', '', '',
5054         'ratename',        'varchar', '',$char_d, '', '',
5055         'agentnum',            'int', 'NULL', '', '', '',
5056         'default_detailnum',   'int', 'NULL', '', '', '',
5057       ],
5058       'primary_key' => 'ratenum',
5059       'unique'      => [],
5060       'index'       => [],
5061       'foreign_keys' => [
5062                           { columns    => [ 'agentnum' ],
5063                             table      => 'agent',
5064                           },
5065                         ],
5066     },
5067
5068     'rate_detail' => {
5069       'columns' => [
5070         'ratedetailnum',   'serial',  '',     '',      '', '',
5071         'ratenum',         'int',     '',     '',      '', '',
5072         'orig_regionnum',  'int', 'NULL',     '',      '', '',
5073         'dest_regionnum',  'int', 'NULL',     '',      '', '',
5074         'min_included',    'int',     '',     '',      '', '',
5075         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
5076         'conn_cost',       'decimal', '', '10,4', '0.0000', '',
5077         'conn_sec',        'int',     '',     '',      '0', '',
5078         'min_charge',      'decimal', '', '10,5',       '', '',
5079         'min_cost',        'decimal', '', '10,5','0.00000', '',
5080         'sec_granularity', 'int',     '',     '',       '', '',
5081         'ratetimenum',     'int', 'NULL',     '',       '', '',
5082         'classnum',        'int', 'NULL',     '',       '', '',
5083         'cdrtypenum',      'int', 'NULL',     '',       '', '',
5084         'region_group',   'char', 'NULL',      1,       '', '',
5085         'upstream_mult_charge',  'decimal',  '', '10,4', '0.0000', '',
5086         'upstream_mult_cost',    'decimal',  '', '10,4', '0.0000', '',
5087       ],
5088       'primary_key'  => 'ratedetailnum',
5089       'unique'       => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
5090       'index'        => [ [ 'ratenum', 'dest_regionnum' ],
5091                           [ 'ratenum', 'ratetimenum' ]
5092                         ],
5093       'foreign_keys' => [
5094                           { columns    => [ 'ratenum' ],
5095                             table      => 'rate',
5096                           },
5097                           { columns    => [ 'orig_regionnum' ],
5098                             table      => 'rate_region',
5099                             references => [ 'regionnum' ],
5100                           },
5101                           { columns    => [ 'dest_regionnum' ],
5102                             table      => 'rate_region',
5103                             references => [ 'regionnum' ],
5104                           },
5105                           { columns    => [ 'ratetimenum' ],
5106                             table      => 'rate_time',
5107                           },
5108                           { columns    => [ 'classnum' ],
5109                             table      => 'usage_class',
5110                           },
5111                           { columns    => [ 'cdrtypenum' ],
5112                             table      => 'cdr_type',
5113                           },
5114                         ],
5115     },
5116
5117     'rate_region' => {
5118       'columns' => [
5119         'regionnum',   'serial',      '', '', '', '',
5120         'regionname',  'varchar',     '', $char_d, '', '',
5121         'exact_match', 'char',    'NULL',  1, '', '',
5122       ],
5123       'primary_key' => 'regionnum',
5124       'unique'      => [],
5125       'index'       => [],
5126     },
5127
5128     'rate_prefix' => {
5129       'columns' => [
5130         'prefixnum',   'serial',      '', '', '', '',
5131         'regionnum',   'int',         '', '', '', '',
5132         'countrycode', 'varchar',     '',  3, '', '',
5133         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
5134         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
5135         'latanum',     'int',     'NULL',      '', '', '',
5136         'state',       'char',    'NULL',       2, '', '',
5137         'ocn',         'char',    'NULL',       4, '', '',
5138       ],
5139       'primary_key'  => 'prefixnum',
5140       'unique'       => [],
5141       'index'        => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
5142       'foreign_keys' => [
5143                           { columns    => [ 'regionnum' ],
5144                             table      => 'rate_region',
5145                           },
5146                           { columns    => [ 'latanum' ],
5147                             table      => 'lata',
5148                           },
5149                         ],
5150     },
5151
5152     'rate_time' => {
5153       'columns' => [
5154         'ratetimenum', 'serial',      '',      '', '', '',
5155         'ratetimename',   'varchar',      '', $char_d, '', '',
5156       ],
5157       'primary_key' => 'ratetimenum',
5158       'unique'      => [],
5159       'index'       => [],
5160     },
5161
5162     'rate_time_interval' => {
5163       'columns' => [
5164         'intervalnum', 'serial', '', '', '', '',
5165         'stime',          'int', '', '', '', '',
5166         'etime',          'int', '', '', '', '',
5167         'ratetimenum',    'int', '', '', '', '',
5168       ],
5169       'primary_key'  => 'intervalnum',
5170       'unique'       => [],
5171       'index'        => [],
5172       'foreign_keys' => [
5173                           { columns    => [ 'ratetimenum' ],
5174                             table      => 'rate_time',
5175                           },
5176                         ],
5177      },
5178
5179     #not really part of the above rate_ stuff (used with flat rate rather than
5180     # rated billing), but could be eventually, and its a rate
5181     'rate_tier' => {
5182       'columns' => [
5183         'tiernum',   'serial', '',      '', '', '',
5184         'tiername', 'varchar', '', $char_d, '', '',
5185       ],
5186       'primary_key' => 'tiernum',
5187       'unique'      => [ [ 'tiername'], ],
5188       'index'       => [],
5189     },
5190
5191     'rate_tier_detail' => {
5192       'columns' => [
5193         'tierdetailnum', 'serial', '',     '', '', '',
5194         'tiernum',          'int', '',     '', '', '',
5195         'min_quan',         'int', '',     '', '', '',
5196         'min_charge',   'decimal', '', '10,4', '', '',
5197       ],
5198       'primary_key'  => 'tierdetailnum',
5199       'unique'       => [],
5200       'index'        => [ ['tiernum'], ],
5201       'foreign_keys' => [
5202                           { columns    => [ 'tiernum' ],
5203                             table      => 'rate_tier',
5204                           },
5205                         ],
5206     },
5207
5208     'usage_class' => {
5209       'columns' => [
5210         'classnum',    'serial',      '',      '', '', '',
5211         'weight',      'int',     'NULL',      '', '', '',
5212         'classname',   'varchar',     '', $char_d, '', '',
5213         'format',      'varchar', 'NULL', $char_d, '', '',
5214         'disabled',    'char',    'NULL',       1, '', '',
5215       ],
5216       'primary_key' => 'classnum',
5217       'unique' => [],
5218       'index' => [ ['disabled'] ],
5219     },
5220
5221     'reg_code' => {
5222       'columns' => [
5223         'codenum',   'serial',    '', '', '', '',
5224         'code',      'varchar',   '', $char_d, '', '',
5225         'agentnum',  'int',       '', '', '', '',
5226       ],
5227       'primary_key'  => 'codenum',
5228       'unique'       => [ [ 'agentnum', 'code' ] ],
5229       'index'        => [ [ 'agentnum' ] ],
5230       'foreign_keys' => [
5231                           { columns    => [ 'agentnum' ],
5232                             table      => 'agent',
5233                           },
5234                         ],
5235      },
5236
5237     'reg_code_pkg' => {
5238       'columns' => [
5239         'codepkgnum', 'serial', '', '', '', '',
5240         'codenum',   'int',    '', '', '', '',
5241         'pkgpart',   'int',    '', '', '', '',
5242       ],
5243       'primary_key'  => 'codepkgnum',
5244       'unique'       => [ [ 'codenum', 'pkgpart' ] ],
5245       'index'        => [ [ 'codenum' ] ],
5246       'foreign_keys' => [
5247                           { columns    => [ 'codenum' ],
5248                             table      => 'reg_code',
5249                           },
5250                           { columns    => [ 'pkgpart' ],
5251                             table      => 'part_pkg',
5252                           },
5253                         ],
5254     },
5255
5256     'clientapi_session' => {
5257       'columns' => [
5258         'sessionnum',  'serial',  '', '', '', '',
5259         'sessionid',  'varchar',  '', $char_d, '', '',
5260         'namespace',  'varchar',  '', $char_d, '', '',
5261       ],
5262       'primary_key' => 'sessionnum',
5263       'unique'      => [ [ 'sessionid', 'namespace' ] ],
5264       'index'       => [],
5265     },
5266
5267     'clientapi_session_field' => {
5268       'columns' => [
5269         'fieldnum',    'serial',     '', '', '', '',
5270         'sessionnum',     'int',     '', '', '', '',
5271         'fieldname',  'varchar',     '', $char_d, '', '',
5272         'fieldvalue',    'text', 'NULL', '', '', '',
5273       ],
5274       'primary_key'  => 'fieldnum',
5275       'unique'       => [ [ 'sessionnum', 'fieldname' ] ],
5276       'index'        => [],
5277       'foreign_keys' => [
5278                           { columns    => [ 'sessionnum' ],
5279                             table      => 'clientapi_session',
5280                           },
5281                         ],
5282     },
5283
5284     'payment_gateway' => {
5285       'columns' => [
5286         'gatewaynum',       'serial',   '',     '', '', '',
5287         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
5288         'gateway_module',   'varchar',  '',     $char_d, '', '',
5289         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
5290         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
5291         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
5292         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
5293         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
5294         'disabled',   'char',  'NULL',   1, '', '',
5295       ],
5296       'primary_key' => 'gatewaynum',
5297       'unique' => [],
5298       'index'  => [ [ 'disabled' ] ],
5299     },
5300
5301     'payment_gateway_option' => {
5302       'columns' => [
5303         'optionnum',   'serial',  '',     '', '', '',
5304         'gatewaynum',  'int',     '',     '', '', '',
5305         'optionname',  'varchar', '',     $char_d, '', '',
5306         'optionvalue', 'text',    'NULL', '', '', '',
5307       ],
5308       'primary_key'  => 'optionnum',
5309       'unique'       => [],
5310       'index'        => [ [ 'gatewaynum' ], [ 'optionname' ] ],
5311       'foreign_keys' => [
5312                           { columns    => [ 'gatewaynum' ],
5313                             table      => 'payment_gateway',
5314                           },
5315                         ],
5316     },
5317
5318     'agent_payment_gateway' => {
5319       'columns' => [
5320         'agentgatewaynum', 'serial', '', '', '', '',
5321         'agentnum',        'int', '', '', '', '',
5322         'gatewaynum',      'int', '', '', '', '',
5323         'cardtype',        'varchar', 'NULL', $char_d, '', '',
5324         'taxclass',        'varchar', 'NULL', $char_d, '', '',
5325       ],
5326       'primary_key'  => 'agentgatewaynum',
5327       'unique'       => [],
5328       'index'        => [ [ 'agentnum', 'cardtype' ], ],
5329
5330       'foreign_keys' => [
5331
5332                           { columns    => [ 'agentnum' ],
5333                             table      => 'agent',
5334                           },
5335                           { columns    => [ 'gatewaynum' ],
5336                             table      => 'payment_gateway',
5337                           },
5338                         ],
5339     },
5340
5341     'banned_pay' => {
5342       'columns' => [
5343         'bannum',        'serial',     '',      '', '', '',
5344         'payby',           'char',     '',       4, '', '',
5345         'payinfo',      'varchar',     '',     128, '', '', #say, a 512-big digest _hex encoded
5346         'payinfo_hash', 'varchar', 'NULL',      32, '', '',
5347         #'paymask',      'varchar',  'NULL', $char_d, '', ''
5348         '_date',                @date_type,         '', '',
5349         'end_date',             @date_type,         '', '',
5350         'otaker',       'varchar', 'NULL',      32, '', '',
5351         'usernum',          'int', 'NULL',      '', '', '',
5352         'bantype',      'varchar', 'NULL', $char_d, '', '',
5353         'reason',       'varchar', 'NULL', $char_d, '', '',
5354       ],
5355       'primary_key'  => 'bannum',
5356       'unique'       => [],
5357       'index'        => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
5358       'foreign_keys' => [
5359                           { columns    => [ 'usernum' ],
5360                             table      => 'access_user',
5361                           },
5362                         ],
5363     },
5364
5365     'pkg_category' => {
5366       'columns' => [
5367         'categorynum',        'serial',     '',      '', '', '',
5368         'categoryname',      'varchar',     '', $char_d, '', '',
5369         'weight',                'int', 'NULL',      '', '', '',
5370         'ticketing_queueid',     'int', 'NULL',      '', '', '',
5371         'condense',             'char', 'NULL',       1, '', '',
5372         'disabled',             'char', 'NULL',       1, '', '',
5373       ],
5374       'primary_key' => 'categorynum',
5375       'unique' => [],
5376       'index' => [ ['disabled'] ],
5377     },
5378
5379     'pkg_class' => {
5380       'columns' => [
5381         'classnum',    'serial',   '',      '', '', '',
5382         'classname',   'varchar',  '', $char_d, '', '',
5383         'categorynum', 'int',  'NULL',      '', '', '',
5384         'disabled',    'char', 'NULL',       1, '', '',
5385         'fcc_ds0s',      'int',     'NULL', '', '', '',
5386       ],
5387       'primary_key'  => 'classnum',
5388       'unique'       => [],
5389       'index'        => [ ['disabled'] ],
5390       'foreign_keys' => [
5391                           { columns    => [ 'categorynum' ],
5392                             table      => 'pkg_category',
5393                           },
5394                         ],
5395     },
5396
5397     'cdr' => {
5398       'columns' => [
5399         # qw( name type null length default local );
5400
5401         ###
5402         #asterisk fields
5403         ###
5404
5405         'acctid',   'bigserial',  '', '', '', '',
5406         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
5407         'calldate', 'timestamp',   '',      '', \'now()', '',
5408         'clid',        'varchar',  '', $char_d, \"''", '',
5409         'src',         'varchar',  '', $char_d, \"''", '',
5410         'dst',         'varchar',  '', $char_d, \"''", '',
5411         'dcontext',    'varchar',  '', $char_d, \"''", '',
5412         'channel',     'varchar',  '', $char_d, \"''", '',
5413         'dstchannel',  'varchar',  '', $char_d, \"''", '',
5414         'lastapp',     'varchar',  '', $char_d, \"''", '',
5415         'lastdata',    'varchar',  '',     255, \"''", '',
5416
5417         #currently only opensips & voipswitch
5418         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
5419
5420         #currently only opensips
5421         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
5422
5423         #currently only u4:
5424         # terminating number (as opposed to dialed destination)
5425         'dst_term',    'varchar',  'NULL', $char_d, '', '',
5426
5427         #these don't seem to be logged by most of the SQL cdr_* modules
5428         #except tds under sql-illegal names, so;
5429         # ... don't rely on them for rating?
5430         # and, what they hey, i went ahead and changed the names and data types
5431         # to freeside-style dates...
5432           #'start',  'timestamp', 'NULL',  '',    '', '',
5433           #'answer', 'timestamp', 'NULL',  '',    '', '',
5434           #'end',    'timestamp', 'NULL',  '',    '', '',
5435         'startdate',  @date_type, '', '',
5436         'answerdate', @date_type, '', '',
5437         'enddate',    @date_type, '', '',
5438         #
5439
5440         'duration',    'int',      '',      '',     0, '',
5441         'billsec',     'int',      '',      '',     0, '',
5442         'disposition', 'varchar',  '',      45, \"''", '',
5443         'amaflags',    'int',      '',      '',     0, '',
5444         'accountcode', 'varchar',  '',      32, \"''", '',
5445         'uniqueid',    'varchar',  '', $char_d, \"''", '',
5446         'userfield',   'varchar',  '',     512, \"''", '',
5447
5448         'max_callers', 'int',  'NULL',      '',    '', '',
5449
5450         ###
5451         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
5452         # ones we adoped moved to "own fields" section below
5453         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
5454         ###
5455
5456         'upstream_currency',      'char', 'NULL',       3, '', '',
5457         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
5458
5459         # how it was rated internally...
5460         'ratedetailnum',           'int', 'NULL',      '', '', '',
5461
5462         'distance',            'decimal', 'NULL',      '', '', '',
5463         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
5464
5465         #cdr_calltype: the big list in appendix 2
5466         'calltypenum',             'int', 'NULL',      '', '', '',
5467
5468         'description',         'varchar', 'NULL', $char_d, '', '',
5469         'quantity',                'int', 'NULL',      '', '', '',
5470
5471         'upstream_rateid',         'int', 'NULL',      '', '', '',
5472
5473         ###
5474         # more fields, for GSM imports
5475         ###
5476         'servicecode',             'int', 'NULL',      '', '', '',
5477         'quantity_able',           'int', 'NULL',      '', '', '',
5478
5479         ###
5480         #and now for our own fields
5481         ###
5482
5483         'cdrtypenum',              'int', 'NULL',      '', '', '',
5484
5485         'charged_party',       'varchar', 'NULL', $char_d, '', '',
5486         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
5487
5488         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
5489
5490         #currently only voipswitch
5491         #'upstream_rate',      'decimal', 'NULL',  '10,5', '', '',
5492
5493         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
5494         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
5495
5496         # how it was rated internally...
5497         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
5498         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
5499         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
5500         'rated_seconds',              'int', 'NULL',      '', '', '',
5501         'rated_minutes', 'double precision', 'NULL',      '', '', '',
5502         'rated_granularity',          'int', 'NULL',      '', '', '',
5503         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
5504         'rated_classnum',             'int', 'NULL',      '', '', '',
5505         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
5506         'rated_cost',            'decimal', 'NULL',  '10,4', '', '',
5507
5508         'carrierid',               'bigint', 'NULL',      '', '', '',
5509
5510         # service it was matched to
5511         'svcnum',             'int',   'NULL',     '',   '', '',
5512
5513         #NULL, done (or something)
5514         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
5515
5516         #NULL, done (or something)
5517         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
5518
5519         #an indexed place to put big numbers
5520         'cdrid',         'bigint',     'NULL',     '',  '', '',
5521
5522         #for taqua accountcode rewriting, for starters
5523         'sessionnum',       'int',    'NULL',      '', '', '',
5524         'subscriber',   'varchar',    'NULL', $char_d, '', '',
5525
5526         #old
5527         'cdrbatch',     'varchar',    'NULL',     255, '', '',
5528         #new
5529         'cdrbatchnum',      'int',    'NULL',      '', '', '',
5530
5531         # FK to cust_bill_pkg_detail; having a value here absolutely means
5532         # that the CDR appears on an invoice
5533         'detailnum',     'bigint',    'NULL',      '', '', '',
5534       ],
5535       'primary_key' => 'acctid',
5536       'unique' => [],
5537       'index' => [ [ 'calldate' ],
5538                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
5539                    [ 'lastapp' ],
5540                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
5541                    [ 'sessionnum' ], [ 'subscriber' ],
5542                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
5543                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
5544                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ], [ 'dst_term' ],
5545                    [ 'detailnum' ],
5546                  ],
5547       #no FKs on cdr table... choosing not to throw errors no matter what's
5548       # thrown in here.  better to have the data.
5549     },
5550
5551     'cdr_batch' => {
5552       'columns' => [
5553         'cdrbatchnum',   'serial',    '',   '', '', '',
5554         'cdrbatch', 'varchar', 'NULL', 255, '', '',
5555         '_date',     @date_type, '', '',
5556       ],
5557       'primary_key' => 'cdrbatchnum',
5558       'unique' => [ [ 'cdrbatch' ] ],
5559       'index' => [],
5560     },
5561
5562     'cdr_termination' => {
5563       'columns' => [
5564         'cdrtermnum', 'bigserial',     '',      '', '', '',
5565         'acctid',        'bigint',     '',      '', '', '',
5566         'termpart',         'int',     '',      '', '', '',#future use see below
5567         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
5568         'rated_seconds',    'int', 'NULL',      '', '', '',
5569         'rated_minutes', 'double precision', 'NULL',   '', '', '',
5570         'status',       'varchar', 'NULL',      32, '', '',
5571         'svcnum',           'int', 'NULL',      '', '', '',
5572       ],
5573       'primary_key'  => 'cdrtermnum',
5574       'unique'       => [ [ 'acctid', 'termpart' ] ],
5575       'index'        => [ [ 'acctid' ], [ 'status' ], ],
5576       'foreign_keys' => [
5577                           { columns    => [ 'acctid' ],
5578                             table      => 'cdr',
5579                           },
5580                           { columns    => [ 'svcnum' ],
5581                             table      => 'cust_svc',
5582                           },
5583                         ],
5584     },
5585
5586     #to handle multiple termination/settlement passes...
5587    # 'part_termination' => {
5588    #   'columns' => [
5589    #     'termpart',       'int', '',      '', '', '',
5590    #     'termname',   'varchar', '', $char_d, '', '',
5591    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
5592    #   ],
5593    #   'primary_key' => 'termpart',
5594    #   'unique' => [],
5595    #   'index'  => [],
5596    # },
5597
5598     #the remaining cdr_ tables are not really used
5599     'cdr_calltype' => {
5600       'columns' => [
5601         'calltypenum',   'serial',  '', '', '', '',
5602         'calltypename',  'varchar', '', $char_d, '', '',
5603       ],
5604       'primary_key' => 'calltypenum',
5605       'unique'      => [],
5606       'index'       => [],
5607     },
5608
5609     'cdr_type' => {
5610       'columns' => [
5611         'cdrtypenum'  => 'serial',  '', '', '', '',
5612         'cdrtypename' => 'varchar', '', $char_d, '', '',
5613       ],
5614       'primary_key' => 'cdrtypenum',
5615       'unique'      => [],
5616       'index'       => [],
5617     },
5618
5619     'cdr_carrier' => {
5620       'columns' => [
5621         'carrierid'   =>  'serial',     '',      '', '', '',
5622         'carriername' => 'varchar',     '', $char_d, '', '',
5623         'disabled'    =>    'char', 'NULL',       1, '', '',
5624       ],
5625       'primary_key' => 'carrierid',
5626       'unique'      => [],
5627       'index'       => [],
5628     },
5629
5630     #'cdr_file' => {
5631     #  'columns' => [
5632     #    'filenum',    'serial',     '', '', '', '',
5633     #    'filename',  'varchar',     '', '', '', '',
5634     #    'status',    'varchar', 'NULL', '', '', '',
5635     #  ],
5636     #  'primary_key' => 'filenum',
5637     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
5638     #                                   # agent-virtualize or have a customer
5639     #                                   # with dup-filename needs or something
5640     #                                   # (only used by cdr.http_and_import for
5641     #                                   #  chrissakes)
5642     #  'index'  => [],
5643     #},
5644
5645     'inventory_item' => {
5646       'columns' => [
5647         'itemnum',   'serial',      '',      '', '', '',
5648         'classnum',  'int',         '',      '', '', '',
5649         'agentnum',  'int',     'NULL',      '', '', '',
5650         'item',      'varchar',     '', $char_d, '', '',
5651         'svcnum',    'int',     'NULL',      '', '', '',
5652         'svc_field', 'varchar', 'NULL', $char_d, '', '',
5653       ],
5654       'primary_key'  => 'itemnum',
5655       'unique'       => [ [ 'classnum', 'item' ] ],
5656       'index'        => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
5657       'foreign_keys' => [
5658                           { columns    => [ 'classnum' ],
5659                             table      => 'inventory_class',
5660                           },
5661                           { columns    => [ 'agentnum' ],
5662                             table      => 'agent',
5663                           },
5664                           { columns    => [ 'svcnum' ],
5665                             table      => 'cust_svc',
5666                           },
5667                         ],
5668     },
5669
5670     'inventory_class' => {
5671       'columns' => [
5672         'classnum',  'serial',       '',      '', '', '',
5673         'classname', 'varchar',      '', $char_d, '', '',
5674       ],
5675       'primary_key' => 'classnum',
5676       'unique' => [],
5677       'index'  => [],
5678     },
5679
5680     'access_user_session' => {
5681       'columns' => [
5682         'sessionnum',   'serial',  '',      '', '', '',
5683         'sessionkey',  'varchar',  '', $char_d, '', '',
5684         'usernum',         'int',  '',      '', '', '',
5685         'start_date', @date_type,               '', '',
5686         'last_date',  @date_type,               '', '',
5687       ],
5688       'primary_key'  => 'sessionnum',
5689       'unique'       => [ [ 'sessionkey' ] ],
5690       'index'        => [],
5691       'foreign_keys' => [
5692                           { columns    => [ 'usernum' ],
5693                             table      => 'access_user',
5694                           },
5695                         ],
5696     },
5697
5698     'access_user' => {
5699       'columns' => [
5700         'usernum',             'serial',     '',      '', '', '',
5701         'username',           'varchar',     '', $char_d, '', '',
5702         '_password',          'varchar', 'NULL', $char_d, '', '',
5703         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
5704         'last',               'varchar', 'NULL', $char_d, '', '',
5705         'first',              'varchar', 'NULL', $char_d, '', '',
5706         'user_custnum',           'int', 'NULL',      '', '', '',
5707         'report_salesnum',        'int', 'NULL',      '', '', '',
5708         'disabled',              'char', 'NULL',       1, '', '',
5709       ],
5710       'primary_key'  => 'usernum',
5711       'unique'       => [ [ 'username' ] ],
5712       'index'        => [ [ 'user_custnum' ] ],
5713       'foreign_keys' => [
5714                           { columns    => [ 'user_custnum' ],
5715                             table      => 'cust_main',
5716                             references => [ 'custnum' ],
5717                           },
5718                           { columns    => [ 'report_salesnum' ],
5719                             table      => 'sales',
5720                             references => [ 'salesnum' ],
5721                           },
5722                         ],
5723     },
5724
5725     'access_user_pref' => {
5726       'columns' => [
5727         'prefnum',    'serial',       '', '', '', '',
5728         'usernum',     'int',       '', '', '', '',
5729         'prefname', 'varchar', '', $char_d, '', '',
5730         'prefvalue', 'text', 'NULL', '', '', '',
5731         'expiration', @date_type, '', '',
5732       ],
5733       'primary_key'  => 'prefnum',
5734       'unique'       => [],
5735       'index'        => [ [ 'usernum' ] ],
5736       'foreign_keys' => [
5737                           { columns    => [ 'usernum' ],
5738                             table      => 'access_user',
5739                           },
5740                         ],
5741     },
5742
5743     'access_group' => {
5744       'columns' => [
5745         'groupnum',   'serial', '',      '', '', '',
5746         'groupname', 'varchar', '', $char_d, '', '',
5747       ],
5748       'primary_key' => 'groupnum',
5749       'unique' => [ [ 'groupname' ] ],
5750       'index'  => [],
5751     },
5752
5753     'access_usergroup' => {
5754       'columns' => [
5755         'usergroupnum', 'serial', '', '', '', '',
5756         'usernum',         'int', '', '', '', '',
5757         'groupnum',        'int', '', '', '', '',
5758       ],
5759       'primary_key'  => 'usergroupnum',
5760       'unique'       => [ [ 'usernum', 'groupnum' ] ],
5761       'index'        => [ [ 'usernum' ] ],
5762       'foreign_keys' => [
5763                           { columns    => [ 'usernum' ],
5764                             table      => 'access_user',
5765                           },
5766                           { columns    => [ 'groupnum' ],
5767                             table      => 'access_group',
5768                           },
5769                         ],
5770      },
5771
5772     'access_groupagent' => {
5773       'columns' => [
5774         'groupagentnum', 'serial', '', '', '', '',
5775         'groupnum',         'int', '', '', '', '',
5776         'agentnum',         'int', '', '', '', '',
5777       ],
5778       'primary_key'  => 'groupagentnum',
5779       'unique'       => [ [ 'groupnum', 'agentnum' ] ],
5780       'index'        => [ [ 'groupnum' ] ],
5781       'foreign_keys' => [
5782                           { columns    => [ 'groupnum' ],
5783                             table      => 'access_group',
5784                           },
5785                           { columns    => [ 'agentnum' ],
5786                             table      => 'agent',
5787                           },
5788                         ],
5789     },
5790
5791     'access_right' => {
5792       'columns' => [
5793         'rightnum',   'serial', '',      '', '', '',
5794         'righttype', 'varchar', '', $char_d, '', '',
5795         'rightobjnum',   'int', '',      '', '', '',
5796         'rightname', 'varchar', '', $char_d, '', '',
5797       ],
5798       'primary_key' => 'rightnum',
5799       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
5800       'index'  => [],
5801     },
5802
5803     'access_user_log' => {
5804       'columns'      => [
5805         'lognum',          'serial',     '',        '', '', '',
5806         'usernum',            'int',     '',        '', '', '',
5807         'path',           'varchar',     '', 2*$char_d, '', '',
5808         '_date',                   @date_type,          '', '',
5809         'render_seconds',     'int', 'NULL',        '', '', '',
5810       ],
5811       'primary_key'  => 'lognum',
5812       'unique'       => [],
5813       'index'        => [ ['usernum'], ['path'], ['_date'] ],
5814     },
5815
5816     'access_user_page_pref' => {
5817       'columns'     => [
5818         'prefnum'     =>  'serial',     '',      '', '', '',
5819         'usernum'     =>     'int',     '',      '', '', '',
5820         'path'        =>    'text',     '',      '', '', '',
5821         'tablenum'    =>     'int', 'NULL',      '', '', '',
5822         '_date'       =>    @date_type,              '', '',
5823         'prefname'    =>    'varchar',  '', $char_d, '', '',
5824         'prefvalue'   =>    'text',     '',      '', '', '',
5825       ],
5826       'primary_key' => 'prefnum',
5827       'unique'      => [ [ 'usernum', 'path', 'tablenum', 'prefname' ] ],
5828       'index'       => [],
5829       'foreign_keys' => [
5830                           { columns   => [ 'usernum' ],
5831                             table     => 'access_user'
5832                           },
5833                         ],
5834     },
5835
5836     'sched_item' => {
5837       'columns' => [
5838         'itemnum',   'serial',      '', '', '', '',
5839         'usernum',      'int',  'NULL', '', '', '',
5840         #'itemname', 'varchar', $char_d, '', '', '',
5841         'disabled',    'char',  'NULL',  1, '', '',
5842       ],
5843       'primary_key'  => 'itemnum',
5844       'unique'       => [ [ 'usernum' ] ],
5845       'index'        => [],
5846       'foreign_keys' => [
5847                           { columns    => [ 'usernum' ],
5848                             table      => 'access_user',
5849                           },
5850                         ],
5851     },
5852
5853     #'sched_item_class'
5854
5855     'sched_avail' => {
5856       'columns' => [
5857         'availnum',      'serial', '', '', '', '',
5858         'itemnum',          'int', '', '', '', '',
5859         'wday',             'int', '', '', '', '',
5860         'stime',            'int', '', '', '', '',
5861         'etime',            'int', '', '', '', '',
5862         'override_date',    @date_type,    '', '',
5863       ],
5864       'primary_key'  => 'availnum',
5865       'unique'       => [],
5866       'index'        => [],
5867       'foreign_keys' => [
5868                           { columns    => [ 'itemnum' ],
5869                             table      => 'sched_item',
5870                           },
5871                         ],
5872     },
5873
5874     'svc_phone' => {
5875       'columns' => [
5876         'svcnum',                         'int',     '',      '', '', '',
5877         'countrycode',                'varchar',     '',       3, '', '',
5878         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
5879         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
5880         'pin',                        'varchar', 'NULL', $char_d, '', '',
5881         'sip_password',               'varchar', 'NULL', $char_d, '', '',
5882         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
5883         'pbxsvc',                         'int', 'NULL',      '', '', '',
5884         'domsvc',                         'int', 'NULL',      '', '', '',
5885         'locationnum',                    'int', 'NULL',      '', '', '',
5886         'forward_svcnum',                 'int', 'NULL',      '', '', '',
5887         'forwarddst',                 'varchar', 'NULL',      15, '', '',
5888         'email',                      'varchar', 'NULL',     255, '', '',
5889         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
5890         'portable',                      'char', 'NULL',       1, '', '',
5891         'lrn',                           'char', 'NULL',      10, '', '',
5892         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
5893         'lnp_due_date',                   'int', 'NULL',      '', '', '',
5894         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
5895         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
5896         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
5897         'sms_carrierid',                  'int', 'NULL',      '', '', '',
5898         'sms_account',                'varchar', 'NULL', $char_d, '', '',
5899         'max_simultaneous',               'int', 'NULL',      '', '', '',
5900         'e911_class',                    'char', 'NULL',       1, '', '',
5901         'e911_type',                     'char', 'NULL',       1, '', '',
5902         'circuit_svcnum',                 'int', 'NULL',      '', '', '',
5903         'sip_server',                 'varchar', 'NULL', $char_d, '', '',
5904       ],
5905       'primary_key'  => 'svcnum',
5906       'unique'       => [ [ 'sms_carrierid', 'sms_account'] ],
5907       'index'        => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
5908                           ['locationnum'], ['sms_carrierid'],
5909                         ],
5910       'foreign_keys' => [
5911                           { columns    => [ 'svcnum' ],
5912                             table      => 'cust_svc',
5913                           },
5914                           { columns    => [ 'pbxsvc' ],
5915                             table      => 'svc_pbx', #'cust_svc',
5916                             references => [ 'svcnum' ],
5917                           },
5918                           { columns    => [ 'domsvc' ],
5919                             table      => 'svc_domain', #'cust_svc',
5920                             references => [ 'svcnum' ],
5921                           },
5922                           { columns    => [ 'locationnum' ],
5923                             table      => 'cust_location',
5924                           },
5925                           { columns    => [ 'sms_carrierid' ],
5926                             table      => 'cdr_carrier',
5927                             references => [ 'carrierid' ],
5928                           },
5929                           { columns    => [ 'circuit_svcnum' ],
5930                             table      => 'svc_circuit',
5931                             references => [ 'svcnum' ],
5932                           },
5933                         ],
5934     },
5935
5936     'phone_device' => {
5937       'columns' => [
5938         'devicenum', 'serial',     '', '', '', '',
5939         'devicepart',   'int',     '', '', '', '',
5940         'svcnum',       'int',     '', '', '', '',
5941         'mac_addr', 'varchar', 'NULL', 12, '', '',
5942       ],
5943       'primary_key'  => 'devicenum',
5944       'unique'       => [ [ 'mac_addr' ], ],
5945       'index'        => [ [ 'devicepart' ], [ 'svcnum' ], ],
5946       'foreign_keys' => [
5947                           { columns    => [ 'devicepart' ],
5948                             table      => 'part_device',
5949                           },
5950                           { columns    => [ 'svcnum' ],
5951                             table      => 'svc_phone',
5952                           },
5953                         ],
5954     },
5955
5956     'part_device' => {
5957       'columns' => [
5958         'devicepart', 'serial',  '',      '', '', '',
5959         'devicename', 'varchar', '', $char_d, '', '',
5960         'inventory_classnum', 'int', 'NULL', '', '', '',
5961         'title',      'varchar', 'NULL', $char_d, '', '',
5962       ],
5963       'primary_key'  => 'devicepart',
5964       'unique'       => [ [ 'devicename' ] ], #?
5965       'index'        => [],
5966       'foreign_keys' => [
5967                           { columns    => [ 'inventory_classnum' ],
5968                             table      => 'inventory_class',
5969                             references => [ 'classnum' ],
5970                           },
5971                         ],
5972     },
5973
5974     'phone_avail' => {
5975       'columns' => [
5976         'availnum',    'serial',      '',      '', '', '',
5977         'exportnum',   'int',         '',      '', '', '',
5978         'countrycode', 'varchar',     '',       3, '', '',
5979         'state',       'char',    'NULL',       2, '', '',
5980         'npa',         'char',        '',       3, '', '',
5981         'nxx',         'char',    'NULL',       3, '', '',
5982         'station',     'char',    'NULL',       4, '', '',
5983         'name',        'varchar', 'NULL', $char_d, '', '',
5984         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
5985         'latanum',      'int',     'NULL',      '', '', '',
5986         'msanum',       'int', 'NULL', '', '', '',
5987         'ordernum',      'int',     'NULL',      '', '', '',
5988         'svcnum',      'int',     'NULL',      '', '', '',
5989         'availbatch', 'varchar',  'NULL', $char_d, '', '',
5990       ],
5991       'primary_key'  => 'availnum',
5992       'unique'       => [],
5993       'index'        => [ ['exportnum','countrycode','state'],    #npa search
5994                           ['exportnum','countrycode','npa'],      #nxx search
5995                           ['exportnum','countrycode','npa','nxx'],#station srch
5996                           [ 'exportnum','countrycode','npa','nxx','station'], #
5997                           [ 'svcnum' ],
5998                           [ 'availbatch' ],
5999                           [ 'latanum' ],
6000                         ],
6001       'foreign_keys' => [
6002                           { columns    => [ 'exportnum' ],
6003                             table      => 'part_export',
6004                           },
6005                           { columns    => [ 'latanum' ],
6006                             table      => 'lata',
6007                           },
6008                           { columns    => [ 'msanum' ],
6009                             table      => 'msa',
6010                           },
6011                           { columns    => [ 'ordernum' ],
6012                             table      => 'did_order',
6013                           },
6014                           { columns    => [ 'svcnum' ],
6015                             table      => 'svc_phone',
6016                           },
6017                         ],
6018     },
6019
6020     'lata' => {
6021       'columns' => [
6022         'latanum',    'int',      '',      '', '', '',
6023         'description',   'varchar',    '',      $char_d, '', '',
6024         'have_usage',   'int',    'NULL',      '', '', '',
6025       ],
6026       'primary_key' => 'latanum',
6027       'unique' => [],
6028       'index'  => [],
6029     },
6030
6031     'msa' => {
6032       'columns' => [
6033         'msanum',    'int',      '',      '', '', '',
6034         'description',   'varchar',    '',      $char_d, '', '',
6035       ],
6036       'primary_key' => 'msanum',
6037       'unique' => [],
6038       'index'  => [],
6039     },
6040
6041     'rate_center' => {
6042       'columns' => [
6043         'ratecenternum',    'serial',      '',      '', '', '',
6044         'description',   'varchar',    '',      $char_d, '', '',
6045       ],
6046       'primary_key' => 'ratecenternum',
6047       'unique' => [],
6048       'index'  => [],
6049     },
6050
6051     'did_vendor' => {
6052       'columns' => [
6053         'vendornum',    'serial',      '',      '', '', '',
6054         'vendorname',   'varchar',        '',     $char_d, '', '',
6055       ],
6056       'primary_key' => 'vendornum',
6057       'unique' => [],
6058       'index'  => [],
6059     },
6060
6061     'did_order_item' => {
6062       'columns' => [
6063         'orderitemnum',    'serial',      '',      '', '', '',
6064         'ordernum',    'int',      '',      '', '', '',
6065         'msanum',      'int',     'NULL',      '', '', '',
6066         'npa',      'int',     'NULL',      '', '', '',
6067         'latanum',      'int',     'NULL',      '', '', '',
6068         'ratecenternum',      'int',     'NULL',      '', '', '',
6069         'state',       'char',    'NULL',       2, '', '',
6070         'quantity',      'int',     '',      '', '', '',
6071         'custnum',   'int', 'NULL', '', '', '',
6072       ],
6073       'primary_key'  => 'orderitemnum',
6074       'unique'       => [],
6075       'index'        => [],
6076       'foreign_keys' => [
6077                           { columns    => [ 'ordernum' ],
6078                             table      => 'did_order',
6079                           },
6080                           { columns    => [ 'msanum' ],
6081                             table      => 'msa',
6082                           },
6083                           { columns    => [ 'latanum' ],
6084                             table      => 'lata',
6085                           },
6086                           { columns    => [ 'ratecenternum' ],
6087                             table      => 'rate_center',
6088                           },
6089                           { columns    => [ 'custnum' ],
6090                             table      => 'cust_main',
6091                           },
6092                         ],
6093     },
6094
6095     'did_order' => {
6096       'columns' => [
6097         'ordernum',    'serial',      '',      '', '', '',
6098         'vendornum',   'int',       '',      '', '', '',
6099         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
6100         'custnum',   'int', 'NULL', '', '', '',
6101         'submitted',      'int',     '',      '', '', '',
6102         'confirmed',      'int',     'NULL',      '', '', '',
6103         'received',      'int',     'NULL',      '', '', '',
6104       ],
6105       'primary_key'  => 'ordernum',
6106       'unique'       => [ [ 'vendornum', 'vendor_order_id' ] ],
6107       'index'        => [],
6108       'foreign_keys' => [
6109                           { columns    => [ 'vendornum' ],
6110                             table      => 'did_vendor',
6111                           },
6112                           { columns    => [ 'custnum' ],
6113                             table      => 'cust_main',
6114                           },
6115                         ],
6116     },
6117
6118     'reason_type' => {
6119       'columns' => [
6120         'typenum',   'serial',  '', '', '', '',
6121         'class',     'char', '', 1, '', '',
6122         'type',     'varchar', '', $char_d, '', '',
6123       ],
6124       'primary_key' => 'typenum',
6125       'unique' => [],
6126       'index' => [],
6127     },
6128
6129     'reason' => {
6130       'columns' => [
6131         'reasonnum',     'serial',  '', '', '', '',
6132         'reason_type',   'int',  '', '', '', '',
6133         'reason',        'text', '', '', '', '',
6134         'disabled',      'char',    'NULL', 1, '', '',
6135         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
6136         'unsuspend_hold','char',    'NULL', 1, '', '',
6137         'unused_credit', 'char',    'NULL', 1, '', '',
6138         'feepart',        'int', 'NULL', '', '', '',
6139         'fee_on_unsuspend','char',  'NULL', 1, '', '',
6140         'fee_hold',      'char',    'NULL', 1, '', '',
6141       ],
6142       'primary_key'  => 'reasonnum',
6143       'unique'       => [],
6144       'index'        => [],
6145       'foreign_keys' => [
6146                           { columns    => [ 'reason_type' ],
6147                             table      => 'reason_type',
6148                             references => [ 'typenum' ],
6149                           },
6150                           { columns    => [ 'unsuspend_pkgpart' ],
6151                             table      => 'part_pkg',
6152                             references => [ 'pkgpart' ],
6153                           },
6154                         ],
6155     },
6156
6157     'conf' => {
6158       'columns' => [
6159         'confnum',  'serial',     '',      '', '', '',
6160         'agentnum', 'int',    'NULL',      '', '', '',
6161         'locale',   'varchar','NULL',      16, '', '',
6162         'name',     'varchar',    '', $char_d, '', '',
6163         'value',    'text',   'NULL',      '', '', '',
6164       ],
6165       'primary_key'  => 'confnum',
6166       'unique'       => [ [ 'agentnum', 'locale', 'name' ] ],
6167       'index'        => [],
6168       'foreign_keys' => [
6169                           { columns    => [ 'agentnum' ],
6170                             table      => 'agent',
6171                           },
6172                         ],
6173     },
6174
6175     'pkg_referral' => {
6176       'columns' => [
6177         'pkgrefnum',     'serial', '', '', '', '',
6178         'pkgnum',        'int',    '', '', '', '',
6179         'refnum',        'int',    '', '', '', '',
6180       ],
6181       'primary_key'  => 'pkgrefnum',
6182       'unique'       => [ [ 'pkgnum', 'refnum' ] ],
6183       'index'        => [ [ 'pkgnum' ], [ 'refnum' ] ],
6184       'foreign_keys' => [
6185                           { columns    => [ 'pkgnum' ],
6186                             table      => 'cust_pkg',
6187                           },
6188                           { columns    => [ 'refnum' ],
6189                             table      => 'part_referral',
6190                           },
6191                         ],
6192     },
6193
6194     'svc_pbx' => {
6195       'columns' => [
6196         'svcnum',           'int',     '',      '', '', '',
6197         'id',               'int', 'NULL',      '', '', '',
6198         'uuid',            'char', 'NULL',      36, '', '',
6199         'title',        'varchar', 'NULL', $char_d, '', '',
6200         'max_extensions',   'int', 'NULL',      '', '', '',
6201         'max_simultaneous', 'int', 'NULL',      '', '', '',
6202         'ip_addr',      'varchar', 'NULL',      40, '', '',
6203       ],
6204       'primary_key'  => 'svcnum',
6205       'unique'       => [],
6206       'index'        => [ [ 'id' ], [ 'uuid' ] ],
6207       'foreign_keys' => [
6208                           { columns    => [ 'svcnum' ],
6209                             table      => 'cust_svc',
6210                           },
6211                         ],
6212     },
6213
6214     'pbx_extension' => {
6215       'columns' => [
6216         'extensionnum',  'serial',     '',      '', '', '',
6217         'svcnum',           'int',     '',      '', '', '',
6218         'extension',    'varchar',     '', $char_d, '', '',
6219         'pin',          'varchar', 'NULL', $char_d, '', '',
6220         'sip_password', 'varchar', 'NULL', $char_d, '', '',
6221         'phone_name',   'varchar', 'NULL', $char_d, '', '',
6222       ],
6223       'primary_key'  => 'extensionnum',
6224       'unique'       => [ [ 'svcnum', 'extension' ] ],
6225       'index'        => [ [ 'svcnum' ] ],
6226       'foreign_keys' => [
6227                           { columns    => [ 'svcnum' ],
6228                             table      => 'svc_pbx',
6229                           },
6230                         ],
6231     },
6232
6233     'pbx_device' => {
6234       'columns' => [
6235         'devicenum', 'serial',     '', '', '', '',
6236         'devicepart',   'int',     '', '', '', '',
6237         'svcnum',       'int',     '', '', '', '',
6238         'mac_addr', 'varchar', 'NULL', 12, '', '',
6239       ],
6240       'primary_key'  => 'devicenum',
6241       'unique'       => [ [ 'mac_addr' ], ],
6242       'index'        => [ [ 'devicepart' ], [ 'svcnum' ], ],
6243       'foreign_keys' => [
6244                           { columns    => [ 'devicepart' ],
6245                             table      => 'part_device',
6246                           },
6247                           { columns    => [ 'svcnum' ],
6248                             table      => 'svc_pbx',
6249                           },
6250                         ],
6251     },
6252
6253     'extension_device' => {
6254       'columns' => [
6255         'extensiondevicenum', 'serial', '', '', '', '',
6256         'extensionnum',          'int', '', '', '', '',
6257         'devicenum',             'int', '', '', '', '',
6258       ],
6259       'primary_key'  => 'extensiondevicenum',
6260       'unique'       => [ [ 'extensionnum', 'devicenum' ] ],
6261       'index'        => [],#both?  which way do we need to query?
6262       'foreign_keys' => [
6263                           { columns  => [ 'extensionnum' ],
6264                             table    => 'pbx_extension',
6265                           },
6266                           { columns  => [ 'devicenum' ],
6267                             table    => 'pbx_device',
6268                           },
6269                         ],
6270     },
6271
6272     'svc_mailinglist' => { #svc_group?
6273       'columns' => [
6274         'svcnum',            'int',     '',            '', '', '',
6275         'username',      'varchar',     '', $username_len, '', '',
6276         'domsvc',            'int',     '',            '', '', '',
6277         'listnum',           'int',     '',            '', '', '',
6278         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
6279         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
6280         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
6281         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
6282       ],
6283       'primary_key'  => 'svcnum',
6284       'unique'       => [],
6285       'index'        => [ ['username'], ['domsvc'], ['listnum'] ],
6286       'foreign_keys' => [
6287                           { columns    => [ 'svcnum' ],
6288                             table      => 'cust_svc',
6289                           },
6290                           { columns    => [ 'domsvc' ],
6291                             table      => 'svc_domain', #'cust_svc',
6292                             references => [ 'svcnum' ],
6293                           },
6294                           { columns    => [ 'listnum' ],
6295                             table      => 'mailinglist',
6296                           },
6297                         ],
6298     },
6299
6300     'mailinglist' => {
6301       'columns' => [
6302         'listnum',   'serial', '',      '', '', '',
6303         'listname', 'varchar', '', $char_d, '', '',
6304       ],
6305       'primary_key' => 'listnum',
6306       'unique' => [],
6307       'index'  => [],
6308     },
6309
6310     'mailinglistmember' => {
6311       'columns' => [
6312         'membernum',        'serial',     '',   '', '', '',
6313         'listnum',             'int',     '',   '', '', '',
6314         'svcnum',              'int', 'NULL',   '', '', '',
6315         'contactemailnum',     'int', 'NULL',   '', '', '',
6316         'email',           'varchar', 'NULL',  255, '', '',
6317       ],
6318       'primary_key'  => 'membernum',
6319       'unique'       => [],
6320       'index'        => [['listnum'],['svcnum'],['contactemailnum'],['email']],
6321       'foreign_keys' => [
6322                           { columns    => [ 'listnum' ],
6323                             table      => 'mailinglist',
6324                           },
6325                           { columns    => [ 'svcnum' ],
6326                             table      => 'svc_acct',
6327                           },
6328                           { columns    => [ 'contactemailnum' ],
6329                             table      => 'contact_email',
6330                           },
6331                         ],
6332     },
6333
6334     'bill_batch' => {
6335       'columns' => [
6336         'batchnum',         'serial',     '',  '', '', '',
6337         'agentnum',            'int', 'NULL',  '', '', '',
6338         'status',             'char', 'NULL', '1', '', '',
6339         'pdf',                'blob', 'NULL',  '', '', '',
6340       ],
6341       'primary_key'  => 'batchnum',
6342       'unique'       => [],
6343       'index'        => [ ['agentnum'] ],
6344       'foreign_keys' => [
6345                           { columns    => [ 'agentnum' ],
6346                             table      => 'agent',
6347                           },
6348                         ],
6349     },
6350
6351     'cust_bill_batch' => {
6352       'columns' => [
6353         'billbatchnum',     'serial',     '', '', '', '',
6354         'batchnum',            'int',     '', '', '', '',
6355         'invnum',              'int',     '', '', '', '',
6356       ],
6357       'primary_key'  => 'billbatchnum',
6358       'unique'       => [],
6359       'index'        => [ [ 'batchnum' ], [ 'invnum' ] ],
6360       'foreign_keys' => [
6361                           { columns    => [ 'batchnum' ],
6362                             table      => 'bill_batch',
6363                           },
6364                           { columns    => [ 'invnum' ],
6365                             table      => 'cust_bill',
6366                           },
6367                         ],
6368     },
6369
6370     'cust_bill_batch_option' => {
6371       'columns' => [
6372         'optionnum', 'serial', '', '', '', '',
6373         'billbatchnum', 'int', '', '', '', '',
6374         'optionname', 'varchar', '', $char_d, '', '',
6375         'optionvalue', 'text', 'NULL', '', '', '',
6376       ],
6377       'primary_key'  => 'optionnum',
6378       'unique'       => [],
6379       'index'        => [ [ 'billbatchnum' ], [ 'optionname' ] ],
6380       'foreign_keys' => [
6381                           { columns    => [ 'billbatchnum' ],
6382                             table      => 'cust_bill_batch',
6383                           },
6384                         ],
6385      },
6386
6387     'msg_template' => {
6388       'columns' => [
6389         'msgnum',     'serial',     '',      '', '', '',
6390         'msgname',   'varchar',     '', $char_d, '', '',
6391         'agentnum',      'int', 'NULL',      '', '', '',
6392         'subject',   'varchar', 'NULL',     512, '', '',
6393         'mime_type', 'varchar',     '', $char_d, '', '',
6394         'body',         'blob', 'NULL',      '', '', '',
6395         'disabled',     'char', 'NULL',       1, '', '',
6396           # migrate these to msg_template_email
6397         'from_addr', 'varchar', 'NULL',     255, '', '',
6398         'bcc_addr',  'varchar', 'NULL',     255, '', '',
6399           # change to not null on v5
6400         'msgclass',  'varchar', 'NULL',      16, '', '',
6401       ],
6402       'primary_key'  => 'msgnum',
6403       'unique'       => [ ],
6404       'index'        => [ ['agentnum'], ],
6405       'foreign_keys' => [
6406                           { columns    => [ 'agentnum' ],
6407                             table      => 'agent',
6408                           },
6409                         ],
6410     },
6411
6412     'msg_template_http' => {
6413       'columns' => [
6414         'num',          'serial',     '',      '', '', '',
6415         'msgnum',          'int',     '',      '', '', '',
6416         'prepare_url', 'varchar', 'NULL',     255, '', '',
6417         'send_url',    'varchar', 'NULL',     255, '', '',
6418         'username',    'varchar', 'NULL', $char_d, '', '',
6419         'password',    'varchar', 'NULL', $char_d, '', '',
6420         'content',        'text', 'NULL',      '', '', '',
6421       ],
6422       'primary_key'  => 'num',
6423       'unique'       => [ [ 'msgnum' ], ],
6424       'index'        => [ ],
6425       'foreign_keys' => [
6426                           { columns    => [ 'msgnum' ],
6427                             table      => 'msg_template',
6428                           },
6429                         ],
6430     },
6431
6432     'template_content' => {
6433       'columns' => [
6434         'contentnum', 'serial',     '',      '', '', '',
6435         'msgnum',        'int',     '',      '', '', '',
6436         'locale',    'varchar', 'NULL',      16, '', '',
6437         'subject',   'varchar', 'NULL',     512, '', '',
6438         'body',         'text', 'NULL',      '', '', '',
6439       ],
6440       'primary_key'  => 'contentnum',
6441       'unique'       => [ ['msgnum', 'locale'] ],
6442       'index'        => [ ],
6443       'foreign_keys' => [
6444                           { columns    => [ 'msgnum' ],
6445                             table      => 'msg_template',
6446                           },
6447                         ],
6448     },
6449
6450     'template_image' => {
6451       'columns' => [
6452         'imgnum',     'serial',     '',      '', '', '',
6453         'name',      'varchar',     '', $char_d, '', '',
6454         'agentnum',      'int', 'NULL',      '', '', '',
6455         'mime_type', 'varchar',     '', $char_d, '', '',
6456         'base64',       'text',     '',      '', '', '',
6457       ],
6458       'primary_key'  => 'imgnum',
6459       'unique'       => [ ],
6460       'index'        => [ ['name'], ['agentnum'] ],
6461     },
6462
6463     'cust_msg' => {
6464       'columns' => [
6465         'custmsgnum', 'serial',     '',     '', '', '',
6466         'custnum',       'int', 'NULL',     '', '', '',
6467         'msgnum',        'int', 'NULL',     '', '', '',
6468         '_date',    @date_type,                 '', '',
6469         'env_from',  'varchar', 'NULL',    255, '', '',
6470         'env_to',    'varchar', 'NULL',    255, '', '',
6471         'header',       'blob', 'NULL',     '', '', '',
6472         'body',         'blob', 'NULL',     '', '', '',
6473         'error',     'varchar', 'NULL',    255, '', '',
6474         'status',    'varchar',     '',$char_d, '', '',
6475         'msgtype',   'varchar', 'NULL',     16, '', '',
6476         'preview',      'text', 'NULL',     '', '', '',
6477       ],
6478       'primary_key'  => 'custmsgnum',
6479       'unique'       => [ ],
6480       'index'        => [ ['custnum'], ],
6481       'foreign_keys' => [
6482                           { columns    => [ 'custnum' ],
6483                             table      => 'cust_main',
6484                           },
6485                           { columns    => [ 'msgnum' ],
6486                             table      => 'msg_template',
6487                           },
6488                         ],
6489     },
6490
6491     'svc_cert' => {
6492       'columns' => [
6493         'svcnum',                'int',     '',      '', '', '',
6494         'recnum',                'int', 'NULL',      '', '', '',
6495         'privatekey',           'text', 'NULL',      '', '', '',
6496         'csr',                  'text', 'NULL',      '', '', '',
6497         'certificate',          'text', 'NULL',      '', '', '',
6498         'cacert',               'text', 'NULL',      '', '', '',
6499         'common_name',       'varchar', 'NULL', $char_d, '', '',
6500         'organization',      'varchar', 'NULL', $char_d, '', '',
6501         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
6502         'city',              'varchar', 'NULL', $char_d, '', '',
6503         'state',             'varchar', 'NULL', $char_d, '', '',
6504         'country',              'char', 'NULL',       2, '', '',
6505         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
6506       ],
6507       'primary_key'  => 'svcnum',
6508       'unique'       => [],
6509       'index'        => [], #recnum
6510       'foreign_keys' => [
6511                           { columns    => [ 'svcnum' ],
6512                             table      => 'cust_svc',
6513                           },
6514                           { columns    => [ 'recnum' ],
6515                             table      => 'domain_record',
6516                           },
6517                         ],
6518     },
6519
6520     'svc_port' => {
6521       'columns' => [
6522         'svcnum',                'int',     '',      '', '', '',
6523         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
6524       ],
6525       'primary_key'  => 'svcnum',
6526       'unique'       => [],
6527       'index'        => [], #recnum
6528       'foreign_keys' => [
6529                           { columns    => [ 'svcnum' ],
6530                             table      => 'cust_svc',
6531                           },
6532                         ],
6533     },
6534
6535     'areacode'  => {
6536       'columns' => [
6537         'areanum',   'serial',        '',      '', '', '',
6538         'code',        'char',        '',       3, '', '',
6539         'country',     'char',    'NULL',       2, '', '',
6540         'state',       'char',    'NULL',       2, '', '',
6541         'description','varchar',  'NULL',     255, '', '',
6542       ],
6543       'primary_key' => 'areanum',
6544       'unique' => [ [ 'areanum' ] ],
6545       'index'  => [],
6546     },
6547
6548     'upgrade_journal' => {
6549       'columns' => [
6550         'upgradenum', 'serial', '', '', '', '',
6551         '_date', 'int', '', '', '', '',
6552         'upgrade', 'varchar', '', $char_d, '', '',
6553         'status', 'varchar', '', $char_d, '', '',
6554         'statustext', 'varchar', 'NULL', $char_d, '', '',
6555       ],
6556       'primary_key' => 'upgradenum',
6557       'unique' => [],
6558       'index' => [ [ 'upgrade' ] ],
6559     },
6560
6561     'upload_target' => {
6562       'columns' => [
6563         'targetnum', 'serial', '', '', '', '',
6564         'agentnum', 'int', 'NULL', '', '', '',
6565         'protocol', 'varchar', '', 10, '', '',
6566         'hostname', 'varchar', '', $char_d, '', '',
6567         'port', 'int', 'NULL', '', '', '',
6568         'username', 'varchar', '', $char_d, '', '',
6569         'password', 'varchar', 'NULL', $char_d, '', '',
6570         'path', 'varchar', 'NULL', $char_d, '', '',
6571         'subject', 'varchar', 'NULL', '255', '', '',
6572         'handling', 'varchar', 'NULL', $char_d, '', '',
6573       ],
6574       'primary_key'   => 'targetnum',
6575       'unique'        => [ [ 'targetnum' ] ],
6576       'index'         => [],
6577       'foreign_keys' => [
6578                           { columns    => [ 'agentnum' ],
6579                             table      => 'agent',
6580                           },
6581                         ],
6582     },
6583
6584     'log' => {
6585       'columns' => [
6586         'lognum',     'serial', '', '', '', '',
6587         '_date',      'int', '', '', '', '',
6588         'agentnum',   'int', 'NULL', '', '', '',
6589         'tablename',  'varchar', 'NULL', $char_d, '', '',
6590         'tablenum',   'int',  'NULL', '', '', '',
6591         'level',      'int',  '', '', '', '',
6592         'message',    'text', '', '', '', '',
6593       ],
6594       'primary_key'  => 'lognum',
6595       'unique'       => [],
6596       'index'        => [ ['_date'], ['level'] ],
6597       'foreign_keys' => [
6598                           { columns    => [ 'agentnum' ],
6599                             table      => 'agent',
6600                           },
6601                         ],
6602     },
6603
6604     'log_context' => {
6605       'columns' => [
6606         'logcontextnum', 'serial', '', '', '', '',
6607         'lognum', 'int', '', '', '', '',
6608         'context', 'varchar', '', $char_d, '', '',
6609       ],
6610       'primary_key'  => 'logcontextnum',
6611       'unique'       => [ [ 'lognum', 'context' ] ],
6612       'index'        => [],
6613       'foreign_keys' => [
6614                           { columns    => [ 'lognum' ],
6615                             table      => 'log',
6616                           },
6617                         ],
6618     },
6619
6620     'log_email' => {
6621       'columns' => [
6622         'logemailnum', 'serial', '', '', '', '',
6623         'context', 'varchar', 'NULL', $char_d, '', '',
6624         'min_level', 'int',  'NULL', '', '', '',
6625         'msgnum', 'int', '',  '', '', '',
6626         'to_addr', 'varchar', 'NULL',     255, '', '',
6627       ],
6628       'primary_key'  => 'logemailnum',
6629       'unique'       => [],
6630       'index'        => [ ['context'], ['min_level'] ],
6631       'foreign_keys' => [
6632                           { columns    => [ 'msgnum' ],
6633                             table      => 'msg_template',
6634                             references => [ 'msgnum' ],
6635                           },
6636                         ],
6637     },
6638
6639     'svc_alarm' => {
6640       'columns' => [
6641 #       name               type        null   length   default local
6642         'svcnum',          'int',      '',    '',      '',     '',
6643         'alarmsystemnum',  'int',      '',    '',      '',     '',
6644         'alarmtypenum',    'int',      '',    '',      '',     '',
6645         'alarmstationnum', 'int',      '',    '',      '',     '',
6646         'acctnum',         'varchar',  '',    $char_d, '',     '',
6647         '_password',       'varchar',  '',    $char_d, '',     '',
6648         'location',        'varchar', 'NULL', $char_d, '',     '',
6649         'cs_receiver',     'int',     'NULL', '',      '',     '',
6650         'cs_phonenum',     'varchar', 'NULL', $char_d, '',     '',
6651         'serialnum',       'varchar', 'NULL', $char_d, '',     '',
6652         #installer (rep)
6653       ],
6654       'primary_key'  => 'svcnum',
6655       'unique'       => [],
6656       'index'        => [],
6657       'foreign_keys' => [
6658                           { columns    => [ 'svcnum' ],
6659                             table      => 'cust_svc',
6660                           },
6661                           { columns    => [ 'alarmsystemnum' ],
6662                             table      => 'alarm_system',
6663                           },
6664                           { columns    => [ 'alarmtypenum' ],
6665                             table      => 'alarm_type',
6666                           },
6667                           { columns    => [ 'alarmstationnum' ],
6668                             table      => 'alarm_station',
6669                           },
6670                         ],
6671     },
6672
6673     'alarm_system' => { #vendors
6674       'columns' => [
6675         'alarmsystemnum',  'serial',     '',      '', '', '',
6676         'agentnum',           'int', 'NULL',      '', '', '',
6677         'systemname',     'varchar',     '', $char_d, '', '',
6678         'disabled',          'char', 'NULL',       1, '', '',
6679       ],
6680       'primary_key' => 'alarmsystemnum',
6681       'unique'      => [ ['agentnum', 'systemname'] ],
6682       'index'       => [ ['agentnum'], ['disabled'] ],
6683       'foreign_keys' => [
6684                           { columns    => [ 'agentnum' ],
6685                             table      => 'agent',
6686                           },
6687                         ],
6688     },
6689
6690     'alarm_type' => { #inputs and outputs
6691       'columns' => [
6692         'alarmtypenum', 'serial',     '',      '', '', '',
6693         'agentnum',        'int', 'NULL',      '', '', '',
6694         'inputs',          'int',     '', '', '', '',
6695         'outputs',         'int',     '', '', '', '',
6696         'disabled',       'char', 'NULL',       1, '', '',
6697       ],
6698       'primary_key' => 'alarmtypenum',
6699       'unique'      => [ ['agentnum', 'inputs', 'outputs'] ],
6700       'index'       => [ ['agentnum'], ['disabled'] ],
6701       'foreign_keys' => [
6702                           { columns    => [ 'agentnum' ],
6703                             table      => 'agent',
6704                           },
6705                         ],
6706     },
6707
6708     'alarm_station' => { #central station (where the alarm reports to)
6709       'columns' => [
6710         'alarmstationnum', 'serial',     '',      '', '', '',
6711         'agentnum',           'int', 'NULL',      '', '', '',
6712         'stationname',    'varchar',     '', $char_d, '', '',
6713         'disabled',          'char', 'NULL',       1, '', '',
6714       ],
6715       'primary_key' => 'alarmstationnum',
6716       'unique'      => [ ['agentnum', 'stationname'], ],
6717       'index'       => [ ['agentnum'], ['disabled'] ],
6718       'foreign_keys' => [
6719                           { columns    => [ 'agentnum' ],
6720                             table      => 'agent',
6721                           },
6722                         ],
6723     },
6724
6725     'svc_cable' => {
6726       'columns' => [
6727         'svcnum',        'int',     '',      '', '', '',
6728         'providernum',   'int', 'NULL',      '', '', '',
6729         'ordernum',  'varchar', 'NULL', $char_d, '', '',
6730         'modelnum',      'int', 'NULL',      '', '', '',
6731         'serialnum', 'varchar', 'NULL', $char_d, '', '',
6732         'mac_addr',  'varchar', 'NULL',      12, '', '',
6733       ],
6734       'primary_key'  => 'svcnum',
6735       'unique'       => [ ['serialnum'] , ['mac_addr'] ],
6736       'index'        => [],
6737       'foreign_keys' => [
6738                           { columns    => [ 'svcnum' ],
6739                             table      => 'cust_svc',
6740                           },
6741                           { columns    => [ 'providernum' ],
6742                             table      => 'cable_provider',
6743                           },
6744                           { columns    => [ 'modelnum' ],
6745                             table      => 'cable_model',
6746                           },
6747                         ],
6748     },
6749
6750     'cable_model' => {
6751       'columns' => [
6752         'modelnum',    'serial',     '',      '', '', '',
6753         'model_name', 'varchar',     '', $char_d, '', '',
6754         'disabled',      'char', 'NULL',       1, '', '',
6755       ],
6756       'primary_key' => 'modelnum',
6757       'unique' => [ [ 'model_name' ], ],
6758       'index'  => [],
6759     },
6760
6761     'cable_provider' => {
6762       'columns' => [
6763         'providernum', 'serial',     '',      '', '', '',
6764         'provider',   'varchar',     '', $char_d, '', '',
6765         'disabled',      'char', 'NULL',       1, '', '',
6766       ],
6767       'primary_key' => 'providernum',
6768       'unique' => [ [ 'provider' ], ],
6769       'index'  => [],
6770     },
6771
6772     'svc_conferencing' => {
6773       'columns' => [
6774         'svcnum',            'int',     '',      '', '', '',
6775         'conf_id',           'int', 'NULL',      '', '', '', #"system assigned"
6776         'conf_name',     'varchar',     '', $char_d, '', '',
6777         'conf_password', 'varchar',     '', $char_d, '', '',
6778         'access_code',   'varchar',     '',      16, '', '',
6779         'duration',          'int',     '',      '', '', '',
6780         'participants',      'int',     '',      '', '', '',
6781         'conftypenum',       'int',     '',      '', '', '',
6782         'confqualitynum',    'int',     '',      '', '', '',
6783         'opt_recording',    'char', 'NULL',       1, '', '',
6784         'opt_sip',          'char', 'NULL',       1, '', '',
6785         'opt_phone',        'char', 'NULL',       1, '', '',
6786       ],
6787       'primary_key' => 'svcnum',
6788       'unique' => [],
6789       'index'  => [],
6790       'foreign_keys' => [
6791                           { columns => [ 'svcnum' ],
6792                             table   => 'cust_svc',
6793                           },
6794                           { columns => [ 'conftypenum' ],
6795                             table   => 'conferencing_type',
6796                           },
6797                           { columns => [ 'confqualitynum' ],
6798                             table   => 'conferencing_quality',
6799                           },
6800                         ],
6801     },
6802
6803     'conferencing_type' => {
6804       'columns' => [
6805         'conftypenum',  'int',     '',      '', '', '',
6806         'typeid'      , 'int',     '',      '', '', '',
6807         'typename', 'varchar',     '', $char_d, '', '',
6808         'disabled',    'char', 'NULL',       1, '', '',
6809       ],
6810       'primary_key' => 'conftypenum',
6811       'unique'      => [ [ 'typeid', 'disabled' ], [ 'typename', 'disabled' ] ],
6812       'index'       => [],
6813     },
6814
6815     'conferencing_quality' => {
6816       'columns' => [
6817         'confqualitynum',  'int',     '',      '', '', '',
6818         'qualityid'      , 'int',     '',      '', '', '',
6819         'qualityname', 'varchar',     '', $char_d, '', '',
6820         'disabled',       'char', 'NULL',       1, '', '',
6821       ],
6822       'primary_key' => 'confqualitynum',
6823       'unique'      => [ [ 'qualityid', 'disabled' ], [ 'qualityname', 'disabled' ] ],
6824       'index'       => [],
6825     },
6826
6827     'svc_video' => {
6828       'columns' => [
6829         'svcnum',            'int', '', '', '', '',
6830         'smartcard_num', 'varchar', '', 16, '', '',
6831         'mac_addr',      'varchar', '', 12, '', '',
6832         'duration',          'int', '', '', '', '',
6833       ],
6834       'primary_key' => 'svcnum',
6835       'unique' => [], # [ 'smartcard_num' ], [ 'mac_addr' ], ],
6836       'index'  => [],
6837       'foreign_keys' => [
6838                           { columns => [ 'svcnum' ],
6839                             table   => 'cust_svc',
6840                           },
6841                         ],
6842     },
6843
6844     'circuit_type' => {
6845       'columns' => [
6846         'typenum',     'serial',     '',      '', '', '',
6847         'typename',   'varchar',     '', $char_d, '', '',
6848         'disabled',      'char', 'NULL',       1, '', '',
6849         # speed? number of voice lines? anything else?
6850       ],
6851       'primary_key' => 'typenum',
6852       'unique' => [ [ 'typename' ] ],
6853       'index'  => [],
6854     },
6855
6856     'circuit_provider' => {
6857       'columns' => [
6858         'providernum', 'serial',     '',      '', '', '',
6859         'provider',   'varchar',     '', $char_d, '', '',
6860         'disabled',      'char', 'NULL',       1, '', '',
6861       ],
6862       'primary_key' => 'providernum',
6863       'unique' => [ [ 'provider' ], ],
6864       'index'  => [],
6865     },
6866
6867     'circuit_termination' => {
6868       'columns' => [
6869         'termnum',     'serial',     '',      '', '', '',
6870         'termination','varchar',     '', $char_d, '', '',
6871         'disabled',      'char', 'NULL',       1, '', '',
6872       ],
6873       'primary_key' => 'termnum',
6874       'unique' => [ [ 'termination' ] ],
6875       'index' => [],
6876     },
6877
6878     'svc_circuit' => {
6879       'columns' => [
6880         'svcnum',                   'int',     '', '', '', '',
6881         'typenum',                  'int',     '', '', '', '',
6882         'providernum',              'int',     '', '', '', '',
6883         'termnum',                  'int',     '', '', '', '',
6884         'circuit_id',           'varchar',     '', 64, '', '',
6885         'desired_due_date',         'int', 'NULL', '', '', '',
6886         'due_date',                 'int', 'NULL', '', '', '',
6887         'vendor_order_id',      'varchar', 'NULL', $char_d,  '', '',
6888         'vendor_qual_id',       'varchar', 'NULL', $char_d,  '', '',
6889         'vendor_order_type',    'varchar', 'NULL', $char_d,  '', '',
6890         'vendor_order_status',  'varchar', 'NULL', $char_d,  '', '',
6891         'endpoint_ip_addr',     'varchar', 'NULL', 40, '', '',
6892         'endpoint_mac_addr',    'varchar', 'NULL', 12, '', '',
6893       ],
6894       'primary_key' => 'svcnum',
6895       'unique'      => [],
6896       'index'       => [ [ 'providernum' ], [ 'typenum' ] ],
6897       'foreign_keys' => [
6898                           { columns => [ 'svcnum' ],
6899                             table   => 'cust_svc',
6900                           },
6901                           { columns => [ 'typenum' ],
6902                             table   => 'circuit_type',
6903                           },
6904                           { columns => [ 'providernum' ],
6905                             table   => 'circuit_provider',
6906                           },
6907                           { columns => [ 'termnum' ],
6908                             table   => 'circuit_termination',
6909                           },
6910       ],
6911     },
6912
6913     'svc_fiber' => {
6914       'columns' => [
6915         'svcnum',         'int',     '',      '', '', '',
6916         'oltnum',         'int', 'NULL',      '', '', '',
6917         'shelf',          'int', 'NULL',      '', '', '',
6918         'card',           'int', 'NULL',      '', '', '',
6919         'olt_port',       'int', 'NULL',      '', '', '',
6920         'ont_id',         'int', 'NULL',      '', '', '',
6921         'ont_typenum',    'int', 'NULL',      '', '', '',
6922         'ont_serial', 'varchar', 'NULL', $char_d, '', '',
6923         'ont_port',   'varchar', 'NULL',      16, '', '',
6924         'circuit_id', 'varchar', 'NULL', $char_d, '', '',
6925         'vlan',           'int', 'NULL',      '', '', '',
6926         'signal',     'decimal', 'NULL',  '10,2', '', '',
6927         'speed_up',       'int', 'NULL',      '', '', '',
6928         'speed_down',     'int', 'NULL',      '', '', '',
6929         'ont_install','varchar', 'NULL', $char_d, '', '',
6930       ],
6931       'primary_key' => 'svcnum',
6932       'unique'      => [ ],
6933       'index'       => [ [ 'ont_serial' ] ],
6934       'foreign_keys' => [
6935                           { columns => [ 'svcnum' ],
6936                             table   => 'cust_svc',
6937                           },
6938                           { columns => [ 'oltnum' ],
6939                             table   => 'fiber_olt',
6940                           },
6941                           { columns => [ 'ont_typenum' ],
6942                             table   => 'hardware_type',
6943                             references => [ 'typenum' ],
6944                           },
6945                         ],
6946     },
6947
6948     'fiber_olt' => {
6949       'columns' => [
6950         'oltnum',   'serial', '',       '', '', '',
6951         'oltname', 'varchar', '',  $char_d, '', '',
6952         'sitenum',     'int', 'NULL',   '', '', '',
6953         'serial',  'varchar', '',  $char_d, '', '',
6954         'disabled',   'char', 'NULL',    1, '', '',
6955       ],
6956       'primary_key' => 'oltnum',
6957       'unique' => [ ],
6958       'index'  => [ ],
6959       'foreign_keys' => [
6960                           { columns => [ 'sitenum' ],
6961                             table   => 'olt_site',
6962                           },
6963                         ],
6964     },
6965
6966     'olt_site' => {
6967       'columns' => [
6968         'sitenum',  'serial', '',      '', '', '',
6969         'market',  'varchar', '', $char_d, '', '',
6970         'site',    'varchar', '', $char_d, '', '',
6971       ],
6972       'primary_key' => 'sitenum',
6973       'unique' => [ [ 'market', 'site' ] ],
6974       'index' => [ ],
6975     },
6976
6977
6978
6979
6980
6981     'vend_main' => {
6982       'columns' => [
6983         'vendnum',   'serial',     '',      '', '', '',
6984         'vendname', 'varchar',     '', $char_d, '', '',
6985         'classnum',     'int',     '',      '', '', '',
6986         'disabled',    'char', 'NULL',       1, '', '',
6987       ],
6988       'primary_key'  => 'vendnum',
6989       'unique'       => [ ['vendname', 'disabled'] ],
6990       'index'        => [],
6991       'foreign_keys' => [
6992                           { columns    => [ 'classnum' ],
6993                             table      => 'vend_class',
6994                           },
6995                         ],
6996     },
6997
6998     'vend_class' => {
6999       'columns' => [
7000         'classnum',     'serial',     '',      '', '', '',
7001         'classname',   'varchar',     '', $char_d, '', '',
7002         'disabled',       'char', 'NULL',       1, '', '',
7003       ],
7004       'primary_key' => 'classnum',
7005       'unique'      => [],
7006       'index'       => [ ['disabled'] ],
7007     },
7008
7009     'vend_bill' => {
7010       'columns' => [
7011         'vendbillnum',    'serial',     '',      '', '', '',
7012         'vendnum',           'int',     '',      '', '', '',
7013         #'_date',        @date_type,                  '', '',
7014         '_date',     'int', '', '',                   '', '',
7015         'charged',     @money_type,                  '', '',
7016       ],
7017       'primary_key'  => 'vendbillnum',
7018       'unique'       => [],
7019       'index'        => [ ['vendnum'], ['_date'], ],
7020       'foreign_keys' => [
7021                           { columns    => [ 'vendnum' ],
7022                             table      => 'vend_main',
7023                           },
7024                         ],
7025     },
7026
7027     'vend_pay' => {
7028       'columns' => [
7029         'vendpaynum',   'serial',    '',       '', '', '',
7030         'vendnum',         'int',    '',       '', '', '',
7031         #'_date',     @date_type,                   '', '',
7032         '_date',     'int', '', '',                   '', '',
7033         'paid',      @money_type,                  '', '',
7034       ],
7035       'primary_key'  => 'vendpaynum',
7036       'unique'       => [],
7037       'index'        => [ [ 'vendnum' ], [ '_date' ], ],
7038       'foreign_keys' => [
7039                           { columns    => [ 'vendnum' ],
7040                             table      => 'vend_main',
7041                           },
7042                         ],
7043     },
7044
7045     'vend_bill_pay' => {
7046       'columns' => [
7047         'vendbillpaynum', 'serial',     '',   '', '', '',
7048         'vendbillnum',       'int',     '',   '', '', '',
7049         'vendpaynum',        'int',     '',   '', '', '',
7050         'amount',  @money_type, '', '',
7051         #? '_date',   @date_type, '', '',
7052       ],
7053       'primary_key'  => 'vendbillpaynum',
7054       'unique'       => [],
7055       'index'        => [ [ 'vendbillnum' ], [ 'vendpaynum' ] ],
7056       'foreign_keys' => [
7057                           { columns    => [ 'vendbillnum' ],
7058                             table      => 'vend_bill',
7059                           },
7060                           { columns    => [ 'vendpaynum' ],
7061                             table      => 'vend_pay',
7062                           },
7063                         ],
7064     },
7065
7066     %{ tables_hashref_torrus() },
7067
7068     # tables of ours for doing torrus virtual port combining
7069     'torrus_srvderive' => {
7070       'columns' => [
7071         'derivenum',     'serial',     '', '', '', '',
7072         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
7073         'last_srv_date',   'date', 'NULL', '', '', '',
7074       ],
7075       'primary_key' => 'derivenum',
7076       'unique' => [ ['serviceid'] ],
7077       'index'  => [],
7078     },
7079
7080     'torrus_srvderive_component' => {
7081       'columns' => [
7082         'componentnum', 'serial', '', '', '', '',
7083         'derivenum',       'int', '', '', '', '',
7084         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
7085       ],
7086       'primary_key'  => 'componentnum',
7087       'unique'       => [ [ 'derivenum', 'serviceid' ], ],
7088       'index'        => [ [ 'derivenum', ], ],
7089       'foreign_keys' => [
7090                           { columns    => [ 'derivenum' ],
7091                             table      => 'torrus_srvderive',
7092                           },
7093                         ],
7094     },
7095
7096     'invoice_mode' => {
7097       'columns' => [
7098         'modenum',      'serial', '', '', '', '',
7099         'agentnum',        'int', 'NULL', '', '', '',
7100         'modename',    'varchar', '', 32, '', '',
7101       ],
7102       'primary_key' => 'modenum',
7103       'unique'      => [ ],
7104       'index'       => [ ],
7105       'foreign_keys' => [
7106                           { columns    => [ 'agentnum' ],
7107                             table      => 'agent',
7108                           },
7109                         ],
7110     },
7111
7112     'invoice_conf' => {
7113       'columns' => [
7114         'confnum',              'serial',   '', '', '', '',
7115         'modenum',              'int',      '', '', '', '',
7116         'locale',               'varchar',  'NULL', 16, '', '',
7117         'notice_name',          'varchar',  'NULL', 64, '', '',
7118         'subject',              'varchar',  'NULL', 64, '', '',
7119         'htmlnotes',            'text',     'NULL', '', '', '',
7120         'htmlfooter',           'text',     'NULL', '', '', '',
7121         'htmlsummary',          'text',     'NULL', '', '', '',
7122         'htmlreturnaddress',    'text',     'NULL', '', '', '',
7123         'latexnotes',           'text',     'NULL', '', '', '',
7124         'latexfooter',          'text',     'NULL', '', '', '',
7125         'latexsummary',         'text',     'NULL', '', '', '',
7126         'latexsmallfooter',     'text',     'NULL', '', '', '',
7127         'latexreturnaddress',   'text',     'NULL', '', '', '',
7128         'with_latexcoupon',     'char',     'NULL', '1', '', '',
7129         'htmlwatermark',        'text',     'NULL', '', '', '',
7130         'latexwatermark',       'text',     'NULL', '', '', '',
7131         'lpr',                  'varchar',  'NULL', $char_d, '', '',
7132       ],
7133       'primary_key'  => 'confnum',
7134       'unique'       => [ [ 'modenum', 'locale' ] ],
7135       'index'        => [ ],
7136       'foreign_keys' => [
7137                           { columns    => [ 'modenum' ],
7138                             table      => 'invoice_mode',
7139                           },
7140                         ],
7141     },
7142
7143     'export_batch' => {
7144       'columns' => [
7145         'batchnum',    'serial',     '',      '', '', '',
7146         'exportnum',      'int',     '',      '', '', '',
7147         '_date',          'int',     '',      '', '', '',
7148         'status',     'varchar', 'NULL',      32, '', '',
7149         'statustext',    'text', 'NULL',      '', '', '',
7150       ],
7151       'primary_key'  => 'batchnum',
7152       'unique'       => [],
7153       'index'        => [ [ 'exportnum' ], [ 'status' ] ],
7154       'foreign_keys' => [
7155                           { columns    => [ 'exportnum' ],
7156                             table      => 'part_export',
7157                             references => [ 'exportnum' ]
7158                           },
7159                         ],
7160     },
7161
7162     'export_batch_item' => {
7163       'columns' => [
7164         'itemnum',     'serial',     '',      '', '', '',
7165         'batchnum',       'int',     '',      '', '', '',
7166         'svcnum',         'int',     '',      '', '', '',
7167         'action',     'varchar',     '',      32, '', '',
7168         'data',          'text', 'NULL',      '', '', '',
7169         'frozen',        'char', 'NULL',       1, '', '',
7170       ],
7171       'primary_key'  => 'itemnum',
7172       'unique'       => [],
7173       'index'        => [ [ 'batchnum' ], [ 'svcnum' ] ],
7174       'foreign_keys' => [
7175                           { columns    => [ 'batchnum' ],
7176                             table      => 'export_batch',
7177                             references => [ 'batchnum' ]
7178                           },
7179                         ],
7180     },
7181
7182     # lookup table for states, similar to msa and lata
7183     'state' => {
7184       'columns' => [
7185         'statenum', 'int',  '', '', '', '',
7186         'country',  'char', '',  2, '', '',
7187         'state',    'char', '', $char_d, '', '',
7188         'fips',     'char', '',  3, '', '',
7189       ],
7190       'primary_key' => 'statenum',
7191       'unique' => [ [ 'country', 'state' ], ],
7192       'index' => [],
7193     },
7194
7195     # eventually link to tower/sector?
7196     'deploy_zone' => {
7197       'columns' => [
7198         'zonenum',        'serial',  '',     '',      '', '',
7199         'description',    'char',    'NULL', $char_d, '', '',
7200         'agentnum',       'int',     '',     '',      '', '',
7201         'censusyear',     'char',    'NULL', 4,      '', '',
7202         'dbaname',        'char',    'NULL', $char_d, '', '',
7203         'zonetype',       'char',    '',     1,       '', '',
7204         'technology',     'int',     '',     '',      '', '',
7205         'spectrum',       'int',     'NULL', '',      '', '',
7206         'adv_speed_up',   'decimal', '',     '10,3', '0', '',
7207         'adv_speed_down', 'decimal', '',     '10,3', '0', '',
7208         'cir_speed_up',   'decimal', '',     '10,3', '0', '',
7209         'cir_speed_down', 'decimal', '',     '10,3', '0', '',
7210         'is_broadband',   'char',    'NULL', 1,       '', '',
7211         'is_voice',       'char',    'NULL', 1,       '', '',
7212         'is_consumer',    'char',    'NULL', 1,       '', '',
7213         'is_business',    'char',    'NULL', 1,       '', '',
7214         'active_date',    @date_type,                 '', '',
7215         'expire_date',    @date_type,                 '', '',
7216       ],
7217       'primary_key' => 'zonenum',
7218       'unique' => [],
7219       'index'  => [ [ 'agentnum' ] ],
7220       'foreign_keys' => [
7221                           { columns     => [ 'agentnum' ],
7222                             table       => 'agent',
7223                             references  => [ 'agentnum' ],
7224                           },
7225                         ],
7226     },
7227
7228     'deploy_zone_block' => {
7229       'columns' => [
7230         'blocknum',       'serial',  '',     '',      '', '',
7231         'zonenum',        'int',     '',     '',      '', '',
7232         'censusblock',    'char',    '',     15,      '', '',
7233         'censusyear',     'char','NULL',      4,      '', '',
7234       ],
7235       'primary_key' => 'blocknum',
7236       'unique' => [],
7237       'index'  => [ [ 'zonenum' ] ],
7238       'foreign_keys' => [
7239                           { columns     => [ 'zonenum' ],
7240                             table       => 'deploy_zone',
7241                             references  => [ 'zonenum' ],
7242                           },
7243                         ],
7244     },
7245
7246     'deploy_zone_vertex' => {
7247       'columns' => [
7248         'vertexnum',      'serial',  '',     '',      '', '',
7249         'zonenum',        'int',     '',     '',      '', '',
7250         'latitude',       'decimal', '',     '10,7',  '', '',
7251         'longitude',      'decimal', '',     '10,7',  '', '',
7252       ],
7253       'primary_key' => 'vertexnum',
7254       'unique' => [ ],
7255       'index'  => [ ],
7256       'foreign_keys' => [
7257                           { columns     => [ 'zonenum' ],
7258                             table       => 'deploy_zone',
7259                             references  => [ 'zonenum' ],
7260                           },
7261                         ],
7262     },
7263
7264     'cacti_page' => {
7265       'columns' => [
7266         'cacti_pagenum',  'serial',   '',     '', '', '',
7267         'exportnum',      'int',      'NULL', '', '', '',
7268         'svcnum',         'int',      'NULL', '', '', '',
7269         'graphnum',       'int',      'NULL', '', '', '',
7270         'imported',       @date_type,             '', '',
7271         'content',        'text',     'NULL', '', '', '',
7272       ],
7273       'primary_key' => 'cacti_pagenum',
7274       'unique'  => [ ],
7275       'index'   => [ ['svcnum'], ['imported'] ],
7276       'foreign_keys' => [
7277                           { columns    => [ 'svcnum' ],
7278                             table      => 'cust_svc',
7279                             references => [ 'svcnum' ],
7280                           },
7281                           { columns    => [ 'exportnum' ],
7282                             table      => 'part_export',
7283                             references => [ 'exportnum' ],
7284                           },
7285                         ],
7286     },
7287
7288     'report_batch' => {
7289       'columns' => [
7290         'reportbatchnum', 'serial',      '',  '', '', '',
7291         'reportname',     'varchar',     '', 255, '', '',
7292         'agentnum',           'int', 'NULL',  '', '', '',
7293         'send_date',     @date_type,              '', '',
7294         'sdate',         @date_type,              '', '',
7295         'edate',         @date_type,              '', '',
7296         'usernum',            'int', 'NULL',  '', '', '',
7297         'msgnum',             'int', 'NULL',  '', '', '',
7298         # add report params here as necessary
7299       ],
7300       'primary_key' => 'reportbatchnum',
7301       'unique' => [],
7302       'index'  => [],
7303       'foreign_keys' => [
7304                           { columns    => [ 'agentnum' ],
7305                             table      => 'agent',
7306                             references => [ 'agentnum' ],
7307                           },
7308                           { columns    => [ 'usernum' ],
7309                             table      => 'access_user',
7310                             references => [ 'usernum' ],
7311                           },
7312                           { columns    => [ 'msgnum' ],
7313                             table      => 'msg_template',
7314                             references => [ 'msgnum' ],
7315                           },
7316                         ],
7317     },
7318
7319     'password_history' => {
7320       'columns' => [
7321         'passwordnum',        'serial',  '',          '', '', '',
7322         '_password',          'varchar', 'NULL', $char_d, '', '',
7323         'encryption_method',  'varchar', 'NULL', $char_d, '', '',
7324         'created',   @date_type,   '', '',
7325         # each table that needs password history gets a column here, and
7326         # an entry in foreign_keys.
7327         'svc_acct__svcnum',     'int', 'NULL', '', '', '',
7328         'svc_dsl__svcnum',      'int', 'NULL', '', '', '',
7329         'svc_alarm__svcnum',    'int', 'NULL', '', '', '',
7330         'agent__agentnum',      'int', 'NULL', '', '', '',
7331         'contact__contactnum',  'int', 'NULL', '', '', '',
7332         'access_user__usernum', 'int', 'NULL', '', '', '',
7333       ],
7334       'primary_key' => 'passwordnum',
7335       'unique' => [],
7336       'index'  => [],
7337       'foreign_keys' => [
7338                           { columns     => [ 'svc_acct__svcnum' ],
7339                             table       => 'svc_acct',
7340                             references  => [ 'svcnum' ],
7341                           },
7342                           { columns     => [ 'svc_dsl__svcnum' ],
7343                             table       => 'svc_dsl',
7344                             references  => [ 'svcnum' ],
7345                           },
7346                           { columns     => [ 'svc_alarm__svcnum' ],
7347                             table       => 'svc_alarm',
7348                             references  => [ 'svcnum' ],
7349                           },
7350                           { columns    => [ 'agent__agentnum' ],
7351                             table      => 'agent',
7352                             references => [ 'agentnum' ],
7353                           },
7354                           { columns    => [ 'contact__contactnum' ],
7355                             table      => 'contact',
7356                             references => [ 'contactnum' ],
7357                           },
7358                           { columns    => [ 'access_user__usernum' ],
7359                             table      => 'access_user',
7360                             references => [ 'usernum' ],
7361                           },
7362                         ],
7363     },
7364
7365     'webservice_log' => {
7366       'columns' => [
7367         'webservicelognum',    'serial',      '',      '', '', '', #big? hubrus
7368         'svcnum',                 'int',  'NULL',      '', '', '', #just in case
7369         'custnum',                'int',      '',      '', '', '',
7370         'method',             'varchar',      '', $char_d, '', '',
7371         'quantity',               'int',      '',      '', '', '', #i.e. pages
7372         '_date',             @date_type,                   '', '',
7373         'status',             'varchar',  'NULL', $char_d, '', '',
7374         'rated_price',        'decimal',  'NULL',  '10,2', '', '',
7375       ],
7376       'primary_key'  => 'webservicelognum',
7377       'unique'       => [],
7378       'index'        => [ ['custnum'], ['status'] ],
7379       'foreign_keys' => [
7380                           { columns => [ 'custnum' ],
7381                             table   => 'cust_main',
7382                           },
7383                           #no FK on svcnum... we don't want to purge these on
7384                           # service deletion
7385                         ],
7386     },
7387
7388     # name type nullability length default local
7389
7390     #'new_table' => {
7391     #  'columns' => [
7392     #    'num', 'serial',       '', '', '', '',
7393     #  ],
7394     #  'primary_key' => 'num',
7395     #  'unique' => [],
7396     #  'index'  => [],
7397     #},
7398
7399   };
7400
7401 }
7402
7403 =back
7404
7405 =head1 BUGS
7406
7407 =head1 SEE ALSO
7408
7409 L<DBIx::DBSchema>
7410
7411 =cut
7412
7413 1;
7414