FS/FS/Schema.pm

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