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