FS/FS/Schema.pm

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