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.40; #0.40 for mysql upgrade fixes
   7 use DBIx::DBSchema::Table;
   8 use DBIx::DBSchema::Column;
   9 use DBIx::DBSchema::Index;
  10 #can't use this yet, dependency bs #use FS::Conf;
  11
  12 @ISA = qw(Exporter);
  13 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  14
  15 $DEBUG = 0;
  16 $me = '[FS::Schema]';
  17
  18 =head1 NAME
  19
  20 FS::Schema - Freeside database schema
  21
  22 =head1 SYNOPSYS
  23
  24     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  25
  26     $dbdef = reload_dbdef;
  27     $dbdef = reload_dbdef "/non/standard/filename";
  28     $dbdef = dbdef;
  29     $dbdef_dist = dbdef_dist;
  30
  31 =head1 DESCRIPTION
  32
  33 This class represents the database schema.
  34
  35 =head1 METHODS
  36
  37 =over 4
  38
  39 =item reload_dbdef([FILENAME])
  40
  41 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  42 non-default filename.  This command is executed at startup unless
  43 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  44
  45 =cut
  46
  47 sub reload_dbdef {
  48   my $file = shift;
  49
  50   unless ( exists $dbdef_cache{$file} ) {
  51     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  52     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  53       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  54   } else {
  55     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  56   }
  57   $dbdef = $dbdef_cache{$file};
  58 }
  59
  60 =item dbdef
  61
  62 Returns the current database definition (represents the current database,
  63 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  64
  65 =cut
  66
  67 sub dbdef { $dbdef; }
  68
  69 =item dbdef_dist [ DATASRC ]
  70
  71 Returns the current canoical database definition as defined in this file.
  72
  73 Optionally, pass a DBI data source to enable syntax specific to that database.
  74 Currently, this enables "ENGINE=InnoDB" for MySQL databases.
  75
  76 =cut
  77
  78 sub dbdef_dist {
  79   my $datasrc = @_ && !ref($_[0]) ? shift : '';
  80   my $opt = @_ ? shift : {};
  81
  82   my $local_options = '';
  83   if ( $datasrc =~ /^dbi:mysql/i ) {
  84     $local_options = 'ENGINE=InnoDB';
  85   }
  86
  87   ###
  88   # create a dbdef object from the old data structure
  89   ###
  90
  91   my $tables_hashref = tables_hashref();
  92
  93   #turn it into objects
  94   my $dbdef = new DBIx::DBSchema map {
  95
  96     my $tablename = $_;
  97     my $indexnum = 1;
  98
  99     my @columns;
 100     while (@{$tables_hashref->{$tablename}{'columns'}}) {
 101       #my($name, $type, $null, $length, $default, $local) =
 102       my @coldef =
 103         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
 104       my %hash = map { $_ => shift @coldef }
 105                      qw( name type null length default local );
 106
 107       #can be removed once we depend on DBIx::DBSchema 0.39;
 108       $hash{'type'} = 'LONGTEXT'
 109         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 110
 111       unless ( defined $hash{'default'} ) {
 112         warn "$tablename:\n".
 113              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 114       }
 115
 116       push @columns, new DBIx::DBSchema::Column ( \%hash );
 117     }
 118
 119     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 120     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 121     my $unique = $tables_hashref->{$tablename}{'unique'};
 122     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
 123     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 124
 125     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 126     #  specification without a key length".
 127     # better solution: teach DBIx::DBSchema to specify a default length for
 128     #  MySQL indices on text columns, or just to support an index length at all
 129     #  so we can pass something in.
 130     # best solution: eliminate need for this index in cust_main::retry_realtime
 131     @index = grep { @{$_}[0] ne 'statustext' } @index
 132       if $datasrc =~ /^dbi:mysql/i;
 133
 134     my @indices = ();
 135     push @indices, map {
 136                          DBIx::DBSchema::Index->new({
 137                            'name'    => $tablename. $indexnum++,
 138                            'unique'  => 1,
 139                            'columns' => $_,
 140                          });
 141                        }
 142                        @$unique;
 143     push @indices, map {
 144                          DBIx::DBSchema::Index->new({
 145                            'name'    => $tablename. $indexnum++,
 146                            'unique'  => 0,
 147                            'columns' => $_,
 148                          });
 149                        }
 150                        @index;
 151
 152     DBIx::DBSchema::Table->new({
 153       'name'          => $tablename,
 154       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 155       'columns'       => \@columns,
 156       'indices'       => \@indices,
 157       'local_options' => $local_options,
 158     });
 159
 160   } keys %$tables_hashref;
 161
 162   if ( $DEBUG ) {
 163     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 164     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 165   }
 166
 167   #add radius attributes to svc_acct
 168   #
 169   #my($svc_acct)=$dbdef->table('svc_acct');
 170   #
 171   #my($attribute);
 172   #foreach $attribute (@attributes) {
 173   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 174   #    'radius_'. $attribute,
 175   #    'varchar',
 176   #    'NULL',
 177   #    $char_d,
 178   #  ));
 179   #}
 180   #
 181   #foreach $attribute (@check_attributes) {
 182   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 183   #    'rc_'. $attribute,
 184   #    'varchar',
 185   #    'NULL',
 186   #    $char_d,
 187   #  ));
 188   #}
 189
 190   my $tables_hashref_torrus = tables_hashref_torrus();
 191
 192   #create history tables
 193   foreach my $table (
 194     grep {    ! /^(clientapi|access_user)_session/
 195            && ! /^h_/
 196            && ! /^log(_context)?$/
 197            && ! /^(legacy_cust_history|cacti_page|access_user_log)$/
 198            && ( ! /^queue(_arg|_depend|_stat)?$/ || ! $opt->{'queue-no_history'} )
 199            && ! $tables_hashref_torrus->{$_}
 200          }
 201       $dbdef->tables
 202   ) {
 203     my $tableobj = $dbdef->table($table)
 204       or die "unknown table $table";
 205
 206     my %h_indices = ();
 207
 208     unless ( $table eq 'cust_event' || $table eq 'cdr' ) { #others?
 209
 210       my %indices = $tableobj->indices;
 211
 212       %h_indices = map {
 213                          ( "h_$_" =>
 214                              DBIx::DBSchema::Index->new({
 215                                'name'    => 'h_'. $indices{$_}->name,
 216                                'unique'  => 0,
 217                                'columns' => [ @{$indices{$_}->columns} ],
 218                              })
 219                          );
 220                        }
 221                        keys %indices;
 222
 223       $h_indices{"h_${table}_srckey"} =
 224         DBIx::DBSchema::Index->new({
 225           'name'    => "h_${table}_srckey",
 226           'unique'  => 0,
 227           'columns' => [ 'history_action', #right?
 228                          $tableobj->primary_key,
 229                        ],
 230         });
 231
 232       $h_indices{"h_${table}_srckey2"} =
 233          DBIx::DBSchema::Index->new({
 234            'name'    => "h_${table}_srckey2",
 235            'unique'  => 0,
 236            'columns' => [ 'history_date',
 237                           $tableobj->primary_key,
 238                         ],
 239          });
 240
 241     }
 242
 243     my $historynum_type = ( $tableobj->column($tableobj->primary_key)->type
 244                               =~ /^(bigserial|bigint|int8)$/i
 245                                 ? 'bigserial'
 246                                 : 'serial'
 247                           );
 248
 249     my $h_tableobj = DBIx::DBSchema::Table->new( {
 250       'name'          => "h_$table",
 251       'primary_key'   => 'historynum',
 252       'indices'       => \%h_indices,
 253       'local_options' => $local_options,
 254       'columns'       => [
 255           DBIx::DBSchema::Column->new( {
 256             'name'    => 'historynum',
 257             'type'    => $historynum_type,
 258             'null'    => 'NOT NULL',
 259             'length'  => '',
 260             'default' => '',
 261             'local'   => '',
 262           } ),
 263           DBIx::DBSchema::Column->new( {
 264             'name'    => 'history_date',
 265             'type'    => 'int',
 266             'null'    => 'NULL',
 267             'length'  => '',
 268             'default' => '',
 269             'local'   => '',
 270           } ),
 271           DBIx::DBSchema::Column->new( {
 272             'name'    => 'history_user',
 273             'type'    => 'varchar',
 274             'null'    => 'NOT NULL',
 275             'length'  => '80',
 276             'default' => '',
 277             'local'   => '',
 278           } ),
 279           DBIx::DBSchema::Column->new( {
 280             'name'    => 'history_action',
 281             'type'    => 'varchar',
 282             'null'    => 'NOT NULL',
 283             'length'  => '80',
 284             'default' => '',
 285             'local'   => '',
 286           } ),
 287           map {
 288             my $column = $tableobj->column($_);
 289
 290             #clone so as to not disturb the original
 291             $column = DBIx::DBSchema::Column->new( {
 292               map { $_ => $column->$_() }
 293                 qw( name type null length default local )
 294             } );
 295
 296             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 297               $column->type(uc($1).'INT');
 298               $column->null('NULL');
 299             }
 300             #$column->default('')
 301             #  if $column->default =~ /^nextval\(/i;
 302             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 303             #$column->local($local);
 304             $column;
 305           } $tableobj->columns
 306       ],
 307     } );
 308     $dbdef->addtable($h_tableobj);
 309   }
 310
 311   if ( $datasrc =~ /^dbi:mysql/i ) {
 312
 313     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 314       'name'          => 'duplicate_lock',
 315       'primary_key'   => 'duplocknum',
 316       'local_options' => $local_options,
 317       'columns'       => [
 318         DBIx::DBSchema::Column->new( {
 319           'name'    => 'duplocknum',
 320           'type'    => 'serial',
 321           'null'    => 'NOT NULL',
 322           'length'  => '',
 323           'default' => '',
 324           'local'   => '',
 325         } ),
 326         DBIx::DBSchema::Column->new( {
 327           'name'    => 'lockname',
 328           'type'    => 'varchar',
 329           'null'    => 'NOT NULL',
 330           'length'  => '80',
 331           'default' => '',
 332           'local'   => '',
 333         } ),
 334       ],
 335       'indices' => { 'duplicate_lock1' =>
 336                        DBIx::DBSchema::Index->new({
 337                          'name'    => 'duplicate_lock1',
 338                          'unique'  => 1,
 339                          'columns' => [ 'lockname' ],
 340                        })
 341                    },
 342     } );
 343
 344     $dbdef->addtable($dup_lock_table);
 345
 346   }
 347
 348   $dbdef;
 349
 350 }
 351
 352 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
 353 sub tables_hashref_torrus {
 354
 355   return {
 356
 357     # Collector export table. It usually grows at several megabytes
 358     # per month, and is updated every 5 minutes
 359     'srvexport' => {
 360       'columns' => [
 361         'id',         'serial', '', '', '', '',
 362         'srv_date',     'date', '', '', '', '',#date and time of the data sample
 363         'srv_time',     'time', '', '', '', '',
 364         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
 365         'value',     'double precision', '', '', '', '',#collected rate or gauge value
 366         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
 367       ],
 368       'primary_key' => 'id',
 369       'unique' => [],
 370       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
 371     },
 372
 373     #Tables for (currently monthly only) report contents.
 374     #These are updated usually once per month, and read at the moment of
 375     #rendering the report output (HTML now, PDF or XML or Excel or whatever
 376     #in the future)
 377
 378     #DBIx::Sequence backend, theplatform-independent inplementation
 379     #of sequences
 380     'dbix_sequence_state' => {
 381       'columns' => [
 382         'id',       'serial', '', '', '', '',
 383         'dataset', 'varchar', '', 50, '', '',
 384         'state_id',    'int', '', '', '', '',
 385       ],
 386       'primary_key' => 'id',
 387       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
 388       'unique' => [ [ 'dataset', 'state_id' ], ],
 389       'index'  => [],
 390     },
 391
 392     'dbix_sequence_release' => {
 393       'columns' => [
 394         'id',       'serial', '', '', '', '',
 395         'dataset', 'varchar', '', 50, '', '',
 396         'released_id', 'int', '', '', '', '',
 397       ],
 398       'primary_key' => 'id',
 399       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
 400       'unique' => [ [ 'dataset', 'released_id', ] ],
 401       'index'  => [],
 402     },
 403
 404     #Each report is characterized by name, date and time.
 405     #Monthly reports are automatically assigned 00:00 of the 1st day
 406     #in the month. The report contains fields for every service ID
 407     #defined across all datasource trees.
 408     'reports' => {
 409       'columns' => [
 410         'id',          'serial', '', '', '', '',
 411         'rep_date',      'date', '', '', '', '',#Start date of the report
 412         'rep_time',      'time', '', '', '', '',#Start time of the report
 413         'reportname', 'varchar', '', 64, '', '',#Report name, such as
 414                                                 # MonthlyUsage
 415         'iscomplete',     'int', '', '', '', '',#0 when the report is in
 416                                                 # progress, 1 when it is ready
 417       ],
 418       'primary_key' => 'id',
 419       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
 420       'index'  => [ [ 'rep_date' ] ],
 421     },
 422
 423     #Each report contains fields. For each service ID,
 424     #the report may contain several fields for various statistics.
 425     #Each field contains information about the units of the value it
 426     #contains
 427     'reportfields' => {
 428       'columns' => [
 429         'id',              'serial',     '', '',    '', '',
 430         'rep_id',             'int', 'NULL', '',    '', '',
 431         'name',           'varchar',     '', 64,    '', '',#name of the field,
 432                                                            # such as AVG or MAX
 433         'serviceid',      'varchar',     '', 64,    '', '',#service ID
 434         'value', 'double precision',     '', '',    '', '',#Numeric value
 435         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
 436                                                            # or Mbps
 437       ],
 438       'primary_key', => 'id',
 439       'unique' => [ [ qw(rep_id name serviceid) ] ],
 440       'index'  => [],
 441     },
 442
 443   };
 444
 445 }
 446
 447 sub tables_hashref {
 448
 449   my $char_d = 80; #default maxlength for text fields
 450
 451   #my(@date_type)  = ( 'timestamp', '', ''     );
 452   my @date_type = ( 'int', 'NULL', ''     );
 453   my @perl_type = ( 'text', 'NULL', ''  );
 454   my @money_type = ( 'decimal',   '', '10,2' );
 455   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 456   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 457   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 458
 459   my $username_len = 64; #usernamemax config file
 460
 461     # name type nullability length default local
 462
 463   return {
 464
 465     'agent' => {
 466       'columns' => [
 467         'agentnum',          'serial',    '',       '', '', '',
 468         'agent',            'varchar',    '',  $char_d, '', '',
 469         'typenum',              'int',    '',       '', '', '',
 470         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 471         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 472         'agent_custnum',        'int', 'NULL',      '', '', '',
 473         'disabled',            'char', 'NULL',       1, '', '',
 474         'username',         'varchar', 'NULL', $char_d, '', '',
 475         '_password',        'varchar', 'NULL', $char_d, '', '',
 476         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 477         'prog',                     @perl_type, '', '', #deprecated (never used)
 478       ],
 479       'primary_key' => 'agentnum',
 480       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 481                                             #insert is giving it a value, tho..
 482       #'index' => [ ['typenum'], ['disabled'] ],
 483       'unique' => [],
 484       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 485     },
 486
 487     'agent_pkg_class' => {
 488       'columns' => [
 489         'agentpkgclassnum',    'serial',     '',    '', '', '',
 490         'agentnum',               'int',     '',    '', '', '',
 491         'classnum',               'int', 'NULL',    '', '', '',
 492         'commission_percent', 'decimal',     '', '7,4', '', '',
 493       ],
 494       'primary_key' => 'agentpkgclassnum',
 495       'unique'      => [ [ 'agentnum', 'classnum' ], ],
 496       'index'       => [],
 497     },
 498
 499     'agent_type' => {
 500       'columns' => [
 501         'typenum',  'serial',      '',      '', '', '',
 502         'atype',    'varchar',     '', $char_d, '', '',
 503         'disabled',    'char', 'NULL',       1, '', '',
 504       ],
 505       'primary_key' => 'typenum',
 506       'unique' => [],
 507       'index' => [ ['disabled'] ],
 508     },
 509
 510     'type_pkgs' => {
 511       'columns' => [
 512         'typepkgnum', 'serial', '', '', '', '',
 513         'typenum',   'int',  '', '', '', '',
 514         'pkgpart',   'int',  '', '', '', '',
 515       ],
 516       'primary_key' => 'typepkgnum',
 517       'unique' => [ ['typenum', 'pkgpart'] ],
 518       'index' => [ ['typenum'] ],
 519     },
 520
 521     'sales' => {
 522       'columns' => [
 523         'salesnum',          'serial',    '',       '', '', '',
 524         'salesperson',      'varchar',    '',  $char_d, '', '',
 525         'agentnum',             'int', 'NULL',      '', '', '',
 526         'sales_custnum',        'int', 'NULL',      '', '', '',
 527         'disabled',            'char', 'NULL',       1, '', '',
 528       ],
 529       'primary_key' => 'salesnum',
 530       'unique' => [],
 531       'index' => [ ['salesnum'], ['disabled'] ],
 532     },
 533
 534     'sales_pkg_class' => {
 535       'columns' => [
 536         'salespkgclassnum',    'serial',     '',    '', '', '',
 537         'salesnum',               'int',     '',    '', '', '',
 538         'classnum',               'int', 'NULL',    '', '', '',
 539         'commission_percent', 'decimal',     '', '7,4', '', '',
 540         'commission_duration',    'int', 'NULL',    '', '', '',
 541       ],
 542       'primary_key' => 'salespkgclassnum',
 543       'unique'      => [ [ 'salesnum', 'classnum' ], ],
 544       'index'       => [],
 545     },
 546
 547     'cust_attachment' => {
 548       'columns' => [
 549         'attachnum', 'serial', '', '', '', '',
 550         'custnum',   'int', '', '', '', '',
 551         '_date',     @date_type, '', '',
 552         'otaker',    'varchar', 'NULL', 32, '', '',
 553         'usernum',   'int', 'NULL', '', '', '',
 554         'filename',  'varchar', '', 255, '', '',
 555         'mime_type', 'varchar', '', $char_d, '', '',
 556         'title',     'varchar', 'NULL', $char_d, '', '',
 557         'body',      'blob', 'NULL', '', '', '',
 558         'disabled',  @date_type, '', '',
 559       ],
 560       'primary_key' => 'attachnum',
 561       'unique'      => [],
 562       'index'       => [ ['custnum'], ['usernum'], ],
 563     },
 564
 565     'cust_bill' => {
 566       'columns' => [
 567         #regular fields
 568         'invnum',    'serial',     '', '', '', '',
 569         'custnum',      'int',     '', '', '', '',
 570         '_date',        @date_type,        '', '',
 571         'charged',      @money_type,       '', '',
 572         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 573
 574         #customer balance info at invoice generation time
 575         #(deprecated)
 576         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 577         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 578
 579         #deprecated (unused by now, right?)
 580         'printed',      'int',     '', '', '', '',
 581
 582         #specific use cases
 583         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 584         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 585         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 586         'promised_date', @date_type,       '', '',
 587       ],
 588       'primary_key' => 'invnum',
 589       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 590       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
 591     },
 592
 593     'cust_bill_void' => {
 594       'columns' => [
 595         #regular fields
 596         'invnum',       'int',     '', '', '', '',
 597         'custnum',      'int',     '', '', '', '',
 598         '_date',        @date_type,        '', '',
 599         'charged',      @money_type,       '', '',
 600         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 601
 602         #customer balance info at invoice generation time
 603         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 604         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 605
 606         #specific use cases
 607         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 608         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 609         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 610         'promised_date', @date_type,       '', '',
 611
 612         #void fields
 613         'void_date', @date_type, '', '',
 614         'reason',    'varchar',   'NULL', $char_d, '', '',
 615         'void_usernum',   'int', 'NULL', '', '', '',
 616       ],
 617       'primary_key' => 'invnum',
 618       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 619       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'], [ 'void_usernum' ] ],
 620     },
 621
 622     #for importing invoices from a legacy system for display purposes only
 623     # no effect upon balance
 624     'legacy_cust_bill' => {
 625       'columns' => [
 626         'legacyinvnum',  'serial',     '',      '', '', '',
 627         'legacyid',     'varchar', 'NULL', $char_d, '', '',
 628         'custnum',          'int',     '',      '', '', '',
 629         '_date',       @date_type,                  '', '',
 630         'charged',    @money_type,                  '', '',
 631         'content_pdf',     'blob', 'NULL',      '', '', '',
 632         'content_html',    'text', 'NULL',      '', '', '',
 633         'locale',       'varchar', 'NULL',      16, '', '',
 634       ],
 635       'primary_key' => 'legacyinvnum',
 636       'unique' => [],
 637       'index'  => [ ['legacyid', 'custnum', 'locale' ], ],
 638     },
 639
 640     'legacy_cust_history' => {
 641       'columns' => [
 642         'legacyhistorynum', 'serial',     '',        '', '', '',
 643         'custnum',             'int',     '',        '', '', '',
 644         'history_action',  'varchar',     '',   $char_d, '', '',
 645         'history_date',           @date_type,            '', '',
 646         'history_usernum',     'int', 'NULL',        '', '', '',
 647         'item',            'varchar', 'NULL',   $char_d, '', '',
 648         'description',     'varchar', 'NULL', 2*$char_d, '', '',
 649         'change_data',        'text', 'NULL',        '', '', '',
 650       ],
 651       'primary_key'  => 'legacyhistorynum',
 652       'unique'       => [],
 653       'index'        => [ ['custnum'], ['history_date'], ],
 654     },
 655
 656     'cust_statement' => {
 657       'columns' => [
 658         'statementnum', 'serial', '', '', '', '',
 659         'custnum',         'int', '', '', '', '',
 660         '_date',           @date_type,    '', '',
 661       ],
 662       'primary_key' => 'statementnum',
 663       'unique' => [],
 664       'index' => [ ['custnum'], ['_date'], ],
 665     },
 666
 667     'cust_bill_event' => {
 668       'columns' => [
 669         'eventnum',    'serial',  '', '', '', '',
 670         'invnum',   'int',  '', '', '', '',
 671         'eventpart',   'int',  '', '', '', '',
 672         '_date',     @date_type, '', '',
 673         'status', 'varchar', '', $char_d, '', '',
 674         'statustext', 'text', 'NULL', '', '', '',
 675       ],
 676       'primary_key' => 'eventnum',
 677       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 678       'unique' => [],
 679       'index' => [ ['invnum'], ['status'], ['eventpart'],
 680                    ['statustext'], ['_date'],
 681                  ],
 682     },
 683
 684     'part_bill_event' => {
 685       'columns' => [
 686         'eventpart',    'serial',  '', '', '', '',
 687         'freq',        'varchar',       'NULL',     $char_d, '', '',
 688         'payby',       'char',  '', 4, '', '',
 689         'event',       'varchar',           '',     $char_d, '', '',
 690         'eventcode',    @perl_type, '', '',
 691         'seconds',     'int', 'NULL', '', '', '',
 692         'weight',      'int', '', '', '', '',
 693         'plan',       'varchar', 'NULL', $char_d, '', '',
 694         'plandata',   'text', 'NULL', '', '', '',
 695         'reason',     'int', 'NULL', '', '', '',
 696         'disabled',     'char', 'NULL', 1, '', '',
 697       ],
 698       'primary_key' => 'eventpart',
 699       'unique' => [],
 700       'index' => [ ['payby'], ['disabled'], ],
 701     },
 702
 703     'part_event' => {
 704       'columns' => [
 705         'eventpart',   'serial',      '',      '', '', '',
 706         'agentnum',    'int',     'NULL',      '', '', '',
 707         'event',       'varchar',     '', $char_d, '', '',
 708         'eventtable',  'varchar',     '', $char_d, '', '',
 709         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 710         'weight',      'int',         '',      '', '', '',
 711         'action',      'varchar',     '', $char_d, '', '',
 712         'disabled',     'char',   'NULL',       1, '', '',
 713       ],
 714       'primary_key' => 'eventpart',
 715       'unique' => [],
 716       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 717     },
 718
 719     'part_event_option' => {
 720       'columns' => [
 721         'optionnum', 'serial', '', '', '', '',
 722         'eventpart', 'int', '', '', '', '',
 723         'optionname', 'varchar', '', $char_d, '', '',
 724         'optionvalue', 'text', 'NULL', '', '', '',
 725       ],
 726       'primary_key' => 'optionnum',
 727       'unique'      => [],
 728       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 729     },
 730
 731     'part_event_condition' => {
 732       'columns' => [
 733         'eventconditionnum', 'serial', '', '', '', '',
 734         'eventpart', 'int', '', '', '', '',
 735         'conditionname', 'varchar', '', $char_d, '', '',
 736       ],
 737       'primary_key' => 'eventconditionnum',
 738       'unique'      => [],
 739       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 740     },
 741
 742     'part_event_condition_option' => {
 743       'columns' => [
 744         'optionnum', 'serial', '', '', '', '',
 745         'eventconditionnum', 'int', '', '', '', '',
 746         'optionname', 'varchar', '', $char_d, '', '',
 747         'optionvalue', 'text', 'NULL', '', '', '',
 748       ],
 749       'primary_key' => 'optionnum',
 750       'unique'      => [],
 751       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 752     },
 753
 754     'part_event_condition_option_option' => {
 755       'columns' => [
 756         'optionoptionnum', 'serial', '', '', '', '',
 757         'optionnum', 'int', '', '', '', '',
 758         'optionname', 'varchar', '', $char_d, '', '',
 759         'optionvalue', 'text', 'NULL', '', '', '',
 760       ],
 761       'primary_key' => 'optionoptionnum',
 762       'unique'      => [],
 763       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 764     },
 765
 766     'cust_event' => {
 767       'columns' => [
 768         'eventnum',    'serial',  '', '', '', '',
 769         'eventpart',   'int',  '', '', '', '',
 770         'tablenum',   'int',  '', '', '', '',
 771         '_date',     @date_type, '', '',
 772         'status', 'varchar', '', $char_d, '', '',
 773         'statustext', 'text', 'NULL', '', '', '',
 774         'no_action',  'char', 'NULL',  1, '', '',
 775       ],
 776       'primary_key' => 'eventnum',
 777       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 778       'unique' => [],
 779       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 780                    ['statustext'], ['_date'], ['no_action'],
 781                  ],
 782     },
 783
 784     'cust_event_fee' => {
 785       'columns' => [
 786         'eventfeenum', 'serial', '', '', '', '',
 787         'eventnum',       'int', '', '', '', '',
 788         'billpkgnum',     'int', 'NULL', '', '', '',
 789         'feepart',        'int', '', '', '', '',
 790         'nextbill',      'char', 'NULL',  1, '', '',
 791       ],
 792       'primary_key'  => 'eventfeenum', # I'd rather just use eventnum
 793       'unique' => [ [ 'billpkgnum' ], [ 'eventnum' ] ], # one-to-one link
 794       'index'  => [ [ 'feepart' ] ],
 795     },
 796
 797     'cust_bill_pkg' => {
 798       'columns' => [
 799         'billpkgnum',        'serial',     '',      '', '', '',
 800         'invnum',               'int',     '',      '', '', '',
 801         'pkgnum',               'int',     '',      '', '', '',
 802         'pkgpart_override',     'int', 'NULL',      '', '', '',
 803         'setup',               @money_type,             '', '',
 804         'recur',               @money_type,             '', '',
 805         'sdate',               @date_type,              '', '',
 806         'edate',               @date_type,              '', '',
 807         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 808         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 809         'section',          'varchar', 'NULL', $char_d, '', '',
 810         'freq',             'varchar', 'NULL', $char_d, '', '',
 811         'quantity',             'int', 'NULL',      '', '', '',
 812         'unitsetup',           @money_typen,            '', '',
 813         'unitrecur',           @money_typen,            '', '',
 814         'hidden',              'char', 'NULL',       1, '', '',
 815         'feepart',              'int', 'NULL',      '', '', '',
 816       ],
 817       'primary_key' => 'billpkgnum',
 818       'unique' => [],
 819       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 820     },
 821
 822     'cust_bill_pkg_detail' => {
 823       'columns' => [
 824         'detailnum', 'serial', '', '', '', '',
 825         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 826         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 827         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 828         'amount',  'decimal', 'NULL', '10,4', '', '',
 829         'format',  'char', 'NULL', 1, '', '',
 830         'classnum', 'int', 'NULL', '', '', '',
 831         'duration', 'int', 'NULL', '',  0, '',
 832         'phonenum', 'varchar', 'NULL', 25, '', '',
 833         'accountcode', 'varchar',  'NULL',      32, '', '',
 834         'startdate',  @date_type, '', '',
 835         'regionname', 'varchar', 'NULL', $char_d, '', '',
 836         'detail',  'varchar', '', 255, '', '',
 837       ],
 838       'primary_key' => 'detailnum',
 839       'unique' => [],
 840       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 841     },
 842
 843     'cust_bill_pkg_display' => {
 844       'columns' => [
 845         'billpkgdisplaynum', 'serial', '', '', '', '',
 846         'billpkgnum', 'int', '', '', '', '',
 847         'section',  'varchar', 'NULL', $char_d, '', '',
 848         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 849         #'unitrecur', @money_typen, '', '',     #this too?
 850         'post_total', 'char', 'NULL', 1, '', '',
 851         'type',       'char', 'NULL', 1, '', '',
 852         'summary',    'char', 'NULL', 1, '', '',
 853       ],
 854       'primary_key' => 'billpkgdisplaynum',
 855       'unique' => [],
 856       'index' => [ ['billpkgnum'], ],
 857     },
 858
 859     'cust_bill_pkg_fee' => {
 860       'columns' => [
 861         'billpkgfeenum',    'serial', '', '', '', '',
 862         'billpkgnum',          'int', '', '', '', '',
 863         'base_invnum',       'int', '', '', '', '',
 864         'base_billpkgnum',   'int', 'NULL', '', '', '',
 865         'amount',        @money_type,         '', '',
 866       ],
 867       'primary_key' => 'billpkgfeenum',
 868       'unique'      => [],
 869       'index'       => [ ['billpkgnum'],
 870                          ['base_invnum'],
 871                          ['base_billpkgnum'],
 872                        ],
 873     },
 874
 875     'cust_bill_pkg_fee_void' => {
 876       'columns' => [
 877         'billpkgfeenum',    'serial', '', '', '', '',
 878         'billpkgnum',          'int', '', '', '', '',
 879         'base_invnum',       'int', '', '', '', '',
 880         'base_billpkgnum',   'int', 'NULL', '', '', '',
 881         'amount',        @money_type,         '', '',
 882       ],
 883       'primary_key' => 'billpkgfeenum',
 884       'unique'      => [],
 885       'index'       => [ ['billpkgnum'],
 886                          ['base_invnum'],
 887                          ['base_billpkgnum'],
 888                        ],
 889     },
 890
 891
 892     'cust_bill_pkg_tax_location' => {
 893       'columns' => [
 894         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 895         'billpkgnum',               'int',      '', '', '', '',
 896         'taxnum',                   'int',      '', '', '', '',
 897         'taxtype',              'varchar',      '', $char_d, '', '',
 898         'pkgnum',                   'int',      '', '', '', '', #redundant
 899         'locationnum',              'int',      '', '', '', '', #redundant
 900         'amount',                   @money_type,        '', '',
 901         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
 902       ],
 903       'primary_key' => 'billpkgtaxlocationnum',
 904       'unique' => [],
 905       'index'  => [ [ 'billpkgnum' ],
 906                     [ 'taxnum' ],
 907                     [ 'pkgnum' ],
 908                     [ 'locationnum' ],
 909                     [ 'taxable_billpkgnum' ],
 910                   ],
 911     },
 912
 913     'cust_bill_pkg_tax_rate_location' => {
 914       'columns' => [
 915         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 916         'billpkgnum',                   'int',      '', '', '', '',
 917         'taxnum',                       'int',      '', '', '', '',
 918         'taxtype',                  'varchar',      '', $char_d, '', '',
 919         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 920         'taxratelocationnum',           'int',      '', '', '', '',
 921         'amount',                       @money_type,        '', '',
 922         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
 923         'taxclass',             'varchar',  'NULL', 10, '', '',
 924       ],
 925       'primary_key' => 'billpkgtaxratelocationnum',
 926       'unique' => [],
 927       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ],
 928                     [ 'taxable_billpkgnum' ], ],
 929     },
 930
 931     'cust_bill_pkg_void' => {
 932       'columns' => [
 933         'billpkgnum',           'int',     '',      '', '', '',
 934         'invnum',               'int',     '',      '', '', '',
 935         'pkgnum',               'int',     '',      '', '', '',
 936         'pkgpart_override',     'int', 'NULL',      '', '', '',
 937         'setup',               @money_type,             '', '',
 938         'recur',               @money_type,             '', '',
 939         'sdate',               @date_type,              '', '',
 940         'edate',               @date_type,              '', '',
 941         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 942         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 943         'section',          'varchar', 'NULL', $char_d, '', '',
 944         'freq',             'varchar', 'NULL', $char_d, '', '',
 945         'quantity',             'int', 'NULL',      '', '', '',
 946         'unitsetup',           @money_typen,            '', '',
 947         'unitrecur',           @money_typen,            '', '',
 948         'hidden',              'char', 'NULL',       1, '', '',
 949         'feepart',              'int', 'NULL',      '', '', '',
 950         #void fields
 951         'void_date', @date_type, '', '',
 952         'reason',    'varchar',   'NULL', $char_d, '', '',
 953         'void_usernum',   'int', 'NULL', '', '', '',
 954       ],
 955       'primary_key' => 'billpkgnum',
 956       'unique' => [],
 957       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], [ 'void_usernum' ], ],
 958     },
 959
 960     'cust_bill_pkg_detail_void' => {
 961       'columns' => [
 962         'detailnum',  'int', '', '', '', '',
 963         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 964         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 965         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 966         'amount',  'decimal', 'NULL', '10,4', '', '',
 967         'format',  'char', 'NULL', 1, '', '',
 968         'classnum', 'int', 'NULL', '', '', '',
 969         'duration', 'int', 'NULL', '',  0, '',
 970         'phonenum', 'varchar', 'NULL', 25, '', '',
 971         'accountcode', 'varchar',  'NULL',      32, '', '',
 972         'startdate',  @date_type, '', '',
 973         'regionname', 'varchar', 'NULL', $char_d, '', '',
 974         'detail',  'varchar', '', 255, '', '',
 975       ],
 976       'primary_key' => 'detailnum',
 977       'unique' => [],
 978       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 979     },
 980
 981     'cust_bill_pkg_display_void' => {
 982       'columns' => [
 983         'billpkgdisplaynum',    'int', '', '', '', '',
 984         'billpkgnum', 'int', '', '', '', '',
 985         'section',  'varchar', 'NULL', $char_d, '', '',
 986         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 987         #'unitrecur', @money_typen, '', '',     #this too?
 988         'post_total', 'char', 'NULL', 1, '', '',
 989         'type',       'char', 'NULL', 1, '', '',
 990         'summary',    'char', 'NULL', 1, '', '',
 991       ],
 992       'primary_key' => 'billpkgdisplaynum',
 993       'unique' => [],
 994       'index' => [ ['billpkgnum'], ],
 995     },
 996
 997     'cust_bill_pkg_tax_location_void' => {
 998       'columns' => [
 999         'billpkgtaxlocationnum',    'int',      '', '', '', '',
1000         'billpkgnum',               'int',      '', '', '', '',
1001         'taxnum',                   'int',      '', '', '', '',
1002         'taxtype',              'varchar',      '', $char_d, '', '',
1003         'pkgnum',                   'int',      '', '', '', '',
1004         'locationnum',              'int',      '', '', '', '', #redundant?
1005         'amount',                   @money_type,        '', '',
1006         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
1007       ],
1008       'primary_key' => 'billpkgtaxlocationnum',
1009       'unique' => [],
1010       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
1011     },
1012
1013     'cust_bill_pkg_tax_rate_location_void' => {
1014       'columns' => [
1015         'billpkgtaxratelocationnum',    'int',      '', '', '', '',
1016         'billpkgnum',                   'int',      '', '', '', '',
1017         'taxnum',                       'int',      '', '', '', '',
1018         'taxtype',                  'varchar',      '', $char_d, '', '',
1019         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
1020         'taxratelocationnum',           'int',      '', '', '', '',
1021         'amount',                       @money_type,        '', '',
1022       ],
1023       'primary_key' => 'billpkgtaxratelocationnum',
1024       'unique' => [],
1025       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
1026     },
1027
1028     'cust_credit' => {
1029       'columns' => [
1030         'crednum',  'serial', '', '', '', '',
1031         'custnum',  'int', '', '', '', '',
1032         '_date',    @date_type, '', '',
1033         'amount',   @money_type, '', '',
1034         'otaker',   'varchar', 'NULL', 32, '', '',
1035         'usernum',   'int', 'NULL', '', '', '',
1036         'reason',   'text', 'NULL', '', '', '',
1037         'reasonnum', 'int', 'NULL', '', '', '',
1038         'addlinfo', 'text', 'NULL', '', '', '',
1039         'closed',    'char', 'NULL', 1, '', '',
1040         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1041         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
1042         'commission_agentnum', 'int', 'NULL', '', '', '', #
1043         'commission_salesnum', 'int', 'NULL', '', '', '', #
1044         'commission_pkgnum',   'int', 'NULL', '', '', '', #
1045         'credbatch',    'varchar', 'NULL', $char_d, '', '',
1046       ],
1047       'primary_key' => 'crednum',
1048       'unique' => [],
1049       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1050                    ['commission_salesnum'], ['credbatch'],
1051                  ],
1052     },
1053
1054     'cust_credit_void' => {
1055       'columns' => [
1056         'crednum',  'serial',     '', '', '', '',
1057         'custnum',     'int',     '', '', '', '',
1058         '_date',  @date_type,             '', '',
1059         'amount',@money_type,             '', '',
1060         'currency',   'char', 'NULL',  3, '', '',
1061         'otaker',  'varchar', 'NULL', 32, '', '',
1062         'usernum',     'int', 'NULL', '', '', '',
1063         'reason',     'text', 'NULL', '', '', '',
1064         'reasonnum',   'int', 'NULL', '', '', '',
1065         'addlinfo',   'text', 'NULL', '', '', '',
1066         'closed',     'char', 'NULL',  1, '', '',
1067         'pkgnum',      'int', 'NULL', '', '','',
1068         'eventnum',    'int', 'NULL', '', '','',
1069         'commission_agentnum', 'int', 'NULL', '', '', '',
1070         'commission_salesnum', 'int', 'NULL', '', '', '',
1071         'commission_pkgnum',   'int', 'NULL', '', '', '',
1072         #void fields
1073         'void_date',  @date_type,                  '', '',
1074         'void_reason', 'varchar', 'NULL', $char_d, '', '',
1075         'void_reasonnum', 'int', 'NULL', '', '', '',
1076         'void_usernum',    'int', 'NULL',      '', '', '',
1077       ],
1078       'primary_key' => 'crednum',
1079       'unique' => [],
1080       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1081                    [ 'commission_salesnum' ],
1082                  ],
1083     },
1084
1085
1086     'cust_credit_bill' => {
1087       'columns' => [
1088         'creditbillnum', 'serial', '', '', '', '',
1089         'crednum',  'int', '', '', '', '',
1090         'invnum',  'int', '', '', '', '',
1091         '_date',    @date_type, '', '',
1092         'amount',   @money_type, '', '',
1093         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1094       ],
1095       'primary_key' => 'creditbillnum',
1096       'unique' => [],
1097       'index' => [ ['crednum'], ['invnum'] ],
1098     },
1099
1100     'cust_credit_bill_pkg' => {
1101       'columns' => [
1102         'creditbillpkgnum', 'serial', '',      '', '', '',
1103         'creditbillnum',       'int', '',      '', '', '',
1104         'billpkgnum',          'int', '',      '', '', '',
1105         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1106         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1107         'amount',            @money_type,          '', '',
1108         'setuprecur',      'varchar', '', $char_d, '', '',
1109         'sdate',   @date_type, '', '',
1110         'edate',   @date_type, '', '',
1111       ],
1112       'primary_key' => 'creditbillpkgnum',
1113       'unique'      => [],
1114       'index'       => [ [ 'creditbillnum' ],
1115                          [ 'billpkgnum' ],
1116                          [ 'billpkgtaxlocationnum' ],
1117                          [ 'billpkgtaxratelocationnum' ],
1118                        ],
1119     },
1120
1121     'cust_main' => {
1122       'columns' => [
1123         'custnum',  'serial',  '',     '', '', '',
1124         'agentnum', 'int',  '',     '', '', '',
1125         'salesnum', 'int',  'NULL', '', '', '',
1126         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
1127         'classnum', 'int', 'NULL', '', '', '',
1128         'custbatch', 'varchar', 'NULL', $char_d, '', '',
1129 #        'titlenum', 'int',  'NULL',   '', '', '',
1130         'last',     'varchar', '',   2*$char_d, '', '',
1131 #        'middle',   'varchar', 'NULL', $char_d, '', '',
1132         'first',    'varchar', '',     $char_d, '', '',
1133         'ss',       'varchar', 'NULL', 11, '', '',
1134         'stateid', 'varchar', 'NULL', $char_d, '', '',
1135         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
1136         'national_id', 'varchar', 'NULL', $char_d, '', '',
1137         'birthdate' ,@date_type, '', '',
1138         'spouse_last',  'varchar', 'NULL', 2*$char_d, '', '',
1139         'spouse_first', 'varchar', 'NULL', $char_d, '', '',
1140         'spouse_birthdate', @date_type, '', '',
1141         'anniversary_date', @date_type, '', '',
1142         'signupdate',@date_type, '', '',
1143         'dundate',   @date_type, '', '',
1144         'company',  'varchar', 'NULL', $char_d, '', '',
1145         'address1', 'varchar', 'NULL', $char_d, '', '',
1146         'address2', 'varchar', 'NULL', $char_d, '', '',
1147         'city',     'varchar', 'NULL', $char_d, '', '',
1148         'county',   'varchar', 'NULL', $char_d, '', '',
1149         'state',    'varchar', 'NULL', $char_d, '', '',
1150         'zip',      'varchar', 'NULL', 10, '', '',
1151         'country',  'char',    'NULL',  2, '', '',
1152         'latitude', 'decimal', 'NULL', '10,7', '', '',
1153         'longitude','decimal', 'NULL', '10,7', '', '',
1154         'coord_auto',  'char', 'NULL',  1, '', '',
1155         'addr_clean',  'char', 'NULL',  1, '', '',
1156         'daytime',  'varchar', 'NULL', 20, '', '',
1157         'night',    'varchar', 'NULL', 20, '', '',
1158         'fax',      'varchar', 'NULL', 12, '', '',
1159         'mobile',   'varchar', 'NULL', 12, '', '',
1160         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '',
1161 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
1162         'ship_first',    'varchar', 'NULL', $char_d, '', '',
1163         'ship_company',  'varchar', 'NULL', $char_d, '', '',
1164         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
1165         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
1166         'ship_city',     'varchar', 'NULL', $char_d, '', '',
1167         'ship_county',   'varchar', 'NULL', $char_d, '', '',
1168         'ship_state',    'varchar', 'NULL', $char_d, '', '',
1169         'ship_zip',      'varchar', 'NULL', 10, '', '',
1170         'ship_country',  'char', 'NULL', 2, '', '',
1171         'ship_latitude', 'decimal', 'NULL', '10,7', '', '',
1172         'ship_longitude','decimal', 'NULL', '10,7', '', '',
1173         'ship_coord_auto',  'char', 'NULL',  1, '', '',
1174         'ship_addr_clean',  'char', 'NULL',  1, '', '',
1175         'ship_daytime',  'varchar', 'NULL', 20, '', '',
1176         'ship_night',    'varchar', 'NULL', 20, '', '',
1177         'ship_fax',      'varchar', 'NULL', 12, '', '',
1178         'ship_mobile',   'varchar', 'NULL', 12, '', '',
1179         'payby',    'char', '',     4, '', '',
1180         'payinfo',  'varchar', 'NULL', 512, '', '',
1181         'paycardtype', 'varchar', 'NULL',   $char_d, '', '',
1182         'paycvv',   'varchar', 'NULL', 512, '', '',
1183         'paymask', 'varchar', 'NULL', $char_d, '', '',
1184         #'paydate',  @date_type, '', '',
1185         'paydate',  'varchar', 'NULL', 10, '', '',
1186         'paystart_month', 'int', 'NULL', '', '', '',
1187         'paystart_year',  'int', 'NULL', '', '', '',
1188         'payissue', 'varchar', 'NULL', 2, '', '',
1189         'payname',  'varchar', 'NULL', 2*$char_d, '', '',
1190         'paystate', 'varchar', 'NULL', $char_d, '', '',
1191         'paytype',  'varchar', 'NULL', $char_d, '', '',
1192         'payip',    'varchar', 'NULL', 15, '', '',
1193         'geocode',  'varchar', 'NULL', 20,  '', '',
1194         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
1195         'censusyear', 'char', 'NULL', 4, '', '',
1196         'district', 'varchar', 'NULL', 20, '', '',
1197         'tax',      'char', 'NULL', 1, '', '',
1198         'otaker',   'varchar', 'NULL',    32, '', '',
1199         'usernum',   'int', 'NULL', '', '', '',
1200         'refnum',   'int',  '',     '', '', '',
1201         'referral_custnum', 'int',  'NULL', '', '', '',
1202         'comments', 'text', 'NULL', '', '', '',
1203         'spool_cdr','char', 'NULL', 1, '', '',
1204         'squelch_cdr','char', 'NULL', 1, '', '',
1205         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
1206         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
1207         'credit_limit', @money_typen, '', '',
1208         'archived', 'char', 'NULL', 1, '', '',
1209         'email_csv_cdr', 'char', 'NULL', 1, '', '',
1210         'accountcode_cdr', 'char', 'NULL', 1, '', '',
1211         'billday',   'int', 'NULL', '', '', '',
1212         'prorate_day',   'int', 'NULL', '', '', '',
1213         'force_prorate_day', 'char', 'NULL', 1, '', '',
1214         'edit_subject', 'char', 'NULL', 1, '', '',
1215         'locale', 'varchar', 'NULL', 16, '', '',
1216         'calling_list_exempt', 'char', 'NULL', 1, '', '',
1217         'invoice_noemail', 'char', 'NULL', 1, '', '',
1218         'message_noemail', 'char', 'NULL', 1, '', '',
1219         'bill_locationnum', 'int', 'NULL', '', '', '',
1220         'ship_locationnum', 'int', 'NULL', '', '', '',
1221         'invoice_ship_address', 'char', 'NULL', 1, '', '',
1222       ],
1223       'primary_key' => 'custnum',
1224       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
1225       #'index' => [ ['last'], ['company'] ],
1226       'index' => [
1227                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
1228                    [ 'custbatch' ],
1229                    [ 'referral_custnum' ],
1230                    [ 'payby' ], [ 'paydate' ],
1231                    [ 'archived' ],
1232                    [ 'ship_locationnum' ],
1233                    [ 'bill_locationnum' ],
1234                  ],
1235     },
1236
1237     'cust_recon' => {  # (some sort of not-well understood thing for OnPac)
1238       'columns' => [
1239         'reconid',      'serial',  '',          '', '', '',
1240         'recondate',    @date_type,                 '', '',
1241         'custnum',      'int'   ,  '',          '', '', '',
1242         'agentnum',     'int',     '',          '', '', '',
1243         'last',         'varchar', '',     $char_d, '', '',
1244         'first',        'varchar', '',     $char_d, '', '',
1245         'address1',     'varchar', '',     $char_d, '', '',
1246         'address2',     'varchar', 'NULL', $char_d, '', '',
1247         'city',         'varchar', '',     $char_d, '', '',
1248         'state',        'varchar', 'NULL', $char_d, '', '',
1249         'zip',          'varchar', 'NULL',      10, '', '',
1250         'pkg',          'varchar', 'NULL', $char_d, '', '',
1251         'adjourn',      @date_type,                 '', '',
1252         'status',       'varchar', 'NULL',      10, '', '',
1253         'agent_custid', 'varchar',  '',    $char_d, '', '',
1254         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
1255         'agent_adjourn', @date_type,                '', '',
1256         'comments',     'text',    'NULL',      '', '', '',
1257       ],
1258       'primary_key' => 'reconid',
1259       'unique' => [],
1260       'index' => [],
1261     },
1262
1263     'contact_class' => {
1264       'columns' => [
1265         'classnum',    'serial',   '',      '', '', '',
1266         'classname',   'varchar',  '', $char_d, '', '',
1267         'disabled',    'char', 'NULL',       1, '', '',
1268       ],
1269       'primary_key' => 'classnum',
1270       'unique' => [],
1271       'index' => [ ['disabled'] ],
1272     },
1273
1274     'contact' => {
1275       'columns' => [
1276         'contactnum', 'serial',     '',      '', '', '',
1277         'prospectnum',   'int', 'NULL',      '', '', '',
1278         'custnum',       'int', 'NULL',      '', '', '',
1279         'locationnum',   'int', 'NULL',      '', '', '', #not yet
1280         'classnum',      'int', 'NULL',      '', '', '',
1281 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1282         'last',      'varchar',     '', $char_d, '', '',
1283 #        'middle',    'varchar', 'NULL', $char_d, '', '',
1284         'first',     'varchar',     '', $char_d, '', '',
1285         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1286         'comment',   'varchar', 'NULL',     255, '', '',
1287         'selfservice_access',    'char', 'NULL',       1, '', '',
1288         '_password',          'varchar', 'NULL', $char_d, '', '',
1289         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1290         'disabled',              'char', 'NULL',       1, '', '',
1291       ],
1292       'primary_key' => 'contactnum',
1293       'unique'      => [],
1294       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1295                          [ 'last' ], [ 'first' ],
1296                        ],
1297     },
1298
1299     'contact_phone' => {
1300       'columns' => [
1301         'contactphonenum', 'serial',     '', '', '', '',
1302         'contactnum',         'int',     '', '', '', '',
1303         'phonetypenum',       'int',     '', '', '', '',
1304         'countrycode',    'varchar',     '',  3, '', '',
1305         'phonenum',       'varchar',     '', 14, '', '',
1306         'extension',      'varchar', 'NULL',  7, '', '',
1307         #?#'comment',        'varchar',     '', $char_d, '', '',
1308       ],
1309       'primary_key' => 'contactphonenum',
1310       'unique'      => [],
1311       'index'       => [],
1312     },
1313
1314     'phone_type' => {
1315       'columns' => [
1316         'phonetypenum',  'serial', '',      '', '', '',
1317         'typename',     'varchar', '', $char_d, '', '',
1318         'weight',           'int', '',      '', '', '',
1319       ],
1320       'primary_key' => 'phonetypenum',
1321       'unique'      => [ [ 'typename' ], ],
1322       'index'       => [],
1323     },
1324
1325     'contact_email' => {
1326       'columns' => [
1327         'contactemailnum', 'serial', '',      '', '', '',
1328         'contactnum',         'int', '',      '', '', '',
1329         'emailaddress',   'varchar', '', $char_d, '', '',
1330       ],
1331       'primary_key' => 'contactemailnum',
1332       #'unique'       => [ [ 'contactnum', 'emailaddress' ], ],
1333       'unique'       => [ [ 'emailaddress' ], ],
1334       'index'       => [],
1335     },
1336
1337     'prospect_main' => {
1338       'columns' => [
1339         'prospectnum',  'serial',     '',      '', '', '',
1340         'agentnum',        'int',     '',      '', '', '',
1341         'company',     'varchar', 'NULL', $char_d, '', '',
1342         'add_date',   @date_type,                  '', '',
1343         'disabled',       'char', 'NULL',       1, '', '',
1344         'custnum',         'int', 'NULL',      '', '', '',
1345         'refnum',          'int', 'NULL',      '', '', '',
1346       ],
1347       'primary_key' => 'prospectnum',
1348       'unique'      => [],
1349       'index'        => [ ['company'], ['agentnum'], ['disabled'], ['refnum'] ],
1350     },
1351
1352     'quotation' => {
1353       'columns' => [
1354         #regular fields
1355         'quotationnum',           'serial',     '', '',   '', '',
1356         'prospectnum',               'int', 'NULL', '',   '', '',
1357         'custnum',                   'int', 'NULL', '',   '', '',
1358         '_date',                @date_type,               '', '',
1359         'disabled',                 'char', 'NULL',  1,   '', '',
1360         'usernum',                   'int', 'NULL', '',   '', '',
1361         'close_date',           @date_type,               '', '',
1362         'confidence',                'int', 'NULL', '',   '', '',
1363         'quotation_description', 'varchar', 'NULL', '50', '', '',
1364         #'total',      @money_type,       '', '',
1365         #'quotation_term', 'varchar', 'NULL', $char_d, '', '',
1366       ],
1367       'primary_key' => 'quotationnum',
1368       'unique' => [],
1369       'index' => [ [ 'prospectnum' ], ['custnum'], ['disabled'], ],
1370     },
1371
1372     'quotation_pkg' => {
1373       'columns' => [
1374         'quotationpkgnum',   'serial',     '', '', '', '',
1375         'quotationnum',         'int', 'NULL', '', '', '', #shouldn't be null,
1376                                                            # but history...
1377         'pkgpart',              'int',     '', '', '', '',
1378         'locationnum',          'int', 'NULL', '', '', '',
1379         'start_date',      @date_type,             '', '',
1380         'contract_end',    @date_type,             '', '',
1381         'quantity',             'int', 'NULL', '', '', '',
1382         'waive_setup',         'char', 'NULL',  1, '', '',
1383         'unitsetup',     @money_typen,             '', '',
1384         'unitrecur',     @money_typen,             '', '',
1385       ],
1386       'primary_key' => 'quotationpkgnum',
1387       'unique' => [],
1388       'index' => [ ['pkgpart'], ],
1389     },
1390
1391     'quotation_pkg_detail' => {
1392       'columns' => [
1393         'detailnum', 'serial', '', '', '', '',
1394         'quotationpkgnum', 'int', '', '', '', '',
1395         'format',  'char', 'NULL', 1, '', '',       # not used for anything
1396         'detail',  'varchar', '', 255, '', '',
1397         'copy_on_order',        'char', 'NULL',  1, '', '', # 'Y' to copy when ordering
1398       ],
1399       'primary_key'  => 'detailnum',
1400       'unique'       => [],
1401       'index'        => [ [ 'quotationpkgnum' ] ],
1402       'foreign_keys' => [
1403                           { columns    => [ 'quotationpkgnum' ],
1404                             table      => 'quotation_pkg',
1405                             references => [ 'quotationpkgnum' ],
1406                           },
1407                         ],
1408     },
1409
1410     'quotation_pkg_discount' => {
1411       'columns' => [
1412         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1413         'quotationpkgnum',            'int', '', '', '', '',
1414         'discountnum',                'int', '', '', '', '',
1415         'setup_amount',        @money_typen,         '', '',
1416         'recur_amount',        @money_typen,         '', '',
1417         #'end_date',              @date_type,         '', '',
1418       ],
1419       'primary_key' => 'quotationpkgdiscountnum',
1420       'unique' => [],
1421       'index'  => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
1422     },
1423
1424     'quotation_pkg_tax' => {
1425       'columns' => [
1426         'quotationtaxnum',  'serial',     '',      '', '', '',
1427         'quotationpkgnum',     'int',     '',      '', '', '',
1428         'itemdesc',        'varchar',     '', $char_d, '', '',
1429         'taxnum',              'int',     '',      '', '', '',
1430         'taxtype',         'varchar',     '', $char_d, '', '',
1431         'setup_amount',    @money_type,                '', '',
1432         'recur_amount',    @money_type,                '', '',
1433       ],
1434       'primary_key' => 'quotationtaxnum',,
1435       'unique' => [],
1436       'index'  => [ [ 'quotationpkgnum' ] ],
1437     },
1438
1439     'cust_location' => { #'location' now that its prospects too, but...
1440       'columns' => [
1441         'locationnum',      'serial',     '',      '', '', '',
1442         'prospectnum',         'int', 'NULL',      '', '', '',
1443         'custnum',             'int', 'NULL',      '', '', '',
1444         'locationname',    'varchar', 'NULL', $char_d, '', '',
1445         'address1',        'varchar',     '', $char_d, '', '',
1446         'address2',        'varchar', 'NULL', $char_d, '', '',
1447         'city',            'varchar', 'NULL', $char_d, '', '',
1448         'county',          'varchar', 'NULL', $char_d, '', '',
1449         'state',           'varchar', 'NULL', $char_d, '', '',
1450         'zip',             'varchar', 'NULL',      10, '', '',
1451         'latitude',        'decimal', 'NULL',  '10,7', '', '',
1452         'longitude',       'decimal', 'NULL',  '10,7', '', '',
1453         'coord_auto',         'char', 'NULL',       1, '', '',
1454         'addr_clean',         'char', 'NULL',       1, '', '',
1455         'country',            'char',     '',       2, '', '',
1456         'geocode',         'varchar', 'NULL',      20, '', '',
1457         'district',        'varchar', 'NULL',      20, '', '',
1458         'censustract',     'varchar', 'NULL',      20, '', '',
1459         'censusyear',         'char', 'NULL',       4, '', '',
1460         'location_type',   'varchar', 'NULL',      20, '', '',
1461         'location_number', 'varchar', 'NULL',      20, '', '',
1462         'location_kind',      'char', 'NULL',       1, '', '',
1463         'disabled',           'char', 'NULL',       1, '', '',
1464       ],
1465       'primary_key' => 'locationnum',
1466       'unique'      => [],
1467       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1468                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1469                          [ 'city' ], [ 'district' ]
1470                        ],
1471     },
1472
1473     'cust_main_invoice' => {
1474       'columns' => [
1475         'destnum',  'serial',  '',     '', '', '',
1476         'custnum',  'int',  '',     '', '', '',
1477         'dest',     'varchar', '',  $char_d, '', '',
1478       ],
1479       'primary_key' => 'destnum',
1480       'unique' => [],
1481       'index' => [ ['custnum'], ],
1482     },
1483
1484     'cust_main_credit_limit' => {
1485       'columns' => [
1486         'creditlimitnum',   'serial', '', '', '', '',
1487         'custnum',             'int', '', '', '', '',
1488         '_date',          @date_type,         '', '',
1489         'amount',       @money_typen,         '', '',
1490         #'amount_currency', 'char', 'NULL',  3, '', '',
1491         'credit_limit', @money_typen,         '', '',
1492         #'credit_limit_currency', 'char', 'NULL',  3, '', '',
1493       ],
1494       'primary_key'  => 'creditlimitnum',
1495       'unique'       => [],
1496       'index'        => [ ['custnum'], ],
1497     },
1498
1499     'cust_main_note' => {
1500       'columns' => [
1501         'notenum',   'serial',    '',  '', '', '',
1502         'custnum',      'int',    '',  '', '', '',
1503         'classnum',     'int', 'NULL', '', '', '',
1504         '_date',          @date_type,      '', '',
1505         'otaker',   'varchar', 'NULL', 32, '', '',
1506         'usernum',      'int', 'NULL', '', '', '',
1507         'comments',    'text', 'NULL', '', '', '',
1508         'sticky',       'int',     '', '',  0, '',
1509       ],
1510       'primary_key' => 'notenum',
1511       'unique' => [],
1512       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1513     },
1514
1515     'cust_note_class' => {
1516       'columns' => [
1517         'classnum',    'serial',   '',      '', '', '',
1518         'classname',   'varchar',  '', $char_d, '', '',
1519         'disabled',    'char', 'NULL',       1, '', '',
1520       ],
1521       'primary_key' => 'classnum',
1522       'unique' => [],
1523       'index' => [ ['disabled'] ],
1524     },
1525
1526     'cust_category' => {
1527       'columns' => [
1528         'categorynum',   'serial',  '', '', '', '',
1529         'categoryname',  'varchar', '', $char_d, '', '',
1530         'weight',         'int', 'NULL',  '', '', '',
1531         'disabled',      'char', 'NULL',   1, '', '',
1532       ],
1533       'primary_key' => 'categorynum',
1534       'unique' => [],
1535       'index' => [ ['disabled'] ],
1536     },
1537
1538     'cust_class' => {
1539       'columns' => [
1540         'classnum',     'serial',     '',      '', '', '',
1541         'classname',   'varchar',     '', $char_d, '', '',
1542         'categorynum',     'int', 'NULL',      '', '', '',
1543         'tax',            'char', 'NULL',       1, '', '',
1544         'disabled',       'char', 'NULL',       1, '', '',
1545       ],
1546       'primary_key' => 'classnum',
1547       'unique' => [],
1548       'index' => [ ['disabled'] ],
1549     },
1550
1551     'cust_tag' => {
1552       'columns' => [
1553         'custtagnum', 'serial', '', '', '', '',
1554         'custnum',       'int', '', '', '', '',
1555         'tagnum',        'int', '', '', '', '',
1556       ],
1557       'primary_key' => 'custtagnum',
1558       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1559       'index'       => [ [ 'custnum' ] ],
1560     },
1561
1562     'part_tag' => {
1563       'columns' => [
1564         'tagnum',    'serial',     '',      '', '', '',
1565         'tagname',  'varchar',     '', $char_d, '', '',
1566         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1567         'tagcolor', 'varchar', 'NULL',       6, '', '',
1568         'by_default',  'char', 'NULL',       1, '', '',
1569         'disabled',    'char', 'NULL',       1, '', '',
1570       ],
1571       'primary_key' => 'tagnum',
1572       'unique'      => [], #[ [ 'tagname' ] ], #?
1573       'index'       => [ [ 'disabled' ] ],
1574     },
1575
1576     'cust_main_exemption' => {
1577       'columns' => [
1578         'exemptionnum',   'serial',     '',      '', '', '',
1579         'custnum',           'int',     '',      '', '', '',
1580         'taxname',       'varchar',     '', $char_d, '', '',
1581         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
1582         #start/end dates?  for reporting?
1583       ],
1584       'primary_key' => 'exemptionnum',
1585       'unique'      => [],
1586       'index'       => [ [ 'custnum' ] ],
1587     },
1588
1589     'cust_tax_adjustment' => {
1590       'columns' => [
1591         'adjustmentnum', 'serial',     '',      '', '', '',
1592         'custnum',          'int',     '',      '', '', '',
1593         'taxname',      'varchar',     '', $char_d, '', '',
1594         'amount',    @money_type,                   '', '',
1595         'comment',     'varchar',  'NULL', $char_d, '', '',
1596         'billpkgnum',       'int', 'NULL',      '', '', '',
1597         #more?  no cust_bill_pkg_tax_location?
1598       ],
1599       'primary_key' => 'adjustmentnum',
1600       'unique'      => [],
1601       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1602     },
1603
1604     'cust_main_county' => { #district+city+county+state+country are checked
1605                             #off the cust_main_county for validation and to
1606                             #provide a tax rate.
1607       'columns' => [
1608         'taxnum',   'serial',   '',    '', '', '',
1609         'district', 'varchar',  'NULL',    20, '', '',
1610         'city',     'varchar',  'NULL',    $char_d, '', '',
1611         'county',   'varchar',  'NULL',    $char_d, '', '',
1612         'state',    'varchar',  'NULL',    $char_d, '', '',
1613         'country',  'char',  '', 2, '', '',
1614         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1615         'exempt_amount', @money_type, '', '',
1616         'tax',      'real',  '',    '', '', '', #tax %
1617         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1618         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1619         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1620         'source',   'varchar', 'NULL', $char_d, '', '',
1621       ],
1622       'primary_key' => 'taxnum',
1623       'unique' => [],
1624   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1625       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ],
1626                    [ 'country' ],
1627                    [ 'taxclass' ],
1628                  ],
1629     },
1630
1631     'tax_rate'    => {
1632       'columns' => [
1633         'taxnum',       'serial',     '',      '', '', '',
1634         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1635         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1636         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1637         'taxclassnum', 'int',      '',      '', '', '',
1638         'effective_date', @date_type, '', '',
1639         'tax',        @taxrate_type,      '', '',        # tax %
1640         'excessrate', @taxrate_typen,     '', '',        # second tax %
1641         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1642         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1643         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1644         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1645         'unittype',    'int',  'NULL', '', '', '',      # for fee
1646         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1647         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1648         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1649         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1650         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1651         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1652         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1653         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1654         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1655         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1656         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1657         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1658         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1659         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1660         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1661         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1662       ],
1663       'primary_key' => 'taxnum',
1664       'unique' => [],
1665       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1666     },
1667
1668     'tax_rate_location' => {
1669       'columns' => [
1670         'taxratelocationnum', 'serial',  '',     '', '', '',
1671         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1672         'geocode',            'varchar', '',     20,      '', '',
1673         'city',               'varchar', 'NULL', $char_d, '', '',
1674         'county',             'varchar', 'NULL', $char_d, '', '',
1675         'state',              'char',    'NULL',       2, '', '',
1676         'disabled',           'char',    'NULL', 1, '', '',
1677       ],
1678       'primary_key' => 'taxratelocationnum',
1679       'unique' => [],
1680       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1681     },
1682
1683     'cust_tax_location' => {
1684       'columns' => [
1685         'custlocationnum', 'serial',  '',     '', '', '',
1686         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1687         'city',            'varchar', 'NULL', $char_d, '', '',
1688         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1689         'county',          'varchar', 'NULL', $char_d, '', '',
1690         'zip',             'char',    '',     5,  '', '',
1691         'state',           'char',    '',     2,  '', '',
1692         'plus4hi',         'char',    'NULL', 4,  '', '',
1693         'plus4lo',         'char',    'NULL', 4,  '', '',
1694         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1695         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1696         'geocode',         'varchar', '',    20,  '', '',
1697       ],
1698       'primary_key' => 'custlocationnum',
1699       'unique' => [],
1700       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1701     },
1702
1703     'tax_class' => {
1704       'columns' => [
1705         'taxclassnum',  'serial',  '',            '', '', '',
1706         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1707         'taxclass',     'varchar', '',       $char_d, '', '',
1708         'description',  'varchar', '',     2*$char_d, '', '',
1709       ],
1710       'primary_key' => 'taxclassnum',
1711       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1712       'index' => [],
1713     },
1714
1715     'cust_pay_pending' => {
1716       'columns' => [
1717         'paypendingnum','serial',      '',  '', '', '',
1718         'custnum',      'int',     'NULL',  '', '', '',
1719         'paid',         @money_type,            '', '',
1720         '_date',        @date_type,             '', '',
1721         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1722                                                         # be index into payby
1723                                                         # table eventually
1724         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1725         'paymask',      'varchar', 'NULL', $char_d, '', '',
1726         'paydate',      'varchar', 'NULL', 10, '', '',
1727         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1728         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1729         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1730
1731         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1732         'status',       'varchar',     '', $char_d, '', '',
1733         'session_id',   'varchar', 'NULL', 1024, '', '', # SHA-512-hex
1734         'statustext',   'text',    'NULL',  '', '', '',
1735         'gatewaynum',   'int',     'NULL',  '', '', '',
1736         #'cust_balance', @money_type,            '', '',
1737         'paynum',       'int',     'NULL',  '', '', '',
1738         'void_paynum',  'int',     'NULL',  '', '', '',
1739         'jobnum',    'bigint',     'NULL',  '', '', '',
1740         'invnum',       'int',     'NULL',  '', '', '',
1741         'manual',       'char',    'NULL',   1, '', '',
1742         'discount_term','int',     'NULL',  '', '', '',
1743       ],
1744       'primary_key' => 'paypendingnum',
1745       'unique'      => [ [ 'payunique' ] ],
1746       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1747     },
1748
1749     'cust_pay' => {
1750       'columns' => [
1751         'paynum',   'serial',    '',   '', '', '',
1752         'custnum',  'int',    '',   '', '', '',
1753         '_date',    @date_type, '', '',
1754         'paid',     @money_type, '', '',
1755         'otaker',   'varchar', 'NULL', 32, '', '',
1756         'usernum',   'int', 'NULL', '', '', '',
1757         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1758                                                  # index into payby table
1759                                                  # eventually
1760         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1761         'paycardtype',    'varchar', 'NULL',   $char_d, '', '',
1762         'paymask', 'varchar', 'NULL', $char_d, '', '',
1763         'paydate',  'varchar', 'NULL', 10, '', '',
1764         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1765         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1766         'closed',    'char', 'NULL', 1, '', '',
1767         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1768         'no_auto_apply',  'char', 'NULL',       1, '', '',
1769         # cash/check deposit info fields
1770         'bank',       'varchar', 'NULL', $char_d, '', '',
1771         'depositor',  'varchar', 'NULL', $char_d, '', '',
1772         'account',    'varchar', 'NULL', 20,      '', '',
1773         'teller',     'varchar', 'NULL', 20,      '', '',
1774
1775         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1776
1777         # credit card/EFT fields (formerly in paybatch)
1778         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1779         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1780         'auth',       'varchar','NULL',16, '', '', # CC auth number
1781         'order_number','varchar','NULL',256, '', '', # transaction number
1782       ],
1783       'primary_key' => 'paynum',
1784       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1785       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1786     },
1787
1788     'cust_pay_void' => {
1789       'columns' => [
1790         'paynum',    'int',    '',   '', '', '',
1791         'custnum',   'int',    '',   '', '', '',
1792         '_date',     @date_type, '', '',
1793         'paid',      @money_type, '', '',
1794         'otaker',   'varchar', 'NULL', 32, '', '',
1795         'usernum',   'int', 'NULL', '', '', '',
1796         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1797                                                   # index into payby table
1798                                                   # eventually
1799         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1800         'paycardtype',    'varchar', 'NULL',   $char_d, '', '',
1801         'paymask', 'varchar', 'NULL', $char_d, '', '',
1802         #'paydate' ?
1803         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1804         'closed',    'char', 'NULL', 1, '', '',
1805         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1806         # cash/check deposit info fields
1807         'bank',       'varchar', 'NULL', $char_d, '', '',
1808         'depositor',  'varchar', 'NULL', $char_d, '', '',
1809         'account',    'varchar', 'NULL', 20,      '', '',
1810         'teller',     'varchar', 'NULL', 20,      '', '',
1811         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1812
1813         # credit card/EFT fields (formerly in paybatch)
1814         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1815         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1816         'auth',       'varchar','NULL',16, '', '', # CC auth number
1817         'order_number', 'varchar','NULL',256, '', '', # transaction number
1818
1819         #void fields
1820         'void_date', @date_type, '', '',
1821         'reason',    'varchar',   'NULL', $char_d, '', '',
1822         'void_usernum',   'int', 'NULL', '', '', '',
1823       ],
1824       'primary_key' => 'paynum',
1825       'unique' => [],
1826       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1827     },
1828
1829     'cust_bill_pay' => {
1830       'columns' => [
1831         'billpaynum', 'serial',     '',   '', '', '',
1832         'invnum',  'int',     '',   '', '', '',
1833         'paynum',  'int',     '',   '', '', '',
1834         'amount',  @money_type, '', '',
1835         '_date',   @date_type, '', '',
1836         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1837       ],
1838       'primary_key' => 'billpaynum',
1839       'unique' => [],
1840       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1841     },
1842
1843     'cust_bill_pay_batch' => {
1844       'columns' => [
1845         'billpaynum', 'serial',     '',   '', '', '',
1846         'invnum',  'int',     '',   '', '', '',
1847         'paybatchnum',  'int',     '',   '', '', '',
1848         'amount',  @money_type, '', '',
1849         '_date',   @date_type, '', '',
1850       ],
1851       'primary_key' => 'billpaynum',
1852       'unique' => [],
1853       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1854     },
1855
1856     'cust_bill_pay_pkg' => {
1857       'columns' => [
1858         'billpaypkgnum', 'serial', '', '', '', '',
1859         'billpaynum',       'int', '', '', '', '',
1860         'billpkgnum',       'int', '', '', '', '',
1861         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1862         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1863         'amount',         @money_type,     '', '',
1864         'setuprecur',      'varchar', '', $char_d, '', '',
1865         'sdate',   @date_type, '', '',
1866         'edate',   @date_type, '', '',
1867       ],
1868       'primary_key' => 'billpaypkgnum',
1869       'unique'      => [],
1870       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1871     },
1872
1873     'pay_batch' => { #batches of payments to an external processor
1874       'columns' => [
1875         'batchnum', 'serial',     '', '', '', '',
1876         'agentnum',    'int', 'NULL', '', '', '',
1877         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1878         'status',     'char', 'NULL',  1, '', '',
1879         'download',       @date_type,     '', '',
1880         'upload',         @date_type,     '', '',
1881         'title',   'varchar', 'NULL',255, '', '',
1882         'processor_id',   'varchar', 'NULL',255, '', '',
1883       ],
1884       'primary_key' => 'batchnum',
1885       'unique' => [],
1886       'index' => [],
1887     },
1888
1889     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1890       'columns' => [
1891         'paybatchnum',   'serial',    '',   '', '', '',
1892         'batchnum',   'int',    '',   '', '', '',
1893         'invnum',   'int',    '',   '', '', '',
1894         'custnum',   'int',    '',   '', '', '',
1895         'last',     'varchar', '',     $char_d, '', '',
1896         'first',    'varchar', '',     $char_d, '', '',
1897         'address1', 'varchar', '',     $char_d, '', '',
1898         'address2', 'varchar', 'NULL', $char_d, '', '',
1899         'city',     'varchar', 'NULL',     $char_d, '', '',
1900         'state',    'varchar', 'NULL', $char_d, '', '',
1901         'zip',      'varchar', 'NULL', 10, '', '',
1902         'country',  'char', '',     2, '', '',
1903         #        'trancode', 'int', '', '', '', ''
1904         'payby',    'char',        '',       4, '', '',
1905         'payinfo',  'varchar', 'NULL',     512, '', '',
1906         #'exp',      @date_type, '', ''
1907         'exp',      'varchar', 'NULL',      11, '', '',
1908         'payname',  'varchar', 'NULL', $char_d, '', '',
1909         'amount',   @money_type, '', '',
1910         'status',   'varchar', 'NULL', $char_d, '', '',
1911         'error_message',   'varchar', 'NULL', $char_d, '', '',
1912       ],
1913       'primary_key' => 'paybatchnum',
1914       'unique' => [],
1915       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1916     },
1917
1918     'fcc477map' => {
1919       'columns' => [
1920         'formkey',   'varchar',     '', 255, '', '',
1921         'formvalue',    'text', 'NULL',  '', '', '',
1922       ],
1923       'primary_key' => 'formkey',
1924       'unique'      => [],
1925       'index'       => [],
1926     },
1927
1928     'cust_pkg' => {
1929       'columns' => [
1930         'pkgnum',           'serial',     '', '', '', '',
1931         'custnum',             'int',     '', '', '', '',
1932         'pkgpart',             'int',     '', '', '', '',
1933         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1934         'contactnum',          'int', 'NULL', '', '', '',
1935         'locationnum',         'int', 'NULL', '', '', '',
1936         'otaker',          'varchar', 'NULL', 32, '', '',
1937         'usernum',             'int', 'NULL', '', '', '',
1938         'salesnum',            'int', 'NULL', '', '', '',
1939         'order_date',     @date_type,             '', '',
1940         'start_date',     @date_type,             '', '',
1941         'setup',          @date_type,             '', '',
1942         'bill',           @date_type,             '', '',
1943         'last_bill',      @date_type,             '', '',
1944         'susp',           @date_type,             '', '',
1945         'adjourn',        @date_type,             '', '',
1946         'resume',         @date_type,             '', '',
1947         'cancel',         @date_type,             '', '',
1948         'uncancel',       @date_type,             '', '',
1949         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1950         'expire',         @date_type,             '', '',
1951         'contract_end',   @date_type,             '', '',
1952         'dundate',        @date_type,             '', '',
1953         'change_date',    @date_type,             '', '',
1954         'change_pkgnum',       'int', 'NULL', '', '', '',
1955         'change_pkgpart',      'int', 'NULL', '', '', '',
1956         'change_locationnum',  'int', 'NULL', '', '', '',
1957         'change_custnum',      'int', 'NULL', '', '', '',
1958         'main_pkgnum',         'int', 'NULL', '', '', '',
1959         'pkglinknum',          'int', 'NULL', '', '', '',
1960         'manual_flag',        'char', 'NULL',  1, '', '',
1961         'no_auto',            'char', 'NULL',  1, '', '',
1962         'quantity',            'int', 'NULL', '', '', '',
1963         'agent_pkgid',     'varchar', 'NULL', $char_d, '', '',
1964         'waive_setup',        'char', 'NULL',  1, '', '',
1965         'recur_show_zero',    'char', 'NULL',  1, '', '',
1966         'setup_show_zero',    'char', 'NULL',  1, '', '',
1967         'change_to_pkgnum',    'int', 'NULL', '', '', '',
1968         'separate_bill',      'char', 'NULL',  1, '', '',
1969       ],
1970       'primary_key' => 'pkgnum',
1971       'unique' => [],
1972       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1973                    [ 'usernum' ], [ 'agent_pkgid' ],
1974                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1975                    ['last_bill'], ['susp'], ['adjourn'], ['resume'],
1976                    ['cancel'], ['expire'], ['contract_end'],
1977                    ['change_date'],
1978                    ['no_auto'],
1979                    #['contactnum'],
1980                    ['salesnum'],
1981                    #['uncancel_pkgnum'],
1982                    #['change_pkgnum'], ['change_locationnum'],
1983                    #['change_custnum'],
1984                    ['main_pkgnum'],
1985                    #['pkglinknum'], ['change_to_pkgnum'],
1986                  ],
1987     },
1988
1989     'cust_pkg_option' => {
1990       'columns' => [
1991         'optionnum', 'serial', '', '', '', '',
1992         'pkgnum', 'int', '', '', '', '',
1993         'optionname', 'varchar', '', $char_d, '', '',
1994         'optionvalue', 'text', 'NULL', '', '', '',
1995       ],
1996       'primary_key' => 'optionnum',
1997       'unique'      => [],
1998       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1999     },
2000
2001     'cust_pkg_detail' => {
2002       'columns' => [
2003         'pkgdetailnum', 'serial', '',        '', '', '',
2004         'pkgnum',          'int', '',        '', '', '',
2005         'detail',      'varchar', '', 2*$char_d, '', '',
2006         'detailtype',     'char', '',         1, '', '', #"I"nvoice or "C"omment
2007         'weight',          'int', '',        '', '', '',
2008       ],
2009       'primary_key' => 'pkgdetailnum',
2010       'unique' => [],
2011       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
2012     },
2013
2014     'cust_pkg_reason' => {
2015       'columns' => [
2016         'num',      'serial',    '',   '', '', '',
2017         'pkgnum',   'int',    '',   '', '', '',
2018         'reasonnum','int',    '',   '', '', '',
2019         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
2020         'otaker',   'varchar', 'NULL', 32, '', '',
2021         'usernum',   'int', 'NULL', '', '', '',
2022         'date',     @date_type, '', '',
2023       ],
2024       'primary_key' => 'num',
2025       'unique' => [],
2026       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
2027     },
2028
2029     'cust_pkg_reason_fee' => {
2030       'columns' => [
2031         'pkgreasonfeenum', 'serial', '', '', '', '',
2032         'pkgreasonnum',       'int', '', '', '', '',
2033         'billpkgnum',         'int', 'NULL', '', '', '',
2034         'feepart',            'int', '', '', '', '',
2035         'nextbill',          'char', 'NULL',  1, '', '',
2036       ],
2037       'primary_key'  => 'pkgreasonfeenum',
2038       'unique' => [ [ 'billpkgnum' ], [ 'pkgreasonnum' ] ], # one-to-one link
2039       'index'  => [ [ 'feepart' ] ],
2040     },
2041
2042     'cust_pkg_discount' => {
2043       'columns' => [
2044         'pkgdiscountnum', 'serial', '',        '', '', '',
2045         'pkgnum',            'int', '',        '', '', '',
2046         'discountnum',       'int', '',        '', '', '',
2047         'months_used',   'decimal', 'NULL', '7,4', '', '',
2048         'end_date',     @date_type,                '', '',
2049         'otaker',        'varchar', 'NULL',    32, '', '',
2050         'usernum',           'int', 'NULL',    '', '', '',
2051         'disabled',         'char', 'NULL',     1, '', '',
2052       ],
2053       'primary_key' => 'pkgdiscountnum',
2054       'unique' => [],
2055       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
2056     },
2057
2058     'cust_pkg_usage' => {
2059       'columns' => [
2060         'pkgusagenum', 'serial', '', '', '', '',
2061         'pkgnum',         'int', '', '', '', '',
2062         'minutes',        'double precision', '', '', '', '',
2063         'pkgusagepart',   'int', '', '', '', '',
2064       ],
2065       'primary_key' => 'pkgusagenum',
2066       'unique' => [],
2067       'index'  => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
2068     },
2069
2070     'cdr_cust_pkg_usage' => {
2071       'columns' => [
2072         'cdrusagenum', 'bigserial', '', '', '', '',
2073         'acctid',      'bigint',    '', '', '', '',
2074         'pkgusagenum', 'int',       '', '', '', '',
2075         'minutes',     'double precision',       '', '', '', '',
2076       ],
2077       'primary_key' => 'cdrusagenum',
2078       'unique' => [],
2079       'index'  => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
2080     },
2081
2082     'cust_bill_pkg_discount' => {
2083       'columns' => [
2084         'billpkgdiscountnum', 'serial',        '', '', '', '',
2085         'billpkgnum',            'int',        '', '', '', '',
2086         'pkgdiscountnum',        'int',        '', '', '', '',
2087         'amount',          @money_type,                '', '',
2088         'months',            'decimal', 'NULL', '7,4', '', '',
2089       ],
2090       'primary_key' => 'billpkgdiscountnum',
2091       'unique' => [],
2092       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2093     },
2094
2095     'cust_bill_pkg_discount_void' => {
2096       'columns' => [
2097         'billpkgdiscountnum',    'int',        '', '', '', '',
2098         'billpkgnum',            'int',        '', '', '', '',
2099         'pkgdiscountnum',        'int',        '', '', '', '',
2100         'amount',          @money_type,                '', '',
2101         'months',            'decimal', 'NULL', '7,4', '', '',
2102       ],
2103       'primary_key' => 'billpkgdiscountnum',
2104       'unique' => [],
2105       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2106     },
2107
2108     'discount' => {
2109       'columns' => [
2110         'discountnum', 'serial',     '',      '', '', '',
2111         #'agentnum',       'int', 'NULL',      '', '', '',
2112         'classnum',       'int', 'NULL',      '', '', '',
2113         'name',       'varchar', 'NULL', $char_d, '', '',
2114         'amount',   @money_type,                  '', '',
2115         'percent',    'decimal',     '',   '7,4', '', '',
2116         'months',     'decimal', 'NULL',   '7,4', '', '',
2117         'disabled',      'char', 'NULL',       1, '', '',
2118         'setup',         'char', 'NULL',       1, '', '',
2119         #'linked',        'char', 'NULL',       1, '', '',
2120       ],
2121       'primary_key' => 'discountnum',
2122       'unique' => [],
2123       'index'  => [], # [ 'agentnum' ], ],
2124     },
2125
2126     'discount_class' => {
2127       'columns' => [
2128         'classnum',    'serial',   '',      '', '', '',
2129         'classname',   'varchar',  '', $char_d, '', '',
2130         #'categorynum', 'int',  'NULL',      '', '', '',
2131         'disabled',    'char', 'NULL',       1, '', '',
2132       ],
2133       'primary_key' => 'classnum',
2134       'unique' => [],
2135       'index' => [ ['disabled'] ],
2136     },
2137
2138     'cust_refund' => {
2139       'columns' => [
2140         'refundnum',    'serial',    '',   '', '', '',
2141         'custnum',  'int',    '',   '', '', '',
2142         '_date',        @date_type, '', '',
2143         'refund',       @money_type, '', '',
2144         'otaker',       'varchar',   'NULL',   32, '', '',
2145         'usernum',   'int', 'NULL', '', '', '',
2146         'reason',       'varchar',   'NULL',   $char_d, '', '',
2147         'reasonnum',   'int', 'NULL', '', '', '',
2148         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
2149                                                      # be index into payby
2150                                                      # table eventually
2151         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
2152         'paycardtype',  'varchar', 'NULL',   $char_d, '', '',
2153         'paymask', 'varchar', 'NULL', $char_d, '', '',
2154         'paybatch',     'varchar',   'NULL', $char_d, '', '',
2155         'closed',    'char', 'NULL', 1, '', '',
2156         'source_paynum', 'int', 'NULL', '', '', '', # link to cust_payby, to prevent unapply of gateway-generated refunds
2157         # credit card/EFT fields (formerly in paybatch)
2158         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
2159         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
2160         'auth',       'varchar','NULL',16, '', '', # CC auth number
2161         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
2162       ],
2163       'primary_key' => 'refundnum',
2164       'unique' => [],
2165       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
2166     },
2167
2168     'cust_credit_refund' => {
2169       'columns' => [
2170         'creditrefundnum', 'serial',     '',   '', '', '',
2171         'crednum',  'int',     '',   '', '', '',
2172         'refundnum',  'int',     '',   '', '', '',
2173         'amount',  @money_type, '', '',
2174         '_date',   @date_type, '', '',
2175       ],
2176       'primary_key' => 'creditrefundnum',
2177       'unique' => [],
2178       'index' => [ ['crednum'], ['refundnum'] ],
2179     },
2180
2181
2182     'cust_svc' => {
2183       'columns' => [
2184         'svcnum',      'serial',     '', '', '', '',
2185         'pkgnum',         'int', 'NULL', '', '', '',
2186         'svcpart',        'int',     '', '', '', '',
2187         'agent_svcid',    'int', 'NULL', '', '', '',
2188         'overlimit',           @date_type,   '', '',
2189       ],
2190       'primary_key' => 'svcnum',
2191       'unique' => [],
2192       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
2193     },
2194
2195     'cust_svc_option' => {
2196       'columns' => [
2197         'optionnum',   'serial', '', '', '', '',
2198         'svcnum',      'int', '', '', '', '',
2199         'optionname',  'varchar', '', $char_d, '', '',
2200         'optionvalue', 'text', 'NULL', '', '', '',
2201       ],
2202       'primary_key' => 'optionnum',
2203       'unique'      => [],
2204       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
2205     },
2206
2207     'svc_export_machine' => {
2208       'columns' => [
2209         'svcexportmachinenum', 'serial', '', '', '', '',
2210         'svcnum',                 'int', '', '', '', '',
2211         'exportnum',              'int', '', '', '', '',
2212         'machinenum',             'int', '', '', '', '',
2213       ],
2214       'primary_key' => 'svcexportmachinenum',
2215       'unique'      => [ ['svcnum', 'exportnum'] ],
2216       'index'       => [],
2217     },
2218
2219     'part_export_machine' => {
2220       'columns' => [
2221         'machinenum', 'serial', '', '', '', '',
2222         'exportnum',     'int', '', '', '', '',
2223         'machine',    'varchar', 'NULL', $char_d, '', '',
2224         'disabled',      'char', 'NULL',       1, '', '',
2225       ],
2226       'primary_key' => 'machinenum',
2227       'unique'      => [ [ 'exportnum', 'machine' ] ],
2228       'index'       => [ [ 'exportnum' ] ],
2229     },
2230
2231    'part_pkg' => {
2232       'columns' => [
2233         'pkgpart',       'serial',    '',   '', '', '',
2234         'pkgpartbatch',  'varchar', 'NULL', $char_d, '', '',
2235         'pkg',           'varchar',   '',   $char_d, '', '',
2236         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
2237         'promo_code',    'varchar', 'NULL', $char_d, '', '',
2238         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
2239         'setuptax',      'char', 'NULL', 1, '', '',
2240         'recurtax',      'char', 'NULL', 1, '', '',
2241         'plan',          'varchar', 'NULL', $char_d, '', '',
2242         'disabled',      'char', 'NULL', 1, '', '',
2243         'custom',        'char', 'NULL', 1, '', '',
2244         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2245         'classnum',      'int',     'NULL', '', '', '',
2246         'addon_classnum','int',     'NULL', '', '', '',
2247         'taxproductnum', 'int',     'NULL', '', '', '',
2248         'setup_cost',    @money_typen,          '', '',
2249         'recur_cost',    @money_typen,          '', '',
2250         'pay_weight',    'real',    'NULL', '', '', '',
2251         'credit_weight', 'real',    'NULL', '', '', '',
2252         'agentnum',      'int',     'NULL', '', '', '',
2253         'fcc_ds0s',      'int',     'NULL', '', '', '',
2254         'fcc_voip_class','char',    'NULL',  1, '', '',
2255         'no_auto',          'char', 'NULL',  1, '', '',
2256         'recur_show_zero',  'char', 'NULL',  1, '', '',
2257         'setup_show_zero',  'char', 'NULL',  1, '', '',
2258         'successor',     'int',     'NULL', '', '', '',
2259         'family_pkgpart','int',     'NULL', '', '', '',
2260         'delay_start',   'int',     'NULL', '', '', '',
2261         'start_on_hold', 'char',    'NULL',  1, '', '',
2262         'agent_pkgpartid', 'varchar', 'NULL', 20, '', '',
2263       ],
2264       'primary_key' => 'pkgpart',
2265       'unique' => [],
2266       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
2267                    [ 'agentnum' ], ['no_auto'], ['agent_pkgpartid'],
2268                  ],
2269     },
2270
2271     'part_pkg_msgcat' => {
2272       'columns' => [
2273         'pkgpartmsgnum',  'serial',     '',        '', '', '',
2274         'pkgpart',           'int',     '',        '', '', '',
2275         'locale',        'varchar',     '',        16, '', '',
2276         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
2277         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2278       ],
2279       'primary_key' => 'pkgpartmsgnum',
2280       'unique'      => [ [ 'pkgpart', 'locale' ] ],
2281       'index'       => [],
2282     },
2283
2284     'part_fee' => {
2285       'columns' => [
2286         'feepart',       'serial',    '',   '', '', '',
2287         'itemdesc',      'varchar',   '',   $char_d,   '', '',
2288         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
2289         'disabled',      'char',    'NULL',  1, '', '',
2290         'classnum',      'int',     'NULL', '', '', '',
2291         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2292         'taxproductnum', 'int',     'NULL', '', '', '',
2293         'pay_weight',    'real',    'NULL', '', '', '',
2294         'credit_weight', 'real',    'NULL', '', '', '',
2295         'agentnum',      'int',     'NULL', '', '', '',
2296         'amount',   @money_type,                '', '',
2297         'percent',     'decimal',    '', '7,4', '', '',
2298         'basis',         'varchar',  '',    16, '', '',
2299         'minimum',    @money_typen,             '', '',
2300         'maximum',    @money_typen,             '', '',
2301         'limit_credit',  'char',    'NULL',  1, '', '',
2302         'setuprecur',    'char',     '',     5, '', '',
2303         'taxable',       'char',    'NULL',  1, '', '',
2304       ],
2305       'primary_key'  => 'feepart',
2306       'unique'       => [],
2307       'index'        => [ [ 'disabled' ], [ 'classnum' ], [ 'agentnum' ]
2308                         ],
2309     },
2310
2311     'part_fee_msgcat' => {
2312       'columns' => [
2313         'feepartmsgnum',  'serial',     '',        '', '', '',
2314         'feepart',           'int',     '',        '', '', '',
2315         'locale',        'varchar',     '',        16, '', '',
2316         'itemdesc',      'varchar',     '',   $char_d, '', '', #longer/no limit?
2317         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2318       ],
2319       'primary_key'  => 'feepartmsgnum',
2320       'unique'       => [ [ 'feepart', 'locale' ] ],
2321       'index'        => [],
2322     },
2323
2324     'part_fee_usage' => {
2325       'columns' => [
2326         'feepartusagenum','serial',     '',        '', '', '',
2327         'feepart',           'int',     '',        '', '', '',
2328         'classnum',          'int',     '',        '', '', '',
2329         'amount',   @money_type,                '', '',
2330         'percent',     'decimal',    '', '7,4', '', '',
2331       ],
2332       'primary_key'  => 'feepartusagenum',
2333       'unique'       => [ [ 'feepart', 'classnum' ] ],
2334       'index'        => [],
2335     },
2336
2337     'part_pkg_link' => {
2338       'columns' => [
2339         'pkglinknum',  'serial',   '',      '', '', '',
2340         'src_pkgpart', 'int',      '',      '', '', '',
2341         'dst_pkgpart', 'int',      '',      '', '', '',
2342         'link_type',   'varchar',  '', $char_d, '', '',
2343         'hidden',      'char', 'NULL',       1, '', '',
2344       ],
2345       'primary_key' => 'pkglinknum',
2346       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
2347       'index'  => [ [ 'src_pkgpart' ] ],
2348     },
2349     # XXX somewhat borked unique: we don't really want a hidden and unhidden
2350     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
2351
2352     'part_pkg_discount' => {
2353       'columns' => [
2354         'pkgdiscountnum', 'serial',   '',      '', '', '',
2355         'pkgpart',        'int',      '',      '', '', '',
2356         'discountnum',    'int',      '',      '', '', '',
2357       ],
2358       'primary_key' => 'pkgdiscountnum',
2359       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
2360       'index'  => [],
2361     },
2362
2363     'part_pkg_taxclass' => {
2364       'columns' => [
2365         'taxclassnum',  'serial', '',       '', '', '',
2366         'taxclass',     'varchar', '', $char_d, '', '',
2367         'disabled', 'char',   'NULL',         1, '', '',
2368       ],
2369       'primary_key' => 'taxclassnum',
2370       'unique'      => [ [ 'taxclass' ] ],
2371       'index'       => [ [ 'disabled' ] ],
2372     },
2373
2374     'part_pkg_taxproduct' => {
2375       'columns' => [
2376         'taxproductnum', 'serial',      '',        '', '', '',
2377         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
2378         'taxproduct',    'varchar',     '',   $char_d, '', '',
2379         'description',   'varchar',     '', 3*$char_d, '', '',
2380       ],
2381       'primary_key' => 'taxproductnum',
2382       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
2383       'index'       => [],
2384     },
2385
2386     'part_pkg_taxrate' => {
2387       'columns' => [
2388         'pkgtaxratenum', 'serial',  '',     '',      '', '',
2389         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
2390         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
2391         'taxproductnum', 'int',  '',     '',       '', '',
2392         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
2393         'county',           'varchar', 'NULL', $char_d, '', '',
2394         'state',            'varchar', 'NULL', $char_d, '', '',
2395         'local',            'varchar', 'NULL', $char_d, '', '',
2396         'country',          'char',    'NULL', 2,       '', '',
2397         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
2398         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
2399         'taxclassnum',      'int',     'NULL', '',      '', '',
2400         'effdate',          @date_type, '', '',
2401         'taxable',          'char',    'NULL', 1,       '', '',
2402       ],
2403       'primary_key' => 'pkgtaxratenum',
2404       'unique' => [],
2405       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
2406     },
2407
2408     'part_pkg_taxoverride' => {
2409       'columns' => [
2410         'taxoverridenum', 'serial', '', '', '', '',
2411         'pkgpart',           'int', '', '', '', '',
2412         'taxclassnum',       'int', '', '', '', '',
2413         'usage_class',    'varchar', 'NULL', $char_d, '', '',
2414       ],
2415       'primary_key' => 'taxoverridenum',
2416       'unique' => [],
2417       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
2418     },
2419
2420 #    'part_title' => {
2421 #      'columns' => [
2422 #        'titlenum',   'int',    '',   '',
2423 #        'title',      'varchar',   '',   $char_d,
2424 #      ],
2425 #      'primary_key' => 'titlenum',
2426 #      'unique' => [ [] ],
2427 #      'index' => [ [] ],
2428 #    },
2429
2430     'pkg_svc' => {
2431       'columns' => [
2432         'pkgsvcnum',  'serial', '',  '', '', '',
2433         'pkgpart',    'int',    '',   '', '', '',
2434         'svcpart',    'int',    '',   '', '', '',
2435         'quantity',   'int',    '',   '', '', '',
2436         'primary_svc','char', 'NULL',  1, '', '',
2437         'hidden',     'char', 'NULL',  1, '', '',
2438         'provision_hold', 'char', 'NULL', 1, '', '',
2439       ],
2440       'primary_key' => 'pkgsvcnum',
2441       'unique' => [ ['pkgpart', 'svcpart'] ],
2442       'index' => [ ['pkgpart'], ['quantity'] ],
2443     },
2444
2445     'part_referral' => {
2446       'columns' => [
2447         'refnum',   'serial',     '',        '', '', '',
2448         'referral', 'varchar',    '',   $char_d, '', '',
2449         'disabled', 'char',   'NULL',         1, '', '',
2450         'agentnum', 'int',    'NULL',        '', '', '',
2451         'title',   'varchar', 'NULL',   $char_d, '', '',
2452       ],
2453       'primary_key'  => 'refnum',
2454       'unique'       => [ ['agentnum', 'title'] ],
2455       'index'        => [ ['disabled'], ['agentnum'], ],
2456     },
2457
2458     'part_svc' => {
2459       'columns' => [
2460         'svcpart',             'serial',     '',        '', '', '',
2461         'svc',                'varchar',     '',   $char_d, '', '',
2462         'svcdb',              'varchar',     '',   $char_d, '', '',
2463         'disabled',              'char', 'NULL',         1, '', '',
2464         'preserve',              'char', 'NULL',         1, '', '',
2465         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
2466         'classnum',               'int', 'NULL',        '', '', '',
2467         'restrict_edit_password','char', 'NULL',         1, '', '',
2468         'has_router',            'char', 'NULL',         1, '', '',
2469 ],
2470       'primary_key' => 'svcpart',
2471       'unique' => [],
2472       'index' => [ [ 'disabled' ] ],
2473     },
2474
2475     'part_svc_column' => {
2476       'columns' => [
2477         'columnnum',   'serial',      '',      '', '', '',
2478         'svcpart',     'int',         '',      '', '', '',
2479         'columnname',  'varchar',     '',      64, '', '',
2480         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
2481         'columnvalue', 'varchar', 'NULL',     512, '', '',
2482         'columnflag',  'char',    'NULL',       1, '', '',
2483         'required',    'char',    'NULL',       1, '', '',
2484       ],
2485       'primary_key' => 'columnnum',
2486       'unique' => [ [ 'svcpart', 'columnname' ] ],
2487       'index' => [ [ 'svcpart' ] ],
2488     },
2489
2490     'part_svc_class' => {
2491       'columns' => [
2492         'classnum',    'serial',   '',      '', '', '',
2493         'classname',   'varchar',  '', $char_d, '', '',
2494         'disabled',    'char', 'NULL',       1, '', '',
2495       ],
2496       'primary_key' => 'classnum',
2497       'unique' => [],
2498       'index' => [ ['disabled'] ],
2499     },
2500
2501     'part_svc_msgcat' => {
2502       'columns' => [
2503         'svcpartmsgnum',  'serial',     '',        '', '', '',
2504         'svcpart',           'int',     '',        '', '', '',
2505         'locale',        'varchar',     '',        16, '', '',
2506         'svc',           'varchar',     '',   $char_d, '', '',
2507       ],
2508       'primary_key'  => 'svcpartmsgnum',
2509       'unique'       => [ [ 'svcpart', 'locale' ] ],
2510       'index'        => [],
2511       'foreign_keys' => [
2512                           { columns    => [ 'svcpart' ],
2513                             table      => 'part_svc',
2514                           },
2515                         ],
2516     },
2517
2518     #(this should be renamed to part_pop)
2519     'svc_acct_pop' => {
2520       'columns' => [
2521         'popnum',    'serial',    '',   '', '', '',
2522         'city',      'varchar',   '',   $char_d, '', '',
2523         'state',     'varchar',   '',   $char_d, '', '',
2524         'ac',        'char',   '',   3, '', '',
2525         'exch',      'char',   '',   3, '', '',
2526         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
2527       ],
2528       'primary_key' => 'popnum',
2529       'unique' => [],
2530       'index' => [ [ 'state' ] ],
2531     },
2532
2533     'part_pop_local' => {
2534       'columns' => [
2535         'localnum',  'serial',     '',     '', '', '',
2536         'popnum',    'int',     '',     '', '', '',
2537         'city',      'varchar', 'NULL', $char_d, '', '',
2538         'state',     'char',    'NULL', 2, '', '',
2539         'npa',       'char',    '',     3, '', '',
2540         'nxx',       'char',    '',     3, '', '',
2541       ],
2542       'primary_key' => 'localnum',
2543       'unique' => [],
2544       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
2545     },
2546
2547     'qual' => {
2548       'columns' => [
2549         'qualnum',  'serial',     '',     '', '', '',
2550         'custnum',    'int',     'NULL',     '', '', '',
2551         'prospectnum',    'int',     'NULL',     '', '', '',
2552         'locationnum',    'int',     'NULL',     '', '', '',
2553         'phonenum',     'varchar', 'NULL',       24, '', '',
2554         'exportnum',      'int', 'NULL', '', '', '',
2555         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
2556         'status',      'char', '', 1, '', '',
2557       ],
2558       'primary_key' => 'qualnum',
2559       'unique' => [],
2560       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
2561                     ['phonenum'], ['vendor_qual_id'] ],
2562     },
2563
2564     'qual_option' => {
2565       'columns' => [
2566         'optionnum', 'serial', '', '', '', '',
2567         'qualnum',  'int',     '',     '', '', '',
2568         'optionname', 'varchar', '', $char_d, '', '',
2569         'optionvalue', 'text', 'NULL', '', '', '',
2570       ],
2571       'primary_key' => 'optionnum',
2572       'unique' => [],
2573       'index' => [],
2574     },
2575
2576     'svc_acct' => {
2577       'columns' => [
2578         'svcnum',    'int',    '',   '', '', '',
2579         'username',  'varchar',   '',   $username_len, '', '',
2580         '_password', 'varchar',   'NULL',  512, '', '',
2581         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
2582         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
2583         'popnum',    'int',    'NULL',   '', '', '',
2584         'sectornum', 'int', 'NULL',      '', '', '',
2585         'uid',       'int', 'NULL',   '', '', '',
2586         'gid',       'int', 'NULL',   '', '', '',
2587         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
2588         'dir',       'varchar',   'NULL',   $char_d, '', '',
2589         'shell',     'varchar',   'NULL',   $char_d, '', '',
2590         'quota',     'varchar',   'NULL',   $char_d, '', '',
2591         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
2592         # IP address mgmt
2593         'routernum', 'int', 'NULL',      '', '', '',
2594         'blocknum',  'int', 'NULL',      '', '', '',
2595         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
2596         'seconds_threshold',   'int', 'NULL',   '', '', '',
2597         'upbytes',   'bigint', 'NULL',   '', '', '',
2598         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
2599         'downbytes', 'bigint', 'NULL',   '', '', '',
2600         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
2601         'totalbytes','bigint', 'NULL',   '', '', '',
2602         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
2603         'domsvc',    'int',     '', '', '', '',
2604         'pbxsvc',    'int', 'NULL', '', '', '',
2605         'last_login',  @date_type, '', '',
2606         'last_logout', @date_type, '', '',
2607         #cardfortress field(s)
2608         'cf_privatekey',      'text', 'NULL',      '', '', '',
2609         #communigate pro fields (quota = MaxAccountSize)
2610         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
2611         #settings
2612         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
2613         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
2614         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
2615         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
2616         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
2617         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
2618         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
2619         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
2620         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
2621         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
2622         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
2623         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
2624         #XXX mailing lists
2625         #preferences
2626         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
2627         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
2628         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
2629         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
2630         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
2631         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
2632         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
2633         #mail
2634         #XXX RPOP settings
2635         #
2636       ],
2637       'primary_key' => 'svcnum',
2638       #'unique' => [ [ 'username', 'domsvc' ] ],
2639       'unique' => [],
2640       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
2641     },
2642
2643     'acct_rt_transaction' => {
2644       'columns' => [
2645         'svcrtid',   'int',    '',   '', '', '',
2646         'svcnum',    'int',    '',   '', '', '',
2647         'transaction_id',       'int', '',   '', '', '',
2648         '_date',   @date_type, '', '',
2649         'seconds',   'int', '',   '', '', '', #uhhhh
2650         'support',   'int', '',   '', '', '',
2651       ],
2652       'primary_key' => 'svcrtid',
2653       'unique' => [],
2654       'index' => [ ['svcnum', 'transaction_id'] ],
2655     },
2656
2657     #'svc_charge' => {
2658     #  'columns' => [
2659     #    'svcnum',    'int',    '',   '',
2660     #    'amount',    @money_type,
2661     #  ],
2662     #  'primary_key' => 'svcnum',
2663     #  'unique' => [ [] ],
2664     #  'index' => [ [] ],
2665     #},
2666
2667     'svc_domain' => {
2668       'columns' => [
2669         'svcnum',           'int',    '',        '', '', '',
2670         'domain',       'varchar',    '',   $char_d, '', '',
2671         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2672         'catchall',         'int', 'NULL',       '', '', '',
2673         'parent_svcnum',    'int', 'NULL',       '', '', '',
2674         'quota',        'varchar', 'NULL',  $char_d, '', '',
2675
2676         #registration info
2677         'registrarnum',     'int', 'NULL',       '', '', '',
2678         'registrarkey', 'varchar', 'NULL',      512, '', '',
2679         'setup_date',      @date_type, '', '',
2680         'renewal_interval', 'int', 'NULL',       '', '', '',
2681         'expiration_date', @date_type, '', '',
2682
2683         #some weird shit australia-specific shit?  yuck.. seems totally unused
2684         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2685         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2686
2687         #communigate pro fields (quota = MaxAccountSize)
2688         'max_accounts',     'int', 'NULL',       '', '', '',
2689         'trailer',         'text', 'NULL',       '', '', '',
2690         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2691         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2692         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2693
2694         #(account default) settings
2695         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
2696         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
2697         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2698         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2699         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2700         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2701         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2702         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2703         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
2704         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
2705         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
2706         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2707
2708         #(account default) preferences
2709         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2710         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2711         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2712         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2713         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2714         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2715         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2716       ],
2717       'primary_key' => 'svcnum',
2718       'unique' => [ ],
2719       'index' => [ ['domain'] ],
2720     },
2721
2722     'svc_dsl' => {
2723       'columns' => [
2724         'svcnum',                    'int',    '',        '', '', '',
2725         'pushed',                    'int', 'NULL',       '', '', '',
2726         'desired_due_date',          'int', 'NULL',       '', '', '',
2727         'due_date',                  'int', 'NULL',       '', '', '',
2728         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2729         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2730         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2731         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2732         'first',                 'varchar', 'NULL', $char_d,  '', '',
2733         'last',                  'varchar', 'NULL', $char_d,  '', '',
2734         'company',               'varchar', 'NULL', $char_d,  '', '',
2735         'phonenum',              'varchar', 'NULL',      24, '', '',
2736         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2737         'loop_type',                'char', 'NULL',       1, '', '',
2738         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2739         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2740         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2741         'vpi',                       'int', 'NULL',      '', '', '',
2742         'vci',                       'int', 'NULL',      '', '', '',
2743         'isp_chg',                  'char', 'NULL',       1, '', '',
2744         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2745         'username',              'varchar', 'NULL', $char_d, '', '',
2746         'password',              'varchar', 'NULL', $char_d, '', '',
2747         'staticips',                'text', 'NULL',      '', '', '',
2748         'monitored',                'char', 'NULL',       1, '', '',
2749         'last_pull',                 'int', 'NULL',      '', '', '',
2750       ],
2751       'primary_key' => 'svcnum',
2752       'unique' => [ ],
2753       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2754     },
2755
2756     'dsl_device' => {
2757       'columns' => [
2758         'devicenum', 'serial',     '', '', '', '',
2759         #part_device?  or our own part_dsl_device?
2760         #'devicepart',   'int',     '', '', '', '',
2761         'svcnum',       'int',     '', '', '', '',
2762         'mac_addr', 'varchar',     '', 12, '', '',
2763       ],
2764       'primary_key' => 'devicenum',
2765       'unique' => [ [ 'mac_addr' ], ],
2766       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2767     },
2768
2769     'dsl_note' => {
2770       'columns' => [
2771         'notenum',           'serial',    '',        '', '', '',
2772         'svcnum',     'int', '',       '', '', '',
2773         'author',     'varchar', 'NULL', $char_d,  '', '',
2774         'priority',   'char', 'NULL',       1,  '', '',
2775         '_date',     'int', 'NULL',       '', '', '',
2776         'note',     'text', '',       '', '', '',
2777       ],
2778       'primary_key' => 'notenum',
2779       'unique' => [ ],
2780       'index' => [ ['svcnum'] ],
2781     },
2782
2783     'svc_dish' => {
2784       'columns' => [
2785         'svcnum',   'int',     '',     '', '', '',
2786         'acctnum',  'varchar', '',     16, '', '',
2787         'installdate', @date_type,         '', '',
2788         'note',     'text',    'NULL', '', '', '',
2789       ],
2790       'primary_key' => 'svcnum',
2791       'unique' => [ ],
2792       'index' => [ ],
2793     },
2794
2795     'svc_hardware' => {
2796       'columns' => [
2797         'svcnum',   'int',     '',          '', '', '',
2798         'typenum',  'int',     '',          '', '', '',
2799         'serial',   'varchar', 'NULL', $char_d, '', '',
2800         'ip_addr',  'varchar', 'NULL',      40, '', '',
2801         'hw_addr',  'varchar', 'NULL',      12, '', '',
2802         'smartcard','varchar', 'NULL',      30, '', '',
2803         'statusnum','int',     'NULL',      '', '', '',
2804         'note',     'text',    'NULL',      '', '', '',
2805       ],
2806       'primary_key' => 'svcnum',
2807       'unique' => [ ],
2808       'index' => [ ],
2809     },
2810
2811     'hardware_class' => {
2812       'columns' => [
2813         'classnum',   'serial', '',      '', '', '',
2814         'classname', 'varchar', '', $char_d, '', '',
2815       ],
2816       'primary_key' => 'classnum',
2817       'unique' => [ ],
2818       'index'  => [ ],
2819     },
2820
2821     'hardware_type' => {
2822       'columns' => [
2823         'typenum',  'serial',     '',      '', '', '',
2824         'classnum',    'int',     '',      '', '', '',
2825         'model',   'varchar',     '', $char_d, '', '',
2826         'revision','varchar', 'NULL', $char_d, '', '',
2827       ],
2828       'primary_key' => 'typenum',
2829       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2830       'index'  => [ ],
2831     },
2832
2833     'hardware_status' => {
2834       'columns' => [
2835         'statusnum', 'serial', '',      '', '', '',
2836         'label'    ,'varchar', '', $char_d, '', '',
2837         'disabled',    'char', 'NULL',   1, '', '',
2838       ],
2839       'primary_key' => 'statusnum',
2840       'unique' => [ ],
2841       'index'  => [ ],
2842     },
2843
2844     'domain_record' => {
2845       'columns' => [
2846         'recnum',    'serial',     '',  '', '', '',
2847         'svcnum',    'int',     '',  '', '', '',
2848         'reczone',   'varchar', '',  255, '', '',
2849         'recaf',     'char',    '',  2, '', '',
2850         'rectype',   'varchar',    '',  5, '', '',
2851         'recdata',   'varchar', '',  255, '', '',
2852         'ttl',       'int',     'NULL', '', '', '',
2853       ],
2854       'primary_key' => 'recnum',
2855       'unique'      => [],
2856       'index'       => [ ['svcnum'] ],
2857     },
2858
2859     'registrar' => {
2860       'columns' => [
2861         'registrarnum',   'serial', '',      '', '', '',
2862         'registrarname', 'varchar', '', $char_d, '', '',
2863       ],
2864       'primary_key' => 'registrarnum',
2865       'unique'      => [],
2866       'index'       => [],
2867     },
2868
2869     'cgp_rule' => {
2870       'columns' => [
2871         'rulenum',  'serial',     '',      '', '', '',
2872         'name',    'varchar',     '', $char_d, '', '',
2873         'comment', 'varchar', 'NULL', $char_d, '', '',
2874         'svcnum',      'int',     '',      '', '', '',
2875         'priority',    'int',     '',      '', '', '',
2876       ],
2877       'primary_key' => 'rulenum',
2878       'unique'      => [ [ 'svcnum', 'name' ] ],
2879       'index'       => [ [ 'svcnum' ] ],
2880     },
2881
2882     'cgp_rule_condition' => {
2883       'columns' => [
2884         'ruleconditionnum',  'serial',     '',      '', '', '',
2885         'conditionname',    'varchar',     '', $char_d, '', '',
2886         'op',               'varchar', 'NULL', $char_d, '', '',
2887         'params',           'varchar', 'NULL',     255, '', '',
2888         'rulenum',              'int',     '',      '', '', '',
2889       ],
2890       'primary_key' => 'ruleconditionnum',
2891       'unique'      => [],
2892       'index'       => [ [ 'rulenum' ] ],
2893     },
2894
2895     'cgp_rule_action' => {
2896        'columns' => [
2897         'ruleactionnum',  'serial',     '',      '', '', '',
2898         'action',        'varchar',     '', $char_d, '', '',
2899         'params',        'varchar', 'NULL',     255, '', '',
2900         'rulenum',           'int',     '',      '', '', '',
2901       ],
2902       'primary_key' => 'ruleactionnum',
2903       'unique'      => [],
2904       'index'       => [ [ 'rulenum' ] ],
2905    },
2906
2907     'svc_forward' => {
2908       'columns' => [
2909         'svcnum',   'int',            '',   '', '', '',
2910         'srcsvc',   'int',        'NULL',   '', '', '',
2911         'src',      'varchar',    'NULL',  255, '', '',
2912         'dstsvc',   'int',        'NULL',   '', '', '',
2913         'dst',      'varchar',    'NULL',  255, '', '',
2914       ],
2915       'primary_key' => 'svcnum',
2916       'unique'      => [],
2917       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2918     },
2919
2920     'svc_www' => {
2921       'columns' => [
2922         'svcnum',   'int',      '',  '', '', '',
2923         'recnum',   'int',      '',  '', '', '',
2924         'usersvc',  'int',  'NULL',  '', '', '',
2925         'config',   'text', 'NULL',  '', '', '',
2926       ],
2927       'primary_key' => 'svcnum',
2928       'unique'      => [],
2929       'index'       => [],
2930     },
2931
2932     #'svc_wo' => {
2933     #  'columns' => [
2934     #    'svcnum',    'int',    '',   '',
2935     #    'svcnum',    'int',    '',   '',
2936     #    'svcnum',    'int',    '',   '',
2937     #    'worker',    'varchar',   '',   $char_d,
2938     #    '_date',     @date_type,
2939     #  ],
2940     #  'primary_key' => 'svcnum',
2941     #  'unique' => [ [] ],
2942     #  'index' => [ [] ],
2943     #},
2944
2945     'prepay_credit' => {
2946       'columns' => [
2947         'prepaynum',   'serial',     '',   '', '', '',
2948         'identifier',  'varchar', '', $char_d, '', '',
2949         'amount',      @money_type, '', '',
2950         'seconds',     'int',     'NULL', '', '', '',
2951         'upbytes',     'bigint',     'NULL', '', '', '',
2952         'downbytes',   'bigint',     'NULL', '', '', '',
2953         'totalbytes',  'bigint',     'NULL', '', '', '',
2954         'agentnum',    'int',     'NULL', '', '', '',
2955       ],
2956       'primary_key' => 'prepaynum',
2957       'unique'      => [ ['identifier'] ],
2958       'index'       => [ ['agentnum'] ],
2959     },
2960
2961     'port' => {
2962       'columns' => [
2963         'portnum',  'serial',     '',   '', '', '',
2964         'ip',       'varchar', 'NULL', 15, '', '',
2965         'nasport',  'int',     'NULL', '', '', '',
2966         'nasnum',   'int',     '',   '', '', '',
2967       ],
2968       'primary_key' => 'portnum',
2969       'unique'      => [],
2970       'index'       => [],
2971     },
2972
2973     'nas' => {
2974       'columns' => [
2975         'nasnum',       'serial',     '',  '',              '', '',
2976         'nasname',     'varchar',     '', 128,              '', '',
2977         'shortname',   'varchar', 'NULL',  32,              '', '',
2978         'type',        'varchar',     '',  30,         'other', '',
2979         'ports',           'int', 'NULL',  '',              '', '',
2980         'secret',      'varchar',     '',  60,        'secret', '',
2981         'server',      'varchar', 'NULL',  64,              '', '',
2982         'community',   'varchar', 'NULL',  50,              '', '',
2983         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2984         'svcnum',          'int', 'NULL',  '',              '', '',
2985       ],
2986       'primary_key' => 'nasnum',
2987       'unique'      => [ [ 'nasname' ], ],
2988       'index'       => [],
2989     },
2990
2991     'export_nas' => {
2992       'columns' => [
2993         'exportnasnum', 'serial', '', '', '', '',
2994         'exportnum',       'int', '', '', '', '',
2995         'nasnum',          'int', '', '', '', '',
2996       ],
2997       'primary_key' => 'exportnasnum',
2998       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2999       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
3000     },
3001
3002     'queue' => {
3003       'columns' => [
3004         'jobnum',   'bigserial',     '',      '', '', '',
3005         'job',        'varchar',     '',     512, '', '',
3006         '_date',          'int',     '',      '', '', '',
3007         'status',     'varchar',     '', $char_d, '', '',
3008         'statustext',    'text', 'NULL',      '', '', '',
3009         'svcnum',         'int', 'NULL',      '', '', '',
3010         'custnum',        'int', 'NULL',      '', '', '',
3011         'secure',        'char', 'NULL',       1, '', '',
3012         'priority',       'int', 'NULL',      '', '', '',
3013         'usernum',        'int', 'NULL',      '', '', '',
3014       ],
3015       'primary_key' => 'jobnum',
3016       'unique'      => [],
3017       'index'       => [ [ 'secure' ], [ 'priority' ],
3018                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
3019                        ],
3020     },
3021
3022     'queue_arg' => {
3023       'columns' => [
3024         'argnum', 'bigserial',     '', '', '', '',
3025         'jobnum',    'bigint',     '', '', '', '',
3026         'frozen',      'char', 'NULL',  1, '', '',
3027         'arg',         'text', 'NULL', '', '', '',
3028       ],
3029       'primary_key' => 'argnum',
3030       'unique'      => [],
3031       'index'       => [ [ 'jobnum' ] ],
3032     },
3033
3034     'queue_depend' => {
3035       'columns' => [
3036         'dependnum',  'bigserial', '', '', '', '',
3037         'jobnum',        'bigint', '', '', '', '',
3038         'depend_jobnum', 'bigint', '', '', '', '',
3039       ],
3040       'primary_key' => 'dependnum',
3041       'unique'      => [],
3042       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
3043     },
3044
3045     'queue_stat' => {
3046       'columns' => [
3047         'statnum', 'bigserial',     '',  '', '', '',
3048         'jobnum',     'bigint',     '',  '', '', '',
3049         'job',       'varchar',     '', 512, '', '',
3050         'custnum',       'int', 'NULL',  '', '', '',
3051         'insert_date', @date_type, '', '',
3052         'start_date',  @date_type, '', '',
3053         'end_date',    @date_type, '', '',
3054       ],
3055       'primary_key'  => 'statnum',
3056       'unique'       => [], #[ ['jobnum'] ],
3057       'index'        => [],
3058     },
3059
3060     'export_svc' => {
3061       'columns' => [
3062         'exportsvcnum' => 'serial', '', '', '', '',
3063         'exportnum'    => 'int', '', '', '', '',
3064         'svcpart'      => 'int', '', '', '', '',
3065         'role'         => 'varchar', 'NULL', 16, '', '',
3066       ],
3067       'primary_key' => 'exportsvcnum',
3068       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
3069       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
3070     },
3071
3072     'export_cust_svc' => {
3073       'columns' => [
3074         'exportcustsvcnum', 'serial', '', '', '', '',
3075         'exportnum', 'int', '', '', '', '',
3076         'svcnum', 'int', '', '', '', '',
3077         'remoteid', 'varchar', '', 512, '', '',
3078       ],
3079       'primary_key'  => 'exportcustsvcnum',
3080       'unique'       => [ [ 'exportnum', 'svcnum' ] ],
3081       'index'        => [ [ 'exportnum', 'svcnum' ] ],
3082       'foreign_keys' => [
3083                           { columns    => [ 'exportnum' ],
3084                             table      => 'part_export',
3085                           },
3086                           { columns    => [ 'svcnum' ],
3087                             table      => 'cust_svc',
3088                           },
3089                         ],
3090     },
3091
3092     'export_device' => {
3093       'columns' => [
3094         'exportdevicenum' => 'serial', '', '', '', '',
3095         'exportnum'    => 'int', '', '', '', '',
3096         'devicepart'      => 'int', '', '', '', '',
3097       ],
3098       'primary_key' => 'exportdevicenum',
3099       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
3100       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
3101     },
3102
3103     'part_export' => {
3104       'columns' => [
3105         'exportnum',   'serial',     '',      '', '', '',
3106         'exportname', 'varchar', 'NULL', $char_d, '', '',
3107         'machine',    'varchar', 'NULL', $char_d, '', '',
3108         'exporttype', 'varchar',     '', $char_d, '', '',
3109         'nodomain',      'char', 'NULL',       1, '', '',
3110         'default_machine','int', 'NULL',      '', '', '',
3111         'no_suspend',    'char', 'NULL',       1, '', '',
3112         # could also have 'no_insert', 'no_replace', etc.
3113       ],
3114       'primary_key' => 'exportnum',
3115       'unique'      => [],
3116       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
3117     },
3118
3119     'part_export_option' => {
3120       'columns' => [
3121         'optionnum', 'serial', '', '', '', '',
3122         'exportnum', 'int', '', '', '', '',
3123         'optionname', 'varchar', '', $char_d, '', '',
3124         'optionvalue', 'text', 'NULL', '', '', '',
3125       ],
3126       'primary_key' => 'optionnum',
3127       'unique'      => [],
3128       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
3129     },
3130
3131     'radius_usergroup' => {
3132       'columns' => [
3133         'usergroupnum', 'serial', '', '', '', '',
3134         'svcnum',       'int', '', '', '', '',
3135         'groupname',    'varchar', 'NULL', $char_d, '', '',
3136         'groupnum',     'int', 'NULL', '', '', '',
3137       ],
3138       'primary_key' => 'usergroupnum',
3139       'unique'      => [],
3140       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
3141     },
3142
3143     'radius_group' => {
3144       'columns' => [
3145         'groupnum', 'serial', '', '', '', '',
3146         'groupname',    'varchar', '', $char_d, '', '',
3147         'description',  'varchar', 'NULL', $char_d, '', '',
3148         'priority', 'int', '', '', '1', '',
3149         'speed_up', 'int', 'NULL', '', '', '',
3150         'speed_down', 'int', 'NULL', '', '', '',
3151       ],
3152       'primary_key' => 'groupnum',
3153       'unique'      => [ ['groupname'] ],
3154       'index'       => [],
3155     },
3156
3157     'radius_attr' => {
3158       'columns' => [
3159         'attrnum',   'serial', '',      '', '', '',
3160         'groupnum',     'int', '',      '', '', '',
3161         'attrname', 'varchar', '', $char_d, '', '',
3162         'value',    'varchar', '',     255, '', '',
3163         'attrtype',    'char', '',       1, '', '',
3164         'op',          'char', '',       2, '', '',
3165       ],
3166       'primary_key' => 'attrnum',
3167       'unique'      => [],
3168       'index'       => [ ['groupnum'], ],
3169     },
3170
3171     'msgcat' => {
3172       'columns' => [
3173         'msgnum', 'serial', '', '', '', '',
3174         'msgcode', 'varchar', '', 255, '', '',
3175         'locale', 'varchar', '', 16, '', '',
3176         'msg', 'text', '', '', '', '',
3177       ],
3178       'primary_key' => 'msgnum',
3179       'unique'      => [ [ 'msgcode', 'locale' ] ],
3180       'index'       => [],
3181     },
3182
3183     'cust_tax_exempt' => {
3184       'columns' => [
3185         'exemptnum', 'serial', '', '', '', '',
3186         'custnum',   'int', '', '', '', '',
3187         'taxnum',    'int', '', '', '', '',
3188         'year',      'int', '', '', '', '',
3189         'month',     'int', '', '', '', '',
3190         'amount',   @money_type, '', '',
3191       ],
3192       'primary_key' => 'exemptnum',
3193       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
3194       'index'       => [],
3195     },
3196
3197     'cust_tax_exempt_pkg' => {
3198       'columns' => [
3199         'exemptpkgnum',  'serial', '', '', '', '',
3200         #'custnum',      'int', '', '', '', ''
3201         'billpkgnum',   'int', '', '', '', '',
3202         'taxnum',       'int', '', '', '', '',
3203         'taxtype',  'varchar', 'NULL', $char_d, '', '',
3204         'year',         'int', 'NULL', '', '', '',
3205         'month',        'int', 'NULL', '', '', '',
3206         'creditbillpkgnum', 'int', 'NULL', '', '', '',
3207         'amount',       @money_type, '', '',
3208         # exemption type flags
3209         'exempt_cust',          'char', 'NULL', 1, '', '',
3210         'exempt_setup',         'char', 'NULL', 1, '', '',
3211         'exempt_recur',         'char', 'NULL', 1, '', '',
3212         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
3213         'exempt_monthly',       'char', 'NULL', 1, '', '',
3214       ],
3215       'primary_key' => 'exemptpkgnum',
3216       'unique' => [],
3217       'index'  => [ [ 'taxnum', 'year', 'month' ],
3218                     [ 'billpkgnum' ],
3219                     [ 'taxnum', 'taxtype' ],
3220                     [ 'creditbillpkgnum' ],
3221                   ],
3222     },
3223
3224     'cust_tax_exempt_pkg_void' => {
3225       'columns' => [
3226         'exemptpkgnum',  'int', '', '', '', '',
3227         #'custnum',      'int', '', '', '', ''
3228         'billpkgnum',   'int', '', '', '', '',
3229         'taxnum',       'int', '', '', '', '',
3230         'taxtype',  'varchar', 'NULL', $char_d, '', '',
3231         'year',         'int', 'NULL', '', '', '',
3232         'month',        'int', 'NULL', '', '', '',
3233         'creditbillpkgnum', 'int', 'NULL', '', '', '',
3234         'amount',       @money_type, '', '',
3235         # exemption type flags
3236         'exempt_cust',          'char', 'NULL', 1, '', '',
3237         'exempt_setup',         'char', 'NULL', 1, '', '',
3238         'exempt_recur',         'char', 'NULL', 1, '', '',
3239         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
3240         'exempt_monthly',       'char', 'NULL', 1, '', '',
3241       ],
3242       'primary_key' => 'exemptpkgnum',
3243       'unique' => [],
3244       'index'  => [ [ 'taxnum', 'year', 'month' ],
3245                     [ 'billpkgnum' ],
3246                     [ 'taxnum', 'taxtype' ],
3247                     [ 'creditbillpkgnum' ],
3248                   ],
3249     },
3250
3251     'router' => {
3252       'columns' => [
3253         'routernum', 'serial', '', '', '', '',
3254         'routername', 'varchar', '', $char_d, '', '',
3255         'svcnum', 'int', 'NULL', '', '', '',
3256         'agentnum',   'int', 'NULL', '', '', '',
3257         'manual_addr', 'char', 'NULL', 1, '', '',
3258       ],
3259       'primary_key' => 'routernum',
3260       'unique'      => [],
3261       'index'       => [],
3262     },
3263
3264     'part_svc_router' => {
3265       'columns' => [
3266         'svcrouternum', 'serial', '', '', '', '',
3267         'svcpart', 'int', '', '', '', '',
3268         'routernum', 'int', '', '', '', '',
3269       ],
3270       'primary_key' => 'svcrouternum',
3271       'unique'      => [],
3272       'index'       => [],
3273     },
3274
3275     'addr_block' => {
3276       'columns' => [
3277         'blocknum', 'serial', '', '', '', '',
3278         'routernum', 'int', '', '', '', '',
3279         'ip_gateway', 'varchar', '', 15, '', '',
3280         'ip_netmask', 'int', '', '', '', '',
3281         'agentnum',   'int', 'NULL', '', '', '',
3282         'manual_flag', 'char', 'NULL', 1, '', '',
3283       ],
3284       'primary_key' => 'blocknum',
3285       'unique'      => [ [ 'blocknum', 'routernum' ] ],
3286       'index'       => [],
3287     },
3288
3289     'addr_range' => {
3290       'columns' => [
3291         'rangenum', 'serial', '', '', '', '',
3292         'start',    'varchar', '', 15, '', '',
3293         'length',   'int', '', '', '', '',
3294         'status',   'varchar', 'NULL', 32, '', '',
3295       ],
3296       'primary_key' => 'rangenum',
3297       'unique'      => [],
3298       'index'       => [],
3299     },
3300
3301     'svc_broadband' => {
3302       'columns' => [
3303         'svcnum',                  'int',     '',        '', '', '',
3304         'description',         'varchar', 'NULL',   $char_d, '', '',
3305         'routernum',               'int', 'NULL',        '', '', '',
3306         'blocknum',                'int', 'NULL',        '', '', '',
3307         'sectornum',               'int', 'NULL',        '', '', '',
3308         'speed_up',                'int', 'NULL',        '', '', '',
3309         'speed_down',              'int', 'NULL',        '', '', '',
3310         'ip_addr',             'varchar', 'NULL',        15, '', '',
3311         'mac_addr',            'varchar', 'NULL',        12, '', '',
3312         'authkey',             'varchar', 'NULL',        32, '', '',
3313         'latitude',            'decimal', 'NULL',    '10,7', '', '',
3314         'longitude',           'decimal', 'NULL',    '10,7', '', '',
3315         'altitude',            'decimal', 'NULL',        '', '', '',
3316         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
3317         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
3318         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
3319         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
3320         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
3321         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
3322         'rssi',                    'int', 'NULL',        '', '', '',
3323         'suid',                    'int', 'NULL',        '', '', '',
3324         'shared_svcnum',           'int', 'NULL',        '', '', '',
3325         'serviceid',           'varchar', 'NULL',        64, '', '',#srvexport/reportfields
3326       ],
3327       'primary_key' => 'svcnum',
3328       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
3329       'index'       => [],
3330     },
3331
3332     'tower' => {
3333       'columns' => [
3334         'towernum',    'serial',     '',      '', '', '',
3335         #'agentnum',       'int', 'NULL',      '', '', '',
3336         'towername',  'varchar',     '', $char_d, '', '',
3337         'disabled',      'char', 'NULL',       1, '', '',
3338         'latitude',   'decimal', 'NULL',  '10,7', '', '',
3339         'longitude',  'decimal', 'NULL',  '10,7', '', '',
3340         'coord_auto',    'char', 'NULL',       1, '', '',
3341         'altitude',   'decimal', 'NULL',      '', '', '',
3342         'height',     'decimal', 'NULL',      '', '', '',
3343         'veg_height', 'decimal', 'NULL',      '', '', '',
3344         'color',      'varchar', 'NULL',       6, '', '',
3345         'up_rate',        'int', 'NULL',      '', '', '',
3346         'down_rate',      'int', 'NULL',      '', '', '',
3347       ],
3348       'primary_key' => 'towernum',
3349       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
3350       'index'       => [],
3351     },
3352
3353     'tower_sector' => {
3354       'columns' => [
3355         'sectornum',     'serial',     '',      '', '', '',
3356         'towernum',         'int',     '',      '', '', '',
3357         'sectorname',   'varchar',     '', $char_d, '', '',
3358         'ip_addr',      'varchar', 'NULL',      15, '', '',
3359         'height',       'decimal', 'NULL',      '', '', '',
3360         'freq_mhz',         'int', 'NULL',      '', '', '',
3361         'direction',        'int', 'NULL',      '', '', '',
3362         'width',            'int', 'NULL',      '', '', '',
3363         'sector_range', 'decimal', 'NULL',      '', '', '',  #?
3364         'downtilt',     'decimal', 'NULL',      '', '', '',
3365         'v_width',          'int', 'NULL',      '', '', '',
3366         'margin',       'decimal', 'NULL',     '', '', '',
3367         'image',           'blob', 'NULL',     '', '', '',
3368         'west',         'decimal', 'NULL', '10,7', '', '',
3369         'east',         'decimal', 'NULL', '10,7', '', '',
3370         'south',        'decimal', 'NULL', '10,7', '', '',
3371         'north',        'decimal', 'NULL', '10,7', '', '',
3372         'title',        'varchar', 'NULL', $char_d,'', '',
3373         'up_rate',          'int', 'NULL',      '', '', '',
3374         'down_rate',        'int', 'NULL',      '', '', '',
3375      ],
3376       'primary_key'  => 'sectornum',
3377       'unique'       => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
3378       'index'        => [ [ 'towernum' ] ],
3379     },
3380
3381     'part_virtual_field' => {
3382       'columns' => [
3383         'vfieldpart', 'serial', '', '', '', '',
3384         'dbtable', 'varchar', '', 32, '', '',
3385         'name', 'varchar', '', 32, '', '',
3386         'length', 'int', 'NULL', '', '', '',
3387         'label', 'varchar', 'NULL', 80, '', '',
3388       ],
3389       'primary_key' => 'vfieldpart',
3390       'unique' => [],
3391       'index' => [],
3392     },
3393
3394     'virtual_field' => {
3395       'columns' => [
3396         'vfieldnum', 'serial', '', '', '', '',
3397         'recnum', 'int', '', '', '', '',
3398         'vfieldpart', 'int', '', '', '', '',
3399         'value', 'varchar', '', 128, '', '',
3400       ],
3401       'primary_key' => 'vfieldnum',
3402       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
3403       'index' => [],
3404     },
3405
3406     'acct_snarf' => {
3407       'columns' => [
3408         'snarfnum',    'serial',     '',      '', '', '',
3409         'snarfname',  'varchar', 'NULL', $char_d, '', '',
3410         'svcnum',         'int',     '',      '', '', '',
3411         'machine',    'varchar',     '',     255, '', '',
3412         'protocol',   'varchar',     '', $char_d, '', '',
3413         'username',   'varchar',     '', $char_d, '', '',
3414         '_password',  'varchar',     '', $char_d, '', '',
3415         'check_freq',     'int', 'NULL',      '', '', '',
3416         'leavemail',     'char', 'NULL',       1, '', '',
3417         'apop',          'char', 'NULL',       1, '', '',
3418         'tls',           'char', 'NULL',       1, '', '',
3419         'mailbox',    'varchar', 'NULL', $char_d, '', '',
3420       ],
3421       'primary_key' => 'snarfnum',
3422       'unique' => [],
3423       'index'  => [ [ 'svcnum' ] ],
3424     },
3425
3426     'svc_external' => {
3427       'columns' => [
3428         'svcnum',     'int',     '',      '', '', '',
3429         'id',      'bigint', 'NULL',      '', '', '',
3430         'title',  'varchar', 'NULL', $char_d, '', '',
3431       ],
3432       'primary_key' => 'svcnum',
3433       'unique'      => [],
3434       'index'       => [],
3435     },
3436
3437     'cust_pay_refund' => {
3438       'columns' => [
3439         'payrefundnum', 'serial', '', '', '', '',
3440         'paynum',  'int', '', '', '', '',
3441         'refundnum',  'int', '', '', '', '',
3442         '_date',    @date_type, '', '',
3443         'amount',   @money_type, '', '',
3444       ],
3445       'primary_key' => 'payrefundnum',
3446       'unique' => [],
3447       'index' => [ ['paynum'], ['refundnum'] ],
3448     },
3449
3450     'part_pkg_option' => {
3451       'columns' => [
3452         'optionnum', 'serial', '', '', '', '',
3453         'pkgpart', 'int', '', '', '', '',
3454         'optionname', 'varchar', '', $char_d, '', '',
3455         'optionvalue', 'text', 'NULL', '', '', '',
3456       ],
3457       'primary_key' => 'optionnum',
3458       'unique'      => [],
3459       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
3460     },
3461
3462     'part_pkg_vendor' => {
3463       'columns' => [
3464         'num', 'serial', '', '', '', '',
3465         'pkgpart', 'int', '', '', '', '',
3466         'exportnum', 'int', '', '', '', '',
3467         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
3468       ],
3469       'primary_key' => 'num',
3470       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
3471       'index'       => [ [ 'pkgpart' ] ],
3472     },
3473
3474     'part_pkg_report_option' => {
3475       'columns' => [
3476         'num',      'serial',   '',      '', '', '',
3477         'name',     'varchar',  '', $char_d, '', '',
3478         'disabled', 'char', 'NULL',       1, '', '',
3479       ],
3480       'primary_key' => 'num',
3481       'unique' => [ [ 'name' ] ],
3482       'index' => [ [ 'disabled' ] ],
3483     },
3484
3485     'part_pkg_usage' => {
3486       'columns' => [
3487         'pkgusagepart', 'serial',   '', '', '', '',
3488         'pkgpart',  'int',      '', '', '', '',
3489         'minutes',  'double precision',      '', '', '', '',
3490         'priority', 'int',  'NULL', '', '', '',
3491         'shared',   'char', 'NULL',  1, '', '',
3492         'rollover', 'char', 'NULL',  1, '', '',
3493         'description',  'varchar', 'NULL', $char_d, '', '',
3494       ],
3495       'primary_key' => 'pkgusagepart',
3496       'unique'      => [],
3497       'index'       => [ [ 'pkgpart' ] ],
3498     },
3499
3500     'part_pkg_usage_class' => {
3501       'columns' => [
3502         'num',       'serial',  '', '', '', '',
3503         'pkgusagepart', 'int',  '', '', '', '',
3504         'classnum',     'int','NULL', '', '', '',
3505       ],
3506       'primary_key' => 'num',
3507       'unique'      => [ [ 'pkgusagepart', 'classnum' ] ],
3508       'index'       => [],
3509     },
3510
3511     'part_pkg_fcc_option' => {
3512       'columns' => [
3513         'num',        'serial', '', '', '', '',
3514         'fccoptionname', 'varchar', '', $char_d, '', '',
3515         'pkgpart',       'int', '', '', '', '',
3516         'optionvalue',   'varchar', 'NULL', $char_d, '', '',
3517       ],
3518       'primary_key' => 'num',
3519       'unique'      => [ [ 'fccoptionname', 'pkgpart' ] ],
3520       'index'       => [],
3521     },
3522
3523     'rate' => {
3524       'columns' => [
3525         'ratenum',          'serial',     '', '', '', '',
3526         'ratename',        'varchar', '',$char_d, '', '',
3527         'agentnum',            'int', 'NULL', '', '', '',
3528         'default_detailnum',   'int', 'NULL', '', '', '',
3529       ],
3530       'primary_key' => 'ratenum',
3531       'unique'      => [],
3532       'index'       => [],
3533     },
3534
3535     'rate_detail' => {
3536       'columns' => [
3537         'ratedetailnum',   'serial',  '',     '',      '', '',
3538         'ratenum',         'int',     '',     '',      '', '',
3539         'orig_regionnum',  'int', 'NULL',     '',      '', '',
3540         'dest_regionnum',  'int', 'NULL',     '',      '', '',
3541         'min_included',    'int',     '',     '',      '', '',
3542         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
3543         'conn_cost',       'decimal', '', '10,4', '0.0000', '',
3544         'conn_sec',        'int',     '',     '',      '0', '',
3545         'min_charge',      'decimal', '', '10,5',       '', '',
3546         'min_cost',        'decimal', '', '10,5','0.00000', '',
3547         'sec_granularity', 'int',     '',     '',       '', '',
3548         'ratetimenum',     'int', 'NULL',     '',       '', '',
3549         'classnum',        'int', 'NULL',     '',       '', '',
3550         'cdrtypenum',      'int', 'NULL',     '',       '', '',
3551         'region_group',   'char', 'NULL',      1,       '', '',
3552         'upstream_mult_charge',  'decimal',  '', '10,4', '0.0000', '',
3553         'upstream_mult_cost',    'decimal',  '', '10,4', '0.0000', '',
3554       ],
3555       'primary_key' => 'ratedetailnum',
3556       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
3557       'index'       => [ [ 'ratenum', 'dest_regionnum' ],
3558                          [ 'ratenum', 'ratetimenum' ]
3559                        ],
3560     },
3561
3562     'rate_region' => {
3563       'columns' => [
3564         'regionnum',   'serial',      '', '', '', '',
3565         'regionname',  'varchar',     '', $char_d, '', '',
3566         'exact_match', 'char',    'NULL',  1, '', '',
3567       ],
3568       'primary_key' => 'regionnum',
3569       'unique'      => [],
3570       'index'       => [],
3571     },
3572
3573     'rate_prefix' => {
3574       'columns' => [
3575         'prefixnum',   'serial',      '', '', '', '',
3576         'regionnum',   'int',         '', '', '', '',
3577         'countrycode', 'varchar',     '',  3, '', '',
3578         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
3579         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
3580         'latanum',     'int',     'NULL',      '', '', '',
3581         'state',       'char',    'NULL',       2, '', '',
3582         'ocn',         'char',    'NULL',       4, '', '',
3583       ],
3584       'primary_key' => 'prefixnum',
3585       'unique'      => [],
3586       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
3587     },
3588
3589     'rate_time' => {
3590       'columns' => [
3591         'ratetimenum', 'serial',      '',      '', '', '',
3592         'ratetimename',   'varchar',      '', $char_d, '', '',
3593       ],
3594       'primary_key' => 'ratetimenum',
3595       'unique'      => [],
3596       'index'       => [],
3597     },
3598
3599     'rate_time_interval' => {
3600       'columns' => [
3601         'intervalnum', 'serial', '', '', '', '',
3602         'stime',          'int', '', '', '', '',
3603         'etime',          'int', '', '', '', '',
3604         'ratetimenum',    'int', '', '', '', '',
3605       ],
3606       'primary_key' => 'intervalnum',
3607       'unique'      => [],
3608       'index'       => [],
3609     },
3610
3611     #not really part of the above rate_ stuff (used with flat rate rather than
3612     # rated billing), but could be eventually, and its a rate
3613     'rate_tier' => {
3614       'columns' => [
3615         'tiernum',   'serial', '',      '', '', '',
3616         'tiername', 'varchar', '', $char_d, '', '',
3617       ],
3618       'primary_key' => 'tiernum',
3619       'unique'      => [ [ 'tiername'], ],
3620       'index'       => [],
3621     },
3622
3623     'rate_tier_detail' => {
3624       'columns' => [
3625         'tierdetailnum', 'serial', '',     '', '', '',
3626         'tiernum',          'int', '',     '', '', '',
3627         'min_quan',         'int', '',     '', '', '',
3628         'min_charge',   'decimal', '', '10,4', '', '',
3629       ],
3630       'primary_key' => 'tierdetailnum',
3631       'unique'      => [],
3632       'index'       => [ ['tiernum'], ],
3633     },
3634
3635     'usage_class' => {
3636       'columns' => [
3637         'classnum',    'serial',      '',      '', '', '',
3638         'weight',      'int',     'NULL',      '', '', '',
3639         'classname',   'varchar',     '', $char_d, '', '',
3640         'format',      'varchar', 'NULL', $char_d, '', '',
3641         'disabled',    'char',    'NULL',       1, '', '',
3642       ],
3643       'primary_key' => 'classnum',
3644       'unique' => [],
3645       'index' => [ ['disabled'] ],
3646     },
3647
3648     'reg_code' => {
3649       'columns' => [
3650         'codenum',   'serial',    '', '', '', '',
3651         'code',      'varchar',   '', $char_d, '', '',
3652         'agentnum',  'int',       '', '', '', '',
3653       ],
3654       'primary_key' => 'codenum',
3655       'unique'      => [ [ 'agentnum', 'code' ] ],
3656       'index'       => [ [ 'agentnum' ] ],
3657     },
3658
3659     'reg_code_pkg' => {
3660       'columns' => [
3661         'codepkgnum', 'serial', '', '', '', '',
3662         'codenum',   'int',    '', '', '', '',
3663         'pkgpart',   'int',    '', '', '', '',
3664       ],
3665       'primary_key' => 'codepkgnum',
3666       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
3667       'index'       => [ [ 'codenum' ] ],
3668     },
3669
3670     'clientapi_session' => {
3671       'columns' => [
3672         'sessionnum',  'serial',  '', '', '', '',
3673         'sessionid',  'varchar',  '', $char_d, '', '',
3674         'namespace',  'varchar',  '', $char_d, '', '',
3675       ],
3676       'primary_key' => 'sessionnum',
3677       'unique'      => [ [ 'sessionid', 'namespace' ] ],
3678       'index'       => [],
3679     },
3680
3681     'clientapi_session_field' => {
3682       'columns' => [
3683         'fieldnum',    'serial',     '', '', '', '',
3684         'sessionnum',     'int',     '', '', '', '',
3685         'fieldname',  'varchar',     '', $char_d, '', '',
3686         'fieldvalue',    'text', 'NULL', '', '', '',
3687       ],
3688       'primary_key' => 'fieldnum',
3689       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
3690       'index'       => [],
3691     },
3692
3693     'payment_gateway' => {
3694       'columns' => [
3695         'gatewaynum',       'serial',   '',     '', '', '',
3696         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
3697         'gateway_module',   'varchar',  '',     $char_d, '', '',
3698         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
3699         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
3700         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
3701         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
3702         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
3703         'disabled',   'char',  'NULL',   1, '', '',
3704       ],
3705       'primary_key' => 'gatewaynum',
3706       'unique' => [],
3707       'index'  => [ [ 'disabled' ] ],
3708     },
3709
3710     'payment_gateway_option' => {
3711       'columns' => [
3712         'optionnum',   'serial',  '',     '', '', '',
3713         'gatewaynum',  'int',     '',     '', '', '',
3714         'optionname',  'varchar', '',     $char_d, '', '',
3715         'optionvalue', 'text',    'NULL', '', '', '',
3716       ],
3717       'primary_key' => 'optionnum',
3718       'unique'      => [],
3719       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
3720     },
3721
3722     'agent_payment_gateway' => {
3723       'columns' => [
3724         'agentgatewaynum', 'serial', '', '', '', '',
3725         'agentnum',        'int', '', '', '', '',
3726         'gatewaynum',      'int', '', '', '', '',
3727         'cardtype',        'varchar', 'NULL', $char_d, '', '',
3728         'taxclass',        'varchar', 'NULL', $char_d, '', '',
3729       ],
3730       'primary_key' => 'agentgatewaynum',
3731       'unique'      => [],
3732       'index'       => [ [ 'agentnum', 'cardtype' ], ],
3733     },
3734
3735     'banned_pay' => {
3736       'columns' => [
3737         'bannum',  'serial',   '',     '', '', '',
3738         'payby',   'char',     '',       4, '', '',
3739         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
3740         #'paymask', 'varchar',  'NULL', $char_d, '', ''
3741         '_date',            @date_type,         '', '',
3742         'end_date',         @date_type,         '', '',
3743         'otaker',  'varchar',  'NULL',      32, '', '',
3744         'usernum',     'int',  'NULL',      '', '', '',
3745         'bantype', 'varchar',  'NULL', $char_d, '', '',
3746         'reason',  'varchar',  'NULL', $char_d, '', '',
3747       ],
3748       'primary_key' => 'bannum',
3749       'unique'      => [],
3750       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
3751     },
3752
3753     'pkg_category' => {
3754       'columns' => [
3755         'categorynum',        'serial',     '',      '', '', '',
3756         'categoryname',      'varchar',     '', $char_d, '', '',
3757         'weight',                'int', 'NULL',      '', '', '',
3758         'ticketing_queueid',     'int', 'NULL',      '', '', '',
3759         'condense',             'char', 'NULL',       1, '', '',
3760         'disabled',             'char', 'NULL',       1, '', '',
3761       ],
3762       'primary_key' => 'categorynum',
3763       'unique' => [],
3764       'index' => [ ['disabled'] ],
3765     },
3766
3767     'pkg_class' => {
3768       'columns' => [
3769         'classnum',    'serial',   '',      '', '', '',
3770         'classname',   'varchar',  '', $char_d, '', '',
3771         'categorynum', 'int',  'NULL',      '', '', '',
3772         'disabled',    'char', 'NULL',       1, '', '',
3773         'fcc_ds0s',      'int',     'NULL', '', '', '',
3774       ],
3775       'primary_key' => 'classnum',
3776       'unique' => [],
3777       'index' => [ ['disabled'] ],
3778     },
3779
3780     'cdr' => {
3781       'columns' => [
3782         # qw( name type null length default local );
3783
3784         ###
3785         #asterisk fields
3786         ###
3787
3788         'acctid',   'bigserial',  '', '', '', '',
3789         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
3790         'calldate', 'timestamp',   '',      '', \'now()', '',
3791         'clid',        'varchar',  '', $char_d, \"''", '',
3792         'src',         'varchar',  '', $char_d, \"''", '',
3793         'dst',         'varchar',  '', $char_d, \"''", '',
3794         'dcontext',    'varchar',  '', $char_d, \"''", '',
3795         'channel',     'varchar',  '', $char_d, \"''", '',
3796         'dstchannel',  'varchar',  '', $char_d, \"''", '',
3797         'lastapp',     'varchar',  '', $char_d, \"''", '',
3798         'lastdata',    'varchar',  '',     255, \"''", '',
3799
3800         #currently only opensips
3801         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
3802         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
3803
3804         #currently only u4:
3805         # terminating number (as opposed to dialed destination)
3806         'dst_term',    'varchar',  'NULL', $char_d, '', '',
3807
3808         #these don't seem to be logged by most of the SQL cdr_* modules
3809         #except tds under sql-illegal names, so;
3810         # ... don't rely on them for rating?
3811         # and, what they hey, i went ahead and changed the names and data types
3812         # to freeside-style dates...
3813           #'start',  'timestamp', 'NULL',  '',    '', '',
3814           #'answer', 'timestamp', 'NULL',  '',    '', '',
3815           #'end',    'timestamp', 'NULL',  '',    '', '',
3816         'startdate',  @date_type, '', '',
3817         'answerdate', @date_type, '', '',
3818         'enddate',    @date_type, '', '',
3819         #
3820
3821         'duration',    'int',      '',      '',     0, '',
3822         'billsec',     'int',      '',      '',     0, '',
3823         'disposition', 'varchar',  '',      45, \"''", '',
3824         'amaflags',    'int',      '',      '',     0, '',
3825         'accountcode', 'varchar',  '',      32, \"''", '',
3826         'uniqueid',    'varchar',  '', $char_d, \"''", '',
3827         'userfield',   'varchar',  '',     512, \"''", '',
3828
3829         'max_callers', 'int',  'NULL',      '',    '', '',
3830
3831         ###
3832         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
3833         # ones we adoped moved to "own fields" section below
3834         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
3835         ###
3836
3837         'upstream_currency',      'char', 'NULL',       3, '', '',
3838         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
3839
3840         # how it was rated internally...
3841         'ratedetailnum',           'int', 'NULL',      '', '', '',
3842
3843         'distance',            'decimal', 'NULL',      '', '', '',
3844         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
3845
3846         #cdr_calltype: the big list in appendix 2
3847         'calltypenum',             'int', 'NULL',      '', '', '',
3848
3849         'description',         'varchar', 'NULL', $char_d, '', '',
3850         'quantity',                'int', 'NULL',      '', '', '',
3851
3852         'upstream_rateid',         'int', 'NULL',      '', '', '',
3853
3854         ###
3855         # more fields, for GSM imports
3856         ###
3857         'servicecode',             'int', 'NULL',      '', '', '',
3858         'quantity_able',           'int', 'NULL',      '', '', '',
3859
3860         ###
3861         #and now for our own fields
3862         ###
3863
3864         'cdrtypenum',              'int', 'NULL',      '', '', '',
3865
3866         'charged_party',       'varchar', 'NULL', $char_d, '', '',
3867         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
3868
3869         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
3870         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
3871         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
3872
3873         # how it was rated internally...
3874         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
3875         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
3876         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
3877         'rated_seconds',              'int', 'NULL',      '', '', '',
3878         'rated_minutes', 'double precision', 'NULL',      '', '', '',
3879         'rated_granularity',          'int', 'NULL',      '', '', '',
3880         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
3881         'rated_classnum',             'int', 'NULL',      '', '', '',
3882         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
3883         'rated_cost',            'decimal', 'NULL',  '10,4', '', '',
3884
3885         # real endpoints of the call
3886         'src_lrn',             'varchar', 'NULL',     '15', '', '',
3887         'dst_lrn',             'varchar', 'NULL',     '15', '', '',
3888
3889         'carrierid',               'bigint', 'NULL',      '', '', '',
3890
3891         # service it was matched to
3892         'svcnum',             'int',   'NULL',     '',   '', '',
3893
3894         #NULL, done (or something)
3895         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
3896
3897         #NULL, done (or something)
3898         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
3899
3900         #an indexed place to put big numbers
3901         'cdrid',         'bigint',     'NULL',     '',  '', '',
3902
3903         #for taqua accountcode rewriting, for starters
3904         'sessionnum',       'int',    'NULL',      '', '', '',
3905         'subscriber',   'varchar',    'NULL', $char_d, '', '',
3906
3907         #old
3908         'cdrbatch',     'varchar',    'NULL',     255, '', '',
3909         #new
3910         'cdrbatchnum',      'int',    'NULL',      '', '', '',
3911
3912         # FK to cust_bill_pkg_detail; having a value here absolutely means
3913         # that the CDR appears on an invoice
3914         'detailnum',     'bigint',    'NULL',      '', '', '',
3915       ],
3916       'primary_key' => 'acctid',
3917       'unique' => [],
3918       'index' => [ [ 'calldate' ],
3919                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
3920                    [ 'startdate' ],
3921                    [ 'lastapp' ],
3922                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
3923                    [ 'sessionnum' ], [ 'subscriber' ],
3924                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
3925                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
3926                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ], [ 'dst_term' ],
3927                  ],
3928     },
3929
3930     'cdr_batch' => {
3931       'columns' => [
3932         'cdrbatchnum',   'serial',    '',   '', '', '',
3933         'cdrbatch', 'varchar', 'NULL', 255, '', '',
3934         '_date',     @date_type, '', '',
3935       ],
3936       'primary_key' => 'cdrbatchnum',
3937       'unique' => [ [ 'cdrbatch' ] ],
3938       'index' => [],
3939     },
3940
3941     'cdr_termination' => {
3942       'columns' => [
3943         'cdrtermnum', 'bigserial',     '',      '', '', '',
3944         'acctid',        'bigint',     '',      '', '', '',
3945         'termpart',         'int',     '',      '', '', '',#future use see below
3946         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
3947         'rated_seconds',    'int', 'NULL',      '', '', '',
3948         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3949         'rated_granularity','int', 'NULL',      '', '', '',
3950         'status',       'varchar', 'NULL',      32, '', '',
3951         'svcnum',           'int', 'NULL',      '', '', '',
3952       ],
3953       'primary_key' => 'cdrtermnum',
3954       'unique'      => [ [ 'acctid', 'termpart' ] ],
3955       'index'       => [ [ 'acctid' ], [ 'status' ], ],
3956     },
3957
3958     #to handle multiple termination/settlement passes...
3959    # 'part_termination' => {
3960    #   'columns' => [
3961    #     'termpart',       'int', '',      '', '', '',
3962    #     'termname',   'varchar', '', $char_d, '', '',
3963    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
3964    #   ],
3965    #   'primary_key' => 'termpart',
3966    #   'unique' => [],
3967    #   'index'  => [],
3968    # },
3969
3970     #the remaining cdr_ tables are not really used
3971     'cdr_calltype' => {
3972       'columns' => [
3973         'calltypenum',   'serial',  '', '', '', '',
3974         'calltypename',  'varchar', '', $char_d, '', '',
3975       ],
3976       'primary_key' => 'calltypenum',
3977       'unique'      => [],
3978       'index'       => [],
3979     },
3980
3981     'cdr_type' => {
3982       'columns' => [
3983         'cdrtypenum'  => 'serial',  '', '', '', '',
3984         'cdrtypename' => 'varchar', '', $char_d, '', '',
3985       ],
3986       'primary_key' => 'cdrtypenum',
3987       'unique'      => [],
3988       'index'       => [],
3989     },
3990
3991     'cdr_carrier' => {
3992       'columns' => [
3993         'carrierid'   =>  'serial',     '',      '', '', '',
3994         'carriername' => 'varchar',     '', $char_d, '', '',
3995         'disabled'    =>    'char', 'NULL',       1, '', '',
3996       ],
3997       'primary_key' => 'carrierid',
3998       'unique'      => [],
3999       'index'       => [],
4000     },
4001
4002     #'cdr_file' => {
4003     #  'columns' => [
4004     #    'filenum',    'serial',     '', '', '', '',
4005     #    'filename',  'varchar',     '', '', '', '',
4006     #    'status',    'varchar', 'NULL', '', '', '',
4007     #  ],
4008     #  'primary_key' => 'filenum',
4009     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
4010     #                                   # agent-virtualize or have a customer
4011     #                                   # with dup-filename needs or something
4012     #                                   # (only used by cdr.http_and_import for
4013     #                                   #  chrissakes)
4014     #  'index'  => [],
4015     #},
4016
4017     'inventory_item' => {
4018       'columns' => [
4019         'itemnum',   'serial',      '',      '', '', '',
4020         'classnum',  'int',         '',      '', '', '',
4021         'agentnum',  'int',     'NULL',      '', '', '',
4022         'item',      'varchar',     '', $char_d, '', '',
4023         'svcnum',    'int',     'NULL',      '', '', '',
4024         'svc_field', 'varchar', 'NULL', $char_d, '', '',
4025       ],
4026       'primary_key' => 'itemnum',
4027       'unique' => [ [ 'classnum', 'item' ] ],
4028       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
4029     },
4030
4031     'inventory_class' => {
4032       'columns' => [
4033         'classnum',  'serial',       '',      '', '', '',
4034         'classname', 'varchar',      '', $char_d, '', '',
4035       ],
4036       'primary_key' => 'classnum',
4037       'unique' => [],
4038       'index'  => [],
4039     },
4040
4041     'access_user_session' => {
4042       'columns' => [
4043         'sessionnum',   'serial',  '',      '', '', '',
4044         'sessionkey',  'varchar',  '', $char_d, '', '',
4045         'usernum',         'int',  '',      '', '', '',
4046         'start_date', @date_type,               '', '',
4047         'last_date',  @date_type,               '', '',
4048       ],
4049       'primary_key' => 'sessionnum',
4050       'unique' => [ [ 'sessionkey' ] ],
4051       'index'  => [],
4052     },
4053
4054     'access_user' => {
4055       'columns' => [
4056         'usernum',            'serial',      '',      '', '', '',
4057         'username',           'varchar',     '', $char_d, '', '',
4058         '_password',          'varchar',     '', $char_d, '', '',
4059         'last',               'varchar',     '', $char_d, '', '',
4060         'first',              'varchar',     '', $char_d, '', '',
4061         'user_custnum',           'int', 'NULL',      '', '', '',
4062         'report_salesnum',        'int', 'NULL',      '', '', '',
4063         'disabled',              'char', 'NULL',       1, '', '',
4064       ],
4065       'primary_key' => 'usernum',
4066       'unique' => [ [ 'username' ] ],
4067       'index'  => [ [ 'user_custnum' ] ],
4068     },
4069
4070     'access_user_pref' => {
4071       'columns' => [
4072         'prefnum',    'serial',       '', '', '', '',
4073         'usernum',     'int',       '', '', '', '',
4074         'prefname', 'varchar', '', $char_d, '', '',
4075         'prefvalue', 'text', 'NULL', '', '', '',
4076         'expiration', @date_type, '', '',
4077       ],
4078       'primary_key' => 'prefnum',
4079       'unique' => [],
4080       'index'  => [ [ 'usernum' ] ],
4081     },
4082
4083     'access_group' => {
4084       'columns' => [
4085         'groupnum',   'serial', '',      '', '', '',
4086         'groupname', 'varchar', '', $char_d, '', '',
4087       ],
4088       'primary_key' => 'groupnum',
4089       'unique' => [ [ 'groupname' ] ],
4090       'index'  => [],
4091     },
4092
4093     'access_usergroup' => {
4094       'columns' => [
4095         'usergroupnum', 'serial', '', '', '', '',
4096         'usernum',         'int', '', '', '', '',
4097         'groupnum',        'int', '', '', '', '',
4098       ],
4099       'primary_key' => 'usergroupnum',
4100       'unique' => [ [ 'usernum', 'groupnum' ] ],
4101       'index'  => [ [ 'usernum' ] ],
4102     },
4103
4104     'access_groupagent' => {
4105       'columns' => [
4106         'groupagentnum', 'serial', '', '', '', '',
4107         'groupnum',         'int', '', '', '', '',
4108         'agentnum',         'int', '', '', '', '',
4109       ],
4110       'primary_key' => 'groupagentnum',
4111       'unique' => [ [ 'groupnum', 'agentnum' ] ],
4112       'index'  => [ [ 'groupnum' ] ],
4113     },
4114
4115     'access_right' => {
4116       'columns' => [
4117         'rightnum',   'serial', '',      '', '', '',
4118         'righttype', 'varchar', '', $char_d, '', '',
4119         'rightobjnum',   'int', '',      '', '', '',
4120         'rightname', 'varchar', '', $char_d, '', '',
4121       ],
4122       'primary_key' => 'rightnum',
4123       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
4124       'index'  => [],
4125     },
4126
4127     'access_user_log' => {
4128       'columns'      => [
4129         'lognum',  'serial', '',        '', '', '',
4130         'usernum',    'int', '',        '', '', '',
4131         'path',   'varchar', '', 2*$char_d, '', '',
4132         '_date',         @date_type,        '', '',
4133       ],
4134       'primary_key'  => 'lognum',
4135       'unique'       => [],
4136       'index'        => [ ['usernum'], ['path'], ['_date'] ],
4137     },
4138
4139     'access_user_page_pref' => {
4140       'columns'     => [
4141         'prefnum'     =>  'serial',     '',      '', '', '',
4142         'usernum'     =>     'int',     '',      '', '', '',
4143         'path'        =>    'text',     '',      '', '', '',
4144         'tablenum'    =>     'int', 'NULL',      '', '', '',
4145         '_date'       =>    @date_type,              '', '',
4146         'prefname'    =>    'varchar',  '', $char_d, '', '',
4147         'prefvalue'   =>    'text',     '',      '', '', '',
4148       ],
4149       'primary_key' => 'prefnum',
4150       'unique'      => [ [ 'usernum', 'path', 'tablenum', 'prefname' ] ],
4151       'index'       => [],
4152       'foreign_keys' => [
4153                           { columns   => [ 'usernum' ],
4154                             table     => 'access_user'
4155                           },
4156                         ],
4157     },
4158
4159     'sched_item' => {
4160       'columns' => [
4161         'itemnum',   'serial',      '', '', '', '',
4162         'usernum',      'int',  'NULL', '', '', '',
4163         #'itemname', 'varchar', $char_d, '', '', '',
4164         'disabled',    'char',  'NULL',  1, '', '',
4165       ],
4166       'primary_key'  => 'itemnum',
4167       'unique'       => [ [ 'usernum' ] ],
4168       'index'        => [],
4169     },
4170
4171     #'sched_item_class'
4172
4173     'sched_avail' => {
4174       'columns' => [
4175         'availnum',      'serial', '', '', '', '',
4176         'itemnum',          'int', '', '', '', '',
4177         'wday',             'int', '', '', '', '',
4178         'stime',            'int', '', '', '', '',
4179         'etime',            'int', '', '', '', '',
4180         'override_date',    @date_type,    '', '',
4181       ],
4182       'primary_key'  => 'availnum',
4183       'unique'       => [],
4184       'index'        => [],
4185     },
4186
4187     'svc_phone' => {
4188       'columns' => [
4189         'svcnum',                         'int',     '',      '', '', '',
4190         'countrycode',                'varchar',     '',       3, '', '',
4191         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
4192         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
4193         'pin',                        'varchar', 'NULL', $char_d, '', '',
4194         'sip_password',               'varchar', 'NULL', $char_d, '', '',
4195         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
4196         'pbxsvc',                         'int', 'NULL',      '', '', '',
4197         'domsvc',                         'int', 'NULL',      '', '', '',
4198         'locationnum',                    'int', 'NULL',      '', '', '',
4199         'forward_svcnum',                 'int', 'NULL',      '', '', '',
4200         'forwarddst',                 'varchar', 'NULL',      15, '', '',
4201         'email',                      'varchar', 'NULL',     255, '', '',
4202         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
4203         'portable',                      'char', 'NULL',       1, '', '',
4204         'lrn',                           'char', 'NULL',      10, '', '',
4205         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
4206         'lnp_due_date',                   'int', 'NULL',      '', '', '',
4207         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
4208         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
4209         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
4210         'sms_carrierid',                  'int', 'NULL',      '', '', '',
4211         'sms_account',                'varchar', 'NULL', $char_d, '', '',
4212         'max_simultaneous',               'int', 'NULL',      '', '', '',
4213         'e911_class',                    'char', 'NULL',       1, '', '',
4214         'e911_type',                     'char', 'NULL',       1, '', '',
4215         'circuit_svcnum',                 'int', 'NULL',      '', '', '',
4216         'sip_server',                 'varchar', 'NULL', $char_d, '', '',
4217       ],
4218       'primary_key' => 'svcnum',
4219       'unique' => [ [ 'sms_carrierid', 'sms_account'] ],
4220       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
4221                     ['locationnum'], ['sms_carrierid'],
4222                   ],
4223     },
4224
4225     'phone_device' => {
4226       'columns' => [
4227         'devicenum', 'serial',     '', '', '', '',
4228         'devicepart',   'int',     '', '', '', '',
4229         'svcnum',       'int',     '', '', '', '',
4230         'mac_addr', 'varchar', 'NULL', 12, '', '',
4231       ],
4232       'primary_key' => 'devicenum',
4233       'unique' => [ [ 'mac_addr' ], ],
4234       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
4235     },
4236
4237     'part_device' => {
4238       'columns' => [
4239         'devicepart', 'serial',  '',      '', '', '',
4240         'devicename', 'varchar', '', $char_d, '', '',
4241         'inventory_classnum', 'int', 'NULL', '', '', '',
4242         'title',      'varchar', 'NULL', $char_d, '', '',
4243       ],
4244       'primary_key' => 'devicepart',
4245       'unique' => [ [ 'devicename' ] ], #?
4246       'index'  => [],
4247     },
4248
4249     'phone_avail' => {
4250       'columns' => [
4251         'availnum',    'serial',      '',      '', '', '',
4252         'exportnum',   'int',         '',      '', '', '',
4253         'countrycode', 'varchar',     '',       3, '', '',
4254         'state',       'char',    'NULL',       2, '', '',
4255         'npa',         'char',        '',       3, '', '',
4256         'nxx',         'char',    'NULL',       3, '', '',
4257         'station',     'char',    'NULL',       4, '', '',
4258         'name',        'varchar', 'NULL', $char_d, '', '',
4259         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
4260         'latanum',      'int',     'NULL',      '', '', '',
4261         'msanum',       'int', 'NULL', '', '', '',
4262         'ordernum',      'int',     'NULL',      '', '', '',
4263         'svcnum',      'int',     'NULL',      '', '', '',
4264         'availbatch', 'varchar',  'NULL', $char_d, '', '',
4265       ],
4266       'primary_key' => 'availnum',
4267       'unique' => [],
4268       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
4269                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
4270                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
4271                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
4272                     [ 'svcnum' ],
4273                     [ 'availbatch' ],
4274                     [ 'latanum' ],
4275                   ],
4276     },
4277
4278     'lata' => {
4279       'columns' => [
4280         'latanum',    'int',      '',      '', '', '',
4281         'description',   'varchar',    '',      $char_d, '', '',
4282         'have_usage',   'int',    'NULL',      '', '', '',
4283       ],
4284       'primary_key' => 'latanum',
4285       'unique' => [],
4286       'index'  => [],
4287     },
4288
4289     'msa' => {
4290       'columns' => [
4291         'msanum',    'int',      '',      '', '', '',
4292         'description',   'varchar',    '',      $char_d, '', '',
4293       ],
4294       'primary_key' => 'msanum',
4295       'unique' => [],
4296       'index'  => [],
4297     },
4298
4299     'rate_center' => {
4300       'columns' => [
4301         'ratecenternum',    'serial',      '',      '', '', '',
4302         'description',   'varchar',    '',      $char_d, '', '',
4303       ],
4304       'primary_key' => 'ratecenternum',
4305       'unique' => [],
4306       'index'  => [],
4307     },
4308
4309     'did_vendor' => {
4310       'columns' => [
4311         'vendornum',    'serial',      '',      '', '', '',
4312         'vendorname',   'varchar',        '',     $char_d, '', '',
4313       ],
4314       'primary_key' => 'vendornum',
4315       'unique' => [],
4316       'index'  => [],
4317     },
4318
4319     'did_order_item' => {
4320       'columns' => [
4321         'orderitemnum',    'serial',      '',      '', '', '',
4322         'ordernum',    'int',      '',      '', '', '',
4323         'msanum',      'int',     'NULL',      '', '', '',
4324         'npa',      'int',     'NULL',      '', '', '',
4325         'latanum',      'int',     'NULL',      '', '', '',
4326         'ratecenternum',      'int',     'NULL',      '', '', '',
4327         'state',       'char',    'NULL',       2, '', '',
4328         'quantity',      'int',     '',      '', '', '',
4329         'custnum',   'int', 'NULL', '', '', '',
4330       ],
4331       'primary_key' => 'orderitemnum',
4332       'unique' => [],
4333       'index'  => [],
4334     },
4335
4336     'did_order' => {
4337       'columns' => [
4338         'ordernum',    'serial',      '',      '', '', '',
4339         'vendornum',   'int',       '',      '', '', '',
4340         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
4341         'custnum',   'int', 'NULL', '', '', '',
4342         'submitted',      'int',     '',      '', '', '',
4343         'confirmed',      'int',     'NULL',      '', '', '',
4344         'received',      'int',     'NULL',      '', '', '',
4345       ],
4346       'primary_key' => 'ordernum',
4347       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
4348       'index'  => [],
4349     },
4350
4351     'reason_type' => {
4352       'columns' => [
4353         'typenum',   'serial',  '', '', '', '',
4354         'class',     'char', '', 1, '', '',
4355         'type',     'varchar', '', $char_d, '', '',
4356       ],
4357       'primary_key' => 'typenum',
4358       'unique' => [],
4359       'index' => [],
4360     },
4361
4362     'reason' => {
4363       'columns' => [
4364         'reasonnum',     'serial',  '', '', '', '',
4365         'reason_type',   'int',  '', '', '', '',
4366         'reason',        'text', '', '', '', '',
4367         'disabled',      'char',    'NULL', 1, '', '',
4368         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
4369         'unsuspend_hold','char',    'NULL', 1, '', '',
4370         'unused_credit', 'char',    'NULL', 1, '', '',
4371         'feepart',        'int', 'NULL', '', '', '',
4372         'fee_on_unsuspend','char',  'NULL', 1, '', '',
4373         'fee_hold',      'char',    'NULL', 1, '', '',
4374       ],
4375       'primary_key' => 'reasonnum',
4376       'unique' => [],
4377       'index' => [],
4378     },
4379
4380     'conf' => {
4381       'columns' => [
4382         'confnum',  'serial',     '',      '', '', '',
4383         'agentnum', 'int',    'NULL',      '', '', '',
4384         'locale',   'varchar','NULL',      16, '', '',
4385         'name',     'varchar',    '', $char_d, '', '',
4386         'value',    'text',   'NULL',      '', '', '',
4387       ],
4388       'primary_key' => 'confnum',
4389       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
4390       'index' => [],
4391     },
4392
4393     'pkg_referral' => {
4394       'columns' => [
4395         'pkgrefnum',     'serial', '', '', '', '',
4396         'pkgnum',        'int',    '', '', '', '',
4397         'refnum',        'int',    '', '', '', '',
4398       ],
4399       'primary_key' => 'pkgrefnum',
4400       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
4401       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
4402     },
4403
4404     'svc_pbx' => {
4405       'columns' => [
4406         'svcnum',           'int',     '',      '', '', '',
4407         'id',               'int', 'NULL',      '', '', '',
4408         'uuid',            'char', 'NULL',      36, '', '',
4409         'title',        'varchar', 'NULL', $char_d, '', '',
4410         'max_extensions',   'int', 'NULL',      '', '', '',
4411         'max_simultaneous', 'int', 'NULL',      '', '', '',
4412         'ip_addr',      'varchar', 'NULL',      40, '', '',
4413       ],
4414       'primary_key' => 'svcnum',
4415       'unique' => [],
4416       'index'  => [ [ 'id' ], [ 'uuid' ] ],
4417     },
4418
4419     'pbx_extension' => {
4420       'columns' => [
4421         'extensionnum',  'serial',     '',      '', '', '',
4422         'svcnum',           'int',     '',      '', '', '',
4423         'extension',    'varchar',     '', $char_d, '', '',
4424         'pin',          'varchar', 'NULL', $char_d, '', '',
4425         'sip_password', 'varchar', 'NULL', $char_d, '', '',
4426         'phone_name',   'varchar', 'NULL', $char_d, '', '',
4427       ],
4428       'primary_key'  => 'extensionnum',
4429       'unique'       => [ [ 'svcnum', 'extension' ] ],
4430       'index'        => [ [ 'svcnum' ] ],
4431     },
4432
4433     'svc_mailinglist' => { #svc_group?
4434       'columns' => [
4435         'svcnum',            'int',     '',            '', '', '',
4436         'username',      'varchar',     '', $username_len, '', '',
4437         'domsvc',            'int',     '',            '', '', '',
4438         'listnum',           'int',     '',            '', '', '',
4439         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
4440         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
4441         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
4442         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
4443       ],
4444       'primary_key' => 'svcnum',
4445       'unique' => [],
4446       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
4447     },
4448
4449     'mailinglist' => {
4450       'columns' => [
4451         'listnum',   'serial', '',      '', '', '',
4452         'listname', 'varchar', '', $char_d, '', '',
4453       ],
4454       'primary_key' => 'listnum',
4455       'unique' => [],
4456       'index'  => [],
4457     },
4458
4459     'mailinglistmember' => {
4460       'columns' => [
4461         'membernum',        'serial',     '',   '', '', '',
4462         'listnum',             'int',     '',   '', '', '',
4463         'svcnum',              'int', 'NULL',   '', '', '',
4464         'contactemailnum',     'int', 'NULL',   '', '', '',
4465         'email',           'varchar', 'NULL',  255, '', '',
4466       ],
4467       'primary_key' => 'membernum',
4468       'unique'      => [],
4469       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
4470     },
4471
4472     'bill_batch' => {
4473       'columns' => [
4474         'batchnum',         'serial',     '',  '', '', '',
4475         'agentnum',            'int', 'NULL',  '', '', '',
4476         'status',             'char', 'NULL', '1', '', '',
4477         'pdf',                'blob', 'NULL',  '', '', '',
4478       ],
4479       'primary_key' => 'batchnum',
4480       'unique'      => [],
4481       'index'       => [ ['agentnum'] ],
4482     },
4483
4484     'cust_bill_batch' => {
4485       'columns' => [
4486         'billbatchnum',     'serial',     '', '', '', '',
4487         'batchnum',            'int',     '', '', '', '',
4488         'invnum',              'int',     '', '', '', '',
4489       ],
4490       'primary_key' => 'billbatchnum',
4491       'unique'      => [],
4492       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
4493     },
4494
4495     'cust_bill_batch_option' => {
4496       'columns' => [
4497         'optionnum', 'serial', '', '', '', '',
4498         'billbatchnum', 'int', '', '', '', '',
4499         'optionname', 'varchar', '', $char_d, '', '',
4500         'optionvalue', 'text', 'NULL', '', '', '',
4501       ],
4502       'primary_key' => 'optionnum',
4503       'unique'      => [],
4504       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
4505     },
4506
4507     'msg_template' => {
4508       'columns' => [
4509         'msgnum',     'serial',     '',      '', '', '',
4510         'msgname',   'varchar',     '', $char_d, '', '',
4511         'agentnum',      'int', 'NULL',      '', '', '',
4512         'subject',   'varchar', 'NULL',     512, '', '',
4513         'mime_type', 'varchar',     '', $char_d, '', '',
4514         'body',         'blob', 'NULL',      '', '', '',
4515         'disabled',     'char', 'NULL',       1, '', '',
4516         'from_addr', 'varchar', 'NULL',     255, '', '',
4517         'bcc_addr',  'varchar', 'NULL',     255, '', '',
4518       ],
4519       'primary_key' => 'msgnum',
4520       'unique'      => [ ],
4521       'index'       => [ ['agentnum'], ],
4522     },
4523
4524     'template_content' => {
4525       'columns' => [
4526         'contentnum', 'serial',     '',      '', '', '',
4527         'msgnum',        'int',     '',      '', '', '',
4528         'locale',    'varchar', 'NULL',      16, '', '',
4529         'subject',   'varchar', 'NULL',     512, '', '',
4530         'body',         'text', 'NULL',      '', '', '',
4531       ],
4532       'primary_key' => 'contentnum',
4533       'unique'      => [ ['msgnum', 'locale'] ],
4534       'index'       => [ ],
4535     },
4536
4537     'cust_msg' => {
4538       'columns' => [
4539         'custmsgnum', 'serial',     '',     '', '', '',
4540         'custnum',       'int', 'NULL',     '', '', '',
4541         'msgnum',        'int', 'NULL',     '', '', '',
4542         '_date',    @date_type,                 '', '',
4543         'env_from',  'varchar', 'NULL',    255, '', '',
4544         'env_to',    'varchar', 'NULL',    255, '', '',
4545         'header',       'blob', 'NULL',     '', '', '',
4546         'body',         'blob', 'NULL',     '', '', '',
4547         'error',     'varchar', 'NULL',    255, '', '',
4548         'status',    'varchar',     '',$char_d, '', '',
4549         'msgtype',   'varchar', 'NULL',     16, '', '',
4550       ],
4551       'primary_key' => 'custmsgnum',
4552       'unique'      => [ ],
4553       'index'       => [ ['custnum'], ],
4554     },
4555
4556     'svc_cert' => {
4557       'columns' => [
4558         'svcnum',                'int',     '',      '', '', '',
4559         'recnum',                'int', 'NULL',      '', '', '',
4560         'privatekey',           'text', 'NULL',      '', '', '',
4561         'csr',                  'text', 'NULL',      '', '', '',
4562         'certificate',          'text', 'NULL',      '', '', '',
4563         'cacert',               'text', 'NULL',      '', '', '',
4564         'common_name',       'varchar', 'NULL', $char_d, '', '',
4565         'organization',      'varchar', 'NULL', $char_d, '', '',
4566         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
4567         'city',              'varchar', 'NULL', $char_d, '', '',
4568         'state',             'varchar', 'NULL', $char_d, '', '',
4569         'country',              'char', 'NULL',       2, '', '',
4570         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
4571       ],
4572       'primary_key' => 'svcnum',
4573       'unique' => [],
4574       'index'  => [], #recnum
4575     },
4576
4577     'svc_port' => {
4578       'columns' => [
4579         'svcnum',                'int',     '',      '', '', '',
4580         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
4581       ],
4582       'primary_key' => 'svcnum',
4583       'unique' => [],
4584       'index'  => [], #recnum
4585     },
4586
4587     'areacode'  => {
4588       'columns' => [
4589         'areanum',   'serial',        '',      '', '', '',
4590         'code',        'char',        '',       3, '', '',
4591         'country',     'char',    'NULL',       2, '', '',
4592         'state',       'char',    'NULL',       2, '', '',
4593         'description','varchar',  'NULL',     255, '', '',
4594       ],
4595       'primary_key' => 'areanum',
4596       'unique' => [ [ 'areanum' ] ],
4597       'index'  => [],
4598     },
4599
4600     'upgrade_journal' => {
4601       'columns' => [
4602         'upgradenum', 'serial', '', '', '', '',
4603         '_date', 'int', '', '', '', '',
4604         'upgrade', 'varchar', '', $char_d, '', '',
4605         'status', 'varchar', '', $char_d, '', '',
4606         'statustext', 'varchar', 'NULL', $char_d, '', '',
4607       ],
4608       'primary_key' => 'upgradenum',
4609       'unique' => [],
4610       'index' => [ [ 'upgrade' ] ],
4611     },
4612
4613     'upload_target' => {
4614       'columns' => [
4615         'targetnum', 'serial', '', '', '', '',
4616         'agentnum', 'int', 'NULL', '', '', '',
4617         'protocol', 'varchar', '', 10, '', '',
4618         'hostname', 'varchar', '', $char_d, '', '',
4619         'port', 'int', 'NULL', '', '', '',
4620         'username', 'varchar', '', $char_d, '', '',
4621         'password', 'varchar', 'NULL', $char_d, '', '',
4622         'path', 'varchar', 'NULL', $char_d, '', '',
4623         'subject', 'varchar', 'NULL', '255', '', '',
4624         'handling', 'varchar', 'NULL', $char_d, '', '',
4625       ],
4626       'primary_key' => 'targetnum',
4627       'unique' => [ [ 'targetnum' ] ],
4628       'index' => [],
4629     },
4630
4631     'log' => {
4632       'columns' => [
4633         'lognum',     'serial', '', '', '', '',
4634         '_date',      'int', '', '', '', '',
4635         'agentnum',   'int', 'NULL', '', '', '',
4636         'tablename',  'varchar', 'NULL', $char_d, '', '',
4637         'tablenum',   'int',  'NULL', '', '', '',
4638         'level',      'int',  '', '', '', '',
4639         'message',    'text', '', '', '', '',
4640       ],
4641       'primary_key' => 'lognum',
4642       'unique'      => [],
4643       'index'       => [ ['_date'], ['level'] ],
4644     },
4645
4646     'log_context' => {
4647       'columns' => [
4648         'logcontextnum', 'serial', '', '', '', '',
4649         'lognum', 'int', '', '', '', '',
4650         'context', 'varchar', '', $char_d, '', '',
4651       ],
4652       'primary_key' => 'logcontextnum',
4653       'unique' => [ [ 'lognum', 'context' ] ],
4654       'index' => [],
4655     },
4656
4657     'svc_alarm' => {
4658       'columns' => [
4659 #       name               type        null   length   default local
4660         'svcnum',          'int',      '',    '',      '',     '',
4661         'alarmsystemnum',  'int',      '',    '',      '',     '',
4662         'alarmtypenum',    'int',      '',    '',      '',     '',
4663         'alarmstationnum', 'int',      '',    '',      '',     '',
4664         'acctnum',         'varchar',  '',    $char_d, '',     '',
4665         '_password',       'varchar',  '',    $char_d, '',     '',
4666         'location',        'varchar', 'NULL', $char_d, '',     '',
4667         'cs_receiver',     'int',     'NULL', '',      '',     '',
4668         'cs_phonenum',     'varchar', 'NULL', $char_d, '',     '',
4669         'serialnum',       'varchar', 'NULL', $char_d, '',     '',
4670         #installer (rep)
4671       ],
4672       'primary_key' => 'svcnum',
4673       'unique' => [],
4674       'index'  => [],
4675     },
4676
4677     'alarm_system' => { #vendors
4678       'columns' => [
4679         'alarmsystemnum',  'serial',     '',      '', '', '',
4680         'agentnum',           'int', 'NULL',      '', '', '',
4681         'systemname',     'varchar',     '', $char_d, '', '',
4682         'disabled',          'char', 'NULL',       1, '', '',
4683       ],
4684       'primary_key' => 'alarmsystemnum',
4685       'unique'      => [ ['agentnum', 'systemname'] ],
4686       'index'       => [ ['agentnum'], ['disabled'] ],
4687     },
4688
4689     'alarm_type' => { #inputs and outputs
4690       'columns' => [
4691         'alarmtypenum', 'serial',     '',      '', '', '',
4692         'agentnum',        'int', 'NULL',      '', '', '',
4693         'inputs',          'int',     '', '', '', '',
4694         'outputs',         'int',     '', '', '', '',
4695         'disabled',       'char', 'NULL',       1, '', '',
4696       ],
4697       'primary_key' => 'alarmtypenum',
4698       'unique'      => [ ['agentnum', 'inputs', 'outputs'] ],
4699       'index'       => [ ['agentnum'], ['disabled'] ],
4700     },
4701
4702     'alarm_station' => { #central station (where the alarm reports to)
4703       'columns' => [
4704         'alarmstationnum', 'serial',     '',      '', '', '',
4705         'agentnum',           'int', 'NULL',      '', '', '',
4706         'stationname',    'varchar',     '', $char_d, '', '',
4707         'disabled',          'char', 'NULL',       1, '', '',
4708       ],
4709       'primary_key' => 'alarmstationnum',
4710       'unique'      => [ ['agentnum', 'stationname'], ],
4711       'index'       => [ ['agentnum'], ['disabled'] ],
4712     },
4713
4714     'svc_cable' => {
4715       'columns' => [
4716         'svcnum',        'int',     '',      '', '', '',
4717         'providernum',   'int', 'NULL',      '', '', '',
4718         'ordernum',  'varchar', 'NULL', $char_d, '', '',
4719         'modelnum',      'int', 'NULL',      '', '', '',
4720         'serialnum', 'varchar', 'NULL', $char_d, '', '',
4721         'mac_addr',  'varchar', 'NULL',      12, '', '',
4722       ],
4723       'primary_key' => 'svcnum',
4724       'unique'       => [ ['serialnum'] , ['mac_addr'] ],
4725       'index'  => [],
4726     },
4727
4728     'cable_model' => {
4729       'columns' => [
4730         'modelnum',    'serial',     '',      '', '', '',
4731         'model_name', 'varchar',     '', $char_d, '', '',
4732         'disabled',      'char', 'NULL',       1, '', '',
4733       ],
4734       'primary_key' => 'modelnum',
4735       'unique' => [ [ 'model_name' ], ],
4736       'index'  => [],
4737     },
4738
4739     'cable_provider' => {
4740       'columns' => [
4741         'providernum', 'serial',     '',      '', '', '',
4742         'provider',   'varchar',     '', $char_d, '', '',
4743         'disabled',      'char', 'NULL',       1, '', '',
4744       ],
4745       'primary_key' => 'providernum',
4746       'unique' => [ [ 'provider' ], ],
4747       'index'  => [],
4748     },
4749
4750     'circuit_type' => {
4751       'columns' => [
4752         'typenum',     'serial',     '',      '', '', '',
4753         'typename',   'varchar',     '', $char_d, '', '',
4754         'disabled',      'char', 'NULL',       1, '', '',
4755         # speed? number of voice lines? anything else?
4756       ],
4757       'primary_key' => 'typenum',
4758       'unique' => [ [ 'typename' ] ],
4759       'index'  => [],
4760     },
4761
4762     'circuit_provider' => {
4763       'columns' => [
4764         'providernum', 'serial',     '',      '', '', '',
4765         'provider',   'varchar',     '', $char_d, '', '',
4766         'disabled',      'char', 'NULL',       1, '', '',
4767       ],
4768       'primary_key' => 'providernum',
4769       'unique' => [ [ 'provider' ], ],
4770       'index'  => [],
4771     },
4772
4773     'circuit_termination' => {
4774       'columns' => [
4775         'termnum',     'serial',     '',      '', '', '',
4776         'termination','varchar',     '', $char_d, '', '',
4777         'disabled',      'char', 'NULL',       1, '', '',
4778       ],
4779       'primary_key' => 'termnum',
4780       'unique' => [ [ 'termination' ] ],
4781       'index' => [],
4782     },
4783
4784     'svc_circuit' => {
4785       'columns' => [
4786         'svcnum',                   'int',     '', '', '', '',
4787         'typenum',                  'int',     '', '', '', '',
4788         'providernum',              'int',     '', '', '', '',
4789         'termnum',                  'int',     '', '', '', '',
4790         'circuit_id',           'varchar',     '', 64, '', '',
4791         'desired_due_date',         'int', 'NULL', '', '', '',
4792         'due_date',                 'int', 'NULL', '', '', '',
4793         'vendor_order_id',      'varchar', 'NULL', $char_d,  '', '',
4794         'vendor_qual_id',       'varchar', 'NULL', $char_d,  '', '',
4795         'vendor_order_type',    'varchar', 'NULL', $char_d,  '', '',
4796         'vendor_order_status',  'varchar', 'NULL', $char_d,  '', '',
4797         'endpoint_ip_addr',     'varchar', 'NULL', 40, '', '',
4798         'endpoint_mac_addr',    'varchar', 'NULL', 12, '', '',
4799         'internal_circuit_id',  'varchar', 'NULL', 64, '', '',
4800       ],
4801       'primary_key' => 'svcnum',
4802       'unique'      => [],
4803       'index'       => [ [ 'providernum' ], [ 'typenum' ] ],
4804     },
4805
4806     'svc_fiber' => {
4807       'columns' => [
4808         'svcnum',         'int',     '',      '', '', '',
4809         'oltnum',         'int', 'NULL',      '', '', '',
4810         'shelf',          'int', 'NULL',      '', '', '',
4811         'card',           'int', 'NULL',      '', '', '',
4812         'olt_port',       'int', 'NULL',      '', '', '',
4813         'ont_id',         'int', 'NULL',      '', '', '',
4814         'ont_typenum',    'int', 'NULL',      '', '', '',
4815         'ont_serial', 'varchar', 'NULL', $char_d, '', '',
4816         'ont_port',   'varchar', 'NULL',      16, '', '',
4817         'circuit_id', 'varchar', 'NULL', $char_d, '', '',
4818         'vlan',           'int', 'NULL',      '', '', '',
4819         'signal',     'decimal', 'NULL',  '10,2', '', '',
4820         'speed_up',       'int', 'NULL',      '', '', '',
4821         'speed_down',     'int', 'NULL',      '', '', '',
4822         'ont_install','varchar', 'NULL', $char_d, '', '',
4823       ],
4824       'primary_key' => 'svcnum',
4825       'unique'      => [ ],
4826       'index'       => [ [ 'ont_serial' ] ],
4827     },
4828
4829     'fiber_olt' => {
4830       'columns' => [
4831         'oltnum',   'serial', '',       '', '', '',
4832         'oltname', 'varchar', '',  $char_d, '', '',
4833         'sitenum',     'int', 'NULL',   '', '', '',
4834         'serial',  'varchar', '',  $char_d, '', '',
4835         'disabled',   'char', 'NULL',    1, '', '',
4836       ],
4837       'primary_key' => 'oltnum',
4838       'unique' => [ ],
4839       'index'  => [ ],
4840       'foreign_keys' => [
4841                           { columns => [ 'sitenum' ],
4842                             table   => 'olt_site',
4843                           },
4844                         ],
4845     },
4846
4847     'olt_site' => {
4848       'columns' => [
4849         'sitenum',  'serial', '',      '', '', '',
4850         'market',  'varchar', '', $char_d, '', '',
4851         'site',    'varchar', '', $char_d, '', '',
4852       ],
4853       'primary_key' => 'sitenum',
4854       'unique' => [ [ 'market', 'site' ] ],
4855       'index' => [ ],
4856     },
4857
4858
4859
4860
4861
4862     'vend_main' => {
4863       'columns' => [
4864         'vendnum',   'serial',     '',      '', '', '',
4865         'vendname', 'varchar',     '', $char_d, '', '',
4866         'classnum',     'int',     '',      '', '', '',
4867         'disabled',    'char', 'NULL',       1, '', '',
4868       ],
4869       'primary_key'  => 'vendnum',
4870       'unique'       => [ ['vendname', 'disabled'] ],
4871       'index'        => [],
4872       'foreign_keys' => [
4873                           { columns    => [ 'classnum' ],
4874                             table      => 'vend_class',
4875                           },
4876                         ],
4877     },
4878
4879     'vend_class' => {
4880       'columns' => [
4881         'classnum',     'serial',     '',      '', '', '',
4882         'classname',   'varchar',     '', $char_d, '', '',
4883         'disabled',       'char', 'NULL',       1, '', '',
4884       ],
4885       'primary_key' => 'classnum',
4886       'unique'      => [],
4887       'index'       => [ ['disabled'] ],
4888     },
4889
4890     'vend_bill' => {
4891       'columns' => [
4892         'vendbillnum',    'serial',     '',      '', '', '',
4893         'vendnum',           'int',     '',      '', '', '',
4894         #'_date',        @date_type,                  '', '',
4895         '_date',     'int', '', '',                   '', '',
4896         'charged',     @money_type,                  '', '',
4897       ],
4898       'primary_key'  => 'vendbillnum',
4899       'unique'       => [],
4900       'index'        => [ ['vendnum'], ['_date'], ],
4901       'foreign_keys' => [
4902                           { columns    => [ 'vendnum' ],
4903                             table      => 'vend_main',
4904                           },
4905                         ],
4906     },
4907
4908     'vend_pay' => {
4909       'columns' => [
4910         'vendpaynum',   'serial',    '',       '', '', '',
4911         'vendnum',         'int',    '',       '', '', '',
4912         #'_date',     @date_type,                   '', '',
4913         '_date',     'int', '', '',                   '', '',
4914         'paid',      @money_type,                  '', '',
4915       ],
4916       'primary_key'  => 'vendpaynum',
4917       'unique'       => [],
4918       'index'        => [ [ 'vendnum' ], [ '_date' ], ],
4919       'foreign_keys' => [
4920                           { columns    => [ 'vendnum' ],
4921                             table      => 'vend_main',
4922                           },
4923                         ],
4924     },
4925
4926     'vend_bill_pay' => {
4927       'columns' => [
4928         'vendbillpaynum', 'serial',     '',   '', '', '',
4929         'vendbillnum',       'int',     '',   '', '', '',
4930         'vendpaynum',        'int',     '',   '', '', '',
4931         'amount',  @money_type, '', '',
4932         #? '_date',   @date_type, '', '',
4933       ],
4934       'primary_key'  => 'vendbillpaynum',
4935       'unique'       => [],
4936       'index'        => [ [ 'vendbillnum' ], [ 'vendpaynum' ] ],
4937       'foreign_keys' => [
4938                           { columns    => [ 'vendbillnum' ],
4939                             table      => 'vend_bill',
4940                           },
4941                           { columns    => [ 'vendpaynum' ],
4942                             table      => 'vend_pay',
4943                           },
4944                         ],
4945     },
4946     %{ tables_hashref_torrus() },
4947
4948     # tables of ours for doing torrus virtual port combining
4949     'torrus_srvderive' => {
4950       'columns' => [
4951         'derivenum',     'serial',     '', '', '', '',
4952         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
4953         'last_srv_date',   'date', 'NULL', '', '', '',
4954       ],
4955       'primary_key' => 'derivenum',
4956       'unique' => [ ['serviceid'] ],
4957       'index'  => [],
4958     },
4959
4960     'torrus_srvderive_component' => {
4961       'columns' => [
4962         'componentnum', 'serial', '', '', '', '',
4963         'derivenum',       'int', '', '', '', '',
4964         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
4965       ],
4966       'primary_key' => 'componentnum',
4967       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
4968       'index'       => [ [ 'derivenum', ], ],
4969     },
4970
4971     'invoice_mode' => {
4972       'columns' => [
4973         'modenum',      'serial', '', '', '', '',
4974         'agentnum',        'int', 'NULL', '', '', '',
4975         'modename',    'varchar', '', 32, '', '',
4976       ],
4977       'primary_key' => 'modenum',
4978       'unique'      => [ ],
4979       'index'       => [ ],
4980     },
4981
4982     'invoice_conf' => {
4983       'columns' => [
4984         'confnum',              'serial',   '', '', '', '',
4985         'modenum',              'int',      '', '', '', '',
4986         'locale',               'varchar',  'NULL', 16, '', '',
4987         'notice_name',          'varchar',  'NULL', 64, '', '',
4988         'subject',              'varchar',  'NULL', 64, '', '',
4989         'htmlnotes',            'text',     'NULL', '', '', '',
4990         'htmlfooter',           'text',     'NULL', '', '', '',
4991         'htmlsummary',          'text',     'NULL', '', '', '',
4992         'htmlreturnaddress',    'text',     'NULL', '', '', '',
4993         'latexnotes',           'text',     'NULL', '', '', '',
4994         'latexfooter',          'text',     'NULL', '', '', '',
4995         'latexsummary',         'text',     'NULL', '', '', '',
4996         'latexsmallfooter',     'text',     'NULL', '', '', '',
4997         'latexreturnaddress',   'text',     'NULL', '', '', '',
4998         'with_latexcoupon',     'char',     'NULL', '1', '', '',
4999         'htmlwatermark',        'text',     'NULL', '', '', '',
5000         'latexwatermark',       'text',     'NULL', '', '', '',
5001         'lpr',                  'varchar',  'NULL', $char_d, '', '',
5002       ],
5003       'primary_key' => 'confnum',
5004       'unique' => [ [ 'modenum', 'locale' ] ],
5005       'index'  => [ ],
5006     },
5007
5008     'export_batch' => {
5009       'columns' => [
5010         'batchnum',    'serial',     '',      '', '', '',
5011         'exportnum',      'int',     '',      '', '', '',
5012         '_date',          'int',     '',      '', '', '',
5013         'status',     'varchar', 'NULL',      32, '', '',
5014         'statustext',    'text', 'NULL',      '', '', '',
5015       ],
5016       'primary_key'  => 'batchnum',
5017       'unique'       => [],
5018       'index'        => [ [ 'exportnum' ], [ 'status' ] ],
5019     },
5020
5021     'export_batch_item' => {
5022       'columns' => [
5023         'itemnum',     'serial',     '',      '', '', '',
5024         'batchnum',       'int',     '',      '', '', '',
5025         'svcnum',         'int',     '',      '', '', '',
5026         'action',     'varchar',     '',      32, '', '',
5027         'data',          'text', 'NULL',      '', '', '',
5028         'frozen',        'char', 'NULL',       1, '', '',
5029       ],
5030       'primary_key'  => 'itemnum',
5031       'unique'       => [],
5032       'index'        => [ [ 'batchnum' ], [ 'svcnum' ] ],
5033     },
5034
5035     # lookup table for states, similar to msa and lata
5036     'state' => {
5037       'columns' => [
5038         'statenum', 'int',  '', '', '', '',
5039         'country',  'char', '',  2, '', '',
5040         'state',    'char', '', $char_d, '', '',
5041         'fips',     'char', '',  3, '', '',
5042       ],
5043       'primary_key' => 'statenum',
5044       'unique' => [ [ 'country', 'state' ], ],
5045       'index' => [],
5046     },
5047
5048     # eventually link to tower/sector?
5049     'deploy_zone' => {
5050       'columns' => [
5051         'zonenum',        'serial',  '',     '',      '', '',
5052         'description',    'char',    'NULL', $char_d, '', '',
5053         'agentnum',       'int',     '',     '',      '', '',
5054         'censusyear',     'char',    'NULL', 4,      '', '',
5055         'dbaname',        'char',    'NULL', $char_d, '', '',
5056         'zonetype',       'char',    '',     1,       '', '',
5057         'technology',     'int',     '',     '',      '', '',
5058         'spectrum',       'int',     'NULL', '',      '', '',
5059         'adv_speed_up',   'decimal', '',     '10,3', '0', '',
5060         'adv_speed_down', 'decimal', '',     '10,3', '0', '',
5061         'cir_speed_up',   'decimal', '',     '10,3', '0', '',
5062         'cir_speed_down', 'decimal', '',     '10,3', '0', '',
5063         'is_broadband',   'char',    'NULL', 1,       '', '',
5064         'is_voice',       'char',    'NULL', 1,       '', '',
5065         'is_consumer',    'char',    'NULL', 1,       '', '',
5066         'is_business',    'char',    'NULL', 1,       '', '',
5067         'active_date',    @date_type,                 '', '',
5068         'expire_date',    @date_type,                 '', '',
5069       ],
5070       'primary_key' => 'zonenum',
5071       'unique' => [],
5072       'index'  => [ [ 'agentnum' ] ],
5073     },
5074
5075     'deploy_zone_block' => {
5076       'columns' => [
5077         'blocknum',       'serial',  '',     '',      '', '',
5078         'zonenum',        'int',     '',     '',      '', '',
5079         'censusblock',    'char',    '',     15,      '', '',
5080         'censusyear',     'char','NULL',      4,      '', '',
5081       ],
5082       'primary_key' => 'blocknum',
5083       'unique' => [],
5084       'index'  => [ [ 'zonenum' ] ],
5085     },
5086
5087     'deploy_zone_vertex' => {
5088       'columns' => [
5089         'vertexnum',      'serial',  '',     '',      '', '',
5090         'zonenum',        'int',     '',     '',      '', '',
5091         'latitude',       'decimal', '',     '10,7',  '', '',
5092         'longitude',      'decimal', '',     '10,7',  '', '',
5093       ],
5094       'primary_key' => 'vertexnum',
5095       'unique' => [ ],
5096       'index'  => [ ],
5097     },
5098
5099     'cacti_page' => {
5100       'columns' => [
5101         'cacti_pagenum',  'serial',   '',     '', '', '',
5102         'exportnum',      'int',      'NULL', '', '', '',
5103         'svcnum',         'int',      'NULL', '', '', '',
5104         'graphnum',       'int',      'NULL', '', '', '',
5105         'imported',       @date_type,             '', '',
5106         'content',        'text',     'NULL', '', '', '',
5107         'thumbnail',      'text',     'NULL', '', '', '',
5108       ],
5109       'primary_key' => 'cacti_pagenum',
5110       'unique'  => [ ],
5111       'index'   => [ ['svcnum'], ['imported'] ],
5112     },
5113
5114     'report_batch' => {
5115       'columns' => [
5116         'reportbatchnum', 'serial',      '',  '', '', '',
5117         'reportname',     'varchar',     '', 255, '', '',
5118         'agentnum',           'int', 'NULL',  '', '', '',
5119         'send_date',     @date_type,              '', '',
5120         'sdate',         @date_type,              '', '',
5121         'edate',         @date_type,              '', '',
5122         'usernum',            'int', 'NULL',  '', '', '',
5123         'msgnum',             'int', 'NULL',  '', '', '',
5124         # add report params here as necessary
5125       ],
5126       'primary_key' => 'reportbatchnum',
5127       'unique' => [],
5128       'index'  => [],
5129       'foreign_keys' => [
5130                           { columns    => [ 'agentnum' ],
5131                             table      => 'agent',
5132                             references => [ 'agentnum' ],
5133                           },
5134                           { columns    => [ 'usernum' ],
5135                             table      => 'access_user',
5136                             references => [ 'usernum' ],
5137                           },
5138                           { columns    => [ 'msgnum' ],
5139                             table      => 'msg_template',
5140                             references => [ 'msgnum' ],
5141                           },
5142                         ],
5143     },
5144
5145     'password_history' => {
5146       'columns' => [
5147         'passwordnum',        'serial',  '',          '', '', '',
5148         '_password',          'varchar', 'NULL', $char_d, '', '',
5149         'encryption_method',  'varchar', 'NULL', $char_d, '', '',
5150         'created',   @date_type,   '', '',
5151         # each table that needs password history gets a column here, and
5152         # an entry in foreign_keys.
5153         'svc_acct__svcnum',     'int', 'NULL', '', '', '',
5154         'svc_dsl__svcnum',      'int', 'NULL', '', '', '',
5155         'svc_alarm__svcnum',    'int', 'NULL', '', '', '',
5156         'agent__agentnum',      'int', 'NULL', '', '', '',
5157         'contact__contactnum',  'int', 'NULL', '', '', '',
5158         'access_user__usernum', 'int', 'NULL', '', '', '',
5159       ],
5160       'primary_key' => 'passwordnum',
5161       'unique' => [],
5162       'index'  => [],
5163       'foreign_keys' => [
5164                           { columns     => [ 'svc_acct__svcnum' ],
5165                             table       => 'svc_acct',
5166                             references  => [ 'svcnum' ],
5167                           },
5168                           { columns     => [ 'svc_dsl__svcnum' ],
5169                             table       => 'svc_dsl',
5170                             references  => [ 'svcnum' ],
5171                           },
5172                           { columns     => [ 'svc_alarm__svcnum' ],
5173                             table       => 'svc_alarm',
5174                             references  => [ 'svcnum' ],
5175                           },
5176                           { columns    => [ 'agent__agentnum' ],
5177                             table      => 'agent',
5178                             references => [ 'agentnum' ],
5179                           },
5180                           { columns    => [ 'contact__contactnum' ],
5181                             table      => 'contact',
5182                             references => [ 'contactnum' ],
5183                           },
5184                           { columns    => [ 'access_user__usernum' ],
5185                             table      => 'access_user',
5186                             references => [ 'usernum' ],
5187                           },
5188                         ],
5189     },
5190
5191     'webservice_log' => {
5192       'columns' => [
5193         'webservicelognum',    'serial',      '',      '', '', '', #big? hubrus
5194         'svcnum',                 'int',  'NULL',      '', '', '', #just in case
5195         'custnum',                'int',      '',      '', '', '',
5196         'method',             'varchar',      '', $char_d, '', '',
5197         'quantity',               'int',      '',      '', '', '', #i.e. pages
5198         '_date',             @date_type,                   '', '',
5199         'status',             'varchar',  'NULL', $char_d, '', '',
5200         'rated_price',        'decimal',  'NULL',  '10,2', '', '',
5201       ],
5202       'primary_key'  => 'webservicelognum',
5203       'unique'       => [],
5204       'index'        => [ ['custnum'], ['status'] ],
5205       'foreign_keys' => [
5206                           { columns => [ 'custnum' ],
5207                             table   => 'cust_main',
5208                           },
5209                           #no FK on svcnum... we don't want to purge these on
5210                           # service deletion
5211                         ],
5212     },
5213
5214     'rt_field_charge' => {
5215       'columns' => [
5216         'rtfieldchargenum',    'serial',      '',      '', '', '',
5217         'pkgnum',                 'int',      '',      '', '', '',
5218         'ticketid',               'int',      '',      '', '', '',
5219         'rate',             @money_type,                   '', '',
5220         'units',              'decimal',      '',  '10,4', '', '',
5221         'charge',           @money_type,                   '', '',
5222         '_date',             @date_type,                   '', '',
5223       ],
5224       'primary_key'  => 'rtfieldchargenum',
5225       'unique'       => [],
5226       'index'        => [ ['pkgnum', 'ticketid'] ],
5227       'foreign_keys' => [
5228                           { columns    => [ 'pkgnum' ],
5229                             table      => 'cust_pkg',
5230                           },
5231                         ],
5232     },
5233
5234     'saved_search' => {
5235       'columns' => [
5236         'searchnum',    'serial',  '',          '', '', '',
5237         'usernum',      'int',     'NULL',      '', '', '',
5238         'searchname',   'varchar', '',     $char_d, '', '',
5239         'path',         'varchar', '',     $char_d, '', '',
5240         'params',       'text',    'NULL',      '', '', '',
5241         'disabled',     'char',    'NULL',       1, '', '',
5242         'freq',         'varchar', 'NULL',      16, '', '',
5243         'last_sent',    'int',     'NULL',      '', '', '',
5244         'format',       'varchar', 'NULL',      32, '', '',
5245       ],
5246       'primary_key'   => 'searchnum',
5247       'unique'        => [],
5248       'index'         => [],
5249       'foreign_keys'  => [
5250                            { columns => [ 'usernum' ],
5251                              table   => 'access_user',
5252                            },
5253                          ],
5254     },
5255
5256     # name type nullability length default local
5257
5258     #'new_table' => {
5259     #  'columns' => [
5260     #    'num', 'serial',       '', '', '', '',
5261     #  ],
5262     #  'primary_key' => 'num',
5263     #  'unique' => [],
5264     #  'index'  => [],
5265     #},
5266
5267   };
5268
5269 }
5270
5271 =back
5272
5273 =head1 BUGS
5274
5275 =head1 SEE ALSO
5276
5277 L<DBIx::DBSchema>
5278
5279 =cut
5280
5281 1;
5282