FS/FS/Schema.pm

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