FS/FS/Schema.pm

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