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