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