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