FS/FS/Schema.pm

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