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                           { columns    => [ 'svcnum' ],
3890                             table      => 'svc_acct', #'cust_svc',
3891                           },
3892                           # 1. RT tables aren't part of our data structure, so
3893                           #     we can't make sure Queue is created already
3894                           # 2. This is our internal hack for time tracking, not
3895                           #     a user-facing feature
3896                           #{ columns    => [ 'transaction_id' ],
3897                           #  table      => 'Transaction',
3898                           #  references => [ 'id' ],
3899                           #},
3900                         ],
3901     },
3902
3903     #'svc_charge' => {
3904     #  'columns' => [
3905     #    'svcnum',    'int',    '',   '',
3906     #    'amount',    @money_type,
3907     #  ],
3908     #  'primary_key' => 'svcnum',
3909     #  'unique' => [ [] ],
3910     #  'index' => [ [] ],
3911     #},
3912
3913     'svc_domain' => {
3914       'columns' => [
3915         'svcnum',           'int',    '',        '', '', '',
3916         'domain',       'varchar',    '',   $char_d, '', '',
3917         'suffix',       'varchar', 'NULL',  $char_d, '', '',
3918         'catchall',         'int', 'NULL',       '', '', '',
3919         'parent_svcnum',    'int', 'NULL',       '', '', '',
3920         'quota',        'varchar', 'NULL',  $char_d, '', '',
3921
3922         #registration info
3923         'registrarnum',     'int', 'NULL',       '', '', '',
3924         'registrarkey', 'varchar', 'NULL',      512, '', '',
3925         'setup_date',      @date_type, '', '',
3926         'renewal_interval', 'int', 'NULL',       '', '', '',
3927         'expiration_date', @date_type, '', '',
3928
3929         #some weird shit australia-specific shit?  yuck.. seems totally unused
3930         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
3931         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
3932
3933         #communigate pro fields (quota = MaxAccountSize)
3934         'max_accounts',     'int', 'NULL',       '', '', '',
3935         'trailer',         'text', 'NULL',       '', '', '',
3936         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
3937         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
3938         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
3939
3940         #(account default) settings
3941         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
3942         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
3943         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
3944         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
3945         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
3946         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
3947         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
3948         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
3949         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
3950         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
3951         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
3952         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
3953
3954         #(account default) preferences
3955         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
3956         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
3957         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
3958         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
3959         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
3960         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
3961         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
3962       ],
3963       'primary_key'  => 'svcnum',
3964       'unique'       => [],
3965       'index'        => [ ['domain'] ],
3966       'foreign_keys' => [
3967                           { columns    => [ 'svcnum' ],
3968                             table      => 'cust_svc',
3969                           },
3970                           { columns    => [ 'catchall' ],
3971                             table      => 'svc_acct',
3972                             references => [ 'svcnum' ],
3973                           },
3974                           { columns    => [ 'parent_svcnum' ],
3975                             table      => 'cust_svc',
3976                             references => [ 'svcnum' ],
3977                           },
3978                           { columns    => [ 'registrarnum' ],
3979                             table      => 'registrar',
3980                           },
3981                         ],
3982     },
3983
3984     'svc_dsl' => {
3985       'columns' => [
3986         'svcnum',                    'int',    '',        '', '', '',
3987         'pushed',                    'int', 'NULL',       '', '', '',
3988         'desired_due_date',          'int', 'NULL',       '', '', '',
3989         'due_date',                  'int', 'NULL',       '', '', '',
3990         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
3991         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
3992         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
3993         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
3994         'first',                 'varchar', 'NULL', $char_d,  '', '',
3995         'last',                  'varchar', 'NULL', $char_d,  '', '',
3996         'company',               'varchar', 'NULL', $char_d,  '', '',
3997         'phonenum',              'varchar', 'NULL',      24, '', '',
3998         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
3999         'loop_type',                'char', 'NULL',       1, '', '',
4000         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
4001         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
4002         'rate_band',             'varchar', 'NULL', $char_d, '', '',
4003         'vpi',                       'int', 'NULL',      '', '', '',
4004         'vci',                       'int', 'NULL',      '', '', '',
4005         'isp_chg',                  'char', 'NULL',       1, '', '',
4006         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
4007         'username',              'varchar', 'NULL', $char_d, '', '',
4008         'password',              'varchar', 'NULL', $char_d, '', '',
4009         'staticips',                'text', 'NULL',      '', '', '',
4010         'monitored',                'char', 'NULL',       1, '', '',
4011         'last_pull',                 'int', 'NULL',      '', '', '',
4012       ],
4013       'primary_key'  => 'svcnum',
4014       'unique'       => [ ],
4015       'index'        => [ ['phonenum'], ['vendor_order_id'] ],
4016       'foreign_keys' => [
4017                           { columns    => [ 'svcnum' ],
4018                             table      => 'cust_svc',
4019                           },
4020                         ],
4021     },
4022
4023     'dsl_device' => {
4024       'columns' => [
4025         'devicenum', 'serial',     '', '', '', '',
4026         #part_device?  or our own part_dsl_device?
4027         #'devicepart',   'int',     '', '', '', '',
4028         'svcnum',       'int',     '', '', '', '',
4029         'mac_addr', 'varchar',     '', 12, '', '',
4030       ],
4031       'primary_key'  => 'devicenum',
4032       'unique'       => [ [ 'mac_addr' ], ],
4033       'index'        => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
4034       'foreign_keys' => [
4035                           { columns    => [ 'svcnum' ],
4036                             table      => 'svc_dsl',
4037                           },
4038                         ],
4039     },
4040
4041     'dsl_note' => {
4042       'columns' => [
4043         'notenum',           'serial',    '',        '', '', '',
4044         'svcnum',     'int', '',       '', '', '',
4045         'author',     'varchar', 'NULL', $char_d,  '', '',
4046         'priority',   'char', 'NULL',       1,  '', '',
4047         '_date',     'int', 'NULL',       '', '', '',
4048         'note',     'text', '',       '', '', '',
4049       ],
4050       'primary_key'  => 'notenum',
4051       'unique'       => [],
4052       'index'        => [ ['svcnum'] ],
4053       'foreign_keys' => [
4054                           { columns    => [ 'svcnum' ],
4055                             table      => 'svc_dsl',
4056                           },
4057                         ],
4058     },
4059
4060     'svc_dish' => {
4061       'columns' => [
4062         'svcnum',   'int',     '',     '', '', '',
4063         'acctnum',  'varchar', '',     16, '', '',
4064         'installdate', @date_type,         '', '',
4065         'note',     'text',    'NULL', '', '', '',
4066       ],
4067       'primary_key'  => 'svcnum',
4068       'unique'       => [],
4069       'index'        => [],
4070       'foreign_keys' => [
4071                           { columns    => [ 'svcnum' ],
4072                             table      => 'cust_svc',
4073                           },
4074                         ],
4075     },
4076
4077     'svc_hardware' => {
4078       'columns' => [
4079         'svcnum',   'int',     '',          '', '', '',
4080         'typenum',  'int',     '',          '', '', '',
4081         'serial',   'varchar', 'NULL', $char_d, '', '',
4082         'ip_addr',  'varchar', 'NULL',      40, '', '',
4083         'hw_addr',  'varchar', 'NULL',      12, '', '',
4084         'smartcard','varchar', 'NULL',      30, '', '',
4085         'statusnum','int',     'NULL',      '', '', '',
4086         'note',     'text',    'NULL',      '', '', '',
4087       ],
4088       'primary_key'  => 'svcnum',
4089       'unique'       => [],
4090       'index'        => [],
4091       'foreign_keys' => [
4092                           { columns    => [ 'svcnum' ],
4093                             table      => 'cust_svc',
4094                           },
4095                           { columns    => [ 'typenum' ],
4096                             table      => 'hardware_type',
4097                           },
4098                           { columns    => [ 'statusnum' ],
4099                             table      => 'hardware_status',
4100                           },
4101                         ],
4102     },
4103
4104     'hardware_class' => {
4105       'columns' => [
4106         'classnum',   'serial', '',      '', '', '',
4107         'classname', 'varchar', '', $char_d, '', '',
4108       ],
4109       'primary_key' => 'classnum',
4110       'unique' => [],
4111       'index'  => [],
4112     },
4113
4114     'hardware_type' => {
4115       'columns' => [
4116         'typenum',  'serial',     '',      '', '', '',
4117         'classnum',    'int',     '',      '', '', '',
4118         'model',   'varchar',     '', $char_d, '', '',
4119         'revision','varchar', 'NULL', $char_d, '', '',
4120       ],
4121       'primary_key'  => 'typenum',
4122       'unique'       => [ [ 'classnum', 'model', 'revision' ] ],
4123       'index'        => [],
4124       'foreign_keys' => [
4125                           { columns    => [ 'classnum' ],
4126                             table      => 'hardware_class',
4127                           },
4128                         ],
4129     },
4130
4131     'hardware_status' => {
4132       'columns' => [
4133         'statusnum', 'serial', '',      '', '', '',
4134         'label'    ,'varchar', '', $char_d, '', '',
4135         'disabled',    'char', 'NULL',   1, '', '',
4136       ],
4137       'primary_key' => 'statusnum',
4138       'unique' => [],
4139       'index'  => [],
4140     },
4141
4142     'domain_record' => {
4143       'columns' => [
4144         'recnum',    'serial',     '',  '', '', '',
4145         'svcnum',    'int',     '',  '', '', '',
4146         'reczone',   'varchar', '',  255, '', '',
4147         'recaf',     'char',    '',  2, '', '',
4148         'rectype',   'varchar',    '',  5, '', '',
4149         'recdata',   'varchar', '',  255, '', '',
4150         'ttl',       'int',     'NULL', '', '', '',
4151       ],
4152       'primary_key'  => 'recnum',
4153       'unique'       => [],
4154       'index'        => [ ['svcnum'] ],
4155       'foreign_keys' => [
4156                           { columns    => [ 'svcnum' ],
4157                             table      => 'svc_domain',
4158                           },
4159                         ],
4160     },
4161
4162     'registrar' => {
4163       'columns' => [
4164         'registrarnum',   'serial', '',      '', '', '',
4165         'registrarname', 'varchar', '', $char_d, '', '',
4166       ],
4167       'primary_key' => 'registrarnum',
4168       'unique'      => [],
4169       'index'       => [],
4170     },
4171
4172     'cgp_rule' => {
4173       'columns' => [
4174         'rulenum',  'serial',     '',      '', '', '',
4175         'name',    'varchar',     '', $char_d, '', '',
4176         'comment', 'varchar', 'NULL', $char_d, '', '',
4177         'svcnum',      'int',     '',      '', '', '',
4178         'priority',    'int',     '',      '', '', '',
4179       ],
4180       'primary_key' => 'rulenum',
4181       'unique'      => [ [ 'svcnum', 'name' ] ],
4182       'index'       => [ [ 'svcnum' ] ],
4183       'foreign_keys' => [
4184                           { columns    => [ 'svcnum' ],
4185                             table      => 'cust_svc', #svc_acct / svc_domain
4186                           },
4187                         ],
4188     },
4189
4190     'cgp_rule_condition' => {
4191       'columns' => [
4192         'ruleconditionnum',  'serial',     '',      '', '', '',
4193         'conditionname',    'varchar',     '', $char_d, '', '',
4194         'op',               'varchar', 'NULL', $char_d, '', '',
4195         'params',           'varchar', 'NULL',     255, '', '',
4196         'rulenum',              'int',     '',      '', '', '',
4197       ],
4198       'primary_key'  => 'ruleconditionnum',
4199       'unique'       => [],
4200       'index'        => [ [ 'rulenum' ] ],
4201       'foreign_keys' => [
4202                           { columns    => [ 'rulenum' ],
4203                             table      => 'cgp_rule',
4204                           },
4205                         ],
4206     },
4207
4208     'cgp_rule_action' => {
4209        'columns' => [
4210         'ruleactionnum',  'serial',     '',      '', '', '',
4211         'action',        'varchar',     '', $char_d, '', '',
4212         'params',        'varchar', 'NULL',     255, '', '',
4213         'rulenum',           'int',     '',      '', '', '',
4214       ],
4215       'primary_key'  => 'ruleactionnum',
4216       'unique'       => [],
4217       'index'        => [ [ 'rulenum' ] ],
4218       'foreign_keys' => [
4219                           { columns    => [ 'rulenum' ],
4220                             table      => 'cgp_rule',
4221                           },
4222                         ],
4223    },
4224
4225     'svc_forward' => {
4226       'columns' => [
4227         'svcnum',   'int',            '',   '', '', '',
4228         'srcsvc',   'int',        'NULL',   '', '', '',
4229         'src',      'varchar',    'NULL',  255, '', '',
4230         'dstsvc',   'int',        'NULL',   '', '', '',
4231         'dst',      'varchar',    'NULL',  255, '', '',
4232       ],
4233       'primary_key'  => 'svcnum',
4234       'unique'       => [],
4235       'index'        => [ ['srcsvc'], ['dstsvc'] ],
4236       'foreign_keys' => [
4237                           { columns    => [ 'svcnum' ],
4238                             table      => 'cust_svc',
4239                           },
4240                           { columns    => [ 'srcsvc' ],
4241                             table      => 'svc_acct',
4242                             references => [ 'svcnum' ]
4243                           },
4244                           { columns    => [ 'dstsvc' ],
4245                             table      => 'svc_acct',
4246                             references => [ 'svcnum' ]
4247                           },
4248                         ],
4249     },
4250
4251     'svc_www' => {
4252       'columns' => [
4253         'svcnum',   'int',      '',  '', '', '',
4254         'recnum',   'int',      '',  '', '', '',
4255         'usersvc',  'int',  'NULL',  '', '', '',
4256         'config',   'text', 'NULL',  '', '', '',
4257       ],
4258       'primary_key' => 'svcnum',
4259       'unique'      => [],
4260       'index'       => [],
4261       'foreign_keys' => [
4262                           { columns    => [ 'svcnum' ],
4263                             table      => 'cust_svc',
4264                           },
4265                           { columns    => [ 'recnum' ],
4266                             table      => 'domain_record',
4267                           },
4268                           { columns    => [ 'usersvc' ],
4269                             table      => 'svc_acct',
4270                             references => [ 'svcnum' ]
4271                           },
4272                         ],
4273     },
4274
4275     #'svc_wo' => {
4276     #  'columns' => [
4277     #    'svcnum',    'int',    '',   '',
4278     #    'svcnum',    'int',    '',   '',
4279     #    'svcnum',    'int',    '',   '',
4280     #    'worker',    'varchar',   '',   $char_d,
4281     #    '_date',     @date_type,
4282     #  ],
4283     #  'primary_key' => 'svcnum',
4284     #  'unique' => [ [] ],
4285     #  'index' => [ [] ],
4286     #},
4287
4288     'prepay_credit' => {
4289       'columns' => [
4290         'prepaynum',   'serial',     '',   '', '', '',
4291         'identifier',  'varchar', '', $char_d, '', '',
4292         'amount',      @money_type, '', '',
4293         'seconds',     'int',     'NULL', '', '', '',
4294         'upbytes',     'bigint',     'NULL', '', '', '',
4295         'downbytes',   'bigint',     'NULL', '', '', '',
4296         'totalbytes',  'bigint',     'NULL', '', '', '',
4297         'agentnum',    'int',     'NULL', '', '', '',
4298       ],
4299       'primary_key'  => 'prepaynum',
4300       'unique'       => [ ['identifier'] ],
4301       'index'        => [ ['agentnum'] ],
4302       'foreign_keys' => [
4303                           { columns    => [ 'agentnum' ],
4304                             table      => 'agent',
4305                           },
4306                         ],
4307     },
4308
4309     'port' => {
4310       'columns' => [
4311         'portnum',  'serial',     '',   '', '', '',
4312         'ip',       'varchar', 'NULL', 15, '', '',
4313         'nasport',  'int',     'NULL', '', '', '',
4314         'nasnum',   'int',     '',   '', '', '',
4315       ],
4316       'primary_key'  => 'portnum',
4317       'unique'       => [],
4318       'index'        => [],
4319       'foreign_keys' => [
4320                           { columns    => [ 'nasnum' ],
4321                             table      => 'nas',
4322                           },
4323                         ],
4324     },
4325
4326     'nas' => {
4327       'columns' => [
4328         'nasnum',       'serial',     '',  '',              '', '',
4329         'nasname',     'varchar',     '', 128,              '', '',
4330         'shortname',   'varchar', 'NULL',  32,              '', '',
4331         'type',        'varchar',     '',  30,         'other', '',
4332         'ports',           'int', 'NULL',  '',              '', '',
4333         'secret',      'varchar',     '',  60,        'secret', '',
4334         'server',      'varchar', 'NULL',  64,              '', '',
4335         'community',   'varchar', 'NULL',  50,              '', '',
4336         'description', 'varchar',     '', 200, 'RADIUS Client', '',
4337         'svcnum',          'int', 'NULL',  '',              '', '',
4338       ],
4339       'primary_key'  => 'nasnum',
4340       'unique'       => [ [ 'nasname' ], ],
4341       'index'        => [],
4342       'foreign_keys' => [
4343                           { columns    => [ 'svcnum' ],
4344                             table      => 'svc_broadband',#no? could be _acct?
4345                                                           #remove or cust_svc?
4346                           },
4347                         ],
4348     },
4349
4350     'export_nas' => {
4351       'columns' => [
4352         'exportnasnum', 'serial', '', '', '', '',
4353         'exportnum',       'int', '', '', '', '',
4354         'nasnum',          'int', '', '', '', '',
4355       ],
4356       'primary_key'  => 'exportnasnum',
4357       'unique'       => [ [ 'exportnum', 'nasnum' ] ],
4358       'index'        => [ [ 'exportnum' ], [ 'nasnum' ] ],
4359       'foreign_keys' => [
4360                           { columns    => [ 'exportnum' ],
4361                             table      => 'part_export',
4362                           },
4363                           { columns    => [ 'nasnum' ],
4364                             table      => 'nas',
4365                           },
4366                         ],
4367     },
4368
4369     'queue' => {
4370       'columns' => [
4371         'jobnum',   'bigserial',     '',      '', '', '',
4372         'job',        'varchar',     '',     512, '', '',
4373         '_date',          'int',     '',      '', '', '',
4374         'status',     'varchar',     '', $char_d, '', '',
4375         'statustext',    'text', 'NULL',      '', '', '',
4376         'svcnum',         'int', 'NULL',      '', '', '',
4377         'custnum',        'int', 'NULL',      '', '', '',
4378         'secure',        'char', 'NULL',       1, '', '',
4379         'priority',       'int', 'NULL',      '', '', '',
4380         'usernum',        'int', 'NULL',      '', '', '',
4381       ],
4382       'primary_key'  => 'jobnum',
4383       'unique'       => [],
4384       'index'        => [ [ 'secure' ], [ 'priority' ],
4385                           [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
4386                         ],
4387       'foreign_keys' => [
4388 #                          { columns    => [ 'svcnum' ],
4389 #                            table      => 'cust_svc',
4390 #                          },
4391                           { columns    => [ 'custnum' ],
4392                             table      => 'cust_main',
4393                           },
4394                           { columns    => [ 'usernum' ],
4395                             table      => 'access_user',
4396                           },
4397                         ],
4398     },
4399
4400     'queue_arg' => {
4401       'columns' => [
4402         'argnum', 'bigserial',     '', '', '', '',
4403         'jobnum',    'bigint',     '', '', '', '',
4404         'frozen',      'char', 'NULL',  1, '', '',
4405         'arg',         'text', 'NULL', '', '', '',
4406       ],
4407       'primary_key'  => 'argnum',
4408       'unique'       => [],
4409       'index'        => [ [ 'jobnum' ] ],
4410       'foreign_keys' => [
4411                           { columns    => [ 'jobnum' ],
4412                             table      => 'queue',
4413                             on_delete  => 'CASCADE',
4414                           },
4415                         ],
4416     },
4417
4418     'queue_depend' => {
4419       'columns' => [
4420         'dependnum',  'bigserial', '', '', '', '',
4421         'jobnum',        'bigint', '', '', '', '',
4422         'depend_jobnum', 'bigint', '', '', '', '',
4423       ],
4424       'primary_key'  => 'dependnum',
4425       'unique'       => [],
4426       'index'        => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
4427       'foreign_keys' => [
4428                           { columns    => [ 'jobnum' ],
4429                             table      => 'queue',
4430                           },
4431                           { columns    => [ 'depend_jobnum' ],
4432                             table      => 'queue',
4433                             references => [ 'jobnum' ],
4434                             on_delete  => 'CASCADE',
4435                           },
4436                         ],
4437     },
4438
4439     'queue_stat' => {
4440       'columns' => [
4441         'statnum', 'bigserial',     '',  '', '', '',
4442         'jobnum',     'bigint',     '',  '', '', '',
4443         'job',       'varchar',     '', 512, '', '',
4444         'custnum',       'int', 'NULL',  '', '', '',
4445         'insert_date', @date_type, '', '',
4446         'start_date',  @date_type, '', '',
4447         'end_date',    @date_type, '', '',
4448       ],
4449       'primary_key'  => 'statnum',
4450       'unique'       => [], #[ ['jobnum'] ],
4451       'index'        => [],
4452     },
4453
4454     'export_svc' => {
4455       'columns' => [
4456         'exportsvcnum' => 'serial', '', '', '', '',
4457         'exportnum'    => 'int', '', '', '', '',
4458         'svcpart'      => 'int', '', '', '', '',
4459         'role'         => 'varchar', 'NULL', 16, '', '',
4460       ],
4461       'primary_key'  => 'exportsvcnum',
4462       'unique'       => [ [ 'exportnum', 'svcpart' ] ],
4463       'index'        => [ [ 'exportnum' ], [ 'svcpart' ] ],
4464       'foreign_keys' => [
4465                           { columns    => [ 'exportnum' ],
4466                             table      => 'part_export',
4467                           },
4468                           { columns    => [ 'svcpart' ],
4469                             table      => 'part_svc',
4470                           },
4471                         ],
4472     },
4473
4474     'export_cust_svc' => {
4475       'columns' => [
4476         'exportcustsvcnum', 'serial', '', '', '', '',
4477         'exportnum', 'int', '', '', '', '',
4478         'svcnum', 'int', '', '', '', '',
4479         'remoteid', 'varchar', '', 512, '', '',
4480       ],
4481       'primary_key'  => 'exportcustsvcnum',
4482       'unique'       => [ [ 'exportnum', 'svcnum' ] ],
4483       'index'        => [ [ 'exportnum', 'svcnum' ] ],
4484       'foreign_keys' => [
4485                           { columns    => [ 'exportnum' ],
4486                             table      => 'part_export',
4487                           },
4488                           { columns    => [ 'svcnum' ],
4489                             table      => 'cust_svc',
4490                           },
4491                         ],
4492     },
4493
4494     'export_device' => {
4495       'columns' => [
4496         'exportdevicenum' => 'serial', '', '', '', '',
4497         'exportnum'       => 'int', '', '', '', '',
4498         'devicepart'      => 'int', '', '', '', '',
4499       ],
4500       'primary_key'  => 'exportdevicenum',
4501       'unique'       => [ [ 'exportnum', 'devicepart' ] ],
4502       'index'        => [ [ 'exportnum' ], [ 'devicepart' ] ],
4503       'foreign_keys' => [
4504                           { columns    => [ 'exportnum' ],
4505                             table      => 'part_export',
4506                           },
4507                           { columns    => [ 'devicepart' ],
4508                             table      => 'part_device',
4509                           },
4510                         ],
4511     },
4512
4513     'part_export' => {
4514       'columns' => [
4515         'exportnum',   'serial',     '',      '', '', '',
4516         'exportname', 'varchar', 'NULL', $char_d, '', '',
4517         'machine',    'varchar', 'NULL', $char_d, '', '',
4518         'exporttype', 'varchar',     '', $char_d, '', '',
4519         'nodomain',      'char', 'NULL',       1, '', '',
4520         'default_machine','int', 'NULL',      '', '', '',
4521         'no_suspend',    'char', 'NULL',       1, '', '',
4522         # could also have 'no_insert', 'no_replace', etc.
4523       ],
4524       'primary_key'  => 'exportnum',
4525       'unique'       => [],
4526       'index'        => [ [ 'machine' ], [ 'exporttype' ] ],
4527       'foreign_keys' => [
4528                           { columns    => [ 'default_machine' ],
4529                             table      => 'part_export_machine',
4530                             references => [ 'machinenum' ]
4531                           },
4532                         ],
4533     },
4534
4535     'part_export_option' => {
4536       'columns' => [
4537         'optionnum', 'serial', '', '', '', '',
4538         'exportnum', 'int', '', '', '', '',
4539         'optionname', 'varchar', '', $char_d, '', '',
4540         'optionvalue', 'text', 'NULL', '', '', '',
4541       ],
4542       'primary_key'  => 'optionnum',
4543       'unique'       => [],
4544       'index'        => [ [ 'exportnum' ], [ 'optionname' ] ],
4545       'foreign_keys' => [
4546                           { columns    => [ 'exportnum' ],
4547                             table      => 'part_export',
4548                           },
4549                         ],
4550     },
4551
4552     'radius_usergroup' => {
4553       'columns' => [
4554         'usergroupnum', 'serial', '', '', '', '',
4555         'svcnum',       'int', '', '', '', '',
4556         'groupname',    'varchar', 'NULL', $char_d, '', '', #deprecated
4557         'groupnum',     'int', 'NULL', '', '', '',
4558       ],
4559       'primary_key'  => 'usergroupnum',
4560       'unique'       => [],
4561       'index'        => [ [ 'svcnum' ], [ 'groupname' ] ],
4562       'foreign_keys' => [
4563                           { columns    => [ 'svcnum' ],
4564                             table      => 'cust_svc', #svc_acct / svc_broadband
4565                           },
4566                           { columns    => [ 'groupnum' ],
4567                             table      => 'radius_group',
4568                           },
4569                         ],
4570     },
4571
4572     'radius_group' => {
4573       'columns' => [
4574         'groupnum', 'serial', '', '', '', '',
4575         'groupname',    'varchar', '', $char_d, '', '',
4576         'description',  'varchar', 'NULL', $char_d, '', '',
4577         'priority', 'int', '', '', '1', '',
4578         'speed_up', 'int', 'NULL', '', '', '',
4579         'speed_down', 'int', 'NULL', '', '', '',
4580       ],
4581       'primary_key' => 'groupnum',
4582       'unique'      => [ ['groupname'] ],
4583       'index'       => [],
4584     },
4585
4586     'radius_attr' => {
4587       'columns' => [
4588         'attrnum',   'serial', '',      '', '', '',
4589         'groupnum',     'int', '',      '', '', '',
4590         'attrname', 'varchar', '', $char_d, '', '',
4591         'value',    'varchar', '',     255, '', '',
4592         'attrtype',    'char', '',       1, '', '',
4593         'op',          'char', '',       2, '', '',
4594       ],
4595       'primary_key'  => 'attrnum',
4596       'unique'       => [],
4597       'index'        => [ ['groupnum'], ],
4598       'foreign_keys' => [
4599                           { columns    => [ 'groupnum' ],
4600                             table      => 'radius_group',
4601                           },
4602                         ],
4603     },
4604
4605     'msgcat' => {
4606       'columns' => [
4607         'msgnum', 'serial', '', '', '', '',
4608         'msgcode', 'varchar', '', 255, '', '',
4609         'locale', 'varchar', '', 16, '', '',
4610         'msg', 'text', '', '', '', '',
4611       ],
4612       'primary_key' => 'msgnum',
4613       'unique'      => [ [ 'msgcode', 'locale' ] ],
4614       'index'       => [],
4615     },
4616
4617     'cust_tax_exempt' => {
4618       'columns' => [
4619         'exemptnum', 'serial', '', '', '', '',
4620         'custnum',   'int', '', '', '', '',
4621         'taxnum',    'int', '', '', '', '',
4622         'year',      'int', '', '', '', '',
4623         'month',     'int', '', '', '', '',
4624         'amount',   @money_type, '', '',
4625       ],
4626       'primary_key'  => 'exemptnum',
4627       'unique'       => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
4628       'index'        => [],
4629       'foreign_keys' => [
4630                           { columns    => [ 'custnum' ],
4631                             table      => 'cust_main',
4632                           },
4633                           { columns    => [ 'taxnum' ],
4634                             table      => 'cust_main_county',
4635                           },
4636                         ],
4637     },
4638
4639     'cust_tax_exempt_pkg' => {
4640       'columns' => [
4641         'exemptpkgnum',  'serial', '', '', '', '',
4642         #'custnum',      'int', '', '', '', ''
4643         'billpkgnum',   'int', '', '', '', '',
4644         'taxnum',       'int', '', '', '', '',
4645         'taxtype',  'varchar', 'NULL', $char_d, '', '',
4646         'year',         'int', 'NULL', '', '', '',
4647         'month',        'int', 'NULL', '', '', '',
4648         'creditbillpkgnum', 'int', 'NULL', '', '', '',
4649         'amount',       @money_type, '', '',
4650         # exemption type flags
4651         'exempt_cust',          'char', 'NULL', 1, '', '',
4652         'exempt_setup',         'char', 'NULL', 1, '', '',
4653         'exempt_recur',         'char', 'NULL', 1, '', '',
4654         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
4655         'exempt_monthly',       'char', 'NULL', 1, '', '',
4656       ],
4657       'primary_key'  => 'exemptpkgnum',
4658       'unique'       => [],
4659       'index'        => [ [ 'taxnum', 'year', 'month' ],
4660                           [ 'billpkgnum' ],
4661                           [ 'taxnum', 'taxtype' ],
4662                           [ 'creditbillpkgnum' ],
4663                         ],
4664       'foreign_keys' => [
4665                           { columns    => [ 'billpkgnum' ],
4666                             table      => 'cust_bill_pkg',
4667                           },
4668                           { columns    => [ 'creditbillpkgnum' ],
4669                             table      => 'cust_credit_bill_pkg',
4670                           },
4671                         ],
4672     },
4673
4674     'cust_tax_exempt_pkg_void' => {
4675       'columns' => [
4676         'exemptpkgnum',  'int', '', '', '', '',
4677         #'custnum',      'int', '', '', '', ''
4678         'billpkgnum',   'int', '', '', '', '',
4679         'taxnum',       'int', '', '', '', '',
4680         'taxtype',  'varchar', 'NULL', $char_d, '', '',
4681         'year',         'int', 'NULL', '', '', '',
4682         'month',        'int', 'NULL', '', '', '',
4683         'creditbillpkgnum', 'int', 'NULL', '', '', '',
4684         'amount',       @money_type, '', '',
4685         # exemption type flags
4686         'exempt_cust',          'char', 'NULL', 1, '', '',
4687         'exempt_setup',         'char', 'NULL', 1, '', '',
4688         'exempt_recur',         'char', 'NULL', 1, '', '',
4689         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
4690         'exempt_monthly',       'char', 'NULL', 1, '', '',
4691       ],
4692       'primary_key'  => 'exemptpkgnum',
4693       'unique'       => [],
4694       'index'        => [ [ 'taxnum', 'year', 'month' ],
4695                           [ 'billpkgnum' ],
4696                           [ 'taxnum', 'taxtype' ],
4697                           [ 'creditbillpkgnum' ],
4698                         ],
4699       'foreign_keys' => [
4700                           { columns    => [ 'billpkgnum' ],
4701                             table      => 'cust_bill_pkg_void',
4702                           },
4703                           { columns    => [ 'taxnum' ],
4704                             table      => 'cust_main_county',
4705                           },
4706                           { columns    => [ 'creditbillpkgnum' ],
4707                             table      => 'cust_credit_bill_pkg',
4708                           },
4709                         ],
4710     },
4711
4712     'router' => {
4713       'columns' => [
4714         'routernum', 'serial', '', '', '', '',
4715         'routername', 'varchar', '', $char_d, '', '',
4716         'svcnum', 'int', 'NULL', '', '', '',
4717         'agentnum',   'int', 'NULL', '', '', '',
4718         'manual_addr', 'char', 'NULL', 1, '', '',
4719       ],
4720       'primary_key'  => 'routernum',
4721       'unique'       => [],
4722       'index'        => [],
4723       'foreign_keys' => [
4724                           { columns    => [ 'svcnum' ],
4725                             table      => 'cust_svc', #svc_acct / svc_broadband
4726                           },
4727                           { columns    => [ 'agentnum' ],
4728                             table      => 'agent',
4729                           },
4730                         ],
4731     },
4732
4733     'part_svc_router' => {
4734       'columns' => [
4735         'svcrouternum', 'serial', '', '', '', '',
4736         'svcpart', 'int', '', '', '', '',
4737         'routernum', 'int', '', '', '', '',
4738       ],
4739       'primary_key'  => 'svcrouternum',
4740       'unique'       => [],
4741       'index'        => [],
4742       'foreign_keys' => [
4743                           { columns    => [ 'svcpart' ],
4744                             table      => 'part_svc',
4745                           },
4746                           { columns    => [ 'routernum' ],
4747                             table      => 'router',
4748                           },
4749                         ],
4750     },
4751
4752     'addr_block' => {
4753       'columns' => [
4754         'blocknum', 'serial', '', '', '', '',
4755         'routernum', 'int', '', '', '', '',
4756         'ip_gateway', 'varchar', '', 15, '', '',
4757         'ip_netmask', 'int', '', '', '', '',
4758         'agentnum',   'int', 'NULL', '', '', '',
4759         'manual_flag', 'char', 'NULL', 1, '', '',
4760       ],
4761       'primary_key'  => 'blocknum',
4762       'unique'       => [ [ 'blocknum', 'routernum' ] ],
4763       'index'        => [],
4764       'foreign_keys' => [
4765                           #{ columns    => [ 'routernum' ],
4766                           #   table      => 'router',
4767                           #},
4768                           { columns    => [ 'agentnum' ],
4769                             table      => 'agent',
4770                           },
4771                         ],
4772     },
4773
4774     'addr_range' => {
4775       'columns' => [
4776         'rangenum', 'serial', '', '', '', '',
4777         'start',    'varchar', '', 15, '', '',
4778         'length',   'int', '', '', '', '',
4779         'status',   'varchar', 'NULL', 32, '', '',
4780       ],
4781       'primary_key' => 'rangenum',
4782       'unique'      => [],
4783       'index'       => [],
4784     },
4785
4786     'svc_broadband' => {
4787       'columns' => [
4788         'svcnum',                  'int',     '',        '', '', '',
4789         'description',         'varchar', 'NULL',   $char_d, '', '',
4790         'routernum',               'int', 'NULL',        '', '', '',
4791         'blocknum',                'int', 'NULL',        '', '', '',
4792         'sectornum',               'int', 'NULL',        '', '', '',
4793         'speed_up',                'int', 'NULL',        '', '', '',
4794         'speed_down',              'int', 'NULL',        '', '', '',
4795         'ip_addr',             'varchar', 'NULL',        15, '', '',
4796         'mac_addr',            'varchar', 'NULL',        12, '', '',
4797         'authkey',             'varchar', 'NULL',        32, '', '',
4798         'latitude',            'decimal', 'NULL',    '10,7', '', '',
4799         'longitude',           'decimal', 'NULL',    '10,7', '', '',
4800         'altitude',            'decimal', 'NULL',        '', '', '',
4801         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
4802         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
4803         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
4804         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
4805         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
4806         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
4807         'rssi',                    'int', 'NULL',        '', '', '',
4808         'suid',                    'int', 'NULL',        '', '', '',
4809         'shared_svcnum',           'int', 'NULL',        '', '', '',
4810         'serviceid',           'varchar', 'NULL',        64, '', '',#srvexport/reportfields
4811       ],
4812       'primary_key'  => 'svcnum',
4813       'unique'       => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
4814       'index'        => [],
4815       'foreign_keys' => [
4816                           { columns    => [ 'svcnum' ],
4817                             table      => 'cust_svc',
4818                           },
4819                           { columns    => [ 'routernum' ],
4820                             table      => 'router',
4821                           },
4822                           { columns    => [ 'blocknum' ],
4823                             table      => 'addr_block',
4824                           },
4825                           { columns    => [ 'sectornum' ],
4826                             table      => 'tower_sector',
4827                           },
4828                           { columns    => [ 'shared_svcnum' ],
4829                             table      => 'svc_broadband',
4830                             references => [ 'svcnum' ],
4831                           },
4832                         ],
4833     },
4834
4835     'tower' => {
4836       'columns' => [
4837         'towernum',    'serial',     '',      '', '', '',
4838         #'agentnum',       'int', 'NULL',      '', '', '',
4839         'towername',  'varchar',     '', $char_d, '', '',
4840         'disabled',      'char', 'NULL',       1, '', '',
4841         'latitude',   'decimal', 'NULL',  '10,7', '', '',
4842         'longitude',  'decimal', 'NULL',  '10,7', '', '',
4843         'coord_auto',    'char', 'NULL',       1, '', '',
4844         'altitude',   'decimal', 'NULL',      '', '', '',
4845         'height',     'decimal', 'NULL',      '', '', '',
4846         'veg_height', 'decimal', 'NULL',      '', '', '',
4847         'color',      'varchar', 'NULL',       6, '', '',
4848       ],
4849       'primary_key' => 'towernum',
4850       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
4851       'index'       => [],
4852     },
4853
4854     'tower_sector' => {
4855       'columns' => [
4856         'sectornum',     'serial',     '',      '', '', '',
4857         'towernum',         'int',     '',      '', '', '',
4858         'sectorname',   'varchar',     '', $char_d, '', '',
4859         'ip_addr',      'varchar', 'NULL',      15, '', '',
4860         'height',       'decimal', 'NULL',      '', '', '',
4861         'freq_mhz',         'int', 'NULL',      '', '', '',
4862         'direction',        'int', 'NULL',      '', '', '',
4863         'width',            'int', 'NULL',      '', '', '',
4864         'sector_range', 'decimal', 'NULL',      '', '', '',  #?
4865         'downtilt',     'decimal', 'NULL',      '', '', '',
4866         'v_width',          'int', 'NULL',      '', '', '',
4867         'margin',       'decimal', 'NULL',     '', '', '',
4868         'image',           'blob', 'NULL',     '', '', '',
4869         'west',         'decimal', 'NULL', '10,7', '', '',
4870         'east',         'decimal', 'NULL', '10,7', '', '',
4871         'south',        'decimal', 'NULL', '10,7', '', '',
4872         'north',        'decimal', 'NULL', '10,7', '', '',
4873      ],
4874       'primary_key'  => 'sectornum',
4875       'unique'       => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
4876       'index'        => [ [ 'towernum' ] ],
4877       'foreign_keys' => [
4878                           { columns    => [ 'towernum' ],
4879                             table      => 'tower',
4880                           },
4881                         ],
4882     },
4883
4884     'part_virtual_field' => {
4885       'columns' => [
4886         'vfieldpart', 'serial', '', '', '', '',
4887         'dbtable', 'varchar', '', 32, '', '',
4888         'name', 'varchar', '', 32, '', '',
4889         'length', 'int', 'NULL', '', '', '',
4890         'label', 'varchar', 'NULL', 80, '', '',
4891       ],
4892       'primary_key' => 'vfieldpart',
4893       'unique' => [],
4894       'index' => [],
4895     },
4896
4897     'virtual_field' => {
4898       'columns' => [
4899         'vfieldnum', 'serial', '', '', '', '',
4900         'recnum', 'int', '', '', '', '',
4901         'vfieldpart', 'int', '', '', '', '',
4902         'value', 'varchar', '', 128, '', '',
4903       ],
4904       'primary_key'  => 'vfieldnum',
4905       'unique'       => [ [ 'vfieldpart', 'recnum' ] ],
4906       'index'        => [],
4907       'foreign_keys' => [
4908                           { columns    => [ 'vfieldpart' ],
4909                             table      => 'part_virtual_field',
4910                           },
4911                         ],
4912     },
4913
4914     'acct_snarf' => {
4915       'columns' => [
4916         'snarfnum',    'serial',     '',      '', '', '',
4917         'snarfname',  'varchar', 'NULL', $char_d, '', '',
4918         'svcnum',         'int',     '',      '', '', '',
4919         'machine',    'varchar',     '',     255, '', '',
4920         'protocol',   'varchar',     '', $char_d, '', '',
4921         'username',   'varchar',     '', $char_d, '', '',
4922         '_password',  'varchar',     '', $char_d, '', '',
4923         'check_freq',     'int', 'NULL',      '', '', '',
4924         'leavemail',     'char', 'NULL',       1, '', '',
4925         'apop',          'char', 'NULL',       1, '', '',
4926         'tls',           'char', 'NULL',       1, '', '',
4927         'mailbox',    'varchar', 'NULL', $char_d, '', '',
4928       ],
4929       'primary_key'  => 'snarfnum',
4930       'unique'       => [],
4931       'index'        => [ [ 'svcnum' ] ],
4932       'foreign_keys' => [
4933                           { columns    => [ 'svcnum' ],
4934                             table      => 'svc_acct',
4935                           },
4936                         ],
4937     },
4938
4939     'svc_external' => {
4940       'columns' => [
4941         'svcnum',     'int',     '',      '', '', '',
4942         'id',      'bigint', 'NULL',      '', '', '',
4943         'title',  'varchar', 'NULL', $char_d, '', '',
4944       ],
4945       'primary_key'  => 'svcnum',
4946       'unique'       => [],
4947       'index'        => [],
4948       'foreign_keys' => [
4949                           { columns    => [ 'svcnum' ],
4950                             table      => 'cust_svc',
4951                           },
4952                         ],
4953     },
4954
4955     'cust_pay_refund' => {
4956       'columns' => [
4957         'payrefundnum', 'serial', '', '', '', '',
4958         'paynum',  'int', '', '', '', '',
4959         'refundnum',  'int', '', '', '', '',
4960         '_date',    @date_type, '', '',
4961         'amount',   @money_type, '', '',
4962       ],
4963       'primary_key'  => 'payrefundnum',
4964       'unique'       => [],
4965       'index'        => [ ['paynum'], ['refundnum'] ],
4966       'foreign_keys' => [
4967                           { columns    => [ 'paynum' ],
4968                             table      => 'cust_pay',
4969                           },
4970                           { columns    => [ 'refundnum' ],
4971                             table      => 'cust_refund',
4972                           },
4973                         ],
4974     },
4975
4976     'part_pkg_option' => {
4977       'columns' => [
4978         'optionnum', 'serial', '', '', '', '',
4979         'pkgpart', 'int', '', '', '', '',
4980         'optionname', 'varchar', '', $char_d, '', '',
4981         'optionvalue', 'text', 'NULL', '', '', '',
4982       ],
4983       'primary_key'  => 'optionnum',
4984       'unique'       => [],
4985       'index'        => [ [ 'pkgpart' ], [ 'optionname' ] ],
4986       'foreign_keys' => [
4987                           { columns    => [ 'pkgpart' ],
4988                             table      => 'part_pkg',
4989                           },
4990                         ],
4991     },
4992
4993     'part_pkg_vendor' => {
4994       'columns' => [
4995         'num', 'serial', '', '', '', '',
4996         'pkgpart', 'int', '', '', '', '',
4997         'exportnum', 'int', '', '', '', '',
4998         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
4999       ],
5000       'primary_key'  => 'num',
5001       'unique'       => [ [ 'pkgpart', 'exportnum' ] ],
5002       'index'        => [ [ 'pkgpart' ] ],
5003       'foreign_keys' => [
5004                           { columns    => [ 'pkgpart' ],
5005                             table      => 'part_pkg',
5006                           },
5007                           { columns    => [ 'exportnum' ],
5008                             table      => 'part_export',
5009                           },
5010                         ],
5011     },
5012
5013     'part_pkg_report_option' => {
5014       'columns' => [
5015         'num',      'serial',   '',      '', '', '',
5016         'name',     'varchar',  '', $char_d, '', '',
5017         'disabled', 'char', 'NULL',       1, '', '',
5018       ],
5019       'primary_key' => 'num',
5020       'unique' => [ [ 'name' ] ],
5021       'index' => [ [ 'disabled' ] ],
5022     },
5023
5024     'part_pkg_usage' => {
5025       'columns' => [
5026         'pkgusagepart', 'serial',   '', '', '', '',
5027         'pkgpart',  'int',      '', '', '', '',
5028         'minutes',  'double precision',      '', '', '', '',
5029         'priority', 'int',  'NULL', '', '', '',
5030         'shared',   'char', 'NULL',  1, '', '',
5031         'rollover', 'char', 'NULL',  1, '', '',
5032         'description',  'varchar', 'NULL', $char_d, '', '',
5033       ],
5034       'primary_key'  => 'pkgusagepart',
5035       'unique'       => [],
5036       'index'        => [ [ 'pkgpart' ] ],
5037       'foreign_keys' => [
5038                           { columns    => [ 'pkgpart' ],
5039                             table      => 'part_pkg',
5040                           },
5041                         ],
5042     },
5043
5044     'part_pkg_usage_class' => {
5045       'columns' => [
5046         'num',       'serial',  '', '', '', '',
5047         'pkgusagepart', 'int',  '', '', '', '',
5048         'classnum',     'int','NULL', '', '', '',
5049       ],
5050       'primary_key'  => 'num',
5051       'unique'       => [ [ 'pkgusagepart', 'classnum' ] ],
5052       'index'        => [],
5053       'foreign_keys' => [
5054                           { columns    => [ 'pkgusagepart' ],
5055                             table      => 'part_pkg_usage',
5056                           },
5057                           { columns    => [ 'classnum' ],
5058                             table      => 'usage_class',
5059                           },
5060                         ],
5061     },
5062
5063     'part_pkg_fcc_option' => {
5064       'columns' => [
5065         'num',        'serial', '', '', '', '',
5066         'fccoptionname', 'varchar', '', $char_d, '', '',
5067         'pkgpart',       'int', '', '', '', '',
5068         'optionvalue',   'varchar', 'NULL', $char_d, '', '',
5069       ],
5070       'primary_key' => 'num',
5071       'unique'      => [ [ 'fccoptionname', 'pkgpart' ] ],
5072       'index'       => [],
5073     },
5074
5075     'rate' => {
5076       'columns' => [
5077         'ratenum',          'serial',     '', '', '', '',
5078         'ratename',        'varchar', '',$char_d, '', '',
5079         'agentnum',            'int', 'NULL', '', '', '',
5080         'default_detailnum',   'int', 'NULL', '', '', '',
5081       ],
5082       'primary_key' => 'ratenum',
5083       'unique'      => [],
5084       'index'       => [],
5085       'foreign_keys' => [
5086                           { columns    => [ 'agentnum' ],
5087                             table      => 'agent',
5088                           },
5089                         ],
5090     },
5091
5092     'rate_detail' => {
5093       'columns' => [
5094         'ratedetailnum',   'serial',  '',     '',      '', '',
5095         'ratenum',         'int',     '',     '',      '', '',
5096         'orig_regionnum',  'int', 'NULL',     '',      '', '',
5097         'dest_regionnum',  'int', 'NULL',     '',      '', '',
5098         'min_included',    'int',     '',     '',      '', '',
5099         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
5100         'conn_cost',       'decimal', '', '10,4', '0.0000', '',
5101         'conn_sec',        'int',     '',     '',      '0', '',
5102         'min_charge',      'decimal', '', '10,5',       '', '',
5103         'min_cost',        'decimal', '', '10,5','0.00000', '',
5104         'sec_granularity', 'int',     '',     '',       '', '',
5105         'ratetimenum',     'int', 'NULL',     '',       '', '',
5106         'classnum',        'int', 'NULL',     '',       '', '',
5107         'cdrtypenum',      'int', 'NULL',     '',       '', '',
5108         'region_group',   'char', 'NULL',      1,       '', '',
5109         'upstream_mult_charge',  'decimal',  '', '10,4', '0.0000', '',
5110         'upstream_mult_cost',    'decimal',  '', '10,4', '0.0000', '',
5111       ],
5112       'primary_key'  => 'ratedetailnum',
5113       'unique'       => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
5114       'index'        => [ [ 'ratenum', 'dest_regionnum' ],
5115                           [ 'ratenum', 'ratetimenum' ]
5116                         ],
5117       'foreign_keys' => [
5118                           { columns    => [ 'ratenum' ],
5119                             table      => 'rate',
5120                           },
5121                           { columns    => [ 'orig_regionnum' ],
5122                             table      => 'rate_region',
5123                             references => [ 'regionnum' ],
5124                           },
5125                           { columns    => [ 'dest_regionnum' ],
5126                             table      => 'rate_region',
5127                             references => [ 'regionnum' ],
5128                           },
5129                           { columns    => [ 'ratetimenum' ],
5130                             table      => 'rate_time',
5131                           },
5132                           { columns    => [ 'classnum' ],
5133                             table      => 'usage_class',
5134                           },
5135                           { columns    => [ 'cdrtypenum' ],
5136                             table      => 'cdr_type',
5137                           },
5138                         ],
5139     },
5140
5141     'rate_region' => {
5142       'columns' => [
5143         'regionnum',   'serial',      '', '', '', '',
5144         'regionname',  'varchar',     '', $char_d, '', '',
5145         'exact_match', 'char',    'NULL',  1, '', '',
5146       ],
5147       'primary_key' => 'regionnum',
5148       'unique'      => [],
5149       'index'       => [],
5150     },
5151
5152     'rate_prefix' => {
5153       'columns' => [
5154         'prefixnum',   'serial',      '', '', '', '',
5155         'regionnum',   'int',         '', '', '', '',
5156         'countrycode', 'varchar',     '',  3, '', '',
5157         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
5158         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
5159         'latanum',     'int',     'NULL',      '', '', '',
5160         'state',       'char',    'NULL',       2, '', '',
5161         'ocn',         'char',    'NULL',       4, '', '',
5162       ],
5163       'primary_key'  => 'prefixnum',
5164       'unique'       => [],
5165       'index'        => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
5166       'foreign_keys' => [
5167                           { columns    => [ 'regionnum' ],
5168                             table      => 'rate_region',
5169                           },
5170                           { columns    => [ 'latanum' ],
5171                             table      => 'lata',
5172                           },
5173                         ],
5174     },
5175
5176     'rate_time' => {
5177       'columns' => [
5178         'ratetimenum', 'serial',      '',      '', '', '',
5179         'ratetimename',   'varchar',      '', $char_d, '', '',
5180       ],
5181       'primary_key' => 'ratetimenum',
5182       'unique'      => [],
5183       'index'       => [],
5184     },
5185
5186     'rate_time_interval' => {
5187       'columns' => [
5188         'intervalnum', 'serial', '', '', '', '',
5189         'stime',          'int', '', '', '', '',
5190         'etime',          'int', '', '', '', '',
5191         'ratetimenum',    'int', '', '', '', '',
5192       ],
5193       'primary_key'  => 'intervalnum',
5194       'unique'       => [],
5195       'index'        => [],
5196       'foreign_keys' => [
5197                           { columns    => [ 'ratetimenum' ],
5198                             table      => 'rate_time',
5199                           },
5200                         ],
5201      },
5202
5203     #not really part of the above rate_ stuff (used with flat rate rather than
5204     # rated billing), but could be eventually, and its a rate
5205     'rate_tier' => {
5206       'columns' => [
5207         'tiernum',   'serial', '',      '', '', '',
5208         'tiername', 'varchar', '', $char_d, '', '',
5209       ],
5210       'primary_key' => 'tiernum',
5211       'unique'      => [ [ 'tiername'], ],
5212       'index'       => [],
5213     },
5214
5215     'rate_tier_detail' => {
5216       'columns' => [
5217         'tierdetailnum', 'serial', '',     '', '', '',
5218         'tiernum',          'int', '',     '', '', '',
5219         'min_quan',         'int', '',     '', '', '',
5220         'min_charge',   'decimal', '', '10,4', '', '',
5221       ],
5222       'primary_key'  => 'tierdetailnum',
5223       'unique'       => [],
5224       'index'        => [ ['tiernum'], ],
5225       'foreign_keys' => [
5226                           { columns    => [ 'tiernum' ],
5227                             table      => 'rate_tier',
5228                           },
5229                         ],
5230     },
5231
5232     'usage_class' => {
5233       'columns' => [
5234         'classnum',    'serial',      '',      '', '', '',
5235         'weight',      'int',     'NULL',      '', '', '',
5236         'classname',   'varchar',     '', $char_d, '', '',
5237         'format',      'varchar', 'NULL', $char_d, '', '',
5238         'disabled',    'char',    'NULL',       1, '', '',
5239       ],
5240       'primary_key' => 'classnum',
5241       'unique' => [],
5242       'index' => [ ['disabled'] ],
5243     },
5244
5245     'reg_code' => {
5246       'columns' => [
5247         'codenum',   'serial',    '', '', '', '',
5248         'code',      'varchar',   '', $char_d, '', '',
5249         'agentnum',  'int',       '', '', '', '',
5250       ],
5251       'primary_key'  => 'codenum',
5252       'unique'       => [ [ 'agentnum', 'code' ] ],
5253       'index'        => [ [ 'agentnum' ] ],
5254       'foreign_keys' => [
5255                           { columns    => [ 'agentnum' ],
5256                             table      => 'agent',
5257                           },
5258                         ],
5259      },
5260
5261     'reg_code_pkg' => {
5262       'columns' => [
5263         'codepkgnum', 'serial', '', '', '', '',
5264         'codenum',   'int',    '', '', '', '',
5265         'pkgpart',   'int',    '', '', '', '',
5266       ],
5267       'primary_key'  => 'codepkgnum',
5268       'unique'       => [ [ 'codenum', 'pkgpart' ] ],
5269       'index'        => [ [ 'codenum' ] ],
5270       'foreign_keys' => [
5271                           { columns    => [ 'codenum' ],
5272                             table      => 'reg_code',
5273                           },
5274                           { columns    => [ 'pkgpart' ],
5275                             table      => 'part_pkg',
5276                           },
5277                         ],
5278     },
5279
5280     'clientapi_session' => {
5281       'columns' => [
5282         'sessionnum',  'serial',  '', '', '', '',
5283         'sessionid',  'varchar',  '', $char_d, '', '',
5284         'namespace',  'varchar',  '', $char_d, '', '',
5285       ],
5286       'primary_key' => 'sessionnum',
5287       'unique'      => [ [ 'sessionid', 'namespace' ] ],
5288       'index'       => [],
5289     },
5290
5291     'clientapi_session_field' => {
5292       'columns' => [
5293         'fieldnum',    'serial',     '', '', '', '',
5294         'sessionnum',     'int',     '', '', '', '',
5295         'fieldname',  'varchar',     '', $char_d, '', '',
5296         'fieldvalue',    'text', 'NULL', '', '', '',
5297       ],
5298       'primary_key'  => 'fieldnum',
5299       'unique'       => [ [ 'sessionnum', 'fieldname' ] ],
5300       'index'        => [],
5301       'foreign_keys' => [
5302                           { columns    => [ 'sessionnum' ],
5303                             table      => 'clientapi_session',
5304                           },
5305                         ],
5306     },
5307
5308     'payment_gateway' => {
5309       'columns' => [
5310         'gatewaynum',       'serial',   '',     '', '', '',
5311         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
5312         'gateway_module',   'varchar',  '',     $char_d, '', '',
5313         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
5314         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
5315         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
5316         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
5317         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
5318         'disabled',   'char',  'NULL',   1, '', '',
5319       ],
5320       'primary_key' => 'gatewaynum',
5321       'unique' => [],
5322       'index'  => [ [ 'disabled' ] ],
5323     },
5324
5325     'payment_gateway_option' => {
5326       'columns' => [
5327         'optionnum',   'serial',  '',     '', '', '',
5328         'gatewaynum',  'int',     '',     '', '', '',
5329         'optionname',  'varchar', '',     $char_d, '', '',
5330         'optionvalue', 'text',    'NULL', '', '', '',
5331       ],
5332       'primary_key'  => 'optionnum',
5333       'unique'       => [],
5334       'index'        => [ [ 'gatewaynum' ], [ 'optionname' ] ],
5335       'foreign_keys' => [
5336                           { columns    => [ 'gatewaynum' ],
5337                             table      => 'payment_gateway',
5338                           },
5339                         ],
5340     },
5341
5342     'agent_payment_gateway' => {
5343       'columns' => [
5344         'agentgatewaynum', 'serial', '', '', '', '',
5345         'agentnum',        'int', '', '', '', '',
5346         'gatewaynum',      'int', '', '', '', '',
5347         'cardtype',        'varchar', 'NULL', $char_d, '', '',
5348         'taxclass',        'varchar', 'NULL', $char_d, '', '',
5349       ],
5350       'primary_key'  => 'agentgatewaynum',
5351       'unique'       => [],
5352       'index'        => [ [ 'agentnum', 'cardtype' ], ],
5353
5354       'foreign_keys' => [
5355
5356                           { columns    => [ 'agentnum' ],
5357                             table      => 'agent',
5358                           },
5359                           { columns    => [ 'gatewaynum' ],
5360                             table      => 'payment_gateway',
5361                           },
5362                         ],
5363     },
5364
5365     'banned_pay' => {
5366       'columns' => [
5367         'bannum',        'serial',     '',      '', '', '',
5368         'payby',           'char',     '',       4, '', '',
5369         'payinfo',      'varchar',     '',     128, '', '', #say, a 512-big digest _hex encoded
5370         'payinfo_hash', 'varchar', 'NULL',      32, '', '',
5371         #'paymask',      'varchar',  'NULL', $char_d, '', ''
5372         '_date',                @date_type,         '', '',
5373         'end_date',             @date_type,         '', '',
5374         'otaker',       'varchar', 'NULL',      32, '', '',
5375         'usernum',          'int', 'NULL',      '', '', '',
5376         'bantype',      'varchar', 'NULL', $char_d, '', '',
5377         'reason',       'varchar', 'NULL', $char_d, '', '',
5378       ],
5379       'primary_key'  => 'bannum',
5380       'unique'       => [],
5381       'index'        => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
5382       'foreign_keys' => [
5383                           { columns    => [ 'usernum' ],
5384                             table      => 'access_user',
5385                           },
5386                         ],
5387     },
5388
5389     'pkg_category' => {
5390       'columns' => [
5391         'categorynum',        'serial',     '',      '', '', '',
5392         'categoryname',      'varchar',     '', $char_d, '', '',
5393         'weight',                'int', 'NULL',      '', '', '',
5394         'ticketing_queueid',     'int', 'NULL',      '', '', '',
5395         'condense',             'char', 'NULL',       1, '', '',
5396         'disabled',             'char', 'NULL',       1, '', '',
5397       ],
5398       'primary_key' => 'categorynum',
5399       'unique' => [],
5400       'index' => [ ['disabled'] ],
5401     },
5402
5403     'pkg_class' => {
5404       'columns' => [
5405         'classnum',    'serial',   '',      '', '', '',
5406         'classname',   'varchar',  '', $char_d, '', '',
5407         'categorynum', 'int',  'NULL',      '', '', '',
5408         'disabled',    'char', 'NULL',       1, '', '',
5409         'fcc_ds0s',      'int',     'NULL', '', '', '',
5410       ],
5411       'primary_key'  => 'classnum',
5412       'unique'       => [],
5413       'index'        => [ ['disabled'] ],
5414       'foreign_keys' => [
5415                           { columns    => [ 'categorynum' ],
5416                             table      => 'pkg_category',
5417                           },
5418                         ],
5419     },
5420
5421     'cdr' => {
5422       'columns' => [
5423         # qw( name type null length default local );
5424
5425         ###
5426         #asterisk fields
5427         ###
5428
5429         'acctid',   'bigserial',  '', '', '', '',
5430         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
5431         'calldate', 'timestamp',   '',      '', \'now()', '',
5432         'clid',        'varchar',  '', $char_d, \"''", '',
5433         'src',         'varchar',  '', $char_d, \"''", '',
5434         'dst',         'varchar',  '', $char_d, \"''", '',
5435         'dcontext',    'varchar',  '', $char_d, \"''", '',
5436         'channel',     'varchar',  '', $char_d, \"''", '',
5437         'dstchannel',  'varchar',  '', $char_d, \"''", '',
5438         'lastapp',     'varchar',  '', $char_d, \"''", '',
5439         'lastdata',    'varchar',  '',     255, \"''", '',
5440
5441         #currently only opensips & voipswitch
5442         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
5443
5444         #currently only opensips
5445         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
5446
5447         #currently only u4:
5448         # terminating number (as opposed to dialed destination)
5449         'dst_term',    'varchar',  'NULL', $char_d, '', '',
5450
5451         #these don't seem to be logged by most of the SQL cdr_* modules
5452         #except tds under sql-illegal names, so;
5453         # ... don't rely on them for rating?
5454         # and, what they hey, i went ahead and changed the names and data types
5455         # to freeside-style dates...
5456           #'start',  'timestamp', 'NULL',  '',    '', '',
5457           #'answer', 'timestamp', 'NULL',  '',    '', '',
5458           #'end',    'timestamp', 'NULL',  '',    '', '',
5459         'startdate',  @date_type, '', '',
5460         'answerdate', @date_type, '', '',
5461         'enddate',    @date_type, '', '',
5462         #
5463
5464         'duration',    'int',      '',      '',     0, '',
5465         'billsec',     'int',      '',      '',     0, '',
5466         'disposition', 'varchar',  '',      45, \"''", '',
5467         'amaflags',    'int',      '',      '',     0, '',
5468         'accountcode', 'varchar',  '',      32, \"''", '',
5469         'uniqueid',    'varchar',  '', $char_d, \"''", '',
5470         'userfield',   'varchar',  '',     512, \"''", '',
5471
5472         'max_callers', 'int',  'NULL',      '',    '', '',
5473
5474         ###
5475         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
5476         # ones we adoped moved to "own fields" section below
5477         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
5478         ###
5479
5480         'upstream_currency',      'char', 'NULL',       3, '', '',
5481         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
5482
5483         # how it was rated internally...
5484         'ratedetailnum',           'int', 'NULL',      '', '', '',
5485
5486         'distance',            'decimal', 'NULL',      '', '', '',
5487         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
5488
5489         #cdr_calltype: the big list in appendix 2
5490         'calltypenum',             'int', 'NULL',      '', '', '',
5491
5492         'description',         'varchar', 'NULL', $char_d, '', '',
5493         'quantity',                'int', 'NULL',      '', '', '',
5494
5495         'upstream_rateid',         'int', 'NULL',      '', '', '',
5496
5497         ###
5498         # more fields, for GSM imports
5499         ###
5500         'servicecode',             'int', 'NULL',      '', '', '',
5501         'quantity_able',           'int', 'NULL',      '', '', '',
5502
5503         ###
5504         #and now for our own fields
5505         ###
5506
5507         'cdrtypenum',              'int', 'NULL',      '', '', '',
5508
5509         'charged_party',       'varchar', 'NULL', $char_d, '', '',
5510         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
5511
5512         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
5513
5514         #currently only voipswitch
5515         #'upstream_rate',      'decimal', 'NULL',  '10,5', '', '',
5516
5517         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
5518         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
5519
5520         # how it was rated internally...
5521         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
5522         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
5523         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
5524         'rated_seconds',              'int', 'NULL',      '', '', '',
5525         'rated_minutes', 'double precision', 'NULL',      '', '', '',
5526         'rated_granularity',          'int', 'NULL',      '', '', '',
5527         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
5528         'rated_classnum',             'int', 'NULL',      '', '', '',
5529         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
5530         'rated_cost',            'decimal', 'NULL',  '10,4', '', '',
5531
5532         'carrierid',               'bigint', 'NULL',      '', '', '',
5533
5534         # service it was matched to
5535         'svcnum',             'int',   'NULL',     '',   '', '',
5536
5537         #NULL, done (or something)
5538         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
5539
5540         #NULL, done (or something)
5541         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
5542
5543         #an indexed place to put big numbers
5544         'cdrid',         'bigint',     'NULL',     '',  '', '',
5545
5546         #for taqua accountcode rewriting, for starters
5547         'sessionnum',       'int',    'NULL',      '', '', '',
5548         'subscriber',   'varchar',    'NULL', $char_d, '', '',
5549
5550         #old
5551         'cdrbatch',     'varchar',    'NULL',     255, '', '',
5552         #new
5553         'cdrbatchnum',      'int',    'NULL',      '', '', '',
5554
5555         # FK to cust_bill_pkg_detail; having a value here absolutely means
5556         # that the CDR appears on an invoice
5557         'detailnum',     'bigint',    'NULL',      '', '', '',
5558       ],
5559       'primary_key' => 'acctid',
5560       'unique' => [],
5561       'index' => [ [ 'calldate' ],
5562                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
5563                    [ 'lastapp' ],
5564                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
5565                    [ 'sessionnum' ], [ 'subscriber' ],
5566                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
5567                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
5568                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ], [ 'dst_term' ],
5569                    [ 'detailnum' ],
5570                  ],
5571       #no FKs on cdr table... choosing not to throw errors no matter what's
5572       # thrown in here.  better to have the data.
5573     },
5574
5575     'cdr_batch' => {
5576       'columns' => [
5577         'cdrbatchnum',   'serial',    '',   '', '', '',
5578         'cdrbatch', 'varchar', 'NULL', 255, '', '',
5579         '_date',     @date_type, '', '',
5580       ],
5581       'primary_key' => 'cdrbatchnum',
5582       'unique' => [ [ 'cdrbatch' ] ],
5583       'index' => [],
5584     },
5585
5586     'cdr_termination' => {
5587       'columns' => [
5588         'cdrtermnum', 'bigserial',     '',      '', '', '',
5589         'acctid',        'bigint',     '',      '', '', '',
5590         'termpart',         'int',     '',      '', '', '',#future use see below
5591         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
5592         'rated_seconds',    'int', 'NULL',      '', '', '',
5593         'rated_minutes', 'double precision', 'NULL',   '', '', '',
5594         'status',       'varchar', 'NULL',      32, '', '',
5595         'svcnum',           'int', 'NULL',      '', '', '',
5596       ],
5597       'primary_key'  => 'cdrtermnum',
5598       'unique'       => [ [ 'acctid', 'termpart' ] ],
5599       'index'        => [ [ 'acctid' ], [ 'status' ], ],
5600       'foreign_keys' => [
5601                           { columns    => [ 'acctid' ],
5602                             table      => 'cdr',
5603                           },
5604                           { columns    => [ 'svcnum' ],
5605                             table      => 'cust_svc',
5606                           },
5607                         ],
5608     },
5609
5610     #to handle multiple termination/settlement passes...
5611    # 'part_termination' => {
5612    #   'columns' => [
5613    #     'termpart',       'int', '',      '', '', '',
5614    #     'termname',   'varchar', '', $char_d, '', '',
5615    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
5616    #   ],
5617    #   'primary_key' => 'termpart',
5618    #   'unique' => [],
5619    #   'index'  => [],
5620    # },
5621
5622     #the remaining cdr_ tables are not really used
5623     'cdr_calltype' => {
5624       'columns' => [
5625         'calltypenum',   'serial',  '', '', '', '',
5626         'calltypename',  'varchar', '', $char_d, '', '',
5627       ],
5628       'primary_key' => 'calltypenum',
5629       'unique'      => [],
5630       'index'       => [],
5631     },
5632
5633     'cdr_type' => {
5634       'columns' => [
5635         'cdrtypenum'  => 'serial',  '', '', '', '',
5636         'cdrtypename' => 'varchar', '', $char_d, '', '',
5637       ],
5638       'primary_key' => 'cdrtypenum',
5639       'unique'      => [],
5640       'index'       => [],
5641     },
5642
5643     'cdr_carrier' => {
5644       'columns' => [
5645         'carrierid'   =>  'serial',     '',      '', '', '',
5646         'carriername' => 'varchar',     '', $char_d, '', '',
5647         'disabled'    =>    'char', 'NULL',       1, '', '',
5648       ],
5649       'primary_key' => 'carrierid',
5650       'unique'      => [],
5651       'index'       => [],
5652     },
5653
5654     #'cdr_file' => {
5655     #  'columns' => [
5656     #    'filenum',    'serial',     '', '', '', '',
5657     #    'filename',  'varchar',     '', '', '', '',
5658     #    'status',    'varchar', 'NULL', '', '', '',
5659     #  ],
5660     #  'primary_key' => 'filenum',
5661     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
5662     #                                   # agent-virtualize or have a customer
5663     #                                   # with dup-filename needs or something
5664     #                                   # (only used by cdr.http_and_import for
5665     #                                   #  chrissakes)
5666     #  'index'  => [],
5667     #},
5668
5669     'inventory_item' => {
5670       'columns' => [
5671         'itemnum',   'serial',      '',      '', '', '',
5672         'classnum',  'int',         '',      '', '', '',
5673         'agentnum',  'int',     'NULL',      '', '', '',
5674         'item',      'varchar',     '', $char_d, '', '',
5675         'svcnum',    'int',     'NULL',      '', '', '',
5676         'svc_field', 'varchar', 'NULL', $char_d, '', '',
5677       ],
5678       'primary_key'  => 'itemnum',
5679       'unique'       => [ [ 'classnum', 'item' ] ],
5680       'index'        => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
5681       'foreign_keys' => [
5682                           { columns    => [ 'classnum' ],
5683                             table      => 'inventory_class',
5684                           },
5685                           { columns    => [ 'agentnum' ],
5686                             table      => 'agent',
5687                           },
5688                           { columns    => [ 'svcnum' ],
5689                             table      => 'cust_svc',
5690                           },
5691                         ],
5692     },
5693
5694     'inventory_class' => {
5695       'columns' => [
5696         'classnum',  'serial',       '',      '', '', '',
5697         'classname', 'varchar',      '', $char_d, '', '',
5698       ],
5699       'primary_key' => 'classnum',
5700       'unique' => [],
5701       'index'  => [],
5702     },
5703
5704     'access_user_session' => {
5705       'columns' => [
5706         'sessionnum',   'serial',  '',      '', '', '',
5707         'sessionkey',  'varchar',  '', $char_d, '', '',
5708         'usernum',         'int',  '',      '', '', '',
5709         'start_date', @date_type,               '', '',
5710         'last_date',  @date_type,               '', '',
5711       ],
5712       'primary_key'  => 'sessionnum',
5713       'unique'       => [ [ 'sessionkey' ] ],
5714       'index'        => [],
5715       'foreign_keys' => [
5716                           { columns    => [ 'usernum' ],
5717                             table      => 'access_user',
5718                           },
5719                         ],
5720     },
5721
5722     'access_user' => {
5723       'columns' => [
5724         'usernum',             'serial',     '',      '', '', '',
5725         'username',           'varchar',     '', $char_d, '', '',
5726         '_password',          'varchar', 'NULL', $char_d, '', '',
5727         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
5728         'last',               'varchar', 'NULL', $char_d, '', '',
5729         'first',              'varchar', 'NULL', $char_d, '', '',
5730         'user_custnum',           'int', 'NULL',      '', '', '',
5731         'report_salesnum',        'int', 'NULL',      '', '', '',
5732         'disabled',              'char', 'NULL',       1, '', '',
5733       ],
5734       'primary_key'  => 'usernum',
5735       'unique'       => [ [ 'username' ] ],
5736       'index'        => [ [ 'user_custnum' ] ],
5737       'foreign_keys' => [
5738                           { columns    => [ 'user_custnum' ],
5739                             table      => 'cust_main',
5740                             references => [ 'custnum' ],
5741                           },
5742                           { columns    => [ 'report_salesnum' ],
5743                             table      => 'sales',
5744                             references => [ 'salesnum' ],
5745                           },
5746                         ],
5747     },
5748
5749     'access_user_pref' => {
5750       'columns' => [
5751         'prefnum',    'serial',       '', '', '', '',
5752         'usernum',     'int',       '', '', '', '',
5753         'prefname', 'varchar', '', $char_d, '', '',
5754         'prefvalue', 'text', 'NULL', '', '', '',
5755         'expiration', @date_type, '', '',
5756       ],
5757       'primary_key'  => 'prefnum',
5758       'unique'       => [],
5759       'index'        => [ [ 'usernum' ] ],
5760       'foreign_keys' => [
5761                           { columns    => [ 'usernum' ],
5762                             table      => 'access_user',
5763                           },
5764                         ],
5765     },
5766
5767     'access_group' => {
5768       'columns' => [
5769         'groupnum',   'serial', '',      '', '', '',
5770         'groupname', 'varchar', '', $char_d, '', '',
5771       ],
5772       'primary_key' => 'groupnum',
5773       'unique' => [ [ 'groupname' ] ],
5774       'index'  => [],
5775     },
5776
5777     'access_usergroup' => {
5778       'columns' => [
5779         'usergroupnum', 'serial', '', '', '', '',
5780         'usernum',         'int', '', '', '', '',
5781         'groupnum',        'int', '', '', '', '',
5782       ],
5783       'primary_key'  => 'usergroupnum',
5784       'unique'       => [ [ 'usernum', 'groupnum' ] ],
5785       'index'        => [ [ 'usernum' ] ],
5786       'foreign_keys' => [
5787                           { columns    => [ 'usernum' ],
5788                             table      => 'access_user',
5789                           },
5790                           { columns    => [ 'groupnum' ],
5791                             table      => 'access_group',
5792                           },
5793                         ],
5794      },
5795
5796     'access_groupagent' => {
5797       'columns' => [
5798         'groupagentnum', 'serial', '', '', '', '',
5799         'groupnum',         'int', '', '', '', '',
5800         'agentnum',         'int', '', '', '', '',
5801       ],
5802       'primary_key'  => 'groupagentnum',
5803       'unique'       => [ [ 'groupnum', 'agentnum' ] ],
5804       'index'        => [ [ 'groupnum' ] ],
5805       'foreign_keys' => [
5806                           { columns    => [ 'groupnum' ],
5807                             table      => 'access_group',
5808                           },
5809                           { columns    => [ 'agentnum' ],
5810                             table      => 'agent',
5811                           },
5812                         ],
5813     },
5814
5815     'access_right' => {
5816       'columns' => [
5817         'rightnum',   'serial', '',      '', '', '',
5818         'righttype', 'varchar', '', $char_d, '', '',
5819         'rightobjnum',   'int', '',      '', '', '',
5820         'rightname', 'varchar', '', $char_d, '', '',
5821       ],
5822       'primary_key' => 'rightnum',
5823       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
5824       'index'  => [],
5825     },
5826
5827     'access_user_log' => {
5828       'columns'      => [
5829         'lognum',          'serial',     '',        '', '', '',
5830         'usernum',            'int',     '',        '', '', '',
5831         'path',           'varchar',     '', 2*$char_d, '', '',
5832         '_date',                   @date_type,          '', '',
5833         'render_seconds',     'int', 'NULL',        '', '', '',
5834       ],
5835       'primary_key'  => 'lognum',
5836       'unique'       => [],
5837       'index'        => [ ['usernum'], ['path'], ['_date'] ],
5838     },
5839
5840     'access_user_page_pref' => {
5841       'columns'     => [
5842         'prefnum'     =>  'serial',     '',      '', '', '',
5843         'usernum'     =>     'int',     '',      '', '', '',
5844         'path'        =>    'text',     '',      '', '', '',
5845         'tablenum'    =>     'int', 'NULL',      '', '', '',
5846         '_date'       =>    @date_type,              '', '',
5847         'prefname'    =>    'varchar',  '', $char_d, '', '',
5848         'prefvalue'   =>    'text',     '',      '', '', '',
5849       ],
5850       'primary_key' => 'prefnum',
5851       'unique'      => [ [ 'usernum', 'path', 'tablenum', 'prefname' ] ],
5852       'index'       => [],
5853       'foreign_keys' => [
5854                           { columns   => [ 'usernum' ],
5855                             table     => 'access_user'
5856                           },
5857                         ],
5858     },
5859
5860     'sched_item' => {
5861       'columns' => [
5862         'itemnum',   'serial',      '', '', '', '',
5863         'usernum',      'int',  'NULL', '', '', '',
5864         #'itemname', 'varchar', $char_d, '', '', '',
5865         'disabled',    'char',  'NULL',  1, '', '',
5866       ],
5867       'primary_key'  => 'itemnum',
5868       'unique'       => [ [ 'usernum' ] ],
5869       'index'        => [],
5870       'foreign_keys' => [
5871                           { columns    => [ 'usernum' ],
5872                             table      => 'access_user',
5873                           },
5874                         ],
5875     },
5876
5877     #'sched_item_class'
5878
5879     'sched_avail' => {
5880       'columns' => [
5881         'availnum',      'serial', '', '', '', '',
5882         'itemnum',          'int', '', '', '', '',
5883         'wday',             'int', '', '', '', '',
5884         'stime',            'int', '', '', '', '',
5885         'etime',            'int', '', '', '', '',
5886         'override_date',    @date_type,    '', '',
5887       ],
5888       'primary_key'  => 'availnum',
5889       'unique'       => [],
5890       'index'        => [],
5891       'foreign_keys' => [
5892                           { columns    => [ 'itemnum' ],
5893                             table      => 'sched_item',
5894                           },
5895                         ],
5896     },
5897
5898     'svc_phone' => {
5899       'columns' => [
5900         'svcnum',                         'int',     '',      '', '', '',
5901         'countrycode',                'varchar',     '',       3, '', '',
5902         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
5903         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
5904         'pin',                        'varchar', 'NULL', $char_d, '', '',
5905         'sip_password',               'varchar', 'NULL', $char_d, '', '',
5906         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
5907         'pbxsvc',                         'int', 'NULL',      '', '', '',
5908         'domsvc',                         'int', 'NULL',      '', '', '',
5909         'locationnum',                    'int', 'NULL',      '', '', '',
5910         'forward_svcnum',                 'int', 'NULL',      '', '', '',
5911         'forwarddst',                 'varchar', 'NULL',      15, '', '',
5912         'email',                      'varchar', 'NULL',     255, '', '',
5913         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
5914         'portable',                      'char', 'NULL',       1, '', '',
5915         'lrn',                           'char', 'NULL',      10, '', '',
5916         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
5917         'lnp_due_date',                   'int', 'NULL',      '', '', '',
5918         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
5919         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
5920         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
5921         'sms_carrierid',                  'int', 'NULL',      '', '', '',
5922         'sms_account',                'varchar', 'NULL', $char_d, '', '',
5923         'max_simultaneous',               'int', 'NULL',      '', '', '',
5924         'e911_class',                    'char', 'NULL',       1, '', '',
5925         'e911_type',                     'char', 'NULL',       1, '', '',
5926         'circuit_svcnum',                 'int', 'NULL',      '', '', '',
5927         'sip_server',                 'varchar', 'NULL', $char_d, '', '',
5928       ],
5929       'primary_key'  => 'svcnum',
5930       'unique'       => [ [ 'sms_carrierid', 'sms_account'] ],
5931       'index'        => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
5932                           ['locationnum'], ['sms_carrierid'],
5933                         ],
5934       'foreign_keys' => [
5935                           { columns    => [ 'svcnum' ],
5936                             table      => 'cust_svc',
5937                           },
5938                           { columns    => [ 'pbxsvc' ],
5939                             table      => 'svc_pbx', #'cust_svc',
5940                             references => [ 'svcnum' ],
5941                           },
5942                           { columns    => [ 'domsvc' ],
5943                             table      => 'svc_domain', #'cust_svc',
5944                             references => [ 'svcnum' ],
5945                           },
5946                           { columns    => [ 'locationnum' ],
5947                             table      => 'cust_location',
5948                           },
5949                           { columns    => [ 'sms_carrierid' ],
5950                             table      => 'cdr_carrier',
5951                             references => [ 'carrierid' ],
5952                           },
5953                           { columns    => [ 'circuit_svcnum' ],
5954                             table      => 'svc_circuit',
5955                             references => [ 'svcnum' ],
5956                           },
5957                         ],
5958     },
5959
5960     'phone_device' => {
5961       'columns' => [
5962         'devicenum', 'serial',     '', '', '', '',
5963         'devicepart',   'int',     '', '', '', '',
5964         'svcnum',       'int',     '', '', '', '',
5965         'mac_addr', 'varchar', 'NULL', 12, '', '',
5966       ],
5967       'primary_key'  => 'devicenum',
5968       'unique'       => [ [ 'mac_addr' ], ],
5969       'index'        => [ [ 'devicepart' ], [ 'svcnum' ], ],
5970       'foreign_keys' => [
5971                           { columns    => [ 'devicepart' ],
5972                             table      => 'part_device',
5973                           },
5974                           { columns    => [ 'svcnum' ],
5975                             table      => 'svc_phone',
5976                           },
5977                         ],
5978     },
5979
5980     'part_device' => {
5981       'columns' => [
5982         'devicepart', 'serial',  '',      '', '', '',
5983         'devicename', 'varchar', '', $char_d, '', '',
5984         'inventory_classnum', 'int', 'NULL', '', '', '',
5985         'title',      'varchar', 'NULL', $char_d, '', '',
5986       ],
5987       'primary_key'  => 'devicepart',
5988       'unique'       => [ [ 'devicename' ] ], #?
5989       'index'        => [],
5990       'foreign_keys' => [
5991                           { columns    => [ 'inventory_classnum' ],
5992                             table      => 'inventory_class',
5993                             references => [ 'classnum' ],
5994                           },
5995                         ],
5996     },
5997
5998     'phone_avail' => {
5999       'columns' => [
6000         'availnum',    'serial',      '',      '', '', '',
6001         'exportnum',   'int',         '',      '', '', '',
6002         'countrycode', 'varchar',     '',       3, '', '',
6003         'state',       'char',    'NULL',       2, '', '',
6004         'npa',         'char',        '',       3, '', '',
6005         'nxx',         'char',    'NULL',       3, '', '',
6006         'station',     'char',    'NULL',       4, '', '',
6007         'name',        'varchar', 'NULL', $char_d, '', '',
6008         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
6009         'latanum',      'int',     'NULL',      '', '', '',
6010         'msanum',       'int', 'NULL', '', '', '',
6011         'ordernum',      'int',     'NULL',      '', '', '',
6012         'svcnum',      'int',     'NULL',      '', '', '',
6013         'availbatch', 'varchar',  'NULL', $char_d, '', '',
6014       ],
6015       'primary_key'  => 'availnum',
6016       'unique'       => [],
6017       'index'        => [ ['exportnum','countrycode','state'],    #npa search
6018                           ['exportnum','countrycode','npa'],      #nxx search
6019                           ['exportnum','countrycode','npa','nxx'],#station srch
6020                           [ 'exportnum','countrycode','npa','nxx','station'], #
6021                           [ 'svcnum' ],
6022                           [ 'availbatch' ],
6023                           [ 'latanum' ],
6024                         ],
6025       'foreign_keys' => [
6026                           { columns    => [ 'exportnum' ],
6027                             table      => 'part_export',
6028                           },
6029                           { columns    => [ 'latanum' ],
6030                             table      => 'lata',
6031                           },
6032                           { columns    => [ 'msanum' ],
6033                             table      => 'msa',
6034                           },
6035                           { columns    => [ 'ordernum' ],
6036                             table      => 'did_order',
6037                           },
6038                           { columns    => [ 'svcnum' ],
6039                             table      => 'svc_phone',
6040                           },
6041                         ],
6042     },
6043
6044     'lata' => {
6045       'columns' => [
6046         'latanum',    'int',      '',      '', '', '',
6047         'description',   'varchar',    '',      $char_d, '', '',
6048         'have_usage',   'int',    'NULL',      '', '', '',
6049       ],
6050       'primary_key' => 'latanum',
6051       'unique' => [],
6052       'index'  => [],
6053     },
6054
6055     'msa' => {
6056       'columns' => [
6057         'msanum',    'int',      '',      '', '', '',
6058         'description',   'varchar',    '',      $char_d, '', '',
6059       ],
6060       'primary_key' => 'msanum',
6061       'unique' => [],
6062       'index'  => [],
6063     },
6064
6065     'rate_center' => {
6066       'columns' => [
6067         'ratecenternum',    'serial',      '',      '', '', '',
6068         'description',   'varchar',    '',      $char_d, '', '',
6069       ],
6070       'primary_key' => 'ratecenternum',
6071       'unique' => [],
6072       'index'  => [],
6073     },
6074
6075     'did_vendor' => {
6076       'columns' => [
6077         'vendornum',    'serial',      '',      '', '', '',
6078         'vendorname',   'varchar',        '',     $char_d, '', '',
6079       ],
6080       'primary_key' => 'vendornum',
6081       'unique' => [],
6082       'index'  => [],
6083     },
6084
6085     'did_order_item' => {
6086       'columns' => [
6087         'orderitemnum',    'serial',      '',      '', '', '',
6088         'ordernum',    'int',      '',      '', '', '',
6089         'msanum',      'int',     'NULL',      '', '', '',
6090         'npa',      'int',     'NULL',      '', '', '',
6091         'latanum',      'int',     'NULL',      '', '', '',
6092         'ratecenternum',      'int',     'NULL',      '', '', '',
6093         'state',       'char',    'NULL',       2, '', '',
6094         'quantity',      'int',     '',      '', '', '',
6095         'custnum',   'int', 'NULL', '', '', '',
6096       ],
6097       'primary_key'  => 'orderitemnum',
6098       'unique'       => [],
6099       'index'        => [],
6100       'foreign_keys' => [
6101                           { columns    => [ 'ordernum' ],
6102                             table      => 'did_order',
6103                           },
6104                           { columns    => [ 'msanum' ],
6105                             table      => 'msa',
6106                           },
6107                           { columns    => [ 'latanum' ],
6108                             table      => 'lata',
6109                           },
6110                           { columns    => [ 'ratecenternum' ],
6111                             table      => 'rate_center',
6112                           },
6113                           { columns    => [ 'custnum' ],
6114                             table      => 'cust_main',
6115                           },
6116                         ],
6117     },
6118
6119     'did_order' => {
6120       'columns' => [
6121         'ordernum',    'serial',      '',      '', '', '',
6122         'vendornum',   'int',       '',      '', '', '',
6123         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
6124         'custnum',   'int', 'NULL', '', '', '',
6125         'submitted',      'int',     '',      '', '', '',
6126         'confirmed',      'int',     'NULL',      '', '', '',
6127         'received',      'int',     'NULL',      '', '', '',
6128       ],
6129       'primary_key'  => 'ordernum',
6130       'unique'       => [ [ 'vendornum', 'vendor_order_id' ] ],
6131       'index'        => [],
6132       'foreign_keys' => [
6133                           { columns    => [ 'vendornum' ],
6134                             table      => 'did_vendor',
6135                           },
6136                           { columns    => [ 'custnum' ],
6137                             table      => 'cust_main',
6138                           },
6139                         ],
6140     },
6141
6142     'reason_type' => {
6143       'columns' => [
6144         'typenum',   'serial',  '', '', '', '',
6145         'class',     'char', '', 1, '', '',
6146         'type',     'varchar', '', $char_d, '', '',
6147       ],
6148       'primary_key' => 'typenum',
6149       'unique' => [],
6150       'index' => [],
6151     },
6152
6153     'reason' => {
6154       'columns' => [
6155         'reasonnum',     'serial',  '', '', '', '',
6156         'reason_type',   'int',  '', '', '', '',
6157         'reason',        'text', '', '', '', '',
6158         'disabled',      'char',    'NULL', 1, '', '',
6159         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
6160         'unsuspend_hold','char',    'NULL', 1, '', '',
6161         'unused_credit', 'char',    'NULL', 1, '', '',
6162         'feepart',        'int', 'NULL', '', '', '',
6163         'fee_on_unsuspend','char',  'NULL', 1, '', '',
6164         'fee_hold',      'char',    'NULL', 1, '', '',
6165       ],
6166       'primary_key'  => 'reasonnum',
6167       'unique'       => [],
6168       'index'        => [],
6169       'foreign_keys' => [
6170                           { columns    => [ 'reason_type' ],
6171                             table      => 'reason_type',
6172                             references => [ 'typenum' ],
6173                           },
6174                           { columns    => [ 'unsuspend_pkgpart' ],
6175                             table      => 'part_pkg',
6176                             references => [ 'pkgpart' ],
6177                           },
6178                         ],
6179     },
6180
6181     'conf' => {
6182       'columns' => [
6183         'confnum',  'serial',     '',      '', '', '',
6184         'agentnum', 'int',    'NULL',      '', '', '',
6185         'locale',   'varchar','NULL',      16, '', '',
6186         'name',     'varchar',    '', $char_d, '', '',
6187         'value',    'text',   'NULL',      '', '', '',
6188       ],
6189       'primary_key'  => 'confnum',
6190       'unique'       => [ [ 'agentnum', 'locale', 'name' ] ],
6191       'index'        => [],
6192       'foreign_keys' => [
6193                           { columns    => [ 'agentnum' ],
6194                             table      => 'agent',
6195                           },
6196                         ],
6197     },
6198
6199     'pkg_referral' => {
6200       'columns' => [
6201         'pkgrefnum',     'serial', '', '', '', '',
6202         'pkgnum',        'int',    '', '', '', '',
6203         'refnum',        'int',    '', '', '', '',
6204       ],
6205       'primary_key'  => 'pkgrefnum',
6206       'unique'       => [ [ 'pkgnum', 'refnum' ] ],
6207       'index'        => [ [ 'pkgnum' ], [ 'refnum' ] ],
6208       'foreign_keys' => [
6209                           { columns    => [ 'pkgnum' ],
6210                             table      => 'cust_pkg',
6211                           },
6212                           { columns    => [ 'refnum' ],
6213                             table      => 'part_referral',
6214                           },
6215                         ],
6216     },
6217
6218     'svc_pbx' => {
6219       'columns' => [
6220         'svcnum',           'int',     '',      '', '', '',
6221         'id',               'int', 'NULL',      '', '', '',
6222         'uuid',            'char', 'NULL',      36, '', '',
6223         'title',        'varchar', 'NULL', $char_d, '', '',
6224         'max_extensions',   'int', 'NULL',      '', '', '',
6225         'max_simultaneous', 'int', 'NULL',      '', '', '',
6226         'ip_addr',      'varchar', 'NULL',      40, '', '',
6227       ],
6228       'primary_key'  => 'svcnum',
6229       'unique'       => [],
6230       'index'        => [ [ 'id' ], [ 'uuid' ] ],
6231       'foreign_keys' => [
6232                           { columns    => [ 'svcnum' ],
6233                             table      => 'cust_svc',
6234                           },
6235                         ],
6236     },
6237
6238     'pbx_extension' => {
6239       'columns' => [
6240         'extensionnum',  'serial',     '',      '', '', '',
6241         'svcnum',           'int',     '',      '', '', '',
6242         'extension',    'varchar',     '', $char_d, '', '',
6243         'pin',          'varchar', 'NULL', $char_d, '', '',
6244         'sip_password', 'varchar', 'NULL', $char_d, '', '',
6245         'phone_name',   'varchar', 'NULL', $char_d, '', '',
6246       ],
6247       'primary_key'  => 'extensionnum',
6248       'unique'       => [ [ 'svcnum', 'extension' ] ],
6249       'index'        => [ [ 'svcnum' ] ],
6250       'foreign_keys' => [
6251                           { columns    => [ 'svcnum' ],
6252                             table      => 'svc_pbx',
6253                           },
6254                         ],
6255     },
6256
6257     'pbx_device' => {
6258       'columns' => [
6259         'devicenum', 'serial',     '', '', '', '',
6260         'devicepart',   'int',     '', '', '', '',
6261         'svcnum',       'int',     '', '', '', '',
6262         'mac_addr', 'varchar', 'NULL', 12, '', '',
6263       ],
6264       'primary_key'  => 'devicenum',
6265       'unique'       => [ [ 'mac_addr' ], ],
6266       'index'        => [ [ 'devicepart' ], [ 'svcnum' ], ],
6267       'foreign_keys' => [
6268                           { columns    => [ 'devicepart' ],
6269                             table      => 'part_device',
6270                           },
6271                           { columns    => [ 'svcnum' ],
6272                             table      => 'svc_pbx',
6273                           },
6274                         ],
6275     },
6276
6277     'extension_device' => {
6278       'columns' => [
6279         'extensiondevicenum', 'serial', '', '', '', '',
6280         'extensionnum',          'int', '', '', '', '',
6281         'devicenum',             'int', '', '', '', '',
6282       ],
6283       'primary_key'  => 'extensiondevicenum',
6284       'unique'       => [ [ 'extensionnum', 'devicenum' ] ],
6285       'index'        => [],#both?  which way do we need to query?
6286       'foreign_keys' => [
6287                           { columns  => [ 'extensionnum' ],
6288                             table    => 'pbx_extension',
6289                           },
6290                           { columns  => [ 'devicenum' ],
6291                             table    => 'pbx_device',
6292                           },
6293                         ],
6294     },
6295
6296     'svc_mailinglist' => { #svc_group?
6297       'columns' => [
6298         'svcnum',            'int',     '',            '', '', '',
6299         'username',      'varchar',     '', $username_len, '', '',
6300         'domsvc',            'int',     '',            '', '', '',
6301         'listnum',           'int',     '',            '', '', '',
6302         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
6303         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
6304         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
6305         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
6306       ],
6307       'primary_key'  => 'svcnum',
6308       'unique'       => [],
6309       'index'        => [ ['username'], ['domsvc'], ['listnum'] ],
6310       'foreign_keys' => [
6311                           { columns    => [ 'svcnum' ],
6312                             table      => 'cust_svc',
6313                           },
6314                           { columns    => [ 'domsvc' ],
6315                             table      => 'svc_domain', #'cust_svc',
6316                             references => [ 'svcnum' ],
6317                           },
6318                           { columns    => [ 'listnum' ],
6319                             table      => 'mailinglist',
6320                           },
6321                         ],
6322     },
6323
6324     'mailinglist' => {
6325       'columns' => [
6326         'listnum',   'serial', '',      '', '', '',
6327         'listname', 'varchar', '', $char_d, '', '',
6328       ],
6329       'primary_key' => 'listnum',
6330       'unique' => [],
6331       'index'  => [],
6332     },
6333
6334     'mailinglistmember' => {
6335       'columns' => [
6336         'membernum',        'serial',     '',   '', '', '',
6337         'listnum',             'int',     '',   '', '', '',
6338         'svcnum',              'int', 'NULL',   '', '', '',
6339         'contactemailnum',     'int', 'NULL',   '', '', '',
6340         'email',           'varchar', 'NULL',  255, '', '',
6341       ],
6342       'primary_key'  => 'membernum',
6343       'unique'       => [],
6344       'index'        => [['listnum'],['svcnum'],['contactemailnum'],['email']],
6345       'foreign_keys' => [
6346                           { columns    => [ 'listnum' ],
6347                             table      => 'mailinglist',
6348                           },
6349                           { columns    => [ 'svcnum' ],
6350                             table      => 'svc_acct',
6351                           },
6352                           { columns    => [ 'contactemailnum' ],
6353                             table      => 'contact_email',
6354                           },
6355                         ],
6356     },
6357
6358     'bill_batch' => {
6359       'columns' => [
6360         'batchnum',         'serial',     '',  '', '', '',
6361         'agentnum',            'int', 'NULL',  '', '', '',
6362         'status',             'char', 'NULL', '1', '', '',
6363         'pdf',                'blob', 'NULL',  '', '', '',
6364       ],
6365       'primary_key'  => 'batchnum',
6366       'unique'       => [],
6367       'index'        => [ ['agentnum'] ],
6368       'foreign_keys' => [
6369                           { columns    => [ 'agentnum' ],
6370                             table      => 'agent',
6371                           },
6372                         ],
6373     },
6374
6375     'cust_bill_batch' => {
6376       'columns' => [
6377         'billbatchnum',     'serial',     '', '', '', '',
6378         'batchnum',            'int',     '', '', '', '',
6379         'invnum',              'int',     '', '', '', '',
6380       ],
6381       'primary_key'  => 'billbatchnum',
6382       'unique'       => [],
6383       'index'        => [ [ 'batchnum' ], [ 'invnum' ] ],
6384       'foreign_keys' => [
6385                           { columns    => [ 'batchnum' ],
6386                             table      => 'bill_batch',
6387                           },
6388                           { columns    => [ 'invnum' ],
6389                             table      => 'cust_bill',
6390                           },
6391                         ],
6392     },
6393
6394     'cust_bill_batch_option' => {
6395       'columns' => [
6396         'optionnum', 'serial', '', '', '', '',
6397         'billbatchnum', 'int', '', '', '', '',
6398         'optionname', 'varchar', '', $char_d, '', '',
6399         'optionvalue', 'text', 'NULL', '', '', '',
6400       ],
6401       'primary_key'  => 'optionnum',
6402       'unique'       => [],
6403       'index'        => [ [ 'billbatchnum' ], [ 'optionname' ] ],
6404       'foreign_keys' => [
6405                           { columns    => [ 'billbatchnum' ],
6406                             table      => 'cust_bill_batch',
6407                           },
6408                         ],
6409      },
6410
6411     'msg_template' => {
6412       'columns' => [
6413         'msgnum',     'serial',     '',      '', '', '',
6414         'msgname',   'varchar',     '', $char_d, '', '',
6415         'agentnum',      'int', 'NULL',      '', '', '',
6416         'subject',   'varchar', 'NULL',     512, '', '',
6417         'mime_type', 'varchar',     '', $char_d, '', '',
6418         'body',         'blob', 'NULL',      '', '', '',
6419         'disabled',     'char', 'NULL',       1, '', '',
6420           # migrate these to msg_template_email
6421         'from_addr', 'varchar', 'NULL',     255, '', '',
6422         'bcc_addr',  'varchar', 'NULL',     255, '', '',
6423           # change to not null on v5
6424         'msgclass',  'varchar', 'NULL',      16, '', '',
6425       ],
6426       'primary_key'  => 'msgnum',
6427       'unique'       => [ ],
6428       'index'        => [ ['agentnum'], ],
6429       'foreign_keys' => [
6430                           { columns    => [ 'agentnum' ],
6431                             table      => 'agent',
6432                           },
6433                         ],
6434     },
6435
6436     'msg_template_http' => {
6437       'columns' => [
6438         'num',          'serial',     '',      '', '', '',
6439         'msgnum',          'int',     '',      '', '', '',
6440         'prepare_url', 'varchar', 'NULL',     255, '', '',
6441         'send_url',    'varchar', 'NULL',     255, '', '',
6442         'username',    'varchar', 'NULL', $char_d, '', '',
6443         'password',    'varchar', 'NULL', $char_d, '', '',
6444         'content',        'text', 'NULL',      '', '', '',
6445       ],
6446       'primary_key'  => 'num',
6447       'unique'       => [ [ 'msgnum' ], ],
6448       'index'        => [ ],
6449       'foreign_keys' => [
6450                           { columns    => [ 'msgnum' ],
6451                             table      => 'msg_template',
6452                           },
6453                         ],
6454     },
6455
6456     'template_content' => {
6457       'columns' => [
6458         'contentnum', 'serial',     '',      '', '', '',
6459         'msgnum',        'int',     '',      '', '', '',
6460         'locale',    'varchar', 'NULL',      16, '', '',
6461         'subject',   'varchar', 'NULL',     512, '', '',
6462         'body',         'text', 'NULL',      '', '', '',
6463       ],
6464       'primary_key'  => 'contentnum',
6465       'unique'       => [ ['msgnum', 'locale'] ],
6466       'index'        => [ ],
6467       'foreign_keys' => [
6468                           { columns    => [ 'msgnum' ],
6469                             table      => 'msg_template',
6470                           },
6471                         ],
6472     },
6473
6474     'template_image' => {
6475       'columns' => [
6476         'imgnum',     'serial',     '',      '', '', '',
6477         'name',      'varchar',     '', $char_d, '', '',
6478         'agentnum',      'int', 'NULL',      '', '', '',
6479         'mime_type', 'varchar',     '', $char_d, '', '',
6480         'base64',       'text',     '',      '', '', '',
6481       ],
6482       'primary_key'  => 'imgnum',
6483       'unique'       => [ ],
6484       'index'        => [ ['name'], ['agentnum'] ],
6485     },
6486
6487     'cust_msg' => {
6488       'columns' => [
6489         'custmsgnum', 'serial',     '',     '', '', '',
6490         'custnum',       'int', 'NULL',     '', '', '',
6491         'msgnum',        'int', 'NULL',     '', '', '',
6492         '_date',    @date_type,                 '', '',
6493         'env_from',  'varchar', 'NULL',    255, '', '',
6494         'env_to',    'varchar', 'NULL',    255, '', '',
6495         'header',       'blob', 'NULL',     '', '', '',
6496         'body',         'blob', 'NULL',     '', '', '',
6497         'error',     'varchar', 'NULL',    255, '', '',
6498         'status',    'varchar',     '',$char_d, '', '',
6499         'msgtype',   'varchar', 'NULL',     16, '', '',
6500         'preview',      'text', 'NULL',     '', '', '',
6501       ],
6502       'primary_key'  => 'custmsgnum',
6503       'unique'       => [ ],
6504       'index'        => [ ['custnum'], ],
6505       'foreign_keys' => [
6506                           { columns    => [ 'custnum' ],
6507                             table      => 'cust_main',
6508                           },
6509                           { columns    => [ 'msgnum' ],
6510                             table      => 'msg_template',
6511                           },
6512                         ],
6513     },
6514
6515     'svc_cert' => {
6516       'columns' => [
6517         'svcnum',                'int',     '',      '', '', '',
6518         'recnum',                'int', 'NULL',      '', '', '',
6519         'privatekey',           'text', 'NULL',      '', '', '',
6520         'csr',                  'text', 'NULL',      '', '', '',
6521         'certificate',          'text', 'NULL',      '', '', '',
6522         'cacert',               'text', 'NULL',      '', '', '',
6523         'common_name',       'varchar', 'NULL', $char_d, '', '',
6524         'organization',      'varchar', 'NULL', $char_d, '', '',
6525         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
6526         'city',              'varchar', 'NULL', $char_d, '', '',
6527         'state',             'varchar', 'NULL', $char_d, '', '',
6528         'country',              'char', 'NULL',       2, '', '',
6529         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
6530       ],
6531       'primary_key'  => 'svcnum',
6532       'unique'       => [],
6533       'index'        => [], #recnum
6534       'foreign_keys' => [
6535                           { columns    => [ 'svcnum' ],
6536                             table      => 'cust_svc',
6537                           },
6538                           { columns    => [ 'recnum' ],
6539                             table      => 'domain_record',
6540                           },
6541                         ],
6542     },
6543
6544     'svc_port' => {
6545       'columns' => [
6546         'svcnum',                'int',     '',      '', '', '',
6547         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
6548       ],
6549       'primary_key'  => 'svcnum',
6550       'unique'       => [],
6551       'index'        => [], #recnum
6552       'foreign_keys' => [
6553                           { columns    => [ 'svcnum' ],
6554                             table      => 'cust_svc',
6555                           },
6556                         ],
6557     },
6558
6559     'areacode'  => {
6560       'columns' => [
6561         'areanum',   'serial',        '',      '', '', '',
6562         'code',        'char',        '',       3, '', '',
6563         'country',     'char',    'NULL',       2, '', '',
6564         'state',       'char',    'NULL',       2, '', '',
6565         'description','varchar',  'NULL',     255, '', '',
6566       ],
6567       'primary_key' => 'areanum',
6568       'unique' => [ [ 'areanum' ] ],
6569       'index'  => [],
6570     },
6571
6572     'upgrade_journal' => {
6573       'columns' => [
6574         'upgradenum', 'serial', '', '', '', '',
6575         '_date', 'int', '', '', '', '',
6576         'upgrade', 'varchar', '', $char_d, '', '',
6577         'status', 'varchar', '', $char_d, '', '',
6578         'statustext', 'varchar', 'NULL', $char_d, '', '',
6579       ],
6580       'primary_key' => 'upgradenum',
6581       'unique' => [],
6582       'index' => [ [ 'upgrade' ] ],
6583     },
6584
6585     'upload_target' => {
6586       'columns' => [
6587         'targetnum', 'serial', '', '', '', '',
6588         'agentnum', 'int', 'NULL', '', '', '',
6589         'protocol', 'varchar', '', 10, '', '',
6590         'hostname', 'varchar', '', $char_d, '', '',
6591         'port', 'int', 'NULL', '', '', '',
6592         'username', 'varchar', '', $char_d, '', '',
6593         'password', 'varchar', 'NULL', $char_d, '', '',
6594         'path', 'varchar', 'NULL', $char_d, '', '',
6595         'subject', 'varchar', 'NULL', '255', '', '',
6596         'handling', 'varchar', 'NULL', $char_d, '', '',
6597       ],
6598       'primary_key'   => 'targetnum',
6599       'unique'        => [ [ 'targetnum' ] ],
6600       'index'         => [],
6601       'foreign_keys' => [
6602                           { columns    => [ 'agentnum' ],
6603                             table      => 'agent',
6604                           },
6605                         ],
6606     },
6607
6608     'log' => {
6609       'columns' => [
6610         'lognum',     'serial', '', '', '', '',
6611         '_date',      'int', '', '', '', '',
6612         'agentnum',   'int', 'NULL', '', '', '',
6613         'tablename',  'varchar', 'NULL', $char_d, '', '',
6614         'tablenum',   'int',  'NULL', '', '', '',
6615         'level',      'int',  '', '', '', '',
6616         'message',    'text', '', '', '', '',
6617       ],
6618       'primary_key'  => 'lognum',
6619       'unique'       => [],
6620       'index'        => [ ['_date'], ['level'] ],
6621       'foreign_keys' => [
6622                           { columns    => [ 'agentnum' ],
6623                             table      => 'agent',
6624                           },
6625                         ],
6626     },
6627
6628     'log_context' => {
6629       'columns' => [
6630         'logcontextnum', 'serial', '', '', '', '',
6631         'lognum', 'int', '', '', '', '',
6632         'context', 'varchar', '', $char_d, '', '',
6633       ],
6634       'primary_key'  => 'logcontextnum',
6635       'unique'       => [ [ 'lognum', 'context' ] ],
6636       'index'        => [],
6637       'foreign_keys' => [
6638                           { columns    => [ 'lognum' ],
6639                             table      => 'log',
6640                           },
6641                         ],
6642     },
6643
6644     'log_email' => {
6645       'columns' => [
6646         'logemailnum', 'serial', '', '', '', '',
6647         'context', 'varchar', 'NULL', $char_d, '', '',
6648         'min_level', 'int',  'NULL', '', '', '',
6649         'msgnum', 'int', '',  '', '', '',
6650         'to_addr', 'varchar', 'NULL',     255, '', '',
6651       ],
6652       'primary_key'  => 'logemailnum',
6653       'unique'       => [],
6654       'index'        => [ ['context'], ['min_level'] ],
6655       'foreign_keys' => [
6656                           { columns    => [ 'msgnum' ],
6657                             table      => 'msg_template',
6658                             references => [ 'msgnum' ],
6659                           },
6660                         ],
6661     },
6662
6663     'svc_alarm' => {
6664       'columns' => [
6665 #       name               type        null   length   default local
6666         'svcnum',          'int',      '',    '',      '',     '',
6667         'alarmsystemnum',  'int',      '',    '',      '',     '',
6668         'alarmtypenum',    'int',      '',    '',      '',     '',
6669         'alarmstationnum', 'int',      '',    '',      '',     '',
6670         'acctnum',         'varchar',  '',    $char_d, '',     '',
6671         '_password',       'varchar',  '',    $char_d, '',     '',
6672         'location',        'varchar', 'NULL', $char_d, '',     '',
6673         'cs_receiver',     'int',     'NULL', '',      '',     '',
6674         'cs_phonenum',     'varchar', 'NULL', $char_d, '',     '',
6675         'serialnum',       'varchar', 'NULL', $char_d, '',     '',
6676         #installer (rep)
6677       ],
6678       'primary_key'  => 'svcnum',
6679       'unique'       => [],
6680       'index'        => [],
6681       'foreign_keys' => [
6682                           { columns    => [ 'svcnum' ],
6683                             table      => 'cust_svc',
6684                           },
6685                           { columns    => [ 'alarmsystemnum' ],
6686                             table      => 'alarm_system',
6687                           },
6688                           { columns    => [ 'alarmtypenum' ],
6689                             table      => 'alarm_type',
6690                           },
6691                           { columns    => [ 'alarmstationnum' ],
6692                             table      => 'alarm_station',
6693                           },
6694                         ],
6695     },
6696
6697     'alarm_system' => { #vendors
6698       'columns' => [
6699         'alarmsystemnum',  'serial',     '',      '', '', '',
6700         'agentnum',           'int', 'NULL',      '', '', '',
6701         'systemname',     'varchar',     '', $char_d, '', '',
6702         'disabled',          'char', 'NULL',       1, '', '',
6703       ],
6704       'primary_key' => 'alarmsystemnum',
6705       'unique'      => [ ['agentnum', 'systemname'] ],
6706       'index'       => [ ['agentnum'], ['disabled'] ],
6707       'foreign_keys' => [
6708                           { columns    => [ 'agentnum' ],
6709                             table      => 'agent',
6710                           },
6711                         ],
6712     },
6713
6714     'alarm_type' => { #inputs and outputs
6715       'columns' => [
6716         'alarmtypenum', 'serial',     '',      '', '', '',
6717         'agentnum',        'int', 'NULL',      '', '', '',
6718         'inputs',          'int',     '', '', '', '',
6719         'outputs',         'int',     '', '', '', '',
6720         'disabled',       'char', 'NULL',       1, '', '',
6721       ],
6722       'primary_key' => 'alarmtypenum',
6723       'unique'      => [ ['agentnum', 'inputs', 'outputs'] ],
6724       'index'       => [ ['agentnum'], ['disabled'] ],
6725       'foreign_keys' => [
6726                           { columns    => [ 'agentnum' ],
6727                             table      => 'agent',
6728                           },
6729                         ],
6730     },
6731
6732     'alarm_station' => { #central station (where the alarm reports to)
6733       'columns' => [
6734         'alarmstationnum', 'serial',     '',      '', '', '',
6735         'agentnum',           'int', 'NULL',      '', '', '',
6736         'stationname',    'varchar',     '', $char_d, '', '',
6737         'disabled',          'char', 'NULL',       1, '', '',
6738       ],
6739       'primary_key' => 'alarmstationnum',
6740       'unique'      => [ ['agentnum', 'stationname'], ],
6741       'index'       => [ ['agentnum'], ['disabled'] ],
6742       'foreign_keys' => [
6743                           { columns    => [ 'agentnum' ],
6744                             table      => 'agent',
6745                           },
6746                         ],
6747     },
6748
6749     'svc_cable' => {
6750       'columns' => [
6751         'svcnum',        'int',     '',      '', '', '',
6752         'providernum',   'int', 'NULL',      '', '', '',
6753         'ordernum',  'varchar', 'NULL', $char_d, '', '',
6754         'modelnum',      'int', 'NULL',      '', '', '',
6755         'serialnum', 'varchar', 'NULL', $char_d, '', '',
6756         'mac_addr',  'varchar', 'NULL',      12, '', '',
6757       ],
6758       'primary_key'  => 'svcnum',
6759       'unique'       => [ ['serialnum'] , ['mac_addr'] ],
6760       'index'        => [],
6761       'foreign_keys' => [
6762                           { columns    => [ 'svcnum' ],
6763                             table      => 'cust_svc',
6764                           },
6765                           { columns    => [ 'providernum' ],
6766                             table      => 'cable_provider',
6767                           },
6768                           { columns    => [ 'modelnum' ],
6769                             table      => 'cable_model',
6770                           },
6771                         ],
6772     },
6773
6774     'cable_model' => {
6775       'columns' => [
6776         'modelnum',    'serial',     '',      '', '', '',
6777         'model_name', 'varchar',     '', $char_d, '', '',
6778         'disabled',      'char', 'NULL',       1, '', '',
6779       ],
6780       'primary_key' => 'modelnum',
6781       'unique' => [ [ 'model_name' ], ],
6782       'index'  => [],
6783     },
6784
6785     'cable_provider' => {
6786       'columns' => [
6787         'providernum', 'serial',     '',      '', '', '',
6788         'provider',   'varchar',     '', $char_d, '', '',
6789         'disabled',      'char', 'NULL',       1, '', '',
6790       ],
6791       'primary_key' => 'providernum',
6792       'unique' => [ [ 'provider' ], ],
6793       'index'  => [],
6794     },
6795
6796     'svc_conferencing' => {
6797       'columns' => [
6798         'svcnum',            'int',     '',      '', '', '',
6799         'conf_id',           'int', 'NULL',      '', '', '', #"system assigned"
6800         'conf_name',     'varchar',     '', $char_d, '', '',
6801         'conf_password', 'varchar',     '', $char_d, '', '',
6802         'access_code',   'varchar',     '',      16, '', '',
6803         'duration',          'int',     '',      '', '', '',
6804         'participants',      'int',     '',      '', '', '',
6805         'conftypenum',       'int',     '',      '', '', '',
6806         'confqualitynum',    'int',     '',      '', '', '',
6807         'opt_recording',    'char', 'NULL',       1, '', '',
6808         'opt_sip',          'char', 'NULL',       1, '', '',
6809         'opt_phone',        'char', 'NULL',       1, '', '',
6810       ],
6811       'primary_key' => 'svcnum',
6812       'unique' => [],
6813       'index'  => [],
6814       'foreign_keys' => [
6815                           { columns => [ 'svcnum' ],
6816                             table   => 'cust_svc',
6817                           },
6818                           { columns => [ 'conftypenum' ],
6819                             table   => 'conferencing_type',
6820                           },
6821                           { columns => [ 'confqualitynum' ],
6822                             table   => 'conferencing_quality',
6823                           },
6824                         ],
6825     },
6826
6827     'conferencing_type' => {
6828       'columns' => [
6829         'conftypenum',  'int',     '',      '', '', '',
6830         'typeid'      , 'int',     '',      '', '', '',
6831         'typename', 'varchar',     '', $char_d, '', '',
6832         'disabled',    'char', 'NULL',       1, '', '',
6833       ],
6834       'primary_key' => 'conftypenum',
6835       'unique'      => [ [ 'typeid', 'disabled' ], [ 'typename', 'disabled' ] ],
6836       'index'       => [],
6837     },
6838
6839     'conferencing_quality' => {
6840       'columns' => [
6841         'confqualitynum',  'int',     '',      '', '', '',
6842         'qualityid'      , 'int',     '',      '', '', '',
6843         'qualityname', 'varchar',     '', $char_d, '', '',
6844         'disabled',       'char', 'NULL',       1, '', '',
6845       ],
6846       'primary_key' => 'confqualitynum',
6847       'unique'      => [ [ 'qualityid', 'disabled' ], [ 'qualityname', 'disabled' ] ],
6848       'index'       => [],
6849     },
6850
6851     'svc_video' => {
6852       'columns' => [
6853         'svcnum',            'int', '', '', '', '',
6854         'smartcard_num', 'varchar', '', 16, '', '',
6855         'mac_addr',      'varchar', '', 12, '', '',
6856         'duration',          'int', '', '', '', '',
6857       ],
6858       'primary_key' => 'svcnum',
6859       'unique' => [], # [ 'smartcard_num' ], [ 'mac_addr' ], ],
6860       'index'  => [],
6861       'foreign_keys' => [
6862                           { columns => [ 'svcnum' ],
6863                             table   => 'cust_svc',
6864                           },
6865                         ],
6866     },
6867
6868     'circuit_type' => {
6869       'columns' => [
6870         'typenum',     'serial',     '',      '', '', '',
6871         'typename',   'varchar',     '', $char_d, '', '',
6872         'disabled',      'char', 'NULL',       1, '', '',
6873         # speed? number of voice lines? anything else?
6874       ],
6875       'primary_key' => 'typenum',
6876       'unique' => [ [ 'typename' ] ],
6877       'index'  => [],
6878     },
6879
6880     'circuit_provider' => {
6881       'columns' => [
6882         'providernum', 'serial',     '',      '', '', '',
6883         'provider',   'varchar',     '', $char_d, '', '',
6884         'disabled',      'char', 'NULL',       1, '', '',
6885       ],
6886       'primary_key' => 'providernum',
6887       'unique' => [ [ 'provider' ], ],
6888       'index'  => [],
6889     },
6890
6891     'circuit_termination' => {
6892       'columns' => [
6893         'termnum',     'serial',     '',      '', '', '',
6894         'termination','varchar',     '', $char_d, '', '',
6895         'disabled',      'char', 'NULL',       1, '', '',
6896       ],
6897       'primary_key' => 'termnum',
6898       'unique' => [ [ 'termination' ] ],
6899       'index' => [],
6900     },
6901
6902     'svc_circuit' => {
6903       'columns' => [
6904         'svcnum',                   'int',     '', '', '', '',
6905         'typenum',                  'int',     '', '', '', '',
6906         'providernum',              'int',     '', '', '', '',
6907         'termnum',                  'int',     '', '', '', '',
6908         'circuit_id',           'varchar',     '', 64, '', '',
6909         'desired_due_date',         'int', 'NULL', '', '', '',
6910         'due_date',                 'int', 'NULL', '', '', '',
6911         'vendor_order_id',      'varchar', 'NULL', $char_d,  '', '',
6912         'vendor_qual_id',       'varchar', 'NULL', $char_d,  '', '',
6913         'vendor_order_type',    'varchar', 'NULL', $char_d,  '', '',
6914         'vendor_order_status',  'varchar', 'NULL', $char_d,  '', '',
6915         'endpoint_ip_addr',     'varchar', 'NULL', 40, '', '',
6916         'endpoint_mac_addr',    'varchar', 'NULL', 12, '', '',
6917       ],
6918       'primary_key' => 'svcnum',
6919       'unique'      => [],
6920       'index'       => [ [ 'providernum' ], [ 'typenum' ] ],
6921       'foreign_keys' => [
6922                           { columns => [ 'svcnum' ],
6923                             table   => 'cust_svc',
6924                           },
6925                           { columns => [ 'typenum' ],
6926                             table   => 'circuit_type',
6927                           },
6928                           { columns => [ 'providernum' ],
6929                             table   => 'circuit_provider',
6930                           },
6931                           { columns => [ 'termnum' ],
6932                             table   => 'circuit_termination',
6933                           },
6934       ],
6935     },
6936
6937     'svc_fiber' => {
6938       'columns' => [
6939         'svcnum',         'int',     '',      '', '', '',
6940         'oltnum',         'int', 'NULL',      '', '', '',
6941         'shelf',          'int', 'NULL',      '', '', '',
6942         'card',           'int', 'NULL',      '', '', '',
6943         'olt_port',       'int', 'NULL',      '', '', '',
6944         'ont_id',         'int', 'NULL',      '', '', '',
6945         'ont_typenum',    'int', 'NULL',      '', '', '',
6946         'ont_serial', 'varchar', 'NULL', $char_d, '', '',
6947         'ont_port',   'varchar', 'NULL',      16, '', '',
6948         'circuit_id', 'varchar', 'NULL', $char_d, '', '',
6949         'vlan',           'int', 'NULL',      '', '', '',
6950         'signal',     'decimal', 'NULL',  '10,2', '', '',
6951         'speed_up',       'int', 'NULL',      '', '', '',
6952         'speed_down',     'int', 'NULL',      '', '', '',
6953         'ont_install','varchar', 'NULL', $char_d, '', '',
6954       ],
6955       'primary_key' => 'svcnum',
6956       'unique'      => [ ],
6957       'index'       => [ [ 'ont_serial' ] ],
6958       'foreign_keys' => [
6959                           { columns => [ 'svcnum' ],
6960                             table   => 'cust_svc',
6961                           },
6962                           { columns => [ 'oltnum' ],
6963                             table   => 'fiber_olt',
6964                           },
6965                           { columns => [ 'ont_typenum' ],
6966                             table   => 'hardware_type',
6967                             references => [ 'typenum' ],
6968                           },
6969                         ],
6970     },
6971
6972     'fiber_olt' => {
6973       'columns' => [
6974         'oltnum',   'serial', '',       '', '', '',
6975         'oltname', 'varchar', '',  $char_d, '', '',
6976         'sitenum',     'int', 'NULL',   '', '', '',
6977         'serial',  'varchar', '',  $char_d, '', '',
6978         'disabled',   'char', 'NULL',    1, '', '',
6979       ],
6980       'primary_key' => 'oltnum',
6981       'unique' => [ ],
6982       'index'  => [ ],
6983       'foreign_keys' => [
6984                           { columns => [ 'sitenum' ],
6985                             table   => 'olt_site',
6986                           },
6987                         ],
6988     },
6989
6990     'olt_site' => {
6991       'columns' => [
6992         'sitenum',  'serial', '',      '', '', '',
6993         'market',  'varchar', '', $char_d, '', '',
6994         'site',    'varchar', '', $char_d, '', '',
6995       ],
6996       'primary_key' => 'sitenum',
6997       'unique' => [ [ 'market', 'site' ] ],
6998       'index' => [ ],
6999     },
7000
7001
7002
7003
7004
7005     'vend_main' => {
7006       'columns' => [
7007         'vendnum',   'serial',     '',      '', '', '',
7008         'vendname', 'varchar',     '', $char_d, '', '',
7009         'classnum',     'int',     '',      '', '', '',
7010         'disabled',    'char', 'NULL',       1, '', '',
7011       ],
7012       'primary_key'  => 'vendnum',
7013       'unique'       => [ ['vendname', 'disabled'] ],
7014       'index'        => [],
7015       'foreign_keys' => [
7016                           { columns    => [ 'classnum' ],
7017                             table      => 'vend_class',
7018                           },
7019                         ],
7020     },
7021
7022     'vend_class' => {
7023       'columns' => [
7024         'classnum',     'serial',     '',      '', '', '',
7025         'classname',   'varchar',     '', $char_d, '', '',
7026         'disabled',       'char', 'NULL',       1, '', '',
7027       ],
7028       'primary_key' => 'classnum',
7029       'unique'      => [],
7030       'index'       => [ ['disabled'] ],
7031     },
7032
7033     'vend_bill' => {
7034       'columns' => [
7035         'vendbillnum',    'serial',     '',      '', '', '',
7036         'vendnum',           'int',     '',      '', '', '',
7037         #'_date',        @date_type,                  '', '',
7038         '_date',     'int', '', '',                   '', '',
7039         'charged',     @money_type,                  '', '',
7040       ],
7041       'primary_key'  => 'vendbillnum',
7042       'unique'       => [],
7043       'index'        => [ ['vendnum'], ['_date'], ],
7044       'foreign_keys' => [
7045                           { columns    => [ 'vendnum' ],
7046                             table      => 'vend_main',
7047                           },
7048                         ],
7049     },
7050
7051     'vend_pay' => {
7052       'columns' => [
7053         'vendpaynum',   'serial',    '',       '', '', '',
7054         'vendnum',         'int',    '',       '', '', '',
7055         #'_date',     @date_type,                   '', '',
7056         '_date',     'int', '', '',                   '', '',
7057         'paid',      @money_type,                  '', '',
7058       ],
7059       'primary_key'  => 'vendpaynum',
7060       'unique'       => [],
7061       'index'        => [ [ 'vendnum' ], [ '_date' ], ],
7062       'foreign_keys' => [
7063                           { columns    => [ 'vendnum' ],
7064                             table      => 'vend_main',
7065                           },
7066                         ],
7067     },
7068
7069     'vend_bill_pay' => {
7070       'columns' => [
7071         'vendbillpaynum', 'serial',     '',   '', '', '',
7072         'vendbillnum',       'int',     '',   '', '', '',
7073         'vendpaynum',        'int',     '',   '', '', '',
7074         'amount',  @money_type, '', '',
7075         #? '_date',   @date_type, '', '',
7076       ],
7077       'primary_key'  => 'vendbillpaynum',
7078       'unique'       => [],
7079       'index'        => [ [ 'vendbillnum' ], [ 'vendpaynum' ] ],
7080       'foreign_keys' => [
7081                           { columns    => [ 'vendbillnum' ],
7082                             table      => 'vend_bill',
7083                           },
7084                           { columns    => [ 'vendpaynum' ],
7085                             table      => 'vend_pay',
7086                           },
7087                         ],
7088     },
7089
7090     %{ tables_hashref_torrus() },
7091
7092     # tables of ours for doing torrus virtual port combining
7093     'torrus_srvderive' => {
7094       'columns' => [
7095         'derivenum',     'serial',     '', '', '', '',
7096         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
7097         'last_srv_date',   'date', 'NULL', '', '', '',
7098       ],
7099       'primary_key' => 'derivenum',
7100       'unique' => [ ['serviceid'] ],
7101       'index'  => [],
7102     },
7103
7104     'torrus_srvderive_component' => {
7105       'columns' => [
7106         'componentnum', 'serial', '', '', '', '',
7107         'derivenum',       'int', '', '', '', '',
7108         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
7109       ],
7110       'primary_key'  => 'componentnum',
7111       'unique'       => [ [ 'derivenum', 'serviceid' ], ],
7112       'index'        => [ [ 'derivenum', ], ],
7113       'foreign_keys' => [
7114                           { columns    => [ 'derivenum' ],
7115                             table      => 'torrus_srvderive',
7116                           },
7117                         ],
7118     },
7119
7120     'invoice_mode' => {
7121       'columns' => [
7122         'modenum',      'serial', '', '', '', '',
7123         'agentnum',        'int', 'NULL', '', '', '',
7124         'modename',    'varchar', '', 32, '', '',
7125       ],
7126       'primary_key' => 'modenum',
7127       'unique'      => [ ],
7128       'index'       => [ ],
7129       'foreign_keys' => [
7130                           { columns    => [ 'agentnum' ],
7131                             table      => 'agent',
7132                           },
7133                         ],
7134     },
7135
7136     'invoice_conf' => {
7137       'columns' => [
7138         'confnum',              'serial',   '', '', '', '',
7139         'modenum',              'int',      '', '', '', '',
7140         'locale',               'varchar',  'NULL', 16, '', '',
7141         'notice_name',          'varchar',  'NULL', 64, '', '',
7142         'subject',              'varchar',  'NULL', 64, '', '',
7143         'htmlnotes',            'text',     'NULL', '', '', '',
7144         'htmlfooter',           'text',     'NULL', '', '', '',
7145         'htmlsummary',          'text',     'NULL', '', '', '',
7146         'htmlreturnaddress',    'text',     'NULL', '', '', '',
7147         'latexnotes',           'text',     'NULL', '', '', '',
7148         'latexfooter',          'text',     'NULL', '', '', '',
7149         'latexsummary',         'text',     'NULL', '', '', '',
7150         'latexsmallfooter',     'text',     'NULL', '', '', '',
7151         'latexreturnaddress',   'text',     'NULL', '', '', '',
7152         'with_latexcoupon',     'char',     'NULL', '1', '', '',
7153         'htmlwatermark',        'text',     'NULL', '', '', '',
7154         'latexwatermark',       'text',     'NULL', '', '', '',
7155         'lpr',                  'varchar',  'NULL', $char_d, '', '',
7156       ],
7157       'primary_key'  => 'confnum',
7158       'unique'       => [ [ 'modenum', 'locale' ] ],
7159       'index'        => [ ],
7160       'foreign_keys' => [
7161                           { columns    => [ 'modenum' ],
7162                             table      => 'invoice_mode',
7163                           },
7164                         ],
7165     },
7166
7167     'export_batch' => {
7168       'columns' => [
7169         'batchnum',    'serial',     '',      '', '', '',
7170         'exportnum',      'int',     '',      '', '', '',
7171         '_date',          'int',     '',      '', '', '',
7172         'status',     'varchar', 'NULL',      32, '', '',
7173         'statustext',    'text', 'NULL',      '', '', '',
7174       ],
7175       'primary_key'  => 'batchnum',
7176       'unique'       => [],
7177       'index'        => [ [ 'exportnum' ], [ 'status' ] ],
7178       'foreign_keys' => [
7179                           { columns    => [ 'exportnum' ],
7180                             table      => 'part_export',
7181                             references => [ 'exportnum' ]
7182                           },
7183                         ],
7184     },
7185
7186     'export_batch_item' => {
7187       'columns' => [
7188         'itemnum',     'serial',     '',      '', '', '',
7189         'batchnum',       'int',     '',      '', '', '',
7190         'svcnum',         'int',     '',      '', '', '',
7191         'action',     'varchar',     '',      32, '', '',
7192         'data',          'text', 'NULL',      '', '', '',
7193         'frozen',        'char', 'NULL',       1, '', '',
7194       ],
7195       'primary_key'  => 'itemnum',
7196       'unique'       => [],
7197       'index'        => [ [ 'batchnum' ], [ 'svcnum' ] ],
7198       'foreign_keys' => [
7199                           { columns    => [ 'batchnum' ],
7200                             table      => 'export_batch',
7201                             references => [ 'batchnum' ]
7202                           },
7203                         ],
7204     },
7205
7206     # lookup table for states, similar to msa and lata
7207     'state' => {
7208       'columns' => [
7209         'statenum', 'int',  '', '', '', '',
7210         'country',  'char', '',  2, '', '',
7211         'state',    'char', '', $char_d, '', '',
7212         'fips',     'char', '',  3, '', '',
7213       ],
7214       'primary_key' => 'statenum',
7215       'unique' => [ [ 'country', 'state' ], ],
7216       'index' => [],
7217     },
7218
7219     # eventually link to tower/sector?
7220     'deploy_zone' => {
7221       'columns' => [
7222         'zonenum',        'serial',  '',     '',      '', '',
7223         'description',    'char',    'NULL', $char_d, '', '',
7224         'agentnum',       'int',     '',     '',      '', '',
7225         'censusyear',     'char',    'NULL', 4,      '', '',
7226         'dbaname',        'char',    'NULL', $char_d, '', '',
7227         'zonetype',       'char',    '',     1,       '', '',
7228         'technology',     'int',     '',     '',      '', '',
7229         'spectrum',       'int',     'NULL', '',      '', '',
7230         'adv_speed_up',   'decimal', '',     '10,3', '0', '',
7231         'adv_speed_down', 'decimal', '',     '10,3', '0', '',
7232         'cir_speed_up',   'decimal', '',     '10,3', '0', '',
7233         'cir_speed_down', 'decimal', '',     '10,3', '0', '',
7234         'is_broadband',   'char',    'NULL', 1,       '', '',
7235         'is_voice',       'char',    'NULL', 1,       '', '',
7236         'is_consumer',    'char',    'NULL', 1,       '', '',
7237         'is_business',    'char',    'NULL', 1,       '', '',
7238         'active_date',    @date_type,                 '', '',
7239         'expire_date',    @date_type,                 '', '',
7240       ],
7241       'primary_key' => 'zonenum',
7242       'unique' => [],
7243       'index'  => [ [ 'agentnum' ] ],
7244       'foreign_keys' => [
7245                           { columns     => [ 'agentnum' ],
7246                             table       => 'agent',
7247                             references  => [ 'agentnum' ],
7248                           },
7249                         ],
7250     },
7251
7252     'deploy_zone_block' => {
7253       'columns' => [
7254         'blocknum',       'serial',  '',     '',      '', '',
7255         'zonenum',        'int',     '',     '',      '', '',
7256         'censusblock',    'char',    '',     15,      '', '',
7257         'censusyear',     'char','NULL',      4,      '', '',
7258       ],
7259       'primary_key' => 'blocknum',
7260       'unique' => [],
7261       'index'  => [ [ 'zonenum' ] ],
7262       'foreign_keys' => [
7263                           { columns     => [ 'zonenum' ],
7264                             table       => 'deploy_zone',
7265                             references  => [ 'zonenum' ],
7266                           },
7267                         ],
7268     },
7269
7270     'deploy_zone_vertex' => {
7271       'columns' => [
7272         'vertexnum',      'serial',  '',     '',      '', '',
7273         'zonenum',        'int',     '',     '',      '', '',
7274         'latitude',       'decimal', '',     '10,7',  '', '',
7275         'longitude',      'decimal', '',     '10,7',  '', '',
7276       ],
7277       'primary_key' => 'vertexnum',
7278       'unique' => [ ],
7279       'index'  => [ ],
7280       'foreign_keys' => [
7281                           { columns     => [ 'zonenum' ],
7282                             table       => 'deploy_zone',
7283                             references  => [ 'zonenum' ],
7284                           },
7285                         ],
7286     },
7287
7288     'cacti_page' => {
7289       'columns' => [
7290         'cacti_pagenum',  'serial',   '',     '', '', '',
7291         'exportnum',      'int',      'NULL', '', '', '',
7292         'svcnum',         'int',      'NULL', '', '', '',
7293         'graphnum',       'int',      'NULL', '', '', '',
7294         'imported',       @date_type,             '', '',
7295         'content',        'text',     'NULL', '', '', '',
7296       ],
7297       'primary_key' => 'cacti_pagenum',
7298       'unique'  => [ ],
7299       'index'   => [ ['svcnum'], ['imported'] ],
7300       'foreign_keys' => [
7301                           { columns    => [ 'svcnum' ],
7302                             table      => 'cust_svc',
7303                             references => [ 'svcnum' ],
7304                           },
7305                           { columns    => [ 'exportnum' ],
7306                             table      => 'part_export',
7307                             references => [ 'exportnum' ],
7308                           },
7309                         ],
7310     },
7311
7312     'report_batch' => {
7313       'columns' => [
7314         'reportbatchnum', 'serial',      '',  '', '', '',
7315         'reportname',     'varchar',     '', 255, '', '',
7316         'agentnum',           'int', 'NULL',  '', '', '',
7317         'send_date',     @date_type,              '', '',
7318         'sdate',         @date_type,              '', '',
7319         'edate',         @date_type,              '', '',
7320         'usernum',            'int', 'NULL',  '', '', '',
7321         'msgnum',             'int', 'NULL',  '', '', '',
7322         # add report params here as necessary
7323       ],
7324       'primary_key' => 'reportbatchnum',
7325       'unique' => [],
7326       'index'  => [],
7327       'foreign_keys' => [
7328                           { columns    => [ 'agentnum' ],
7329                             table      => 'agent',
7330                             references => [ 'agentnum' ],
7331                           },
7332                           { columns    => [ 'usernum' ],
7333                             table      => 'access_user',
7334                             references => [ 'usernum' ],
7335                           },
7336                           { columns    => [ 'msgnum' ],
7337                             table      => 'msg_template',
7338                             references => [ 'msgnum' ],
7339                           },
7340                         ],
7341     },
7342
7343     'password_history' => {
7344       'columns' => [
7345         'passwordnum',        'serial',  '',          '', '', '',
7346         '_password',          'varchar', 'NULL', $char_d, '', '',
7347         'encryption_method',  'varchar', 'NULL', $char_d, '', '',
7348         'created',   @date_type,   '', '',
7349         # each table that needs password history gets a column here, and
7350         # an entry in foreign_keys.
7351         'svc_acct__svcnum',     'int', 'NULL', '', '', '',
7352         'svc_dsl__svcnum',      'int', 'NULL', '', '', '',
7353         'svc_alarm__svcnum',    'int', 'NULL', '', '', '',
7354         'agent__agentnum',      'int', 'NULL', '', '', '',
7355         'contact__contactnum',  'int', 'NULL', '', '', '',
7356         'access_user__usernum', 'int', 'NULL', '', '', '',
7357       ],
7358       'primary_key' => 'passwordnum',
7359       'unique' => [],
7360       'index'  => [],
7361       'foreign_keys' => [
7362                           { columns     => [ 'svc_acct__svcnum' ],
7363                             table       => 'svc_acct',
7364                             references  => [ 'svcnum' ],
7365                           },
7366                           { columns     => [ 'svc_dsl__svcnum' ],
7367                             table       => 'svc_dsl',
7368                             references  => [ 'svcnum' ],
7369                           },
7370                           { columns     => [ 'svc_alarm__svcnum' ],
7371                             table       => 'svc_alarm',
7372                             references  => [ 'svcnum' ],
7373                           },
7374                           { columns    => [ 'agent__agentnum' ],
7375                             table      => 'agent',
7376                             references => [ 'agentnum' ],
7377                           },
7378                           { columns    => [ 'contact__contactnum' ],
7379                             table      => 'contact',
7380                             references => [ 'contactnum' ],
7381                           },
7382                           { columns    => [ 'access_user__usernum' ],
7383                             table      => 'access_user',
7384                             references => [ 'usernum' ],
7385                           },
7386                         ],
7387     },
7388
7389     'webservice_log' => {
7390       'columns' => [
7391         'webservicelognum',    'serial',      '',      '', '', '', #big? hubrus
7392         'svcnum',                 'int',  'NULL',      '', '', '', #just in case
7393         'custnum',                'int',      '',      '', '', '',
7394         'method',             'varchar',      '', $char_d, '', '',
7395         'quantity',               'int',      '',      '', '', '', #i.e. pages
7396         '_date',             @date_type,                   '', '',
7397         'status',             'varchar',  'NULL', $char_d, '', '',
7398         'rated_price',        'decimal',  'NULL',  '10,2', '', '',
7399       ],
7400       'primary_key'  => 'webservicelognum',
7401       'unique'       => [],
7402       'index'        => [ ['custnum'], ['status'] ],
7403       'foreign_keys' => [
7404                           { columns => [ 'custnum' ],
7405                             table   => 'cust_main',
7406                           },
7407                           #no FK on svcnum... we don't want to purge these on
7408                           # service deletion
7409                         ],
7410     },
7411
7412     # name type nullability length default local
7413
7414     #'new_table' => {
7415     #  'columns' => [
7416     #    'num', 'serial',       '', '', '', '',
7417     #  ],
7418     #  'primary_key' => 'num',
7419     #  'unique' => [],
7420     #  'index'  => [],
7421     #},
7422
7423   };
7424
7425 }
7426
7427 =back
7428
7429 =head1 BUGS
7430
7431 =head1 SEE ALSO
7432
7433 L<DBIx::DBSchema>
7434
7435 =cut
7436
7437 1;
7438