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