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