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