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