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