FS/FS/Schema.pm

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