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
  11 @ISA = qw(Exporter);
  12 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  13
  14 $DEBUG = 0;
  15 $me = '[FS::Schema]';
  16
  17 =head1 NAME
  18
  19 FS::Schema - Freeside database schema
  20
  21 =head1 SYNOPSYS
  22
  23     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  24
  25     $dbdef = reload_dbdef;
  26     $dbdef = reload_dbdef "/non/standard/filename";
  27     $dbdef = dbdef;
  28     $dbdef_dist = dbdef_dist;
  29
  30 =head1 DESCRIPTION
  31
  32 This class represents the database schema.
  33
  34 =head1 METHODS
  35
  36 =over 4
  37
  38 =item reload_dbdef([FILENAME])
  39
  40 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  41 non-default filename.  This command is executed at startup unless
  42 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  43
  44 =cut
  45
  46 sub reload_dbdef {
  47   my $file = shift;
  48
  49   unless ( exists $dbdef_cache{$file} ) {
  50     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  51     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  52       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  53   } else {
  54     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  55   }
  56   $dbdef = $dbdef_cache{$file};
  57 }
  58
  59 =item dbdef
  60
  61 Returns the current database definition (represents the current database,
  62 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  63
  64 =cut
  65
  66 sub dbdef { $dbdef; }
  67
  68 =item dbdef_dist [ DATASRC ]
  69
  70 Returns the current canoical database definition as defined in this file.
  71
  72 Optionally, pass a DBI data source to enable syntax specific to that database.
  73 Currently, this enables "ENGINE=InnoDB" for MySQL databases.
  74
  75 =cut
  76
  77 sub dbdef_dist {
  78   my $datasrc = @_ ? shift : '';
  79
  80   my $local_options = '';
  81   if ( $datasrc =~ /^dbi:mysql/i ) {
  82     $local_options = 'ENGINE=InnoDB';
  83   }
  84
  85   ###
  86   # create a dbdef object from the old data structure
  87   ###
  88
  89   my $tables_hashref = tables_hashref();
  90
  91   #turn it into objects
  92   my $dbdef = new DBIx::DBSchema map {
  93
  94     my $tablename = $_;
  95     my $indexnum = 1;
  96
  97     my @columns;
  98     while (@{$tables_hashref->{$tablename}{'columns'}}) {
  99       #my($name, $type, $null, $length, $default, $local) =
 100       my @coldef =
 101         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
 102       my %hash = map { $_ => shift @coldef }
 103                      qw( name type null length default local );
 104
 105       #can be removed once we depend on DBIx::DBSchema 0.39;
 106       $hash{'type'} = 'LONGTEXT'
 107         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 108
 109       unless ( defined $hash{'default'} ) {
 110         warn "$tablename:\n".
 111              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 112       }
 113
 114       push @columns, new DBIx::DBSchema::Column ( \%hash );
 115     }
 116
 117     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 118     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 119     my $unique = $tables_hashref->{$tablename}{'unique'};
 120     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
 121     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 122
 123     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 124     #  specification without a key length".
 125     # better solution: teach DBIx::DBSchema to specify a default length for
 126     #  MySQL indices on text columns, or just to support an index length at all
 127     #  so we can pass something in.
 128     # best solution: eliminate need for this index in cust_main::retry_realtime
 129     @index = grep { @{$_}[0] ne 'statustext' } @index
 130       if $datasrc =~ /^dbi:mysql/i;
 131
 132     my @indices = ();
 133     push @indices, map {
 134                          DBIx::DBSchema::Index->new({
 135                            'name'    => $tablename. $indexnum++,
 136                            'unique'  => 1,
 137                            'columns' => $_,
 138                          });
 139                        }
 140                        @$unique;
 141     push @indices, map {
 142                          DBIx::DBSchema::Index->new({
 143                            'name'    => $tablename. $indexnum++,
 144                            'unique'  => 0,
 145                            'columns' => $_,
 146                          });
 147                        }
 148                        @index;
 149
 150     DBIx::DBSchema::Table->new({
 151       'name'          => $tablename,
 152       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 153       'columns'       => \@columns,
 154       'indices'       => \@indices,
 155       'local_options' => $local_options,
 156     });
 157
 158   } keys %$tables_hashref;
 159
 160   if ( $DEBUG ) {
 161     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 162     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 163   }
 164
 165   #add radius attributes to svc_acct
 166   #
 167   #my($svc_acct)=$dbdef->table('svc_acct');
 168   #
 169   #my($attribute);
 170   #foreach $attribute (@attributes) {
 171   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 172   #    'radius_'. $attribute,
 173   #    'varchar',
 174   #    'NULL',
 175   #    $char_d,
 176   #  ));
 177   #}
 178   #
 179   #foreach $attribute (@check_attributes) {
 180   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 181   #    'rc_'. $attribute,
 182   #    'varchar',
 183   #    'NULL',
 184   #    $char_d,
 185   #  ));
 186   #}
 187
 188   my $tables_hashref_torrus = tables_hashref_torrus();
 189
 190   #create history tables
 191   foreach my $table (
 192     grep {    ! /^(clientapi|access_user)_session/
 193            && ! /^h_/
 194            && ! /^log(_context)?$/
 195            && ! $tables_hashref_torrus->{$_}
 196          }
 197       $dbdef->tables
 198   ) {
 199     my $tableobj = $dbdef->table($table)
 200       or die "unknown table $table";
 201
 202     my %h_indices = ();
 203
 204     unless ( $table eq 'cust_event' ) { #others?
 205
 206       my %indices = $tableobj->indices;
 207
 208       %h_indices = map {
 209                          ( "h_$_" =>
 210                              DBIx::DBSchema::Index->new({
 211                                'name'    => 'h_'. $indices{$_}->name,
 212                                'unique'  => 0,
 213                                'columns' => [ @{$indices{$_}->columns} ],
 214                              })
 215                          );
 216                        }
 217                        keys %indices;
 218
 219       $h_indices{"h_${table}_srckey"} =
 220         DBIx::DBSchema::Index->new({
 221           'name'    => "h_${table}_srckey",
 222           'unique'  => 0,
 223           'columns' => [ 'history_action', #right?
 224                          $tableobj->primary_key,
 225                        ],
 226         });
 227
 228       $h_indices{"h_${table}_srckey2"} =
 229          DBIx::DBSchema::Index->new({
 230            'name'    => "h_${table}_srckey2",
 231            'unique'  => 0,
 232            'columns' => [ 'history_date',
 233                           $tableobj->primary_key,
 234                         ],
 235          });
 236
 237     }
 238
 239     my $h_tableobj = DBIx::DBSchema::Table->new( {
 240       'name'          => "h_$table",
 241       'primary_key'   => 'historynum',
 242       'indices'       => \%h_indices,
 243       'local_options' => $local_options,
 244       'columns'       => [
 245           DBIx::DBSchema::Column->new( {
 246             'name'    => 'historynum',
 247             'type'    => 'serial',
 248             'null'    => 'NOT NULL',
 249             'length'  => '',
 250             'default' => '',
 251             'local'   => '',
 252           } ),
 253           DBIx::DBSchema::Column->new( {
 254             'name'    => 'history_date',
 255             'type'    => 'int',
 256             'null'    => 'NULL',
 257             'length'  => '',
 258             'default' => '',
 259             'local'   => '',
 260           } ),
 261           DBIx::DBSchema::Column->new( {
 262             'name'    => 'history_user',
 263             'type'    => 'varchar',
 264             'null'    => 'NOT NULL',
 265             'length'  => '80',
 266             'default' => '',
 267             'local'   => '',
 268           } ),
 269           DBIx::DBSchema::Column->new( {
 270             'name'    => 'history_action',
 271             'type'    => 'varchar',
 272             'null'    => 'NOT NULL',
 273             'length'  => '80',
 274             'default' => '',
 275             'local'   => '',
 276           } ),
 277           map {
 278             my $column = $tableobj->column($_);
 279
 280             #clone so as to not disturb the original
 281             $column = DBIx::DBSchema::Column->new( {
 282               map { $_ => $column->$_() }
 283                 qw( name type null length default local )
 284             } );
 285
 286             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 287               $column->type(uc($1).'INT');
 288               $column->null('NULL');
 289             }
 290             #$column->default('')
 291             #  if $column->default =~ /^nextval\(/i;
 292             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 293             #$column->local($local);
 294             $column;
 295           } $tableobj->columns
 296       ],
 297     } );
 298     $dbdef->addtable($h_tableobj);
 299   }
 300
 301   if ( $datasrc =~ /^dbi:mysql/i ) {
 302
 303     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 304       'name'          => 'duplicate_lock',
 305       'primary_key'   => 'duplocknum',
 306       'local_options' => $local_options,
 307       'columns'       => [
 308         DBIx::DBSchema::Column->new( {
 309           'name'    => 'duplocknum',
 310           'type'    => 'serial',
 311           'null'    => 'NOT NULL',
 312           'length'  => '',
 313           'default' => '',
 314           'local'   => '',
 315         } ),
 316         DBIx::DBSchema::Column->new( {
 317           'name'    => 'lockname',
 318           'type'    => 'varchar',
 319           'null'    => 'NOT NULL',
 320           'length'  => '80',
 321           'default' => '',
 322           'local'   => '',
 323         } ),
 324       ],
 325       'indices' => { 'duplicate_lock1' =>
 326                        DBIx::DBSchema::Index->new({
 327                          'name'    => 'duplicate_lock1',
 328                          'unique'  => 1,
 329                          'columns' => [ 'lockname' ],
 330                        })
 331                    },
 332     } );
 333
 334     $dbdef->addtable($dup_lock_table);
 335
 336   }
 337
 338   $dbdef;
 339
 340 }
 341
 342 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
 343 sub tables_hashref_torrus {
 344
 345   return {
 346
 347     # Collector export table. It usually grows at several megabytes
 348     # per month, and is updated every 5 minutes
 349     'srvexport' => {
 350       'columns' => [
 351         'id',         'serial', '', '', '', '',
 352         'srv_date',     'date', '', '', '', '',#date and time of the data sample
 353         'srv_time',     'time', '', '', '', '',
 354         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
 355         'value',     'double precision', '', '', '', '',#collected rate or gauge value
 356         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
 357       ],
 358       'primary_key' => 'id',
 359       'unique' => [],
 360       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
 361     },
 362
 363     #Tables for (currently monthly only) report contents.
 364     #These are updated usually once per month, and read at the moment of
 365     #rendering the report output (HTML now, PDF or XML or Excel or whatever
 366     #in the future)
 367
 368     #DBIx::Sequence backend, theplatform-independent inplementation
 369     #of sequences
 370     'dbix_sequence_state' => {
 371       'columns' => [
 372         'id',       'serial', '', '', '', '',
 373         'dataset', 'varchar', '', 50, '', '',
 374         'state_id',    'int', '', '', '', '',
 375       ],
 376       'primary_key' => 'id',
 377       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
 378       'unique' => [ [ 'dataset', 'state_id' ], ],
 379       'index'  => [],
 380     },
 381
 382     'dbix_sequence_release' => {
 383       'columns' => [
 384         'id',       'serial', '', '', '', '',
 385         'dataset', 'varchar', '', 50, '', '',
 386         'released_id', 'int', '', '', '', '',
 387       ],
 388       'primary_key' => 'id',
 389       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
 390       'unique' => [ [ 'dataset', 'released_id', ] ],
 391       'index'  => [],
 392     },
 393
 394     #Each report is characterized by name, date and time.
 395     #Monthly reports are automatically assigned 00:00 of the 1st day
 396     #in the month. The report contains fields for every service ID
 397     #defined across all datasource trees.
 398     'reports' => {
 399       'columns' => [
 400         'id',          'serial', '', '', '', '',
 401         'rep_date',      'date', '', '', '', '',#Start date of the report
 402         'rep_time',      'time', '', '', '', '',#Start time of the report
 403         'reportname', 'varchar', '', 64, '', '',#Report name, such as
 404                                                 # MonthlyUsage
 405         'iscomplete',     'int', '', '', '', '',#0 when the report is in
 406                                                 # progress, 1 when it is ready
 407       ],
 408       'primary_key' => 'id',
 409       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
 410       'index'  => [ [ 'rep_date' ] ],
 411     },
 412
 413     #Each report contains fields. For each service ID,
 414     #the report may contain several fields for various statistics.
 415     #Each field contains information about the units of the value it
 416     #contains
 417     'reportfields' => {
 418       'columns' => [
 419         'id',              'serial',     '', '',    '', '',
 420         'rep_id',             'int', 'NULL', '',    '', '',
 421         'name',           'varchar',     '', 64,    '', '',#name of the field,
 422                                                            # such as AVG or MAX
 423         'serviceid',      'varchar',     '', 64,    '', '',#service ID
 424         'value', 'double precision',     '', '',    '', '',#Numeric value
 425         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
 426                                                            # or Mbps
 427       ],
 428       'primary_key', => 'id',
 429       'unique' => [ [ qw(rep_id name serviceid) ] ],
 430       'index'  => [],
 431     },
 432
 433   };
 434
 435 }
 436
 437 sub tables_hashref {
 438
 439   my $char_d = 80; #default maxlength for text fields
 440
 441   #my(@date_type)  = ( 'timestamp', '', ''     );
 442   my @date_type  = ( 'int', 'NULL', ''     );
 443   my @perl_type = ( 'text', 'NULL', ''  );
 444   my @money_type = ( 'decimal',   '', '10,2' );
 445   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 446   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 447   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 448
 449   my $username_len = 64; #usernamemax config file
 450
 451     # name type nullability length default local
 452
 453   return {
 454
 455     'agent' => {
 456       'columns' => [
 457         'agentnum',          'serial',    '',       '', '', '',
 458         'agent',            'varchar',    '',  $char_d, '', '',
 459         'typenum',              'int',    '',       '', '', '',
 460         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 461         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 462         'agent_custnum',        'int', 'NULL',      '', '', '',
 463         'disabled',            'char', 'NULL',       1, '', '',
 464         'username',         'varchar', 'NULL', $char_d, '', '',
 465         '_password',        'varchar', 'NULL', $char_d, '', '',
 466         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 467         'prog',                     @perl_type, '', '', #deprecated (never used)
 468       ],
 469       'primary_key' => 'agentnum',
 470       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 471                                             #insert is giving it a value, tho..
 472       #'index' => [ ['typenum'], ['disabled'] ],
 473       'unique' => [],
 474       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 475     },
 476
 477     'agent_pkg_class' => {
 478       'columns' => [
 479         'agentpkgclassnum',    'serial',     '',    '', '', '',
 480         'agentnum',               'int',     '',    '', '', '',
 481         'classnum',               'int', 'NULL',    '', '', '',
 482         'commission_percent', 'decimal',     '', '7,4', '', '',
 483       ],
 484       'primary_key' => 'agentpkgclassnum',
 485       'unique'      => [ [ 'agentnum', 'classnum' ], ],
 486       'index'       => [],
 487     },
 488
 489     'agent_type' => {
 490       'columns' => [
 491         'typenum',   'serial',  '', '', '', '',
 492         'atype',     'varchar', '', $char_d, '', '',
 493       ],
 494       'primary_key' => 'typenum',
 495       'unique' => [],
 496       'index' => [],
 497     },
 498
 499     'type_pkgs' => {
 500       'columns' => [
 501         'typepkgnum', 'serial', '', '', '', '',
 502         'typenum',   'int',  '', '', '', '',
 503         'pkgpart',   'int',  '', '', '', '',
 504       ],
 505       'primary_key' => 'typepkgnum',
 506       'unique' => [ ['typenum', 'pkgpart'] ],
 507       'index' => [ ['typenum'] ],
 508     },
 509
 510     'sales' => {
 511       'columns' => [
 512         'salesnum',          'serial',    '',       '', '', '',
 513         'salesperson',      'varchar',    '',  $char_d, '', '',
 514         'agentnum',             'int', 'NULL',      '', '', '',
 515         'disabled',            'char', 'NULL',       1, '', '',
 516       ],
 517       'primary_key' => 'salesnum',
 518       'unique' => [],
 519       'index' => [ ['salesnum'], ['disabled'] ],
 520     },
 521
 522     'cust_attachment' => {
 523       'columns' => [
 524         'attachnum', 'serial', '', '', '', '',
 525         'custnum',   'int', '', '', '', '',
 526         '_date',     @date_type, '', '',
 527         'otaker',    'varchar', 'NULL', 32, '', '',
 528         'usernum',   'int', 'NULL', '', '', '',
 529         'filename',  'varchar', '', 255, '', '',
 530         'mime_type', 'varchar', '', $char_d, '', '',
 531         'title',     'varchar', 'NULL', $char_d, '', '',
 532         'body',      'blob', 'NULL', '', '', '',
 533         'disabled',  @date_type, '', '',
 534       ],
 535       'primary_key' => 'attachnum',
 536       'unique'      => [],
 537       'index'       => [ ['custnum'], ['usernum'], ],
 538     },
 539
 540     'cust_bill' => {
 541       'columns' => [
 542         #regular fields
 543         'invnum',    'serial',     '', '', '', '',
 544         'custnum',      'int',     '', '', '', '',
 545         '_date',        @date_type,        '', '',
 546         'charged',      @money_type,       '', '',
 547         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 548
 549         #customer balance info at invoice generation time
 550         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 551         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 552
 553         #deprecated (unused by now, right?)
 554         'printed',      'int',     '', '', '', '',
 555
 556         #specific use cases
 557         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 558         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 559         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 560         'promised_date', @date_type,       '', '',
 561       ],
 562       'primary_key' => 'invnum',
 563       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 564       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
 565     },
 566
 567     'cust_bill_void' => {
 568       'columns' => [
 569         #regular fields
 570         'invnum',       'int',     '', '', '', '',
 571         'custnum',      'int',     '', '', '', '',
 572         '_date',        @date_type,        '', '',
 573         'charged',      @money_type,       '', '',
 574         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 575
 576         #customer balance info at invoice generation time
 577         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 578         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 579
 580         #specific use cases
 581         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 582         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 583         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 584         'promised_date', @date_type,       '', '',
 585
 586         #void fields
 587         'void_date', @date_type, '', '',
 588         'reason',    'varchar',   'NULL', $char_d, '', '',
 589         'void_usernum',   'int', 'NULL', '', '', '',
 590       ],
 591       'primary_key' => 'invnum',
 592       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 593       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'], [ 'void_usernum' ] ],
 594     },
 595
 596     #for importing invoices from a legacy system for display purposes only
 597     # no effect upon balance
 598     'legacy_cust_bill' => {
 599       'columns' => [
 600         'legacyinvnum',  'serial',     '',      '', '', '',
 601         'legacyid',     'varchar', 'NULL', $char_d, '', '',
 602         'custnum',          'int',     '',      '', '', '',
 603         '_date',       @date_type,                  '', '',
 604         'charged',    @money_type,                  '', '',
 605         'content_pdf',     'blob', 'NULL',      '', '', '',
 606         'content_html',    'text', 'NULL',      '', '', '',
 607         'locale',       'varchar', 'NULL',      16, '', '',
 608       ],
 609       'primary_key' => 'legacyinvnum',
 610       'unique' => [],
 611       'index'  => [ ['legacyid', 'custnum', 'locale' ], ],
 612     },
 613
 614     'cust_statement' => {
 615       'columns' => [
 616         'statementnum', 'serial', '', '', '', '',
 617         'custnum',         'int', '', '', '', '',
 618         '_date',           @date_type,    '', '',
 619       ],
 620       'primary_key' => 'statementnum',
 621       'unique' => [],
 622       'index' => [ ['custnum'], ['_date'], ],
 623     },
 624
 625     'cust_bill_event' => {
 626       'columns' => [
 627         'eventnum',    'serial',  '', '', '', '',
 628         'invnum',   'int',  '', '', '', '',
 629         'eventpart',   'int',  '', '', '', '',
 630         '_date',     @date_type, '', '',
 631         'status', 'varchar', '', $char_d, '', '',
 632         'statustext', 'text', 'NULL', '', '', '',
 633       ],
 634       'primary_key' => 'eventnum',
 635       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 636       'unique' => [],
 637       'index' => [ ['invnum'], ['status'], ['eventpart'],
 638                    ['statustext'], ['_date'],
 639                  ],
 640     },
 641
 642     'part_bill_event' => {
 643       'columns' => [
 644         'eventpart',    'serial',  '', '', '', '',
 645         'freq',        'varchar',       'NULL',     $char_d, '', '',
 646         'payby',       'char',  '', 4, '', '',
 647         'event',       'varchar',           '',     $char_d, '', '',
 648         'eventcode',    @perl_type, '', '',
 649         'seconds',     'int', 'NULL', '', '', '',
 650         'weight',      'int', '', '', '', '',
 651         'plan',       'varchar', 'NULL', $char_d, '', '',
 652         'plandata',   'text', 'NULL', '', '', '',
 653         'reason',     'int', 'NULL', '', '', '',
 654         'disabled',     'char', 'NULL', 1, '', '',
 655       ],
 656       'primary_key' => 'eventpart',
 657       'unique' => [],
 658       'index' => [ ['payby'], ['disabled'], ],
 659     },
 660
 661     'part_event' => {
 662       'columns' => [
 663         'eventpart',   'serial',      '',      '', '', '',
 664         'agentnum',    'int',     'NULL',      '', '', '',
 665         'event',       'varchar',     '', $char_d, '', '',
 666         'eventtable',  'varchar',     '', $char_d, '', '',
 667         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 668         'weight',      'int',         '',      '', '', '',
 669         'action',      'varchar',     '', $char_d, '', '',
 670         'disabled',     'char',   'NULL',       1, '', '',
 671       ],
 672       'primary_key' => 'eventpart',
 673       'unique' => [],
 674       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 675     },
 676
 677     'part_event_option' => {
 678       'columns' => [
 679         'optionnum', 'serial', '', '', '', '',
 680         'eventpart', 'int', '', '', '', '',
 681         'optionname', 'varchar', '', $char_d, '', '',
 682         'optionvalue', 'text', 'NULL', '', '', '',
 683       ],
 684       'primary_key' => 'optionnum',
 685       'unique'      => [],
 686       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 687     },
 688
 689     'part_event_condition' => {
 690       'columns' => [
 691         'eventconditionnum', 'serial', '', '', '', '',
 692         'eventpart', 'int', '', '', '', '',
 693         'conditionname', 'varchar', '', $char_d, '', '',
 694       ],
 695       'primary_key' => 'eventconditionnum',
 696       'unique'      => [],
 697       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 698     },
 699
 700     'part_event_condition_option' => {
 701       'columns' => [
 702         'optionnum', 'serial', '', '', '', '',
 703         'eventconditionnum', 'int', '', '', '', '',
 704         'optionname', 'varchar', '', $char_d, '', '',
 705         'optionvalue', 'text', 'NULL', '', '', '',
 706       ],
 707       'primary_key' => 'optionnum',
 708       'unique'      => [],
 709       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 710     },
 711
 712     'part_event_condition_option_option' => {
 713       'columns' => [
 714         'optionoptionnum', 'serial', '', '', '', '',
 715         'optionnum', 'int', '', '', '', '',
 716         'optionname', 'varchar', '', $char_d, '', '',
 717         'optionvalue', 'text', 'NULL', '', '', '',
 718       ],
 719       'primary_key' => 'optionoptionnum',
 720       'unique'      => [],
 721       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 722     },
 723
 724     'cust_event' => {
 725       'columns' => [
 726         'eventnum',    'serial',  '', '', '', '',
 727         'eventpart',   'int',  '', '', '', '',
 728         'tablenum',   'int',  '', '', '', '',
 729         '_date',     @date_type, '', '',
 730         'status', 'varchar', '', $char_d, '', '',
 731         'statustext', 'text', 'NULL', '', '', '',
 732       ],
 733       'primary_key' => 'eventnum',
 734       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 735       'unique' => [],
 736       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 737                    ['statustext'], ['_date'],
 738                  ],
 739     },
 740
 741     'cust_bill_pkg' => {
 742       'columns' => [
 743         'billpkgnum',        'serial',     '',      '', '', '',
 744         'invnum',               'int',     '',      '', '', '',
 745         'pkgnum',               'int',     '',      '', '', '',
 746         'pkgpart_override',     'int', 'NULL',      '', '', '',
 747         'setup',               @money_type,             '', '',
 748         'recur',               @money_type,             '', '',
 749         'sdate',               @date_type,              '', '',
 750         'edate',               @date_type,              '', '',
 751         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 752         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 753         'section',          'varchar', 'NULL', $char_d, '', '',
 754         'freq',             'varchar', 'NULL', $char_d, '', '',
 755         'quantity',             'int', 'NULL',      '', '', '',
 756         'unitsetup',           @money_typen,            '', '',
 757         'unitrecur',           @money_typen,            '', '',
 758         'hidden',              'char', 'NULL',       1, '', '',
 759       ],
 760       'primary_key' => 'billpkgnum',
 761       'unique' => [],
 762       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 763     },
 764
 765     'cust_bill_pkg_detail' => {
 766       'columns' => [
 767         'detailnum', 'serial', '', '', '', '',
 768         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 769         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 770         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 771         'amount',  'decimal', 'NULL', '10,4', '', '',
 772         'format',  'char', 'NULL', 1, '', '',
 773         'classnum', 'int', 'NULL', '', '', '',
 774         'duration', 'int', 'NULL', '',  0, '',
 775         'phonenum', 'varchar', 'NULL', 25, '', '',
 776         'accountcode', 'varchar',  'NULL',      20, '', '',
 777         'startdate',  @date_type, '', '',
 778         'regionname', 'varchar', 'NULL', $char_d, '', '',
 779         'detail',  'varchar', '', 255, '', '',
 780       ],
 781       'primary_key' => 'detailnum',
 782       'unique' => [],
 783       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 784     },
 785
 786     'cust_bill_pkg_display' => {
 787       'columns' => [
 788         'billpkgdisplaynum', 'serial', '', '', '', '',
 789         'billpkgnum', 'int', '', '', '', '',
 790         'section',  'varchar', 'NULL', $char_d, '', '',
 791         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 792         #'unitrecur', @money_typen, '', '',     #this too?
 793         'post_total', 'char', 'NULL', 1, '', '',
 794         'type',       'char', 'NULL', 1, '', '',
 795         'summary',    'char', 'NULL', 1, '', '',
 796       ],
 797       'primary_key' => 'billpkgdisplaynum',
 798       'unique' => [],
 799       'index' => [ ['billpkgnum'], ],
 800     },
 801
 802     'cust_bill_pkg_tax_location' => {
 803       'columns' => [
 804         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 805         'billpkgnum',               'int',      '', '', '', '',
 806         'taxnum',                   'int',      '', '', '', '',
 807         'taxtype',              'varchar',      '', $char_d, '', '',
 808         'pkgnum',                   'int',      '', '', '', '', #redundant
 809         'locationnum',              'int',      '', '', '', '', #redundant
 810         'amount',                   @money_type,        '', '',
 811         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
 812       ],
 813       'primary_key' => 'billpkgtaxlocationnum',
 814       'unique' => [],
 815       'index'  => [ [ 'billpkgnum' ],
 816                     [ 'taxnum' ],
 817                     [ 'pkgnum' ],
 818                     [ 'locationnum' ],
 819                     [ 'taxable_billpkgnum' ],
 820                   ],
 821     },
 822
 823     'cust_bill_pkg_tax_rate_location' => {
 824       'columns' => [
 825         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 826         'billpkgnum',                   'int',      '', '', '', '',
 827         'taxnum',                       'int',      '', '', '', '',
 828         'taxtype',                  'varchar',      '', $char_d, '', '',
 829         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 830         'taxratelocationnum',           'int',      '', '', '', '',
 831         'amount',                       @money_type,        '', '',
 832         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
 833       ],
 834       'primary_key' => 'billpkgtaxratelocationnum',
 835       'unique' => [],
 836       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ],
 837                     [ 'taxable_billpkgnum' ], ],
 838     },
 839
 840     'cust_bill_pkg_void' => {
 841       'columns' => [
 842         'billpkgnum',           'int',     '',      '', '', '',
 843         'invnum',               'int',     '',      '', '', '',
 844         'pkgnum',               'int',     '',      '', '', '',
 845         'pkgpart_override',     'int', 'NULL',      '', '', '',
 846         'setup',               @money_type,             '', '',
 847         'recur',               @money_type,             '', '',
 848         'sdate',               @date_type,              '', '',
 849         'edate',               @date_type,              '', '',
 850         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 851         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 852         'section',          'varchar', 'NULL', $char_d, '', '',
 853         'freq',             'varchar', 'NULL', $char_d, '', '',
 854         'quantity',             'int', 'NULL',      '', '', '',
 855         'unitsetup',           @money_typen,            '', '',
 856         'unitrecur',           @money_typen,            '', '',
 857         'hidden',              'char', 'NULL',       1, '', '',
 858         #void fields
 859         'void_date', @date_type, '', '',
 860         'reason',    'varchar',   'NULL', $char_d, '', '',
 861         'void_usernum',   'int', 'NULL', '', '', '',
 862       ],
 863       'primary_key' => 'billpkgnum',
 864       'unique' => [],
 865       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], [ 'void_usernum' ], ],
 866     },
 867
 868     'cust_bill_pkg_detail_void' => {
 869       'columns' => [
 870         'detailnum',  'int', '', '', '', '',
 871         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 872         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 873         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 874         'amount',  'decimal', 'NULL', '10,4', '', '',
 875         'format',  'char', 'NULL', 1, '', '',
 876         'classnum', 'int', 'NULL', '', '', '',
 877         'duration', 'int', 'NULL', '',  0, '',
 878         'phonenum', 'varchar', 'NULL', 25, '', '',
 879         'accountcode', 'varchar',  'NULL',      20, '', '',
 880         'startdate',  @date_type, '', '',
 881         'regionname', 'varchar', 'NULL', $char_d, '', '',
 882         'detail',  'varchar', '', 255, '', '',
 883       ],
 884       'primary_key' => 'detailnum',
 885       'unique' => [],
 886       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 887     },
 888
 889     'cust_bill_pkg_display_void' => {
 890       'columns' => [
 891         'billpkgdisplaynum',    'int', '', '', '', '',
 892         'billpkgnum', 'int', '', '', '', '',
 893         'section',  'varchar', 'NULL', $char_d, '', '',
 894         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 895         #'unitrecur', @money_typen, '', '',     #this too?
 896         'post_total', 'char', 'NULL', 1, '', '',
 897         'type',       'char', 'NULL', 1, '', '',
 898         'summary',    'char', 'NULL', 1, '', '',
 899       ],
 900       'primary_key' => 'billpkgdisplaynum',
 901       'unique' => [],
 902       'index' => [ ['billpkgnum'], ],
 903     },
 904
 905     'cust_bill_pkg_tax_location_void' => {
 906       'columns' => [
 907         'billpkgtaxlocationnum',    'int',      '', '', '', '',
 908         'billpkgnum',               'int',      '', '', '', '',
 909         'taxnum',                   'int',      '', '', '', '',
 910         'taxtype',              'varchar',      '', $char_d, '', '',
 911         'pkgnum',                   'int',      '', '', '', '',
 912         'locationnum',              'int',      '', '', '', '', #redundant?
 913         'amount',                   @money_type,        '', '',
 914       ],
 915       'primary_key' => 'billpkgtaxlocationnum',
 916       'unique' => [],
 917       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 918     },
 919
 920     'cust_bill_pkg_tax_rate_location_void' => {
 921       'columns' => [
 922         'billpkgtaxratelocationnum',    'int',      '', '', '', '',
 923         'billpkgnum',                   'int',      '', '', '', '',
 924         'taxnum',                       'int',      '', '', '', '',
 925         'taxtype',                  'varchar',      '', $char_d, '', '',
 926         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 927         'taxratelocationnum',           'int',      '', '', '', '',
 928         'amount',                       @money_type,        '', '',
 929       ],
 930       'primary_key' => 'billpkgtaxratelocationnum',
 931       'unique' => [],
 932       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 933     },
 934
 935     'cust_credit' => {
 936       'columns' => [
 937         'crednum',  'serial', '', '', '', '',
 938         'custnum',  'int', '', '', '', '',
 939         '_date',    @date_type, '', '',
 940         'amount',   @money_type, '', '',
 941         'otaker',   'varchar', 'NULL', 32, '', '',
 942         'usernum',   'int', 'NULL', '', '', '',
 943         'reason',   'text', 'NULL', '', '', '',
 944         'reasonnum', 'int', 'NULL', '', '', '',
 945         'addlinfo', 'text', 'NULL', '', '', '',
 946         'closed',    'char', 'NULL', 1, '', '',
 947         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 948         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
 949         #'commission_agentnum', 'int', 'NULL', '', '', '', #
 950       ],
 951       'primary_key' => 'crednum',
 952       'unique' => [],
 953       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'] ],
 954     },
 955
 956     'cust_credit_bill' => {
 957       'columns' => [
 958         'creditbillnum', 'serial', '', '', '', '',
 959         'crednum',  'int', '', '', '', '',
 960         'invnum',  'int', '', '', '', '',
 961         '_date',    @date_type, '', '',
 962         'amount',   @money_type, '', '',
 963         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 964       ],
 965       'primary_key' => 'creditbillnum',
 966       'unique' => [],
 967       'index' => [ ['crednum'], ['invnum'] ],
 968     },
 969
 970     'cust_credit_bill_pkg' => {
 971       'columns' => [
 972         'creditbillpkgnum', 'serial', '',      '', '', '',
 973         'creditbillnum',       'int', '',      '', '', '',
 974         'billpkgnum',          'int', '',      '', '', '',
 975         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
 976         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
 977         'amount',            @money_type,          '', '',
 978         'setuprecur',      'varchar', '', $char_d, '', '',
 979         'sdate',   @date_type, '', '',
 980         'edate',   @date_type, '', '',
 981       ],
 982       'primary_key' => 'creditbillpkgnum',
 983       'unique'      => [],
 984       'index'       => [ [ 'creditbillnum' ],
 985                          [ 'billpkgnum' ],
 986                          [ 'billpkgtaxlocationnum' ],
 987                          [ 'billpkgtaxratelocationnum' ],
 988                        ],
 989     },
 990
 991     'cust_main' => {
 992       'columns' => [
 993         'custnum',  'serial',  '',     '', '', '',
 994         'agentnum', 'int',  '',     '', '', '',
 995         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 996         'classnum', 'int', 'NULL', '', '', '',
 997         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 998 #        'titlenum', 'int',  'NULL',   '', '', '',
 999         'last',     'varchar', '',   2*$char_d, '', '',
1000 #        'middle',   'varchar', 'NULL', $char_d, '', '',
1001         'first',    'varchar', '',     $char_d, '', '',
1002         'ss',       'varchar', 'NULL', 11, '', '',
1003         'stateid', 'varchar', 'NULL', $char_d, '', '',
1004         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
1005         'national_id', 'varchar', 'NULL', $char_d, '', '',
1006         'birthdate' ,@date_type, '', '',
1007         'spouse_birthdate' ,@date_type, '', '',
1008         'anniversary_date' ,@date_type, '', '',
1009         'signupdate',@date_type, '', '',
1010         'dundate',   @date_type, '', '',
1011         'company',  'varchar', 'NULL', $char_d, '', '',
1012         'address1', 'varchar', 'NULL', $char_d, '', '',
1013         'address2', 'varchar', 'NULL', $char_d, '', '',
1014         'city',     'varchar', 'NULL', $char_d, '', '',
1015         'county',   'varchar', 'NULL', $char_d, '', '',
1016         'state',    'varchar', 'NULL', $char_d, '', '',
1017         'zip',      'varchar', 'NULL', 10, '', '',
1018         'country',  'char',    'NULL',  2, '', '',
1019         'latitude', 'decimal', 'NULL', '10,7', '', '',
1020         'longitude','decimal', 'NULL', '10,7', '', '',
1021         'coord_auto',  'char', 'NULL',  1, '', '',
1022         'addr_clean',  'char', 'NULL',  1, '', '',
1023         'daytime',  'varchar', 'NULL', 20, '', '',
1024         'night',    'varchar', 'NULL', 20, '', '',
1025         'fax',      'varchar', 'NULL', 12, '', '',
1026         'mobile',   'varchar', 'NULL', 12, '', '',
1027         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '',
1028 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
1029         'ship_first',    'varchar', 'NULL', $char_d, '', '',
1030         'ship_company',  'varchar', 'NULL', $char_d, '', '',
1031         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
1032         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
1033         'ship_city',     'varchar', 'NULL', $char_d, '', '',
1034         'ship_county',   'varchar', 'NULL', $char_d, '', '',
1035         'ship_state',    'varchar', 'NULL', $char_d, '', '',
1036         'ship_zip',      'varchar', 'NULL', 10, '', '',
1037         'ship_country',  'char', 'NULL', 2, '', '',
1038         'ship_latitude', 'decimal', 'NULL', '10,7', '', '',
1039         'ship_longitude','decimal', 'NULL', '10,7', '', '',
1040         'ship_coord_auto',  'char', 'NULL',  1, '', '',
1041         'ship_addr_clean',  'char', 'NULL',  1, '', '',
1042         'ship_daytime',  'varchar', 'NULL', 20, '', '',
1043         'ship_night',    'varchar', 'NULL', 20, '', '',
1044         'ship_fax',      'varchar', 'NULL', 12, '', '',
1045         'ship_mobile',   'varchar', 'NULL', 12, '', '',
1046         'payby',    'char', '',     4, '', '',
1047         'payinfo',  'varchar', 'NULL', 512, '', '',
1048         'paycvv',   'varchar', 'NULL', 512, '', '',
1049         'paymask', 'varchar', 'NULL', $char_d, '', '',
1050         #'paydate',  @date_type, '', '',
1051         'paydate',  'varchar', 'NULL', 10, '', '',
1052         'paystart_month', 'int', 'NULL', '', '', '',
1053         'paystart_year',  'int', 'NULL', '', '', '',
1054         'payissue', 'varchar', 'NULL', 2, '', '',
1055         'payname',  'varchar', 'NULL', 2*$char_d, '', '',
1056         'paystate', 'varchar', 'NULL', $char_d, '', '',
1057         'paytype',  'varchar', 'NULL', $char_d, '', '',
1058         'payip',    'varchar', 'NULL', 15, '', '',
1059         'geocode',  'varchar', 'NULL', 20,  '', '',
1060         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
1061         'censusyear', 'char', 'NULL', 4, '', '',
1062         'district', 'varchar', 'NULL', 20, '', '',
1063         'tax',      'char', 'NULL', 1, '', '',
1064         'otaker',   'varchar', 'NULL',    32, '', '',
1065         'usernum',   'int', 'NULL', '', '', '',
1066         'refnum',   'int',  '',     '', '', '',
1067         'referral_custnum', 'int',  'NULL', '', '', '',
1068         'comments', 'text', 'NULL', '', '', '',
1069         'spool_cdr','char', 'NULL', 1, '', '',
1070         'squelch_cdr','char', 'NULL', 1, '', '',
1071         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
1072         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
1073         'credit_limit', @money_typen, '', '',
1074         'archived', 'char', 'NULL', 1, '', '',
1075         'email_csv_cdr', 'char', 'NULL', 1, '', '',
1076         'accountcode_cdr', 'char', 'NULL', 1, '', '',
1077         'billday',   'int', 'NULL', '', '', '',
1078         'prorate_day',   'int', 'NULL', '', '', '',
1079         'edit_subject', 'char', 'NULL', 1, '', '',
1080         'locale', 'varchar', 'NULL', 16, '', '',
1081         'calling_list_exempt', 'char', 'NULL', 1, '', '',
1082         'invoice_noemail', 'char', 'NULL', 1, '', '',
1083         'message_noemail', 'char', 'NULL', 1, '', '',
1084         'bill_locationnum', 'int', 'NULL', '', '', '',
1085         'ship_locationnum', 'int', 'NULL', '', '', '',
1086       ],
1087       'primary_key' => 'custnum',
1088       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
1089       #'index' => [ ['last'], ['company'] ],
1090       'index' => [
1091                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
1092                    [ 'custbatch' ],
1093                    [ 'referral_custnum' ],
1094                    [ 'payby' ], [ 'paydate' ],
1095                    [ 'archived' ],
1096                  ],
1097     },
1098
1099     'cust_recon' => {  # (some sort of not-well understood thing for OnPac)
1100       'columns' => [
1101         'reconid',      'serial',  '',          '', '', '',
1102         'recondate',    @date_type,                 '', '',
1103         'custnum',      'int'   ,  '',          '', '', '',
1104         'agentnum',     'int',     '',          '', '', '',
1105         'last',         'varchar', '',     $char_d, '', '',
1106         'first',        'varchar', '',     $char_d, '', '',
1107         'address1',     'varchar', '',     $char_d, '', '',
1108         'address2',     'varchar', 'NULL', $char_d, '', '',
1109         'city',         'varchar', '',     $char_d, '', '',
1110         'state',        'varchar', 'NULL', $char_d, '', '',
1111         'zip',          'varchar', 'NULL',      10, '', '',
1112         'pkg',          'varchar', 'NULL', $char_d, '', '',
1113         'adjourn',      @date_type,                 '', '',
1114         'status',       'varchar', 'NULL',      10, '', '',
1115         'agent_custid', 'varchar',  '',    $char_d, '', '',
1116         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
1117         'agent_adjourn', @date_type,                '', '',
1118         'comments',     'text',    'NULL',      '', '', '',
1119       ],
1120       'primary_key' => 'reconid',
1121       'unique' => [],
1122       'index' => [],
1123     },
1124
1125     'contact_class' => {
1126       'columns' => [
1127         'classnum',    'serial',   '',      '', '', '',
1128         'classname',   'varchar',  '', $char_d, '', '',
1129         'disabled',    'char', 'NULL',       1, '', '',
1130       ],
1131       'primary_key' => 'classnum',
1132       'unique' => [],
1133       'index' => [ ['disabled'] ],
1134     },
1135
1136     'contact' => {
1137       'columns' => [
1138         'contactnum', 'serial',     '',      '', '', '',
1139         'prospectnum',   'int', 'NULL',      '', '', '',
1140         'custnum',       'int', 'NULL',      '', '', '',
1141         'locationnum',   'int', 'NULL',      '', '', '', #not yet
1142         'classnum',      'int', 'NULL',      '', '', '',
1143 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1144         'last',      'varchar',     '', $char_d, '', '',
1145 #        'middle',    'varchar', 'NULL', $char_d, '', '',
1146         'first',     'varchar',     '', $char_d, '', '',
1147         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1148         'comment',   'varchar', 'NULL',     255, '', '',
1149         'disabled',     'char', 'NULL',       1, '', '',
1150       ],
1151       'primary_key' => 'contactnum',
1152       'unique'      => [],
1153       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1154                          [ 'last' ], [ 'first' ],
1155                        ],
1156     },
1157
1158     'contact_phone' => {
1159       'columns' => [
1160         'contactphonenum', 'serial',     '', '', '', '',
1161         'contactnum',         'int',     '', '', '', '',
1162         'phonetypenum',       'int',     '', '', '', '',
1163         'countrycode',    'varchar',     '',  3, '', '',
1164         'phonenum',       'varchar',     '', 14, '', '',
1165         'extension',      'varchar', 'NULL',  7, '', '',
1166         #?#'comment',        'varchar',     '', $char_d, '', '',
1167       ],
1168       'primary_key' => 'contactphonenum',
1169       'unique'      => [],
1170       'index'       => [],
1171     },
1172
1173     'phone_type' => {
1174       'columns' => [
1175         'phonetypenum',  'serial', '',      '', '', '',
1176         'typename',     'varchar', '', $char_d, '', '',
1177         'weight',           'int', '',      '', '', '',
1178       ],
1179       'primary_key' => 'phonetypenum',
1180       'unique'      => [ [ 'typename' ], ],
1181       'index'       => [],
1182     },
1183
1184     'contact_email' => {
1185       'columns' => [
1186         'contactemailnum', 'serial', '',      '', '', '',
1187         'contactnum',         'int', '',      '', '', '',
1188         'emailaddress',   'varchar', '', $char_d, '', '',
1189       ],
1190       'primary_key' => 'contactemailnum',
1191       'unique'      => [ [ 'emailaddress' ], ],
1192       'index'       => [],
1193     },
1194
1195     'prospect_main' => {
1196       'columns' => [
1197         'prospectnum',  'serial',     '',      '', '', '',
1198         'agentnum',        'int',     '',      '', '', '',
1199         'company',     'varchar', 'NULL', $char_d, '', '',
1200         'add_date',   @date_type,                  '', '',
1201         'disabled',       'char', 'NULL',       1, '', '',
1202         'custnum',         'int', 'NULL',      '', '', '',
1203       ],
1204       'primary_key' => 'prospectnum',
1205       'unique'      => [],
1206       'index'       => [ [ 'company' ], [ 'agentnum' ], [ 'disabled' ] ],
1207     },
1208
1209     'quotation' => {
1210       'columns' => [
1211         #regular fields
1212         'quotationnum',   'serial',     '', '', '', '',
1213         'prospectnum',       'int', 'NULL', '', '', '',
1214         'custnum',           'int', 'NULL', '', '', '',
1215         '_date',        @date_type,             '', '',
1216         'disabled',         'char', 'NULL',  1, '', '',
1217         'usernum',           'int', 'NULL', '', '', '',
1218         #'total',      @money_type,       '', '',
1219         #'quotation_term', 'varchar', 'NULL', $char_d, '', '',
1220       ],
1221       'primary_key' => 'quotationnum',
1222       'unique' => [],
1223       'index' => [ [ 'prospectnum' ], ['custnum'], ],
1224     },
1225
1226     'quotation_pkg' => {
1227       'columns' => [
1228         'quotationpkgnum',   'serial',     '', '', '', '',
1229         'quotationnum',         'int', 'NULL', '', '', '', #shouldn't be null,
1230                                                            # but history...
1231         'pkgpart',              'int',     '', '', '', '',
1232         'locationnum',          'int', 'NULL', '', '', '',
1233         'start_date',      @date_type,             '', '',
1234         'contract_end',    @date_type,             '', '',
1235         'quantity',             'int', 'NULL', '', '', '',
1236         'waive_setup',         'char', 'NULL',  1, '', '',
1237       ],
1238       'primary_key' => 'quotationpkgnum',
1239       'unique' => [],
1240       'index' => [ ['pkgpart'], ],
1241     },
1242
1243     'quotation_pkg_discount' => {
1244       'columns' => [
1245         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1246         'quotationpkgnum',            'int', '', '', '', '',
1247         'discountnum',                'int', '', '', '', '',
1248         #'end_date',              @date_type,         '', '',
1249       ],
1250       'primary_key' => 'quotationpkgdiscountnum',
1251       'unique' => [],
1252       'index'  => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
1253     },
1254
1255     'cust_location' => { #'location' now that its prospects too, but...
1256       'columns' => [
1257         'locationnum',      'serial',     '',      '', '', '',
1258         'prospectnum',         'int', 'NULL',      '', '', '',
1259         'custnum',             'int', 'NULL',      '', '', '',
1260         'address1',        'varchar',     '', $char_d, '', '',
1261         'address2',        'varchar', 'NULL', $char_d, '', '',
1262         'city',            'varchar',     '', $char_d, '', '',
1263         'county',          'varchar', 'NULL', $char_d, '', '',
1264         'state',           'varchar', 'NULL', $char_d, '', '',
1265         'zip',             'varchar', 'NULL',      10, '', '',
1266         'latitude',        'decimal', 'NULL',  '10,7', '', '',
1267         'longitude',       'decimal', 'NULL',  '10,7', '', '',
1268         'coord_auto',         'char', 'NULL',       1, '', '',
1269         'addr_clean',         'char', 'NULL',       1, '', '',
1270         'country',            'char',     '',       2, '', '',
1271         'geocode',         'varchar', 'NULL',      20, '', '',
1272         'district',        'varchar', 'NULL',      20, '', '',
1273         'censustract',     'varchar', 'NULL',      20, '', '',
1274         'censusyear',         'char', 'NULL',       4, '', '',
1275         'location_type',   'varchar', 'NULL',      20, '', '',
1276         'location_number', 'varchar', 'NULL',      20, '', '',
1277         'location_kind',      'char', 'NULL',       1, '', '',
1278         'disabled',           'char', 'NULL',       1, '', '',
1279       ],
1280       'primary_key' => 'locationnum',
1281       'unique'      => [],
1282       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1283                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1284                          [ 'city' ], [ 'district' ]
1285                        ],
1286     },
1287
1288     'cust_main_invoice' => {
1289       'columns' => [
1290         'destnum',  'serial',  '',     '', '', '',
1291         'custnum',  'int',  '',     '', '', '',
1292         'dest',     'varchar', '',  $char_d, '', '',
1293       ],
1294       'primary_key' => 'destnum',
1295       'unique' => [],
1296       'index' => [ ['custnum'], ],
1297     },
1298
1299     'cust_main_note' => {
1300       'columns' => [
1301         'notenum',  'serial',  '',     '', '', '',
1302         'custnum',  'int',  '',     '', '', '',
1303         'classnum',      'int',     'NULL', '', '', '',
1304         '_date',    @date_type, '', '',
1305         'otaker',   'varchar', 'NULL',    32, '', '',
1306         'usernum',   'int', 'NULL', '', '', '',
1307         'comments', 'text', 'NULL', '', '', '',
1308       ],
1309       'primary_key' => 'notenum',
1310       'unique' => [],
1311       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1312     },
1313
1314     'cust_note_class' => {
1315       'columns' => [
1316         'classnum',    'serial',   '',      '', '', '',
1317         'classname',   'varchar',  '', $char_d, '', '',
1318         'disabled',    'char', 'NULL',       1, '', '',
1319       ],
1320       'primary_key' => 'classnum',
1321       'unique' => [],
1322       'index' => [ ['disabled'] ],
1323     },
1324
1325     'cust_category' => {
1326       'columns' => [
1327         'categorynum',   'serial',  '', '', '', '',
1328         'categoryname',  'varchar', '', $char_d, '', '',
1329         'weight',         'int', 'NULL',  '', '', '',
1330         'disabled',      'char', 'NULL',   1, '', '',
1331       ],
1332       'primary_key' => 'categorynum',
1333       'unique' => [],
1334       'index' => [ ['disabled'] ],
1335     },
1336
1337     'cust_class' => {
1338       'columns' => [
1339         'classnum',     'serial',     '',      '', '', '',
1340         'classname',   'varchar',     '', $char_d, '', '',
1341         'categorynum',     'int', 'NULL',      '', '', '',
1342         'tax',            'char', 'NULL',       1, '', '',
1343         'disabled',       'char', 'NULL',       1, '', '',
1344       ],
1345       'primary_key' => 'classnum',
1346       'unique' => [],
1347       'index' => [ ['disabled'] ],
1348     },
1349
1350     'cust_tag' => {
1351       'columns' => [
1352         'custtagnum', 'serial', '', '', '', '',
1353         'custnum',       'int', '', '', '', '',
1354         'tagnum',        'int', '', '', '', '',
1355       ],
1356       'primary_key' => 'custtagnum',
1357       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1358       'index'       => [ [ 'custnum' ] ],
1359     },
1360
1361     'part_tag' => {
1362       'columns' => [
1363         'tagnum',    'serial',     '',      '', '', '',
1364         'tagname',  'varchar',     '', $char_d, '', '',
1365         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1366         'tagcolor', 'varchar', 'NULL',       6, '', '',
1367         'by_default',  'char', 'NULL',       1, '', '',
1368         'disabled',    'char', 'NULL',       1, '', '',
1369       ],
1370       'primary_key' => 'tagnum',
1371       'unique'      => [], #[ [ 'tagname' ] ], #?
1372       'index'       => [ [ 'disabled' ] ],
1373     },
1374
1375     'cust_main_exemption' => {
1376       'columns' => [
1377         'exemptionnum',   'serial',     '',      '', '', '',
1378         'custnum',           'int',     '',      '', '', '',
1379         'taxname',       'varchar',     '', $char_d, '', '',
1380         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
1381         #start/end dates?  for reporting?
1382       ],
1383       'primary_key' => 'exemptionnum',
1384       'unique'      => [],
1385       'index'       => [ [ 'custnum' ] ],
1386     },
1387
1388     'cust_tax_adjustment' => {
1389       'columns' => [
1390         'adjustmentnum', 'serial',     '',      '', '', '',
1391         'custnum',          'int',     '',      '', '', '',
1392         'taxname',      'varchar',     '', $char_d, '', '',
1393         'amount',    @money_type,                   '', '',
1394         'comment',     'varchar',  'NULL', $char_d, '', '',
1395         'billpkgnum',       'int', 'NULL',      '', '', '',
1396         #more?  no cust_bill_pkg_tax_location?
1397       ],
1398       'primary_key' => 'adjustmentnum',
1399       'unique'      => [],
1400       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1401     },
1402
1403     'cust_main_county' => { #district+city+county+state+country are checked
1404                             #off the cust_main_county for validation and to
1405                             #provide a tax rate.
1406       'columns' => [
1407         'taxnum',   'serial',   '',    '', '', '',
1408         'district', 'varchar',  'NULL',    20, '', '',
1409         'city',     'varchar',  'NULL',    $char_d, '', '',
1410         'county',   'varchar',  'NULL',    $char_d, '', '',
1411         'state',    'varchar',  'NULL',    $char_d, '', '',
1412         'country',  'char',  '', 2, '', '',
1413         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1414         'exempt_amount', @money_type, '', '',
1415         'tax',      'real',  '',    '', '', '', #tax %
1416         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1417         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1418         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1419       ],
1420       'primary_key' => 'taxnum',
1421       'unique' => [],
1422   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1423       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ],
1424                    [ 'country' ],
1425                    [ 'taxclass' ],
1426                  ],
1427     },
1428
1429     'tax_rate'    => {
1430       'columns' => [
1431         'taxnum',       'serial',     '',      '', '', '',
1432         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1433         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1434         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1435         'taxclassnum', 'int',      '',      '', '', '',
1436         'effective_date', @date_type, '', '',
1437         'tax',        @taxrate_type,      '', '',        # tax %
1438         'excessrate', @taxrate_typen,     '', '',        # second tax %
1439         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1440         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1441         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1442         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1443         'unittype',    'int',  'NULL', '', '', '',      # for fee
1444         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1445         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1446         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1447         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1448         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1449         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1450         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1451         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1452         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1453         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1454         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1455         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1456         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1457         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1458         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1459         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1460       ],
1461       'primary_key' => 'taxnum',
1462       'unique' => [],
1463       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1464     },
1465
1466     'tax_rate_location' => {
1467       'columns' => [
1468         'taxratelocationnum', 'serial',  '',     '', '', '',
1469         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1470         'geocode',            'varchar', '',     20,      '', '',
1471         'city',               'varchar', 'NULL', $char_d, '', '',
1472         'county',             'varchar', 'NULL', $char_d, '', '',
1473         'state',              'char',    'NULL',       2, '', '',
1474         'disabled',           'char',    'NULL', 1, '', '',
1475       ],
1476       'primary_key' => 'taxratelocationnum',
1477       'unique' => [],
1478       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1479     },
1480
1481     'cust_tax_location' => {
1482       'columns' => [
1483         'custlocationnum', 'serial',  '',     '', '', '',
1484         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1485         'city',            'varchar', 'NULL', $char_d, '', '',
1486         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1487         'county',          'varchar', 'NULL', $char_d, '', '',
1488         'zip',             'char',    '',     5,  '', '',
1489         'state',           'char',    '',     2,  '', '',
1490         'plus4hi',         'char',    'NULL', 4,  '', '',
1491         'plus4lo',         'char',    'NULL', 4,  '', '',
1492         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1493         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1494         'geocode',         'varchar', '',    20,  '', '',
1495       ],
1496       'primary_key' => 'custlocationnum',
1497       'unique' => [],
1498       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1499     },
1500
1501     'tax_class' => {
1502       'columns' => [
1503         'taxclassnum',  'serial',  '',            '', '', '',
1504         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1505         'taxclass',     'varchar', '',       $char_d, '', '',
1506         'description',  'varchar', '',     2*$char_d, '', '',
1507       ],
1508       'primary_key' => 'taxclassnum',
1509       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1510       'index' => [],
1511     },
1512
1513     'cust_pay_pending' => {
1514       'columns' => [
1515         'paypendingnum','serial',      '',  '', '', '',
1516         'custnum',      'int',         '',  '', '', '',
1517         'paid',         @money_type,            '', '',
1518         '_date',        @date_type,             '', '',
1519         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1520                                                         # be index into payby
1521                                                         # table eventually
1522         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1523         'paymask',      'varchar', 'NULL', $char_d, '', '',
1524         'paydate',      'varchar', 'NULL', 10, '', '',
1525         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1526         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1527         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1528
1529         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1530         'status',       'varchar',     '', $char_d, '', '',
1531         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1532         'statustext',   'text',    'NULL',  '', '', '',
1533         'gatewaynum',   'int',     'NULL',  '', '', '',
1534         #'cust_balance', @money_type,            '', '',
1535         'paynum',       'int',     'NULL',  '', '', '',
1536         'jobnum',       'int',     'NULL',  '', '', '',
1537       ],
1538       'primary_key' => 'paypendingnum',
1539       'unique'      => [ [ 'payunique' ] ],
1540       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1541     },
1542
1543     'cust_pay' => {
1544       'columns' => [
1545         'paynum',   'serial',    '',   '', '', '',
1546         'custnum',  'int',    '',   '', '', '',
1547         '_date',    @date_type, '', '',
1548         'paid',     @money_type, '', '',
1549         'otaker',   'varchar', 'NULL', 32, '', '',
1550         'usernum',   'int', 'NULL', '', '', '',
1551         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1552                                                  # index into payby table
1553                                                  # eventually
1554         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1555         'paymask', 'varchar', 'NULL', $char_d, '', '',
1556         'paydate',  'varchar', 'NULL', 10, '', '',
1557         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1558         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1559         'closed',    'char', 'NULL', 1, '', '',
1560         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1561         # cash/check deposit info fields
1562         'bank',       'varchar', 'NULL', $char_d, '', '',
1563         'depositor',  'varchar', 'NULL', $char_d, '', '',
1564         'account',    'varchar', 'NULL', 20,      '', '',
1565         'teller',     'varchar', 'NULL', 20,      '', '',
1566
1567         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1568
1569         # credit card/EFT fields (formerly in paybatch)
1570         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1571         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1572         'auth',       'varchar','NULL',16, '', '', # CC auth number
1573         'order_number','varchar','NULL',$char_d, '', '', # transaction number
1574       ],
1575       'primary_key' => 'paynum',
1576       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1577       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1578     },
1579
1580     'cust_pay_void' => {
1581       'columns' => [
1582         'paynum',    'int',    '',   '', '', '',
1583         'custnum',   'int',    '',   '', '', '',
1584         '_date',     @date_type, '', '',
1585         'paid',      @money_type, '', '',
1586         'otaker',   'varchar', 'NULL', 32, '', '',
1587         'usernum',   'int', 'NULL', '', '', '',
1588         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1589                                                   # index into payby table
1590                                                   # eventually
1591         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1592         'paymask', 'varchar', 'NULL', $char_d, '', '',
1593         #'paydate' ?
1594         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1595         'closed',    'char', 'NULL', 1, '', '',
1596         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1597         # cash/check deposit info fields
1598         'bank',       'varchar', 'NULL', $char_d, '', '',
1599         'depositor',  'varchar', 'NULL', $char_d, '', '',
1600         'account',    'varchar', 'NULL', 20,      '', '',
1601         'teller',     'varchar', 'NULL', 20,      '', '',
1602         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1603
1604         # credit card/EFT fields (formerly in paybatch)
1605         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1606         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1607         'auth',       'varchar','NULL',16, '', '', # CC auth number
1608         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
1609
1610         #void fields
1611         'void_date', @date_type, '', '',
1612         'reason',    'varchar',   'NULL', $char_d, '', '',
1613         'void_usernum',   'int', 'NULL', '', '', '',
1614       ],
1615       'primary_key' => 'paynum',
1616       'unique' => [],
1617       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1618     },
1619
1620     'cust_bill_pay' => {
1621       'columns' => [
1622         'billpaynum', 'serial',     '',   '', '', '',
1623         'invnum',  'int',     '',   '', '', '',
1624         'paynum',  'int',     '',   '', '', '',
1625         'amount',  @money_type, '', '',
1626         '_date',   @date_type, '', '',
1627         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1628       ],
1629       'primary_key' => 'billpaynum',
1630       'unique' => [],
1631       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1632     },
1633
1634     'cust_bill_pay_batch' => {
1635       'columns' => [
1636         'billpaynum', 'serial',     '',   '', '', '',
1637         'invnum',  'int',     '',   '', '', '',
1638         'paybatchnum',  'int',     '',   '', '', '',
1639         'amount',  @money_type, '', '',
1640         '_date',   @date_type, '', '',
1641       ],
1642       'primary_key' => 'billpaynum',
1643       'unique' => [],
1644       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1645     },
1646
1647     'cust_bill_pay_pkg' => {
1648       'columns' => [
1649         'billpaypkgnum', 'serial', '', '', '', '',
1650         'billpaynum',       'int', '', '', '', '',
1651         'billpkgnum',       'int', '', '', '', '',
1652         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1653         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1654         'amount',         @money_type,     '', '',
1655         'setuprecur',      'varchar', '', $char_d, '', '',
1656         'sdate',   @date_type, '', '',
1657         'edate',   @date_type, '', '',
1658       ],
1659       'primary_key' => 'billpaypkgnum',
1660       'unique'      => [],
1661       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1662     },
1663
1664     'pay_batch' => { #batches of payments to an external processor
1665       'columns' => [
1666         'batchnum', 'serial',     '', '', '', '',
1667         'agentnum',    'int', 'NULL', '', '', '',
1668         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1669         'status',     'char', 'NULL',  1, '', '',
1670         'download',       @date_type,     '', '',
1671         'upload',         @date_type,     '', '',
1672         'title',   'varchar', 'NULL',255, '', '',
1673       ],
1674       'primary_key' => 'batchnum',
1675       'unique' => [],
1676       'index' => [],
1677     },
1678
1679     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1680       'columns' => [
1681         'paybatchnum',   'serial',    '',   '', '', '',
1682         'batchnum',   'int',    '',   '', '', '',
1683         'invnum',   'int',    '',   '', '', '',
1684         'custnum',   'int',    '',   '', '', '',
1685         'last',     'varchar', '',     $char_d, '', '',
1686         'first',    'varchar', '',     $char_d, '', '',
1687         'address1', 'varchar', '',     $char_d, '', '',
1688         'address2', 'varchar', 'NULL', $char_d, '', '',
1689         'city',     'varchar', '',     $char_d, '', '',
1690         'state',    'varchar', 'NULL', $char_d, '', '',
1691         'zip',      'varchar', 'NULL', 10, '', '',
1692         'country',  'char', '',     2, '', '',
1693         #        'trancode', 'int', '', '', '', ''
1694         'payby',    'char',        '',       4, '', '',
1695         'payinfo',  'varchar', 'NULL',     512, '', '',
1696         #'exp',      @date_type, '', ''
1697         'exp',      'varchar', 'NULL',      11, '', '',
1698         'payname',  'varchar', 'NULL', $char_d, '', '',
1699         'amount',   @money_type, '', '',
1700         'status',   'varchar', 'NULL', $char_d, '', '',
1701         'error_message',   'varchar', 'NULL', $char_d, '', '',
1702       ],
1703       'primary_key' => 'paybatchnum',
1704       'unique' => [],
1705       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1706     },
1707
1708     'fcc477map' => {
1709       'columns' => [
1710         'formkey',   'varchar',     '', 255, '', '',
1711         'formvalue',    'text', 'NULL',  '', '', '',
1712       ],
1713       'primary_key' => 'formkey',
1714       'unique'      => [],
1715       'index'       => [],
1716     },
1717
1718     'cust_pkg' => {
1719       'columns' => [
1720         'pkgnum',           'serial',     '', '', '', '',
1721         'custnum',             'int',     '', '', '', '',
1722         'pkgpart',             'int',     '', '', '', '',
1723         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1724         'contactnum',          'int', 'NULL', '', '', '',
1725         'locationnum',         'int', 'NULL', '', '', '',
1726         'otaker',          'varchar', 'NULL', 32, '', '',
1727         'usernum',             'int', 'NULL', '', '', '',
1728         'order_date',     @date_type,             '', '',
1729         'start_date',     @date_type,             '', '',
1730         'setup',          @date_type,             '', '',
1731         'bill',           @date_type,             '', '',
1732         'last_bill',      @date_type,             '', '',
1733         'susp',           @date_type,             '', '',
1734         'adjourn',        @date_type,             '', '',
1735         'resume',         @date_type,             '', '',
1736         'cancel',         @date_type,             '', '',
1737         'uncancel',       @date_type,             '', '',
1738         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1739         'expire',         @date_type,             '', '',
1740         'contract_end',   @date_type,             '', '',
1741         'dundate',        @date_type,             '', '',
1742         'change_date',    @date_type,             '', '',
1743         'change_pkgnum',       'int', 'NULL', '', '', '',
1744         'change_pkgpart',      'int', 'NULL', '', '', '',
1745         'change_locationnum',  'int', 'NULL', '', '', '',
1746         'change_custnum',      'int', 'NULL', '', '', '',
1747         'main_pkgnum',         'int', 'NULL', '', '', '',
1748         'pkglinknum',          'int', 'NULL', '', '', '',
1749         'manual_flag',        'char', 'NULL',  1, '', '',
1750         'no_auto',            'char', 'NULL',  1, '', '',
1751         'quantity',            'int', 'NULL', '', '', '',
1752         'agent_pkgid',         'int', 'NULL', '', '', '',
1753         'waive_setup',        'char', 'NULL',  1, '', '',
1754         'recur_show_zero',    'char', 'NULL',  1, '', '',
1755         'setup_show_zero',    'char', 'NULL',  1, '', '',
1756       ],
1757       'primary_key' => 'pkgnum',
1758       'unique' => [],
1759       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1760                    [ 'usernum' ], [ 'agent_pkgid' ],
1761                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1762                    ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
1763                    ['expire'], ['contract_end'], ['change_date'], ['no_auto'],
1764                  ],
1765     },
1766
1767     'cust_pkg_option' => {
1768       'columns' => [
1769         'optionnum', 'serial', '', '', '', '',
1770         'pkgnum', 'int', '', '', '', '',
1771         'optionname', 'varchar', '', $char_d, '', '',
1772         'optionvalue', 'text', 'NULL', '', '', '',
1773       ],
1774       'primary_key' => 'optionnum',
1775       'unique'      => [],
1776       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1777     },
1778
1779     'cust_pkg_detail' => {
1780       'columns' => [
1781         'pkgdetailnum', 'serial', '',      '', '', '',
1782         'pkgnum',          'int', '',      '', '', '',
1783         'detail',      'varchar', '', $char_d, '', '',
1784         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1785         'weight',          'int', '',      '', '', '',
1786       ],
1787       'primary_key' => 'pkgdetailnum',
1788       'unique' => [],
1789       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1790     },
1791
1792     'cust_pkg_reason' => {
1793       'columns' => [
1794         'num',      'serial',    '',   '', '', '',
1795         'pkgnum',   'int',    '',   '', '', '',
1796         'reasonnum','int',    '',   '', '', '',
1797         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1798         'otaker',   'varchar', 'NULL', 32, '', '',
1799         'usernum',   'int', 'NULL', '', '', '',
1800         'date',     @date_type, '', '',
1801       ],
1802       'primary_key' => 'num',
1803       'unique' => [],
1804       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1805     },
1806
1807     'cust_pkg_discount' => {
1808       'columns' => [
1809         'pkgdiscountnum', 'serial', '',        '', '', '',
1810         'pkgnum',            'int', '',        '', '', '',
1811         'discountnum',       'int', '',        '', '', '',
1812         'months_used',   'decimal', 'NULL', '7,4', '', '',
1813         'end_date',     @date_type,                '', '',
1814         'otaker',        'varchar', 'NULL',    32, '', '',
1815         'usernum',           'int', 'NULL',    '', '', '',
1816         'disabled',         'char', 'NULL',     1, '', '',
1817       ],
1818       'primary_key' => 'pkgdiscountnum',
1819       'unique' => [],
1820       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1821     },
1822
1823     'cust_pkg_usage' => {
1824       'columns' => [
1825         'pkgusagenum', 'serial', '', '', '', '',
1826         'pkgnum',         'int', '', '', '', '',
1827         'minutes',        'int', '', '', '', '',
1828         'pkgusagepart',   'int', '', '', '', '',
1829       ],
1830       'primary_key' => 'pkgusagenum',
1831       'unique' => [],
1832       'index'  => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
1833     },
1834
1835     'cdr_cust_pkg_usage' => {
1836       'columns' => [
1837         'cdrusagenum', 'bigserial', '', '', '', '',
1838         'acctid',      'bigint',    '', '', '', '',
1839         'pkgusagenum', 'int',       '', '', '', '',
1840         'minutes',     'int',       '', '', '', '',
1841       ],
1842       'primary_key' => 'cdrusagenum',
1843       'unique' => [],
1844       'index'  => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
1845     },
1846
1847     'cust_bill_pkg_discount' => {
1848       'columns' => [
1849         'billpkgdiscountnum', 'serial',        '', '', '', '',
1850         'billpkgnum',            'int',        '', '', '', '',
1851         'pkgdiscountnum',        'int',        '', '', '', '',
1852         'amount',          @money_type,                '', '',
1853         'months',            'decimal', 'NULL', '7,4', '', '',
1854       ],
1855       'primary_key' => 'billpkgdiscountnum',
1856       'unique' => [],
1857       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1858     },
1859
1860     'cust_bill_pkg_discount_void' => {
1861       'columns' => [
1862         'billpkgdiscountnum',    'int',        '', '', '', '',
1863         'billpkgnum',            'int',        '', '', '', '',
1864         'pkgdiscountnum',        'int',        '', '', '', '',
1865         'amount',          @money_type,                '', '',
1866         'months',            'decimal', 'NULL', '7,4', '', '',
1867       ],
1868       'primary_key' => 'billpkgdiscountnum',
1869       'unique' => [],
1870       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1871     },
1872
1873     'discount' => {
1874       'columns' => [
1875         'discountnum', 'serial',     '',      '', '', '',
1876         #'agentnum',       'int', 'NULL',      '', '', '',
1877         'name',       'varchar', 'NULL', $char_d, '', '',
1878         'amount',   @money_type,                  '', '',
1879         'percent',    'decimal',     '',   '7,4', '', '',
1880         'months',     'decimal', 'NULL',   '7,4', '', '',
1881         'disabled',      'char', 'NULL',       1, '', '',
1882         'setup',         'char', 'NULL',       1, '', '',
1883         #'linked',        'char', 'NULL',       1, '', '',
1884       ],
1885       'primary_key' => 'discountnum',
1886       'unique' => [],
1887       'index'  => [], # [ 'agentnum' ], ],
1888     },
1889
1890     'cust_refund' => {
1891       'columns' => [
1892         'refundnum',    'serial',    '',   '', '', '',
1893         'custnum',  'int',    '',   '', '', '',
1894         '_date',        @date_type, '', '',
1895         'refund',       @money_type, '', '',
1896         'otaker',       'varchar',   'NULL',   32, '', '',
1897         'usernum',   'int', 'NULL', '', '', '',
1898         'reason',       'varchar',   '',   $char_d, '', '',
1899         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1900                                                      # be index into payby
1901                                                      # table eventually
1902         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1903         'paymask', 'varchar', 'NULL', $char_d, '', '',
1904         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1905         'closed',    'char', 'NULL', 1, '', '',
1906         # credit card/EFT fields (formerly in paybatch)
1907         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1908         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1909         'auth',       'varchar','NULL',16, '', '', # CC auth number
1910         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
1911       ],
1912       'primary_key' => 'refundnum',
1913       'unique' => [],
1914       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1915     },
1916
1917     'cust_credit_refund' => {
1918       'columns' => [
1919         'creditrefundnum', 'serial',     '',   '', '', '',
1920         'crednum',  'int',     '',   '', '', '',
1921         'refundnum',  'int',     '',   '', '', '',
1922         'amount',  @money_type, '', '',
1923         '_date',   @date_type, '', '',
1924       ],
1925       'primary_key' => 'creditrefundnum',
1926       'unique' => [],
1927       'index' => [ ['crednum'], ['refundnum'] ],
1928     },
1929
1930
1931     'cust_svc' => {
1932       'columns' => [
1933         'svcnum',      'serial',     '', '', '', '',
1934         'pkgnum',         'int', 'NULL', '', '', '',
1935         'svcpart',        'int',     '', '', '', '',
1936         'agent_svcid',    'int', 'NULL', '', '', '',
1937         'overlimit',           @date_type,   '', '',
1938       ],
1939       'primary_key' => 'svcnum',
1940       'unique' => [],
1941       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
1942     },
1943
1944     'cust_svc_option' => {
1945       'columns' => [
1946         'optionnum',   'serial', '', '', '', '',
1947         'svcnum',      'int', '', '', '', '',
1948         'optionname',  'varchar', '', $char_d, '', '',
1949         'optionvalue', 'text', 'NULL', '', '', '',
1950       ],
1951       'primary_key' => 'optionnum',
1952       'unique'      => [],
1953       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1954     },
1955
1956     'svc_export_machine' => {
1957       'columns' => [
1958         'svcexportmachinenum', 'serial', '', '', '', '',
1959         'svcnum',                 'int', '', '', '', '',
1960         'exportnum',              'int', '', '', '', '',
1961         'machinenum',             'int', '', '', '', '',
1962       ],
1963       'primary_key' => 'svcexportmachinenum',
1964       'unique'      => [ ['svcnum', 'exportnum'] ],
1965       'index'       => [],
1966     },
1967
1968     'part_export_machine' => {
1969       'columns' => [
1970         'machinenum', 'serial', '', '', '', '',
1971         'exportnum',     'int', '', '', '', '',
1972         'machine',    'varchar', 'NULL', $char_d, '', '',
1973         'disabled',      'char', 'NULL',       1, '', '',
1974       ],
1975       'primary_key' => 'machinenum',
1976       'unique'      => [ [ 'exportnum', 'machine' ] ],
1977       'index'       => [ [ 'exportnum' ] ],
1978     },
1979
1980    'part_pkg' => {
1981       'columns' => [
1982         'pkgpart',       'serial',    '',   '', '', '',
1983         'pkg',           'varchar',   '',   $char_d, '', '',
1984         'comment',       'varchar',   '', 2*$char_d, '', '',
1985         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1986         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1987         'setuptax',      'char', 'NULL', 1, '', '',
1988         'recurtax',      'char', 'NULL', 1, '', '',
1989         'plan',          'varchar', 'NULL', $char_d, '', '',
1990         'disabled',      'char', 'NULL', 1, '', '',
1991         'custom',        'char', 'NULL', 1, '', '',
1992         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1993         'classnum',      'int',     'NULL', '', '', '',
1994         'addon_classnum','int',     'NULL', '', '', '',
1995         'taxproductnum', 'int',     'NULL', '', '', '',
1996         'setup_cost',    @money_typen,          '', '',
1997         'recur_cost',    @money_typen,          '', '',
1998         'pay_weight',    'real',    'NULL', '', '', '',
1999         'credit_weight', 'real',    'NULL', '', '', '',
2000         'agentnum',      'int',     'NULL', '', '', '',
2001         'fcc_ds0s',      'int',     'NULL', '', '', '',
2002         'fcc_voip_class','char',    'NULL',  1, '', '',
2003         'no_auto',          'char', 'NULL',  1, '', '',
2004         'recur_show_zero',  'char', 'NULL',  1, '', '',
2005         'setup_show_zero',  'char', 'NULL',  1, '', '',
2006         'successor',     'int',     'NULL', '', '', '',
2007         'family_pkgpart','int',     'NULL', '', '', '',
2008       ],
2009       'primary_key' => 'pkgpart',
2010       'unique' => [],
2011       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
2012                    [ 'agentnum' ], ['no_auto'],
2013                  ],
2014     },
2015
2016     'part_pkg_msgcat' => {
2017       'columns' => [
2018         'pkgpartmsgnum',  'serial',     '',        '', '', '',
2019         'pkgpart',           'int',     '',        '', '', '',
2020         'locale',        'varchar',     '',        16, '', '',
2021         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
2022         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2023       ],
2024       'primary_key' => 'pkgpartmsgnum',
2025       'unique'      => [ [ 'pkgpart', 'locale' ] ],
2026       'index'       => [],
2027     },
2028
2029     'part_pkg_link' => {
2030       'columns' => [
2031         'pkglinknum',  'serial',   '',      '', '', '',
2032         'src_pkgpart', 'int',      '',      '', '', '',
2033         'dst_pkgpart', 'int',      '',      '', '', '',
2034         'link_type',   'varchar',  '', $char_d, '', '',
2035         'hidden',      'char', 'NULL',       1, '', '',
2036       ],
2037       'primary_key' => 'pkglinknum',
2038       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
2039       'index'  => [ [ 'src_pkgpart' ] ],
2040     },
2041     # XXX somewhat borked unique: we don't really want a hidden and unhidden
2042     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
2043
2044     'part_pkg_discount' => {
2045       'columns' => [
2046         'pkgdiscountnum', 'serial',   '',      '', '', '',
2047         'pkgpart',        'int',      '',      '', '', '',
2048         'discountnum',    'int',      '',      '', '', '',
2049       ],
2050       'primary_key' => 'pkgdiscountnum',
2051       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
2052       'index'  => [],
2053     },
2054
2055     'part_pkg_taxclass' => {
2056       'columns' => [
2057         'taxclassnum',  'serial', '',       '', '', '',
2058         'taxclass',     'varchar', '', $char_d, '', '',
2059         'disabled', 'char',   'NULL',         1, '', '',
2060       ],
2061       'primary_key' => 'taxclassnum',
2062       'unique'      => [ [ 'taxclass' ] ],
2063       'index'       => [ [ 'disabled' ] ],
2064     },
2065
2066     'part_pkg_taxproduct' => {
2067       'columns' => [
2068         'taxproductnum', 'serial',      '',        '', '', '',
2069         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
2070         'taxproduct',    'varchar',     '',   $char_d, '', '',
2071         'description',   'varchar',     '', 3*$char_d, '', '',
2072       ],
2073       'primary_key' => 'taxproductnum',
2074       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
2075       'index'       => [],
2076     },
2077
2078     'part_pkg_taxrate' => {
2079       'columns' => [
2080         'pkgtaxratenum', 'serial',  '',     '',      '', '',
2081         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
2082         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
2083         'taxproductnum', 'int',  '',     '',       '', '',
2084         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
2085         'county',           'varchar', 'NULL', $char_d, '', '',
2086         'state',            'varchar', 'NULL', $char_d, '', '',
2087         'local',            'varchar', 'NULL', $char_d, '', '',
2088         'country',          'char',    'NULL', 2,       '', '',
2089         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
2090         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
2091         'taxclassnum',      'int',     'NULL', '',      '', '',
2092         'effdate',          @date_type, '', '',
2093         'taxable',          'char',    'NULL', 1,       '', '',
2094       ],
2095       'primary_key' => 'pkgtaxratenum',
2096       'unique' => [],
2097       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
2098     },
2099
2100     'part_pkg_taxoverride' => {
2101       'columns' => [
2102         'taxoverridenum', 'serial', '', '', '', '',
2103         'pkgpart',           'int', '', '', '', '',
2104         'taxclassnum',       'int', '', '', '', '',
2105         'usage_class',    'varchar', 'NULL', $char_d, '', '',
2106       ],
2107       'primary_key' => 'taxoverridenum',
2108       'unique' => [],
2109       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
2110     },
2111
2112 #    'part_title' => {
2113 #      'columns' => [
2114 #        'titlenum',   'int',    '',   '',
2115 #        'title',      'varchar',   '',   $char_d,
2116 #      ],
2117 #      'primary_key' => 'titlenum',
2118 #      'unique' => [ [] ],
2119 #      'index' => [ [] ],
2120 #    },
2121
2122     'pkg_svc' => {
2123       'columns' => [
2124         'pkgsvcnum',  'serial', '',  '', '', '',
2125         'pkgpart',    'int',    '',   '', '', '',
2126         'svcpart',    'int',    '',   '', '', '',
2127         'quantity',   'int',    '',   '', '', '',
2128         'primary_svc','char', 'NULL',  1, '', '',
2129         'hidden',     'char', 'NULL',  1, '', '',
2130       ],
2131       'primary_key' => 'pkgsvcnum',
2132       'unique' => [ ['pkgpart', 'svcpart'] ],
2133       'index' => [ ['pkgpart'], ['quantity'] ],
2134     },
2135
2136     'part_referral' => {
2137       'columns' => [
2138         'refnum',   'serial',     '',        '', '', '',
2139         'referral', 'varchar',    '',   $char_d, '', '',
2140         'disabled', 'char',   'NULL',         1, '', '',
2141         'agentnum', 'int',    'NULL',        '', '', '',
2142       ],
2143       'primary_key' => 'refnum',
2144       'unique' => [],
2145       'index' => [ ['disabled'], ['agentnum'], ],
2146     },
2147
2148     'part_svc' => {
2149       'columns' => [
2150         'svcpart',             'serial',     '',        '', '', '',
2151         'svc',                'varchar',     '',   $char_d, '', '',
2152         'svcdb',              'varchar',     '',   $char_d, '', '',
2153         'disabled',              'char', 'NULL',         1, '', '',
2154         'preserve',              'char', 'NULL',         1, '', '',
2155         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
2156         'classnum',               'int', 'NULL',        '', '', '',
2157         'restrict_edit_password','char', 'NULL',         1, '', '',
2158 ],
2159       'primary_key' => 'svcpart',
2160       'unique' => [],
2161       'index' => [ [ 'disabled' ] ],
2162     },
2163
2164     'part_svc_column' => {
2165       'columns' => [
2166         'columnnum',   'serial',      '',      '', '', '',
2167         'svcpart',     'int',         '',      '', '', '',
2168         'columnname',  'varchar',     '',      64, '', '',
2169         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
2170         'columnvalue', 'varchar', 'NULL',     512, '', '',
2171         'columnflag',  'char',    'NULL',       1, '', '',
2172       ],
2173       'primary_key' => 'columnnum',
2174       'unique' => [ [ 'svcpart', 'columnname' ] ],
2175       'index' => [ [ 'svcpart' ] ],
2176     },
2177
2178     'part_svc_class' => {
2179       'columns' => [
2180         'classnum',    'serial',   '',      '', '', '',
2181         'classname',   'varchar',  '', $char_d, '', '',
2182         'disabled',    'char', 'NULL',       1, '', '',
2183       ],
2184       'primary_key' => 'classnum',
2185       'unique' => [],
2186       'index' => [ ['disabled'] ],
2187     },
2188
2189     #(this should be renamed to part_pop)
2190     'svc_acct_pop' => {
2191       'columns' => [
2192         'popnum',    'serial',    '',   '', '', '',
2193         'city',      'varchar',   '',   $char_d, '', '',
2194         'state',     'varchar',   '',   $char_d, '', '',
2195         'ac',        'char',   '',   3, '', '',
2196         'exch',      'char',   '',   3, '', '',
2197         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
2198       ],
2199       'primary_key' => 'popnum',
2200       'unique' => [],
2201       'index' => [ [ 'state' ] ],
2202     },
2203
2204     'part_pop_local' => {
2205       'columns' => [
2206         'localnum',  'serial',     '',     '', '', '',
2207         'popnum',    'int',     '',     '', '', '',
2208         'city',      'varchar', 'NULL', $char_d, '', '',
2209         'state',     'char',    'NULL', 2, '', '',
2210         'npa',       'char',    '',     3, '', '',
2211         'nxx',       'char',    '',     3, '', '',
2212       ],
2213       'primary_key' => 'localnum',
2214       'unique' => [],
2215       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
2216     },
2217
2218     'qual' => {
2219       'columns' => [
2220         'qualnum',  'serial',     '',     '', '', '',
2221         'custnum',    'int',     'NULL',     '', '', '',
2222         'prospectnum',    'int',     'NULL',     '', '', '',
2223         'locationnum',    'int',     'NULL',     '', '', '',
2224         'phonenum',     'varchar', 'NULL',       24, '', '',
2225         'exportnum',      'int', 'NULL', '', '', '',
2226         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
2227         'status',      'char', '', 1, '', '',
2228       ],
2229       'primary_key' => 'qualnum',
2230       'unique' => [],
2231       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
2232                     ['phonenum'], ['vendor_qual_id'] ],
2233     },
2234
2235     'qual_option' => {
2236       'columns' => [
2237         'optionnum', 'serial', '', '', '', '',
2238         'qualnum',  'int',     '',     '', '', '',
2239         'optionname', 'varchar', '', $char_d, '', '',
2240         'optionvalue', 'text', 'NULL', '', '', '',
2241       ],
2242       'primary_key' => 'optionnum',
2243       'unique' => [],
2244       'index' => [],
2245     },
2246
2247     'svc_acct' => {
2248       'columns' => [
2249         'svcnum',    'int',    '',   '', '', '',
2250         'username',  'varchar',   '',   $username_len, '', '',
2251         '_password', 'varchar',   'NULL',  512, '', '',
2252         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
2253         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
2254         'popnum',    'int',    'NULL',   '', '', '',
2255         'sectornum', 'int', 'NULL',      '', '', '',
2256         'uid',       'int', 'NULL',   '', '', '',
2257         'gid',       'int', 'NULL',   '', '', '',
2258         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
2259         'dir',       'varchar',   'NULL',   $char_d, '', '',
2260         'shell',     'varchar',   'NULL',   $char_d, '', '',
2261         'quota',     'varchar',   'NULL',   $char_d, '', '',
2262         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
2263         # IP address mgmt
2264         'routernum', 'int', 'NULL',      '', '', '',
2265         'blocknum',  'int', 'NULL',      '', '', '',
2266         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
2267         'seconds_threshold',   'int', 'NULL',   '', '', '',
2268         'upbytes',   'bigint', 'NULL',   '', '', '',
2269         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
2270         'downbytes', 'bigint', 'NULL',   '', '', '',
2271         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
2272         'totalbytes','bigint', 'NULL',   '', '', '',
2273         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
2274         'domsvc',    'int',     '', '', '', '',
2275         'pbxsvc',    'int', 'NULL', '', '', '',
2276         'last_login',  @date_type, '', '',
2277         'last_logout', @date_type, '', '',
2278         #cardfortress field(s)
2279         'cf_privatekey',      'text', 'NULL',      '', '', '',
2280         #communigate pro fields (quota = MaxAccountSize)
2281         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
2282         #settings
2283         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
2284         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
2285         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
2286         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
2287         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
2288         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
2289         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
2290         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
2291         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
2292         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
2293         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
2294         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
2295         #XXX mailing lists
2296         #preferences
2297         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
2298         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
2299         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
2300         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
2301         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
2302         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
2303         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
2304         #mail
2305         #XXX RPOP settings
2306         #
2307       ],
2308       'primary_key' => 'svcnum',
2309       #'unique' => [ [ 'username', 'domsvc' ] ],
2310       'unique' => [],
2311       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
2312     },
2313
2314     'acct_rt_transaction' => {
2315       'columns' => [
2316         'svcrtid',   'int',    '',   '', '', '',
2317         'svcnum',    'int',    '',   '', '', '',
2318         'transaction_id',       'int', '',   '', '', '',
2319         '_date',   @date_type, '', '',
2320         'seconds',   'int', '',   '', '', '', #uhhhh
2321         'support',   'int', '',   '', '', '',
2322       ],
2323       'primary_key' => 'svcrtid',
2324       'unique' => [],
2325       'index' => [ ['svcnum', 'transaction_id'] ],
2326     },
2327
2328     #'svc_charge' => {
2329     #  'columns' => [
2330     #    'svcnum',    'int',    '',   '',
2331     #    'amount',    @money_type,
2332     #  ],
2333     #  'primary_key' => 'svcnum',
2334     #  'unique' => [ [] ],
2335     #  'index' => [ [] ],
2336     #},
2337
2338     'svc_domain' => {
2339       'columns' => [
2340         'svcnum',           'int',    '',        '', '', '',
2341         'domain',       'varchar',    '',   $char_d, '', '',
2342         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2343         'catchall',         'int', 'NULL',       '', '', '',
2344         'parent_svcnum',    'int', 'NULL',       '', '', '',
2345         'registrarnum',     'int', 'NULL',       '', '', '',
2346         'registrarkey', 'varchar', 'NULL',      512, '', '',
2347         'setup_date',      @date_type, '', '',
2348         'renewal_interval', 'int', 'NULL',       '', '', '',
2349         'expiration_date', @date_type, '', '',
2350         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2351         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2352         #communigate pro fields (quota = MaxAccountSize)
2353         'max_accounts',     'int', 'NULL',       '', '', '',
2354         'trailer',         'text', 'NULL',       '', '', '',
2355         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2356         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2357         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2358         #settings
2359         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
2360         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
2361         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2362         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2363         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2364         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2365         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2366         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2367         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
2368         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
2369         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
2370         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2371         #preferences
2372         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2373         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2374         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2375         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2376         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2377         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2378         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2379       ],
2380       'primary_key' => 'svcnum',
2381       'unique' => [ ],
2382       'index' => [ ['domain'] ],
2383     },
2384
2385     'svc_dsl' => {
2386       'columns' => [
2387         'svcnum',                    'int',    '',        '', '', '',
2388         'pushed',                    'int', 'NULL',       '', '', '',
2389         'desired_due_date',          'int', 'NULL',       '', '', '',
2390         'due_date',                  'int', 'NULL',       '', '', '',
2391         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2392         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2393         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2394         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2395         'first',                 'varchar', 'NULL', $char_d,  '', '',
2396         'last',                  'varchar', 'NULL', $char_d,  '', '',
2397         'company',               'varchar', 'NULL', $char_d,  '', '',
2398         'phonenum',              'varchar', 'NULL',      24, '', '',
2399         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2400         'loop_type',                'char', 'NULL',       1, '', '',
2401         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2402         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2403         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2404         'vpi',                       'int', 'NULL',      '', '', '',
2405         'vci',                       'int', 'NULL',      '', '', '',
2406         'isp_chg',                  'char', 'NULL',       1, '', '',
2407         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2408         'username',              'varchar', 'NULL', $char_d, '', '',
2409         'password',              'varchar', 'NULL', $char_d, '', '',
2410         'staticips',                'text', 'NULL',      '', '', '',
2411         'monitored',                'char', 'NULL',       1, '', '',
2412         'last_pull',                 'int', 'NULL',      '', '', '',
2413       ],
2414       'primary_key' => 'svcnum',
2415       'unique' => [ ],
2416       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2417     },
2418
2419     'dsl_device' => {
2420       'columns' => [
2421         'devicenum', 'serial',     '', '', '', '',
2422         #part_device?  or our own part_dsl_device?
2423         #'devicepart',   'int',     '', '', '', '',
2424         'svcnum',       'int',     '', '', '', '',
2425         'mac_addr', 'varchar',     '', 12, '', '',
2426       ],
2427       'primary_key' => 'devicenum',
2428       'unique' => [ [ 'mac_addr' ], ],
2429       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2430     },
2431
2432     'dsl_note' => {
2433       'columns' => [
2434         'notenum',           'serial',    '',        '', '', '',
2435         'svcnum',     'int', '',       '', '', '',
2436         'author',     'varchar', 'NULL', $char_d,  '', '',
2437         'priority',   'char', 'NULL',       1,  '', '',
2438         '_date',     'int', 'NULL',       '', '', '',
2439         'note',     'text', '',       '', '', '',
2440       ],
2441       'primary_key' => 'notenum',
2442       'unique' => [ ],
2443       'index' => [ ['svcnum'] ],
2444     },
2445
2446     'svc_dish' => {
2447       'columns' => [
2448         'svcnum',   'int',     '',     '', '', '',
2449         'acctnum',  'varchar', '',     16, '', '',
2450         'installdate', @date_type,         '', '',
2451         'note',     'text',    'NULL', '', '', '',
2452       ],
2453       'primary_key' => 'svcnum',
2454       'unique' => [ ],
2455       'index' => [ ],
2456     },
2457
2458     'svc_hardware' => {
2459       'columns' => [
2460         'svcnum',   'int',     '',          '', '', '',
2461         'typenum',  'int',     '',          '', '', '',
2462         'serial',   'varchar', 'NULL', $char_d, '', '',
2463         'ip_addr',  'varchar', 'NULL',      40, '', '',
2464         'hw_addr',  'varchar', 'NULL',      12, '', '',
2465         'smartcard','varchar', 'NULL',      30, '', '',
2466         'statusnum','int',     'NULL',      '', '', '',
2467         'note',     'text',    'NULL',      '', '', '',
2468       ],
2469       'primary_key' => 'svcnum',
2470       'unique' => [ ],
2471       'index' => [ ],
2472     },
2473
2474     'hardware_class' => {
2475       'columns' => [
2476         'classnum',   'serial', '',      '', '', '',
2477         'classname', 'varchar', '', $char_d, '', '',
2478       ],
2479       'primary_key' => 'classnum',
2480       'unique' => [ ],
2481       'index'  => [ ],
2482     },
2483
2484     'hardware_type' => {
2485       'columns' => [
2486         'typenum',  'serial',     '',      '', '', '',
2487         'classnum',    'int',     '',      '', '', '',
2488         'model',   'varchar',     '', $char_d, '', '',
2489         'revision','varchar', 'NULL', $char_d, '', '',
2490       ],
2491       'primary_key' => 'typenum',
2492       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2493       'index'  => [ ],
2494     },
2495
2496     'hardware_status' => {
2497       'columns' => [
2498         'statusnum', 'serial', '',      '', '', '',
2499         'label'    ,'varchar', '', $char_d, '', '',
2500         'disabled',    'char', 'NULL',   1, '', '',
2501       ],
2502       'primary_key' => 'statusnum',
2503       'unique' => [ ],
2504       'index'  => [ ],
2505     },
2506
2507     'domain_record' => {
2508       'columns' => [
2509         'recnum',    'serial',     '',  '', '', '',
2510         'svcnum',    'int',     '',  '', '', '',
2511         'reczone',   'varchar', '',  255, '', '',
2512         'recaf',     'char',    '',  2, '', '',
2513         'rectype',   'varchar',    '',  5, '', '',
2514         'recdata',   'varchar', '',  255, '', '',
2515         'ttl',       'int',     'NULL', '', '', '',
2516       ],
2517       'primary_key' => 'recnum',
2518       'unique'      => [],
2519       'index'       => [ ['svcnum'] ],
2520     },
2521
2522     'registrar' => {
2523       'columns' => [
2524         'registrarnum',   'serial', '',      '', '', '',
2525         'registrarname', 'varchar', '', $char_d, '', '',
2526       ],
2527       'primary_key' => 'registrarnum',
2528       'unique'      => [],
2529       'index'       => [],
2530     },
2531
2532     'cgp_rule' => {
2533       'columns' => [
2534         'rulenum',  'serial',     '',      '', '', '',
2535         'name',    'varchar',     '', $char_d, '', '',
2536         'comment', 'varchar', 'NULL', $char_d, '', '',
2537         'svcnum',      'int',     '',      '', '', '',
2538         'priority',    'int',     '',      '', '', '',
2539       ],
2540       'primary_key' => 'rulenum',
2541       'unique'      => [ [ 'svcnum', 'name' ] ],
2542       'index'       => [ [ 'svcnum' ] ],
2543     },
2544
2545     'cgp_rule_condition' => {
2546       'columns' => [
2547         'ruleconditionnum',  'serial',     '',      '', '', '',
2548         'conditionname',    'varchar',     '', $char_d, '', '',
2549         'op',               'varchar', 'NULL', $char_d, '', '',
2550         'params',           'varchar', 'NULL',     255, '', '',
2551         'rulenum',              'int',     '',      '', '', '',
2552       ],
2553       'primary_key' => 'ruleconditionnum',
2554       'unique'      => [],
2555       'index'       => [ [ 'rulenum' ] ],
2556     },
2557
2558     'cgp_rule_action' => {
2559        'columns' => [
2560         'ruleactionnum',  'serial',     '',      '', '', '',
2561         'action',        'varchar',     '', $char_d, '', '',
2562         'params',        'varchar', 'NULL',     255, '', '',
2563         'rulenum',           'int',     '',      '', '', '',
2564       ],
2565       'primary_key' => 'ruleactionnum',
2566       'unique'      => [],
2567       'index'       => [ [ 'rulenum' ] ],
2568    },
2569
2570     'svc_forward' => {
2571       'columns' => [
2572         'svcnum',   'int',            '',   '', '', '',
2573         'srcsvc',   'int',        'NULL',   '', '', '',
2574         'src',      'varchar',    'NULL',  255, '', '',
2575         'dstsvc',   'int',        'NULL',   '', '', '',
2576         'dst',      'varchar',    'NULL',  255, '', '',
2577       ],
2578       'primary_key' => 'svcnum',
2579       'unique'      => [],
2580       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2581     },
2582
2583     'svc_www' => {
2584       'columns' => [
2585         'svcnum',   'int',      '',  '', '', '',
2586         'recnum',   'int',      '',  '', '', '',
2587         'usersvc',  'int',  'NULL',  '', '', '',
2588         'config',   'text', 'NULL',  '', '', '',
2589       ],
2590       'primary_key' => 'svcnum',
2591       'unique'      => [],
2592       'index'       => [],
2593     },
2594
2595     #'svc_wo' => {
2596     #  'columns' => [
2597     #    'svcnum',    'int',    '',   '',
2598     #    'svcnum',    'int',    '',   '',
2599     #    'svcnum',    'int',    '',   '',
2600     #    'worker',    'varchar',   '',   $char_d,
2601     #    '_date',     @date_type,
2602     #  ],
2603     #  'primary_key' => 'svcnum',
2604     #  'unique' => [ [] ],
2605     #  'index' => [ [] ],
2606     #},
2607
2608     'prepay_credit' => {
2609       'columns' => [
2610         'prepaynum',   'serial',     '',   '', '', '',
2611         'identifier',  'varchar', '', $char_d, '', '',
2612         'amount',      @money_type, '', '',
2613         'seconds',     'int',     'NULL', '', '', '',
2614         'upbytes',     'bigint',     'NULL', '', '', '',
2615         'downbytes',   'bigint',     'NULL', '', '', '',
2616         'totalbytes',  'bigint',     'NULL', '', '', '',
2617         'agentnum',    'int',     'NULL', '', '', '',
2618       ],
2619       'primary_key' => 'prepaynum',
2620       'unique'      => [ ['identifier'] ],
2621       'index'       => [],
2622     },
2623
2624     'port' => {
2625       'columns' => [
2626         'portnum',  'serial',     '',   '', '', '',
2627         'ip',       'varchar', 'NULL', 15, '', '',
2628         'nasport',  'int',     'NULL', '', '', '',
2629         'nasnum',   'int',     '',   '', '', '',
2630       ],
2631       'primary_key' => 'portnum',
2632       'unique'      => [],
2633       'index'       => [],
2634     },
2635
2636     'nas' => {
2637       'columns' => [
2638         'nasnum',       'serial',     '',  '',              '', '',
2639         'nasname',     'varchar',     '', 128,              '', '',
2640         'shortname',   'varchar', 'NULL',  32,              '', '',
2641         'type',        'varchar',     '',  30,         'other', '',
2642         'ports',           'int', 'NULL',  '',              '', '',
2643         'secret',      'varchar',     '',  60,        'secret', '',
2644         'server',      'varchar', 'NULL',  64,              '', '',
2645         'community',   'varchar', 'NULL',  50,              '', '',
2646         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2647         'svcnum',          'int', 'NULL',  '',              '', '',
2648       ],
2649       'primary_key' => 'nasnum',
2650       'unique'      => [ [ 'nasname' ], ],
2651       'index'       => [],
2652     },
2653
2654     'export_nas' => {
2655       'columns' => [
2656         'exportnasnum', 'serial', '', '', '', '',
2657         'exportnum',       'int', '', '', '', '',
2658         'nasnum',          'int', '', '', '', '',
2659       ],
2660       'primary_key' => 'exportnasnum',
2661       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2662       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
2663     },
2664
2665     'queue' => {
2666       'columns' => [
2667         'jobnum',      'serial',     '',      '', '', '',
2668         'job',        'varchar',     '',     512, '', '',
2669         '_date',          'int',     '',      '', '', '',
2670         'status',     'varchar',     '', $char_d, '', '',
2671         'statustext',    'text', 'NULL',      '', '', '',
2672         'svcnum',         'int', 'NULL',      '', '', '',
2673         'custnum',        'int', 'NULL',      '', '', '',
2674         'secure',        'char', 'NULL',       1, '', '',
2675         'priority',       'int', 'NULL',      '', '', '',
2676       ],
2677       'primary_key' => 'jobnum',
2678       'unique'      => [],
2679       'index'       => [ [ 'secure' ], [ 'priority' ],
2680                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2681                        ],
2682     },
2683
2684     'queue_arg' => {
2685       'columns' => [
2686         'argnum', 'serial', '', '', '', '',
2687         'jobnum', 'int', '', '', '', '',
2688         'frozen', 'char', 'NULL',       1, '', '',
2689         'arg', 'text', 'NULL', '', '', '',
2690       ],
2691       'primary_key' => 'argnum',
2692       'unique'      => [],
2693       'index'       => [ [ 'jobnum' ] ],
2694     },
2695
2696     'queue_depend' => {
2697       'columns' => [
2698         'dependnum', 'serial', '', '', '', '',
2699         'jobnum', 'int', '', '', '', '',
2700         'depend_jobnum', 'int', '', '', '', '',
2701       ],
2702       'primary_key' => 'dependnum',
2703       'unique'      => [],
2704       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2705     },
2706
2707     'export_svc' => {
2708       'columns' => [
2709         'exportsvcnum' => 'serial', '', '', '', '',
2710         'exportnum'    => 'int', '', '', '', '',
2711         'svcpart'      => 'int', '', '', '', '',
2712       ],
2713       'primary_key' => 'exportsvcnum',
2714       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2715       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2716     },
2717
2718     'export_device' => {
2719       'columns' => [
2720         'exportdevicenum' => 'serial', '', '', '', '',
2721         'exportnum'    => 'int', '', '', '', '',
2722         'devicepart'      => 'int', '', '', '', '',
2723       ],
2724       'primary_key' => 'exportdevicenum',
2725       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2726       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2727     },
2728
2729     'part_export' => {
2730       'columns' => [
2731         'exportnum',   'serial',     '',      '', '', '',
2732         'exportname', 'varchar', 'NULL', $char_d, '', '',
2733         'machine',    'varchar', 'NULL', $char_d, '', '',
2734         'exporttype', 'varchar',     '', $char_d, '', '',
2735         'nodomain',      'char', 'NULL',       1, '', '',
2736         'default_machine','int', 'NULL',      '', '', '',
2737       ],
2738       'primary_key' => 'exportnum',
2739       'unique'      => [],
2740       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2741     },
2742
2743     'part_export_option' => {
2744       'columns' => [
2745         'optionnum', 'serial', '', '', '', '',
2746         'exportnum', 'int', '', '', '', '',
2747         'optionname', 'varchar', '', $char_d, '', '',
2748         'optionvalue', 'text', 'NULL', '', '', '',
2749       ],
2750       'primary_key' => 'optionnum',
2751       'unique'      => [],
2752       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2753     },
2754
2755     'radius_usergroup' => {
2756       'columns' => [
2757         'usergroupnum', 'serial', '', '', '', '',
2758         'svcnum',       'int', '', '', '', '',
2759         'groupname',    'varchar', 'NULL', $char_d, '', '',
2760         'groupnum',     'int', 'NULL', '', '', '',
2761       ],
2762       'primary_key' => 'usergroupnum',
2763       'unique'      => [],
2764       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2765     },
2766
2767     'radius_group' => {
2768       'columns' => [
2769         'groupnum', 'serial', '', '', '', '',
2770         'groupname',    'varchar', '', $char_d, '', '',
2771         'description',  'varchar', 'NULL', $char_d, '', '',
2772         'priority', 'int', '', '', '1', '',
2773         'speed_up', 'int', 'NULL', '', '', '',
2774         'speed_down', 'int', 'NULL', '', '', '',
2775       ],
2776       'primary_key' => 'groupnum',
2777       'unique'      => [ ['groupname'] ],
2778       'index'       => [],
2779     },
2780
2781     'radius_attr' => {
2782       'columns' => [
2783         'attrnum',   'serial', '',      '', '', '',
2784         'groupnum',     'int', '',      '', '', '',
2785         'attrname', 'varchar', '', $char_d, '', '',
2786         'value',    'varchar', '',     255, '', '',
2787         'attrtype',    'char', '',       1, '', '',
2788         'op',          'char', '',       2, '', '',
2789       ],
2790       'primary_key' => 'attrnum',
2791       'unique'      => [],
2792       'index'       => [ ['groupnum'], ],
2793     },
2794
2795     'msgcat' => {
2796       'columns' => [
2797         'msgnum', 'serial', '', '', '', '',
2798         'msgcode', 'varchar', '', 255, '', '',
2799         'locale', 'varchar', '', 16, '', '',
2800         'msg', 'text', '', '', '', '',
2801       ],
2802       'primary_key' => 'msgnum',
2803       'unique'      => [ [ 'msgcode', 'locale' ] ],
2804       'index'       => [],
2805     },
2806
2807     'cust_tax_exempt' => {
2808       'columns' => [
2809         'exemptnum', 'serial', '', '', '', '',
2810         'custnum',   'int', '', '', '', '',
2811         'taxnum',    'int', '', '', '', '',
2812         'year',      'int', '', '', '', '',
2813         'month',     'int', '', '', '', '',
2814         'amount',   @money_type, '', '',
2815       ],
2816       'primary_key' => 'exemptnum',
2817       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2818       'index'       => [],
2819     },
2820
2821     'cust_tax_exempt_pkg' => {
2822       'columns' => [
2823         'exemptpkgnum',  'serial', '', '', '', '',
2824         #'custnum',      'int', '', '', '', ''
2825         'billpkgnum',   'int', '', '', '', '',
2826         'taxnum',       'int', '', '', '', '',
2827         'year',         'int', 'NULL', '', '', '',
2828         'month',        'int', 'NULL', '', '', '',
2829         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2830         'amount',       @money_type, '', '',
2831         # exemption type flags
2832         'exempt_cust',          'char', 'NULL', 1, '', '',
2833         'exempt_setup',         'char', 'NULL', 1, '', '',
2834         'exempt_recur',         'char', 'NULL', 1, '', '',
2835         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
2836         'exempt_monthly',       'char', 'NULL', 1, '', '',
2837       ],
2838       'primary_key' => 'exemptpkgnum',
2839       'unique' => [],
2840       'index'  => [ [ 'taxnum', 'year', 'month' ],
2841                     [ 'billpkgnum' ],
2842                     [ 'taxnum' ],
2843                     [ 'creditbillpkgnum' ],
2844                   ],
2845     },
2846
2847     'cust_tax_exempt_pkg_void' => {
2848       'columns' => [
2849         'exemptpkgnum',  'int', '', '', '', '',
2850         #'custnum',      'int', '', '', '', ''
2851         'billpkgnum',   'int', '', '', '', '',
2852         'taxnum',       'int', '', '', '', '',
2853         'year',         'int', 'NULL', '', '', '',
2854         'month',        'int', 'NULL', '', '', '',
2855         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2856         'amount',       @money_type, '', '',
2857         # exemption type flags
2858         'exempt_cust',          'char', 'NULL', 1, '', '',
2859         'exempt_setup',         'char', 'NULL', 1, '', '',
2860         'exempt_recur',         'char', 'NULL', 1, '', '',
2861         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
2862         'exempt_monthly',       'char', 'NULL', 1, '', '',
2863       ],
2864       'primary_key' => 'exemptpkgnum',
2865       'unique' => [],
2866       'index'  => [ [ 'taxnum', 'year', 'month' ],
2867                     [ 'billpkgnum' ],
2868                     [ 'taxnum' ],
2869                     [ 'creditbillpkgnum' ],
2870                   ],
2871     },
2872
2873     'router' => {
2874       'columns' => [
2875         'routernum', 'serial', '', '', '', '',
2876         'routername', 'varchar', '', $char_d, '', '',
2877         'svcnum', 'int', 'NULL', '', '', '',
2878         'agentnum',   'int', 'NULL', '', '', '',
2879         'manual_addr', 'char', 'NULL', 1, '', '',
2880       ],
2881       'primary_key' => 'routernum',
2882       'unique'      => [],
2883       'index'       => [],
2884     },
2885
2886     'part_svc_router' => {
2887       'columns' => [
2888         'svcrouternum', 'serial', '', '', '', '',
2889         'svcpart', 'int', '', '', '', '',
2890         'routernum', 'int', '', '', '', '',
2891       ],
2892       'primary_key' => 'svcrouternum',
2893       'unique'      => [],
2894       'index'       => [],
2895     },
2896
2897     'addr_block' => {
2898       'columns' => [
2899         'blocknum', 'serial', '', '', '', '',
2900         'routernum', 'int', '', '', '', '',
2901         'ip_gateway', 'varchar', '', 15, '', '',
2902         'ip_netmask', 'int', '', '', '', '',
2903         'agentnum',   'int', 'NULL', '', '', '',
2904         'manual_flag', 'char', 'NULL', 1, '', '',
2905       ],
2906       'primary_key' => 'blocknum',
2907       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2908       'index'       => [],
2909     },
2910
2911     'svc_broadband' => {
2912       'columns' => [
2913         'svcnum',                  'int',     '',        '', '', '',
2914         'description',         'varchar', 'NULL',   $char_d, '', '',
2915         'routernum',               'int', 'NULL',        '', '', '',
2916         'blocknum',                'int', 'NULL',        '', '', '',
2917         'sectornum',               'int', 'NULL',        '', '', '',
2918         'speed_up',                'int', 'NULL',        '', '', '',
2919         'speed_down',              'int', 'NULL',        '', '', '',
2920         'ip_addr',             'varchar', 'NULL',        15, '', '',
2921         'mac_addr',            'varchar', 'NULL',        12, '', '',
2922         'authkey',             'varchar', 'NULL',        32, '', '',
2923         'latitude',            'decimal', 'NULL',    '10,7', '', '',
2924         'longitude',           'decimal', 'NULL',    '10,7', '', '',
2925         'altitude',            'decimal', 'NULL',        '', '', '',
2926         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
2927         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
2928         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
2929         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
2930         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
2931         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
2932         'rssi',                    'int', 'NULL',        '', '', '',
2933         'suid',                    'int', 'NULL',        '', '', '',
2934         'shared_svcnum',           'int', 'NULL',        '', '', '',
2935       ],
2936       'primary_key' => 'svcnum',
2937       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
2938       'index'       => [],
2939     },
2940
2941     'tower' => {
2942       'columns' => [
2943         'towernum',   'serial',     '',      '', '', '',
2944         #'agentnum',      'int', 'NULL',      '', '', '',
2945         'towername', 'varchar',     '', $char_d, '', '',
2946         'disabled',     'char', 'NULL',       1, '', '',
2947         'latitude', 'decimal', 'NULL',   '10,7', '', '',
2948         'longitude','decimal', 'NULL',   '10,7', '', '',
2949         'altitude', 'decimal', 'NULL',       '', '', '',
2950         'coord_auto',  'char', 'NULL',        1, '', '',
2951       ],
2952       'primary_key' => 'towernum',
2953       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
2954       'index'       => [],
2955     },
2956
2957     'tower_sector' => {
2958       'columns' => [
2959         'sectornum',   'serial',     '',      '', '', '',
2960         'towernum',       'int',     '',      '', '', '',
2961         'sectorname', 'varchar',     '', $char_d, '', '',
2962         'ip_addr',    'varchar', 'NULL',      15, '', '',
2963       ],
2964       'primary_key' => 'sectornum',
2965       'unique'      => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
2966       'index'       => [ [ 'towernum' ] ],
2967     },
2968
2969     'part_virtual_field' => {
2970       'columns' => [
2971         'vfieldpart', 'serial', '', '', '', '',
2972         'dbtable', 'varchar', '', 32, '', '',
2973         'name', 'varchar', '', 32, '', '',
2974         'length', 'int', 'NULL', '', '', '',
2975         'label', 'varchar', 'NULL', 80, '', '',
2976       ],
2977       'primary_key' => 'vfieldpart',
2978       'unique' => [],
2979       'index' => [],
2980     },
2981
2982     'virtual_field' => {
2983       'columns' => [
2984         'vfieldnum', 'serial', '', '', '', '',
2985         'recnum', 'int', '', '', '', '',
2986         'vfieldpart', 'int', '', '', '', '',
2987         'value', 'varchar', '', 128, '', '',
2988       ],
2989       'primary_key' => 'vfieldnum',
2990       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2991       'index' => [],
2992     },
2993
2994     'acct_snarf' => {
2995       'columns' => [
2996         'snarfnum',    'serial',     '',      '', '', '',
2997         'snarfname',  'varchar', 'NULL', $char_d, '', '',
2998         'svcnum',         'int',     '',      '', '', '',
2999         'machine',    'varchar',     '',     255, '', '',
3000         'protocol',   'varchar',     '', $char_d, '', '',
3001         'username',   'varchar',     '', $char_d, '', '',
3002         '_password',  'varchar',     '', $char_d, '', '',
3003         'check_freq',     'int', 'NULL',      '', '', '',
3004         'leavemail',     'char', 'NULL',       1, '', '',
3005         'apop',          'char', 'NULL',       1, '', '',
3006         'tls',           'char', 'NULL',       1, '', '',
3007         'mailbox',    'varchar', 'NULL', $char_d, '', '',
3008       ],
3009       'primary_key' => 'snarfnum',
3010       'unique' => [],
3011       'index'  => [ [ 'svcnum' ] ],
3012     },
3013
3014     'svc_external' => {
3015       'columns' => [
3016         'svcnum',     'int',     '',      '', '', '',
3017         'id',      'bigint', 'NULL',      '', '', '',
3018         'title',  'varchar', 'NULL', $char_d, '', '',
3019       ],
3020       'primary_key' => 'svcnum',
3021       'unique'      => [],
3022       'index'       => [],
3023     },
3024
3025     'cust_pay_refund' => {
3026       'columns' => [
3027         'payrefundnum', 'serial', '', '', '', '',
3028         'paynum',  'int', '', '', '', '',
3029         'refundnum',  'int', '', '', '', '',
3030         '_date',    @date_type, '', '',
3031         'amount',   @money_type, '', '',
3032       ],
3033       'primary_key' => 'payrefundnum',
3034       'unique' => [],
3035       'index' => [ ['paynum'], ['refundnum'] ],
3036     },
3037
3038     'part_pkg_option' => {
3039       'columns' => [
3040         'optionnum', 'serial', '', '', '', '',
3041         'pkgpart', 'int', '', '', '', '',
3042         'optionname', 'varchar', '', $char_d, '', '',
3043         'optionvalue', 'text', 'NULL', '', '', '',
3044       ],
3045       'primary_key' => 'optionnum',
3046       'unique'      => [],
3047       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
3048     },
3049
3050     'part_pkg_vendor' => {
3051       'columns' => [
3052         'num', 'serial', '', '', '', '',
3053         'pkgpart', 'int', '', '', '', '',
3054         'exportnum', 'int', '', '', '', '',
3055         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
3056       ],
3057       'primary_key' => 'num',
3058       'unique' => [ [