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         #downtilt etc? rfpath has profile files for devices/antennas you upload?
4849         'sector_range', 'decimal', 'NULL',      '', '', '',  #?
4850       ],
4851       'primary_key'  => 'sectornum',
4852       'unique'       => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
4853       'index'        => [ [ 'towernum' ] ],
4854       'foreign_keys' => [
4855                           { columns    => [ 'towernum' ],
4856                             table      => 'tower',
4857                           },
4858                         ],
4859     },
4860
4861     'part_virtual_field' => {
4862       'columns' => [
4863         'vfieldpart', 'serial', '', '', '', '',
4864         'dbtable', 'varchar', '', 32, '', '',
4865         'name', 'varchar', '', 32, '', '',
4866         'length', 'int', 'NULL', '', '', '',
4867         'label', 'varchar', 'NULL', 80, '', '',
4868       ],
4869       'primary_key' => 'vfieldpart',
4870       'unique' => [],
4871       'index' => [],
4872     },
4873
4874     'virtual_field' => {
4875       'columns' => [
4876         'vfieldnum', 'serial', '', '', '', '',
4877         'recnum', 'int', '', '', '', '',
4878         'vfieldpart', 'int', '', '', '', '',
4879         'value', 'varchar', '', 128, '', '',
4880       ],
4881       'primary_key'  => 'vfieldnum',
4882       'unique'       => [ [ 'vfieldpart', 'recnum' ] ],
4883       'index'        => [],
4884       'foreign_keys' => [
4885                           { columns    => [ 'vfieldpart' ],
4886                             table      => 'part_virtual_field',
4887                           },
4888                         ],
4889     },
4890
4891     'acct_snarf' => {
4892       'columns' => [
4893         'snarfnum',    'serial',     '',      '', '', '',
4894         'snarfname',  'varchar', 'NULL', $char_d, '', '',
4895         'svcnum',         'int',     '',      '', '', '',
4896         'machine',    'varchar',     '',     255, '', '',
4897         'protocol',   'varchar',     '', $char_d, '', '',
4898         'username',   'varchar',     '', $char_d, '', '',
4899         '_password',  'varchar',     '', $char_d, '', '',
4900         'check_freq',     'int', 'NULL',      '', '', '',
4901         'leavemail',     'char', 'NULL',       1, '', '',
4902         'apop',          'char', 'NULL',       1, '', '',
4903         'tls',           'char', 'NULL',       1, '', '',
4904         'mailbox',    'varchar', 'NULL', $char_d, '', '',
4905       ],
4906       'primary_key'  => 'snarfnum',
4907       'unique'       => [],
4908       'index'        => [ [ 'svcnum' ] ],
4909       'foreign_keys' => [
4910                           { columns    => [ 'svcnum' ],
4911                             table      => 'svc_acct',
4912                           },
4913                         ],
4914     },
4915
4916     'svc_external' => {
4917       'columns' => [
4918         'svcnum',     'int',     '',      '', '', '',
4919         'id',      'bigint', 'NULL',      '', '', '',
4920         'title',  'varchar', 'NULL', $char_d, '', '',
4921       ],
4922       'primary_key'  => 'svcnum',
4923       'unique'       => [],
4924       'index'        => [],
4925       'foreign_keys' => [
4926                           { columns    => [ 'svcnum' ],
4927                             table      => 'cust_svc',
4928                           },
4929                         ],
4930     },
4931
4932     'cust_pay_refund' => {
4933       'columns' => [
4934         'payrefundnum', 'serial', '', '', '', '',
4935         'paynum',  'int', '', '', '', '',
4936         'refundnum',  'int', '', '', '', '',
4937         '_date',    @date_type, '', '',
4938         'amount',   @money_type, '', '',
4939       ],
4940       'primary_key'  => 'payrefundnum',
4941       'unique'       => [],
4942       'index'        => [ ['paynum'], ['refundnum'] ],
4943       'foreign_keys' => [
4944                           { columns    => [ 'paynum' ],
4945                             table      => 'cust_pay',
4946                           },
4947                           { columns    => [ 'refundnum' ],
4948                             table      => 'cust_refund',
4949                           },
4950                         ],
4951     },
4952
4953     'part_pkg_option' => {
4954       'columns' => [
4955         'optionnum', 'serial', '', '', '', '',
4956         'pkgpart', 'int', '', '', '', '',
4957         'optionname', 'varchar', '', $char_d, '', '',
4958         'optionvalue', 'text', 'NULL', '', '', '',
4959       ],
4960       'primary_key'  => 'optionnum',
4961       'unique'       => [],
4962       'index'        => [ [ 'pkgpart' ], [ 'optionname' ] ],
4963       'foreign_keys' => [
4964                           { columns    => [ 'pkgpart' ],
4965                             table      => 'part_pkg',
4966                           },
4967                         ],
4968     },
4969
4970     'part_pkg_vendor' => {
4971       'columns' => [
4972         'num', 'serial', '', '', '', '',
4973         'pkgpart', 'int', '', '', '', '',
4974         'exportnum', 'int', '', '', '', '',
4975         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
4976       ],
4977       'primary_key'  => 'num',
4978       'unique'       => [ [ 'pkgpart', 'exportnum' ] ],
4979       'index'        => [ [ 'pkgpart' ] ],
4980       'foreign_keys' => [
4981                           { columns    => [ 'pkgpart' ],
4982                             table      => 'part_pkg',
4983                           },
4984                           { columns    => [ 'exportnum' ],
4985                             table      => 'part_export',
4986                           },
4987                         ],
4988     },
4989
4990     'part_pkg_report_option' => {
4991       'columns' => [
4992         'num',      'serial',   '',      '', '', '',
4993         'name',     'varchar',  '', $char_d, '', '',
4994         'disabled', 'char', 'NULL',       1, '', '',
4995       ],
4996       'primary_key' => 'num',
4997       'unique' => [ [ 'name' ] ],
4998       'index' => [ [ 'disabled' ] ],
4999     },
5000
5001     'part_pkg_usage' => {
5002       'columns' => [
5003         'pkgusagepart', 'serial',   '', '', '', '',
5004         'pkgpart',  'int',      '', '', '', '',
5005         'minutes',  'double precision',      '', '', '', '',
5006         'priority', 'int',  'NULL', '', '', '',
5007         'shared',   'char', 'NULL',  1, '', '',
5008         'rollover', 'char', 'NULL',  1, '', '',
5009         'description',  'varchar', 'NULL', $char_d, '', '',
5010       ],
5011       'primary_key'  => 'pkgusagepart',
5012       'unique'       => [],
5013       'index'        => [ [ 'pkgpart' ] ],
5014       'foreign_keys' => [
5015                           { columns    => [ 'pkgpart' ],
5016                             table      => 'part_pkg',
5017                           },
5018                         ],
5019     },
5020
5021     'part_pkg_usage_class' => {
5022       'columns' => [
5023         'num',       'serial',  '', '', '', '',
5024         'pkgusagepart', 'int',  '', '', '', '',
5025         'classnum',     'int','NULL', '', '', '',
5026       ],
5027       'primary_key'  => 'num',
5028       'unique'       => [ [ 'pkgusagepart', 'classnum' ] ],
5029       'index'        => [],
5030       'foreign_keys' => [
5031                           { columns    => [ 'pkgusagepart' ],
5032                             table      => 'part_pkg_usage',
5033                           },
5034                           { columns    => [ 'classnum' ],
5035                             table      => 'usage_class',
5036                           },
5037                         ],
5038     },
5039
5040     'part_pkg_fcc_option' => {
5041       'columns' => [
5042         'num',        'serial', '', '', '', '',
5043         'fccoptionname', 'varchar', '', $char_d, '', '',
5044         'pkgpart',       'int', '', '', '', '',
5045         'optionvalue',   'varchar', 'NULL', $char_d, '', '',
5046       ],
5047       'primary_key' => 'num',
5048       'unique'      => [ [ 'fccoptionname', 'pkgpart' ] ],
5049       'index'       => [],
5050     },
5051
5052     'rate' => {
5053       'columns' => [
5054         'ratenum',          'serial',     '', '', '', '',
5055         'ratename',        'varchar', '',$char_d, '', '',
5056         'agentnum',            'int', 'NULL', '', '', '',
5057         'default_detailnum',   'int', 'NULL', '', '', '',
5058       ],
5059       'primary_key' => 'ratenum',
5060       'unique'      => [],
5061       'index'       => [],
5062       'foreign_keys' => [
5063                           { columns    => [ 'agentnum' ],
5064                             table      => 'agent',
5065                           },
5066                         ],
5067     },
5068
5069     'rate_detail' => {
5070       'columns' => [
5071         'ratedetailnum',   'serial',  '',     '',      '', '',
5072         'ratenum',         'int',     '',     '',      '', '',
5073         'orig_regionnum',  'int', 'NULL',     '',      '', '',
5074         'dest_regionnum',  'int', 'NULL',     '',      '', '',
5075         'min_included',    'int',     '',     '',      '', '',
5076         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
5077         'conn_cost',       'decimal', '', '10,4', '0.0000', '',
5078         'conn_sec',        'int',     '',     '',      '0', '',
5079         'min_charge',      'decimal', '', '10,5',       '', '',
5080         'min_cost',        'decimal', '', '10,5','0.00000', '',
5081         'sec_granularity', 'int',     '',     '',       '', '',
5082         'ratetimenum',     'int', 'NULL',     '',       '', '',
5083         'classnum',        'int', 'NULL',     '',       '', '',
5084         'cdrtypenum',      'int', 'NULL',     '',       '', '',
5085         'region_group',   'char', 'NULL',      1,       '', '',
5086         'upstream_mult_charge',  'decimal',  '', '10,4', '0.0000', '',
5087         'upstream_mult_cost',    'decimal',  '', '10,4', '0.0000', '',
5088       ],
5089       'primary_key'  => 'ratedetailnum',
5090       'unique'       => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
5091       'index'        => [ [ 'ratenum', 'dest_regionnum' ],
5092                           [ 'ratenum', 'ratetimenum' ]
5093                         ],
5094       'foreign_keys' => [
5095                           { columns    => [ 'ratenum' ],
5096                             table      => 'rate',
5097                           },
5098                           { columns    => [ 'orig_regionnum' ],
5099                             table      => 'rate_region',
5100                             references => [ 'regionnum' ],
5101                           },
5102                           { columns    => [ 'dest_regionnum' ],
5103                             table      => 'rate_region',
5104                             references => [ 'regionnum' ],
5105                           },
5106                           { columns    => [ 'ratetimenum' ],
5107                             table      => 'rate_time',
5108                           },
5109                           { columns    => [ 'classnum' ],
5110                             table      => 'usage_class',
5111                           },
5112                           { columns    => [ 'cdrtypenum' ],
5113                             table      => 'cdr_type',
5114                           },
5115                         ],
5116     },
5117
5118     'rate_region' => {
5119       'columns' => [
5120         'regionnum',   'serial',      '', '', '', '',
5121         'regionname',  'varchar',     '', $char_d, '', '',
5122         'exact_match', 'char',    'NULL',  1, '', '',
5123       ],
5124       'primary_key' => 'regionnum',
5125       'unique'      => [],
5126       'index'       => [],
5127     },
5128
5129     'rate_prefix' => {
5130       'columns' => [
5131         'prefixnum',   'serial',      '', '', '', '',
5132         'regionnum',   'int',         '', '', '', '',
5133         'countrycode', 'varchar',     '',  3, '', '',
5134         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
5135         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
5136         'latanum',     'int',     'NULL',      '', '', '',
5137         'state',       'char',    'NULL',       2, '', '',
5138         'ocn',         'char',    'NULL',       4, '', '',
5139       ],
5140       'primary_key'  => 'prefixnum',
5141       'unique'       => [],
5142       'index'        => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
5143       'foreign_keys' => [
5144                           { columns    => [ 'regionnum' ],
5145                             table      => 'rate_region',
5146                           },
5147                           { columns    => [ 'latanum' ],
5148                             table      => 'lata',
5149                           },
5150                         ],
5151     },
5152
5153     'rate_time' => {
5154       'columns' => [
5155         'ratetimenum', 'serial',      '',      '', '', '',
5156         'ratetimename',   'varchar',      '', $char_d, '', '',
5157       ],
5158       'primary_key' => 'ratetimenum',
5159       'unique'      => [],
5160       'index'       => [],
5161     },
5162
5163     'rate_time_interval' => {
5164       'columns' => [
5165         'intervalnum', 'serial', '', '', '', '',
5166         'stime',          'int', '', '', '', '',
5167         'etime',          'int', '', '', '', '',
5168         'ratetimenum',    'int', '', '', '', '',
5169       ],
5170       'primary_key'  => 'intervalnum',
5171       'unique'       => [],
5172       'index'        => [],
5173       'foreign_keys' => [
5174                           { columns    => [ 'ratetimenum' ],
5175                             table      => 'rate_time',
5176                           },
5177                         ],
5178      },
5179
5180     #not really part of the above rate_ stuff (used with flat rate rather than
5181     # rated billing), but could be eventually, and its a rate
5182     'rate_tier' => {
5183       'columns' => [
5184         'tiernum',   'serial', '',      '', '', '',
5185         'tiername', 'varchar', '', $char_d, '', '',
5186       ],
5187       'primary_key' => 'tiernum',
5188       'unique'      => [ [ 'tiername'], ],
5189       'index'       => [],
5190     },
5191
5192     'rate_tier_detail' => {
5193       'columns' => [
5194         'tierdetailnum', 'serial', '',     '', '', '',
5195         'tiernum',          'int', '',     '', '', '',
5196         'min_quan',         'int', '',     '', '', '',
5197         'min_charge',   'decimal', '', '10,4', '', '',
5198       ],
5199       'primary_key'  => 'tierdetailnum',
5200       'unique'       => [],
5201       'index'        => [ ['tiernum'], ],
5202       'foreign_keys' => [
5203                           { columns    => [ 'tiernum' ],
5204                             table      => 'rate_tier',
5205                           },
5206                         ],
5207     },
5208
5209     'usage_class' => {
5210       'columns' => [
5211         'classnum',    'serial',      '',      '', '', '',
5212         'weight',      'int',     'NULL',      '', '', '',
5213         'classname',   'varchar',     '', $char_d, '', '',
5214         'format',      'varchar', 'NULL', $char_d, '', '',
5215         'disabled',    'char',    'NULL',       1, '', '',
5216       ],
5217       'primary_key' => 'classnum',
5218       'unique' => [],
5219       'index' => [ ['disabled'] ],
5220     },
5221
5222     'reg_code' => {
5223       'columns' => [
5224         'codenum',   'serial',    '', '', '', '',
5225         'code',      'varchar',   '', $char_d, '', '',
5226         'agentnum',  'int',       '', '', '', '',
5227       ],
5228       'primary_key'  => 'codenum',
5229       'unique'       => [ [ 'agentnum', 'code' ] ],
5230       'index'        => [ [ 'agentnum' ] ],
5231       'foreign_keys' => [
5232                           { columns    => [ 'agentnum' ],
5233                             table      => 'agent',
5234                           },
5235                         ],
5236      },
5237
5238     'reg_code_pkg' => {
5239       'columns' => [
5240         'codepkgnum', 'serial', '', '', '', '',
5241         'codenum',   'int',    '', '', '', '',
5242         'pkgpart',   'int',    '', '', '', '',
5243       ],
5244       'primary_key'  => 'codepkgnum',
5245       'unique'       => [ [ 'codenum', 'pkgpart' ] ],
5246       'index'        => [ [ 'codenum' ] ],
5247       'foreign_keys' => [
5248                           { columns    => [ 'codenum' ],
5249                             table      => 'reg_code',
5250                           },
5251                           { columns    => [ 'pkgpart' ],
5252                             table      => 'part_pkg',
5253                           },
5254                         ],
5255     },
5256
5257     'clientapi_session' => {
5258       'columns' => [
5259         'sessionnum',  'serial',  '', '', '', '',
5260         'sessionid',  'varchar',  '', $char_d, '', '',
5261         'namespace',  'varchar',  '', $char_d, '', '',
5262       ],
5263       'primary_key' => 'sessionnum',
5264       'unique'      => [ [ 'sessionid', 'namespace' ] ],
5265       'index'       => [],
5266     },
5267
5268     'clientapi_session_field' => {
5269       'columns' => [
5270         'fieldnum',    'serial',     '', '', '', '',
5271         'sessionnum',     'int',     '', '', '', '',
5272         'fieldname',  'varchar',     '', $char_d, '', '',
5273         'fieldvalue',    'text', 'NULL', '', '', '',
5274       ],
5275       'primary_key'  => 'fieldnum',
5276       'unique'       => [ [ 'sessionnum', 'fieldname' ] ],
5277       'index'        => [],
5278       'foreign_keys' => [
5279                           { columns    => [ 'sessionnum' ],
5280                             table      => 'clientapi_session',
5281                           },
5282                         ],
5283     },
5284
5285     'payment_gateway' => {
5286       'columns' => [
5287         'gatewaynum',       'serial',   '',     '', '', '',
5288         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
5289         'gateway_module',   'varchar',  '',     $char_d, '', '',
5290         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
5291         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
5292         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
5293         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
5294         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
5295         'disabled',   'char',  'NULL',   1, '', '',
5296       ],
5297       'primary_key' => 'gatewaynum',
5298       'unique' => [],
5299       'index'  => [ [ 'disabled' ] ],
5300     },
5301
5302     'payment_gateway_option' => {
5303       'columns' => [
5304         'optionnum',   'serial',  '',     '', '', '',
5305         'gatewaynum',  'int',     '',     '', '', '',
5306         'optionname',  'varchar', '',     $char_d, '', '',
5307         'optionvalue', 'text',    'NULL', '', '', '',
5308       ],
5309       'primary_key'  => 'optionnum',
5310       'unique'       => [],
5311       'index'        => [ [ 'gatewaynum' ], [ 'optionname' ] ],
5312       'foreign_keys' => [
5313                           { columns    => [ 'gatewaynum' ],
5314                             table      => 'payment_gateway',
5315                           },
5316                         ],
5317     },
5318
5319     'agent_payment_gateway' => {
5320       'columns' => [
5321         'agentgatewaynum', 'serial', '', '', '', '',
5322         'agentnum',        'int', '', '', '', '',
5323         'gatewaynum',      'int', '', '', '', '',
5324         'cardtype',        'varchar', 'NULL', $char_d, '', '',
5325         'taxclass',        'varchar', 'NULL', $char_d, '', '',
5326       ],
5327       'primary_key'  => 'agentgatewaynum',
5328       'unique'       => [],
5329       'index'        => [ [ 'agentnum', 'cardtype' ], ],
5330
5331       'foreign_keys' => [
5332
5333                           { columns    => [ 'agentnum' ],
5334                             table      => 'agent',
5335                           },
5336                           { columns    => [ 'gatewaynum' ],
5337                             table      => 'payment_gateway',
5338                           },
5339                         ],
5340     },
5341
5342     'banned_pay' => {
5343       'columns' => [
5344         'bannum',        'serial',     '',      '', '', '',
5345         'payby',           'char',     '',       4, '', '',
5346         'payinfo',      'varchar',     '',     128, '', '', #say, a 512-big digest _hex encoded
5347         'payinfo_hash', 'varchar', 'NULL',      32, '', '',
5348         #'paymask',      'varchar',  'NULL', $char_d, '', ''
5349         '_date',                @date_type,         '', '',
5350         'end_date',             @date_type,         '', '',
5351         'otaker',       'varchar', 'NULL',      32, '', '',
5352         'usernum',          'int', 'NULL',      '', '', '',
5353         'bantype',      'varchar', 'NULL', $char_d, '', '',
5354         'reason',       'varchar', 'NULL', $char_d, '', '',
5355       ],
5356       'primary_key'  => 'bannum',
5357       'unique'       => [],
5358       'index'        => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
5359       'foreign_keys' => [
5360                           { columns    => [ 'usernum' ],
5361                             table      => 'access_user',
5362                           },
5363                         ],
5364     },
5365
5366     'pkg_category' => {
5367       'columns' => [
5368         'categorynum',        'serial',     '',      '', '', '',
5369         'categoryname',      'varchar',     '', $char_d, '', '',
5370         'weight',                'int', 'NULL',      '', '', '',
5371         'ticketing_queueid',     'int', 'NULL',      '', '', '',
5372         'condense',             'char', 'NULL',       1, '', '',
5373         'disabled',             'char', 'NULL',       1, '', '',
5374       ],
5375       'primary_key' => 'categorynum',
5376       'unique' => [],
5377       'index' => [ ['disabled'] ],
5378     },
5379
5380     'pkg_class' => {
5381       'columns' => [
5382         'classnum',    'serial',   '',      '', '', '',
5383         'classname',   'varchar',  '', $char_d, '', '',
5384         'categorynum', 'int',  'NULL',      '', '', '',
5385         'disabled',    'char', 'NULL',       1, '', '',
5386         'fcc_ds0s',      'int',     'NULL', '', '', '',
5387       ],
5388       'primary_key'  => 'classnum',
5389       'unique'       => [],
5390       'index'        => [ ['disabled'] ],
5391       'foreign_keys' => [
5392                           { columns    => [ 'categorynum' ],
5393                             table      => 'pkg_category',
5394                           },
5395                         ],
5396     },
5397
5398     'cdr' => {
5399       'columns' => [
5400         # qw( name type null length default local );
5401
5402         ###
5403         #asterisk fields
5404         ###
5405
5406         'acctid',   'bigserial',  '', '', '', '',
5407         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
5408         'calldate', 'timestamp',   '',      '', \'now()', '',
5409         'clid',        'varchar',  '', $char_d, \"''", '',
5410         'src',         'varchar',  '', $char_d, \"''", '',
5411         'dst',         'varchar',  '', $char_d, \"''", '',
5412         'dcontext',    'varchar',  '', $char_d, \"''", '',
5413         'channel',     'varchar',  '', $char_d, \"''", '',
5414         'dstchannel',  'varchar',  '', $char_d, \"''", '',
5415         'lastapp',     'varchar',  '', $char_d, \"''", '',
5416         'lastdata',    'varchar',  '',     255, \"''", '',
5417
5418         #currently only opensips & voipswitch
5419         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
5420
5421         #currently only opensips
5422         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
5423
5424         #currently only u4:
5425         # terminating number (as opposed to dialed destination)
5426         'dst_term',    'varchar',  'NULL', $char_d, '', '',
5427
5428         #these don't seem to be logged by most of the SQL cdr_* modules
5429         #except tds under sql-illegal names, so;
5430         # ... don't rely on them for rating?
5431         # and, what they hey, i went ahead and changed the names and data types
5432         # to freeside-style dates...
5433           #'start',  'timestamp', 'NULL',  '',    '', '',
5434           #'answer', 'timestamp', 'NULL',  '',    '', '',
5435           #'end',    'timestamp', 'NULL',  '',    '', '',
5436         'startdate',  @date_type, '', '',
5437         'answerdate', @date_type, '', '',
5438         'enddate',    @date_type, '', '',
5439         #
5440
5441         'duration',    'int',      '',      '',     0, '',
5442         'billsec',     'int',      '',      '',     0, '',
5443         'disposition', 'varchar',  '',      45, \"''", '',
5444         'amaflags',    'int',      '',      '',     0, '',
5445         'accountcode', 'varchar',  '',      32, \"''", '',
5446         'uniqueid',    'varchar',  '', $char_d, \"''", '',
5447         'userfield',   'varchar',  '',     512, \"''", '',
5448
5449         'max_callers', 'int',  'NULL',      '',    '', '',
5450
5451         ###
5452         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
5453         # ones we adoped moved to "own fields" section below
5454         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
5455         ###
5456
5457         'upstream_currency',      'char', 'NULL',       3, '', '',
5458         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
5459
5460         # how it was rated internally...
5461         'ratedetailnum',           'int', 'NULL',      '', '', '',
5462
5463         'distance',            'decimal', 'NULL',      '', '', '',
5464         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
5465
5466         #cdr_calltype: the big list in appendix 2
5467         'calltypenum',             'int', 'NULL',      '', '', '',
5468
5469         'description',         'varchar', 'NULL', $char_d, '', '',
5470         'quantity',                'int', 'NULL',      '', '', '',
5471
5472         'upstream_rateid',         'int', 'NULL',      '', '', '',
5473
5474         ###
5475         # more fields, for GSM imports
5476         ###
5477         'servicecode',             'int', 'NULL',      '', '', '',
5478         'quantity_able',           'int', 'NULL',      '', '', '',
5479
5480         ###
5481         #and now for our own fields
5482         ###
5483
5484         'cdrtypenum',              'int', 'NULL',      '', '', '',
5485
5486         'charged_party',       'varchar', 'NULL', $char_d, '', '',
5487         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
5488
5489         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
5490
5491         #currently only voipswitch
5492         #'upstream_rate',      'decimal', 'NULL',  '10,5', '', '',
5493
5494         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
5495         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
5496
5497         # how it was rated internally...
5498         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
5499         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
5500         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
5501         'rated_seconds',              'int', 'NULL',      '', '', '',
5502         'rated_minutes', 'double precision', 'NULL',      '', '', '',
5503         'rated_granularity',          'int', 'NULL',      '', '', '',
5504         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
5505         'rated_classnum',             'int', 'NULL',      '', '', '',
5506         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
5507         'rated_cost',            'decimal', 'NULL',  '10,4', '', '',
5508
5509         'carrierid',               'bigint', 'NULL',      '', '', '',
5510
5511         # service it was matched to
5512         'svcnum',             'int',   'NULL',     '',   '', '',
5513
5514         #NULL, done (or something)
5515         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
5516
5517         #NULL, done (or something)
5518         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
5519
5520         #an indexed place to put big numbers
5521         'cdrid',         'bigint',     'NULL',     '',  '', '',
5522
5523         #for taqua accountcode rewriting, for starters
5524         'sessionnum',       'int',    'NULL',      '', '', '',
5525         'subscriber',   'varchar',    'NULL', $char_d, '', '',
5526
5527         #old
5528         'cdrbatch',     'varchar',    'NULL',     255, '', '',
5529         #new
5530         'cdrbatchnum',      'int',    'NULL',      '', '', '',
5531
5532         # FK to cust_bill_pkg_detail; having a value here absolutely means
5533         # that the CDR appears on an invoice
5534         'detailnum',     'bigint',    'NULL',      '', '', '',
5535       ],
5536       'primary_key' => 'acctid',
5537       'unique' => [],
5538       'index' => [ [ 'calldate' ],
5539                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
5540                    [ 'lastapp' ],
5541                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
5542                    [ 'sessionnum' ], [ 'subscriber' ],
5543                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
5544                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
5545                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ], [ 'dst_term' ],
5546                    [ 'detailnum' ],
5547                  ],
5548       #no FKs on cdr table... choosing not to throw errors no matter what's
5549       # thrown in here.  better to have the data.
5550     },
5551
5552     'cdr_batch' => {
5553       'columns' => [
5554         'cdrbatchnum',   'serial',    '',   '', '', '',
5555         'cdrbatch', 'varchar', 'NULL', 255, '', '',
5556         '_date',     @date_type, '', '',
5557       ],
5558       'primary_key' => 'cdrbatchnum',
5559       'unique' => [ [ 'cdrbatch' ] ],
5560       'index' => [],
5561     },
5562
5563     'cdr_termination' => {
5564       'columns' => [
5565         'cdrtermnum', 'bigserial',     '',      '', '', '',
5566         'acctid',        'bigint',     '',      '', '', '',
5567         'termpart',         'int',     '',      '', '', '',#future use see below
5568         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
5569         'rated_seconds',    'int', 'NULL',      '', '', '',
5570         'rated_minutes', 'double precision', 'NULL',   '', '', '',
5571         'status',       'varchar', 'NULL',      32, '', '',
5572         'svcnum',           'int', 'NULL',      '', '', '',
5573       ],
5574       'primary_key'  => 'cdrtermnum',
5575       'unique'       => [ [ 'acctid', 'termpart' ] ],
5576       'index'        => [ [ 'acctid' ], [ 'status' ], ],
5577       'foreign_keys' => [
5578                           { columns    => [ 'acctid' ],
5579                             table      => 'cdr',
5580                           },
5581                           { columns    => [ 'svcnum' ],
5582                             table      => 'cust_svc',
5583                           },
5584                         ],
5585     },
5586
5587     #to handle multiple termination/settlement passes...
5588    # 'part_termination' => {
5589    #   'columns' => [
5590    #     'termpart',       'int', '',      '', '', '',
5591    #     'termname',   'varchar', '', $char_d, '', '',
5592    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
5593    #   ],
5594    #   'primary_key' => 'termpart',
5595    #   'unique' => [],
5596    #   'index'  => [],
5597    # },
5598
5599     #the remaining cdr_ tables are not really used
5600     'cdr_calltype' => {
5601       'columns' => [
5602         'calltypenum',   'serial',  '', '', '', '',
5603         'calltypename',  'varchar', '', $char_d, '', '',
5604       ],
5605       'primary_key' => 'calltypenum',
5606       'unique'      => [],
5607       'index'       => [],
5608     },
5609
5610     'cdr_type' => {
5611       'columns' => [
5612         'cdrtypenum'  => 'serial',  '', '', '', '',
5613         'cdrtypename' => 'varchar', '', $char_d, '', '',
5614       ],
5615       'primary_key' => 'cdrtypenum',
5616       'unique'      => [],
5617       'index'       => [],
5618     },
5619
5620     'cdr_carrier' => {
5621       'columns' => [
5622         'carrierid'   =>  'serial',     '',      '', '', '',
5623         'carriername' => 'varchar',     '', $char_d, '', '',
5624         'disabled'    =>    'char', 'NULL',       1, '', '',
5625       ],
5626       'primary_key' => 'carrierid',
5627       'unique'      => [],
5628       'index'       => [],
5629     },
5630
5631     #'cdr_file' => {
5632     #  'columns' => [
5633     #    'filenum',    'serial',     '', '', '', '',
5634     #    'filename',  'varchar',     '', '', '', '',
5635     #    'status',    'varchar', 'NULL', '', '', '',
5636     #  ],
5637     #  'primary_key' => 'filenum',
5638     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
5639     #                                   # agent-virtualize or have a customer
5640     #                                   # with dup-filename needs or something
5641     #                                   # (only used by cdr.http_and_import for
5642     #                                   #  chrissakes)
5643     #  'index'  => [],
5644     #},
5645
5646     'inventory_item' => {
5647       'columns' => [
5648         'itemnum',   'serial',      '',      '', '', '',
5649         'classnum',  'int',         '',      '', '', '',
5650         'agentnum',  'int',     'NULL',      '', '', '',
5651         'item',      'varchar',     '', $char_d, '', '',
5652         'svcnum',    'int',     'NULL',      '', '', '',
5653         'svc_field', 'varchar', 'NULL', $char_d, '', '',
5654       ],
5655       'primary_key'  => 'itemnum',
5656       'unique'       => [ [ 'classnum', 'item' ] ],
5657       'index'        => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
5658       'foreign_keys' => [
5659                           { columns    => [ 'classnum' ],
5660                             table      => 'inventory_class',
5661                           },
5662                           { columns    => [ 'agentnum' ],
5663                             table      => 'agent',
5664                           },
5665                           { columns    => [ 'svcnum' ],
5666                             table      => 'cust_svc',
5667                           },
5668                         ],
5669     },
5670
5671     'inventory_class' => {
5672       'columns' => [
5673         'classnum',  'serial',       '',      '', '', '',
5674         'classname', 'varchar',      '', $char_d, '', '',
5675       ],
5676       'primary_key' => 'classnum',
5677       'unique' => [],
5678       'index'  => [],
5679     },
5680
5681     'access_user_session' => {
5682       'columns' => [
5683         'sessionnum',   'serial',  '',      '', '', '',
5684         'sessionkey',  'varchar',  '', $char_d, '', '',
5685         'usernum',         'int',  '',      '', '', '',
5686         'start_date', @date_type,               '', '',
5687         'last_date',  @date_type,               '', '',
5688       ],
5689       'primary_key'  => 'sessionnum',
5690       'unique'       => [ [ 'sessionkey' ] ],
5691       'index'        => [],
5692       'foreign_keys' => [
5693                           { columns    => [ 'usernum' ],
5694                             table      => 'access_user',
5695                           },
5696                         ],
5697     },
5698
5699     'access_user' => {
5700       'columns' => [
5701         'usernum',             'serial',     '',      '', '', '',
5702         'username',           'varchar',     '', $char_d, '', '',
5703         '_password',          'varchar', 'NULL', $char_d, '', '',
5704         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
5705         'last',               'varchar', 'NULL', $char_d, '', '',
5706         'first',              'varchar', 'NULL', $char_d, '', '',
5707         'user_custnum',           'int', 'NULL',      '', '', '',
5708         'report_salesnum',        'int', 'NULL',      '', '', '',
5709         'disabled',              'char', 'NULL',       1, '', '',
5710       ],
5711       'primary_key'  => 'usernum',
5712       'unique'       => [ [ 'username' ] ],
5713       'index'        => [ [ 'user_custnum' ] ],
5714       'foreign_keys' => [
5715                           { columns    => [ 'user_custnum' ],
5716                             table      => 'cust_main',
5717                             references => [ 'custnum' ],
5718                           },
5719                           { columns    => [ 'report_salesnum' ],
5720                             table      => 'sales',
5721                             references => [ 'salesnum' ],
5722                           },
5723                         ],
5724     },
5725
5726     'access_user_pref' => {
5727       'columns' => [
5728         'prefnum',    'serial',       '', '', '', '',
5729         'usernum',     'int',       '', '', '', '',
5730         'prefname', 'varchar', '', $char_d, '', '',
5731         'prefvalue', 'text', 'NULL', '', '', '',
5732         'expiration', @date_type, '', '',
5733       ],
5734       'primary_key'  => 'prefnum',
5735       'unique'       => [],
5736       'index'        => [ [ 'usernum' ] ],
5737       'foreign_keys' => [
5738                           { columns    => [ 'usernum' ],
5739                             table      => 'access_user',
5740                           },
5741                         ],
5742     },
5743
5744     'access_group' => {
5745       'columns' => [
5746         'groupnum',   'serial', '',      '', '', '',
5747         'groupname', 'varchar', '', $char_d, '', '',
5748       ],
5749       'primary_key' => 'groupnum',
5750       'unique' => [ [ 'groupname' ] ],
5751       'index'  => [],
5752     },
5753
5754     'access_usergroup' => {
5755       'columns' => [
5756         'usergroupnum', 'serial', '', '', '', '',
5757         'usernum',         'int', '', '', '', '',
5758         'groupnum',        'int', '', '', '', '',
5759       ],
5760       'primary_key'  => 'usergroupnum',
5761       'unique'       => [ [ 'usernum', 'groupnum' ] ],
5762       'index'        => [ [ 'usernum' ] ],
5763       'foreign_keys' => [
5764                           { columns    => [ 'usernum' ],
5765                             table      => 'access_user',
5766                           },
5767                           { columns    => [ 'groupnum' ],
5768                             table      => 'access_group',
5769                           },
5770                         ],
5771      },
5772
5773     'access_groupagent' => {
5774       'columns' => [
5775         'groupagentnum', 'serial', '', '', '', '',
5776         'groupnum',         'int', '', '', '', '',
5777         'agentnum',         'int', '', '', '', '',
5778       ],
5779       'primary_key'  => 'groupagentnum',
5780       'unique'       => [ [ 'groupnum', 'agentnum' ] ],
5781       'index'        => [ [ 'groupnum' ] ],
5782       'foreign_keys' => [
5783                           { columns    => [ 'groupnum' ],
5784                             table      => 'access_group',
5785                           },
5786                           { columns    => [ 'agentnum' ],
5787                             table      => 'agent',
5788                           },
5789                         ],
5790     },
5791
5792     'access_right' => {
5793       'columns' => [
5794         'rightnum',   'serial', '',      '', '', '',
5795         'righttype', 'varchar', '', $char_d, '', '',
5796         'rightobjnum',   'int', '',      '', '', '',
5797         'rightname', 'varchar', '', $char_d, '', '',
5798       ],
5799       'primary_key' => 'rightnum',
5800       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
5801       'index'  => [],
5802     },
5803
5804     'access_user_log' => {
5805       'columns'      => [
5806         'lognum',          'serial',     '',        '', '', '',
5807         'usernum',            'int',     '',        '', '', '',
5808         'path',           'varchar',     '', 2*$char_d, '', '',
5809         '_date',                   @date_type,          '', '',
5810         'render_seconds',     'int', 'NULL',        '', '', '',
5811       ],
5812       'primary_key'  => 'lognum',
5813       'unique'       => [],
5814       'index'        => [ ['usernum'], ['path'], ['_date'] ],
5815     },
5816
5817     'access_user_page_pref' => {
5818       'columns'     => [
5819         'prefnum'     =>  'serial',     '',      '', '', '',
5820         'usernum'     =>     'int',     '',      '', '', '',
5821         'path'        =>    'text',     '',      '', '', '',
5822         'tablenum'    =>     'int', 'NULL',      '', '', '',
5823         '_date'       =>    @date_type,              '', '',
5824         'prefname'    =>    'varchar',  '', $char_d, '', '',
5825         'prefvalue'   =>    'text',     '',      '', '', '',
5826       ],
5827       'primary_key' => 'prefnum',
5828       'unique'      => [ [ 'usernum', 'path', 'tablenum', 'prefname' ] ],
5829       'index'       => [],
5830       'foreign_keys' => [
5831                           { columns   => [ 'usernum' ],
5832                             table     => 'access_user'
5833                           },
5834                         ],
5835     },
5836
5837     'sched_item' => {
5838       'columns' => [
5839         'itemnum',   'serial',      '', '', '', '',
5840         'usernum',      'int',  'NULL', '', '', '',
5841         #'itemname', 'varchar', $char_d, '', '', '',
5842         'disabled',    'char',  'NULL',  1, '', '',
5843       ],
5844       'primary_key'  => 'itemnum',
5845       'unique'       => [ [ 'usernum' ] ],
5846       'index'        => [],
5847       'foreign_keys' => [
5848                           { columns    => [ 'usernum' ],
5849                             table      => 'access_user',
5850                           },
5851                         ],
5852     },
5853
5854     #'sched_item_class'
5855
5856     'sched_avail' => {
5857       'columns' => [
5858         'availnum',      'serial', '', '', '', '',
5859         'itemnum',          'int', '', '', '', '',
5860         'wday',             'int', '', '', '', '',
5861         'stime',            'int', '', '', '', '',
5862         'etime',            'int', '', '', '', '',
5863         'override_date',    @date_type,    '', '',
5864       ],
5865       'primary_key'  => 'availnum',
5866       'unique'       => [],
5867       'index'        => [],
5868       'foreign_keys' => [
5869                           { columns    => [ 'itemnum' ],
5870                             table      => 'sched_item',
5871                           },
5872                         ],
5873     },
5874
5875     'svc_phone' => {
5876       'columns' => [
5877         'svcnum',                         'int',     '',      '', '', '',
5878         'countrycode',                'varchar',     '',       3, '', '',
5879         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
5880         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
5881         'pin',                        'varchar', 'NULL', $char_d, '', '',
5882         'sip_password',               'varchar', 'NULL', $char_d, '', '',
5883         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
5884         'pbxsvc',                         'int', 'NULL',      '', '', '',
5885         'domsvc',                         'int', 'NULL',      '', '', '',
5886         'locationnum',                    'int', 'NULL',      '', '', '',
5887         'forward_svcnum',                 'int', 'NULL',      '', '', '',
5888         'forwarddst',                 'varchar', 'NULL',      15, '', '',
5889         'email',                      'varchar', 'NULL',     255, '', '',
5890         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
5891         'portable',                      'char', 'NULL',       1, '', '',
5892         'lrn',                           'char', 'NULL',      10, '', '',
5893         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
5894         'lnp_due_date',                   'int', 'NULL',      '', '', '',
5895         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
5896         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
5897         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
5898         'sms_carrierid',                  'int', 'NULL',      '', '', '',
5899         'sms_account',                'varchar', 'NULL', $char_d, '', '',
5900         'max_simultaneous',               'int', 'NULL',      '', '', '',
5901         'e911_class',                    'char', 'NULL',       1, '', '',
5902         'e911_type',                     'char', 'NULL',       1, '', '',
5903         'circuit_svcnum',                 'int', 'NULL',      '', '', '',
5904         'sip_server',                 'varchar', 'NULL', $char_d, '', '',
5905       ],
5906       'primary_key'  => 'svcnum',
5907       'unique'       => [ [ 'sms_carrierid', 'sms_account'] ],
5908       'index'        => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
5909                           ['locationnum'], ['sms_carrierid'],
5910                         ],
5911       'foreign_keys' => [
5912                           { columns    => [ 'svcnum' ],
5913                             table      => 'cust_svc',
5914                           },
5915                           { columns    => [ 'pbxsvc' ],
5916                             table      => 'svc_pbx', #'cust_svc',
5917                             references => [ 'svcnum' ],
5918                           },
5919                           { columns    => [ 'domsvc' ],
5920                             table      => 'svc_domain', #'cust_svc',
5921                             references => [ 'svcnum' ],
5922                           },
5923                           { columns    => [ 'locationnum' ],
5924                             table      => 'cust_location',
5925                           },
5926                           { columns    => [ 'sms_carrierid' ],
5927                             table      => 'cdr_carrier',
5928                             references => [ 'carrierid' ],
5929                           },
5930                           { columns    => [ 'circuit_svcnum' ],
5931                             table      => 'svc_circuit',
5932                             references => [ 'svcnum' ],
5933                           },
5934                         ],
5935     },
5936
5937     'phone_device' => {
5938       'columns' => [
5939         'devicenum', 'serial',     '', '', '', '',
5940         'devicepart',   'int',     '', '', '', '',
5941         'svcnum',       'int',     '', '', '', '',
5942         'mac_addr', 'varchar', 'NULL', 12, '', '',
5943       ],
5944       'primary_key'  => 'devicenum',
5945       'unique'       => [ [ 'mac_addr' ], ],
5946       'index'        => [ [ 'devicepart' ], [ 'svcnum' ], ],
5947       'foreign_keys' => [
5948                           { columns    => [ 'devicepart' ],
5949                             table      => 'part_device',
5950                           },
5951                           { columns    => [ 'svcnum' ],
5952                             table      => 'svc_phone',
5953                           },
5954                         ],
5955     },
5956
5957     'part_device' => {
5958       'columns' => [
5959         'devicepart', 'serial',  '',      '', '', '',
5960         'devicename', 'varchar', '', $char_d, '', '',
5961         'inventory_classnum', 'int', 'NULL', '', '', '',
5962         'title',      'varchar', 'NULL', $char_d, '', '',
5963       ],
5964       'primary_key'  => 'devicepart',
5965       'unique'       => [ [ 'devicename' ] ], #?
5966       'index'        => [],
5967       'foreign_keys' => [
5968                           { columns    => [ 'inventory_classnum' ],
5969                             table      => 'inventory_class',
5970                             references => [ 'classnum' ],
5971                           },
5972                         ],
5973     },
5974
5975     'phone_avail' => {
5976       'columns' => [
5977         'availnum',    'serial',      '',      '', '', '',
5978         'exportnum',   'int',         '',      '', '', '',
5979         'countrycode', 'varchar',     '',       3, '', '',
5980         'state',       'char',    'NULL',       2, '', '',
5981         'npa',         'char',        '',       3, '', '',
5982         'nxx',         'char',    'NULL',       3, '', '',
5983         'station',     'char',    'NULL',       4, '', '',
5984         'name',        'varchar', 'NULL', $char_d, '', '',
5985         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
5986         'latanum',      'int',     'NULL',      '', '', '',
5987         'msanum',       'int', 'NULL', '', '', '',
5988         'ordernum',      'int',     'NULL',      '', '', '',
5989         'svcnum',      'int',     'NULL',      '', '', '',
5990         'availbatch', 'varchar',  'NULL', $char_d, '', '',
5991       ],
5992       'primary_key'  => 'availnum',
5993       'unique'       => [],
5994       'index'        => [ ['exportnum','countrycode','state'],    #npa search
5995                           ['exportnum','countrycode','npa'],      #nxx search
5996                           ['exportnum','countrycode','npa','nxx'],#station srch
5997                           [ 'exportnum','countrycode','npa','nxx','station'], #
5998                           [ 'svcnum' ],
5999                           [ 'availbatch' ],
6000                           [ 'latanum' ],
6001                         ],
6002       'foreign_keys' => [
6003                           { columns    => [ 'exportnum' ],
6004                             table      => 'part_export',
6005                           },
6006                           { columns    => [ 'latanum' ],
6007                             table      => 'lata',
6008                           },
6009                           { columns    => [ 'msanum' ],
6010                             table      => 'msa',
6011                           },
6012                           { columns    => [ 'ordernum' ],
6013                             table      => 'did_order',
6014                           },
6015                           { columns    => [ 'svcnum' ],
6016                             table      => 'svc_phone',
6017                           },
6018                         ],
6019     },
6020
6021     'lata' => {
6022       'columns' => [
6023         'latanum',    'int',      '',      '', '', '',
6024         'description',   'varchar',    '',      $char_d, '', '',
6025         'have_usage',   'int',    'NULL',      '', '', '',
6026       ],
6027       'primary_key' => 'latanum',
6028       'unique' => [],
6029       'index'  => [],
6030     },
6031
6032     'msa' => {
6033       'columns' => [
6034         'msanum',    'int',      '',      '', '', '',
6035         'description',   'varchar',    '',      $char_d, '', '',
6036       ],
6037       'primary_key' => 'msanum',
6038       'unique' => [],
6039       'index'  => [],
6040     },
6041
6042     'rate_center' => {
6043       'columns' => [
6044         'ratecenternum',    'serial',      '',      '', '', '',
6045         'description',   'varchar',    '',      $char_d, '', '',
6046       ],
6047       'primary_key' => 'ratecenternum',
6048       'unique' => [],
6049       'index'  => [],
6050     },
6051
6052     'did_vendor' => {
6053       'columns' => [
6054         'vendornum',    'serial',      '',      '', '', '',
6055         'vendorname',   'varchar',        '',     $char_d, '', '',
6056       ],
6057       'primary_key' => 'vendornum',
6058       'unique' => [],
6059       'index'  => [],
6060     },
6061
6062     'did_order_item' => {
6063       'columns' => [
6064         'orderitemnum',    'serial',      '',      '', '', '',
6065         'ordernum',    'int',      '',      '', '', '',
6066         'msanum',      'int',     'NULL',      '', '', '',
6067         'npa',      'int',     'NULL',      '', '', '',
6068         'latanum',      'int',     'NULL',      '', '', '',
6069         'ratecenternum',      'int',     'NULL',      '', '', '',
6070         'state',       'char',    'NULL',       2, '', '',
6071         'quantity',      'int',     '',      '', '', '',
6072         'custnum',   'int', 'NULL', '', '', '',
6073       ],
6074       'primary_key'  => 'orderitemnum',
6075       'unique'       => [],
6076       'index'        => [],
6077       'foreign_keys' => [
6078                           { columns    => [ 'ordernum' ],
6079                             table      => 'did_order',
6080                           },
6081                           { columns    => [ 'msanum' ],
6082                             table      => 'msa',
6083                           },
6084                           { columns    => [ 'latanum' ],
6085                             table      => 'lata',
6086                           },
6087                           { columns    => [ 'ratecenternum' ],
6088                             table      => 'rate_center',
6089                           },
6090                           { columns    => [ 'custnum' ],
6091                             table      => 'cust_main',
6092                           },
6093                         ],
6094     },
6095
6096     'did_order' => {
6097       'columns' => [
6098         'ordernum',    'serial',      '',      '', '', '',
6099         'vendornum',   'int',       '',      '', '', '',
6100         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
6101         'custnum',   'int', 'NULL', '', '', '',
6102         'submitted',      'int',     '',      '', '', '',
6103         'confirmed',      'int',     'NULL',      '', '', '',
6104         'received',      'int',     'NULL',      '', '', '',
6105       ],
6106       'primary_key'  => 'ordernum',
6107       'unique'       => [ [ 'vendornum', 'vendor_order_id' ] ],
6108       'index'        => [],
6109       'foreign_keys' => [
6110                           { columns    => [ 'vendornum' ],
6111                             table      => 'did_vendor',
6112                           },
6113                           { columns    => [ 'custnum' ],
6114                             table      => 'cust_main',
6115                           },
6116                         ],
6117     },
6118
6119     'reason_type' => {
6120       'columns' => [
6121         'typenum',   'serial',  '', '', '', '',
6122         'class',     'char', '', 1, '', '',
6123         'type',     'varchar', '', $char_d, '', '',
6124       ],
6125       'primary_key' => 'typenum',
6126       'unique' => [],
6127       'index' => [],
6128     },
6129
6130     'reason' => {
6131       'columns' => [
6132         'reasonnum',     'serial',  '', '', '', '',
6133         'reason_type',   'int',  '', '', '', '',
6134         'reason',        'text', '', '', '', '',
6135         'disabled',      'char',    'NULL', 1, '', '',
6136         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
6137         'unsuspend_hold','char',    'NULL', 1, '', '',
6138         'unused_credit', 'char',    'NULL', 1, '', '',
6139         'feepart',        'int', 'NULL', '', '', '',
6140         'fee_on_unsuspend','char',  'NULL', 1, '', '',
6141         'fee_hold',      'char',    'NULL', 1, '', '',
6142       ],
6143       'primary_key'  => 'reasonnum',
6144       'unique'       => [],
6145       'index'        => [],
6146       'foreign_keys' => [
6147                           { columns    => [ 'reason_type' ],
6148                             table      => 'reason_type',
6149                             references => [ 'typenum' ],
6150                           },
6151                           { columns    => [ 'unsuspend_pkgpart' ],
6152                             table      => 'part_pkg',
6153                             references => [ 'pkgpart' ],
6154                           },
6155                         ],
6156     },
6157
6158     'conf' => {
6159       'columns' => [
6160         'confnum',  'serial',     '',      '', '', '',
6161         'agentnum', 'int',    'NULL',      '', '', '',
6162         'locale',   'varchar','NULL',      16, '', '',
6163         'name',     'varchar',    '', $char_d, '', '',
6164         'value',    'text',   'NULL',      '', '', '',
6165       ],
6166       'primary_key'  => 'confnum',
6167       'unique'       => [ [ 'agentnum', 'locale', 'name' ] ],
6168       'index'        => [],
6169       'foreign_keys' => [
6170                           { columns    => [ 'agentnum' ],
6171                             table      => 'agent',
6172                           },
6173                         ],
6174     },
6175
6176     'pkg_referral' => {
6177       'columns' => [
6178         'pkgrefnum',     'serial', '', '', '', '',
6179         'pkgnum',        'int',    '', '', '', '',
6180         'refnum',        'int',    '', '', '', '',
6181       ],
6182       'primary_key'  => 'pkgrefnum',
6183       'unique'       => [ [ 'pkgnum', 'refnum' ] ],
6184       'index'        => [ [ 'pkgnum' ], [ 'refnum' ] ],
6185       'foreign_keys' => [
6186                           { columns    => [ 'pkgnum' ],
6187                             table      => 'cust_pkg',
6188                           },
6189                           { columns    => [ 'refnum' ],
6190                             table      => 'part_referral',
6191                           },
6192                         ],
6193     },
6194
6195     'svc_pbx' => {
6196       'columns' => [
6197         'svcnum',           'int',     '',      '', '', '',
6198         'id',               'int', 'NULL',      '', '', '',
6199         'uuid',            'char', 'NULL',      36, '', '',
6200         'title',        'varchar', 'NULL', $char_d, '', '',
6201         'max_extensions',   'int', 'NULL',      '', '', '',
6202         'max_simultaneous', 'int', 'NULL',      '', '', '',
6203         'ip_addr',      'varchar', 'NULL',      40, '', '',
6204       ],
6205       'primary_key'  => 'svcnum',
6206       'unique'       => [],
6207       'index'        => [ [ 'id' ], [ 'uuid' ] ],
6208       'foreign_keys' => [
6209                           { columns    => [ 'svcnum' ],
6210                             table      => 'cust_svc',
6211                           },
6212                         ],
6213     },
6214
6215     'pbx_extension' => {
6216       'columns' => [
6217         'extensionnum',  'serial',     '',      '', '', '',
6218         'svcnum',           'int',     '',      '', '', '',
6219         'extension',    'varchar',     '', $char_d, '', '',
6220         'pin',          'varchar', 'NULL', $char_d, '', '',
6221         'sip_password', 'varchar', 'NULL', $char_d, '', '',
6222         'phone_name',   'varchar', 'NULL', $char_d, '', '',
6223       ],
6224       'primary_key'  => 'extensionnum',
6225       'unique'       => [ [ 'svcnum', 'extension' ] ],
6226       'index'        => [ [ 'svcnum' ] ],
6227       'foreign_keys' => [
6228                           { columns    => [ 'svcnum' ],
6229                             table      => 'svc_pbx',
6230                           },
6231                         ],
6232     },
6233
6234     'pbx_device' => {
6235       'columns' => [
6236         'devicenum', 'serial',     '', '', '', '',
6237         'devicepart',   'int',     '', '', '', '',
6238         'svcnum',       'int',     '', '', '', '',
6239         'mac_addr', 'varchar', 'NULL', 12, '', '',
6240       ],
6241       'primary_key'  => 'devicenum',
6242       'unique'       => [ [ 'mac_addr' ], ],
6243       'index'        => [ [ 'devicepart' ], [ 'svcnum' ], ],
6244       'foreign_keys' => [
6245                           { columns    => [ 'devicepart' ],
6246                             table      => 'part_device',
6247                           },
6248                           { columns    => [ 'svcnum' ],
6249                             table      => 'svc_pbx',
6250                           },
6251                         ],
6252     },
6253
6254     'extension_device' => {
6255       'columns' => [
6256         'extensiondevicenum', 'serial', '', '', '', '',
6257         'extensionnum',          'int', '', '', '', '',
6258         'devicenum',             'int', '', '', '', '',
6259       ],
6260       'primary_key'  => 'extensiondevicenum',
6261       'unique'       => [ [ 'extensionnum', 'devicenum' ] ],
6262       'index'        => [],#both?  which way do we need to query?
6263       'foreign_keys' => [
6264                           { columns  => [ 'extensionnum' ],
6265                             table    => 'pbx_extension',
6266                           },
6267                           { columns  => [ 'devicenum' ],
6268                             table    => 'pbx_device',
6269                           },
6270                         ],
6271     },
6272
6273     'svc_mailinglist' => { #svc_group?
6274       'columns' => [
6275         'svcnum',            'int',     '',            '', '', '',
6276         'username',      'varchar',     '', $username_len, '', '',
6277         'domsvc',            'int',     '',            '', '', '',
6278         'listnum',           'int',     '',            '', '', '',
6279         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
6280         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
6281         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
6282         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
6283       ],
6284       'primary_key'  => 'svcnum',
6285       'unique'       => [],
6286       'index'        => [ ['username'], ['domsvc'], ['listnum'] ],
6287       'foreign_keys' => [
6288                           { columns    => [ 'svcnum' ],
6289                             table      => 'cust_svc',
6290                           },
6291                           { columns    => [ 'domsvc' ],
6292                             table      => 'svc_domain', #'cust_svc',
6293                             references => [ 'svcnum' ],
6294                           },
6295                           { columns    => [ 'listnum' ],
6296                             table      => 'mailinglist',
6297                           },
6298                         ],
6299     },
6300
6301     'mailinglist' => {
6302       'columns' => [
6303         'listnum',   'serial', '',      '', '', '',
6304         'listname', 'varchar', '', $char_d, '', '',
6305       ],
6306       'primary_key' => 'listnum',
6307       'unique' => [],
6308       'index'  => [],
6309     },
6310
6311     'mailinglistmember' => {
6312       'columns' => [
6313         'membernum',        'serial',     '',   '', '', '',
6314         'listnum',             'int',     '',   '', '', '',
6315         'svcnum',              'int', 'NULL',   '', '', '',
6316         'contactemailnum',     'int', 'NULL',   '', '', '',
6317         'email',           'varchar', 'NULL',  255, '', '',
6318       ],
6319       'primary_key'  => 'membernum',
6320       'unique'       => [],
6321       'index'        => [['listnum'],['svcnum'],['contactemailnum'],['email']],
6322       'foreign_keys' => [
6323                           { columns    => [ 'listnum' ],
6324                             table      => 'mailinglist',
6325                           },
6326                           { columns    => [ 'svcnum' ],
6327                             table      => 'svc_acct',
6328                           },
6329                           { columns    => [ 'contactemailnum' ],
6330                             table      => 'contact_email',
6331                           },
6332                         ],
6333     },
6334
6335     'bill_batch' => {
6336       'columns' => [
6337         'batchnum',         'serial',     '',  '', '', '',
6338         'agentnum',            'int', 'NULL',  '', '', '',
6339         'status',             'char', 'NULL', '1', '', '',
6340         'pdf',                'blob', 'NULL',  '', '', '',
6341       ],
6342       'primary_key'  => 'batchnum',
6343       'unique'       => [],
6344       'index'        => [ ['agentnum'] ],
6345       'foreign_keys' => [
6346                           { columns    => [ 'agentnum' ],
6347                             table      => 'agent',
6348                           },
6349                         ],
6350     },
6351
6352     'cust_bill_batch' => {
6353       'columns' => [
6354         'billbatchnum',     'serial',     '', '', '', '',
6355         'batchnum',            'int',     '', '', '', '',
6356         'invnum',              'int',     '', '', '', '',
6357       ],
6358       'primary_key'  => 'billbatchnum',
6359       'unique'       => [],
6360       'index'        => [ [ 'batchnum' ], [ 'invnum' ] ],
6361       'foreign_keys' => [
6362                           { columns    => [ 'batchnum' ],
6363                             table      => 'bill_batch',
6364                           },
6365                           { columns    => [ 'invnum' ],
6366                             table      => 'cust_bill',
6367                           },
6368                         ],
6369     },
6370
6371     'cust_bill_batch_option' => {
6372       'columns' => [
6373         'optionnum', 'serial', '', '', '', '',
6374         'billbatchnum', 'int', '', '', '', '',
6375         'optionname', 'varchar', '', $char_d, '', '',
6376         'optionvalue', 'text', 'NULL', '', '', '',
6377       ],
6378       'primary_key'  => 'optionnum',
6379       'unique'       => [],
6380       'index'        => [ [ 'billbatchnum' ], [ 'optionname' ] ],
6381       'foreign_keys' => [
6382                           { columns    => [ 'billbatchnum' ],
6383                             table      => 'cust_bill_batch',
6384                           },
6385                         ],
6386      },
6387
6388     'msg_template' => {
6389       'columns' => [
6390         'msgnum',     'serial',     '',      '', '', '',
6391         'msgname',   'varchar',     '', $char_d, '', '',
6392         'agentnum',      'int', 'NULL',      '', '', '',
6393         'subject',   'varchar', 'NULL',     512, '', '',
6394         'mime_type', 'varchar',     '', $char_d, '', '',
6395         'body',         'blob', 'NULL',      '', '', '',
6396         'disabled',     'char', 'NULL',       1, '', '',
6397           # migrate these to msg_template_email
6398         'from_addr', 'varchar', 'NULL',     255, '', '',
6399         'bcc_addr',  'varchar', 'NULL',     255, '', '',
6400           # change to not null on v5
6401         'msgclass',  'varchar', 'NULL',      16, '', '',
6402       ],
6403       'primary_key'  => 'msgnum',
6404       'unique'       => [ ],
6405       'index'        => [ ['agentnum'], ],
6406       'foreign_keys' => [
6407                           { columns    => [ 'agentnum' ],
6408                             table      => 'agent',
6409                           },
6410                         ],
6411     },
6412
6413     'msg_template_http' => {
6414       'columns' => [
6415         'num',          'serial',     '',      '', '', '',
6416         'msgnum',          'int',     '',      '', '', '',
6417         'prepare_url', 'varchar', 'NULL',     255, '', '',
6418         'send_url',    'varchar', 'NULL',     255, '', '',
6419         'username',    'varchar', 'NULL', $char_d, '', '',
6420         'password',    'varchar', 'NULL', $char_d, '', '',
6421         'content',        'text', 'NULL',      '', '', '',
6422       ],
6423       'primary_key'  => 'num',
6424       'unique'       => [ [ 'msgnum' ], ],
6425       'index'        => [ ],
6426       'foreign_keys' => [
6427                           { columns    => [ 'msgnum' ],
6428                             table      => 'msg_template',
6429                           },
6430                         ],
6431     },
6432
6433     'template_content' => {
6434       'columns' => [
6435         'contentnum', 'serial',     '',      '', '', '',
6436         'msgnum',        'int',     '',      '', '', '',
6437         'locale',    'varchar', 'NULL',      16, '', '',
6438         'subject',   'varchar', 'NULL',     512, '', '',
6439         'body',         'text', 'NULL',      '', '', '',
6440       ],
6441       'primary_key'  => 'contentnum',
6442       'unique'       => [ ['msgnum', 'locale'] ],
6443       'index'        => [ ],
6444       'foreign_keys' => [
6445                           { columns    => [ 'msgnum' ],
6446                             table      => 'msg_template',
6447                           },
6448                         ],
6449     },
6450
6451     'template_image' => {
6452       'columns' => [
6453         'imgnum',     'serial',     '',      '', '', '',
6454         'name',      'varchar',     '', $char_d, '', '',
6455         'agentnum',      'int', 'NULL',      '', '', '',
6456         'mime_type', 'varchar',     '', $char_d, '', '',
6457         'base64',       'text',     '',      '', '', '',
6458       ],
6459       'primary_key'  => 'imgnum',
6460       'unique'       => [ ],
6461       'index'        => [ ['name'], ['agentnum'] ],
6462     },
6463
6464     'cust_msg' => {
6465       'columns' => [
6466         'custmsgnum', 'serial',     '',     '', '', '',
6467         'custnum',       'int', 'NULL',     '', '', '',
6468         'msgnum',        'int', 'NULL',     '', '', '',
6469         '_date',    @date_type,                 '', '',
6470         'env_from',  'varchar', 'NULL',    255, '', '',
6471         'env_to',    'varchar', 'NULL',    255, '', '',
6472         'header',       'blob', 'NULL',     '', '', '',
6473         'body',         'blob', 'NULL',     '', '', '',
6474         'error',     'varchar', 'NULL',    255, '', '',
6475         'status',    'varchar',     '',$char_d, '', '',
6476         'msgtype',   'varchar', 'NULL',     16, '', '',
6477         'preview',      'text', 'NULL',     '', '', '',
6478       ],
6479       'primary_key'  => 'custmsgnum',
6480       'unique'       => [ ],
6481       'index'        => [ ['custnum'], ],
6482       'foreign_keys' => [
6483                           { columns    => [ 'custnum' ],
6484                             table      => 'cust_main',
6485                           },
6486                           { columns    => [ 'msgnum' ],
6487                             table      => 'msg_template',
6488                           },
6489                         ],
6490     },
6491
6492     'svc_cert' => {
6493       'columns' => [
6494         'svcnum',                'int',     '',      '', '', '',
6495         'recnum',                'int', 'NULL',      '', '', '',
6496         'privatekey',           'text', 'NULL',      '', '', '',
6497         'csr',                  'text', 'NULL',      '', '', '',
6498         'certificate',          'text', 'NULL',      '', '', '',
6499         'cacert',               'text', 'NULL',      '', '', '',
6500         'common_name',       'varchar', 'NULL', $char_d, '', '',
6501         'organization',      'varchar', 'NULL', $char_d, '', '',
6502         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
6503         'city',              'varchar', 'NULL', $char_d, '', '',
6504         'state',             'varchar', 'NULL', $char_d, '', '',
6505         'country',              'char', 'NULL',       2, '', '',
6506         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
6507       ],
6508       'primary_key'  => 'svcnum',
6509       'unique'       => [],
6510       'index'        => [], #recnum
6511       'foreign_keys' => [
6512                           { columns    => [ 'svcnum' ],
6513                             table      => 'cust_svc',
6514                           },
6515                           { columns    => [ 'recnum' ],
6516                             table      => 'domain_record',
6517                           },
6518                         ],
6519     },
6520
6521     'svc_port' => {
6522       'columns' => [
6523         'svcnum',                'int',     '',      '', '', '',
6524         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
6525       ],
6526       'primary_key'  => 'svcnum',
6527       'unique'       => [],
6528       'index'        => [], #recnum
6529       'foreign_keys' => [
6530                           { columns    => [ 'svcnum' ],
6531                             table      => 'cust_svc',
6532                           },
6533                         ],
6534     },
6535
6536     'areacode'  => {
6537       'columns' => [
6538         'areanum',   'serial',        '',      '', '', '',
6539         'code',        'char',        '',       3, '', '',
6540         'country',     'char',    'NULL',       2, '', '',
6541         'state',       'char',    'NULL',       2, '', '',
6542         'description','varchar',  'NULL',     255, '', '',
6543       ],
6544       'primary_key' => 'areanum',
6545       'unique' => [ [ 'areanum' ] ],
6546       'index'  => [],
6547     },
6548
6549     'upgrade_journal' => {
6550       'columns' => [
6551         'upgradenum', 'serial', '', '', '', '',
6552         '_date', 'int', '', '', '', '',
6553         'upgrade', 'varchar', '', $char_d, '', '',
6554         'status', 'varchar', '', $char_d, '', '',
6555         'statustext', 'varchar', 'NULL', $char_d, '', '',
6556       ],
6557       'primary_key' => 'upgradenum',
6558       'unique' => [],
6559       'index' => [ [ 'upgrade' ] ],
6560     },
6561
6562     'upload_target' => {
6563       'columns' => [
6564         'targetnum', 'serial', '', '', '', '',
6565         'agentnum', 'int', 'NULL', '', '', '',
6566         'protocol', 'varchar', '', 10, '', '',
6567         'hostname', 'varchar', '', $char_d, '', '',
6568         'port', 'int', 'NULL', '', '', '',
6569         'username', 'varchar', '', $char_d, '', '',
6570         'password', 'varchar', 'NULL', $char_d, '', '',
6571         'path', 'varchar', 'NULL', $char_d, '', '',
6572         'subject', 'varchar', 'NULL', '255', '', '',
6573         'handling', 'varchar', 'NULL', $char_d, '', '',
6574       ],
6575       'primary_key'   => 'targetnum',
6576       'unique'        => [ [ 'targetnum' ] ],
6577       'index'         => [],
6578       'foreign_keys' => [
6579                           { columns    => [ 'agentnum' ],
6580                             table      => 'agent',
6581                           },
6582                         ],
6583     },
6584
6585     'log' => {
6586       'columns' => [
6587         'lognum',     'serial', '', '', '', '',
6588         '_date',      'int', '', '', '', '',
6589         'agentnum',   'int', 'NULL', '', '', '',
6590         'tablename',  'varchar', 'NULL', $char_d, '', '',
6591         'tablenum',   'int',  'NULL', '', '', '',
6592         'level',      'int',  '', '', '', '',
6593         'message',    'text', '', '', '', '',
6594       ],
6595       'primary_key'  => 'lognum',
6596       'unique'       => [],
6597       'index'        => [ ['_date'], ['level'] ],
6598       'foreign_keys' => [
6599                           { columns    => [ 'agentnum' ],
6600                             table      => 'agent',
6601                           },
6602                         ],
6603     },
6604
6605     'log_context' => {
6606       'columns' => [
6607         'logcontextnum', 'serial', '', '', '', '',
6608         'lognum', 'int', '', '', '', '',
6609         'context', 'varchar', '', $char_d, '', '',
6610       ],
6611       'primary_key'  => 'logcontextnum',
6612       'unique'       => [ [ 'lognum', 'context' ] ],
6613       'index'        => [],
6614       'foreign_keys' => [
6615                           { columns    => [ 'lognum' ],
6616                             table      => 'log',
6617                           },
6618                         ],
6619     },
6620
6621     'log_email' => {
6622       'columns' => [
6623         'logemailnum', 'serial', '', '', '', '',
6624         'context', 'varchar', 'NULL', $char_d, '', '',
6625         'min_level', 'int',  'NULL', '', '', '',
6626         'msgnum', 'int', '',  '', '', '',
6627         'to_addr', 'varchar', 'NULL',     255, '', '',
6628       ],
6629       'primary_key'  => 'logemailnum',
6630       'unique'       => [],
6631       'index'        => [ ['context'], ['min_level'] ],
6632       'foreign_keys' => [
6633                           { columns    => [ 'msgnum' ],
6634                             table      => 'msg_template',
6635                             references => [ 'msgnum' ],
6636                           },
6637                         ],
6638     },
6639
6640     'svc_alarm' => {
6641       'columns' => [
6642 #       name               type        null   length   default local
6643         'svcnum',          'int',      '',    '',      '',     '',
6644         'alarmsystemnum',  'int',      '',    '',      '',     '',
6645         'alarmtypenum',    'int',      '',    '',      '',     '',
6646         'alarmstationnum', 'int',      '',    '',      '',     '',
6647         'acctnum',         'varchar',  '',    $char_d, '',     '',
6648         '_password',       'varchar',  '',    $char_d, '',     '',
6649         'location',        'varchar', 'NULL', $char_d, '',     '',
6650         'cs_receiver',     'int',     'NULL', '',      '',     '',
6651         'cs_phonenum',     'varchar', 'NULL', $char_d, '',     '',
6652         'serialnum',       'varchar', 'NULL', $char_d, '',     '',
6653         #installer (rep)
6654       ],
6655       'primary_key'  => 'svcnum',
6656       'unique'       => [],
6657       'index'        => [],
6658       'foreign_keys' => [
6659                           { columns    => [ 'svcnum' ],
6660                             table      => 'cust_svc',
6661                           },
6662                           { columns    => [ 'alarmsystemnum' ],
6663                             table      => 'alarm_system',
6664                           },
6665                           { columns    => [ 'alarmtypenum' ],
6666                             table      => 'alarm_type',
6667                           },
6668                           { columns    => [ 'alarmstationnum' ],
6669                             table      => 'alarm_station',
6670                           },
6671                         ],
6672     },
6673
6674     'alarm_system' => { #vendors
6675       'columns' => [
6676         'alarmsystemnum',  'serial',     '',      '', '', '',
6677         'agentnum',           'int', 'NULL',      '', '', '',
6678         'systemname',     'varchar',     '', $char_d, '', '',
6679         'disabled',          'char', 'NULL',       1, '', '',
6680       ],
6681       'primary_key' => 'alarmsystemnum',
6682       'unique'      => [ ['agentnum', 'systemname'] ],
6683       'index'       => [ ['agentnum'], ['disabled'] ],
6684       'foreign_keys' => [
6685                           { columns    => [ 'agentnum' ],
6686                             table      => 'agent',
6687                           },
6688                         ],
6689     },
6690
6691     'alarm_type' => { #inputs and outputs
6692       'columns' => [
6693         'alarmtypenum', 'serial',     '',      '', '', '',
6694         'agentnum',        'int', 'NULL',      '', '', '',
6695         'inputs',          'int',     '', '', '', '',
6696         'outputs',         'int',     '', '', '', '',
6697         'disabled',       'char', 'NULL',       1, '', '',
6698       ],
6699       'primary_key' => 'alarmtypenum',
6700       'unique'      => [ ['agentnum', 'inputs', 'outputs'] ],
6701       'index'       => [ ['agentnum'], ['disabled'] ],
6702       'foreign_keys' => [
6703                           { columns    => [ 'agentnum' ],
6704                             table      => 'agent',
6705                           },
6706                         ],
6707     },
6708
6709     'alarm_station' => { #central station (where the alarm reports to)
6710       'columns' => [
6711         'alarmstationnum', 'serial',     '',      '', '', '',
6712         'agentnum',           'int', 'NULL',      '', '', '',
6713         'stationname',    'varchar',     '', $char_d, '', '',
6714         'disabled',          'char', 'NULL',       1, '', '',
6715       ],
6716       'primary_key' => 'alarmstationnum',
6717       'unique'      => [ ['agentnum', 'stationname'], ],
6718       'index'       => [ ['agentnum'], ['disabled'] ],
6719       'foreign_keys' => [
6720                           { columns    => [ 'agentnum' ],
6721                             table      => 'agent',
6722                           },
6723                         ],
6724     },
6725
6726     'svc_cable' => {
6727       'columns' => [
6728         'svcnum',        'int',     '',      '', '', '',
6729         'providernum',   'int', 'NULL',      '', '', '',
6730         'ordernum',  'varchar', 'NULL', $char_d, '', '',
6731         'modelnum',      'int', 'NULL',      '', '', '',
6732         'serialnum', 'varchar', 'NULL', $char_d, '', '',
6733         'mac_addr',  'varchar', 'NULL',      12, '', '',
6734       ],
6735       'primary_key'  => 'svcnum',
6736       'unique'       => [ ['serialnum'] , ['mac_addr'] ],
6737       'index'        => [],
6738       'foreign_keys' => [
6739                           { columns    => [ 'svcnum' ],
6740                             table      => 'cust_svc',
6741                           },
6742                           { columns    => [ 'providernum' ],
6743                             table      => 'cable_provider',
6744                           },
6745                           { columns    => [ 'modelnum' ],
6746                             table      => 'cable_model',
6747                           },
6748                         ],
6749     },
6750
6751     'cable_model' => {
6752       'columns' => [
6753         'modelnum',    'serial',     '',      '', '', '',
6754         'model_name', 'varchar',     '', $char_d, '', '',
6755         'disabled',      'char', 'NULL',       1, '', '',
6756       ],
6757       'primary_key' => 'modelnum',
6758       'unique' => [ [ 'model_name' ], ],
6759       'index'  => [],
6760     },
6761
6762     'cable_provider' => {
6763       'columns' => [
6764         'providernum', 'serial',     '',      '', '', '',
6765         'provider',   'varchar',     '', $char_d, '', '',
6766         'disabled',      'char', 'NULL',       1, '', '',
6767       ],
6768       'primary_key' => 'providernum',
6769       'unique' => [ [ 'provider' ], ],
6770       'index'  => [],
6771     },
6772
6773     'svc_conferencing' => {
6774       'columns' => [
6775         'svcnum',            'int',     '',      '', '', '',
6776         'conf_id',           'int', 'NULL',      '', '', '', #"system assigned"
6777         'conf_name',     'varchar',     '', $char_d, '', '',
6778         'conf_password', 'varchar',     '', $char_d, '', '',
6779         'access_code',   'varchar',     '',      16, '', '',
6780         'duration',          'int',     '',      '', '', '',
6781         'participants',      'int',     '',      '', '', '',
6782         'conftypenum',       'int',     '',      '', '', '',
6783         'confqualitynum',    'int',     '',      '', '', '',
6784         'opt_recording',    'char', 'NULL',       1, '', '',
6785         'opt_sip',          'char', 'NULL',       1, '', '',
6786         'opt_phone',        'char', 'NULL',       1, '', '',
6787       ],
6788       'primary_key' => 'svcnum',
6789       'unique' => [],
6790       'index'  => [],
6791       'foreign_keys' => [
6792                           { columns => [ 'svcnum' ],
6793                             table   => 'cust_svc',
6794                           },
6795                           { columns => [ 'conftypenum' ],
6796                             table   => 'conferencing_type',
6797                           },
6798                           { columns => [ 'confqualitynum' ],
6799                             table   => 'conferencing_quality',
6800                           },
6801                         ],
6802     },
6803
6804     'conferencing_type' => {
6805       'columns' => [
6806         'conftypenum',  'int',     '',      '', '', '',
6807         'typeid'      , 'int',     '',      '', '', '',
6808         'typename', 'varchar',     '', $char_d, '', '',
6809         'disabled',    'char', 'NULL',       1, '', '',
6810       ],
6811       'primary_key' => 'conftypenum',
6812       'unique'      => [ [ 'typeid', 'disabled' ], [ 'typename', 'disabled' ] ],
6813       'index'       => [],
6814     },
6815
6816     'conferencing_quality' => {
6817       'columns' => [
6818         'confqualitynum',  'int',     '',      '', '', '',
6819         'qualityid'      , 'int',     '',      '', '', '',
6820         'qualityname', 'varchar',     '', $char_d, '', '',
6821         'disabled',       'char', 'NULL',       1, '', '',
6822       ],
6823       'primary_key' => 'confqualitynum',
6824       'unique'      => [ [ 'qualityid', 'disabled' ], [ 'qualityname', 'disabled' ] ],
6825       'index'       => [],
6826     },
6827
6828     'svc_video' => {
6829       'columns' => [
6830         'svcnum',            'int', '', '', '', '',
6831         'smartcard_num', 'varchar', '', 16, '', '',
6832         'mac_addr',      'varchar', '', 12, '', '',
6833         'duration',          'int', '', '', '', '',
6834       ],
6835       'primary_key' => 'svcnum',
6836       'unique' => [], # [ 'smartcard_num' ], [ 'mac_addr' ], ],
6837       'index'  => [],
6838       'foreign_keys' => [
6839                           { columns => [ 'svcnum' ],
6840                             table   => 'cust_svc',
6841                           },
6842                         ],
6843     },
6844
6845     'circuit_type' => {
6846       'columns' => [
6847         'typenum',     'serial',     '',      '', '', '',
6848         'typename',   'varchar',     '', $char_d, '', '',
6849         'disabled',      'char', 'NULL',       1, '', '',
6850         # speed? number of voice lines? anything else?
6851       ],
6852       'primary_key' => 'typenum',
6853       'unique' => [ [ 'typename' ] ],
6854       'index'  => [],
6855     },
6856
6857     'circuit_provider' => {
6858       'columns' => [
6859         'providernum', 'serial',     '',      '', '', '',
6860         'provider',   'varchar',     '', $char_d, '', '',
6861         'disabled',      'char', 'NULL',       1, '', '',
6862       ],
6863       'primary_key' => 'providernum',
6864       'unique' => [ [ 'provider' ], ],
6865       'index'  => [],
6866     },
6867
6868     'circuit_termination' => {
6869       'columns' => [
6870         'termnum',     'serial',     '',      '', '', '',
6871         'termination','varchar',     '', $char_d, '', '',
6872         'disabled',      'char', 'NULL',       1, '', '',
6873       ],
6874       'primary_key' => 'termnum',
6875       'unique' => [ [ 'termination' ] ],
6876       'index' => [],
6877     },
6878
6879     'svc_circuit' => {
6880       'columns' => [
6881         'svcnum',                   'int',     '', '', '', '',
6882         'typenum',                  'int',     '', '', '', '',
6883         'providernum',              'int',     '', '', '', '',
6884         'termnum',                  'int',     '', '', '', '',
6885         'circuit_id',           'varchar',     '', 64, '', '',
6886         'desired_due_date',         'int', 'NULL', '', '', '',
6887         'due_date',                 'int', 'NULL', '', '', '',
6888         'vendor_order_id',      'varchar', 'NULL', $char_d,  '', '',
6889         'vendor_qual_id',       'varchar', 'NULL', $char_d,  '', '',
6890         'vendor_order_type',    'varchar', 'NULL', $char_d,  '', '',
6891         'vendor_order_status',  'varchar', 'NULL', $char_d,  '', '',
6892         'endpoint_ip_addr',     'varchar', 'NULL', 40, '', '',
6893         'endpoint_mac_addr',    'varchar', 'NULL', 12, '', '',
6894       ],
6895       'primary_key' => 'svcnum',
6896       'unique'      => [],
6897       'index'       => [ [ 'providernum' ], [ 'typenum' ] ],
6898       'foreign_keys' => [
6899                           { columns => [ 'svcnum' ],
6900                             table   => 'cust_svc',
6901                           },
6902                           { columns => [ 'typenum' ],
6903                             table   => 'circuit_type',
6904                           },
6905                           { columns => [ 'providernum' ],
6906                             table   => 'circuit_provider',
6907                           },
6908                           { columns => [ 'termnum' ],
6909                             table   => 'circuit_termination',
6910                           },
6911       ],
6912     },
6913
6914     'svc_fiber' => {
6915       'columns' => [
6916         'svcnum',         'int',     '',      '', '', '',
6917         'oltnum',         'int', 'NULL',      '', '', '',
6918         'shelf',          'int', 'NULL',      '', '', '',
6919         'card',           'int', 'NULL',      '', '', '',
6920         'olt_port',       'int', 'NULL',      '', '', '',
6921         'ont_id',         'int', 'NULL',      '', '', '',
6922         'ont_typenum',    'int', 'NULL',      '', '', '',
6923         'ont_serial', 'varchar', 'NULL', $char_d, '', '',
6924         'ont_port',   'varchar', 'NULL',      16, '', '',
6925         'circuit_id', 'varchar', 'NULL', $char_d, '', '',
6926         'vlan',           'int', 'NULL',      '', '', '',
6927         'signal',     'decimal', 'NULL',  '10,2', '', '',
6928         'speed_up',       'int', 'NULL',      '', '', '',
6929         'speed_down',     'int', 'NULL',      '', '', '',
6930         'ont_install','varchar', 'NULL', $char_d, '', '',
6931       ],
6932       'primary_key' => 'svcnum',
6933       'unique'      => [ ],
6934       'index'       => [ [ 'ont_serial' ] ],
6935       'foreign_keys' => [
6936                           { columns => [ 'svcnum' ],
6937                             table   => 'cust_svc',
6938                           },
6939                           { columns => [ 'oltnum' ],
6940                             table   => 'fiber_olt',
6941                           },
6942                           { columns => [ 'ont_typenum' ],
6943                             table   => 'hardware_type',
6944                             references => [ 'typenum' ],
6945                           },
6946                         ],
6947     },
6948
6949     'fiber_olt' => {
6950       'columns' => [
6951         'oltnum',   'serial', '',       '', '', '',
6952         'oltname', 'varchar', '',  $char_d, '', '',
6953         'sitenum',     'int', 'NULL',   '', '', '',
6954         'serial',  'varchar', '',  $char_d, '', '',
6955         'disabled',   'char', 'NULL',    1, '', '',
6956       ],
6957       'primary_key' => 'oltnum',
6958       'unique' => [ ],
6959       'index'  => [ ],
6960       'foreign_keys' => [
6961                           { columns => [ 'sitenum' ],
6962                             table   => 'olt_site',
6963                           },
6964                         ],
6965     },
6966
6967     'olt_site' => {
6968       'columns' => [
6969         'sitenum',  'serial', '',      '', '', '',
6970         'market',  'varchar', '', $char_d, '', '',
6971         'site',    'varchar', '', $char_d, '', '',
6972       ],
6973       'primary_key' => 'sitenum',
6974       'unique' => [ [ 'market', 'site' ] ],
6975       'index' => [ ],
6976     },
6977
6978
6979
6980
6981
6982     'vend_main' => {
6983       'columns' => [
6984         'vendnum',   'serial',     '',      '', '', '',
6985         'vendname', 'varchar',     '', $char_d, '', '',
6986         'classnum',     'int',     '',      '', '', '',
6987         'disabled',    'char', 'NULL',       1, '', '',
6988       ],
6989       'primary_key'  => 'vendnum',
6990       'unique'       => [ ['vendname', 'disabled'] ],
6991       'index'        => [],
6992       'foreign_keys' => [
6993                           { columns    => [ 'classnum' ],
6994                             table      => 'vend_class',
6995                           },
6996                         ],
6997     },
6998
6999     'vend_class' => {
7000       'columns' => [
7001         'classnum',     'serial',     '',      '', '', '',
7002         'classname',   'varchar',     '', $char_d, '', '',
7003         'disabled',       'char', 'NULL',       1, '', '',
7004       ],
7005       'primary_key' => 'classnum',
7006       'unique'      => [],
7007       'index'       => [ ['disabled'] ],
7008     },
7009
7010     'vend_bill' => {
7011       'columns' => [
7012         'vendbillnum',    'serial',     '',      '', '', '',
7013         'vendnum',           'int',     '',      '', '', '',
7014         #'_date',        @date_type,                  '', '',
7015         '_date',     'int', '', '',                   '', '',
7016         'charged',     @money_type,                  '', '',
7017       ],
7018       'primary_key'  => 'vendbillnum',
7019       'unique'       => [],
7020       'index'        => [ ['vendnum'], ['_date'], ],
7021       'foreign_keys' => [
7022                           { columns    => [ 'vendnum' ],
7023                             table      => 'vend_main',
7024                           },
7025                         ],
7026     },
7027
7028     'vend_pay' => {
7029       'columns' => [
7030         'vendpaynum',   'serial',    '',       '', '', '',
7031         'vendnum',         'int',    '',       '', '', '',
7032         #'_date',     @date_type,                   '', '',
7033         '_date',     'int', '', '',                   '', '',
7034         'paid',      @money_type,                  '', '',
7035       ],
7036       'primary_key'  => 'vendpaynum',
7037       'unique'       => [],
7038       'index'        => [ [ 'vendnum' ], [ '_date' ], ],
7039       'foreign_keys' => [
7040                           { columns    => [ 'vendnum' ],
7041                             table      => 'vend_main',
7042                           },
7043                         ],
7044     },
7045
7046     'vend_bill_pay' => {
7047       'columns' => [
7048         'vendbillpaynum', 'serial',     '',   '', '', '',
7049         'vendbillnum',       'int',     '',   '', '', '',
7050         'vendpaynum',        'int',     '',   '', '', '',
7051         'amount',  @money_type, '', '',
7052         #? '_date',   @date_type, '', '',
7053       ],
7054       'primary_key'  => 'vendbillpaynum',
7055       'unique'       => [],
7056       'index'        => [ [ 'vendbillnum' ], [ 'vendpaynum' ] ],
7057       'foreign_keys' => [
7058                           { columns    => [ 'vendbillnum' ],
7059                             table      => 'vend_bill',
7060                           },
7061                           { columns    => [ 'vendpaynum' ],
7062                             table      => 'vend_pay',
7063                           },
7064                         ],
7065     },
7066
7067     %{ tables_hashref_torrus() },
7068
7069     # tables of ours for doing torrus virtual port combining
7070     'torrus_srvderive' => {
7071       'columns' => [
7072         'derivenum',     'serial',     '', '', '', '',
7073         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
7074         'last_srv_date',   'date', 'NULL', '', '', '',
7075       ],
7076       'primary_key' => 'derivenum',
7077       'unique' => [ ['serviceid'] ],
7078       'index'  => [],
7079     },
7080
7081     'torrus_srvderive_component' => {
7082       'columns' => [
7083         'componentnum', 'serial', '', '', '', '',
7084         'derivenum',       'int', '', '', '', '',
7085         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
7086       ],
7087       'primary_key'  => 'componentnum',
7088       'unique'       => [ [ 'derivenum', 'serviceid' ], ],
7089       'index'        => [ [ 'derivenum', ], ],
7090       'foreign_keys' => [
7091                           { columns    => [ 'derivenum' ],
7092                             table      => 'torrus_srvderive',
7093                           },
7094                         ],
7095     },
7096
7097     'invoice_mode' => {
7098       'columns' => [
7099         'modenum',      'serial', '', '', '', '',
7100         'agentnum',        'int', 'NULL', '', '', '',
7101         'modename',    'varchar', '', 32, '', '',
7102       ],
7103       'primary_key' => 'modenum',
7104       'unique'      => [ ],
7105       'index'       => [ ],
7106       'foreign_keys' => [
7107                           { columns    => [ 'agentnum' ],
7108                             table      => 'agent',
7109                           },
7110                         ],
7111     },
7112
7113     'invoice_conf' => {
7114       'columns' => [
7115         'confnum',              'serial',   '', '', '', '',
7116         'modenum',              'int',      '', '', '', '',
7117         'locale',               'varchar',  'NULL', 16, '', '',
7118         'notice_name',          'varchar',  'NULL', 64, '', '',
7119         'subject',              'varchar',  'NULL', 64, '', '',
7120         'htmlnotes',            'text',     'NULL', '', '', '',
7121         'htmlfooter',           'text',     'NULL', '', '', '',
7122         'htmlsummary',          'text',     'NULL', '', '', '',
7123         'htmlreturnaddress',    'text',     'NULL', '', '', '',
7124         'latexnotes',           'text',     'NULL', '', '', '',
7125         'latexfooter',          'text',     'NULL', '', '', '',
7126         'latexsummary',         'text',     'NULL', '', '', '',
7127         'latexsmallfooter',     'text',     'NULL', '', '', '',
7128         'latexreturnaddress',   'text',     'NULL', '', '', '',
7129         'with_latexcoupon',     'char',     'NULL', '1', '', '',
7130         'htmlwatermark',        'text',     'NULL', '', '', '',
7131         'latexwatermark',       'text',     'NULL', '', '', '',
7132         'lpr',                  'varchar',  'NULL', $char_d, '', '',
7133       ],
7134       'primary_key'  => 'confnum',
7135       'unique'       => [ [ 'modenum', 'locale' ] ],
7136       'index'        => [ ],
7137       'foreign_keys' => [
7138                           { columns    => [ 'modenum' ],
7139                             table      => 'invoice_mode',
7140                           },
7141                         ],
7142     },
7143
7144     'export_batch' => {
7145       'columns' => [
7146         'batchnum',    'serial',     '',      '', '', '',
7147         'exportnum',      'int',     '',      '', '', '',
7148         '_date',          'int',     '',      '', '', '',
7149         'status',     'varchar', 'NULL',      32, '', '',
7150         'statustext',    'text', 'NULL',      '', '', '',
7151       ],
7152       'primary_key'  => 'batchnum',
7153       'unique'       => [],
7154       'index'        => [ [ 'exportnum' ], [ 'status' ] ],
7155       'foreign_keys' => [
7156                           { columns    => [ 'exportnum' ],
7157                             table      => 'part_export',
7158                             references => [ 'exportnum' ]
7159                           },
7160                         ],
7161     },
7162
7163     'export_batch_item' => {
7164       'columns' => [
7165         'itemnum',     'serial',     '',      '', '', '',
7166         'batchnum',       'int',     '',      '', '', '',
7167         'svcnum',         'int',     '',      '', '', '',
7168         'action',     'varchar',     '',      32, '', '',
7169         'data',          'text', 'NULL',      '', '', '',
7170         'frozen',        'char', 'NULL',       1, '', '',
7171       ],
7172       'primary_key'  => 'itemnum',
7173       'unique'       => [],
7174       'index'        => [ [ 'batchnum' ], [ 'svcnum' ] ],
7175       'foreign_keys' => [
7176                           { columns    => [ 'batchnum' ],
7177                             table      => 'export_batch',
7178                             references => [ 'batchnum' ]
7179                           },
7180                         ],
7181     },
7182
7183     # lookup table for states, similar to msa and lata
7184     'state' => {
7185       'columns' => [
7186         'statenum', 'int',  '', '', '', '',
7187         'country',  'char', '',  2, '', '',
7188         'state',    'char', '', $char_d, '', '',
7189         'fips',     'char', '',  3, '', '',
7190       ],
7191       'primary_key' => 'statenum',
7192       'unique' => [ [ 'country', 'state' ], ],
7193       'index' => [],
7194     },
7195
7196     # eventually link to tower/sector?
7197     'deploy_zone' => {
7198       'columns' => [
7199         'zonenum',        'serial',  '',     '',      '', '',
7200         'description',    'char',    'NULL', $char_d, '', '',
7201         'agentnum',       'int',     '',     '',      '', '',
7202         'censusyear',     'char',    'NULL', 4,      '', '',
7203         'dbaname',        'char',    'NULL', $char_d, '', '',
7204         'zonetype',       'char',    '',     1,       '', '',
7205         'technology',     'int',     '',     '',      '', '',
7206         'spectrum',       'int',     'NULL', '',      '', '',
7207         'adv_speed_up',   'decimal', '',     '10,3', '0', '',
7208         'adv_speed_down', 'decimal', '',     '10,3', '0', '',
7209         'cir_speed_up',   'decimal', '',     '10,3', '0', '',
7210         'cir_speed_down', 'decimal', '',     '10,3', '0', '',
7211         'is_broadband',   'char',    'NULL', 1,       '', '',
7212         'is_voice',       'char',    'NULL', 1,       '', '',
7213         'is_consumer',    'char',    'NULL', 1,       '', '',
7214         'is_business',    'char',    'NULL', 1,       '', '',
7215         'active_date',    @date_type,                 '', '',
7216         'expire_date',    @date_type,                 '', '',
7217       ],
7218       'primary_key' => 'zonenum',
7219       'unique' => [],
7220       'index'  => [ [ 'agentnum' ] ],
7221       'foreign_keys' => [
7222                           { columns     => [ 'agentnum' ],
7223                             table       => 'agent',
7224                             references  => [ 'agentnum' ],
7225                           },
7226                         ],
7227     },
7228
7229     'deploy_zone_block' => {
7230       'columns' => [
7231         'blocknum',       'serial',  '',     '',      '', '',
7232         'zonenum',        'int',     '',     '',      '', '',
7233         'censusblock',    'char',    '',     15,      '', '',
7234         'censusyear',     'char','NULL',      4,      '', '',
7235       ],
7236       'primary_key' => 'blocknum',
7237       'unique' => [],
7238       'index'  => [ [ 'zonenum' ] ],
7239       'foreign_keys' => [
7240                           { columns     => [ 'zonenum' ],
7241                             table       => 'deploy_zone',
7242                             references  => [ 'zonenum' ],
7243                           },
7244                         ],
7245     },
7246
7247     'deploy_zone_vertex' => {
7248       'columns' => [
7249         'vertexnum',      'serial',  '',     '',      '', '',
7250         'zonenum',        'int',     '',     '',      '', '',
7251         'latitude',       'decimal', '',     '10,7',  '', '',
7252         'longitude',      'decimal', '',     '10,7',  '', '',
7253       ],
7254       'primary_key' => 'vertexnum',
7255       'unique' => [ ],
7256       'index'  => [ ],
7257       'foreign_keys' => [
7258                           { columns     => [ 'zonenum' ],
7259                             table       => 'deploy_zone',
7260                             references  => [ 'zonenum' ],
7261                           },
7262                         ],
7263     },
7264
7265     'cacti_page' => {
7266       'columns' => [
7267         'cacti_pagenum',  'serial',   '',     '', '', '',
7268         'exportnum',      'int',      'NULL', '', '', '',
7269         'svcnum',         'int',      'NULL', '', '', '',
7270         'graphnum',       'int',      'NULL', '', '', '',
7271         'imported',       @date_type,             '', '',
7272         'content',        'text',     'NULL', '', '', '',
7273       ],
7274       'primary_key' => 'cacti_pagenum',
7275       'unique'  => [ ],
7276       'index'   => [ ['svcnum'], ['imported'] ],
7277       'foreign_keys' => [
7278                           { columns    => [ 'svcnum' ],
7279                             table      => 'cust_svc',
7280                             references => [ 'svcnum' ],
7281                           },
7282                           { columns    => [ 'exportnum' ],
7283                             table      => 'part_export',
7284                             references => [ 'exportnum' ],
7285                           },
7286                         ],
7287     },
7288
7289     'report_batch' => {
7290       'columns' => [
7291         'reportbatchnum', 'serial',      '',  '', '', '',
7292         'reportname',     'varchar',     '', 255, '', '',
7293         'agentnum',           'int', 'NULL',  '', '', '',
7294         'send_date',     @date_type,              '', '',
7295         'sdate',         @date_type,              '', '',
7296         'edate',         @date_type,              '', '',
7297         'usernum',            'int', 'NULL',  '', '', '',
7298         'msgnum',             'int', 'NULL',  '', '', '',
7299         # add report params here as necessary
7300       ],
7301       'primary_key' => 'reportbatchnum',
7302       'unique' => [],
7303       'index'  => [],
7304       'foreign_keys' => [
7305                           { columns    => [ 'agentnum' ],
7306                             table      => 'agent',
7307                             references => [ 'agentnum' ],
7308                           },
7309                           { columns    => [ 'usernum' ],
7310                             table      => 'access_user',
7311                             references => [ 'usernum' ],
7312                           },
7313                           { columns    => [ 'msgnum' ],
7314                             table      => 'msg_template',
7315                             references => [ 'msgnum' ],
7316                           },
7317                         ],
7318     },
7319
7320     'password_history' => {
7321       'columns' => [
7322         'passwordnum',        'serial',  '',          '', '', '',
7323         '_password',          'varchar', 'NULL', $char_d, '', '',
7324         'encryption_method',  'varchar', 'NULL', $char_d, '', '',
7325         'created',   @date_type,   '', '',
7326         # each table that needs password history gets a column here, and
7327         # an entry in foreign_keys.
7328         'svc_acct__svcnum',     'int', 'NULL', '', '', '',
7329         'svc_dsl__svcnum',      'int', 'NULL', '', '', '',
7330         'svc_alarm__svcnum',    'int', 'NULL', '', '', '',
7331         'agent__agentnum',      'int', 'NULL', '', '', '',
7332         'contact__contactnum',  'int', 'NULL', '', '', '',
7333         'access_user__usernum', 'int', 'NULL', '', '', '',
7334       ],
7335       'primary_key' => 'passwordnum',
7336       'unique' => [],
7337       'index'  => [],
7338       'foreign_keys' => [
7339                           { columns     => [ 'svc_acct__svcnum' ],
7340                             table       => 'svc_acct',
7341                             references  => [ 'svcnum' ],
7342                           },
7343                           { columns     => [ 'svc_dsl__svcnum' ],
7344                             table       => 'svc_dsl',
7345                             references  => [ 'svcnum' ],
7346                           },
7347                           { columns     => [ 'svc_alarm__svcnum' ],
7348                             table       => 'svc_alarm',
7349                             references  => [ 'svcnum' ],
7350                           },
7351                           { columns    => [ 'agent__agentnum' ],
7352                             table      => 'agent',
7353                             references => [ 'agentnum' ],
7354                           },
7355                           { columns    => [ 'contact__contactnum' ],
7356                             table      => 'contact',
7357                             references => [ 'contactnum' ],
7358                           },
7359                           { columns    => [ 'access_user__usernum' ],
7360                             table      => 'access_user',
7361                             references => [ 'usernum' ],
7362                           },
7363                         ],
7364     },
7365
7366     'webservice_log' => {
7367       'columns' => [
7368         'webservicelognum',    'serial',      '',      '', '', '', #big? hubrus
7369         'svcnum',                 'int',  'NULL',      '', '', '', #just in case
7370         'custnum',                'int',      '',      '', '', '',
7371         'method',             'varchar',      '', $char_d, '', '',
7372         'quantity',               'int',      '',      '', '', '', #i.e. pages
7373         '_date',             @date_type,                   '', '',
7374         'status',             'varchar',  'NULL', $char_d, '', '',
7375         'rated_price',        'decimal',  'NULL',  '10,2', '', '',
7376       ],
7377       'primary_key'  => 'webservicelognum',
7378       'unique'       => [],
7379       'index'        => [ ['custnum'], ['status'] ],
7380       'foreign_keys' => [
7381                           { columns => [ 'custnum' ],
7382                             table   => 'cust_main',
7383                           },
7384                           #no FK on svcnum... we don't want to purge these on
7385                           # service deletion
7386                         ],
7387     },
7388
7389     # name type nullability length default local
7390
7391     #'new_table' => {
7392     #  'columns' => [
7393     #    'num', 'serial',       '', '', '', '',
7394     #  ],
7395     #  'primary_key' => 'num',
7396     #  'unique' => [],
7397     #  'index'  => [],
7398     #},
7399
7400   };
7401
7402 }
7403
7404 =back
7405
7406 =head1 BUGS
7407
7408 =head1 SEE ALSO
7409
7410 L<DBIx::DBSchema>
7411
7412 =cut
7413
7414 1;
7415