FS/FS/Schema.pm

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