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