FS/FS/Schema.pm

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