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       ],
 972       'primary_key' => 'crednum',
 973       'unique' => [],
 974       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'] ],
 975     },
 976
 977     'cust_credit_bill' => {
 978       'columns' => [
 979         'creditbillnum', 'serial', '', '', '', '',
 980         'crednum',  'int', '', '', '', '',
 981         'invnum',  'int', '', '', '', '',
 982         '_date',    @date_type, '', '',
 983         'amount',   @money_type, '', '',
 984         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 985       ],
 986       'primary_key' => 'creditbillnum',
 987       'unique' => [],
 988       'index' => [ ['crednum'], ['invnum'] ],
 989     },
 990
 991     'cust_credit_bill_pkg' => {
 992       'columns' => [
 993         'creditbillpkgnum', 'serial', '',      '', '', '',
 994         'creditbillnum',       'int', '',      '', '', '',
 995         'billpkgnum',          'int', '',      '', '', '',
 996         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
 997         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
 998         'amount',            @money_type,          '', '',
 999         'setuprecur',      'varchar', '', $char_d, '', '',
1000         'sdate',   @date_type, '', '',
1001         'edate',   @date_type, '', '',
1002       ],
1003       'primary_key' => 'creditbillpkgnum',
1004       'unique'      => [],
1005       'index'       => [ [ 'creditbillnum' ],
1006                          [ 'billpkgnum' ],
1007                          [ 'billpkgtaxlocationnum' ],
1008                          [ 'billpkgtaxratelocationnum' ],
1009                        ],
1010     },
1011
1012     'cust_main' => {
1013       'columns' => [
1014         'custnum',  'serial',  '',     '', '', '',
1015         'agentnum', 'int',  '',     '', '', '',
1016         'salesnum', 'int',  'NULL', '', '', '',
1017         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
1018         'classnum', 'int', 'NULL', '', '', '',
1019         'custbatch', 'varchar', 'NULL', $char_d, '', '',
1020 #        'titlenum', 'int',  'NULL',   '', '', '',
1021         'last',     'varchar', '',   2*$char_d, '', '',
1022 #        'middle',   'varchar', 'NULL', $char_d, '', '',
1023         'first',    'varchar', '',     $char_d, '', '',
1024         'ss',       'varchar', 'NULL', 11, '', '',
1025         'stateid', 'varchar', 'NULL', $char_d, '', '',
1026         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
1027         'national_id', 'varchar', 'NULL', $char_d, '', '',
1028         'birthdate' ,@date_type, '', '',
1029         'spouse_birthdate' ,@date_type, '', '',
1030         'anniversary_date' ,@date_type, '', '',
1031         'signupdate',@date_type, '', '',
1032         'dundate',   @date_type, '', '',
1033         'company',  'varchar', 'NULL', $char_d, '', '',
1034         'address1', 'varchar', 'NULL', $char_d, '', '',
1035         'address2', 'varchar', 'NULL', $char_d, '', '',
1036         'city',     'varchar', 'NULL', $char_d, '', '',
1037         'county',   'varchar', 'NULL', $char_d, '', '',
1038         'state',    'varchar', 'NULL', $char_d, '', '',
1039         'zip',      'varchar', 'NULL', 10, '', '',
1040         'country',  'char',    'NULL',  2, '', '',
1041         'latitude', 'decimal', 'NULL', '10,7', '', '',
1042         'longitude','decimal', 'NULL', '10,7', '', '',
1043         'coord_auto',  'char', 'NULL',  1, '', '',
1044         'addr_clean',  'char', 'NULL',  1, '', '',
1045         'daytime',  'varchar', 'NULL', 20, '', '',
1046         'night',    'varchar', 'NULL', 20, '', '',
1047         'fax',      'varchar', 'NULL', 12, '', '',
1048         'mobile',   'varchar', 'NULL', 12, '', '',
1049         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '',
1050 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
1051         'ship_first',    'varchar', 'NULL', $char_d, '', '',
1052         'ship_company',  'varchar', 'NULL', $char_d, '', '',
1053         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
1054         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
1055         'ship_city',     'varchar', 'NULL', $char_d, '', '',
1056         'ship_county',   'varchar', 'NULL', $char_d, '', '',
1057         'ship_state',    'varchar', 'NULL', $char_d, '', '',
1058         'ship_zip',      'varchar', 'NULL', 10, '', '',
1059         'ship_country',  'char', 'NULL', 2, '', '',
1060         'ship_latitude', 'decimal', 'NULL', '10,7', '', '',
1061         'ship_longitude','decimal', 'NULL', '10,7', '', '',
1062         'ship_coord_auto',  'char', 'NULL',  1, '', '',
1063         'ship_addr_clean',  'char', 'NULL',  1, '', '',
1064         'ship_daytime',  'varchar', 'NULL', 20, '', '',
1065         'ship_night',    'varchar', 'NULL', 20, '', '',
1066         'ship_fax',      'varchar', 'NULL', 12, '', '',
1067         'ship_mobile',   'varchar', 'NULL', 12, '', '',
1068         'payby',    'char', '',     4, '', '',
1069         'payinfo',  'varchar', 'NULL', 512, '', '',
1070         'paycvv',   'varchar', 'NULL', 512, '', '',
1071         'paymask', 'varchar', 'NULL', $char_d, '', '',
1072         #'paydate',  @date_type, '', '',
1073         'paydate',  'varchar', 'NULL', 10, '', '',
1074         'paystart_month', 'int', 'NULL', '', '', '',
1075         'paystart_year',  'int', 'NULL', '', '', '',
1076         'payissue', 'varchar', 'NULL', 2, '', '',
1077         'payname',  'varchar', 'NULL', 2*$char_d, '', '',
1078         'paystate', 'varchar', 'NULL', $char_d, '', '',
1079         'paytype',  'varchar', 'NULL', $char_d, '', '',
1080         'payip',    'varchar', 'NULL', 15, '', '',
1081         'geocode',  'varchar', 'NULL', 20,  '', '',
1082         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
1083         'censusyear', 'char', 'NULL', 4, '', '',
1084         'district', 'varchar', 'NULL', 20, '', '',
1085         'tax',      'char', 'NULL', 1, '', '',
1086         'otaker',   'varchar', 'NULL',    32, '', '',
1087         'usernum',   'int', 'NULL', '', '', '',
1088         'refnum',   'int',  '',     '', '', '',
1089         'referral_custnum', 'int',  'NULL', '', '', '',
1090         'comments', 'text', 'NULL', '', '', '',
1091         'spool_cdr','char', 'NULL', 1, '', '',
1092         'squelch_cdr','char', 'NULL', 1, '', '',
1093         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
1094         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
1095         'credit_limit', @money_typen, '', '',
1096         'archived', 'char', 'NULL', 1, '', '',
1097         'email_csv_cdr', 'char', 'NULL', 1, '', '',
1098         'accountcode_cdr', 'char', 'NULL', 1, '', '',
1099         'billday',   'int', 'NULL', '', '', '',
1100         'prorate_day',   'int', 'NULL', '', '', '',
1101         'edit_subject', 'char', 'NULL', 1, '', '',
1102         'locale', 'varchar', 'NULL', 16, '', '',
1103         'calling_list_exempt', 'char', 'NULL', 1, '', '',
1104         'invoice_noemail', 'char', 'NULL', 1, '', '',
1105         'message_noemail', 'char', 'NULL', 1, '', '',
1106         'bill_locationnum', 'int', 'NULL', '', '', '',
1107         'ship_locationnum', 'int', 'NULL', '', '', '',
1108       ],
1109       'primary_key' => 'custnum',
1110       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
1111       #'index' => [ ['last'], ['company'] ],
1112       'index' => [
1113                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
1114                    [ 'custbatch' ],
1115                    [ 'referral_custnum' ],
1116                    [ 'payby' ], [ 'paydate' ],
1117                    [ 'archived' ],
1118                  ],
1119     },
1120
1121     'cust_recon' => {  # (some sort of not-well understood thing for OnPac)
1122       'columns' => [
1123         'reconid',      'serial',  '',          '', '', '',
1124         'recondate',    @date_type,                 '', '',
1125         'custnum',      'int'   ,  '',          '', '', '',
1126         'agentnum',     'int',     '',          '', '', '',
1127         'last',         'varchar', '',     $char_d, '', '',
1128         'first',        'varchar', '',     $char_d, '', '',
1129         'address1',     'varchar', '',     $char_d, '', '',
1130         'address2',     'varchar', 'NULL', $char_d, '', '',
1131         'city',         'varchar', '',     $char_d, '', '',
1132         'state',        'varchar', 'NULL', $char_d, '', '',
1133         'zip',          'varchar', 'NULL',      10, '', '',
1134         'pkg',          'varchar', 'NULL', $char_d, '', '',
1135         'adjourn',      @date_type,                 '', '',
1136         'status',       'varchar', 'NULL',      10, '', '',
1137         'agent_custid', 'varchar',  '',    $char_d, '', '',
1138         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
1139         'agent_adjourn', @date_type,                '', '',
1140         'comments',     'text',    'NULL',      '', '', '',
1141       ],
1142       'primary_key' => 'reconid',
1143       'unique' => [],
1144       'index' => [],
1145     },
1146
1147     'contact_class' => {
1148       'columns' => [
1149         'classnum',    'serial',   '',      '', '', '',
1150         'classname',   'varchar',  '', $char_d, '', '',
1151         'disabled',    'char', 'NULL',       1, '', '',
1152       ],
1153       'primary_key' => 'classnum',
1154       'unique' => [],
1155       'index' => [ ['disabled'] ],
1156     },
1157
1158     'contact' => {
1159       'columns' => [
1160         'contactnum', 'serial',     '',      '', '', '',
1161         'prospectnum',   'int', 'NULL',      '', '', '',
1162         'custnum',       'int', 'NULL',      '', '', '',
1163         'locationnum',   'int', 'NULL',      '', '', '', #not yet
1164         'classnum',      'int', 'NULL',      '', '', '',
1165 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1166         'last',      'varchar',     '', $char_d, '', '',
1167 #        'middle',    'varchar', 'NULL', $char_d, '', '',
1168         'first',     'varchar',     '', $char_d, '', '',
1169         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1170         'comment',   'varchar', 'NULL',     255, '', '',
1171         'disabled',     'char', 'NULL',       1, '', '',
1172       ],
1173       'primary_key' => 'contactnum',
1174       'unique'      => [],
1175       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1176                          [ 'last' ], [ 'first' ],
1177                        ],
1178     },
1179
1180     'contact_phone' => {
1181       'columns' => [
1182         'contactphonenum', 'serial',     '', '', '', '',
1183         'contactnum',         'int',     '', '', '', '',
1184         'phonetypenum',       'int',     '', '', '', '',
1185         'countrycode',    'varchar',     '',  3, '', '',
1186         'phonenum',       'varchar',     '', 14, '', '',
1187         'extension',      'varchar', 'NULL',  7, '', '',
1188         #?#'comment',        'varchar',     '', $char_d, '', '',
1189       ],
1190       'primary_key' => 'contactphonenum',
1191       'unique'      => [],
1192       'index'       => [],
1193     },
1194
1195     'phone_type' => {
1196       'columns' => [
1197         'phonetypenum',  'serial', '',      '', '', '',
1198         'typename',     'varchar', '', $char_d, '', '',
1199         'weight',           'int', '',      '', '', '',
1200       ],
1201       'primary_key' => 'phonetypenum',
1202       'unique'      => [ [ 'typename' ], ],
1203       'index'       => [],
1204     },
1205
1206     'contact_email' => {
1207       'columns' => [
1208         'contactemailnum', 'serial', '',      '', '', '',
1209         'contactnum',         'int', '',      '', '', '',
1210         'emailaddress',   'varchar', '', $char_d, '', '',
1211       ],
1212       'primary_key' => 'contactemailnum',
1213       'unique'      => [ [ 'contactnum', 'emailaddress' ], ],
1214       'index'       => [],
1215     },
1216
1217     'prospect_main' => {
1218       'columns' => [
1219         'prospectnum',  'serial',     '',      '', '', '',
1220         'agentnum',        'int',     '',      '', '', '',
1221         'company',     'varchar', 'NULL', $char_d, '', '',
1222         'add_date',   @date_type,                  '', '',
1223         'disabled',       'char', 'NULL',       1, '', '',
1224         'custnum',         'int', 'NULL',      '', '', '',
1225       ],
1226       'primary_key' => 'prospectnum',
1227       'unique'      => [],
1228       'index'       => [ [ 'company' ], [ 'agentnum' ], [ 'disabled' ] ],
1229     },
1230
1231     'quotation' => {
1232       'columns' => [
1233         #regular fields
1234         'quotationnum',   'serial',     '', '', '', '',
1235         'prospectnum',       'int', 'NULL', '', '', '',
1236         'custnum',           'int', 'NULL', '', '', '',
1237         '_date',        @date_type,             '', '',
1238         'disabled',         'char', 'NULL',  1, '', '',
1239         'usernum',           'int', 'NULL', '', '', '',
1240         #'total',      @money_type,       '', '',
1241         #'quotation_term', 'varchar', 'NULL', $char_d, '', '',
1242       ],
1243       'primary_key' => 'quotationnum',
1244       'unique' => [],
1245       'index' => [ [ 'prospectnum' ], ['custnum'], ],
1246     },
1247
1248     'quotation_pkg' => {
1249       'columns' => [
1250         'quotationpkgnum',   'serial',     '', '', '', '',
1251         'quotationnum',         'int', 'NULL', '', '', '', #shouldn't be null,
1252                                                            # but history...
1253         'pkgpart',              'int',     '', '', '', '',
1254         'locationnum',          'int', 'NULL', '', '', '',
1255         'start_date',      @date_type,             '', '',
1256         'contract_end',    @date_type,             '', '',
1257         'quantity',             'int', 'NULL', '', '', '',
1258         'waive_setup',         'char', 'NULL',  1, '', '',
1259       ],
1260       'primary_key' => 'quotationpkgnum',
1261       'unique' => [],
1262       'index' => [ ['pkgpart'], ],
1263     },
1264
1265     'quotation_pkg_discount' => {
1266       'columns' => [
1267         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1268         'quotationpkgnum',            'int', '', '', '', '',
1269         'discountnum',                'int', '', '', '', '',
1270         #'end_date',              @date_type,         '', '',
1271       ],
1272       'primary_key' => 'quotationpkgdiscountnum',
1273       'unique' => [],
1274       'index'  => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
1275     },
1276
1277     'cust_location' => { #'location' now that its prospects too, but...
1278       'columns' => [
1279         'locationnum',      'serial',     '',      '', '', '',
1280         'prospectnum',         'int', 'NULL',      '', '', '',
1281         'custnum',             'int', 'NULL',      '', '', '',
1282         'address1',        'varchar',     '', $char_d, '', '',
1283         'address2',        'varchar', 'NULL', $char_d, '', '',
1284         'city',            'varchar',     '', $char_d, '', '',
1285         'county',          'varchar', 'NULL', $char_d, '', '',
1286         'state',           'varchar', 'NULL', $char_d, '', '',
1287         'zip',             'varchar', 'NULL',      10, '', '',
1288         'latitude',        'decimal', 'NULL',  '10,7', '', '',
1289         'longitude',       'decimal', 'NULL',  '10,7', '', '',
1290         'coord_auto',         'char', 'NULL',       1, '', '',
1291         'addr_clean',         'char', 'NULL',       1, '', '',
1292         'country',            'char',     '',       2, '', '',
1293         'geocode',         'varchar', 'NULL',      20, '', '',
1294         'district',        'varchar', 'NULL',      20, '', '',
1295         'censustract',     'varchar', 'NULL',      20, '', '',
1296         'censusyear',         'char', 'NULL',       4, '', '',
1297         'location_type',   'varchar', 'NULL',      20, '', '',
1298         'location_number', 'varchar', 'NULL',      20, '', '',
1299         'location_kind',      'char', 'NULL',       1, '', '',
1300         'disabled',           'char', 'NULL',       1, '', '',
1301       ],
1302       'primary_key' => 'locationnum',
1303       'unique'      => [],
1304       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1305                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1306                          [ 'city' ], [ 'district' ]
1307                        ],
1308     },
1309
1310     'cust_main_invoice' => {
1311       'columns' => [
1312         'destnum',  'serial',  '',     '', '', '',
1313         'custnum',  'int',  '',     '', '', '',
1314         'dest',     'varchar', '',  $char_d, '', '',
1315       ],
1316       'primary_key' => 'destnum',
1317       'unique' => [],
1318       'index' => [ ['custnum'], ],
1319     },
1320
1321     'cust_main_note' => {
1322       'columns' => [
1323         'notenum',  'serial',  '',     '', '', '',
1324         'custnum',  'int',  '',     '', '', '',
1325         'classnum',      'int',     'NULL', '', '', '',
1326         '_date',    @date_type, '', '',
1327         'otaker',   'varchar', 'NULL',    32, '', '',
1328         'usernum',   'int', 'NULL', '', '', '',
1329         'comments', 'text', 'NULL', '', '', '',
1330       ],
1331       'primary_key' => 'notenum',
1332       'unique' => [],
1333       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1334     },
1335
1336     'cust_note_class' => {
1337       'columns' => [
1338         'classnum',    'serial',   '',      '', '', '',
1339         'classname',   'varchar',  '', $char_d, '', '',
1340         'disabled',    'char', 'NULL',       1, '', '',
1341       ],
1342       'primary_key' => 'classnum',
1343       'unique' => [],
1344       'index' => [ ['disabled'] ],
1345     },
1346
1347     'cust_category' => {
1348       'columns' => [
1349         'categorynum',   'serial',  '', '', '', '',
1350         'categoryname',  'varchar', '', $char_d, '', '',
1351         'weight',         'int', 'NULL',  '', '', '',
1352         'disabled',      'char', 'NULL',   1, '', '',
1353       ],
1354       'primary_key' => 'categorynum',
1355       'unique' => [],
1356       'index' => [ ['disabled'] ],
1357     },
1358
1359     'cust_class' => {
1360       'columns' => [
1361         'classnum',     'serial',     '',      '', '', '',
1362         'classname',   'varchar',     '', $char_d, '', '',
1363         'categorynum',     'int', 'NULL',      '', '', '',
1364         'tax',            'char', 'NULL',       1, '', '',
1365         'disabled',       'char', 'NULL',       1, '', '',
1366       ],
1367       'primary_key' => 'classnum',
1368       'unique' => [],
1369       'index' => [ ['disabled'] ],
1370     },
1371
1372     'cust_tag' => {
1373       'columns' => [
1374         'custtagnum', 'serial', '', '', '', '',
1375         'custnum',       'int', '', '', '', '',
1376         'tagnum',        'int', '', '', '', '',
1377       ],
1378       'primary_key' => 'custtagnum',
1379       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1380       'index'       => [ [ 'custnum' ] ],
1381     },
1382
1383     'part_tag' => {
1384       'columns' => [
1385         'tagnum',    'serial',     '',      '', '', '',
1386         'tagname',  'varchar',     '', $char_d, '', '',
1387         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1388         'tagcolor', 'varchar', 'NULL',       6, '', '',
1389         'by_default',  'char', 'NULL',       1, '', '',
1390         'disabled',    'char', 'NULL',       1, '', '',
1391       ],
1392       'primary_key' => 'tagnum',
1393       'unique'      => [], #[ [ 'tagname' ] ], #?
1394       'index'       => [ [ 'disabled' ] ],
1395     },
1396
1397     'cust_main_exemption' => {
1398       'columns' => [
1399         'exemptionnum',   'serial',     '',      '', '', '',
1400         'custnum',           'int',     '',      '', '', '',
1401         'taxname',       'varchar',     '', $char_d, '', '',
1402         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
1403         #start/end dates?  for reporting?
1404       ],
1405       'primary_key' => 'exemptionnum',
1406       'unique'      => [],
1407       'index'       => [ [ 'custnum' ] ],
1408     },
1409
1410     'cust_tax_adjustment' => {
1411       'columns' => [
1412         'adjustmentnum', 'serial',     '',      '', '', '',
1413         'custnum',          'int',     '',      '', '', '',
1414         'taxname',      'varchar',     '', $char_d, '', '',
1415         'amount',    @money_type,                   '', '',
1416         'comment',     'varchar',  'NULL', $char_d, '', '',
1417         'billpkgnum',       'int', 'NULL',      '', '', '',
1418         #more?  no cust_bill_pkg_tax_location?
1419       ],
1420       'primary_key' => 'adjustmentnum',
1421       'unique'      => [],
1422       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1423     },
1424
1425     'cust_main_county' => { #district+city+county+state+country are checked
1426                             #off the cust_main_county for validation and to
1427                             #provide a tax rate.
1428       'columns' => [
1429         'taxnum',   'serial',   '',    '', '', '',
1430         'district', 'varchar',  'NULL',    20, '', '',
1431         'city',     'varchar',  'NULL',    $char_d, '', '',
1432         'county',   'varchar',  'NULL',    $char_d, '', '',
1433         'state',    'varchar',  'NULL',    $char_d, '', '',
1434         'country',  'char',  '', 2, '', '',
1435         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1436         'exempt_amount', @money_type, '', '',
1437         'tax',      'real',  '',    '', '', '', #tax %
1438         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1439         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1440         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1441       ],
1442       'primary_key' => 'taxnum',
1443       'unique' => [],
1444   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1445       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ],
1446                    [ 'country' ],
1447                    [ 'taxclass' ],
1448                  ],
1449     },
1450
1451     'tax_rate'    => {
1452       'columns' => [
1453         'taxnum',       'serial',     '',      '', '', '',
1454         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1455         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1456         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1457         'taxclassnum', 'int',      '',      '', '', '',
1458         'effective_date', @date_type, '', '',
1459         'tax',        @taxrate_type,      '', '',        # tax %
1460         'excessrate', @taxrate_typen,     '', '',        # second tax %
1461         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1462         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1463         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1464         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1465         'unittype',    'int',  'NULL', '', '', '',      # for fee
1466         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1467         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1468         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1469         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1470         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1471         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1472         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1473         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1474         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1475         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1476         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1477         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1478         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1479         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1480         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1481         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1482       ],
1483       'primary_key' => 'taxnum',
1484       'unique' => [],
1485       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1486     },
1487
1488     'tax_rate_location' => {
1489       'columns' => [
1490         'taxratelocationnum', 'serial',  '',     '', '', '',
1491         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1492         'geocode',            'varchar', '',     20,      '', '',
1493         'city',               'varchar', 'NULL', $char_d, '', '',
1494         'county',             'varchar', 'NULL', $char_d, '', '',
1495         'state',              'char',    'NULL',       2, '', '',
1496         'disabled',           'char',    'NULL', 1, '', '',
1497       ],
1498       'primary_key' => 'taxratelocationnum',
1499       'unique' => [],
1500       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1501     },
1502
1503     'cust_tax_location' => {
1504       'columns' => [
1505         'custlocationnum', 'serial',  '',     '', '', '',
1506         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1507         'city',            'varchar', 'NULL', $char_d, '', '',
1508         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1509         'county',          'varchar', 'NULL', $char_d, '', '',
1510         'zip',             'char',    '',     5,  '', '',
1511         'state',           'char',    '',     2,  '', '',
1512         'plus4hi',         'char',    'NULL', 4,  '', '',
1513         'plus4lo',         'char',    'NULL', 4,  '', '',
1514         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1515         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1516         'geocode',         'varchar', '',    20,  '', '',
1517       ],
1518       'primary_key' => 'custlocationnum',
1519       'unique' => [],
1520       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1521     },
1522
1523     'tax_class' => {
1524       'columns' => [
1525         'taxclassnum',  'serial',  '',            '', '', '',
1526         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1527         'taxclass',     'varchar', '',       $char_d, '', '',
1528         'description',  'varchar', '',     2*$char_d, '', '',
1529       ],
1530       'primary_key' => 'taxclassnum',
1531       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1532       'index' => [],
1533     },
1534
1535     'cust_pay_pending' => {
1536       'columns' => [
1537         'paypendingnum','serial',      '',  '', '', '',
1538         'custnum',      'int',         '',  '', '', '',
1539         'paid',         @money_type,            '', '',
1540         '_date',        @date_type,             '', '',
1541         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1542                                                         # be index into payby
1543                                                         # table eventually
1544         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1545         'paymask',      'varchar', 'NULL', $char_d, '', '',
1546         'paydate',      'varchar', 'NULL', 10, '', '',
1547         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1548         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1549         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1550
1551         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1552         'status',       'varchar',     '', $char_d, '', '',
1553         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1554         'statustext',   'text',    'NULL',  '', '', '',
1555         'gatewaynum',   'int',     'NULL',  '', '', '',
1556         #'cust_balance', @money_type,            '', '',
1557         'paynum',       'int',     'NULL',  '', '', '',
1558         'jobnum',    'bigint',     'NULL',  '', '', '',
1559         'invnum',       'int',     'NULL',  '', '', '',
1560         'manual',       'char',    'NULL',   1, '', '',
1561         'discount_term','int',     'NULL',  '', '', '',
1562       ],
1563       'primary_key' => 'paypendingnum',
1564       'unique'      => [ [ 'payunique' ] ],
1565       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1566     },
1567
1568     'cust_pay' => {
1569       'columns' => [
1570         'paynum',   'serial',    '',   '', '', '',
1571         'custnum',  'int',    '',   '', '', '',
1572         '_date',    @date_type, '', '',
1573         'paid',     @money_type, '', '',
1574         'otaker',   'varchar', 'NULL', 32, '', '',
1575         'usernum',   'int', 'NULL', '', '', '',
1576         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1577                                                  # index into payby table
1578                                                  # eventually
1579         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1580         'paymask', 'varchar', 'NULL', $char_d, '', '',
1581         'paydate',  'varchar', 'NULL', 10, '', '',
1582         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1583         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1584         'closed',    'char', 'NULL', 1, '', '',
1585         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1586         # cash/check deposit info fields
1587         'bank',       'varchar', 'NULL', $char_d, '', '',
1588         'depositor',  'varchar', 'NULL', $char_d, '', '',
1589         'account',    'varchar', 'NULL', 20,      '', '',
1590         'teller',     'varchar', 'NULL', 20,      '', '',
1591
1592         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1593
1594         # credit card/EFT fields (formerly in paybatch)
1595         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1596         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1597         'auth',       'varchar','NULL',16, '', '', # CC auth number
1598         'order_number','varchar','NULL',$char_d, '', '', # transaction number
1599       ],
1600       'primary_key' => 'paynum',
1601       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1602       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1603     },
1604
1605     'cust_pay_void' => {
1606       'columns' => [
1607         'paynum',    'int',    '',   '', '', '',
1608         'custnum',   'int',    '',   '', '', '',
1609         '_date',     @date_type, '', '',
1610         'paid',      @money_type, '', '',
1611         'otaker',   'varchar', 'NULL', 32, '', '',
1612         'usernum',   'int', 'NULL', '', '', '',
1613         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1614                                                   # index into payby table
1615                                                   # eventually
1616         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1617         'paymask', 'varchar', 'NULL', $char_d, '', '',
1618         #'paydate' ?
1619         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1620         'closed',    'char', 'NULL', 1, '', '',
1621         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1622         # cash/check deposit info fields
1623         'bank',       'varchar', 'NULL', $char_d, '', '',
1624         'depositor',  'varchar', 'NULL', $char_d, '', '',
1625         'account',    'varchar', 'NULL', 20,      '', '',
1626         'teller',     'varchar', 'NULL', 20,      '', '',
1627         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1628
1629         # credit card/EFT fields (formerly in paybatch)
1630         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1631         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1632         'auth',       'varchar','NULL',16, '', '', # CC auth number
1633         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
1634
1635         #void fields
1636         'void_date', @date_type, '', '',
1637         'reason',    'varchar',   'NULL', $char_d, '', '',
1638         'void_usernum',   'int', 'NULL', '', '', '',
1639       ],
1640       'primary_key' => 'paynum',
1641       'unique' => [],
1642       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1643     },
1644
1645     'cust_bill_pay' => {
1646       'columns' => [
1647         'billpaynum', 'serial',     '',   '', '', '',
1648         'invnum',  'int',     '',   '', '', '',
1649         'paynum',  'int',     '',   '', '', '',
1650         'amount',  @money_type, '', '',
1651         '_date',   @date_type, '', '',
1652         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1653       ],
1654       'primary_key' => 'billpaynum',
1655       'unique' => [],
1656       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1657     },
1658
1659     'cust_bill_pay_batch' => {
1660       'columns' => [
1661         'billpaynum', 'serial',     '',   '', '', '',
1662         'invnum',  'int',     '',   '', '', '',
1663         'paybatchnum',  'int',     '',   '', '', '',
1664         'amount',  @money_type, '', '',
1665         '_date',   @date_type, '', '',
1666       ],
1667       'primary_key' => 'billpaynum',
1668       'unique' => [],
1669       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1670     },
1671
1672     'cust_bill_pay_pkg' => {
1673       'columns' => [
1674         'billpaypkgnum', 'serial', '', '', '', '',
1675         'billpaynum',       'int', '', '', '', '',
1676         'billpkgnum',       'int', '', '', '', '',
1677         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1678         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1679         'amount',         @money_type,     '', '',
1680         'setuprecur',      'varchar', '', $char_d, '', '',
1681         'sdate',   @date_type, '', '',
1682         'edate',   @date_type, '', '',
1683       ],
1684       'primary_key' => 'billpaypkgnum',
1685       'unique'      => [],
1686       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1687     },
1688
1689     'pay_batch' => { #batches of payments to an external processor
1690       'columns' => [
1691         'batchnum', 'serial',     '', '', '', '',
1692         'agentnum',    'int', 'NULL', '', '', '',
1693         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1694         'status',     'char', 'NULL',  1, '', '',
1695         'download',       @date_type,     '', '',
1696         'upload',         @date_type,     '', '',
1697         'title',   'varchar', 'NULL',255, '', '',
1698       ],
1699       'primary_key' => 'batchnum',
1700       'unique' => [],
1701       'index' => [],
1702     },
1703
1704     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1705       'columns' => [
1706         'paybatchnum',   'serial',    '',   '', '', '',
1707         'batchnum',   'int',    '',   '', '', '',
1708         'invnum',   'int',    '',   '', '', '',
1709         'custnum',   'int',    '',   '', '', '',
1710         'last',     'varchar', '',     $char_d, '', '',
1711         'first',    'varchar', '',     $char_d, '', '',
1712         'address1', 'varchar', '',     $char_d, '', '',
1713         'address2', 'varchar', 'NULL', $char_d, '', '',
1714         'city',     'varchar', '',     $char_d, '', '',
1715         'state',    'varchar', 'NULL', $char_d, '', '',
1716         'zip',      'varchar', 'NULL', 10, '', '',
1717         'country',  'char', '',     2, '', '',
1718         #        'trancode', 'int', '', '', '', ''
1719         'payby',    'char',        '',       4, '', '',
1720         'payinfo',  'varchar', 'NULL',     512, '', '',
1721         #'exp',      @date_type, '', ''
1722         'exp',      'varchar', 'NULL',      11, '', '',
1723         'payname',  'varchar', 'NULL', $char_d, '', '',
1724         'amount',   @money_type, '', '',
1725         'status',   'varchar', 'NULL', $char_d, '', '',
1726         'error_message',   'varchar', 'NULL', $char_d, '', '',
1727       ],
1728       'primary_key' => 'paybatchnum',
1729       'unique' => [],
1730       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1731     },
1732
1733     'fcc477map' => {
1734       'columns' => [
1735         'formkey',   'varchar',     '', 255, '', '',
1736         'formvalue',    'text', 'NULL',  '', '', '',
1737       ],
1738       'primary_key' => 'formkey',
1739       'unique'      => [],
1740       'index'       => [],
1741     },
1742
1743     'cust_pkg' => {
1744       'columns' => [
1745         'pkgnum',           'serial',     '', '', '', '',
1746         'custnum',             'int',     '', '', '', '',
1747         'pkgpart',             'int',     '', '', '', '',
1748         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1749         'contactnum',          'int', 'NULL', '', '', '',
1750         'locationnum',         'int', 'NULL', '', '', '',
1751         'otaker',          'varchar', 'NULL', 32, '', '',
1752         'usernum',             'int', 'NULL', '', '', '',
1753         'salesnum',            'int', 'NULL', '', '', '',
1754         'order_date',     @date_type,             '', '',
1755         'start_date',     @date_type,             '', '',
1756         'setup',          @date_type,             '', '',
1757         'bill',           @date_type,             '', '',
1758         'last_bill',      @date_type,             '', '',
1759         'susp',           @date_type,             '', '',
1760         'adjourn',        @date_type,             '', '',
1761         'resume',         @date_type,             '', '',
1762         'cancel',         @date_type,             '', '',
1763         'uncancel',       @date_type,             '', '',
1764         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1765         'expire',         @date_type,             '', '',
1766         'contract_end',   @date_type,             '', '',
1767         'dundate',        @date_type,             '', '',
1768         'change_date',    @date_type,             '', '',
1769         'change_pkgnum',       'int', 'NULL', '', '', '',
1770         'change_pkgpart',      'int', 'NULL', '', '', '',
1771         'change_locationnum',  'int', 'NULL', '', '', '',
1772         'change_custnum',      'int', 'NULL', '', '', '',
1773         'main_pkgnum',         'int', 'NULL', '', '', '',
1774         'pkglinknum',          'int', 'NULL', '', '', '',
1775         'manual_flag',        'char', 'NULL',  1, '', '',
1776         'no_auto',            'char', 'NULL',  1, '', '',
1777         'quantity',            'int', 'NULL', '', '', '',
1778         'agent_pkgid',         'int', 'NULL', '', '', '',
1779         'waive_setup',        'char', 'NULL',  1, '', '',
1780         'recur_show_zero',    'char', 'NULL',  1, '', '',
1781         'setup_show_zero',    'char', 'NULL',  1, '', '',
1782         'change_to_pkgnum',    'int', 'NULL', '', '', '',
1783       ],
1784       'primary_key' => 'pkgnum',
1785       'unique' => [],
1786       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1787                    [ 'usernum' ], [ 'agent_pkgid' ],
1788                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1789                    ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
1790                    ['expire'], ['contract_end'], ['change_date'], ['no_auto'],
1791                  ],
1792     },
1793
1794     'cust_pkg_option' => {
1795       'columns' => [
1796         'optionnum', 'serial', '', '', '', '',
1797         'pkgnum', 'int', '', '', '', '',
1798         'optionname', 'varchar', '', $char_d, '', '',
1799         'optionvalue', 'text', 'NULL', '', '', '',
1800       ],
1801       'primary_key' => 'optionnum',
1802       'unique'      => [],
1803       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1804     },
1805
1806     'cust_pkg_detail' => {
1807       'columns' => [
1808         'pkgdetailnum', 'serial', '',      '', '', '',
1809         'pkgnum',          'int', '',      '', '', '',
1810         'detail',      'varchar', '', $char_d, '', '',
1811         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1812         'weight',          'int', '',      '', '', '',
1813       ],
1814       'primary_key' => 'pkgdetailnum',
1815       'unique' => [],
1816       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1817     },
1818
1819     'cust_pkg_reason' => {
1820       'columns' => [
1821         'num',      'serial',    '',   '', '', '',
1822         'pkgnum',   'int',    '',   '', '', '',
1823         'reasonnum','int',    '',   '', '', '',
1824         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1825         'otaker',   'varchar', 'NULL', 32, '', '',
1826         'usernum',   'int', 'NULL', '', '', '',
1827         'date',     @date_type, '', '',
1828       ],
1829       'primary_key' => 'num',
1830       'unique' => [],
1831       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1832     },
1833
1834     'cust_pkg_discount' => {
1835       'columns' => [
1836         'pkgdiscountnum', 'serial', '',        '', '', '',
1837         'pkgnum',            'int', '',        '', '', '',
1838         'discountnum',       'int', '',        '', '', '',
1839         'months_used',   'decimal', 'NULL', '7,4', '', '',
1840         'end_date',     @date_type,                '', '',
1841         'otaker',        'varchar', 'NULL',    32, '', '',
1842         'usernum',           'int', 'NULL',    '', '', '',
1843         'disabled',         'char', 'NULL',     1, '', '',
1844       ],
1845       'primary_key' => 'pkgdiscountnum',
1846       'unique' => [],
1847       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1848     },
1849
1850     'cust_pkg_usage' => {
1851       'columns' => [
1852         'pkgusagenum', 'serial', '', '', '', '',
1853         'pkgnum',         'int', '', '', '', '',
1854         'minutes',        'int', '', '', '', '',
1855         'pkgusagepart',   'int', '', '', '', '',
1856       ],
1857       'primary_key' => 'pkgusagenum',
1858       'unique' => [],
1859       'index'  => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
1860     },
1861
1862     'cdr_cust_pkg_usage' => {
1863       'columns' => [
1864         'cdrusagenum', 'bigserial', '', '', '', '',
1865         'acctid',      'bigint',    '', '', '', '',
1866         'pkgusagenum', 'int',       '', '', '', '',
1867         'minutes',     'int',       '', '', '', '',
1868       ],
1869       'primary_key' => 'cdrusagenum',
1870       'unique' => [],
1871       'index'  => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
1872     },
1873
1874     'cust_bill_pkg_discount' => {
1875       'columns' => [
1876         'billpkgdiscountnum', 'serial',        '', '', '', '',
1877         'billpkgnum',            'int',        '', '', '', '',
1878         'pkgdiscountnum',        'int',        '', '', '', '',
1879         'amount',          @money_type,                '', '',
1880         'months',            'decimal', 'NULL', '7,4', '', '',
1881       ],
1882       'primary_key' => 'billpkgdiscountnum',
1883       'unique' => [],
1884       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1885     },
1886
1887     'cust_bill_pkg_discount_void' => {
1888       'columns' => [
1889         'billpkgdiscountnum',    'int',        '', '', '', '',
1890         'billpkgnum',            'int',        '', '', '', '',
1891         'pkgdiscountnum',        'int',        '', '', '', '',
1892         'amount',          @money_type,                '', '',
1893         'months',            'decimal', 'NULL', '7,4', '', '',
1894       ],
1895       'primary_key' => 'billpkgdiscountnum',
1896       'unique' => [],
1897       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1898     },
1899
1900     'discount' => {
1901       'columns' => [
1902         'discountnum', 'serial',     '',      '', '', '',
1903         #'agentnum',       'int', 'NULL',      '', '', '',
1904         'name',       'varchar', 'NULL', $char_d, '', '',
1905         'amount',   @money_type,                  '', '',
1906         'percent',    'decimal',     '',   '7,4', '', '',
1907         'months',     'decimal', 'NULL',   '7,4', '', '',
1908         'disabled',      'char', 'NULL',       1, '', '',
1909         'setup',         'char', 'NULL',       1, '', '',
1910         #'linked',        'char', 'NULL',       1, '', '',
1911       ],
1912       'primary_key' => 'discountnum',
1913       'unique' => [],
1914       'index'  => [], # [ 'agentnum' ], ],
1915     },
1916
1917     'cust_refund' => {
1918       'columns' => [
1919         'refundnum',    'serial',    '',   '', '', '',
1920         'custnum',  'int',    '',   '', '', '',
1921         '_date',        @date_type, '', '',
1922         'refund',       @money_type, '', '',
1923         'otaker',       'varchar',   'NULL',   32, '', '',
1924         'usernum',   'int', 'NULL', '', '', '',
1925         'reason',       'varchar',   '',   $char_d, '', '',
1926         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1927                                                      # be index into payby
1928                                                      # table eventually
1929         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1930         'paymask', 'varchar', 'NULL', $char_d, '', '',
1931         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1932         'closed',    'char', 'NULL', 1, '', '',
1933         # credit card/EFT fields (formerly in paybatch)
1934         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1935         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1936         'auth',       'varchar','NULL',16, '', '', # CC auth number
1937         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
1938       ],
1939       'primary_key' => 'refundnum',
1940       'unique' => [],
1941       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1942     },
1943
1944     'cust_credit_refund' => {
1945       'columns' => [
1946         'creditrefundnum', 'serial',     '',   '', '', '',
1947         'crednum',  'int',     '',   '', '', '',
1948         'refundnum',  'int',     '',   '', '', '',
1949         'amount',  @money_type, '', '',
1950         '_date',   @date_type, '', '',
1951       ],
1952       'primary_key' => 'creditrefundnum',
1953       'unique' => [],
1954       'index' => [ ['crednum'], ['refundnum'] ],
1955     },
1956
1957
1958     'cust_svc' => {
1959       'columns' => [
1960         'svcnum',      'serial',     '', '', '', '',
1961         'pkgnum',         'int', 'NULL', '', '', '',
1962         'svcpart',        'int',     '', '', '', '',
1963         'agent_svcid',    'int', 'NULL', '', '', '',
1964         'overlimit',           @date_type,   '', '',
1965       ],
1966       'primary_key' => 'svcnum',
1967       'unique' => [],
1968       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
1969     },
1970
1971     'cust_svc_option' => {
1972       'columns' => [
1973         'optionnum',   'serial', '', '', '', '',
1974         'svcnum',      'int', '', '', '', '',
1975         'optionname',  'varchar', '', $char_d, '', '',
1976         'optionvalue', 'text', 'NULL', '', '', '',
1977       ],
1978       'primary_key' => 'optionnum',
1979       'unique'      => [],
1980       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1981     },
1982
1983     'svc_export_machine' => {
1984       'columns' => [
1985         'svcexportmachinenum', 'serial', '', '', '', '',
1986         'svcnum',                 'int', '', '', '', '',
1987         'exportnum',              'int', '', '', '', '',
1988         'machinenum',             'int', '', '', '', '',
1989       ],
1990       'primary_key' => 'svcexportmachinenum',
1991       'unique'      => [ ['svcnum', 'exportnum'] ],
1992       'index'       => [],
1993     },
1994
1995     'part_export_machine' => {
1996       'columns' => [
1997         'machinenum', 'serial', '', '', '', '',
1998         'exportnum',     'int', '', '', '', '',
1999         'machine',    'varchar', 'NULL', $char_d, '', '',
2000         'disabled',      'char', 'NULL',       1, '', '',
2001       ],
2002       'primary_key' => 'machinenum',
2003       'unique'      => [ [ 'exportnum', 'machine' ] ],
2004       'index'       => [ [ 'exportnum' ] ],
2005     },
2006
2007    'part_pkg' => {
2008       'columns' => [
2009         'pkgpart',       'serial',    '',   '', '', '',
2010         'pkg',           'varchar',   '',   $char_d, '', '',
2011         'comment',       'varchar',   '', 2*$char_d, '', '',
2012         'promo_code',    'varchar', 'NULL', $char_d, '', '',
2013         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
2014         'setuptax',      'char', 'NULL', 1, '', '',
2015         'recurtax',      'char', 'NULL', 1, '', '',
2016         'plan',          'varchar', 'NULL', $char_d, '', '',
2017         'disabled',      'char', 'NULL', 1, '', '',
2018         'custom',        'char', 'NULL', 1, '', '',
2019         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2020         'classnum',      'int',     'NULL', '', '', '',
2021         'addon_classnum','int',     'NULL', '', '', '',
2022         'taxproductnum', 'int',     'NULL', '', '', '',
2023         'setup_cost',    @money_typen,          '', '',
2024         'recur_cost',    @money_typen,          '', '',
2025         'pay_weight',    'real',    'NULL', '', '', '',
2026         'credit_weight', 'real',    'NULL', '', '', '',
2027         'agentnum',      'int',     'NULL', '', '', '',
2028         'fcc_ds0s',      'int',     'NULL', '', '', '',
2029         'fcc_voip_class','char',    'NULL',  1, '', '',
2030         'no_auto',          'char', 'NULL',  1, '', '',
2031         'recur_show_zero',  'char', 'NULL',  1, '', '',
2032         'setup_show_zero',  'char', 'NULL',  1, '', '',
2033         'successor',     'int',     'NULL', '', '', '',
2034         'family_pkgpart','int',     'NULL', '', '', '',
2035         'delay_start',   'int',     'NULL', '', '', '',
2036       ],
2037       'primary_key' => 'pkgpart',
2038       'unique' => [],
2039       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
2040                    [ 'agentnum' ], ['no_auto'],
2041                  ],
2042     },
2043
2044     'part_pkg_msgcat' => {
2045       'columns' => [
2046         'pkgpartmsgnum',  'serial',     '',        '', '', '',
2047         'pkgpart',           'int',     '',        '', '', '',
2048         'locale',        'varchar',     '',        16, '', '',
2049         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
2050         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2051       ],
2052       'primary_key' => 'pkgpartmsgnum',
2053       'unique'      => [ [ 'pkgpart', 'locale' ] ],
2054       'index'       => [],
2055     },
2056
2057     'part_pkg_link' => {
2058       'columns' => [
2059         'pkglinknum',  'serial',   '',      '', '', '',
2060         'src_pkgpart', 'int',      '',      '', '', '',
2061         'dst_pkgpart', 'int',      '',      '', '', '',
2062         'link_type',   'varchar',  '', $char_d, '', '',
2063         'hidden',      'char', 'NULL',       1, '', '',
2064       ],
2065       'primary_key' => 'pkglinknum',
2066       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
2067       'index'  => [ [ 'src_pkgpart' ] ],
2068     },
2069     # XXX somewhat borked unique: we don't really want a hidden and unhidden
2070     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
2071
2072     'part_pkg_discount' => {
2073       'columns' => [
2074         'pkgdiscountnum', 'serial',   '',      '', '', '',
2075         'pkgpart',        'int',      '',      '', '', '',
2076         'discountnum',    'int',      '',      '', '', '',
2077       ],
2078       'primary_key' => 'pkgdiscountnum',
2079       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
2080       'index'  => [],
2081     },
2082
2083     'part_pkg_taxclass' => {
2084       'columns' => [
2085         'taxclassnum',  'serial', '',       '', '', '',
2086         'taxclass',     'varchar', '', $char_d, '', '',
2087         'disabled', 'char',   'NULL',         1, '', '',
2088       ],
2089       'primary_key' => 'taxclassnum',
2090       'unique'      => [ [ 'taxclass' ] ],
2091       'index'       => [ [ 'disabled' ] ],
2092     },
2093
2094     'part_pkg_taxproduct' => {
2095       'columns' => [
2096         'taxproductnum', 'serial',      '',        '', '', '',
2097         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
2098         'taxproduct',    'varchar',     '',   $char_d, '', '',
2099         'description',   'varchar',     '', 3*$char_d, '', '',
2100       ],
2101       'primary_key' => 'taxproductnum',
2102       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
2103       'index'       => [],
2104     },
2105
2106     'part_pkg_taxrate' => {
2107       'columns' => [
2108         'pkgtaxratenum', 'serial',  '',     '',      '', '',
2109         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
2110         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
2111         'taxproductnum', 'int',  '',     '',       '', '',
2112         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
2113         'county',           'varchar', 'NULL', $char_d, '', '',
2114         'state',            'varchar', 'NULL', $char_d, '', '',
2115         'local',            'varchar', 'NULL', $char_d, '', '',
2116         'country',          'char',    'NULL', 2,       '', '',
2117         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
2118         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
2119         'taxclassnum',      'int',     'NULL', '',      '', '',
2120         'effdate',          @date_type, '', '',
2121         'taxable',          'char',    'NULL', 1,       '', '',
2122       ],
2123       'primary_key' => 'pkgtaxratenum',
2124       'unique' => [],
2125       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
2126     },
2127
2128     'part_pkg_taxoverride' => {
2129       'columns' => [
2130         'taxoverridenum', 'serial', '', '', '', '',
2131         'pkgpart',           'int', '', '', '', '',
2132         'taxclassnum',       'int', '', '', '', '',
2133         'usage_class',    'varchar', 'NULL', $char_d, '', '',
2134       ],
2135       'primary_key' => 'taxoverridenum',
2136       'unique' => [],
2137       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
2138     },
2139
2140 #    'part_title' => {
2141 #      'columns' => [
2142 #        'titlenum',   'int',    '',   '',
2143 #        'title',      'varchar',   '',   $char_d,
2144 #      ],
2145 #      'primary_key' => 'titlenum',
2146 #      'unique' => [ [] ],
2147 #      'index' => [ [] ],
2148 #    },
2149
2150     'pkg_svc' => {
2151       'columns' => [
2152         'pkgsvcnum',  'serial', '',  '', '', '',
2153         'pkgpart',    'int',    '',   '', '', '',
2154         'svcpart',    'int',    '',   '', '', '',
2155         'quantity',   'int',    '',   '', '', '',
2156         'primary_svc','char', 'NULL',  1, '', '',
2157         'hidden',     'char', 'NULL',  1, '', '',
2158       ],
2159       'primary_key' => 'pkgsvcnum',
2160       'unique' => [ ['pkgpart', 'svcpart'] ],
2161       'index' => [ ['pkgpart'], ['quantity'] ],
2162     },
2163
2164     'part_referral' => {
2165       'columns' => [
2166         'refnum',   'serial',     '',        '', '', '',
2167         'referral', 'varchar',    '',   $char_d, '', '',
2168         'disabled', 'char',   'NULL',         1, '', '',
2169         'agentnum', 'int',    'NULL',        '', '', '',
2170       ],
2171       'primary_key' => 'refnum',
2172       'unique' => [],
2173       'index' => [ ['disabled'], ['agentnum'], ],
2174     },
2175
2176     'part_svc' => {
2177       'columns' => [
2178         'svcpart',             'serial',     '',        '', '', '',
2179         'svc',                'varchar',     '',   $char_d, '', '',
2180         'svcdb',              'varchar',     '',   $char_d, '', '',
2181         'disabled',              'char', 'NULL',         1, '', '',
2182         'preserve',              'char', 'NULL',         1, '', '',
2183         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
2184         'classnum',               'int', 'NULL',        '', '', '',
2185         'restrict_edit_password','char', 'NULL',         1, '', '',
2186 ],
2187       'primary_key' => 'svcpart',
2188       'unique' => [],
2189       'index' => [ [ 'disabled' ] ],
2190     },
2191
2192     'part_svc_column' => {
2193       'columns' => [
2194         'columnnum',   'serial',      '',      '', '', '',
2195         'svcpart',     'int',         '',      '', '', '',
2196         'columnname',  'varchar',     '',      64, '', '',
2197         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
2198         'columnvalue', 'varchar', 'NULL',     512, '', '',
2199         'columnflag',  'char',    'NULL',       1, '', '',
2200       ],
2201       'primary_key' => 'columnnum',
2202       'unique' => [ [ 'svcpart', 'columnname' ] ],
2203       'index' => [ [ 'svcpart' ] ],
2204     },
2205
2206     'part_svc_class' => {
2207       'columns' => [
2208         'classnum',    'serial',   '',      '', '', '',
2209         'classname',   'varchar',  '', $char_d, '', '',
2210         'disabled',    'char', 'NULL',       1, '', '',
2211       ],
2212       'primary_key' => 'classnum',
2213       'unique' => [],
2214       'index' => [ ['disabled'] ],
2215     },
2216
2217     #(this should be renamed to part_pop)
2218     'svc_acct_pop' => {
2219       'columns' => [
2220         'popnum',    'serial',    '',   '', '', '',
2221         'city',      'varchar',   '',   $char_d, '', '',
2222         'state',     'varchar',   '',   $char_d, '', '',
2223         'ac',        'char',   '',   3, '', '',
2224         'exch',      'char',   '',   3, '', '',
2225         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
2226       ],
2227       'primary_key' => 'popnum',
2228       'unique' => [],
2229       'index' => [ [ 'state' ] ],
2230     },
2231
2232     'part_pop_local' => {
2233       'columns' => [
2234         'localnum',  'serial',     '',     '', '', '',
2235         'popnum',    'int',     '',     '', '', '',
2236         'city',      'varchar', 'NULL', $char_d, '', '',
2237         'state',     'char',    'NULL', 2, '', '',
2238         'npa',       'char',    '',     3, '', '',
2239         'nxx',       'char',    '',     3, '', '',
2240       ],
2241       'primary_key' => 'localnum',
2242       'unique' => [],
2243       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
2244     },
2245
2246     'qual' => {
2247       'columns' => [
2248         'qualnum',  'serial',     '',     '', '', '',
2249         'custnum',    'int',     'NULL',     '', '', '',
2250         'prospectnum',    'int',     'NULL',     '', '', '',
2251         'locationnum',    'int',     'NULL',     '', '', '',
2252         'phonenum',     'varchar', 'NULL',       24, '', '',
2253         'exportnum',      'int', 'NULL', '', '', '',
2254         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
2255         'status',      'char', '', 1, '', '',
2256       ],
2257       'primary_key' => 'qualnum',
2258       'unique' => [],
2259       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
2260                     ['phonenum'], ['vendor_qual_id'] ],
2261     },
2262
2263     'qual_option' => {
2264       'columns' => [
2265         'optionnum', 'serial', '', '', '', '',
2266         'qualnum',  'int',     '',     '', '', '',
2267         'optionname', 'varchar', '', $char_d, '', '',
2268         'optionvalue', 'text', 'NULL', '', '', '',
2269       ],
2270       'primary_key' => 'optionnum',
2271       'unique' => [],
2272       'index' => [],
2273     },
2274
2275     'svc_acct' => {
2276       'columns' => [
2277         'svcnum',    'int',    '',   '', '', '',
2278         'username',  'varchar',   '',   $username_len, '', '',
2279         '_password', 'varchar',   'NULL',  512, '', '',
2280         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
2281         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
2282         'popnum',    'int',    'NULL',   '', '', '',
2283         'sectornum', 'int', 'NULL',      '', '', '',
2284         'uid',       'int', 'NULL',   '', '', '',
2285         'gid',       'int', 'NULL',   '', '', '',
2286         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
2287         'dir',       'varchar',   'NULL',   $char_d, '', '',
2288         'shell',     'varchar',   'NULL',   $char_d, '', '',
2289         'quota',     'varchar',   'NULL',   $char_d, '', '',
2290         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
2291         # IP address mgmt
2292         'routernum', 'int', 'NULL',      '', '', '',
2293         'blocknum',  'int', 'NULL',      '', '', '',
2294         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
2295         'seconds_threshold',   'int', 'NULL',   '', '', '',
2296         'upbytes',   'bigint', 'NULL',   '', '', '',
2297         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
2298         'downbytes', 'bigint', 'NULL',   '', '', '',
2299         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
2300         'totalbytes','bigint', 'NULL',   '', '', '',
2301         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
2302         'domsvc',    'int',     '', '', '', '',
2303         'pbxsvc',    'int', 'NULL', '', '', '',
2304         'last_login',  @date_type, '', '',
2305         'last_logout', @date_type, '', '',
2306         #cardfortress field(s)
2307         'cf_privatekey',      'text', 'NULL',      '', '', '',
2308         #communigate pro fields (quota = MaxAccountSize)
2309         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
2310         #settings
2311         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
2312         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
2313         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
2314         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
2315         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
2316         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
2317         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
2318         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
2319         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
2320         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
2321         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
2322         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
2323         #XXX mailing lists
2324         #preferences
2325         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
2326         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
2327         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
2328         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
2329         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
2330         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
2331         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
2332         #mail
2333         #XXX RPOP settings
2334         #
2335       ],
2336       'primary_key' => 'svcnum',
2337       #'unique' => [ [ 'username', 'domsvc' ] ],
2338       'unique' => [],
2339       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
2340     },
2341
2342     'acct_rt_transaction' => {
2343       'columns' => [
2344         'svcrtid',   'int',    '',   '', '', '',
2345         'svcnum',    'int',    '',   '', '', '',
2346         'transaction_id',       'int', '',   '', '', '',
2347         '_date',   @date_type, '', '',
2348         'seconds',   'int', '',   '', '', '', #uhhhh
2349         'support',   'int', '',   '', '', '',
2350       ],
2351       'primary_key' => 'svcrtid',
2352       'unique' => [],
2353       'index' => [ ['svcnum', 'transaction_id'] ],
2354     },
2355
2356     #'svc_charge' => {
2357     #  'columns' => [
2358     #    'svcnum',    'int',    '',   '',
2359     #    'amount',    @money_type,
2360     #  ],
2361     #  'primary_key' => 'svcnum',
2362     #  'unique' => [ [] ],
2363     #  'index' => [ [] ],
2364     #},
2365
2366     'svc_domain' => {
2367       'columns' => [
2368         'svcnum',           'int',    '',        '', '', '',
2369         'domain',       'varchar',    '',   $char_d, '', '',
2370         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2371         'catchall',         'int', 'NULL',       '', '', '',
2372         'parent_svcnum',    'int', 'NULL',       '', '', '',
2373         'registrarnum',     'int', 'NULL',       '', '', '',
2374         'registrarkey', 'varchar', 'NULL',      512, '', '',
2375         'setup_date',      @date_type, '', '',
2376         'renewal_interval', 'int', 'NULL',       '', '', '',
2377         'expiration_date', @date_type, '', '',
2378         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2379         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2380         #communigate pro fields (quota = MaxAccountSize)
2381         'max_accounts',     'int', 'NULL',       '', '', '',
2382         'trailer',         'text', 'NULL',       '', '', '',
2383         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2384         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2385         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2386         #settings
2387         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
2388         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
2389         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2390         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2391         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2392         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2393         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2394         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2395         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
2396         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
2397         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
2398         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2399         #preferences
2400         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2401         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2402         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2403         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2404         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2405         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2406         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2407       ],
2408       'primary_key' => 'svcnum',
2409       'unique' => [ ],
2410       'index' => [ ['domain'] ],
2411     },
2412
2413     'svc_dsl' => {
2414       'columns' => [
2415         'svcnum',                    'int',    '',        '', '', '',
2416         'pushed',                    'int', 'NULL',       '', '', '',
2417         'desired_due_date',          'int', 'NULL',       '', '', '',
2418         'due_date',                  'int', 'NULL',       '', '', '',
2419         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2420         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2421         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2422         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2423         'first',                 'varchar', 'NULL', $char_d,  '', '',
2424         'last',                  'varchar', 'NULL', $char_d,  '', '',
2425         'company',               'varchar', 'NULL', $char_d,  '', '',
2426         'phonenum',              'varchar', 'NULL',      24, '', '',
2427         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2428         'loop_type',                'char', 'NULL',       1, '', '',
2429         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2430         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2431         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2432         'vpi',                       'int', 'NULL',      '', '', '',
2433         'vci',                       'int', 'NULL',      '', '', '',
2434         'isp_chg',                  'char', 'NULL',       1, '', '',
2435         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2436         'username',              'varchar', 'NULL', $char_d, '', '',
2437         'password',              'varchar', 'NULL', $char_d, '', '',
2438         'staticips',                'text', 'NULL',      '', '', '',
2439         'monitored',                'char', 'NULL',       1, '', '',
2440         'last_pull',                 'int', 'NULL',      '', '', '',
2441       ],
2442       'primary_key' => 'svcnum',
2443       'unique' => [ ],
2444       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2445     },
2446
2447     'dsl_device' => {
2448       'columns' => [
2449         'devicenum', 'serial',     '', '', '', '',
2450         #part_device?  or our own part_dsl_device?
2451         #'devicepart',   'int',     '', '', '', '',
2452         'svcnum',       'int',     '', '', '', '',
2453         'mac_addr', 'varchar',     '', 12, '', '',
2454       ],
2455       'primary_key' => 'devicenum',
2456       'unique' => [ [ 'mac_addr' ], ],
2457       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2458     },
2459
2460     'dsl_note' => {
2461       'columns' => [
2462         'notenum',           'serial',    '',        '', '', '',
2463         'svcnum',     'int', '',       '', '', '',
2464         'author',     'varchar', 'NULL', $char_d,  '', '',
2465         'priority',   'char', 'NULL',       1,  '', '',
2466         '_date',     'int', 'NULL',       '', '', '',
2467         'note',     'text', '',       '', '', '',
2468       ],
2469       'primary_key' => 'notenum',
2470       'unique' => [ ],
2471       'index' => [ ['svcnum'] ],
2472     },
2473
2474     'svc_dish' => {
2475       'columns' => [
2476         'svcnum',   'int',     '',     '', '', '',
2477         'acctnum',  'varchar', '',     16, '', '',
2478         'installdate', @date_type,         '', '',
2479         'note',     'text',    'NULL', '', '', '',
2480       ],
2481       'primary_key' => 'svcnum',
2482       'unique' => [ ],
2483       'index' => [ ],
2484     },
2485
2486     'svc_hardware' => {
2487       'columns' => [
2488         'svcnum',   'int',     '',          '', '', '',
2489         'typenum',  'int',     '',          '', '', '',
2490         'serial',   'varchar', 'NULL', $char_d, '', '',
2491         'ip_addr',  'varchar', 'NULL',      40, '', '',
2492         'hw_addr',  'varchar', 'NULL',      12, '', '',
2493         'smartcard','varchar', 'NULL',      30, '', '',
2494         'statusnum','int',     'NULL',      '', '', '',
2495         'note',     'text',    'NULL',      '', '', '',
2496       ],
2497       'primary_key' => 'svcnum',
2498       'unique' => [ ],
2499       'index' => [ ],
2500     },
2501
2502     'hardware_class' => {
2503       'columns' => [
2504         'classnum',   'serial', '',      '', '', '',
2505         'classname', 'varchar', '', $char_d, '', '',
2506       ],
2507       'primary_key' => 'classnum',
2508       'unique' => [ ],
2509       'index'  => [ ],
2510     },
2511
2512     'hardware_type' => {
2513       'columns' => [
2514         'typenum',  'serial',     '',      '', '', '',
2515         'classnum',    'int',     '',      '', '', '',
2516         'model',   'varchar',     '', $char_d, '', '',
2517         'revision','varchar', 'NULL', $char_d, '', '',
2518       ],
2519       'primary_key' => 'typenum',
2520       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2521       'index'  => [ ],
2522     },
2523
2524     'hardware_status' => {
2525       'columns' => [
2526         'statusnum', 'serial', '',      '', '', '',
2527         'label'    ,'varchar', '', $char_d, '', '',
2528         'disabled',    'char', 'NULL',   1, '', '',
2529       ],
2530       'primary_key' => 'statusnum',
2531       'unique' => [ ],
2532       'index'  => [ ],
2533     },
2534
2535     'domain_record' => {
2536       'columns' => [
2537         'recnum',    'serial',     '',  '', '', '',
2538         'svcnum',    'int',     '',  '', '', '',
2539         'reczone',   'varchar', '',  255, '', '',
2540         'recaf',     'char',    '',  2, '', '',
2541         'rectype',   'varchar',    '',  5, '', '',
2542         'recdata',   'varchar', '',  255, '', '',
2543         'ttl',       'int',     'NULL', '', '', '',
2544       ],
2545       'primary_key' => 'recnum',
2546       'unique'      => [],
2547       'index'       => [ ['svcnum'] ],
2548     },
2549
2550     'registrar' => {
2551       'columns' => [
2552         'registrarnum',   'serial', '',      '', '', '',
2553         'registrarname', 'varchar', '', $char_d, '', '',
2554       ],
2555       'primary_key' => 'registrarnum',
2556       'unique'      => [],
2557       'index'       => [],
2558     },
2559
2560     'cgp_rule' => {
2561       'columns' => [
2562         'rulenum',  'serial',     '',      '', '', '',
2563         'name',    'varchar',     '', $char_d, '', '',
2564         'comment', 'varchar', 'NULL', $char_d, '', '',
2565         'svcnum',      'int',     '',      '', '', '',
2566         'priority',    'int',     '',      '', '', '',
2567       ],
2568       'primary_key' => 'rulenum',
2569       'unique'      => [ [ 'svcnum', 'name' ] ],
2570       'index'       => [ [ 'svcnum' ] ],
2571     },
2572
2573     'cgp_rule_condition' => {
2574       'columns' => [
2575         'ruleconditionnum',  'serial',     '',      '', '', '',
2576         'conditionname',    'varchar',     '', $char_d, '', '',
2577         'op',               'varchar', 'NULL', $char_d, '', '',
2578         'params',           'varchar', 'NULL',     255, '', '',
2579         'rulenum',              'int',     '',      '', '', '',
2580       ],
2581       'primary_key' => 'ruleconditionnum',
2582       'unique'      => [],
2583       'index'       => [ [ 'rulenum' ] ],
2584     },
2585
2586     'cgp_rule_action' => {
2587        'columns' => [
2588         'ruleactionnum',  'serial',     '',      '', '', '',
2589         'action',        'varchar',     '', $char_d, '', '',
2590         'params',        'varchar', 'NULL',     255, '', '',
2591         'rulenum',           'int',     '',      '', '', '',
2592       ],
2593       'primary_key' => 'ruleactionnum',
2594       'unique'      => [],
2595       'index'       => [ [ 'rulenum' ] ],
2596    },
2597
2598     'svc_forward' => {
2599       'columns' => [
2600         'svcnum',   'int',            '',   '', '', '',
2601         'srcsvc',   'int',        'NULL',   '', '', '',
2602         'src',      'varchar',    'NULL',  255, '', '',
2603         'dstsvc',   'int',        'NULL',   '', '', '',
2604         'dst',      'varchar',    'NULL',  255, '', '',
2605       ],
2606       'primary_key' => 'svcnum',
2607       'unique'      => [],
2608       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2609     },
2610
2611     'svc_www' => {
2612       'columns' => [
2613         'svcnum',   'int',      '',  '', '', '',
2614         'recnum',   'int',      '',  '', '', '',
2615         'usersvc',  'int',  'NULL',  '', '', '',
2616         'config',   'text', 'NULL',  '', '', '',
2617       ],
2618       'primary_key' => 'svcnum',
2619       'unique'      => [],
2620       'index'       => [],
2621     },
2622
2623     #'svc_wo' => {
2624     #  'columns' => [
2625     #    'svcnum',    'int',    '',   '',
2626     #    'svcnum',    'int',    '',   '',
2627     #    'svcnum',    'int',    '',   '',
2628     #    'worker',    'varchar',   '',   $char_d,
2629     #    '_date',     @date_type,
2630     #  ],
2631     #  'primary_key' => 'svcnum',
2632     #  'unique' => [ [] ],
2633     #  'index' => [ [] ],
2634     #},
2635
2636     'prepay_credit' => {
2637       'columns' => [
2638         'prepaynum',   'serial',     '',   '', '', '',
2639         'identifier',  'varchar', '', $char_d, '', '',
2640         'amount',      @money_type, '', '',
2641         'seconds',     'int',     'NULL', '', '', '',
2642         'upbytes',     'bigint',     'NULL', '', '', '',
2643         'downbytes',   'bigint',     'NULL', '', '', '',
2644         'totalbytes',  'bigint',     'NULL', '', '', '',
2645         'agentnum',    'int',     'NULL', '', '', '',
2646       ],
2647       'primary_key' => 'prepaynum',
2648       'unique'      => [ ['identifier'] ],
2649       'index'       => [],
2650     },
2651
2652     'port' => {
2653       'columns' => [
2654         'portnum',  'serial',     '',   '', '', '',
2655         'ip',       'varchar', 'NULL', 15, '', '',
2656         'nasport',  'int',     'NULL', '', '', '',
2657         'nasnum',   'int',     '',   '', '', '',
2658       ],
2659       'primary_key' => 'portnum',
2660       'unique'      => [],
2661       'index'       => [],
2662     },
2663
2664     'nas' => {
2665       'columns' => [
2666         'nasnum',       'serial',     '',  '',              '', '',
2667         'nasname',     'varchar',     '', 128,              '', '',
2668         'shortname',   'varchar', 'NULL',  32,              '', '',
2669         'type',        'varchar',     '',  30,         'other', '',
2670         'ports',           'int', 'NULL',  '',              '', '',
2671         'secret',      'varchar',     '',  60,        'secret', '',
2672         'server',      'varchar', 'NULL',  64,              '', '',
2673         'community',   'varchar', 'NULL',  50,              '', '',
2674         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2675         'svcnum',          'int', 'NULL',  '',              '', '',
2676       ],
2677       'primary_key' => 'nasnum',
2678       'unique'      => [ [ 'nasname' ], ],
2679       'index'       => [],
2680     },
2681
2682     'export_nas' => {
2683       'columns' => [
2684         'exportnasnum', 'serial', '', '', '', '',
2685         'exportnum',       'int', '', '', '', '',
2686         'nasnum',          'int', '', '', '', '',
2687       ],
2688       'primary_key' => 'exportnasnum',
2689       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2690       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
2691     },
2692
2693     'queue' => {
2694       'columns' => [
2695         'jobnum',   'bigserial',     '',      '', '', '',
2696         'job',        'varchar',     '',     512, '', '',
2697         '_date',          'int',     '',      '', '', '',
2698         'status',     'varchar',     '', $char_d, '', '',
2699         'statustext',    'text', 'NULL',      '', '', '',
2700         'svcnum',         'int', 'NULL',      '', '', '',
2701         'custnum',        'int', 'NULL',      '', '', '',
2702         'secure',        'char', 'NULL',       1, '', '',
2703         'priority',       'int', 'NULL',      '', '', '',
2704       ],
2705       'primary_key' => 'jobnum',
2706       'unique'      => [],
2707       'index'       => [ [ 'secure' ], [ 'priority' ],
2708                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2709                        ],
2710     },
2711
2712     'queue_arg' => {
2713       'columns' => [
2714         'argnum', 'bigserial',     '', '', '', '',
2715         'jobnum',    'bigint',     '', '', '', '',
2716         'frozen',      'char', 'NULL',  1, '', '',
2717         'arg',         'text', 'NULL', '', '', '',
2718       ],
2719       'primary_key' => 'argnum',
2720       'unique'      => [],
2721       'index'       => [ [ 'jobnum' ] ],
2722     },
2723
2724     'queue_depend' => {
2725       'columns' => [
2726         'dependnum',  'bigserial', '', '', '', '',
2727         'jobnum',        'bigint', '', '', '', '',
2728         'depend_jobnum', 'bigint', '', '', '', '',
2729       ],
2730       'primary_key' => 'dependnum',
2731       'unique'      => [],
2732       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2733     },
2734
2735     'export_svc' => {
2736       'columns' => [
2737         'exportsvcnum' => 'serial', '', '', '', '',
2738         'exportnum'    => 'int', '', '', '', '',
2739         'svcpart'      => 'int', '', '', '', '',
2740       ],
2741       'primary_key' => 'exportsvcnum',
2742       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2743       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2744     },
2745
2746     'export_device' => {
2747       'columns' => [
2748         'exportdevicenum' => 'serial', '', '', '', '',
2749         'exportnum'    => 'int', '', '', '', '',
2750         'devicepart'      => 'int', '', '', '', '',
2751       ],
2752       'primary_key' => 'exportdevicenum',
2753       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2754       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2755     },
2756
2757     'part_export' => {
2758       'columns' => [
2759         'exportnum',   'serial',     '',      '', '', '',
2760         'exportname', 'varchar', 'NULL', $char_d, '', '',
2761         'machine',    'varchar', 'NULL', $char_d, '', '',
2762         'exporttype', 'varchar',     '', $char_d, '', '',
2763         'nodomain',      'char', 'NULL',       1, '', '',
2764         'default_machine','int', 'NULL',      '', '', '',
2765       ],
2766       'primary_key' => 'exportnum',
2767       'unique'      => [],
2768       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2769     },
2770
2771     'part_export_option' => {
2772       'columns' => [
2773         'optionnum', 'serial', '', '', '', '',
2774         'exportnum', 'int', '', '', '', '',
2775         'optionname', 'varchar', '', $char_d, '', '',
2776         'optionvalue', 'text', 'NULL', '', '', '',
2777       ],
2778       'primary_key' => 'optionnum',
2779       'unique'      => [],
2780       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2781     },
2782
2783     'radius_usergroup' => {
2784       'columns' => [
2785         'usergroupnum', 'serial', '', '', '', '',
2786         'svcnum',       'int', '', '', '', '',
2787         'groupname',    'varchar', 'NULL', $char_d, '', '',
2788         'groupnum',     'int', 'NULL', '', '', '',
2789       ],
2790       'primary_key' => 'usergroupnum',
2791       'unique'      => [],
2792       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2793     },
2794
2795     'radius_group' => {
2796       'columns' => [
2797         'groupnum', 'serial', '', '', '', '',
2798         'groupname',    'varchar', '', $char_d, '', '',
2799         'description',  'varchar', 'NULL', $char_d, '', '',
2800         'priority', 'int', '', '', '1', '',
2801         'speed_up', 'int', 'NULL', '', '', '',
2802         'speed_down', 'int', 'NULL', '', '', '',
2803       ],
2804       'primary_key' => 'groupnum',
2805       'unique'      => [ ['groupname'] ],
2806       'index'       => [],
2807     },
2808
2809     'radius_attr' => {
2810       'columns' => [
2811         'attrnum',   'serial', '',      '', '', '',
2812         'groupnum',     'int', '',      '', '', '',
2813         'attrname', 'varchar', '', $char_d, '', '',
2814         'value',    'varchar', '',     255, '', '',
2815         'attrtype',    'char', '',       1, '', '',
2816         'op',          'char', '',       2, '', '',
2817       ],
2818       'primary_key' => 'attrnum',
2819       'unique'      => [],
2820       'index'       => [ ['groupnum'], ],
2821     },
2822
2823     'msgcat' => {
2824       'columns' => [
2825         'msgnum', 'serial', '', '', '', '',
2826         'msgcode', 'varchar', '', 255, '', '',
2827         'locale', 'varchar', '', 16, '', '',
2828         'msg', 'text', '', '', '', '',
2829       ],
2830       'primary_key' => 'msgnum',
2831       'unique'      => [ [ 'msgcode', 'locale' ] ],
2832       'index'       => [],
2833     },
2834
2835     'cust_tax_exempt' => {
2836       'columns' => [
2837         'exemptnum', 'serial', '', '', '', '',
2838         'custnum',   'int', '', '', '', '',
2839         'taxnum',    'int', '', '', '', '',
2840         'year',      'int', '', '', '', '',
2841         'month',     'int', '', '', '', '',
2842         'amount',   @money_type, '', '',
2843       ],
2844       'primary_key' => 'exemptnum',
2845       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2846       'index'       => [],
2847     },
2848
2849     'cust_tax_exempt_pkg' => {
2850       'columns' => [
2851         'exemptpkgnum',  'serial', '', '', '', '',
2852         #'custnum',      'int', '', '', '', ''
2853         'billpkgnum',   'int', '', '', '', '',
2854         'taxnum',       'int', '', '', '', '',
2855         'year',         'int', 'NULL', '', '', '',
2856         'month',        'int', 'NULL', '', '', '',
2857         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2858         'amount',       @money_type, '', '',
2859         # exemption type flags
2860         'exempt_cust',          'char', 'NULL', 1, '', '',
2861         'exempt_setup',         'char', 'NULL', 1, '', '',
2862         'exempt_recur',         'char', 'NULL', 1, '', '',
2863         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
2864         'exempt_monthly',       'char', 'NULL', 1, '', '',
2865       ],
2866       'primary_key' => 'exemptpkgnum',
2867       'unique' => [],
2868       'index'  => [ [ 'taxnum', 'year', 'month' ],
2869                     [ 'billpkgnum' ],
2870                     [ 'taxnum' ],
2871                     [ 'creditbillpkgnum' ],
2872                   ],
2873     },
2874
2875     'cust_tax_exempt_pkg_void' => {
2876       'columns' => [
2877         'exemptpkgnum',  'int', '', '', '', '',
2878         #'custnum',      'int', '', '', '', ''
2879         'billpkgnum',   'int', '', '', '', '',
2880         'taxnum',       'int', '', '', '', '',
2881         'year',         'int', 'NULL', '', '', '',
2882         'month',        'int', 'NULL', '', '', '',
2883         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2884         'amount',       @money_type, '', '',
2885         # exemption type flags
2886         'exempt_cust',          'char', 'NULL', 1, '', '',
2887         'exempt_setup',         'char', 'NULL', 1, '', '',
2888         'exempt_recur',         'char', 'NULL', 1, '', '',
2889         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
2890         'exempt_monthly',       'char', 'NULL', 1, '', '',
2891       ],
2892       'primary_key' => 'exemptpkgnum',
2893       'unique' => [],
2894       'index'  => [ [ 'taxnum', 'year', 'month' ],
2895                     [ 'billpkgnum' ],
2896                     [ 'taxnum' ],
2897                     [ 'creditbillpkgnum' ],
2898                   ],
2899     },
2900
2901     'router' => {
2902       'columns' => [
2903         'routernum', 'serial', '', '', '', '',
2904         'routername', 'varchar', '', $char_d, '', '',
2905         'svcnum', 'int', 'NULL', '', '', '',
2906         'agentnum',   'int', 'NULL', '', '', '',
2907         'manual_addr', 'char', 'NULL', 1, '', '',
2908       ],
2909       'primary_key' => 'routernum',
2910       'unique'      => [],
2911       'index'       => [],
2912     },
2913
2914     'part_svc_router' => {
2915       'columns' => [
2916         'svcrouternum', 'serial', '', '', '', '',
2917         'svcpart', 'int', '', '', '', '',
2918         'routernum', 'int', '', '', '', '',
2919       ],
2920       'primary_key' => 'svcrouternum',
2921       'unique'      => [],
2922       'index'       => [],
2923     },
2924
2925     'addr_block' => {
2926       'columns' => [
2927         'blocknum', 'serial', '', '', '', '',
2928         'routernum', 'int', '', '', '', '',
2929         'ip_gateway', 'varchar', '', 15, '', '',
2930         'ip_netmask', 'int', '', '', '', '',
2931         'agentnum',   'int', 'NULL', '', '', '',
2932         'manual_flag', 'char', 'NULL', 1, '', '',
2933       ],
2934       'primary_key' => 'blocknum',
2935       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2936       'index'       => [],
2937     },
2938
2939     'svc_broadband' => {
2940       'columns' => [
2941         'svcnum',                  'int',     '',        '', '', '',
2942         'description',         'varchar', 'NULL',   $char_d, '', '',
2943         'routernum',               'int', 'NULL',        '', '', '',
2944         'blocknum',                'int', 'NULL',        '', '', '',
2945         'sectornum',               'int', 'NULL',        '', '', '',
2946         'speed_up',                'int', 'NULL',        '', '', '',
2947         'speed_down',              'int', 'NULL',        '', '', '',
2948         'ip_addr',             'varchar', 'NULL',        15, '', '',
2949         'mac_addr',            'varchar', 'NULL',        12, '', '',
2950         'authkey',             'varchar', 'NULL',        32, '', '',
2951         'latitude',            'decimal', 'NULL',    '10,7', '', '',
2952         'longitude',           'decimal', 'NULL',    '10,7', '', '',
2953         'altitude',            'decimal', 'NULL',        '', '', '',
2954         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
2955         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
2956         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
2957         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
2958         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
2959         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
2960         'rssi',                    'int', 'NULL',        '', '', '',
2961         'suid',                    'int', 'NULL',        '', '', '',
2962         'shared_svcnum',           'int', 'NULL',        '', '', '',
2963       ],
2964       'primary_key' => 'svcnum',
2965       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
2966       'index'       => [],
2967     },
2968
2969     'tower' => {
2970       'columns' => [
2971         'towernum',   'serial',     '',      '', '', '',
2972         #'agentnum',      'int', 'NULL',      '', '', '',
2973         'towername', 'varchar',     '', $char_d, '', '',
2974         'disabled',     'char', 'NULL',       1, '', '',
2975         'latitude', 'decimal', 'NULL',   '10,7', '', '',
2976         'longitude','decimal', 'NULL',   '10,7', '', '',
2977         'altitude', 'decimal', 'NULL',       '', '', '',
2978         'coord_auto',  'char', 'NULL',        1, '', '',
2979       ],
2980       'primary_key' => 'towernum',
2981       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
2982       'index'       => [],
2983     },
2984
2985     'tower_sector' => {
2986       'columns' => [
2987         'sectornum',   'serial',     '',      '', '', '',
2988         'towernum',       'int',     '',      '', '', '',
2989         'sectorname', 'varchar',     '', $char_d, '', '',
2990         'ip_addr',    'varchar', 'NULL',      15, '', '',
2991       ],
2992       'primary_key' => 'sectornum',
2993       'unique'      => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
2994       'index'       => [ [ 'towernum' ] ],
2995     },
2996
2997     'part_virtual_field' => {
2998       'columns' => [
2999         'vfieldpart', 'serial', '', '', '', '',
3000         'dbtable', 'varchar', '', 32, '', '',
3001         'name', 'varchar', '', 32, '', '',
3002         'length', 'int', 'NULL', '', '', '',
3003         'label', 'varchar', 'NULL', 80, '', '',
3004       ],
3005       'primary_key' => 'vfieldpart',
3006       'unique' => [],
3007       'index' => [],
3008     },
3009
3010     'virtual_field' => {
3011       'columns' => [
3012         'vfieldnum', 'serial', '', '', '', '',
3013         'recnum', 'int', '', '', '', '',
3014         'vfieldpart', 'int', '', '', '', '',
3015         'value', 'varchar', '', 128, '', '',
3016       ],
3017       'primary_key' => 'vfieldnum',
3018       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
3019       'index' => [],
3020     },
3021
3022     'acct_snarf' => {
3023       'columns' => [
3024         'snarfnum',    'serial',     '',      '', '', '',
3025         'snarfname',  'varchar', 'NULL', $char_d, '', '',
3026         'svcnum',         'int',     '',      '', '', '',
3027         'machine',    'varchar',     '',     255, '', '',
3028         'protocol',   'varchar',     '', $char_d, '', '',
3029         'username',   'varchar',     '', $char_d, '', '',
3030         '_password',  'varchar',     '', $char_d, '', '',
3031         'check_freq',     'int', 'NULL',      '', '', '',
3032         'leavemail',     'char', 'NULL',       1, '', '',
3033         'apop',          'char', 'NULL',       1, '', '',
3034         'tls',           'char', 'NULL',       1, '', '',
3035         'mailbox',    'varchar', 'NULL', $char_d, '', '',
3036       ],
3037       'primary_key' => 'snarfnum',
3038       'unique' => [],
3039       'index'  => [ [ 'svcnum' ] ],
3040     },
3041
3042     'svc_external' => {
3043       'columns' => [
3044         'svcnum',     'int',     '',      '', '', '',
3045         'id',      'bigint', 'NULL',      '', '', '',
3046         'title',  'varchar', 'NULL', $char_d, '', '',
3047       ],
3048       'primary_key' => 'svcnum',
3049       'unique'      => [],
3050       'index'       => [],
3051     },
3052
3053     'cust_pay_refund' => {
3054       'columns' => [
3055         'payrefundnum', 'serial', '', '', '', '',
3056         'paynum',  'int', '', '', '', '',
3057         'refundnum',  'int', '', '', '', '',
3058         '_date',    @date_type, '', '',
3059         'amount',   @money_type, '', '',
3060       ],
3061       'primary_key' => 'payrefundnum',
3062       'unique' => [],
3063       'index' => [ ['paynum'], ['refundnum'] ],
3064     },
3065
3066     'part_pkg_option' => {
3067       'columns' => [
3068         'optionnum', 'serial', '', '', '', '',
3069         'pkgpart', 'int', '', '', '', '',
3070         'optionname', 'varchar', '', $char_d, '', '',
3071         'optionvalue', 'text', 'NULL', '', '', '',
3072       ],
3073       'primary_key' => 'optionnum',
3074       'unique'      => [],
3075       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
3076     },
3077
3078     'part_pkg_vendor' => {
3079       'columns' => [
3080         'num', 'serial', '', '', '', '',
3081         'pkgpart', 'int', '', '', '', '',
3082         'exportnum', 'int', '', '', '', '',
3083         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
3084       ],
3085       'primary_key' => 'num',
3086       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
3087       'index'       => [ [ 'pkgpart' ] ],
3088     },
3089
3090     'part_pkg_report_option' => {
3091       'columns' => [
3092         'num',      'serial',   '',      '', '', '',
3093         'name',     'varchar',  '', $char_d, '', '',
3094         'disabled', 'char', 'NULL',       1, '', '',
3095       ],
3096       'primary_key' => 'num',
3097       'unique' => [ [ 'name' ] ],
3098       'index' => [ [ 'disabled' ] ],
3099     },
3100
3101     'part_pkg_usage' => {
3102       'columns' => [
3103         'pkgusagepart', 'serial',   '', '', '', '',
3104         'pkgpart',  'int',      '', '', '', '',
3105         'minutes',  'int',      '', '', '', '',
3106         'priority', 'int',  'NULL', '', '', '',
3107         'shared',   'char', 'NULL',  1, '', '',
3108         'rollover', 'char', 'NULL',  1, '', '',
3109         'description',  'varchar', 'NULL', $char_d, '', '',
3110       ],
3111       'primary_key' => 'pkgusagepart',
3112       'unique'      => [],
3113       'index'       => [ [ 'pkgpart' ] ],
3114     },
3115
3116     'part_pkg_usage_class' => {
3117       'columns' => [
3118         'num',       'serial',  '', '', '', '',
3119         'pkgusagepart', 'int',  '', '', '', '',
3120         'classnum',     'int','NULL', '', '', '',
3121       ],
3122       'primary_key' => 'num',
3123       'unique'      => [ [ 'pkgusagepart', 'classnum' ] ],
3124       'index'       => [],
3125     },
3126
3127     'rate' => {
3128       'columns' => [
3129         'ratenum',  'serial', '', '', '', '',
3130         'ratename', 'varchar', '', $char_d, '', '',
3131       ],
3132       'primary_key' => 'ratenum',
3133       'unique'      => [],
3134       'index'       => [],
3135     },
3136
3137     'rate_detail' => {
3138       'columns' => [
3139         'ratedetailnum',   'serial',  '',     '',      '', '',
3140         'ratenum',         'int',     '',     '',      '', '',
3141         'orig_regionnum',  'int', 'NULL',     '',      '', '',
3142         'dest_regionnum',  'int',     '',     '',      '', '',
3143         'min_included',    'int',     '',     '',      '', '',
3144         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
3145         'conn_sec',        'int',     '',     '',      '0', '',
3146         'min_charge',      'decimal', '', '10,5',       '', '',
3147         'sec_granularity', 'int',     '',     '',       '', '',
3148         'ratetimenum',     'int', 'NULL',     '',       '', '',
3149         'classnum',        'int', 'NULL',     '',       '', '',
3150         'cdrtypenum',      'int', 'NULL',     '',       '', '',
3151         'region_group', 'char', 'NULL',        1,       '', '',
3152       ],
3153       'primary_key' => 'ratedetailnum',
3154       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
3155       'index'       => [ [ 'ratenum', 'dest_regionnum' ],
3156                          [ 'ratenum', 'ratetimenum' ]
3157                        ],
3158     },
3159
3160     'rate_region' => {
3161       'columns' => [
3162         'regionnum',   'serial',      '', '', '', '',
3163         'regionname',  'varchar',     '', $char_d, '', '',
3164         'exact_match', 'char',    'NULL',  1, '', '',
3165       ],
3166       'primary_key' => 'regionnum',
3167       'unique'      => [],
3168       'index'       => [],
3169     },
3170
3171     'rate_prefix' => {
3172       'columns' => [
3173         'prefixnum',   'serial',      '', '', '', '',
3174         'regionnum',   'int',         '', '', '', '',
3175         'countrycode', 'varchar',     '',  3, '', '',
3176         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
3177         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
3178         'latanum',     'int',     'NULL',      '', '', '',
3179         'state',       'char',    'NULL',       2, '', '',
3180         'ocn',         'char',    'NULL',       4, '', '',
3181       ],
3182       'primary_key' => 'prefixnum',
3183       'unique'      => [],
3184       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
3185     },
3186
3187     'rate_time' => {
3188       'columns' => [
3189         'ratetimenum', 'serial',      '',      '', '', '',
3190         'ratetimename',   'varchar',      '', $char_d, '', '',
3191       ],
3192       'primary_key' => 'ratetimenum',
3193       'unique'      => [],
3194       'index'       => [],
3195     },
3196
3197     'rate_time_interval' => {
3198       'columns' => [
3199         'intervalnum', 'serial', '', '', '', '',
3200         'stime',          'int', '', '', '', '',
3201         'etime',          'int', '', '', '', '',
3202         'ratetimenum',    'int', '', '', '', '',
3203       ],
3204       'primary_key' => 'intervalnum',
3205       'unique'      => [],
3206       'index'       => [],
3207     },
3208
3209     #not really part of the above rate_ stuff (used with flat rate rather than
3210     # rated billing), but could be eventually, and its a rate
3211     'rate_tier' => {
3212       'columns' => [
3213         'tiernum',   'serial', '',      '', '', '',
3214         'tiername', 'varchar', '', $char_d, '', '',
3215       ],
3216       'primary_key' => 'tiernum',
3217       'unique'      => [ [ 'tiername'], ],
3218       'index'       => [],
3219     },
3220
3221     'rate_tier_detail' => {
3222       'columns' => [
3223         'tierdetailnum', 'serial', '',     '', '', '',
3224         'tiernum',          'int', '',     '', '', '',
3225         'min_quan',         'int', '',     '', '', '',
3226         'min_charge',   'decimal', '', '10,4', '', '',
3227       ],
3228       'primary_key' => 'tierdetailnum',
3229       'unique'      => [],
3230       'index'       => [ ['tiernum'], ],
3231     },
3232
3233     'usage_class' => {
3234       'columns' => [
3235         'classnum',    'serial',      '',      '', '', '',
3236         'weight',      'int',     'NULL',      '', '', '',
3237         'classname',   'varchar',     '', $char_d, '', '',
3238         'format',      'varchar', 'NULL', $char_d, '', '',
3239         'disabled',    'char',    'NULL',       1, '', '',
3240       ],
3241       'primary_key' => 'classnum',
3242       'unique' => [],
3243       'index' => [ ['disabled'] ],
3244     },
3245
3246     'reg_code' => {
3247       'columns' => [
3248         'codenum',   'serial',    '', '', '', '',
3249         'code',      'varchar',   '', $char_d, '', '',
3250         'agentnum',  'int',       '', '', '', '',
3251       ],
3252       'primary_key' => 'codenum',
3253       'unique'      => [ [ 'agentnum', 'code' ] ],
3254       'index'       => [ [ 'agentnum' ] ],
3255     },
3256
3257     'reg_code_pkg' => {
3258       'columns' => [
3259         'codepkgnum', 'serial', '', '', '', '',
3260         'codenum',   'int',    '', '', '', '',
3261         'pkgpart',   'int',    '', '', '', '',
3262       ],
3263       'primary_key' => 'codepkgnum',
3264       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
3265       'index'       => [ [ 'codenum' ] ],
3266     },
3267
3268     'clientapi_session' => {
3269       'columns' => [
3270         'sessionnum',  'serial',  '', '', '', '',
3271         'sessionid',  'varchar',  '', $char_d, '', '',
3272         'namespace',  'varchar',  '', $char_d, '', '',
3273       ],
3274       'primary_key' => 'sessionnum',
3275       'unique'      => [ [ 'sessionid', 'namespace' ] ],
3276       'index'       => [],
3277     },
3278
3279     'clientapi_session_field' => {
3280       'columns' => [
3281         'fieldnum',    'serial',     '', '', '', '',
3282         'sessionnum',     'int',     '', '', '', '',
3283         'fieldname',  'varchar',     '', $char_d, '', '',
3284         'fieldvalue',    'text', 'NULL', '', '', '',
3285       ],
3286       'primary_key' => 'fieldnum',
3287       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
3288       'index'       => [],
3289     },
3290
3291     'payment_gateway' => {
3292       'columns' => [
3293         'gatewaynum',       'serial',   '',     '', '', '',
3294         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
3295         'gateway_module',   'varchar',  '',     $char_d, '', '',
3296         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
3297         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
3298         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
3299         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
3300         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
3301         'disabled',   'char',  'NULL',   1, '', '',
3302       ],
3303       'primary_key' => 'gatewaynum',
3304       'unique' => [],
3305       'index'  => [ [ 'disabled' ] ],
3306     },
3307
3308     'payment_gateway_option' => {
3309       'columns' => [
3310         'optionnum',   'serial',  '',     '', '', '',
3311         'gatewaynum',  'int',     '',     '', '', '',
3312         'optionname',  'varchar', '',     $char_d, '', '',
3313         'optionvalue', 'text',    'NULL', '', '', '',
3314       ],
3315       'primary_key' => 'optionnum',
3316       'unique'      => [],
3317       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
3318     },
3319
3320     'agent_payment_gateway' => {
3321       'columns' => [
3322         'agentgatewaynum', 'serial', '', '', '', '',
3323         'agentnum',        'int', '', '', '', '',
3324         'gatewaynum',      'int', '', '', '', '',
3325         'cardtype',        'varchar', 'NULL', $char_d, '', '',
3326         'taxclass',        'varchar', 'NULL', $char_d, '', '',
3327       ],
3328       'primary_key' => 'agentgatewaynum',
3329       'unique'      => [],
3330       'index'       => [ [ 'agentnum', 'cardtype' ], ],
3331     },
3332
3333     'banned_pay' => {
3334       'columns' => [
3335         'bannum',  'serial',   '',     '', '', '',
3336         'payby',   'char',     '',       4, '', '',
3337         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
3338         #'paymask', 'varchar',  'NULL', $char_d, '', ''
3339         '_date',            @date_type,         '', '',
3340         'end_date',         @date_type,         '', '',
3341         'otaker',  'varchar',  'NULL',      32, '', '',
3342         'usernum',     'int',  'NULL',      '', '', '',
3343         'bantype', 'varchar',  'NULL', $char_d, '', '',
3344         'reason',  'varchar',  'NULL', $char_d, '', '',
3345       ],
3346       'primary_key' => 'bannum',
3347       'unique'      => [],
3348       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
3349     },
3350
3351     'pkg_category' => {
3352       'columns' => [
3353         'categorynum',   'serial',  '', '', '', '',
3354         'categoryname',  'varchar', '', $char_d, '', '',
3355         'weight',         'int', 'NULL',  '', '', '',
3356         'condense',      'char', 'NULL',   1, '', '',
3357         'disabled',      'char', 'NULL',   1, '', '',
3358       ],
3359       'primary_key' => 'categorynum',
3360       'unique' => [],
3361       'index' => [ ['disabled'] ],
3362     },
3363
3364     'pkg_class' => {
3365       'columns' => [
3366         'classnum',    'serial',   '',      '', '', '',
3367         'classname',   'varchar',  '', $char_d, '', '',
3368         'categorynum', 'int',  'NULL',      '', '', '',
3369         'disabled',    'char', 'NULL',       1, '', '',
3370         'fcc_ds0s',      'int',     'NULL', '', '', '',
3371       ],
3372       'primary_key' => 'classnum',
3373       'unique' => [],
3374       'index' => [ ['disabled'] ],
3375     },
3376
3377     'cdr' => {
3378       'columns' => [
3379         # qw( name type null length default local );
3380
3381         ###
3382         #asterisk fields
3383         ###
3384
3385         'acctid',   'bigserial',  '', '', '', '',
3386         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
3387         'calldate', 'timestamp',   '',      '', \'now()', '',
3388         'clid',        'varchar',  '', $char_d, \"''", '',
3389         'src',         'varchar',  '', $char_d, \"''", '',
3390         'dst',         'varchar',  '', $char_d, \"''", '',
3391         'dcontext',    'varchar',  '', $char_d, \"''", '',
3392         'channel',     'varchar',  '', $char_d, \"''", '',
3393         'dstchannel',  'varchar',  '', $char_d, \"''", '',
3394         'lastapp',     'varchar',  '', $char_d, \"''", '',
3395         'lastdata',    'varchar',  '',     255, \"''", '',
3396
3397         #currently only opensips
3398         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
3399         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
3400
3401         #these don't seem to be logged by most of the SQL cdr_* modules
3402         #except tds under sql-illegal names, so;
3403         # ... don't rely on them for rating?
3404         # and, what they hey, i went ahead and changed the names and data types
3405         # to freeside-style dates...
3406           #'start',  'timestamp', 'NULL',  '',    '', '',
3407           #'answer', 'timestamp', 'NULL',  '',    '', '',
3408           #'end',    'timestamp', 'NULL',  '',    '', '',
3409         'startdate',  @date_type, '', '',
3410         'answerdate', @date_type, '', '',
3411         'enddate',    @date_type, '', '',
3412         #
3413
3414         'duration',    'int',      '',      '',     0, '',
3415         'billsec',     'int',      '',      '',     0, '',
3416         'disposition', 'varchar',  '',      45, \"''", '',
3417         'amaflags',    'int',      '',      '',     0, '',
3418         'accountcode', 'varchar',  '',      20, \"''", '',
3419         'uniqueid',    'varchar',  '', $char_d, \"''", '',
3420         'userfield',   'varchar',  '',     512, \"''", '',
3421
3422         'max_callers', 'int',  'NULL',      '',    '', '',
3423
3424         ###
3425         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
3426         # ones we adoped moved to "own fields" section below
3427         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
3428         ###
3429
3430         'upstream_currency',      'char', 'NULL',       3, '', '',
3431         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
3432
3433         # how it was rated internally...
3434         'ratedetailnum',           'int', 'NULL',      '', '', '',
3435
3436         'distance',            'decimal', 'NULL',      '', '', '',
3437         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
3438
3439         #cdr_calltype: the big list in appendix 2
3440         'calltypenum',             'int', 'NULL',      '', '', '',
3441
3442         'description',         'varchar', 'NULL', $char_d, '', '',
3443         'quantity',                'int', 'NULL',      '', '', '',
3444
3445         'upstream_rateid',         'int', 'NULL',      '', '', '',
3446
3447         ###
3448         # more fields, for GSM imports
3449         ###
3450         'servicecode',             'int', 'NULL',      '', '', '',
3451         'quantity_able',           'int', 'NULL',      '', '', '',
3452
3453         ###
3454         #and now for our own fields
3455         ###
3456
3457         'cdrtypenum',              'int', 'NULL',      '', '', '',
3458
3459         'charged_party',       'varchar', 'NULL', $char_d, '', '',
3460         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
3461
3462         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
3463         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
3464         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
3465
3466         # how it was rated internally...
3467         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
3468         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
3469         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
3470         'rated_seconds',              'int', 'NULL',      '', '', '',
3471         'rated_minutes', 'double precision', 'NULL',      '', '', '',
3472         'rated_granularity',          'int', 'NULL',      '', '', '',
3473         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
3474         'rated_classnum',             'int', 'NULL',      '', '', '',
3475         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
3476
3477         'carrierid',               'bigint', 'NULL',      '', '', '',
3478
3479         # service it was matched to
3480         'svcnum',             'int',   'NULL',     '',   '', '',
3481
3482         #NULL, done (or something)
3483         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
3484
3485         #NULL, done (or something)
3486         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
3487
3488         #an indexed place to put big numbers
3489         'cdrid',         'bigint',     'NULL',     '',  '', '',
3490
3491         #for taqua accountcode rewriting, for starters
3492         'sessionnum',       'int',    'NULL',      '', '', '',
3493         'subscriber',   'varchar',    'NULL', $char_d, '', '',
3494
3495         #old
3496         'cdrbatch',     'varchar',    'NULL',     255, '', '',
3497         #new
3498         'cdrbatchnum',      'int',    'NULL',      '', '', '',
3499
3500       ],
3501       'primary_key' => 'acctid',
3502       'unique' => [],
3503       'index' => [ [ 'calldate' ],
3504                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
3505                    [ 'lastapp' ],
3506                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
3507                    [ 'sessionnum' ], [ 'subscriber' ],
3508                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
3509                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
3510                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ],
3511                  ],
3512     },
3513
3514     'cdr_batch' => {
3515       'columns' => [
3516         'cdrbatchnum',   'serial',    '',   '', '', '',
3517         'cdrbatch', 'varchar', 'NULL', 255, '', '',
3518         '_date',     @date_type, '', '',
3519       ],
3520       'primary_key' => 'cdrbatchnum',
3521       'unique' => [ [ 'cdrbatch' ] ],
3522       'index' => [],
3523     },
3524
3525     'cdr_termination' => {
3526       'columns' => [
3527         'cdrtermnum', 'bigserial',     '',      '', '', '',
3528         'acctid',        'bigint',     '',      '', '', '',
3529         'termpart',         'int',     '',      '', '', '',#future use see below
3530         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
3531         'rated_seconds',    'int', 'NULL',      '', '', '',
3532         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3533         'status',       'varchar', 'NULL',      32, '', '',
3534         'svcnum',           'int', 'NULL',      '', '', '',
3535       ],
3536       'primary_key' => 'cdrtermnum',
3537       'unique'      => [ [ 'acctid', 'termpart' ] ],
3538       'index'       => [ [ 'acctid' ], [ 'status' ], ],
3539     },
3540
3541     #to handle multiple termination/settlement passes...
3542    # 'part_termination' => {
3543    #   'columns' => [
3544    #     'termpart',       'int', '',      '', '', '',
3545    #     'termname',   'varchar', '', $char_d, '', '',
3546    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
3547    #   ],
3548    #   'primary_key' => 'termpart',
3549    #   'unique' => [],
3550    #   'index'  => [],
3551    # },
3552
3553     #the remaining cdr_ tables are not really used
3554     'cdr_calltype' => {
3555       'columns' => [
3556         'calltypenum',   'serial',  '', '', '', '',
3557         'calltypename',  'varchar', '', $char_d, '', '',
3558       ],
3559       'primary_key' => 'calltypenum',
3560       'unique'      => [],
3561       'index'       => [],
3562     },
3563
3564     'cdr_type' => {
3565       'columns' => [
3566         'cdrtypenum'  => 'serial',  '', '', '', '',
3567         'cdrtypename' => 'varchar', '', $char_d, '', '',
3568       ],
3569       'primary_key' => 'cdrtypenum',
3570       'unique'      => [],
3571       'index'       => [],
3572     },
3573
3574     'cdr_carrier' => {
3575       'columns' => [
3576         'carrierid'   =>  'serial',     '',      '', '', '',
3577         'carriername' => 'varchar',     '', $char_d, '', '',
3578         'disabled'    =>    'char', 'NULL',       1, '', '',
3579       ],
3580       'primary_key' => 'carrierid',
3581       'unique'      => [],
3582       'index'       => [],
3583     },
3584
3585     #'cdr_file' => {
3586     #  'columns' => [
3587     #    'filenum',    'serial',     '', '', '', '',
3588     #    'filename',  'varchar',     '', '', '', '',
3589     #    'status',    'varchar', 'NULL', '', '', '',
3590     #  ],
3591     #  'primary_key' => 'filenum',
3592     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
3593     #                                   # agent-virtualize or have a customer
3594     #                                   # with dup-filename needs or something
3595     #                                   # (only used by cdr.http_and_import for
3596     #                                   #  chrissakes)
3597     #  'index'  => [],
3598     #},
3599
3600     'inventory_item' => {
3601       'columns' => [
3602         'itemnum',   'serial',      '',      '', '', '',
3603         'classnum',  'int',         '',      '', '', '',
3604         'agentnum',  'int',     'NULL',      '', '', '',
3605         'item',      'varchar',     '', $char_d, '', '',
3606         'svcnum',    'int',     'NULL',      '', '', '',
3607         'svc_field', 'varchar', 'NULL', $char_d, '', '',
3608       ],
3609       'primary_key' => 'itemnum',
3610       'unique' => [ [ 'classnum', 'item' ] ],
3611       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3612     },
3613
3614     'inventory_class' => {
3615       'columns' => [
3616         'classnum',  'serial',       '',      '', '', '',
3617         'classname', 'varchar',      '', $char_d, '', '',
3618       ],
3619       'primary_key' => 'classnum',
3620       'unique' => [],
3621       'index'  => [],
3622     },
3623
3624     'access_user' => {
3625       'columns' => [
3626         'usernum',   'serial',  '',      '', '', '',
3627         'username',  'varchar', '', $char_d, '', '',
3628         '_password', 'varchar', '', $char_d, '', '',
3629         'last',      'varchar', '', $char_d, '', '',
3630         'first',     'varchar', '', $char_d, '', '',
3631         'user_custnum',  'int', 'NULL',  '', '', '',
3632         'disabled',     'char', 'NULL',   1, '', '',
3633       ],
3634       'primary_key' => 'usernum',
3635       'unique' => [ [ 'username' ] ],
3636       'index'  => [ [ 'user_custnum' ] ],
3637     },
3638
3639     'access_user_pref' => {
3640       'columns' => [
3641         'prefnum',    'serial',       '', '', '', '',
3642         'usernum',     'int',       '', '', '', '',
3643         'prefname', 'varchar', '', $char_d, '', '',
3644         'prefvalue', 'text', 'NULL', '', '', '',
3645         'expiration', @date_type, '', '',
3646       ],
3647       'primary_key' => 'prefnum',
3648       'unique' => [],
3649       'index'  => [ [ 'usernum' ] ],
3650     },
3651
3652     'access_group' => {
3653       'columns' => [
3654         'groupnum',   'serial', '',      '', '', '',
3655         'groupname', 'varchar', '', $char_d, '', '',
3656       ],
3657       'primary_key' => 'groupnum',
3658       'unique' => [ [ 'groupname' ] ],
3659       'index'  => [],
3660     },
3661
3662     'access_usergroup' => {
3663       'columns' => [
3664         'usergroupnum', 'serial', '', '', '', '',
3665         'usernum',         'int', '', '', '', '',
3666         'groupnum',        'int', '', '', '', '',
3667       ],
3668       'primary_key' => 'usergroupnum',
3669       'unique' => [ [ 'usernum', 'groupnum' ] ],
3670       'index'  => [ [ 'usernum' ] ],
3671     },
3672
3673     'access_groupagent' => {
3674       'columns' => [
3675         'groupagentnum', 'serial', '', '', '', '',
3676         'groupnum',         'int', '', '', '', '',
3677         'agentnum',         'int', '', '', '', '',
3678       ],
3679       'primary_key' => 'groupagentnum',
3680       'unique' => [ [ 'groupnum', 'agentnum' ] ],
3681       'index'  => [ [ 'groupnum' ] ],
3682     },
3683
3684     'access_right' => {
3685       'columns' => [
3686         'rightnum',   'serial', '',      '', '', '',
3687         'righttype', 'varchar', '', $char_d, '', '',
3688         'rightobjnum',   'int', '',      '', '', '',
3689         'rightname', 'varchar', '', $char_d, '', '',
3690       ],
3691       'primary_key' => 'rightnum',
3692       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
3693       'index'  => [],
3694     },
3695
3696     'svc_phone' => {
3697       'columns' => [
3698         'svcnum',                         'int',     '',      '', '', '',
3699         'countrycode',                'varchar',     '',       3, '', '',
3700         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
3701         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
3702         'pin',                        'varchar', 'NULL', $char_d, '', '',
3703         'sip_password',               'varchar', 'NULL', $char_d, '', '',
3704         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
3705         'pbxsvc',                         'int', 'NULL',      '', '', '',
3706         'domsvc',                         'int', 'NULL',      '', '', '',
3707         'locationnum',                    'int', 'NULL',      '', '', '',
3708         'forwarddst',                 'varchar', 'NULL',      15, '', '',
3709         'email',                      'varchar', 'NULL',     255, '', '',
3710         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
3711         'portable',                      'char', 'NULL',       1, '', '',
3712         'lrn',                           'char', 'NULL',      10, '', '',
3713         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
3714         'lnp_due_date',                   'int', 'NULL',      '', '', '',
3715         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
3716         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
3717         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
3718         'sms_carrierid',                  'int', 'NULL',      '', '', '',
3719         'sms_account',                'varchar', 'NULL', $char_d, '', '',
3720         'max_simultaneous',               'int', 'NULL',      '', '', '',
3721       ],
3722       'primary_key' => 'svcnum',
3723       'unique' => [ [ 'sms_carrierid', 'sms_account'] ],
3724       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
3725                     ['locationnum'], ['sms_carrierid'],
3726                   ],
3727     },
3728
3729     'phone_device' => {
3730       'columns' => [
3731         'devicenum', 'serial',     '', '', '', '',
3732         'devicepart',   'int',     '', '', '', '',
3733         'svcnum',       'int',     '', '', '', '',
3734         'mac_addr', 'varchar', 'NULL', 12, '', '',
3735       ],
3736       'primary_key' => 'devicenum',
3737       'unique' => [ [ 'mac_addr' ], ],
3738       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
3739     },
3740
3741     'part_device' => {
3742       'columns' => [
3743         'devicepart', 'serial',  '',      '', '', '',
3744         'devicename', 'varchar', '', $char_d, '', '',
3745         'inventory_classnum', 'int', 'NULL', '', '', '',
3746       ],
3747       'primary_key' => 'devicepart',
3748       'unique' => [ [ 'devicename' ] ], #?
3749       'index'  => [],
3750     },
3751
3752     'phone_avail' => {
3753       'columns' => [
3754         'availnum',    'serial',      '',      '', '', '',
3755         'exportnum',   'int',         '',      '', '', '',
3756         'countrycode', 'varchar',     '',       3, '', '',
3757         'state',       'char',    'NULL',       2, '', '',
3758         'npa',         'char',        '',       3, '', '',
3759         'nxx',         'char',    'NULL',       3, '', '',
3760         'station',     'char',    'NULL',       4, '', '',
3761         'name',        'varchar', 'NULL', $char_d, '', '',
3762         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
3763         'latanum',      'int',     'NULL',      '', '', '',
3764         'msanum',       'int', 'NULL', '', '', '',
3765         'ordernum',      'int',     'NULL',      '', '', '',
3766         'svcnum',      'int',     'NULL',      '', '', '',
3767         'availbatch', 'varchar',  'NULL', $char_d, '', '',
3768       ],
3769       'primary_key' => 'availnum',
3770       'unique' => [],
3771       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
3772                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
3773                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
3774                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
3775                     [ 'svcnum' ],
3776                     [ 'availbatch' ],
3777                     [ 'latanum' ],
3778                   ],
3779     },
3780
3781     'lata' => {
3782       'columns' => [
3783         'latanum',    'int',      '',      '', '', '',
3784         'description',   'varchar',    '',      $char_d, '', '',
3785         'have_usage',   'int',    'NULL',      '', '', '',
3786       ],
3787       'primary_key' => 'latanum',
3788       'unique' => [],
3789       'index'  => [],
3790     },
3791
3792     'msa' => {
3793       'columns' => [
3794         'msanum',    'int',      '',      '', '', '',
3795         'description',   'varchar',    '',      $char_d, '', '',
3796       ],
3797       'primary_key' => 'msanum',
3798       'unique' => [],
3799       'index'  => [],
3800     },
3801
3802     'rate_center' => {
3803       'columns' => [
3804         'ratecenternum',    'serial',      '',      '', '', '',
3805         'description',   'varchar',    '',      $char_d, '', '',
3806       ],
3807       'primary_key' => 'ratecenternum',
3808       'unique' => [],
3809       'index'  => [],
3810     },
3811
3812     'did_vendor' => {
3813       'columns' => [
3814         'vendornum',    'serial',      '',      '', '', '',
3815         'vendorname',   'varchar',        '',     $char_d, '', '',
3816       ],
3817       'primary_key' => 'vendornum',
3818       'unique' => [],
3819       'index'  => [],
3820     },
3821
3822     'did_order_item' => {
3823       'columns' => [
3824         'orderitemnum',    'serial',      '',      '', '', '',
3825         'ordernum',    'int',      '',      '', '', '',
3826         'msanum',      'int',     'NULL',      '', '', '',
3827         'npa',      'int',     'NULL',      '', '', '',
3828         'latanum',      'int',     'NULL',      '', '', '',
3829         'ratecenternum',      'int',     'NULL',      '', '', '',
3830         'state',       'char',    'NULL',       2, '', '',
3831         'quantity',      'int',     '',      '', '', '',
3832         'custnum',   'int', 'NULL', '', '', '',
3833       ],
3834       'primary_key' => 'orderitemnum',
3835       'unique' => [],
3836       'index'  => [],
3837     },
3838
3839     'did_order' => {
3840       'columns' => [
3841         'ordernum',    'serial',      '',      '', '', '',
3842         'vendornum',   'int',       '',      '', '', '',
3843         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
3844         'custnum',   'int', 'NULL', '', '', '',
3845         'submitted',      'int',     '',      '', '', '',
3846         'confirmed',      'int',     'NULL',      '', '', '',
3847         'received',      'int',     'NULL',      '', '', '',
3848       ],
3849       'primary_key' => 'ordernum',
3850       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
3851       'index'  => [],
3852     },
3853
3854     'reason_type' => {
3855       'columns' => [
3856         'typenum',   'serial',  '', '', '', '',
3857         'class',     'char', '', 1, '', '',
3858         'type',     'varchar', '', $char_d, '', '',
3859       ],
3860       'primary_key' => 'typenum',
3861       'unique' => [],
3862       'index' => [],
3863     },
3864
3865     'reason' => {
3866       'columns' => [
3867         'reasonnum',     'serial',  '', '', '', '',
3868         'reason_type',   'int',  '', '', '', '',
3869         'reason',        'text', '', '', '', '',
3870         'disabled',      'char',    'NULL', 1, '', '',
3871         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
3872         'unsuspend_hold','char',    'NULL', 1, '', '',
3873       ],
3874       'primary_key' => 'reasonnum',
3875       'unique' => [],
3876       'index' => [],
3877     },
3878
3879     'conf' => {
3880       'columns' => [
3881         'confnum',  'serial',     '',      '', '', '',
3882         'agentnum', 'int',    'NULL',      '', '', '',
3883         'locale',   'varchar','NULL',      16, '', '',
3884         'name',     'varchar',    '', $char_d, '', '',
3885         'value',    'text',   'NULL',      '', '', '',
3886       ],
3887       'primary_key' => 'confnum',
3888       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
3889       'index' => [],
3890     },
3891
3892     'pkg_referral' => {
3893       'columns' => [
3894         'pkgrefnum',     'serial', '', '', '', '',
3895         'pkgnum',        'int',    '', '', '', '',
3896         'refnum',        'int',    '', '', '', '',
3897       ],
3898       'primary_key' => 'pkgrefnum',
3899       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
3900       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
3901     },
3902
3903     'svc_pbx' => {
3904       'columns' => [
3905         'svcnum',           'int',     '',      '', '', '',
3906         'id',               'int', 'NULL',      '', '', '',
3907         'title',        'varchar', 'NULL', $char_d, '', '',
3908         'max_extensions',   'int', 'NULL',      '', '', '',
3909         'max_simultaneous', 'int', 'NULL',      '', '', '',
3910       ],
3911       'primary_key' => 'svcnum',
3912       'unique' => [],
3913       'index'  => [ [ 'id' ] ],
3914     },
3915
3916     'svc_mailinglist' => { #svc_group?
3917       'columns' => [
3918         'svcnum',            'int',     '',            '', '', '',
3919         'username',      'varchar',     '', $username_len, '', '',
3920         'domsvc',            'int',     '',            '', '', '',
3921         'listnum',           'int',     '',            '', '', '',
3922         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
3923         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
3924         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
3925         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
3926       ],
3927       'primary_key' => 'svcnum',
3928       'unique' => [],
3929       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
3930     },
3931
3932     'mailinglist' => {
3933       'columns' => [
3934         'listnum',   'serial', '',      '', '', '',
3935         'listname', 'varchar', '', $char_d, '', '',
3936       ],
3937       'primary_key' => 'listnum',
3938       'unique' => [],
3939       'index'  => [],
3940     },
3941
3942     'mailinglistmember' => {
3943       'columns' => [
3944         'membernum',        'serial',     '',   '', '', '',
3945         'listnum',             'int',     '',   '', '', '',
3946         'svcnum',              'int', 'NULL',   '', '', '',
3947         'contactemailnum',     'int', 'NULL',   '', '', '',
3948         'email',           'varchar', 'NULL',  255, '', '',
3949       ],
3950       'primary_key' => 'membernum',
3951       'unique'      => [],
3952       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
3953     },
3954
3955     'bill_batch' => {
3956       'columns' => [
3957         'batchnum',         'serial',     '',  '', '', '',
3958         'agentnum',            'int', 'NULL',  '', '', '',
3959         'status',             'char', 'NULL', '1', '', '',
3960         'pdf',                'blob', 'NULL',  '', '', '',
3961       ],
3962       'primary_key' => 'batchnum',
3963       'unique'      => [],
3964       'index'       => [ ['agentnum'] ],
3965     },
3966
3967     'cust_bill_batch' => {
3968       'columns' => [
3969         'billbatchnum',     'serial',     '', '', '', '',
3970         'batchnum',            'int',     '', '', '', '',
3971         'invnum',              'int',     '', '', '', '',
3972       ],
3973       'primary_key' => 'billbatchnum',
3974       'unique'      => [],
3975       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
3976     },
3977
3978     'cust_bill_batch_option' => {
3979       'columns' => [
3980         'optionnum', 'serial', '', '', '', '',
3981         'billbatchnum', 'int', '', '', '', '',
3982         'optionname', 'varchar', '', $char_d, '', '',
3983         'optionvalue', 'text', 'NULL', '', '', '',
3984       ],
3985       'primary_key' => 'optionnum',
3986       'unique'      => [],
3987       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
3988     },
3989
3990     'msg_template' => {
3991       'columns' => [
3992         'msgnum',     'serial',     '',      '', '', '',
3993         'msgname',   'varchar',     '', $char_d, '', '',
3994         'agentnum',      'int', 'NULL',      '', '', '',
3995         'subject',   'varchar', 'NULL',     512, '', '',
3996         'mime_type', 'varchar',     '', $char_d, '', '',
3997         'body',         'blob', 'NULL',      '', '', '',
3998         'disabled',     'char', 'NULL',       1, '', '',
3999         'from_addr', 'varchar', 'NULL',     255, '', '',
4000         'bcc_addr',  'varchar', 'NULL',     255, '', '',
4001       ],
4002       'primary_key' => 'msgnum',
4003       'unique'      => [ ],
4004       'index'       => [ ['agentnum'], ],
4005     },
4006
4007     'template_content' => {
4008       'columns' => [
4009         'contentnum', 'serial',     '',      '', '', '',
4010         'msgnum',        'int',     '',      '', '', '',
4011         'locale',    'varchar', 'NULL',      16, '', '',
4012         'subject',   'varchar', 'NULL',     512, '', '',
4013         'body',         'text', 'NULL',      '', '', '',
4014       ],
4015       'primary_key' => 'contentnum',
4016       'unique'      => [ ['msgnum', 'locale'] ],
4017       'index'       => [ ],
4018     },
4019
4020     'cust_msg' => {
4021       'columns' => [
4022         'custmsgnum', 'serial',     '',     '', '', '',
4023         'custnum',       'int',     '',     '', '', '',
4024         'msgnum',        'int', 'NULL',     '', '', '',
4025         '_date',    @date_type,                 '', '',
4026         'env_from',  'varchar', 'NULL',    255, '', '',
4027         'env_to',    'varchar', 'NULL',    255, '', '',
4028         'header',       'blob', 'NULL',     '', '', '',
4029         'body',         'blob', 'NULL',     '', '', '',
4030         'error',     'varchar', 'NULL',    255, '', '',
4031         'status',    'varchar',     '',$char_d, '', '',
4032       ],
4033       'primary_key' => 'custmsgnum',
4034       'unique'      => [ ],
4035       'index'       => [ ['custnum'], ],
4036     },
4037
4038     'svc_cert' => {
4039       'columns' => [
4040         'svcnum',                'int',     '',      '', '', '',
4041         'recnum',                'int', 'NULL',      '', '', '',
4042         'privatekey',           'text', 'NULL',      '', '', '',
4043         'csr',                  'text', 'NULL',      '', '', '',
4044         'certificate',          'text', 'NULL',      '', '', '',
4045         'cacert',               'text', 'NULL',      '', '', '',
4046         'common_name',       'varchar', 'NULL', $char_d, '', '',
4047         'organization',      'varchar', 'NULL', $char_d, '', '',
4048         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
4049         'city',              'varchar', 'NULL', $char_d, '', '',
4050         'state',             'varchar', 'NULL', $char_d, '', '',
4051         'country',              'char', 'NULL',       2, '', '',
4052         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
4053       ],
4054       'primary_key' => 'svcnum',
4055       'unique' => [],
4056       'index'  => [], #recnum
4057     },
4058
4059     'svc_port' => {
4060       'columns' => [
4061         'svcnum',                'int',     '',      '', '', '',
4062         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
4063       ],
4064       'primary_key' => 'svcnum',
4065       'unique' => [],
4066       'index'  => [], #recnum
4067     },
4068
4069     'areacode'  => {
4070       'columns' => [
4071         'areanum',   'serial',        '',      '', '', '',
4072         'code',        'char',        '',       3, '', '',
4073         'country',     'char',    'NULL',       2, '', '',
4074         'state',       'char',    'NULL',       2, '', '',
4075         'description','varchar',  'NULL',     255, '', '',
4076       ],
4077       'primary_key' => 'areanum',
4078       'unique' => [ [ 'areanum' ] ],
4079       'index'  => [],
4080     },
4081
4082     'upgrade_journal' => {
4083       'columns' => [
4084         'upgradenum', 'serial', '', '', '', '',
4085         '_date', 'int', '', '', '', '',
4086         'upgrade', 'varchar', '', $char_d, '', '',
4087         'status', 'varchar', '', $char_d, '', '',
4088         'statustext', 'varchar', 'NULL', $char_d, '', '',
4089       ],
4090       'primary_key' => 'upgradenum',
4091       'unique' => [ [ 'upgradenum' ] ],
4092       'index' => [ [ 'upgrade' ] ],
4093     },
4094
4095     'upload_target' => {
4096       'columns' => [
4097         'targetnum', 'serial', '', '', '', '',
4098         'agentnum', 'int', 'NULL', '', '', '',
4099         'protocol', 'varchar', '', 10, '', '',
4100         'hostname', 'varchar', '', $char_d, '', '',
4101         'port', 'int', 'NULL', '', '', '',
4102         'username', 'varchar', '', $char_d, '', '',
4103         'password', 'varchar', 'NULL', $char_d, '', '',
4104         'path', 'varchar', 'NULL', $char_d, '', '',
4105         'subject', 'varchar', 'NULL', '255', '', '',
4106         'handling', 'varchar', 'NULL', $char_d, '', '',
4107       ],
4108       'primary_key' => 'targetnum',
4109       'unique' => [ [ 'targetnum' ] ],
4110       'index' => [],
4111     },
4112
4113     'log' => {
4114       'columns' => [
4115         'lognum',     'serial', '', '', '', '',
4116         '_date',      'int', '', '', '', '',
4117         'agentnum',   'int', 'NULL', '', '', '',
4118         'tablename',  'varchar', 'NULL', $char_d, '', '',
4119         'tablenum',   'int',  'NULL', '', '', '',
4120         'level',      'int',  '', '', '', '',
4121         'message',    'text', '', '', '', '',
4122       ],
4123       'primary_key' => 'lognum',
4124       'unique'      => [],
4125       'index'       => [ ['_date'], ['level'] ],
4126     },
4127
4128     'log_context' => {
4129       'columns' => [
4130         'logcontextnum', 'serial', '', '', '', '',
4131         'lognum', 'int', '', '', '', '',
4132         'context', 'varchar', '', 32, '', '',
4133       ],
4134       'primary_key' => 'logcontextnum',
4135       'unique' => [ [ 'lognum', 'context' ] ],
4136       'index' => [],
4137     },
4138
4139     'svc_cable' => {
4140       'columns' => [
4141         'svcnum',         'int',     '',      '', '', '',
4142         #nothing so far...  there should be _something_ uniquely identifying
4143         # each subscriber besides the device info...?
4144       ],
4145       'primary_key' => 'svcnum',
4146       'unique' => [],
4147       'index'  => [],
4148     },
4149
4150     'cable_device' => {
4151       'columns' => [
4152         'devicenum', 'serial',     '',      '', '', '',
4153         'devicepart',   'int',     '',      '', '', '',
4154         'svcnum',       'int',     '',      '', '', '',
4155         'mac_addr', 'varchar', 'NULL',      12, '', '',
4156         'serial',   'varchar', 'NULL', $char_d, '', '',
4157       ],
4158       'primary_key' => 'devicenum',
4159       'unique' => [ [ 'mac_addr' ], ],
4160       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
4161     },
4162
4163     %{ tables_hashref_torrus() },
4164
4165     # tables of ours for doing torrus virtual port combining
4166     'torrus_srvderive' => {
4167       'columns' => [
4168         'derivenum',     'serial',     '', '', '', '',
4169         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
4170         'last_srv_date',   'date', 'NULL', '', '', '',
4171       ],
4172       'primary_key' => 'derivenum',
4173       'unique' => [ ['serviceid'] ],
4174       'index'  => [],
4175     },
4176
4177     'torrus_srvderive_component' => {
4178       'columns' => [
4179         'componentnum', 'serial', '', '', '', '',
4180         'derivenum',       'int', '', '', '', '',
4181         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
4182       ],
4183       'primary_key' => 'componentnum',
4184       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
4185       'index'       => [ [ 'derivenum', ], ],
4186     },
4187
4188
4189     # name type nullability length default local
4190
4191     #'new_table' => {
4192     #  'columns' => [
4193     #    'num', 'serial',       '', '', '', '',
4194     #  ],
4195     #  'primary_key' => 'num',
4196     #  'unique' => [],
4197     #  'index'  => [],
4198     #},
4199
4200   };
4201
4202 }
4203
4204 =back
4205
4206 =head1 BUGS
4207
4208 =head1 SEE ALSO
4209
4210 L<DBIx::DBSchema>
4211
4212 =cut
4213
4214 1;
4215