FS/FS/Schema.pm

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