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