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