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 #can't use this yet, dependency bs #use FS::Conf;
  11
  12 @ISA = qw(Exporter);
  13 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  14
  15 $DEBUG = 0;
  16 $me = '[FS::Schema]';
  17
  18 =head1 NAME
  19
  20 FS::Schema - Freeside database schema
  21
  22 =head1 SYNOPSYS
  23
  24     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  25
  26     $dbdef = reload_dbdef;
  27     $dbdef = reload_dbdef "/non/standard/filename";
  28     $dbdef = dbdef;
  29     $dbdef_dist = dbdef_dist;
  30
  31 =head1 DESCRIPTION
  32
  33 This class represents the database schema.
  34
  35 =head1 METHODS
  36
  37 =over 4
  38
  39 =item reload_dbdef([FILENAME])
  40
  41 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  42 non-default filename.  This command is executed at startup unless
  43 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  44
  45 =cut
  46
  47 sub reload_dbdef {
  48   my $file = shift;
  49
  50   unless ( exists $dbdef_cache{$file} ) {
  51     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  52     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  53       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  54   } else {
  55     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  56   }
  57   $dbdef = $dbdef_cache{$file};
  58 }
  59
  60 =item dbdef
  61
  62 Returns the current database definition (represents the current database,
  63 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  64
  65 =cut
  66
  67 sub dbdef { $dbdef; }
  68
  69 =item dbdef_dist [ DATASRC ]
  70
  71 Returns the current canoical database definition as defined in this file.
  72
  73 Optionally, pass a DBI data source to enable syntax specific to that database.
  74 Currently, this enables "ENGINE=InnoDB" for MySQL databases.
  75
  76 =cut
  77
  78 sub dbdef_dist {
  79   my $datasrc = @_ && !ref($_[0]) ? shift : '';
  80   my $opt = @_ ? shift : {};
  81
  82   my $local_options = '';
  83   if ( $datasrc =~ /^dbi:mysql/i ) {
  84     $local_options = 'ENGINE=InnoDB';
  85   }
  86
  87   ###
  88   # create a dbdef object from the old data structure
  89   ###
  90
  91   my $tables_hashref = tables_hashref();
  92
  93   #turn it into objects
  94   my $dbdef = new DBIx::DBSchema map {
  95
  96     my $tablename = $_;
  97     my $indexnum = 1;
  98
  99     my @columns;
 100     while (@{$tables_hashref->{$tablename}{'columns'}}) {
 101       #my($name, $type, $null, $length, $default, $local) =
 102       my @coldef =
 103         splice @{$tables_hashref->{$tablename}{'columns'}}, 0, 6;
 104       my %hash = map { $_ => shift @coldef }
 105                      qw( name type null length default local );
 106
 107       #can be removed once we depend on DBIx::DBSchema 0.39;
 108       $hash{'type'} = 'LONGTEXT'
 109         if $hash{'type'} =~ /^TEXT$/i && $datasrc =~ /^dbi:mysql/i;
 110
 111       unless ( defined $hash{'default'} ) {
 112         warn "$tablename:\n".
 113              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 114       }
 115
 116       push @columns, new DBIx::DBSchema::Column ( \%hash );
 117     }
 118
 119     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 120     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 121     my $unique = $tables_hashref->{$tablename}{'unique'};
 122     warn "missing index for $tablename\n" unless defined $tables_hashref->{$tablename}{'index'};
 123     my @index  = @{ $tables_hashref->{$tablename}{'index'} };
 124
 125     # kludge to avoid avoid "BLOB/TEXT column 'statustext' used in key
 126     #  specification without a key length".
 127     # better solution: teach DBIx::DBSchema to specify a default length for
 128     #  MySQL indices on text columns, or just to support an index length at all
 129     #  so we can pass something in.
 130     # best solution: eliminate need for this index in cust_main::retry_realtime
 131     @index = grep { @{$_}[0] ne 'statustext' } @index
 132       if $datasrc =~ /^dbi:mysql/i;
 133
 134     my @indices = ();
 135     push @indices, map {
 136                          DBIx::DBSchema::Index->new({
 137                            'name'    => $tablename. $indexnum++,
 138                            'unique'  => 1,
 139                            'columns' => $_,
 140                          });
 141                        }
 142                        @$unique;
 143     push @indices, map {
 144                          DBIx::DBSchema::Index->new({
 145                            'name'    => $tablename. $indexnum++,
 146                            'unique'  => 0,
 147                            'columns' => $_,
 148                          });
 149                        }
 150                        @index;
 151
 152     DBIx::DBSchema::Table->new({
 153       'name'          => $tablename,
 154       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 155       'columns'       => \@columns,
 156       'indices'       => \@indices,
 157       'local_options' => $local_options,
 158     });
 159
 160   } keys %$tables_hashref;
 161
 162   if ( $DEBUG ) {
 163     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 164     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 165   }
 166
 167   #add radius attributes to svc_acct
 168   #
 169   #my($svc_acct)=$dbdef->table('svc_acct');
 170   #
 171   #my($attribute);
 172   #foreach $attribute (@attributes) {
 173   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 174   #    'radius_'. $attribute,
 175   #    'varchar',
 176   #    'NULL',
 177   #    $char_d,
 178   #  ));
 179   #}
 180   #
 181   #foreach $attribute (@check_attributes) {
 182   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 183   #    'rc_'. $attribute,
 184   #    'varchar',
 185   #    'NULL',
 186   #    $char_d,
 187   #  ));
 188   #}
 189
 190   my $tables_hashref_torrus = tables_hashref_torrus();
 191
 192   #create history tables
 193   foreach my $table (
 194     grep {    ! /^(clientapi|access_user)_session/
 195            && ! /^h_/
 196            && ! /^log(_context)?$/
 197            && ! /^legacy_cust_history$/
 198            && ( ! /^queue(_arg|_depend|_stat)?$/ || ! $opt->{'queue-no_history'} )
 199            && ! $tables_hashref_torrus->{$_}
 200            && ! /^cacti_page$/
 201          }
 202       $dbdef->tables
 203   ) {
 204     my $tableobj = $dbdef->table($table)
 205       or die "unknown table $table";
 206
 207     my %h_indices = ();
 208
 209     unless ( $table eq 'cust_event' || $table eq 'cdr' ) { #others?
 210
 211       my %indices = $tableobj->indices;
 212
 213       %h_indices = map {
 214                          ( "h_$_" =>
 215                              DBIx::DBSchema::Index->new({
 216                                'name'    => 'h_'. $indices{$_}->name,
 217                                'unique'  => 0,
 218                                'columns' => [ @{$indices{$_}->columns} ],
 219                              })
 220                          );
 221                        }
 222                        keys %indices;
 223
 224       $h_indices{"h_${table}_srckey"} =
 225         DBIx::DBSchema::Index->new({
 226           'name'    => "h_${table}_srckey",
 227           'unique'  => 0,
 228           'columns' => [ 'history_action', #right?
 229                          $tableobj->primary_key,
 230                        ],
 231         });
 232
 233       $h_indices{"h_${table}_srckey2"} =
 234          DBIx::DBSchema::Index->new({
 235            'name'    => "h_${table}_srckey2",
 236            'unique'  => 0,
 237            'columns' => [ 'history_date',
 238                           $tableobj->primary_key,
 239                         ],
 240          });
 241
 242     }
 243
 244     my $historynum_type = ( $tableobj->column($tableobj->primary_key)->type
 245                               =~ /^(bigserial|bigint|int8)$/i
 246                                 ? 'bigserial'
 247                                 : 'serial'
 248                           );
 249
 250     my $h_tableobj = DBIx::DBSchema::Table->new( {
 251       'name'          => "h_$table",
 252       'primary_key'   => 'historynum',
 253       'indices'       => \%h_indices,
 254       'local_options' => $local_options,
 255       'columns'       => [
 256           DBIx::DBSchema::Column->new( {
 257             'name'    => 'historynum',
 258             'type'    => $historynum_type,
 259             'null'    => 'NOT NULL',
 260             'length'  => '',
 261             'default' => '',
 262             'local'   => '',
 263           } ),
 264           DBIx::DBSchema::Column->new( {
 265             'name'    => 'history_date',
 266             'type'    => 'int',
 267             'null'    => 'NULL',
 268             'length'  => '',
 269             'default' => '',
 270             'local'   => '',
 271           } ),
 272           DBIx::DBSchema::Column->new( {
 273             'name'    => 'history_user',
 274             'type'    => 'varchar',
 275             'null'    => 'NOT NULL',
 276             'length'  => '80',
 277             'default' => '',
 278             'local'   => '',
 279           } ),
 280           DBIx::DBSchema::Column->new( {
 281             'name'    => 'history_action',
 282             'type'    => 'varchar',
 283             'null'    => 'NOT NULL',
 284             'length'  => '80',
 285             'default' => '',
 286             'local'   => '',
 287           } ),
 288           map {
 289             my $column = $tableobj->column($_);
 290
 291             #clone so as to not disturb the original
 292             $column = DBIx::DBSchema::Column->new( {
 293               map { $_ => $column->$_() }
 294                 qw( name type null length default local )
 295             } );
 296
 297             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 298               $column->type(uc($1).'INT');
 299               $column->null('NULL');
 300             }
 301             #$column->default('')
 302             #  if $column->default =~ /^nextval\(/i;
 303             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 304             #$column->local($local);
 305             $column;
 306           } $tableobj->columns
 307       ],
 308     } );
 309     $dbdef->addtable($h_tableobj);
 310   }
 311
 312   if ( $datasrc =~ /^dbi:mysql/i ) {
 313
 314     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 315       'name'          => 'duplicate_lock',
 316       'primary_key'   => 'duplocknum',
 317       'local_options' => $local_options,
 318       'columns'       => [
 319         DBIx::DBSchema::Column->new( {
 320           'name'    => 'duplocknum',
 321           'type'    => 'serial',
 322           'null'    => 'NOT NULL',
 323           'length'  => '',
 324           'default' => '',
 325           'local'   => '',
 326         } ),
 327         DBIx::DBSchema::Column->new( {
 328           'name'    => 'lockname',
 329           'type'    => 'varchar',
 330           'null'    => 'NOT NULL',
 331           'length'  => '80',
 332           'default' => '',
 333           'local'   => '',
 334         } ),
 335       ],
 336       'indices' => { 'duplicate_lock1' =>
 337                        DBIx::DBSchema::Index->new({
 338                          'name'    => 'duplicate_lock1',
 339                          'unique'  => 1,
 340                          'columns' => [ 'lockname' ],
 341                        })
 342                    },
 343     } );
 344
 345     $dbdef->addtable($dup_lock_table);
 346
 347   }
 348
 349   $dbdef;
 350
 351 }
 352
 353 #torrus tables http://torrus.org/reporting_setup.pod.html#create_sql_tables
 354 sub tables_hashref_torrus {
 355
 356   return {
 357
 358     # Collector export table. It usually grows at several megabytes
 359     # per month, and is updated every 5 minutes
 360     'srvexport' => {
 361       'columns' => [
 362         'id',         'serial', '', '', '', '',
 363         'srv_date',     'date', '', '', '', '',#date and time of the data sample
 364         'srv_time',     'time', '', '', '', '',
 365         'serviceid', 'varchar', '', 64, '', '',#unique service ID per counter
 366         'value',     'double precision', '', '', '', '',#collected rate or gauge value
 367         'intvl', 'int', '', '', '', '', # collection interval - for counter volume calculation
 368       ],
 369       'primary_key' => 'id',
 370       'unique' => [],
 371       'index'  => [ ['srv_date'], ['srv_date', 'srv_time'], ['serviceid'], ],
 372     },
 373
 374     #Tables for (currently monthly only) report contents.
 375     #These are updated usually once per month, and read at the moment of
 376     #rendering the report output (HTML now, PDF or XML or Excel or whatever
 377     #in the future)
 378
 379     #DBIx::Sequence backend, theplatform-independent inplementation
 380     #of sequences
 381     'dbix_sequence_state' => {
 382       'columns' => [
 383         'id',       'serial', '', '', '', '',
 384         'dataset', 'varchar', '', 50, '', '',
 385         'state_id',    'int', '', '', '', '',
 386       ],
 387       'primary_key' => 'id',
 388       #CONSTRAINT pk_dbix_sequence PRIMARY KEY (dataset, state_id)
 389       'unique' => [ [ 'dataset', 'state_id' ], ],
 390       'index'  => [],
 391     },
 392
 393     'dbix_sequence_release' => {
 394       'columns' => [
 395         'id',       'serial', '', '', '', '',
 396         'dataset', 'varchar', '', 50, '', '',
 397         'released_id', 'int', '', '', '', '',
 398       ],
 399       'primary_key' => 'id',
 400       #CONSTRAINT pk_dbi_release PRIMARY KEY (dataset, released_id)
 401       'unique' => [ [ 'dataset', 'released_id', ] ],
 402       'index'  => [],
 403     },
 404
 405     #Each report is characterized by name, date and time.
 406     #Monthly reports are automatically assigned 00:00 of the 1st day
 407     #in the month. The report contains fields for every service ID
 408     #defined across all datasource trees.
 409     'reports' => {
 410       'columns' => [
 411         'id',          'serial', '', '', '', '',
 412         'rep_date',      'date', '', '', '', '',#Start date of the report
 413         'rep_time',      'time', '', '', '', '',#Start time of the report
 414         'reportname', 'varchar', '', 64, '', '',#Report name, such as
 415                                                 # MonthlyUsage
 416         'iscomplete',     'int', '', '', '', '',#0 when the report is in
 417                                                 # progress, 1 when it is ready
 418       ],
 419       'primary_key' => 'id',
 420       'unique' => [ [ qw(rep_date rep_time reportname) ] ],
 421       'index'  => [ [ 'rep_date' ] ],
 422     },
 423
 424     #Each report contains fields. For each service ID,
 425     #the report may contain several fields for various statistics.
 426     #Each field contains information about the units of the value it
 427     #contains
 428     'reportfields' => {
 429       'columns' => [
 430         'id',              'serial',     '', '',    '', '',
 431         'rep_id',             'int', 'NULL', '',    '', '',
 432         'name',           'varchar',     '', 64,    '', '',#name of the field,
 433                                                            # such as AVG or MAX
 434         'serviceid',      'varchar',     '', 64,    '', '',#service ID
 435         'value', 'double precision',     '', '',    '', '',#Numeric value
 436         'units',          'varchar',     '', 64, \"''", '',#Units, such as bytes
 437                                                            # or Mbps
 438       ],
 439       'primary_key', => 'id',
 440       'unique' => [ [ qw(rep_id name serviceid) ] ],
 441       'index'  => [],
 442     },
 443
 444   };
 445
 446 }
 447
 448 sub tables_hashref {
 449
 450   my $char_d = 80; #default maxlength for text fields
 451
 452   #my(@date_type)  = ( 'timestamp', '', ''     );
 453   my @date_type = ( 'int', 'NULL', ''     );
 454   my @perl_type = ( 'text', 'NULL', ''  );
 455   my @money_type = ( 'decimal',   '', '10,2' );
 456   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 457   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 458   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 459
 460   my $username_len = 64; #usernamemax config file
 461
 462     # name type nullability length default local
 463
 464   return {
 465
 466     'agent' => {
 467       'columns' => [
 468         'agentnum',          'serial',    '',       '', '', '',
 469         'agent',            'varchar',    '',  $char_d, '', '',
 470         'typenum',              'int',    '',       '', '', '',
 471         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 472         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 473         'agent_custnum',        'int', 'NULL',      '', '', '',
 474         'disabled',            'char', 'NULL',       1, '', '',
 475         'username',         'varchar', 'NULL', $char_d, '', '',
 476         '_password',        'varchar', 'NULL', $char_d, '', '',
 477         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 478         'prog',                     @perl_type, '', '', #deprecated (never used)
 479       ],
 480       'primary_key' => 'agentnum',
 481       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 482                                             #insert is giving it a value, tho..
 483       #'index' => [ ['typenum'], ['disabled'] ],
 484       'unique' => [],
 485       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 486     },
 487
 488     'agent_pkg_class' => {
 489       'columns' => [
 490         'agentpkgclassnum',    'serial',     '',    '', '', '',
 491         'agentnum',               'int',     '',    '', '', '',
 492         'classnum',               'int', 'NULL',    '', '', '',
 493         'commission_percent', 'decimal',     '', '7,4', '', '',
 494       ],
 495       'primary_key' => 'agentpkgclassnum',
 496       'unique'      => [ [ 'agentnum', 'classnum' ], ],
 497       'index'       => [],
 498     },
 499
 500     'agent_type' => {
 501       'columns' => [
 502         'typenum',  'serial',      '',      '', '', '',
 503         'atype',    'varchar',     '', $char_d, '', '',
 504         'disabled',    'char', 'NULL',       1, '', '',
 505       ],
 506       'primary_key' => 'typenum',
 507       'unique' => [],
 508       'index' => [ ['disabled'] ],
 509     },
 510
 511     'type_pkgs' => {
 512       'columns' => [
 513         'typepkgnum', 'serial', '', '', '', '',
 514         'typenum',   'int',  '', '', '', '',
 515         'pkgpart',   'int',  '', '', '', '',
 516       ],
 517       'primary_key' => 'typepkgnum',
 518       'unique' => [ ['typenum', 'pkgpart'] ],
 519       'index' => [ ['typenum'] ],
 520     },
 521
 522     'sales' => {
 523       'columns' => [
 524         'salesnum',          'serial',    '',       '', '', '',
 525         'salesperson',      'varchar',    '',  $char_d, '', '',
 526         'agentnum',             'int', 'NULL',      '', '', '',
 527         'sales_custnum',        'int', 'NULL',      '', '', '',
 528         'disabled',            'char', 'NULL',       1, '', '',
 529       ],
 530       'primary_key' => 'salesnum',
 531       'unique' => [],
 532       'index' => [ ['salesnum'], ['disabled'] ],
 533     },
 534
 535     'sales_pkg_class' => {
 536       'columns' => [
 537         'salespkgclassnum',    'serial',     '',    '', '', '',
 538         'salesnum',               'int',     '',    '', '', '',
 539         'classnum',               'int', 'NULL',    '', '', '',
 540         'commission_percent', 'decimal',     '', '7,4', '', '',
 541         'commission_duration',    'int', 'NULL',    '', '', '',
 542       ],
 543       'primary_key' => 'salespkgclassnum',
 544       'unique'      => [ [ 'salesnum', 'classnum' ], ],
 545       'index'       => [],
 546     },
 547
 548     'cust_attachment' => {
 549       'columns' => [
 550         'attachnum', 'serial', '', '', '', '',
 551         'custnum',   'int', '', '', '', '',
 552         '_date',     @date_type, '', '',
 553         'otaker',    'varchar', 'NULL', 32, '', '',
 554         'usernum',   'int', 'NULL', '', '', '',
 555         'filename',  'varchar', '', 255, '', '',
 556         'mime_type', 'varchar', '', $char_d, '', '',
 557         'title',     'varchar', 'NULL', $char_d, '', '',
 558         'body',      'blob', 'NULL', '', '', '',
 559         'disabled',  @date_type, '', '',
 560       ],
 561       'primary_key' => 'attachnum',
 562       'unique'      => [],
 563       'index'       => [ ['custnum'], ['usernum'], ],
 564     },
 565
 566     'cust_bill' => {
 567       'columns' => [
 568         #regular fields
 569         'invnum',    'serial',     '', '', '', '',
 570         'custnum',      'int',     '', '', '', '',
 571         '_date',        @date_type,        '', '',
 572         'charged',      @money_type,       '', '',
 573         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 574
 575         #customer balance info at invoice generation time
 576         #(deprecated)
 577         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 578         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 579
 580         #deprecated (unused by now, right?)
 581         'printed',      'int',     '', '', '', '',
 582
 583         #specific use cases
 584         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 585         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 586         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 587         'promised_date', @date_type,       '', '',
 588       ],
 589       'primary_key' => 'invnum',
 590       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 591       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'] ],
 592     },
 593
 594     'cust_bill_void' => {
 595       'columns' => [
 596         #regular fields
 597         'invnum',       'int',     '', '', '', '',
 598         'custnum',      'int',     '', '', '', '',
 599         '_date',        @date_type,        '', '',
 600         'charged',      @money_type,       '', '',
 601         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 602
 603         #customer balance info at invoice generation time
 604         'previous_balance',   @money_typen, '', '',  #eventually not nullable
 605         'billing_balance',    @money_typen, '', '',  #eventually not nullable
 606
 607         #specific use cases
 608         'closed',      'char', 'NULL',  1, '', '', #not yet used much
 609         'statementnum', 'int', 'NULL', '', '', '', #invoice aggregate statements
 610         'agent_invid',  'int', 'NULL', '', '', '', #(varchar?) importing legacy
 611         'promised_date', @date_type,       '', '',
 612
 613         #void fields
 614         'void_date', @date_type, '', '',
 615         'reason',    'varchar',   'NULL', $char_d, '', '',
 616         'void_usernum',   'int', 'NULL', '', '', '',
 617       ],
 618       'primary_key' => 'invnum',
 619       'unique' => [ [ 'custnum', 'agent_invid' ] ], #agentnum?  huh
 620       'index' => [ ['custnum'], ['_date'], ['statementnum'], ['agent_invid'], [ 'void_usernum' ] ],
 621     },
 622
 623     #for importing invoices from a legacy system for display purposes only
 624     # no effect upon balance
 625     'legacy_cust_bill' => {
 626       'columns' => [
 627         'legacyinvnum',  'serial',     '',      '', '', '',
 628         'legacyid',     'varchar', 'NULL', $char_d, '', '',
 629         'custnum',          'int',     '',      '', '', '',
 630         '_date',       @date_type,                  '', '',
 631         'charged',    @money_type,                  '', '',
 632         'content_pdf',     'blob', 'NULL',      '', '', '',
 633         'content_html',    'text', 'NULL',      '', '', '',
 634         'locale',       'varchar', 'NULL',      16, '', '',
 635       ],
 636       'primary_key' => 'legacyinvnum',
 637       'unique' => [],
 638       'index'  => [ ['legacyid', 'custnum', 'locale' ], ],
 639     },
 640
 641     'legacy_cust_history' => {
 642       'columns' => [
 643         'legacyhistorynum', 'serial',     '',        '', '', '',
 644         'custnum',             'int',     '',        '', '', '',
 645         'history_action',  'varchar',     '',   $char_d, '', '',
 646         'history_date',           @date_type,            '', '',
 647         'history_usernum',     'int', 'NULL',        '', '', '',
 648         'item',            'varchar', 'NULL',   $char_d, '', '',
 649         'description',     'varchar', 'NULL', 2*$char_d, '', '',
 650         'change_data',        'text', 'NULL',        '', '', '',
 651       ],
 652       'primary_key'  => 'legacyhistorynum',
 653       'unique'       => [],
 654       'index'        => [ ['custnum'], ['history_date'], ],
 655     },
 656
 657     'cust_statement' => {
 658       'columns' => [
 659         'statementnum', 'serial', '', '', '', '',
 660         'custnum',         'int', '', '', '', '',
 661         '_date',           @date_type,    '', '',
 662       ],
 663       'primary_key' => 'statementnum',
 664       'unique' => [],
 665       'index' => [ ['custnum'], ['_date'], ],
 666     },
 667
 668     'cust_bill_event' => {
 669       'columns' => [
 670         'eventnum',    'serial',  '', '', '', '',
 671         'invnum',   'int',  '', '', '', '',
 672         'eventpart',   'int',  '', '', '', '',
 673         '_date',     @date_type, '', '',
 674         'status', 'varchar', '', $char_d, '', '',
 675         'statustext', 'text', 'NULL', '', '', '',
 676       ],
 677       'primary_key' => 'eventnum',
 678       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 679       'unique' => [],
 680       'index' => [ ['invnum'], ['status'], ['eventpart'],
 681                    ['statustext'], ['_date'],
 682                  ],
 683     },
 684
 685     'part_bill_event' => {
 686       'columns' => [
 687         'eventpart',    'serial',  '', '', '', '',
 688         'freq',        'varchar',       'NULL',     $char_d, '', '',
 689         'payby',       'char',  '', 4, '', '',
 690         'event',       'varchar',           '',     $char_d, '', '',
 691         'eventcode',    @perl_type, '', '',
 692         'seconds',     'int', 'NULL', '', '', '',
 693         'weight',      'int', '', '', '', '',
 694         'plan',       'varchar', 'NULL', $char_d, '', '',
 695         'plandata',   'text', 'NULL', '', '', '',
 696         'reason',     'int', 'NULL', '', '', '',
 697         'disabled',     'char', 'NULL', 1, '', '',
 698       ],
 699       'primary_key' => 'eventpart',
 700       'unique' => [],
 701       'index' => [ ['payby'], ['disabled'], ],
 702     },
 703
 704     'part_event' => {
 705       'columns' => [
 706         'eventpart',   'serial',      '',      '', '', '',
 707         'agentnum',    'int',     'NULL',      '', '', '',
 708         'event',       'varchar',     '', $char_d, '', '',
 709         'eventtable',  'varchar',     '', $char_d, '', '',
 710         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 711         'weight',      'int',         '',      '', '', '',
 712         'action',      'varchar',     '', $char_d, '', '',
 713         'disabled',     'char',   'NULL',       1, '', '',
 714       ],
 715       'primary_key' => 'eventpart',
 716       'unique' => [],
 717       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 718     },
 719
 720     'part_event_option' => {
 721       'columns' => [
 722         'optionnum', 'serial', '', '', '', '',
 723         'eventpart', 'int', '', '', '', '',
 724         'optionname', 'varchar', '', $char_d, '', '',
 725         'optionvalue', 'text', 'NULL', '', '', '',
 726       ],
 727       'primary_key' => 'optionnum',
 728       'unique'      => [],
 729       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 730     },
 731
 732     'part_event_condition' => {
 733       'columns' => [
 734         'eventconditionnum', 'serial', '', '', '', '',
 735         'eventpart', 'int', '', '', '', '',
 736         'conditionname', 'varchar', '', $char_d, '', '',
 737       ],
 738       'primary_key' => 'eventconditionnum',
 739       'unique'      => [],
 740       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 741     },
 742
 743     'part_event_condition_option' => {
 744       'columns' => [
 745         'optionnum', 'serial', '', '', '', '',
 746         'eventconditionnum', 'int', '', '', '', '',
 747         'optionname', 'varchar', '', $char_d, '', '',
 748         'optionvalue', 'text', 'NULL', '', '', '',
 749       ],
 750       'primary_key' => 'optionnum',
 751       'unique'      => [],
 752       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 753     },
 754
 755     'part_event_condition_option_option' => {
 756       'columns' => [
 757         'optionoptionnum', 'serial', '', '', '', '',
 758         'optionnum', 'int', '', '', '', '',
 759         'optionname', 'varchar', '', $char_d, '', '',
 760         'optionvalue', 'text', 'NULL', '', '', '',
 761       ],
 762       'primary_key' => 'optionoptionnum',
 763       'unique'      => [],
 764       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 765     },
 766
 767     'cust_event' => {
 768       'columns' => [
 769         'eventnum',    'serial',  '', '', '', '',
 770         'eventpart',   'int',  '', '', '', '',
 771         'tablenum',   'int',  '', '', '', '',
 772         '_date',     @date_type, '', '',
 773         'status', 'varchar', '', $char_d, '', '',
 774         'statustext', 'text', 'NULL', '', '', '',
 775       ],
 776       'primary_key' => 'eventnum',
 777       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 778       'unique' => [],
 779       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 780                    ['statustext'], ['_date'],
 781                  ],
 782     },
 783
 784     'cust_event_fee' => {
 785       'columns' => [
 786         'eventfeenum', 'serial', '', '', '', '',
 787         'eventnum',       'int', '', '', '', '',
 788         'billpkgnum',     'int', 'NULL', '', '', '',
 789         'feepart',        'int', '', '', '', '',
 790         'nextbill',      'char', 'NULL',  1, '', '',
 791       ],
 792       'primary_key'  => 'eventfeenum', # I'd rather just use eventnum
 793       'unique' => [ [ 'billpkgnum' ], [ 'eventnum' ] ], # one-to-one link
 794       'index'  => [ [ 'feepart' ] ],
 795     },
 796
 797     'cust_bill_pkg' => {
 798       'columns' => [
 799         'billpkgnum',        'serial',     '',      '', '', '',
 800         'invnum',               'int',     '',      '', '', '',
 801         'pkgnum',               'int',     '',      '', '', '',
 802         'pkgpart_override',     'int', 'NULL',      '', '', '',
 803         'setup',               @money_type,             '', '',
 804         'recur',               @money_type,             '', '',
 805         'sdate',               @date_type,              '', '',
 806         'edate',               @date_type,              '', '',
 807         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 808         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 809         'section',          'varchar', 'NULL', $char_d, '', '',
 810         'freq',             'varchar', 'NULL', $char_d, '', '',
 811         'quantity',             'int', 'NULL',      '', '', '',
 812         'unitsetup',           @money_typen,            '', '',
 813         'unitrecur',           @money_typen,            '', '',
 814         'hidden',              'char', 'NULL',       1, '', '',
 815         'feepart',              'int', 'NULL',      '', '', '',
 816       ],
 817       'primary_key' => 'billpkgnum',
 818       'unique' => [],
 819       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 820     },
 821
 822     'cust_bill_pkg_detail' => {
 823       'columns' => [
 824         'detailnum', 'serial', '', '', '', '',
 825         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 826         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 827         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 828         'amount',  'decimal', 'NULL', '10,4', '', '',
 829         'format',  'char', 'NULL', 1, '', '',
 830         'classnum', 'int', 'NULL', '', '', '',
 831         'duration', 'int', 'NULL', '',  0, '',
 832         'phonenum', 'varchar', 'NULL', 25, '', '',
 833         'accountcode', 'varchar',  'NULL',      32, '', '',
 834         'startdate',  @date_type, '', '',
 835         'regionname', 'varchar', 'NULL', $char_d, '', '',
 836         'detail',  'varchar', '', 255, '', '',
 837       ],
 838       'primary_key' => 'detailnum',
 839       'unique' => [],
 840       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 841     },
 842
 843     'cust_bill_pkg_display' => {
 844       'columns' => [
 845         'billpkgdisplaynum', 'serial', '', '', '', '',
 846         'billpkgnum', 'int', '', '', '', '',
 847         'section',  'varchar', 'NULL', $char_d, '', '',
 848         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 849         #'unitrecur', @money_typen, '', '',     #this too?
 850         'post_total', 'char', 'NULL', 1, '', '',
 851         'type',       'char', 'NULL', 1, '', '',
 852         'summary',    'char', 'NULL', 1, '', '',
 853       ],
 854       'primary_key' => 'billpkgdisplaynum',
 855       'unique' => [],
 856       'index' => [ ['billpkgnum'], ],
 857     },
 858
 859     'cust_bill_pkg_fee' => {
 860       'columns' => [
 861         'billpkgfeenum',    'serial', '', '', '', '',
 862         'billpkgnum',          'int', '', '', '', '',
 863         'base_invnum',       'int', '', '', '', '',
 864         'base_billpkgnum',   'int', 'NULL', '', '', '',
 865         'amount',        @money_type,         '', '',
 866       ],
 867       'primary_key' => 'billpkgfeenum',
 868       'unique'      => [],
 869       'index'       => [ ['billpkgnum'],
 870                          ['base_invnum'],
 871                          ['base_billpkgnum'],
 872                        ],
 873     },
 874
 875     'cust_bill_pkg_fee_void' => {
 876       'columns' => [
 877         'billpkgfeenum',    'serial', '', '', '', '',
 878         'billpkgnum',          'int', '', '', '', '',
 879         'base_invnum',       'int', '', '', '', '',
 880         'base_billpkgnum',   'int', 'NULL', '', '', '',
 881         'amount',        @money_type,         '', '',
 882       ],
 883       'primary_key' => 'billpkgfeenum',
 884       'unique'      => [],
 885       'index'       => [ ['billpkgnum'],
 886                          ['base_invnum'],
 887                          ['base_billpkgnum'],
 888                        ],
 889     },
 890
 891
 892     'cust_bill_pkg_tax_location' => {
 893       'columns' => [
 894         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 895         'billpkgnum',               'int',      '', '', '', '',
 896         'taxnum',                   'int',      '', '', '', '',
 897         'taxtype',              'varchar',      '', $char_d, '', '',
 898         'pkgnum',                   'int',      '', '', '', '', #redundant
 899         'locationnum',              'int',      '', '', '', '', #redundant
 900         'amount',                   @money_type,        '', '',
 901         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
 902       ],
 903       'primary_key' => 'billpkgtaxlocationnum',
 904       'unique' => [],
 905       'index'  => [ [ 'billpkgnum' ],
 906                     [ 'taxnum' ],
 907                     [ 'pkgnum' ],
 908                     [ 'locationnum' ],
 909                     [ 'taxable_billpkgnum' ],
 910                   ],
 911     },
 912
 913     'cust_bill_pkg_tax_rate_location' => {
 914       'columns' => [
 915         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 916         'billpkgnum',                   'int',      '', '', '', '',
 917         'taxnum',                       'int',      '', '', '', '',
 918         'taxtype',                  'varchar',      '', $char_d, '', '',
 919         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 920         'taxratelocationnum',           'int',      '', '', '', '',
 921         'amount',                       @money_type,        '', '',
 922         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
 923         'taxclass',             'varchar',  'NULL', 10, '', '',
 924       ],
 925       'primary_key' => 'billpkgtaxratelocationnum',
 926       'unique' => [],
 927       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ],
 928                     [ 'taxable_billpkgnum' ], ],
 929     },
 930
 931     'cust_bill_pkg_void' => {
 932       'columns' => [
 933         'billpkgnum',           'int',     '',      '', '', '',
 934         'invnum',               'int',     '',      '', '', '',
 935         'pkgnum',               'int',     '',      '', '', '',
 936         'pkgpart_override',     'int', 'NULL',      '', '', '',
 937         'setup',               @money_type,             '', '',
 938         'recur',               @money_type,             '', '',
 939         'sdate',               @date_type,              '', '',
 940         'edate',               @date_type,              '', '',
 941         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 942         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 943         'section',          'varchar', 'NULL', $char_d, '', '',
 944         'freq',             'varchar', 'NULL', $char_d, '', '',
 945         'quantity',             'int', 'NULL',      '', '', '',
 946         'unitsetup',           @money_typen,            '', '',
 947         'unitrecur',           @money_typen,            '', '',
 948         'hidden',              'char', 'NULL',       1, '', '',
 949         'feepart',              'int', 'NULL',      '', '', '',
 950         #void fields
 951         'void_date', @date_type, '', '',
 952         'reason',    'varchar',   'NULL', $char_d, '', '',
 953         'void_usernum',   'int', 'NULL', '', '', '',
 954       ],
 955       'primary_key' => 'billpkgnum',
 956       'unique' => [],
 957       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], [ 'void_usernum' ], ],
 958     },
 959
 960     'cust_bill_pkg_detail_void' => {
 961       'columns' => [
 962         'detailnum',  'int', '', '', '', '',
 963         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 964         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 965         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 966         'amount',  'decimal', 'NULL', '10,4', '', '',
 967         'format',  'char', 'NULL', 1, '', '',
 968         'classnum', 'int', 'NULL', '', '', '',
 969         'duration', 'int', 'NULL', '',  0, '',
 970         'phonenum', 'varchar', 'NULL', 25, '', '',
 971         'accountcode', 'varchar',  'NULL',      32, '', '',
 972         'startdate',  @date_type, '', '',
 973         'regionname', 'varchar', 'NULL', $char_d, '', '',
 974         'detail',  'varchar', '', 255, '', '',
 975       ],
 976       'primary_key' => 'detailnum',
 977       'unique' => [],
 978       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 979     },
 980
 981     'cust_bill_pkg_display_void' => {
 982       'columns' => [
 983         'billpkgdisplaynum',    'int', '', '', '', '',
 984         'billpkgnum', 'int', '', '', '', '',
 985         'section',  'varchar', 'NULL', $char_d, '', '',
 986         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 987         #'unitrecur', @money_typen, '', '',     #this too?
 988         'post_total', 'char', 'NULL', 1, '', '',
 989         'type',       'char', 'NULL', 1, '', '',
 990         'summary',    'char', 'NULL', 1, '', '',
 991       ],
 992       'primary_key' => 'billpkgdisplaynum',
 993       'unique' => [],
 994       'index' => [ ['billpkgnum'], ],
 995     },
 996
 997     'cust_bill_pkg_tax_location_void' => {
 998       'columns' => [
 999         'billpkgtaxlocationnum',    'int',      '', '', '', '',
1000         'billpkgnum',               'int',      '', '', '', '',
1001         'taxnum',                   'int',      '', '', '', '',
1002         'taxtype',              'varchar',      '', $char_d, '', '',
1003         'pkgnum',                   'int',      '', '', '', '',
1004         'locationnum',              'int',      '', '', '', '', #redundant?
1005         'amount',                   @money_type,        '', '',
1006         'taxable_billpkgnum',       'int',  'NULL', '', '', '',
1007       ],
1008       'primary_key' => 'billpkgtaxlocationnum',
1009       'unique' => [],
1010       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
1011     },
1012
1013     'cust_bill_pkg_tax_rate_location_void' => {
1014       'columns' => [
1015         'billpkgtaxratelocationnum',    'int',      '', '', '', '',
1016         'billpkgnum',                   'int',      '', '', '', '',
1017         'taxnum',                       'int',      '', '', '', '',
1018         'taxtype',                  'varchar',      '', $char_d, '', '',
1019         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
1020         'taxratelocationnum',           'int',      '', '', '', '',
1021         'amount',                       @money_type,        '', '',
1022       ],
1023       'primary_key' => 'billpkgtaxratelocationnum',
1024       'unique' => [],
1025       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
1026     },
1027
1028     'cust_credit' => {
1029       'columns' => [
1030         'crednum',  'serial', '', '', '', '',
1031         'custnum',  'int', '', '', '', '',
1032         '_date',    @date_type, '', '',
1033         'amount',   @money_type, '', '',
1034         'otaker',   'varchar', 'NULL', 32, '', '',
1035         'usernum',   'int', 'NULL', '', '', '',
1036         'reason',   'text', 'NULL', '', '', '',
1037         'reasonnum', 'int', 'NULL', '', '', '',
1038         'addlinfo', 'text', 'NULL', '', '', '',
1039         'closed',    'char', 'NULL', 1, '', '',
1040         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1041         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
1042         'commission_agentnum', 'int', 'NULL', '', '', '', #
1043         'commission_salesnum', 'int', 'NULL', '', '', '', #
1044         'commission_pkgnum',   'int', 'NULL', '', '', '', #
1045         'credbatch',    'varchar', 'NULL', $char_d, '', '',
1046       ],
1047       'primary_key' => 'crednum',
1048       'unique' => [],
1049       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1050                    ['commission_salesnum'], ['credbatch'],
1051                  ],
1052     },
1053
1054     'cust_credit_void' => {
1055       'columns' => [
1056         'crednum',  'serial',     '', '', '', '',
1057         'custnum',     'int',     '', '', '', '',
1058         '_date',  @date_type,             '', '',
1059         'amount',@money_type,             '', '',
1060         'currency',   'char', 'NULL',  3, '', '',
1061         'otaker',  'varchar', 'NULL', 32, '', '',
1062         'usernum',     'int', 'NULL', '', '', '',
1063         'reason',     'text', 'NULL', '', '', '',
1064         'reasonnum',   'int', 'NULL', '', '', '',
1065         'addlinfo',   'text', 'NULL', '', '', '',
1066         'closed',     'char', 'NULL',  1, '', '',
1067         'pkgnum',      'int', 'NULL', '', '','',
1068         'eventnum',    'int', 'NULL', '', '','',
1069         'commission_agentnum', 'int', 'NULL', '', '', '',
1070         'commission_salesnum', 'int', 'NULL', '', '', '',
1071         'commission_pkgnum',   'int', 'NULL', '', '', '',
1072         #void fields
1073         'void_date',  @date_type,                  '', '',
1074         'void_reason', 'varchar', 'NULL', $char_d, '', '',
1075         'void_reasonnum', 'int', 'NULL', '', '', '',
1076         'void_usernum',    'int', 'NULL',      '', '', '',
1077       ],
1078       'primary_key' => 'crednum',
1079       'unique' => [],
1080       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'],
1081                    [ 'commission_salesnum' ],
1082                  ],
1083     },
1084
1085
1086     'cust_credit_bill' => {
1087       'columns' => [
1088         'creditbillnum', 'serial', '', '', '', '',
1089         'crednum',  'int', '', '', '', '',
1090         'invnum',  'int', '', '', '', '',
1091         '_date',    @date_type, '', '',
1092         'amount',   @money_type, '', '',
1093         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1094       ],
1095       'primary_key' => 'creditbillnum',
1096       'unique' => [],
1097       'index' => [ ['crednum'], ['invnum'] ],
1098     },
1099
1100     'cust_credit_bill_pkg' => {
1101       'columns' => [
1102         'creditbillpkgnum', 'serial', '',      '', '', '',
1103         'creditbillnum',       'int', '',      '', '', '',
1104         'billpkgnum',          'int', '',      '', '', '',
1105         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1106         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1107         'amount',            @money_type,          '', '',
1108         'setuprecur',      'varchar', '', $char_d, '', '',
1109         'sdate',   @date_type, '', '',
1110         'edate',   @date_type, '', '',
1111       ],
1112       'primary_key' => 'creditbillpkgnum',
1113       'unique'      => [],
1114       'index'       => [ [ 'creditbillnum' ],
1115                          [ 'billpkgnum' ],
1116                          [ 'billpkgtaxlocationnum' ],
1117                          [ 'billpkgtaxratelocationnum' ],
1118                        ],
1119     },
1120
1121     'cust_main' => {
1122       'columns' => [
1123         'custnum',  'serial',  '',     '', '', '',
1124         'agentnum', 'int',  '',     '', '', '',
1125         'salesnum', 'int',  'NULL', '', '', '',
1126         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
1127         'classnum', 'int', 'NULL', '', '', '',
1128         'custbatch', 'varchar', 'NULL', $char_d, '', '',
1129 #        'titlenum', 'int',  'NULL',   '', '', '',
1130         'last',     'varchar', '',   2*$char_d, '', '',
1131 #        'middle',   'varchar', 'NULL', $char_d, '', '',
1132         'first',    'varchar', '',     $char_d, '', '',
1133         'ss',       'varchar', 'NULL', 11, '', '',
1134         'stateid', 'varchar', 'NULL', $char_d, '', '',
1135         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
1136         'national_id', 'varchar', 'NULL', $char_d, '', '',
1137         'birthdate' ,@date_type, '', '',
1138         'spouse_last',  'varchar', 'NULL', 2*$char_d, '', '',
1139         'spouse_first', 'varchar', 'NULL', $char_d, '', '',
1140         'spouse_birthdate', @date_type, '', '',
1141         'anniversary_date', @date_type, '', '',
1142         'signupdate',@date_type, '', '',
1143         'dundate',   @date_type, '', '',
1144         'company',  'varchar', 'NULL', $char_d, '', '',
1145         'address1', 'varchar', 'NULL', $char_d, '', '',
1146         'address2', 'varchar', 'NULL', $char_d, '', '',
1147         'city',     'varchar', 'NULL', $char_d, '', '',
1148         'county',   'varchar', 'NULL', $char_d, '', '',
1149         'state',    'varchar', 'NULL', $char_d, '', '',
1150         'zip',      'varchar', 'NULL', 10, '', '',
1151         'country',  'char',    'NULL',  2, '', '',
1152         'latitude', 'decimal', 'NULL', '10,7', '', '',
1153         'longitude','decimal', 'NULL', '10,7', '', '',
1154         'coord_auto',  'char', 'NULL',  1, '', '',
1155         'addr_clean',  'char', 'NULL',  1, '', '',
1156         'daytime',  'varchar', 'NULL', 20, '', '',
1157         'night',    'varchar', 'NULL', 20, '', '',
1158         'fax',      'varchar', 'NULL', 12, '', '',
1159         'mobile',   'varchar', 'NULL', 12, '', '',
1160         'ship_last',     'varchar', 'NULL', 2*$char_d, '', '',
1161 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
1162         'ship_first',    'varchar', 'NULL', $char_d, '', '',
1163         'ship_company',  'varchar', 'NULL', $char_d, '', '',
1164         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
1165         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
1166         'ship_city',     'varchar', 'NULL', $char_d, '', '',
1167         'ship_county',   'varchar', 'NULL', $char_d, '', '',
1168         'ship_state',    'varchar', 'NULL', $char_d, '', '',
1169         'ship_zip',      'varchar', 'NULL', 10, '', '',
1170         'ship_country',  'char', 'NULL', 2, '', '',
1171         'ship_latitude', 'decimal', 'NULL', '10,7', '', '',
1172         'ship_longitude','decimal', 'NULL', '10,7', '', '',
1173         'ship_coord_auto',  'char', 'NULL',  1, '', '',
1174         'ship_addr_clean',  'char', 'NULL',  1, '', '',
1175         'ship_daytime',  'varchar', 'NULL', 20, '', '',
1176         'ship_night',    'varchar', 'NULL', 20, '', '',
1177         'ship_fax',      'varchar', 'NULL', 12, '', '',
1178         'ship_mobile',   'varchar', 'NULL', 12, '', '',
1179         'payby',    'char', '',     4, '', '',
1180         'payinfo',  'varchar', 'NULL', 512, '', '',
1181         'paycvv',   'varchar', 'NULL', 512, '', '',
1182         'paymask', 'varchar', 'NULL', $char_d, '', '',
1183         #'paydate',  @date_type, '', '',
1184         'paydate',  'varchar', 'NULL', 10, '', '',
1185         'paystart_month', 'int', 'NULL', '', '', '',
1186         'paystart_year',  'int', 'NULL', '', '', '',
1187         'payissue', 'varchar', 'NULL', 2, '', '',
1188         'payname',  'varchar', 'NULL', 2*$char_d, '', '',
1189         'paystate', 'varchar', 'NULL', $char_d, '', '',
1190         'paytype',  'varchar', 'NULL', $char_d, '', '',
1191         'payip',    'varchar', 'NULL', 15, '', '',
1192         'geocode',  'varchar', 'NULL', 20,  '', '',
1193         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
1194         'censusyear', 'char', 'NULL', 4, '', '',
1195         'district', 'varchar', 'NULL', 20, '', '',
1196         'tax',      'char', 'NULL', 1, '', '',
1197         'otaker',   'varchar', 'NULL',    32, '', '',
1198         'usernum',   'int', 'NULL', '', '', '',
1199         'refnum',   'int',  '',     '', '', '',
1200         'referral_custnum', 'int',  'NULL', '', '', '',
1201         'comments', 'text', 'NULL', '', '', '',
1202         'spool_cdr','char', 'NULL', 1, '', '',
1203         'squelch_cdr','char', 'NULL', 1, '', '',
1204         'cdr_termination_percentage', 'decimal', 'NULL', '7,4', '', '',
1205         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
1206         'credit_limit', @money_typen, '', '',
1207         'archived', 'char', 'NULL', 1, '', '',
1208         'email_csv_cdr', 'char', 'NULL', 1, '', '',
1209         'accountcode_cdr', 'char', 'NULL', 1, '', '',
1210         'billday',   'int', 'NULL', '', '', '',
1211         'prorate_day',   'int', 'NULL', '', '', '',
1212         'edit_subject', 'char', 'NULL', 1, '', '',
1213         'locale', 'varchar', 'NULL', 16, '', '',
1214         'calling_list_exempt', 'char', 'NULL', 1, '', '',
1215         'invoice_noemail', 'char', 'NULL', 1, '', '',
1216         'message_noemail', 'char', 'NULL', 1, '', '',
1217         'bill_locationnum', 'int', 'NULL', '', '', '',
1218         'ship_locationnum', 'int', 'NULL', '', '', '',
1219         'invoice_ship_address', 'char', 'NULL', 1, '', '',
1220       ],
1221       'primary_key' => 'custnum',
1222       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
1223       #'index' => [ ['last'], ['company'] ],
1224       'index' => [
1225                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
1226                    [ 'custbatch' ],
1227                    [ 'referral_custnum' ],
1228                    [ 'payby' ], [ 'paydate' ],
1229                    [ 'archived' ],
1230                    [ 'ship_locationnum' ],
1231                    [ 'bill_locationnum' ],
1232                  ],
1233     },
1234
1235     'cust_recon' => {  # (some sort of not-well understood thing for OnPac)
1236       'columns' => [
1237         'reconid',      'serial',  '',          '', '', '',
1238         'recondate',    @date_type,                 '', '',
1239         'custnum',      'int'   ,  '',          '', '', '',
1240         'agentnum',     'int',     '',          '', '', '',
1241         'last',         'varchar', '',     $char_d, '', '',
1242         'first',        'varchar', '',     $char_d, '', '',
1243         'address1',     'varchar', '',     $char_d, '', '',
1244         'address2',     'varchar', 'NULL', $char_d, '', '',
1245         'city',         'varchar', '',     $char_d, '', '',
1246         'state',        'varchar', 'NULL', $char_d, '', '',
1247         'zip',          'varchar', 'NULL',      10, '', '',
1248         'pkg',          'varchar', 'NULL', $char_d, '', '',
1249         'adjourn',      @date_type,                 '', '',
1250         'status',       'varchar', 'NULL',      10, '', '',
1251         'agent_custid', 'varchar',  '',    $char_d, '', '',
1252         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
1253         'agent_adjourn', @date_type,                '', '',
1254         'comments',     'text',    'NULL',      '', '', '',
1255       ],
1256       'primary_key' => 'reconid',
1257       'unique' => [],
1258       'index' => [],
1259     },
1260
1261     'contact_class' => {
1262       'columns' => [
1263         'classnum',    'serial',   '',      '', '', '',
1264         'classname',   'varchar',  '', $char_d, '', '',
1265         'disabled',    'char', 'NULL',       1, '', '',
1266       ],
1267       'primary_key' => 'classnum',
1268       'unique' => [],
1269       'index' => [ ['disabled'] ],
1270     },
1271
1272     'contact' => {
1273       'columns' => [
1274         'contactnum', 'serial',     '',      '', '', '',
1275         'prospectnum',   'int', 'NULL',      '', '', '',
1276         'custnum',       'int', 'NULL',      '', '', '',
1277         'locationnum',   'int', 'NULL',      '', '', '', #not yet
1278         'classnum',      'int', 'NULL',      '', '', '',
1279 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
1280         'last',      'varchar',     '', $char_d, '', '',
1281 #        'middle',    'varchar', 'NULL', $char_d, '', '',
1282         'first',     'varchar',     '', $char_d, '', '',
1283         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
1284         'comment',   'varchar', 'NULL',     255, '', '',
1285         'selfservice_access',    'char', 'NULL',       1, '', '',
1286         '_password',          'varchar', 'NULL', $char_d, '', '',
1287         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1288         'disabled',              'char', 'NULL',       1, '', '',
1289       ],
1290       'primary_key' => 'contactnum',
1291       'unique'      => [],
1292       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
1293                          [ 'last' ], [ 'first' ],
1294                        ],
1295     },
1296
1297     'contact_phone' => {
1298       'columns' => [
1299         'contactphonenum', 'serial',     '', '', '', '',
1300         'contactnum',         'int',     '', '', '', '',
1301         'phonetypenum',       'int',     '', '', '', '',
1302         'countrycode',    'varchar',     '',  3, '', '',
1303         'phonenum',       'varchar',     '', 14, '', '',
1304         'extension',      'varchar', 'NULL',  7, '', '',
1305         #?#'comment',        'varchar',     '', $char_d, '', '',
1306       ],
1307       'primary_key' => 'contactphonenum',
1308       'unique'      => [],
1309       'index'       => [],
1310     },
1311
1312     'phone_type' => {
1313       'columns' => [
1314         'phonetypenum',  'serial', '',      '', '', '',
1315         'typename',     'varchar', '', $char_d, '', '',
1316         'weight',           'int', '',      '', '', '',
1317       ],
1318       'primary_key' => 'phonetypenum',
1319       'unique'      => [ [ 'typename' ], ],
1320       'index'       => [],
1321     },
1322
1323     'contact_email' => {
1324       'columns' => [
1325         'contactemailnum', 'serial', '',      '', '', '',
1326         'contactnum',         'int', '',      '', '', '',
1327         'emailaddress',   'varchar', '', $char_d, '', '',
1328       ],
1329       'primary_key' => 'contactemailnum',
1330       #'unique'       => [ [ 'contactnum', 'emailaddress' ], ],
1331       'unique'       => [ [ 'emailaddress' ], ],
1332       'index'       => [],
1333     },
1334
1335     'prospect_main' => {
1336       'columns' => [
1337         'prospectnum',  'serial',     '',      '', '', '',
1338         'agentnum',        'int',     '',      '', '', '',
1339         'company',     'varchar', 'NULL', $char_d, '', '',
1340         'add_date',   @date_type,                  '', '',
1341         'disabled',       'char', 'NULL',       1, '', '',
1342         'custnum',         'int', 'NULL',      '', '', '',
1343         'refnum',          'int', 'NULL',      '', '', '',
1344       ],
1345       'primary_key' => 'prospectnum',
1346       'unique'      => [],
1347       'index'        => [ ['company'], ['agentnum'], ['disabled'], ['refnum'] ],
1348     },
1349
1350     'quotation' => {
1351       'columns' => [
1352         #regular fields
1353         'quotationnum',   'serial',     '', '', '', '',
1354         'prospectnum',       'int', 'NULL', '', '', '',
1355         'custnum',           'int', 'NULL', '', '', '',
1356         '_date',        @date_type,             '', '',
1357         'disabled',         'char', 'NULL',  1, '', '',
1358         'usernum',           'int', 'NULL', '', '', '',
1359         #'total',      @money_type,       '', '',
1360         #'quotation_term', 'varchar', 'NULL', $char_d, '', '',
1361       ],
1362       'primary_key' => 'quotationnum',
1363       'unique' => [],
1364       'index' => [ [ 'prospectnum' ], ['custnum'], ['disabled'], ],
1365     },
1366
1367     'quotation_pkg' => {
1368       'columns' => [
1369         'quotationpkgnum',   'serial',     '', '', '', '',
1370         'quotationnum',         'int', 'NULL', '', '', '', #shouldn't be null,
1371                                                            # but history...
1372         'pkgpart',              'int',     '', '', '', '',
1373         'locationnum',          'int', 'NULL', '', '', '',
1374         'start_date',      @date_type,             '', '',
1375         'contract_end',    @date_type,             '', '',
1376         'quantity',             'int', 'NULL', '', '', '',
1377         'waive_setup',         'char', 'NULL',  1, '', '',
1378         'unitsetup',     @money_typen,             '', '',
1379         'unitrecur',     @money_typen,             '', '',
1380       ],
1381       'primary_key' => 'quotationpkgnum',
1382       'unique' => [],
1383       'index' => [ ['pkgpart'], ],
1384     },
1385
1386     'quotation_pkg_detail' => {
1387       'columns' => [
1388         'detailnum', 'serial', '', '', '', '',
1389         'quotationpkgnum', 'int', '', '', '', '',
1390         'format',  'char', 'NULL', 1, '', '',       # not used for anything
1391         'detail',  'varchar', '', 255, '', '',
1392         'copy_on_order',        'char', 'NULL',  1, '', '', # 'Y' to copy when ordering
1393       ],
1394       'primary_key'  => 'detailnum',
1395       'unique'       => [],
1396       'index'        => [ [ 'quotationpkgnum' ] ],
1397       'foreign_keys' => [
1398                           { columns    => [ 'quotationpkgnum' ],
1399                             table      => 'quotation_pkg',
1400                             references => [ 'quotationpkgnum' ],
1401                           },
1402                         ],
1403     },
1404
1405     'quotation_pkg_discount' => {
1406       'columns' => [
1407         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1408         'quotationpkgnum',            'int', '', '', '', '',
1409         'discountnum',                'int', '', '', '', '',
1410         'setup_amount',        @money_typen,         '', '',
1411         'recur_amount',        @money_typen,         '', '',
1412         #'end_date',              @date_type,         '', '',
1413       ],
1414       'primary_key' => 'quotationpkgdiscountnum',
1415       'unique' => [],
1416       'index'  => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
1417     },
1418
1419     'quotation_pkg_tax' => {
1420       'columns' => [
1421         'quotationtaxnum',  'serial',     '',      '', '', '',
1422         'quotationpkgnum',     'int',     '',      '', '', '',
1423         'itemdesc',        'varchar',     '', $char_d, '', '',
1424         'taxnum',              'int',     '',      '', '', '',
1425         'taxtype',         'varchar',     '', $char_d, '', '',
1426         'setup_amount',    @money_type,                '', '',
1427         'recur_amount',    @money_type,                '', '',
1428       ],
1429       'primary_key' => 'quotationtaxnum',,
1430       'unique' => [],
1431       'index'  => [ [ 'quotationpkgnum' ] ],
1432     },
1433
1434     'cust_location' => { #'location' now that its prospects too, but...
1435       'columns' => [
1436         'locationnum',      'serial',     '',      '', '', '',
1437         'prospectnum',         'int', 'NULL',      '', '', '',
1438         'custnum',             'int', 'NULL',      '', '', '',
1439         'locationname',    'varchar', 'NULL', $char_d, '', '',
1440         'address1',        'varchar',     '', $char_d, '', '',
1441         'address2',        'varchar', 'NULL', $char_d, '', '',
1442         'city',            'varchar', 'NULL', $char_d, '', '',
1443         'county',          'varchar', 'NULL', $char_d, '', '',
1444         'state',           'varchar', 'NULL', $char_d, '', '',
1445         'zip',             'varchar', 'NULL',      10, '', '',
1446         'latitude',        'decimal', 'NULL',  '10,7', '', '',
1447         'longitude',       'decimal', 'NULL',  '10,7', '', '',
1448         'coord_auto',         'char', 'NULL',       1, '', '',
1449         'addr_clean',         'char', 'NULL',       1, '', '',
1450         'country',            'char',     '',       2, '', '',
1451         'geocode',         'varchar', 'NULL',      20, '', '',
1452         'district',        'varchar', 'NULL',      20, '', '',
1453         'censustract',     'varchar', 'NULL',      20, '', '',
1454         'censusyear',         'char', 'NULL',       4, '', '',
1455         'location_type',   'varchar', 'NULL',      20, '', '',
1456         'location_number', 'varchar', 'NULL',      20, '', '',
1457         'location_kind',      'char', 'NULL',       1, '', '',
1458         'disabled',           'char', 'NULL',       1, '', '',
1459       ],
1460       'primary_key' => 'locationnum',
1461       'unique'      => [],
1462       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1463                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1464                          [ 'city' ], [ 'district' ]
1465                        ],
1466     },
1467
1468     'cust_main_invoice' => {
1469       'columns' => [
1470         'destnum',  'serial',  '',     '', '', '',
1471         'custnum',  'int',  '',     '', '', '',
1472         'dest',     'varchar', '',  $char_d, '', '',
1473       ],
1474       'primary_key' => 'destnum',
1475       'unique' => [],
1476       'index' => [ ['custnum'], ],
1477     },
1478
1479     'cust_main_credit_limit' => {
1480       'columns' => [
1481         'creditlimitnum',   'serial', '', '', '', '',
1482         'custnum',             'int', '', '', '', '',
1483         '_date',          @date_type,         '', '',
1484         'amount',       @money_typen,         '', '',
1485         #'amount_currency', 'char', 'NULL',  3, '', '',
1486         'credit_limit', @money_typen,         '', '',
1487         #'credit_limit_currency', 'char', 'NULL',  3, '', '',
1488       ],
1489       'primary_key'  => 'creditlimitnum',
1490       'unique'       => [],
1491       'index'        => [ ['custnum'], ],
1492     },
1493
1494     'cust_main_note' => {
1495       'columns' => [
1496         'notenum',   'serial',    '',  '', '', '',
1497         'custnum',      'int',    '',  '', '', '',
1498         'classnum',     'int', 'NULL', '', '', '',
1499         '_date',          @date_type,      '', '',
1500         'otaker',   'varchar', 'NULL', 32, '', '',
1501         'usernum',      'int', 'NULL', '', '', '',
1502         'comments',    'text', 'NULL', '', '', '',
1503         'sticky',       'int',     '', '',  0, '',
1504       ],
1505       'primary_key' => 'notenum',
1506       'unique' => [],
1507       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1508     },
1509
1510     'cust_note_class' => {
1511       'columns' => [
1512         'classnum',    'serial',   '',      '', '', '',
1513         'classname',   'varchar',  '', $char_d, '', '',
1514         'disabled',    'char', 'NULL',       1, '', '',
1515       ],
1516       'primary_key' => 'classnum',
1517       'unique' => [],
1518       'index' => [ ['disabled'] ],
1519     },
1520
1521     'cust_category' => {
1522       'columns' => [
1523         'categorynum',   'serial',  '', '', '', '',
1524         'categoryname',  'varchar', '', $char_d, '', '',
1525         'weight',         'int', 'NULL',  '', '', '',
1526         'disabled',      'char', 'NULL',   1, '', '',
1527       ],
1528       'primary_key' => 'categorynum',
1529       'unique' => [],
1530       'index' => [ ['disabled'] ],
1531     },
1532
1533     'cust_class' => {
1534       'columns' => [
1535         'classnum',     'serial',     '',      '', '', '',
1536         'classname',   'varchar',     '', $char_d, '', '',
1537         'categorynum',     'int', 'NULL',      '', '', '',
1538         'tax',            'char', 'NULL',       1, '', '',
1539         'disabled',       'char', 'NULL',       1, '', '',
1540       ],
1541       'primary_key' => 'classnum',
1542       'unique' => [],
1543       'index' => [ ['disabled'] ],
1544     },
1545
1546     'cust_tag' => {
1547       'columns' => [
1548         'custtagnum', 'serial', '', '', '', '',
1549         'custnum',       'int', '', '', '', '',
1550         'tagnum',        'int', '', '', '', '',
1551       ],
1552       'primary_key' => 'custtagnum',
1553       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1554       'index'       => [ [ 'custnum' ] ],
1555     },
1556
1557     'part_tag' => {
1558       'columns' => [
1559         'tagnum',    'serial',     '',      '', '', '',
1560         'tagname',  'varchar',     '', $char_d, '', '',
1561         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1562         'tagcolor', 'varchar', 'NULL',       6, '', '',
1563         'by_default',  'char', 'NULL',       1, '', '',
1564         'disabled',    'char', 'NULL',       1, '', '',
1565       ],
1566       'primary_key' => 'tagnum',
1567       'unique'      => [], #[ [ 'tagname' ] ], #?
1568       'index'       => [ [ 'disabled' ] ],
1569     },
1570
1571     'cust_main_exemption' => {
1572       'columns' => [
1573         'exemptionnum',   'serial',     '',      '', '', '',
1574         'custnum',           'int',     '',      '', '', '',
1575         'taxname',       'varchar',     '', $char_d, '', '',
1576         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
1577         #start/end dates?  for reporting?
1578       ],
1579       'primary_key' => 'exemptionnum',
1580       'unique'      => [],
1581       'index'       => [ [ 'custnum' ] ],
1582     },
1583
1584     'cust_tax_adjustment' => {
1585       'columns' => [
1586         'adjustmentnum', 'serial',     '',      '', '', '',
1587         'custnum',          'int',     '',      '', '', '',
1588         'taxname',      'varchar',     '', $char_d, '', '',
1589         'amount',    @money_type,                   '', '',
1590         'comment',     'varchar',  'NULL', $char_d, '', '',
1591         'billpkgnum',       'int', 'NULL',      '', '', '',
1592         #more?  no cust_bill_pkg_tax_location?
1593       ],
1594       'primary_key' => 'adjustmentnum',
1595       'unique'      => [],
1596       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1597     },
1598
1599     'cust_main_county' => { #district+city+county+state+country are checked
1600                             #off the cust_main_county for validation and to
1601                             #provide a tax rate.
1602       'columns' => [
1603         'taxnum',   'serial',   '',    '', '', '',
1604         'district', 'varchar',  'NULL',    20, '', '',
1605         'city',     'varchar',  'NULL',    $char_d, '', '',
1606         'county',   'varchar',  'NULL',    $char_d, '', '',
1607         'state',    'varchar',  'NULL',    $char_d, '', '',
1608         'country',  'char',  '', 2, '', '',
1609         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1610         'exempt_amount', @money_type, '', '',
1611         'tax',      'real',  '',    '', '', '', #tax %
1612         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1613         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1614         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1615       ],
1616       'primary_key' => 'taxnum',
1617       'unique' => [],
1618   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1619       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ],
1620                    [ 'country' ],
1621                    [ 'taxclass' ],
1622                  ],
1623     },
1624
1625     'tax_rate'    => {
1626       'columns' => [
1627         'taxnum',       'serial',     '',      '', '', '',
1628         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1629         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1630         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1631         'taxclassnum', 'int',      '',      '', '', '',
1632         'effective_date', @date_type, '', '',
1633         'tax',        @taxrate_type,      '', '',        # tax %
1634         'excessrate', @taxrate_typen,     '', '',        # second tax %
1635         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1636         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1637         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1638         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1639         'unittype',    'int',  'NULL', '', '', '',      # for fee
1640         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1641         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1642         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1643         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1644         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1645         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1646         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1647         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1648         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1649         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1650         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1651         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1652         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1653         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1654         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1655         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1656       ],
1657       'primary_key' => 'taxnum',
1658       'unique' => [],
1659       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1660     },
1661
1662     'tax_rate_location' => {
1663       'columns' => [
1664         'taxratelocationnum', 'serial',  '',     '', '', '',
1665         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1666         'geocode',            'varchar', '',     20,      '', '',
1667         'city',               'varchar', 'NULL', $char_d, '', '',
1668         'county',             'varchar', 'NULL', $char_d, '', '',
1669         'state',              'char',    'NULL',       2, '', '',
1670         'disabled',           'char',    'NULL', 1, '', '',
1671       ],
1672       'primary_key' => 'taxratelocationnum',
1673       'unique' => [],
1674       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1675     },
1676
1677     'cust_tax_location' => {
1678       'columns' => [
1679         'custlocationnum', 'serial',  '',     '', '', '',
1680         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1681         'city',            'varchar', 'NULL', $char_d, '', '',
1682         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1683         'county',          'varchar', 'NULL', $char_d, '', '',
1684         'zip',             'char',    '',     5,  '', '',
1685         'state',           'char',    '',     2,  '', '',
1686         'plus4hi',         'char',    'NULL', 4,  '', '',
1687         'plus4lo',         'char',    'NULL', 4,  '', '',
1688         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1689         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1690         'geocode',         'varchar', '',    20,  '', '',
1691       ],
1692       'primary_key' => 'custlocationnum',
1693       'unique' => [],
1694       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1695     },
1696
1697     'tax_class' => {
1698       'columns' => [
1699         'taxclassnum',  'serial',  '',            '', '', '',
1700         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1701         'taxclass',     'varchar', '',       $char_d, '', '',
1702         'description',  'varchar', '',     2*$char_d, '', '',
1703       ],
1704       'primary_key' => 'taxclassnum',
1705       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1706       'index' => [],
1707     },
1708
1709     'cust_pay_pending' => {
1710       'columns' => [
1711         'paypendingnum','serial',      '',  '', '', '',
1712         'custnum',      'int',         '',  '', '', '',
1713         'paid',         @money_type,            '', '',
1714         '_date',        @date_type,             '', '',
1715         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1716                                                         # be index into payby
1717                                                         # table eventually
1718         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1719         'paymask',      'varchar', 'NULL', $char_d, '', '',
1720         'paydate',      'varchar', 'NULL', 10, '', '',
1721         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1722         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1723         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1724
1725         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1726         'status',       'varchar',     '', $char_d, '', '',
1727         'session_id',   'varchar', 'NULL', 1024, '', '', # SHA-512-hex
1728         'statustext',   'text',    'NULL',  '', '', '',
1729         'gatewaynum',   'int',     'NULL',  '', '', '',
1730         #'cust_balance', @money_type,            '', '',
1731         'paynum',       'int',     'NULL',  '', '', '',
1732         'void_paynum',  'int',     'NULL',  '', '', '',
1733         'jobnum',    'bigint',     'NULL',  '', '', '',
1734         'invnum',       'int',     'NULL',  '', '', '',
1735         'manual',       'char',    'NULL',   1, '', '',
1736         'discount_term','int',     'NULL',  '', '', '',
1737       ],
1738       'primary_key' => 'paypendingnum',
1739       'unique'      => [ [ 'payunique' ] ],
1740       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1741     },
1742
1743     'cust_pay' => {
1744       'columns' => [
1745         'paynum',   'serial',    '',   '', '', '',
1746         'custnum',  'int',    '',   '', '', '',
1747         '_date',    @date_type, '', '',
1748         'paid',     @money_type, '', '',
1749         'otaker',   'varchar', 'NULL', 32, '', '',
1750         'usernum',   'int', 'NULL', '', '', '',
1751         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1752                                                  # index into payby table
1753                                                  # eventually
1754         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1755         'paymask', 'varchar', 'NULL', $char_d, '', '',
1756         'paydate',  'varchar', 'NULL', 10, '', '',
1757         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1758         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1759         'closed',    'char', 'NULL', 1, '', '',
1760         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1761         'no_auto_apply',  'char', 'NULL',       1, '', '',
1762         # cash/check deposit info fields
1763         'bank',       'varchar', 'NULL', $char_d, '', '',
1764         'depositor',  'varchar', 'NULL', $char_d, '', '',
1765         'account',    'varchar', 'NULL', 20,      '', '',
1766         'teller',     'varchar', 'NULL', 20,      '', '',
1767
1768         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1769
1770         # credit card/EFT fields (formerly in paybatch)
1771         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1772         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1773         'auth',       'varchar','NULL',16, '', '', # CC auth number
1774         'order_number','varchar','NULL',$char_d, '', '', # transaction number
1775       ],
1776       'primary_key' => 'paynum',
1777       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1778       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1779     },
1780
1781     'cust_pay_void' => {
1782       'columns' => [
1783         'paynum',    'int',    '',   '', '', '',
1784         'custnum',   'int',    '',   '', '', '',
1785         '_date',     @date_type, '', '',
1786         'paid',      @money_type, '', '',
1787         'otaker',   'varchar', 'NULL', 32, '', '',
1788         'usernum',   'int', 'NULL', '', '', '',
1789         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1790                                                   # index into payby table
1791                                                   # eventually
1792         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1793         'paymask', 'varchar', 'NULL', $char_d, '', '',
1794         #'paydate' ?
1795         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1796         'closed',    'char', 'NULL', 1, '', '',
1797         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1798         # cash/check deposit info fields
1799         'bank',       'varchar', 'NULL', $char_d, '', '',
1800         'depositor',  'varchar', 'NULL', $char_d, '', '',
1801         'account',    'varchar', 'NULL', 20,      '', '',
1802         'teller',     'varchar', 'NULL', 20,      '', '',
1803         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1804
1805         # credit card/EFT fields (formerly in paybatch)
1806         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1807         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1808         'auth',       'varchar','NULL',16, '', '', # CC auth number
1809         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
1810
1811         #void fields
1812         'void_date', @date_type, '', '',
1813         'reason',    'varchar',   'NULL', $char_d, '', '',
1814         'void_usernum',   'int', 'NULL', '', '', '',
1815       ],
1816       'primary_key' => 'paynum',
1817       'unique' => [],
1818       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1819     },
1820
1821     'cust_bill_pay' => {
1822       'columns' => [
1823         'billpaynum', 'serial',     '',   '', '', '',
1824         'invnum',  'int',     '',   '', '', '',
1825         'paynum',  'int',     '',   '', '', '',
1826         'amount',  @money_type, '', '',
1827         '_date',   @date_type, '', '',
1828         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1829       ],
1830       'primary_key' => 'billpaynum',
1831       'unique' => [],
1832       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1833     },
1834
1835     'cust_bill_pay_batch' => {
1836       'columns' => [
1837         'billpaynum', 'serial',     '',   '', '', '',
1838         'invnum',  'int',     '',   '', '', '',
1839         'paybatchnum',  'int',     '',   '', '', '',
1840         'amount',  @money_type, '', '',
1841         '_date',   @date_type, '', '',
1842       ],
1843       'primary_key' => 'billpaynum',
1844       'unique' => [],
1845       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1846     },
1847
1848     'cust_bill_pay_pkg' => {
1849       'columns' => [
1850         'billpaypkgnum', 'serial', '', '', '', '',
1851         'billpaynum',       'int', '', '', '', '',
1852         'billpkgnum',       'int', '', '', '', '',
1853         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1854         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1855         'amount',         @money_type,     '', '',
1856         'setuprecur',      'varchar', '', $char_d, '', '',
1857         'sdate',   @date_type, '', '',
1858         'edate',   @date_type, '', '',
1859       ],
1860       'primary_key' => 'billpaypkgnum',
1861       'unique'      => [],
1862       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1863     },
1864
1865     'pay_batch' => { #batches of payments to an external processor
1866       'columns' => [
1867         'batchnum', 'serial',     '', '', '', '',
1868         'agentnum',    'int', 'NULL', '', '', '',
1869         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1870         'status',     'char', 'NULL',  1, '', '',
1871         'download',       @date_type,     '', '',
1872         'upload',         @date_type,     '', '',
1873         'title',   'varchar', 'NULL',255, '', '',
1874         'processor_id',   'varchar', 'NULL',255, '', '',
1875       ],
1876       'primary_key' => 'batchnum',
1877       'unique' => [],
1878       'index' => [],
1879     },
1880
1881     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1882       'columns' => [
1883         'paybatchnum',   'serial',    '',   '', '', '',
1884         'batchnum',   'int',    '',   '', '', '',
1885         'invnum',   'int',    '',   '', '', '',
1886         'custnum',   'int',    '',   '', '', '',
1887         'last',     'varchar', '',     $char_d, '', '',
1888         'first',    'varchar', '',     $char_d, '', '',
1889         'address1', 'varchar', '',     $char_d, '', '',
1890         'address2', 'varchar', 'NULL', $char_d, '', '',
1891         'city',     'varchar', 'NULL',     $char_d, '', '',
1892         'state',    'varchar', 'NULL', $char_d, '', '',
1893         'zip',      'varchar', 'NULL', 10, '', '',
1894         'country',  'char', '',     2, '', '',
1895         #        'trancode', 'int', '', '', '', ''
1896         'payby',    'char',        '',       4, '', '',
1897         'payinfo',  'varchar', 'NULL',     512, '', '',
1898         #'exp',      @date_type, '', ''
1899         'exp',      'varchar', 'NULL',      11, '', '',
1900         'payname',  'varchar', 'NULL', $char_d, '', '',
1901         'amount',   @money_type, '', '',
1902         'status',   'varchar', 'NULL', $char_d, '', '',
1903         'error_message',   'varchar', 'NULL', $char_d, '', '',
1904       ],
1905       'primary_key' => 'paybatchnum',
1906       'unique' => [],
1907       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1908     },
1909
1910     'fcc477map' => {
1911       'columns' => [
1912         'formkey',   'varchar',     '', 255, '', '',
1913         'formvalue',    'text', 'NULL',  '', '', '',
1914       ],
1915       'primary_key' => 'formkey',
1916       'unique'      => [],
1917       'index'       => [],
1918     },
1919
1920     'cust_pkg' => {
1921       'columns' => [
1922         'pkgnum',           'serial',     '', '', '', '',
1923         'custnum',             'int',     '', '', '', '',
1924         'pkgpart',             'int',     '', '', '', '',
1925         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1926         'contactnum',          'int', 'NULL', '', '', '',
1927         'locationnum',         'int', 'NULL', '', '', '',
1928         'otaker',          'varchar', 'NULL', 32, '', '',
1929         'usernum',             'int', 'NULL', '', '', '',
1930         'salesnum',            'int', 'NULL', '', '', '',
1931         'order_date',     @date_type,             '', '',
1932         'start_date',     @date_type,             '', '',
1933         'setup',          @date_type,             '', '',
1934         'bill',           @date_type,             '', '',
1935         'last_bill',      @date_type,             '', '',
1936         'susp',           @date_type,             '', '',
1937         'adjourn',        @date_type,             '', '',
1938         'resume',         @date_type,             '', '',
1939         'cancel',         @date_type,             '', '',
1940         'uncancel',       @date_type,             '', '',
1941         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1942         'expire',         @date_type,             '', '',
1943         'contract_end',   @date_type,             '', '',
1944         'dundate',        @date_type,             '', '',
1945         'change_date',    @date_type,             '', '',
1946         'change_pkgnum',       'int', 'NULL', '', '', '',
1947         'change_pkgpart',      'int', 'NULL', '', '', '',
1948         'change_locationnum',  'int', 'NULL', '', '', '',
1949         'change_custnum',      'int', 'NULL', '', '', '',
1950         'main_pkgnum',         'int', 'NULL', '', '', '',
1951         'pkglinknum',          'int', 'NULL', '', '', '',
1952         'manual_flag',        'char', 'NULL',  1, '', '',
1953         'no_auto',            'char', 'NULL',  1, '', '',
1954         'quantity',            'int', 'NULL', '', '', '',
1955         'agent_pkgid',     'varchar', 'NULL', $char_d, '', '',
1956         'waive_setup',        'char', 'NULL',  1, '', '',
1957         'recur_show_zero',    'char', 'NULL',  1, '', '',
1958         'setup_show_zero',    'char', 'NULL',  1, '', '',
1959         'change_to_pkgnum',    'int', 'NULL', '', '', '',
1960         'separate_bill',      'char', 'NULL',  1, '', '',
1961       ],
1962       'primary_key' => 'pkgnum',
1963       'unique' => [],
1964       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1965                    [ 'usernum' ], [ 'agent_pkgid' ],
1966                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1967                    ['last_bill'], ['susp'], ['adjourn'], ['resume'],
1968                    ['cancel'], ['expire'], ['contract_end'],
1969                    ['change_date'],
1970                    ['no_auto'],
1971                    #['contactnum'],
1972                    ['salesnum'],
1973                    #['uncancel_pkgnum'],
1974                    #['change_pkgnum'], ['change_locationnum'],
1975                    #['change_custnum'],
1976                    ['main_pkgnum'],
1977                    #['pkglinknum'], ['change_to_pkgnum'],
1978                  ],
1979     },
1980
1981     'cust_pkg_option' => {
1982       'columns' => [
1983         'optionnum', 'serial', '', '', '', '',
1984         'pkgnum', 'int', '', '', '', '',
1985         'optionname', 'varchar', '', $char_d, '', '',
1986         'optionvalue', 'text', 'NULL', '', '', '',
1987       ],
1988       'primary_key' => 'optionnum',
1989       'unique'      => [],
1990       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1991     },
1992
1993     'cust_pkg_detail' => {
1994       'columns' => [
1995         'pkgdetailnum', 'serial', '',        '', '', '',
1996         'pkgnum',          'int', '',        '', '', '',
1997         'detail',      'varchar', '', 2*$char_d, '', '',
1998         'detailtype',     'char', '',         1, '', '', #"I"nvoice or "C"omment
1999         'weight',          'int', '',        '', '', '',
2000       ],
2001       'primary_key' => 'pkgdetailnum',
2002       'unique' => [],
2003       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
2004     },
2005
2006     'cust_pkg_reason' => {
2007       'columns' => [
2008         'num',      'serial',    '',   '', '', '',
2009         'pkgnum',   'int',    '',   '', '', '',
2010         'reasonnum','int',    '',   '', '', '',
2011         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
2012         'otaker',   'varchar', 'NULL', 32, '', '',
2013         'usernum',   'int', 'NULL', '', '', '',
2014         'date',     @date_type, '', '',
2015       ],
2016       'primary_key' => 'num',
2017       'unique' => [],
2018       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
2019     },
2020
2021     'cust_pkg_reason_fee' => {
2022       'columns' => [
2023         'pkgreasonfeenum', 'serial', '', '', '', '',
2024         'pkgreasonnum',       'int', '', '', '', '',
2025         'billpkgnum',         'int', 'NULL', '', '', '',
2026         'feepart',            'int', '', '', '', '',
2027         'nextbill',          'char', 'NULL',  1, '', '',
2028       ],
2029       'primary_key'  => 'pkgreasonfeenum',
2030       'unique' => [ [ 'billpkgnum' ], [ 'pkgreasonnum' ] ], # one-to-one link
2031       'index'  => [ [ 'feepart' ] ],
2032     },
2033
2034     'cust_pkg_discount' => {
2035       'columns' => [
2036         'pkgdiscountnum', 'serial', '',        '', '', '',
2037         'pkgnum',            'int', '',        '', '', '',
2038         'discountnum',       'int', '',        '', '', '',
2039         'months_used',   'decimal', 'NULL', '7,4', '', '',
2040         'end_date',     @date_type,                '', '',
2041         'otaker',        'varchar', 'NULL',    32, '', '',
2042         'usernum',           'int', 'NULL',    '', '', '',
2043         'disabled',         'char', 'NULL',     1, '', '',
2044       ],
2045       'primary_key' => 'pkgdiscountnum',
2046       'unique' => [],
2047       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
2048     },
2049
2050     'cust_pkg_usage' => {
2051       'columns' => [
2052         'pkgusagenum', 'serial', '', '', '', '',
2053         'pkgnum',         'int', '', '', '', '',
2054         'minutes',        'double precision', '', '', '', '',
2055         'pkgusagepart',   'int', '', '', '', '',
2056       ],
2057       'primary_key' => 'pkgusagenum',
2058       'unique' => [],
2059       'index'  => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
2060     },
2061
2062     'cdr_cust_pkg_usage' => {
2063       'columns' => [
2064         'cdrusagenum', 'bigserial', '', '', '', '',
2065         'acctid',      'bigint',    '', '', '', '',
2066         'pkgusagenum', 'int',       '', '', '', '',
2067         'minutes',     'double precision',       '', '', '', '',
2068       ],
2069       'primary_key' => 'cdrusagenum',
2070       'unique' => [],
2071       'index'  => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
2072     },
2073
2074     'cust_bill_pkg_discount' => {
2075       'columns' => [
2076         'billpkgdiscountnum', 'serial',        '', '', '', '',
2077         'billpkgnum',            'int',        '', '', '', '',
2078         'pkgdiscountnum',        'int',        '', '', '', '',
2079         'amount',          @money_type,                '', '',
2080         'months',            'decimal', 'NULL', '7,4', '', '',
2081       ],
2082       'primary_key' => 'billpkgdiscountnum',
2083       'unique' => [],
2084       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2085     },
2086
2087     'cust_bill_pkg_discount_void' => {
2088       'columns' => [
2089         'billpkgdiscountnum',    'int',        '', '', '', '',
2090         'billpkgnum',            'int',        '', '', '', '',
2091         'pkgdiscountnum',        'int',        '', '', '', '',
2092         'amount',          @money_type,                '', '',
2093         'months',            'decimal', 'NULL', '7,4', '', '',
2094       ],
2095       'primary_key' => 'billpkgdiscountnum',
2096       'unique' => [],
2097       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2098     },
2099
2100     'discount' => {
2101       'columns' => [
2102         'discountnum', 'serial',     '',      '', '', '',
2103         #'agentnum',       'int', 'NULL',      '', '', '',
2104         'classnum',       'int', 'NULL',      '', '', '',
2105         'name',       'varchar', 'NULL', $char_d, '', '',
2106         'amount',   @money_type,                  '', '',
2107         'percent',    'decimal',     '',   '7,4', '', '',
2108         'months',     'decimal', 'NULL',   '7,4', '', '',
2109         'disabled',      'char', 'NULL',       1, '', '',
2110         'setup',         'char', 'NULL',       1, '', '',
2111         #'linked',        'char', 'NULL',       1, '', '',
2112       ],
2113       'primary_key' => 'discountnum',
2114       'unique' => [],
2115       'index'  => [], # [ 'agentnum' ], ],
2116     },
2117
2118     'discount_class' => {
2119       'columns' => [
2120         'classnum',    'serial',   '',      '', '', '',
2121         'classname',   'varchar',  '', $char_d, '', '',
2122         #'categorynum', 'int',  'NULL',      '', '', '',
2123         'disabled',    'char', 'NULL',       1, '', '',
2124       ],
2125       'primary_key' => 'classnum',
2126       'unique' => [],
2127       'index' => [ ['disabled'] ],
2128     },
2129
2130     'cust_refund' => {
2131       'columns' => [
2132         'refundnum',    'serial',    '',   '', '', '',
2133         'custnum',  'int',    '',   '', '', '',
2134         '_date',        @date_type, '', '',
2135         'refund',       @money_type, '', '',
2136         'otaker',       'varchar',   'NULL',   32, '', '',
2137         'usernum',   'int', 'NULL', '', '', '',
2138         'reason',       'varchar',   'NULL',   $char_d, '', '',
2139         'reasonnum',   'int', 'NULL', '', '', '',
2140         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
2141                                                      # be index into payby
2142                                                      # table eventually
2143         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
2144         'paymask', 'varchar', 'NULL', $char_d, '', '',
2145         'paybatch',     'varchar',   'NULL', $char_d, '', '',
2146         'closed',    'char', 'NULL', 1, '', '',
2147         # credit card/EFT fields (formerly in paybatch)
2148         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
2149         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
2150         'auth',       'varchar','NULL',16, '', '', # CC auth number
2151         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
2152       ],
2153       'primary_key' => 'refundnum',
2154       'unique' => [],
2155       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
2156     },
2157
2158     'cust_credit_refund' => {
2159       'columns' => [
2160         'creditrefundnum', 'serial',     '',   '', '', '',
2161         'crednum',  'int',     '',   '', '', '',
2162         'refundnum',  'int',     '',   '', '', '',
2163         'amount',  @money_type, '', '',
2164         '_date',   @date_type, '', '',
2165       ],
2166       'primary_key' => 'creditrefundnum',
2167       'unique' => [],
2168       'index' => [ ['crednum'], ['refundnum'] ],
2169     },
2170
2171
2172     'cust_svc' => {
2173       'columns' => [
2174         'svcnum',      'serial',     '', '', '', '',
2175         'pkgnum',         'int', 'NULL', '', '', '',
2176         'svcpart',        'int',     '', '', '', '',
2177         'agent_svcid',    'int', 'NULL', '', '', '',
2178         'overlimit',           @date_type,   '', '',
2179       ],
2180       'primary_key' => 'svcnum',
2181       'unique' => [],
2182       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
2183     },
2184
2185     'cust_svc_option' => {
2186       'columns' => [
2187         'optionnum',   'serial', '', '', '', '',
2188         'svcnum',      'int', '', '', '', '',
2189         'optionname',  'varchar', '', $char_d, '', '',
2190         'optionvalue', 'text', 'NULL', '', '', '',
2191       ],
2192       'primary_key' => 'optionnum',
2193       'unique'      => [],
2194       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
2195     },
2196
2197     'svc_export_machine' => {
2198       'columns' => [
2199         'svcexportmachinenum', 'serial', '', '', '', '',
2200         'svcnum',                 'int', '', '', '', '',
2201         'exportnum',              'int', '', '', '', '',
2202         'machinenum',             'int', '', '', '', '',
2203       ],
2204       'primary_key' => 'svcexportmachinenum',
2205       'unique'      => [ ['svcnum', 'exportnum'] ],
2206       'index'       => [],
2207     },
2208
2209     'part_export_machine' => {
2210       'columns' => [
2211         'machinenum', 'serial', '', '', '', '',
2212         'exportnum',     'int', '', '', '', '',
2213         'machine',    'varchar', 'NULL', $char_d, '', '',
2214         'disabled',      'char', 'NULL',       1, '', '',
2215       ],
2216       'primary_key' => 'machinenum',
2217       'unique'      => [ [ 'exportnum', 'machine' ] ],
2218       'index'       => [ [ 'exportnum' ] ],
2219     },
2220
2221    'part_pkg' => {
2222       'columns' => [
2223         'pkgpart',       'serial',    '',   '', '', '',
2224         'pkgpartbatch',  'varchar', 'NULL', $char_d, '', '',
2225         'pkg',           'varchar',   '',   $char_d, '', '',
2226         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
2227         'promo_code',    'varchar', 'NULL', $char_d, '', '',
2228         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
2229         'setuptax',      'char', 'NULL', 1, '', '',
2230         'recurtax',      'char', 'NULL', 1, '', '',
2231         'plan',          'varchar', 'NULL', $char_d, '', '',
2232         'disabled',      'char', 'NULL', 1, '', '',
2233         'custom',        'char', 'NULL', 1, '', '',
2234         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2235         'classnum',      'int',     'NULL', '', '', '',
2236         'addon_classnum','int',     'NULL', '', '', '',
2237         'taxproductnum', 'int',     'NULL', '', '', '',
2238         'setup_cost',    @money_typen,          '', '',
2239         'recur_cost',    @money_typen,          '', '',
2240         'pay_weight',    'real',    'NULL', '', '', '',
2241         'credit_weight', 'real',    'NULL', '', '', '',
2242         'agentnum',      'int',     'NULL', '', '', '',
2243         'fcc_ds0s',      'int',     'NULL', '', '', '',
2244         'fcc_voip_class','char',    'NULL',  1, '', '',
2245         'no_auto',          'char', 'NULL',  1, '', '',
2246         'recur_show_zero',  'char', 'NULL',  1, '', '',
2247         'setup_show_zero',  'char', 'NULL',  1, '', '',
2248         'successor',     'int',     'NULL', '', '', '',
2249         'family_pkgpart','int',     'NULL', '', '', '',
2250         'delay_start',   'int',     'NULL', '', '', '',
2251         'start_on_hold', 'char',    'NULL',  1, '', '',
2252         'agent_pkgpartid', 'varchar', 'NULL', 20, '', '',
2253       ],
2254       'primary_key' => 'pkgpart',
2255       'unique' => [],
2256       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
2257                    [ 'agentnum' ], ['no_auto'], ['agent_pkgpartid'],
2258                  ],
2259     },
2260
2261     'part_pkg_msgcat' => {
2262       'columns' => [
2263         'pkgpartmsgnum',  'serial',     '',        '', '', '',
2264         'pkgpart',           'int',     '',        '', '', '',
2265         'locale',        'varchar',     '',        16, '', '',
2266         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
2267         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2268       ],
2269       'primary_key' => 'pkgpartmsgnum',
2270       'unique'      => [ [ 'pkgpart', 'locale' ] ],
2271       'index'       => [],
2272     },
2273
2274     'part_fee' => {
2275       'columns' => [
2276         'feepart',       'serial',    '',   '', '', '',
2277         'itemdesc',      'varchar',   '',   $char_d,   '', '',
2278         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
2279         'disabled',      'char',    'NULL',  1, '', '',
2280         'classnum',      'int',     'NULL', '', '', '',
2281         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2282         'taxproductnum', 'int',     'NULL', '', '', '',
2283         'pay_weight',    'real',    'NULL', '', '', '',
2284         'credit_weight', 'real',    'NULL', '', '', '',
2285         'agentnum',      'int',     'NULL', '', '', '',
2286         'amount',   @money_type,                '', '',
2287         'percent',     'decimal',    '', '7,4', '', '',
2288         'basis',         'varchar',  '',    16, '', '',
2289         'minimum',    @money_typen,             '', '',
2290         'maximum',    @money_typen,             '', '',
2291         'limit_credit',  'char',    'NULL',  1, '', '',
2292         'setuprecur',    'char',     '',     5, '', '',
2293         'taxable',       'char',    'NULL',  1, '', '',
2294       ],
2295       'primary_key'  => 'feepart',
2296       'unique'       => [],
2297       'index'        => [ [ 'disabled' ], [ 'classnum' ], [ 'agentnum' ]
2298                         ],
2299     },
2300
2301     'part_fee_msgcat' => {
2302       'columns' => [
2303         'feepartmsgnum',  'serial',     '',        '', '', '',
2304         'feepart',           'int',     '',        '', '', '',
2305         'locale',        'varchar',     '',        16, '', '',
2306         'itemdesc',      'varchar',     '',   $char_d, '', '', #longer/no limit?
2307         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2308       ],
2309       'primary_key'  => 'feepartmsgnum',
2310       'unique'       => [ [ 'feepart', 'locale' ] ],
2311       'index'        => [],
2312     },
2313
2314     'part_fee_usage' => {
2315       'columns' => [
2316         'feepartusagenum','serial',     '',        '', '', '',
2317         'feepart',           'int',     '',        '', '', '',
2318         'classnum',          'int',     '',        '', '', '',
2319         'amount',   @money_type,                '', '',
2320         'percent',     'decimal',    '', '7,4', '', '',
2321       ],
2322       'primary_key'  => 'feepartusagenum',
2323       'unique'       => [ [ 'feepart', 'classnum' ] ],
2324       'index'        => [],
2325     },
2326
2327     'part_pkg_link' => {
2328       'columns' => [
2329         'pkglinknum',  'serial',   '',      '', '', '',
2330         'src_pkgpart', 'int',      '',      '', '', '',
2331         'dst_pkgpart', 'int',      '',      '', '', '',
2332         'link_type',   'varchar',  '', $char_d, '', '',
2333         'hidden',      'char', 'NULL',       1, '', '',
2334       ],
2335       'primary_key' => 'pkglinknum',
2336       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
2337       'index'  => [ [ 'src_pkgpart' ] ],
2338     },
2339     # XXX somewhat borked unique: we don't really want a hidden and unhidden
2340     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
2341
2342     'part_pkg_discount' => {
2343       'columns' => [
2344         'pkgdiscountnum', 'serial',   '',      '', '', '',
2345         'pkgpart',        'int',      '',      '', '', '',
2346         'discountnum',    'int',      '',      '', '', '',
2347       ],
2348       'primary_key' => 'pkgdiscountnum',
2349       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
2350       'index'  => [],
2351     },
2352
2353     'part_pkg_taxclass' => {
2354       'columns' => [
2355         'taxclassnum',  'serial', '',       '', '', '',
2356         'taxclass',     'varchar', '', $char_d, '', '',
2357         'disabled', 'char',   'NULL',         1, '', '',
2358       ],
2359       'primary_key' => 'taxclassnum',
2360       'unique'      => [ [ 'taxclass' ] ],
2361       'index'       => [ [ 'disabled' ] ],
2362     },
2363
2364     'part_pkg_taxproduct' => {
2365       'columns' => [
2366         'taxproductnum', 'serial',      '',        '', '', '',
2367         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
2368         'taxproduct',    'varchar',     '',   $char_d, '', '',
2369         'description',   'varchar',     '', 3*$char_d, '', '',
2370       ],
2371       'primary_key' => 'taxproductnum',
2372       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
2373       'index'       => [],
2374     },
2375
2376     'part_pkg_taxrate' => {
2377       'columns' => [
2378         'pkgtaxratenum', 'serial',  '',     '',      '', '',
2379         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
2380         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
2381         'taxproductnum', 'int',  '',     '',       '', '',
2382         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
2383         'county',           'varchar', 'NULL', $char_d, '', '',
2384         'state',            'varchar', 'NULL', $char_d, '', '',
2385         'local',            'varchar', 'NULL', $char_d, '', '',
2386         'country',          'char',    'NULL', 2,       '', '',
2387         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
2388         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
2389         'taxclassnum',      'int',     'NULL', '',      '', '',
2390         'effdate',          @date_type, '', '',
2391         'taxable',          'char',    'NULL', 1,       '', '',
2392       ],
2393       'primary_key' => 'pkgtaxratenum',
2394       'unique' => [],
2395       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
2396     },
2397
2398     'part_pkg_taxoverride' => {
2399       'columns' => [
2400         'taxoverridenum', 'serial', '', '', '', '',
2401         'pkgpart',           'int', '', '', '', '',
2402         'taxclassnum',       'int', '', '', '', '',
2403         'usage_class',    'varchar', 'NULL', $char_d, '', '',
2404       ],
2405       'primary_key' => 'taxoverridenum',
2406       'unique' => [],
2407       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
2408     },
2409
2410 #    'part_title' => {
2411 #      'columns' => [
2412 #        'titlenum',   'int',    '',   '',
2413 #        'title',      'varchar',   '',   $char_d,
2414 #      ],
2415 #      'primary_key' => 'titlenum',
2416 #      'unique' => [ [] ],
2417 #      'index' => [ [] ],
2418 #    },
2419
2420     'pkg_svc' => {
2421       'columns' => [
2422         'pkgsvcnum',  'serial', '',  '', '', '',
2423         'pkgpart',    'int',    '',   '', '', '',
2424         'svcpart',    'int',    '',   '', '', '',
2425         'quantity',   'int',    '',   '', '', '',
2426         'primary_svc','char', 'NULL',  1, '', '',
2427         'hidden',     'char', 'NULL',  1, '', '',
2428         'provision_hold', 'char', 'NULL', 1, '', '',
2429       ],
2430       'primary_key' => 'pkgsvcnum',
2431       'unique' => [ ['pkgpart', 'svcpart'] ],
2432       'index' => [ ['pkgpart'], ['quantity'] ],
2433     },
2434
2435     'part_referral' => {
2436       'columns' => [
2437         'refnum',   'serial',     '',        '', '', '',
2438         'referral', 'varchar',    '',   $char_d, '', '',
2439         'disabled', 'char',   'NULL',         1, '', '',
2440         'agentnum', 'int',    'NULL',        '', '', '',
2441       ],
2442       'primary_key' => 'refnum',
2443       'unique' => [],
2444       'index' => [ ['disabled'], ['agentnum'], ],
2445     },
2446
2447     'part_svc' => {
2448       'columns' => [
2449         'svcpart',             'serial',     '',        '', '', '',
2450         'svc',                'varchar',     '',   $char_d, '', '',
2451         'svcdb',              'varchar',     '',   $char_d, '', '',
2452         'disabled',              'char', 'NULL',         1, '', '',
2453         'preserve',              'char', 'NULL',         1, '', '',
2454         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
2455         'classnum',               'int', 'NULL',        '', '', '',
2456         'restrict_edit_password','char', 'NULL',         1, '', '',
2457         'has_router',            'char', 'NULL',         1, '', '',
2458 ],
2459       'primary_key' => 'svcpart',
2460       'unique' => [],
2461       'index' => [ [ 'disabled' ] ],
2462     },
2463
2464     'part_svc_column' => {
2465       'columns' => [
2466         'columnnum',   'serial',      '',      '', '', '',
2467         'svcpart',     'int',         '',      '', '', '',
2468         'columnname',  'varchar',     '',      64, '', '',
2469         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
2470         'columnvalue', 'varchar', 'NULL',     512, '', '',
2471         'columnflag',  'char',    'NULL',       1, '', '',
2472         'required',    'char',    'NULL',       1, '', '',
2473       ],
2474       'primary_key' => 'columnnum',
2475       'unique' => [ [ 'svcpart', 'columnname' ] ],
2476       'index' => [ [ 'svcpart' ] ],
2477     },
2478
2479     'part_svc_class' => {
2480       'columns' => [
2481         'classnum',    'serial',   '',      '', '', '',
2482         'classname',   'varchar',  '', $char_d, '', '',
2483         'disabled',    'char', 'NULL',       1, '', '',
2484       ],
2485       'primary_key' => 'classnum',
2486       'unique' => [],
2487       'index' => [ ['disabled'] ],
2488     },
2489
2490     #(this should be renamed to part_pop)
2491     'svc_acct_pop' => {
2492       'columns' => [
2493         'popnum',    'serial',    '',   '', '', '',
2494         'city',      'varchar',   '',   $char_d, '', '',
2495         'state',     'varchar',   '',   $char_d, '', '',
2496         'ac',        'char',   '',   3, '', '',
2497         'exch',      'char',   '',   3, '', '',
2498         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
2499       ],
2500       'primary_key' => 'popnum',
2501       'unique' => [],
2502       'index' => [ [ 'state' ] ],
2503     },
2504
2505     'part_pop_local' => {
2506       'columns' => [
2507         'localnum',  'serial',     '',     '', '', '',
2508         'popnum',    'int',     '',     '', '', '',
2509         'city',      'varchar', 'NULL', $char_d, '', '',
2510         'state',     'char',    'NULL', 2, '', '',
2511         'npa',       'char',    '',     3, '', '',
2512         'nxx',       'char',    '',     3, '', '',
2513       ],
2514       'primary_key' => 'localnum',
2515       'unique' => [],
2516       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
2517     },
2518
2519     'qual' => {
2520       'columns' => [
2521         'qualnum',  'serial',     '',     '', '', '',
2522         'custnum',    'int',     'NULL',     '', '', '',
2523         'prospectnum',    'int',     'NULL',     '', '', '',
2524         'locationnum',    'int',     'NULL',     '', '', '',
2525         'phonenum',     'varchar', 'NULL',       24, '', '',
2526         'exportnum',      'int', 'NULL', '', '', '',
2527         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
2528         'status',      'char', '', 1, '', '',
2529       ],
2530       'primary_key' => 'qualnum',
2531       'unique' => [],
2532       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
2533                     ['phonenum'], ['vendor_qual_id'] ],
2534     },
2535
2536     'qual_option' => {
2537       'columns' => [
2538         'optionnum', 'serial', '', '', '', '',
2539         'qualnum',  'int',     '',     '', '', '',
2540         'optionname', 'varchar', '', $char_d, '', '',
2541         'optionvalue', 'text', 'NULL', '', '', '',
2542       ],
2543       'primary_key' => 'optionnum',
2544       'unique' => [],
2545       'index' => [],
2546     },
2547
2548     'svc_acct' => {
2549       'columns' => [
2550         'svcnum',    'int',    '',   '', '', '',
2551         'username',  'varchar',   '',   $username_len, '', '',
2552         '_password', 'varchar',   'NULL',  512, '', '',
2553         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
2554         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
2555         'popnum',    'int',    'NULL',   '', '', '',
2556         'sectornum', 'int', 'NULL',      '', '', '',
2557         'uid',       'int', 'NULL',   '', '', '',
2558         'gid',       'int', 'NULL',   '', '', '',
2559         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
2560         'dir',       'varchar',   'NULL',   $char_d, '', '',
2561         'shell',     'varchar',   'NULL',   $char_d, '', '',
2562         'quota',     'varchar',   'NULL',   $char_d, '', '',
2563         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
2564         # IP address mgmt
2565         'routernum', 'int', 'NULL',      '', '', '',
2566         'blocknum',  'int', 'NULL',      '', '', '',
2567         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
2568         'seconds_threshold',   'int', 'NULL',   '', '', '',
2569         'upbytes',   'bigint', 'NULL',   '', '', '',
2570         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
2571         'downbytes', 'bigint', 'NULL',   '', '', '',
2572         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
2573         'totalbytes','bigint', 'NULL',   '', '', '',
2574         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
2575         'domsvc',    'int',     '', '', '', '',
2576         'pbxsvc',    'int', 'NULL', '', '', '',
2577         'last_login',  @date_type, '', '',
2578         'last_logout', @date_type, '', '',
2579         #cardfortress field(s)
2580         'cf_privatekey',      'text', 'NULL',      '', '', '',
2581         #communigate pro fields (quota = MaxAccountSize)
2582         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
2583         #settings
2584         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
2585         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
2586         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
2587         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
2588         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
2589         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
2590         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
2591         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
2592         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
2593         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
2594         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
2595         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
2596         #XXX mailing lists
2597         #preferences
2598         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
2599         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
2600         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
2601         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
2602         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
2603         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
2604         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
2605         #mail
2606         #XXX RPOP settings
2607         #
2608       ],
2609       'primary_key' => 'svcnum',
2610       #'unique' => [ [ 'username', 'domsvc' ] ],
2611       'unique' => [],
2612       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
2613     },
2614
2615     'acct_rt_transaction' => {
2616       'columns' => [
2617         'svcrtid',   'int',    '',   '', '', '',
2618         'svcnum',    'int',    '',   '', '', '',
2619         'transaction_id',       'int', '',   '', '', '',
2620         '_date',   @date_type, '', '',
2621         'seconds',   'int', '',   '', '', '', #uhhhh
2622         'support',   'int', '',   '', '', '',
2623       ],
2624       'primary_key' => 'svcrtid',
2625       'unique' => [],
2626       'index' => [ ['svcnum', 'transaction_id'] ],
2627     },
2628
2629     #'svc_charge' => {
2630     #  'columns' => [
2631     #    'svcnum',    'int',    '',   '',
2632     #    'amount',    @money_type,
2633     #  ],
2634     #  'primary_key' => 'svcnum',
2635     #  'unique' => [ [] ],
2636     #  'index' => [ [] ],
2637     #},
2638
2639     'svc_domain' => {
2640       'columns' => [
2641         'svcnum',           'int',    '',        '', '', '',
2642         'domain',       'varchar',    '',   $char_d, '', '',
2643         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2644         'catchall',         'int', 'NULL',       '', '', '',
2645         'parent_svcnum',    'int', 'NULL',       '', '', '',
2646         'quota',        'varchar', 'NULL',  $char_d, '', '',
2647
2648         #registration info
2649         'registrarnum',     'int', 'NULL',       '', '', '',
2650         'registrarkey', 'varchar', 'NULL',      512, '', '',
2651         'setup_date',      @date_type, '', '',
2652         'renewal_interval', 'int', 'NULL',       '', '', '',
2653         'expiration_date', @date_type, '', '',
2654
2655         #some weird shit australia-specific shit?  yuck.. seems totally unused
2656         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2657         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2658
2659         #communigate pro fields (quota = MaxAccountSize)
2660         'max_accounts',     'int', 'NULL',       '', '', '',
2661         'trailer',         'text', 'NULL',       '', '', '',
2662         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2663         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2664         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2665
2666         #(account default) settings
2667         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
2668         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
2669         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2670         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2671         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2672         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2673         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2674         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2675         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
2676         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
2677         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
2678         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2679
2680         #(account default) preferences
2681         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2682         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2683         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2684         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2685         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2686         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2687         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2688       ],
2689       'primary_key' => 'svcnum',
2690       'unique' => [ ],
2691       'index' => [ ['domain'] ],
2692     },
2693
2694     'svc_dsl' => {
2695       'columns' => [
2696         'svcnum',                    'int',    '',        '', '', '',
2697         'pushed',                    'int', 'NULL',       '', '', '',
2698         'desired_due_date',          'int', 'NULL',       '', '', '',
2699         'due_date',                  'int', 'NULL',       '', '', '',
2700         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2701         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2702         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2703         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2704         'first',                 'varchar', 'NULL', $char_d,  '', '',
2705         'last',                  'varchar', 'NULL', $char_d,  '', '',
2706         'company',               'varchar', 'NULL', $char_d,  '', '',
2707         'phonenum',              'varchar', 'NULL',      24, '', '',
2708         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2709         'loop_type',                'char', 'NULL',       1, '', '',
2710         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2711         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2712         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2713         'vpi',                       'int', 'NULL',      '', '', '',
2714         'vci',                       'int', 'NULL',      '', '', '',
2715         'isp_chg',                  'char', 'NULL',       1, '', '',
2716         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2717         'username',              'varchar', 'NULL', $char_d, '', '',
2718         'password',              'varchar', 'NULL', $char_d, '', '',
2719         'staticips',                'text', 'NULL',      '', '', '',
2720         'monitored',                'char', 'NULL',       1, '', '',
2721         'last_pull',                 'int', 'NULL',      '', '', '',
2722       ],
2723       'primary_key' => 'svcnum',
2724       'unique' => [ ],
2725       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2726     },
2727
2728     'dsl_device' => {
2729       'columns' => [
2730         'devicenum', 'serial',     '', '', '', '',
2731         #part_device?  or our own part_dsl_device?
2732         #'devicepart',   'int',     '', '', '', '',
2733         'svcnum',       'int',     '', '', '', '',
2734         'mac_addr', 'varchar',     '', 12, '', '',
2735       ],
2736       'primary_key' => 'devicenum',
2737       'unique' => [ [ 'mac_addr' ], ],
2738       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2739     },
2740
2741     'dsl_note' => {
2742       'columns' => [
2743         'notenum',           'serial',    '',        '', '', '',
2744         'svcnum',     'int', '',       '', '', '',
2745         'author',     'varchar', 'NULL', $char_d,  '', '',
2746         'priority',   'char', 'NULL',       1,  '', '',
2747         '_date',     'int', 'NULL',       '', '', '',
2748         'note',     'text', '',       '', '', '',
2749       ],
2750       'primary_key' => 'notenum',
2751       'unique' => [ ],
2752       'index' => [ ['svcnum'] ],
2753     },
2754
2755     'svc_dish' => {
2756       'columns' => [
2757         'svcnum',   'int',     '',     '', '', '',
2758         'acctnum',  'varchar', '',     16, '', '',
2759         'installdate', @date_type,         '', '',
2760         'note',     'text',    'NULL', '', '', '',
2761       ],
2762       'primary_key' => 'svcnum',
2763       'unique' => [ ],
2764       'index' => [ ],
2765     },
2766
2767     'svc_hardware' => {
2768       'columns' => [
2769         'svcnum',   'int',     '',          '', '', '',
2770         'typenum',  'int',     '',          '', '', '',
2771         'serial',   'varchar', 'NULL', $char_d, '', '',
2772         'ip_addr',  'varchar', 'NULL',      40, '', '',
2773         'hw_addr',  'varchar', 'NULL',      12, '', '',
2774         'smartcard','varchar', 'NULL',      30, '', '',
2775         'statusnum','int',     'NULL',      '', '', '',
2776         'note',     'text',    'NULL',      '', '', '',
2777       ],
2778       'primary_key' => 'svcnum',
2779       'unique' => [ ],
2780       'index' => [ ],
2781     },
2782
2783     'hardware_class' => {
2784       'columns' => [
2785         'classnum',   'serial', '',      '', '', '',
2786         'classname', 'varchar', '', $char_d, '', '',
2787       ],
2788       'primary_key' => 'classnum',
2789       'unique' => [ ],
2790       'index'  => [ ],
2791     },
2792
2793     'hardware_type' => {
2794       'columns' => [
2795         'typenum',  'serial',     '',      '', '', '',
2796         'classnum',    'int',     '',      '', '', '',
2797         'model',   'varchar',     '', $char_d, '', '',
2798         'revision','varchar', 'NULL', $char_d, '', '',
2799       ],
2800       'primary_key' => 'typenum',
2801       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2802       'index'  => [ ],
2803     },
2804
2805     'hardware_status' => {
2806       'columns' => [
2807         'statusnum', 'serial', '',      '', '', '',
2808         'label'    ,'varchar', '', $char_d, '', '',
2809         'disabled',    'char', 'NULL',   1, '', '',
2810       ],
2811       'primary_key' => 'statusnum',
2812       'unique' => [ ],
2813       'index'  => [ ],
2814     },
2815
2816     'domain_record' => {
2817       'columns' => [
2818         'recnum',    'serial',     '',  '', '', '',
2819         'svcnum',    'int',     '',  '', '', '',
2820         'reczone',   'varchar', '',  255, '', '',
2821         'recaf',     'char',    '',  2, '', '',
2822         'rectype',   'varchar',    '',  5, '', '',
2823         'recdata',   'varchar', '',  255, '', '',
2824         'ttl',       'int',     'NULL', '', '', '',
2825       ],
2826       'primary_key' => 'recnum',
2827       'unique'      => [],
2828       'index'       => [ ['svcnum'] ],
2829     },
2830
2831     'registrar' => {
2832       'columns' => [
2833         'registrarnum',   'serial', '',      '', '', '',
2834         'registrarname', 'varchar', '', $char_d, '', '',
2835       ],
2836       'primary_key' => 'registrarnum',
2837       'unique'      => [],
2838       'index'       => [],
2839     },
2840
2841     'cgp_rule' => {
2842       'columns' => [
2843         'rulenum',  'serial',     '',      '', '', '',
2844         'name',    'varchar',     '', $char_d, '', '',
2845         'comment', 'varchar', 'NULL', $char_d, '', '',
2846         'svcnum',      'int',     '',      '', '', '',
2847         'priority',    'int',     '',      '', '', '',
2848       ],
2849       'primary_key' => 'rulenum',
2850       'unique'      => [ [ 'svcnum', 'name' ] ],
2851       'index'       => [ [ 'svcnum' ] ],
2852     },
2853
2854     'cgp_rule_condition' => {
2855       'columns' => [
2856         'ruleconditionnum',  'serial',     '',      '', '', '',
2857         'conditionname',    'varchar',     '', $char_d, '', '',
2858         'op',               'varchar', 'NULL', $char_d, '', '',
2859         'params',           'varchar', 'NULL',     255, '', '',
2860         'rulenum',              'int',     '',      '', '', '',
2861       ],
2862       'primary_key' => 'ruleconditionnum',
2863       'unique'      => [],
2864       'index'       => [ [ 'rulenum' ] ],
2865     },
2866
2867     'cgp_rule_action' => {
2868        'columns' => [
2869         'ruleactionnum',  'serial',     '',      '', '', '',
2870         'action',        'varchar',     '', $char_d, '', '',
2871         'params',        'varchar', 'NULL',     255, '', '',
2872         'rulenum',           'int',     '',      '', '', '',
2873       ],
2874       'primary_key' => 'ruleactionnum',
2875       'unique'      => [],
2876       'index'       => [ [ 'rulenum' ] ],
2877    },
2878
2879     'svc_forward' => {
2880       'columns' => [
2881         'svcnum',   'int',            '',   '', '', '',
2882         'srcsvc',   'int',        'NULL',   '', '', '',
2883         'src',      'varchar',    'NULL',  255, '', '',
2884         'dstsvc',   'int',        'NULL',   '', '', '',
2885         'dst',      'varchar',    'NULL',  255, '', '',
2886       ],
2887       'primary_key' => 'svcnum',
2888       'unique'      => [],
2889       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2890     },
2891
2892     'svc_www' => {
2893       'columns' => [
2894         'svcnum',   'int',      '',  '', '', '',
2895         'recnum',   'int',      '',  '', '', '',
2896         'usersvc',  'int',  'NULL',  '', '', '',
2897         'config',   'text', 'NULL',  '', '', '',
2898       ],
2899       'primary_key' => 'svcnum',
2900       'unique'      => [],
2901       'index'       => [],
2902     },
2903
2904     #'svc_wo' => {
2905     #  'columns' => [
2906     #    'svcnum',    'int',    '',   '',
2907     #    'svcnum',    'int',    '',   '',
2908     #    'svcnum',    'int',    '',   '',
2909     #    'worker',    'varchar',   '',   $char_d,
2910     #    '_date',     @date_type,
2911     #  ],
2912     #  'primary_key' => 'svcnum',
2913     #  'unique' => [ [] ],
2914     #  'index' => [ [] ],
2915     #},
2916
2917     'prepay_credit' => {
2918       'columns' => [
2919         'prepaynum',   'serial',     '',   '', '', '',
2920         'identifier',  'varchar', '', $char_d, '', '',
2921         'amount',      @money_type, '', '',
2922         'seconds',     'int',     'NULL', '', '', '',
2923         'upbytes',     'bigint',     'NULL', '', '', '',
2924         'downbytes',   'bigint',     'NULL', '', '', '',
2925         'totalbytes',  'bigint',     'NULL', '', '', '',
2926         'agentnum',    'int',     'NULL', '', '', '',
2927       ],
2928       'primary_key' => 'prepaynum',
2929       'unique'      => [ ['identifier'] ],
2930       'index'       => [ ['agentnum'] ],
2931     },
2932
2933     'port' => {
2934       'columns' => [
2935         'portnum',  'serial',     '',   '', '', '',
2936         'ip',       'varchar', 'NULL', 15, '', '',
2937         'nasport',  'int',     'NULL', '', '', '',
2938         'nasnum',   'int',     '',   '', '', '',
2939       ],
2940       'primary_key' => 'portnum',
2941       'unique'      => [],
2942       'index'       => [],
2943     },
2944
2945     'nas' => {
2946       'columns' => [
2947         'nasnum',       'serial',     '',  '',              '', '',
2948         'nasname',     'varchar',     '', 128,              '', '',
2949         'shortname',   'varchar', 'NULL',  32,              '', '',
2950         'type',        'varchar',     '',  30,         'other', '',
2951         'ports',           'int', 'NULL',  '',              '', '',
2952         'secret',      'varchar',     '',  60,        'secret', '',
2953         'server',      'varchar', 'NULL',  64,              '', '',
2954         'community',   'varchar', 'NULL',  50,              '', '',
2955         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2956         'svcnum',          'int', 'NULL',  '',              '', '',
2957       ],
2958       'primary_key' => 'nasnum',
2959       'unique'      => [ [ 'nasname' ], ],
2960       'index'       => [],
2961     },
2962
2963     'export_nas' => {
2964       'columns' => [
2965         'exportnasnum', 'serial', '', '', '', '',
2966         'exportnum',       'int', '', '', '', '',
2967         'nasnum',          'int', '', '', '', '',
2968       ],
2969       'primary_key' => 'exportnasnum',
2970       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2971       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
2972     },
2973
2974     'queue' => {
2975       'columns' => [
2976         'jobnum',   'bigserial',     '',      '', '', '',
2977         'job',        'varchar',     '',     512, '', '',
2978         '_date',          'int',     '',      '', '', '',
2979         'status',     'varchar',     '', $char_d, '', '',
2980         'statustext',    'text', 'NULL',      '', '', '',
2981         'svcnum',         'int', 'NULL',      '', '', '',
2982         'custnum',        'int', 'NULL',      '', '', '',
2983         'secure',        'char', 'NULL',       1, '', '',
2984         'priority',       'int', 'NULL',      '', '', '',
2985         'usernum',        'int', 'NULL',      '', '', '',
2986       ],
2987       'primary_key' => 'jobnum',
2988       'unique'      => [],
2989       'index'       => [ [ 'secure' ], [ 'priority' ],
2990                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2991                        ],
2992     },
2993
2994     'queue_arg' => {
2995       'columns' => [
2996         'argnum', 'bigserial',     '', '', '', '',
2997         'jobnum',    'bigint',     '', '', '', '',
2998         'frozen',      'char', 'NULL',  1, '', '',
2999         'arg',         'text', 'NULL', '', '', '',
3000       ],
3001       'primary_key' => 'argnum',
3002       'unique'      => [],
3003       'index'       => [ [ 'jobnum' ] ],
3004     },
3005
3006     'queue_depend' => {
3007       'columns' => [
3008         'dependnum',  'bigserial', '', '', '', '',
3009         'jobnum',        'bigint', '', '', '', '',
3010         'depend_jobnum', 'bigint', '', '', '', '',
3011       ],
3012       'primary_key' => 'dependnum',
3013       'unique'      => [],
3014       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
3015     },
3016
3017     'queue_stat' => {
3018       'columns' => [
3019         'statnum', 'bigserial',     '',  '', '', '',
3020         'jobnum',     'bigint',     '',  '', '', '',
3021         'job',       'varchar',     '', 512, '', '',
3022         'custnum',       'int', 'NULL',  '', '', '',
3023         'insert_date', @date_type, '', '',
3024         'start_date',  @date_type, '', '',
3025         'end_date',    @date_type, '', '',
3026       ],
3027       'primary_key'  => 'statnum',
3028       'unique'       => [], #[ ['jobnum'] ],
3029       'index'        => [],
3030     },
3031
3032     'export_svc' => {
3033       'columns' => [
3034         'exportsvcnum' => 'serial', '', '', '', '',
3035         'exportnum'    => 'int', '', '', '', '',
3036         'svcpart'      => 'int', '', '', '', '',
3037         'role'         => 'varchar', 'NULL', 16, '', '',
3038       ],
3039       'primary_key' => 'exportsvcnum',
3040       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
3041       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
3042     },
3043
3044     'export_device' => {
3045       'columns' => [
3046         'exportdevicenum' => 'serial', '', '', '', '',
3047         'exportnum'    => 'int', '', '', '', '',
3048         'devicepart'      => 'int', '', '', '', '',
3049       ],
3050       'primary_key' => 'exportdevicenum',
3051       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
3052       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
3053     },
3054
3055     'part_export' => {
3056       'columns' => [
3057         'exportnum',   'serial',     '',      '', '', '',
3058         'exportname', 'varchar', 'NULL', $char_d, '', '',
3059         'machine',    'varchar', 'NULL', $char_d, '', '',
3060         'exporttype', 'varchar',     '', $char_d, '', '',
3061         'nodomain',      'char', 'NULL',       1, '', '',
3062         'default_machine','int', 'NULL',      '', '', '',
3063         'no_suspend',    'char', 'NULL',       1, '', '',
3064         # could also have 'no_insert', 'no_replace', etc.
3065       ],
3066       'primary_key' => 'exportnum',
3067       'unique'      => [],
3068       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
3069     },
3070
3071     'part_export_option' => {
3072       'columns' => [
3073         'optionnum', 'serial', '', '', '', '',
3074         'exportnum', 'int', '', '', '', '',
3075         'optionname', 'varchar', '', $char_d, '', '',
3076         'optionvalue', 'text', 'NULL', '', '', '',
3077       ],
3078       'primary_key' => 'optionnum',
3079       'unique'      => [],
3080       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
3081     },
3082
3083     'radius_usergroup' => {
3084       'columns' => [
3085         'usergroupnum', 'serial', '', '', '', '',
3086         'svcnum',       'int', '', '', '', '',
3087         'groupname',    'varchar', 'NULL', $char_d, '', '',
3088         'groupnum',     'int', 'NULL', '', '', '',
3089       ],
3090       'primary_key' => 'usergroupnum',
3091       'unique'      => [],
3092       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
3093     },
3094
3095     'radius_group' => {
3096       'columns' => [
3097         'groupnum', 'serial', '', '', '', '',
3098         'groupname',    'varchar', '', $char_d, '', '',
3099         'description',  'varchar', 'NULL', $char_d, '', '',
3100         'priority', 'int', '', '', '1', '',
3101         'speed_up', 'int', 'NULL', '', '', '',
3102         'speed_down', 'int', 'NULL', '', '', '',
3103       ],
3104       'primary_key' => 'groupnum',
3105       'unique'      => [ ['groupname'] ],
3106       'index'       => [],
3107     },
3108
3109     'radius_attr' => {
3110       'columns' => [
3111         'attrnum',   'serial', '',      '', '', '',
3112         'groupnum',     'int', '',      '', '', '',
3113         'attrname', 'varchar', '', $char_d, '', '',
3114         'value',    'varchar', '',     255, '', '',
3115         'attrtype',    'char', '',       1, '', '',
3116         'op',          'char', '',       2, '', '',
3117       ],
3118       'primary_key' => 'attrnum',
3119       'unique'      => [],
3120       'index'       => [ ['groupnum'], ],
3121     },
3122
3123     'msgcat' => {
3124       'columns' => [
3125         'msgnum', 'serial', '', '', '', '',
3126         'msgcode', 'varchar', '', 255, '', '',
3127         'locale', 'varchar', '', 16, '', '',
3128         'msg', 'text', '', '', '', '',
3129       ],
3130       'primary_key' => 'msgnum',
3131       'unique'      => [ [ 'msgcode', 'locale' ] ],
3132       'index'       => [],
3133     },
3134
3135     'cust_tax_exempt' => {
3136       'columns' => [
3137         'exemptnum', 'serial', '', '', '', '',
3138         'custnum',   'int', '', '', '', '',
3139         'taxnum',    'int', '', '', '', '',
3140         'year',      'int', '', '', '', '',
3141         'month',     'int', '', '', '', '',
3142         'amount',   @money_type, '', '',
3143       ],
3144       'primary_key' => 'exemptnum',
3145       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
3146       'index'       => [],
3147     },
3148
3149     'cust_tax_exempt_pkg' => {
3150       'columns' => [
3151         'exemptpkgnum',  'serial', '', '', '', '',
3152         #'custnum',      'int', '', '', '', ''
3153         'billpkgnum',   'int', '', '', '', '',
3154         'taxnum',       'int', '', '', '', '',
3155         'taxtype',  'varchar', 'NULL', $char_d, '', '',
3156         'year',         'int', 'NULL', '', '', '',
3157         'month',        'int', 'NULL', '', '', '',
3158         'creditbillpkgnum', 'int', 'NULL', '', '', '',
3159         'amount',       @money_type, '', '',
3160         # exemption type flags
3161         'exempt_cust',          'char', 'NULL', 1, '', '',
3162         'exempt_setup',         'char', 'NULL', 1, '', '',
3163         'exempt_recur',         'char', 'NULL', 1, '', '',
3164         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
3165         'exempt_monthly',       'char', 'NULL', 1, '', '',
3166       ],
3167       'primary_key' => 'exemptpkgnum',
3168       'unique' => [],
3169       'index'  => [ [ 'taxnum', 'year', 'month' ],
3170                     [ 'billpkgnum' ],
3171                     [ 'taxnum', 'taxtype' ],
3172                     [ 'creditbillpkgnum' ],
3173                   ],
3174     },
3175
3176     'cust_tax_exempt_pkg_void' => {
3177       'columns' => [
3178         'exemptpkgnum',  'int', '', '', '', '',
3179         #'custnum',      'int', '', '', '', ''
3180         'billpkgnum',   'int', '', '', '', '',
3181         'taxnum',       'int', '', '', '', '',
3182         'taxtype',  'varchar', 'NULL', $char_d, '', '',
3183         'year',         'int', 'NULL', '', '', '',
3184         'month',        'int', 'NULL', '', '', '',
3185         'creditbillpkgnum', 'int', 'NULL', '', '', '',
3186         'amount',       @money_type, '', '',
3187         # exemption type flags
3188         'exempt_cust',          'char', 'NULL', 1, '', '',
3189         'exempt_setup',         'char', 'NULL', 1, '', '',
3190         'exempt_recur',         'char', 'NULL', 1, '', '',
3191         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
3192         'exempt_monthly',       'char', 'NULL', 1, '', '',
3193       ],
3194       'primary_key' => 'exemptpkgnum',
3195       'unique' => [],
3196       'index'  => [ [ 'taxnum', 'year', 'month' ],
3197                     [ 'billpkgnum' ],
3198                     [ 'taxnum', 'taxtype' ],
3199                     [ 'creditbillpkgnum' ],
3200                   ],
3201     },
3202
3203     'router' => {
3204       'columns' => [
3205         'routernum', 'serial', '', '', '', '',
3206         'routername', 'varchar', '', $char_d, '', '',
3207         'svcnum', 'int', 'NULL', '', '', '',
3208         'agentnum',   'int', 'NULL', '', '', '',
3209         'manual_addr', 'char', 'NULL', 1, '', '',
3210       ],
3211       'primary_key' => 'routernum',
3212       'unique'      => [],
3213       'index'       => [],
3214     },
3215
3216     'part_svc_router' => {
3217       'columns' => [
3218         'svcrouternum', 'serial', '', '', '', '',
3219         'svcpart', 'int', '', '', '', '',
3220         'routernum', 'int', '', '', '', '',
3221       ],
3222       'primary_key' => 'svcrouternum',
3223       'unique'      => [],
3224       'index'       => [],
3225     },
3226
3227     'addr_block' => {
3228       'columns' => [
3229         'blocknum', 'serial', '', '', '', '',
3230         'routernum', 'int', '', '', '', '',
3231         'ip_gateway', 'varchar', '', 15, '', '',
3232         'ip_netmask', 'int', '', '', '', '',
3233         'agentnum',   'int', 'NULL', '', '', '',
3234         'manual_flag', 'char', 'NULL', 1, '', '',
3235       ],
3236       'primary_key' => 'blocknum',
3237       'unique'      => [ [ 'blocknum', 'routernum' ] ],
3238       'index'       => [],
3239     },
3240
3241     'addr_range' => {
3242       'columns' => [
3243         'rangenum', 'serial', '', '', '', '',
3244         'start',    'varchar', '', 15, '', '',
3245         'length',   'int', '', '', '', '',
3246         'status',   'varchar', 'NULL', 32, '', '',
3247       ],
3248       'primary_key' => 'rangenum',
3249       'unique'      => [],
3250       'index'       => [],
3251     },
3252
3253     'svc_broadband' => {
3254       'columns' => [
3255         'svcnum',                  'int',     '',        '', '', '',
3256         'description',         'varchar', 'NULL',   $char_d, '', '',
3257         'routernum',               'int', 'NULL',        '', '', '',
3258         'blocknum',                'int', 'NULL',        '', '', '',
3259         'sectornum',               'int', 'NULL',        '', '', '',
3260         'speed_up',                'int', 'NULL',        '', '', '',
3261         'speed_down',              'int', 'NULL',        '', '', '',
3262         'ip_addr',             'varchar', 'NULL',        15, '', '',
3263         'mac_addr',            'varchar', 'NULL',        12, '', '',
3264         'authkey',             'varchar', 'NULL',        32, '', '',
3265         'latitude',            'decimal', 'NULL',    '10,7', '', '',
3266         'longitude',           'decimal', 'NULL',    '10,7', '', '',
3267         'altitude',            'decimal', 'NULL',        '', '', '',
3268         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
3269         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
3270         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
3271         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
3272         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
3273         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
3274         'rssi',                    'int', 'NULL',        '', '', '',
3275         'suid',                    'int', 'NULL',        '', '', '',
3276         'shared_svcnum',           'int', 'NULL',        '', '', '',
3277         'serviceid',           'varchar', 'NULL',        64, '', '',#srvexport/reportfields
3278       ],
3279       'primary_key' => 'svcnum',
3280       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
3281       'index'       => [],
3282     },
3283
3284     'tower' => {
3285       'columns' => [
3286         'towernum',    'serial',     '',      '', '', '',
3287         #'agentnum',       'int', 'NULL',      '', '', '',
3288         'towername',  'varchar',     '', $char_d, '', '',
3289         'disabled',      'char', 'NULL',       1, '', '',
3290         'latitude',   'decimal', 'NULL',  '10,7', '', '',
3291         'longitude',  'decimal', 'NULL',  '10,7', '', '',
3292         'coord_auto',    'char', 'NULL',       1, '', '',
3293         'altitude',   'decimal', 'NULL',      '', '', '',
3294         'height',     'decimal', 'NULL',      '', '', '',
3295         'veg_height', 'decimal', 'NULL',      '', '', '',
3296         'color',      'varchar', 'NULL',       6, '', '',
3297       ],
3298       'primary_key' => 'towernum',
3299       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
3300       'index'       => [],
3301     },
3302
3303     'tower_sector' => {
3304       'columns' => [
3305         'sectornum',     'serial',     '',      '', '', '',
3306         'towernum',         'int',     '',      '', '', '',
3307         'sectorname',   'varchar',     '', $char_d, '', '',
3308         'ip_addr',      'varchar', 'NULL',      15, '', '',
3309         'height',       'decimal', 'NULL',      '', '', '',
3310         'freq_mhz',         'int', 'NULL',      '', '', '',
3311         'direction',        'int', 'NULL',      '', '', '',
3312         'width',            'int', 'NULL',      '', '', '',
3313         #downtilt etc? rfpath has profile files for devices/antennas you upload?
3314         'sector_range', 'decimal', 'NULL',      '', '', '',  #?
3315       ],
3316       'primary_key' => 'sectornum',
3317       'unique'      => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
3318       'index'       => [ [ 'towernum' ] ],
3319     },
3320
3321     'part_virtual_field' => {
3322       'columns' => [
3323         'vfieldpart', 'serial', '', '', '', '',
3324         'dbtable', 'varchar', '', 32, '', '',
3325         'name', 'varchar', '', 32, '', '',
3326         'length', 'int', 'NULL', '', '', '',
3327         'label', 'varchar', 'NULL', 80, '', '',
3328       ],
3329       'primary_key' => 'vfieldpart',
3330       'unique' => [],
3331       'index' => [],
3332     },
3333
3334     'virtual_field' => {
3335       'columns' => [
3336         'vfieldnum', 'serial', '', '', '', '',
3337         'recnum', 'int', '', '', '', '',
3338         'vfieldpart', 'int', '', '', '', '',
3339         'value', 'varchar', '', 128, '', '',
3340       ],
3341       'primary_key' => 'vfieldnum',
3342       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
3343       'index' => [],
3344     },
3345
3346     'acct_snarf' => {
3347       'columns' => [
3348         'snarfnum',    'serial',     '',      '', '', '',
3349         'snarfname',  'varchar', 'NULL', $char_d, '', '',
3350         'svcnum',         'int',     '',      '', '', '',
3351         'machine',    'varchar',     '',     255, '', '',
3352         'protocol',   'varchar',     '', $char_d, '', '',
3353         'username',   'varchar',     '', $char_d, '', '',
3354         '_password',  'varchar',     '', $char_d, '', '',
3355         'check_freq',     'int', 'NULL',      '', '', '',
3356         'leavemail',     'char', 'NULL',       1, '', '',
3357         'apop',          'char', 'NULL',       1, '', '',
3358         'tls',           'char', 'NULL',       1, '', '',
3359         'mailbox',    'varchar', 'NULL', $char_d, '', '',
3360       ],
3361       'primary_key' => 'snarfnum',
3362       'unique' => [],
3363       'index'  => [ [ 'svcnum' ] ],
3364     },
3365
3366     'svc_external' => {
3367       'columns' => [
3368         'svcnum',     'int',     '',      '', '', '',
3369         'id',      'bigint', 'NULL',      '', '', '',
3370         'title',  'varchar', 'NULL', $char_d, '', '',
3371       ],
3372       'primary_key' => 'svcnum',
3373       'unique'      => [],
3374       'index'       => [],
3375     },
3376
3377     'cust_pay_refund' => {
3378       'columns' => [
3379         'payrefundnum', 'serial', '', '', '', '',
3380         'paynum',  'int', '', '', '', '',
3381         'refundnum',  'int', '', '', '', '',
3382         '_date',    @date_type, '', '',
3383         'amount',   @money_type, '', '',
3384       ],
3385       'primary_key' => 'payrefundnum',
3386       'unique' => [],
3387       'index' => [ ['paynum'], ['refundnum'] ],
3388     },
3389
3390     'part_pkg_option' => {
3391       'columns' => [
3392         'optionnum', 'serial', '', '', '', '',
3393         'pkgpart', 'int', '', '', '', '',
3394         'optionname', 'varchar', '', $char_d, '', '',
3395         'optionvalue', 'text', 'NULL', '', '', '',
3396       ],
3397       'primary_key' => 'optionnum',
3398       'unique'      => [],
3399       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
3400     },
3401
3402     'part_pkg_vendor' => {
3403       'columns' => [
3404         'num', 'serial', '', '', '', '',
3405         'pkgpart', 'int', '', '', '', '',
3406         'exportnum', 'int', '', '', '', '',
3407         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
3408       ],
3409       'primary_key' => 'num',
3410       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
3411       'index'       => [ [ 'pkgpart' ] ],
3412     },
3413
3414     'part_pkg_report_option' => {
3415       'columns' => [
3416         'num',      'serial',   '',      '', '', '',
3417         'name',     'varchar',  '', $char_d, '', '',
3418         'disabled', 'char', 'NULL',       1, '', '',
3419       ],
3420       'primary_key' => 'num',
3421       'unique' => [ [ 'name' ] ],
3422       'index' => [ [ 'disabled' ] ],
3423     },
3424
3425     'part_pkg_usage' => {
3426       'columns' => [
3427         'pkgusagepart', 'serial',   '', '', '', '',
3428         'pkgpart',  'int',      '', '', '', '',
3429         'minutes',  'double precision',      '', '', '', '',
3430         'priority', 'int',  'NULL', '', '', '',
3431         'shared',   'char', 'NULL',  1, '', '',
3432         'rollover', 'char', 'NULL',  1, '', '',
3433         'description',  'varchar', 'NULL', $char_d, '', '',
3434       ],
3435       'primary_key' => 'pkgusagepart',
3436       'unique'      => [],
3437       'index'       => [ [ 'pkgpart' ] ],
3438     },
3439
3440     'part_pkg_usage_class' => {
3441       'columns' => [
3442         'num',       'serial',  '', '', '', '',
3443         'pkgusagepart', 'int',  '', '', '', '',
3444         'classnum',     'int','NULL', '', '', '',
3445       ],
3446       'primary_key' => 'num',
3447       'unique'      => [ [ 'pkgusagepart', 'classnum' ] ],
3448       'index'       => [],
3449     },
3450
3451     'part_pkg_fcc_option' => {
3452       'columns' => [
3453         'num',        'serial', '', '', '', '',
3454         'fccoptionname', 'varchar', '', $char_d, '', '',
3455         'pkgpart',       'int', '', '', '', '',
3456         'optionvalue',   'varchar', 'NULL', $char_d, '', '',
3457       ],
3458       'primary_key' => 'num',
3459       'unique'      => [ [ 'fccoptionname', 'pkgpart' ] ],
3460       'index'       => [],
3461     },
3462
3463     'rate' => {
3464       'columns' => [
3465         'ratenum',          'serial',     '', '', '', '',
3466         'ratename',        'varchar', '',$char_d, '', '',
3467         'agentnum',            'int', 'NULL', '', '', '',
3468         'default_detailnum',   'int', 'NULL', '', '', '',
3469       ],
3470       'primary_key' => 'ratenum',
3471       'unique'      => [],
3472       'index'       => [],
3473     },
3474
3475     'rate_detail' => {
3476       'columns' => [
3477         'ratedetailnum',   'serial',  '',     '',      '', '',
3478         'ratenum',         'int',     '',     '',      '', '',
3479         'orig_regionnum',  'int', 'NULL',     '',      '', '',
3480         'dest_regionnum',  'int', 'NULL',     '',      '', '',
3481         'min_included',    'int',     '',     '',      '', '',
3482         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
3483         'conn_cost',       'decimal', '', '10,4', '0.0000', '',
3484         'conn_sec',        'int',     '',     '',      '0', '',
3485         'min_charge',      'decimal', '', '10,5',       '', '',
3486         'min_cost',        'decimal', '', '10,5','0.00000', '',
3487         'sec_granularity', 'int',     '',     '',       '', '',
3488         'ratetimenum',     'int', 'NULL',     '',       '', '',
3489         'classnum',        'int', 'NULL',     '',       '', '',
3490         'cdrtypenum',      'int', 'NULL',     '',       '', '',
3491         'region_group',   'char', 'NULL',      1,       '', '',
3492         'upstream_mult_charge',  'decimal',  '', '10,4', '0.0000', '',
3493         'upstream_mult_cost',    'decimal',  '', '10,4', '0.0000', '',
3494       ],
3495       'primary_key' => 'ratedetailnum',
3496       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
3497       'index'       => [ [ 'ratenum', 'dest_regionnum' ],
3498                          [ 'ratenum', 'ratetimenum' ]
3499                        ],
3500     },
3501
3502     'rate_region' => {
3503       'columns' => [
3504         'regionnum',   'serial',      '', '', '', '',
3505         'regionname',  'varchar',     '', $char_d, '', '',
3506         'exact_match', 'char',    'NULL',  1, '', '',
3507       ],
3508       'primary_key' => 'regionnum',
3509       'unique'      => [],
3510       'index'       => [],
3511     },
3512
3513     'rate_prefix' => {
3514       'columns' => [
3515         'prefixnum',   'serial',      '', '', '', '',
3516         'regionnum',   'int',         '', '', '', '',
3517         'countrycode', 'varchar',     '',  3, '', '',
3518         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
3519         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
3520         'latanum',     'int',     'NULL',      '', '', '',
3521         'state',       'char',    'NULL',       2, '', '',
3522         'ocn',         'char',    'NULL',       4, '', '',
3523       ],
3524       'primary_key' => 'prefixnum',
3525       'unique'      => [],
3526       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
3527     },
3528
3529     'rate_time' => {
3530       'columns' => [
3531         'ratetimenum', 'serial',      '',      '', '', '',
3532         'ratetimename',   'varchar',      '', $char_d, '', '',
3533       ],
3534       'primary_key' => 'ratetimenum',
3535       'unique'      => [],
3536       'index'       => [],
3537     },
3538
3539     'rate_time_interval' => {
3540       'columns' => [
3541         'intervalnum', 'serial', '', '', '', '',
3542         'stime',          'int', '', '', '', '',
3543         'etime',          'int', '', '', '', '',
3544         'ratetimenum',    'int', '', '', '', '',
3545       ],
3546       'primary_key' => 'intervalnum',
3547       'unique'      => [],
3548       'index'       => [],
3549     },
3550
3551     #not really part of the above rate_ stuff (used with flat rate rather than
3552     # rated billing), but could be eventually, and its a rate
3553     'rate_tier' => {
3554       'columns' => [
3555         'tiernum',   'serial', '',      '', '', '',
3556         'tiername', 'varchar', '', $char_d, '', '',
3557       ],
3558       'primary_key' => 'tiernum',
3559       'unique'      => [ [ 'tiername'], ],
3560       'index'       => [],
3561     },
3562
3563     'rate_tier_detail' => {
3564       'columns' => [
3565         'tierdetailnum', 'serial', '',     '', '', '',
3566         'tiernum',          'int', '',     '', '', '',
3567         'min_quan',         'int', '',     '', '', '',
3568         'min_charge',   'decimal', '', '10,4', '', '',
3569       ],
3570       'primary_key' => 'tierdetailnum',
3571       'unique'      => [],
3572       'index'       => [ ['tiernum'], ],
3573     },
3574
3575     'usage_class' => {
3576       'columns' => [
3577         'classnum',    'serial',      '',      '', '', '',
3578         'weight',      'int',     'NULL',      '', '', '',
3579         'classname',   'varchar',     '', $char_d, '', '',
3580         'format',      'varchar', 'NULL', $char_d, '', '',
3581         'disabled',    'char',    'NULL',       1, '', '',
3582       ],
3583       'primary_key' => 'classnum',
3584       'unique' => [],
3585       'index' => [ ['disabled'] ],
3586     },
3587
3588     'reg_code' => {
3589       'columns' => [
3590         'codenum',   'serial',    '', '', '', '',
3591         'code',      'varchar',   '', $char_d, '', '',
3592         'agentnum',  'int',       '', '', '', '',
3593       ],
3594       'primary_key' => 'codenum',
3595       'unique'      => [ [ 'agentnum', 'code' ] ],
3596       'index'       => [ [ 'agentnum' ] ],
3597     },
3598
3599     'reg_code_pkg' => {
3600       'columns' => [
3601         'codepkgnum', 'serial', '', '', '', '',
3602         'codenum',   'int',    '', '', '', '',
3603         'pkgpart',   'int',    '', '', '', '',
3604       ],
3605       'primary_key' => 'codepkgnum',
3606       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
3607       'index'       => [ [ 'codenum' ] ],
3608     },
3609
3610     'clientapi_session' => {
3611       'columns' => [
3612         'sessionnum',  'serial',  '', '', '', '',
3613         'sessionid',  'varchar',  '', $char_d, '', '',
3614         'namespace',  'varchar',  '', $char_d, '', '',
3615       ],
3616       'primary_key' => 'sessionnum',
3617       'unique'      => [ [ 'sessionid', 'namespace' ] ],
3618       'index'       => [],
3619     },
3620
3621     'clientapi_session_field' => {
3622       'columns' => [
3623         'fieldnum',    'serial',     '', '', '', '',
3624         'sessionnum',     'int',     '', '', '', '',
3625         'fieldname',  'varchar',     '', $char_d, '', '',
3626         'fieldvalue',    'text', 'NULL', '', '', '',
3627       ],
3628       'primary_key' => 'fieldnum',
3629       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
3630       'index'       => [],
3631     },
3632
3633     'payment_gateway' => {
3634       'columns' => [
3635         'gatewaynum',       'serial',   '',     '', '', '',
3636         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
3637         'gateway_module',   'varchar',  '',     $char_d, '', '',
3638         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
3639         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
3640         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
3641         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
3642         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
3643         'disabled',   'char',  'NULL',   1, '', '',
3644       ],
3645       'primary_key' => 'gatewaynum',
3646       'unique' => [],
3647       'index'  => [ [ 'disabled' ] ],
3648     },
3649
3650     'payment_gateway_option' => {
3651       'columns' => [
3652         'optionnum',   'serial',  '',     '', '', '',
3653         'gatewaynum',  'int',     '',     '', '', '',
3654         'optionname',  'varchar', '',     $char_d, '', '',
3655         'optionvalue', 'text',    'NULL', '', '', '',
3656       ],
3657       'primary_key' => 'optionnum',
3658       'unique'      => [],
3659       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
3660     },
3661
3662     'agent_payment_gateway' => {
3663       'columns' => [
3664         'agentgatewaynum', 'serial', '', '', '', '',
3665         'agentnum',        'int', '', '', '', '',
3666         'gatewaynum',      'int', '', '', '', '',
3667         'cardtype',        'varchar', 'NULL', $char_d, '', '',
3668         'taxclass',        'varchar', 'NULL', $char_d, '', '',
3669       ],
3670       'primary_key' => 'agentgatewaynum',
3671       'unique'      => [],
3672       'index'       => [ [ 'agentnum', 'cardtype' ], ],
3673     },
3674
3675     'banned_pay' => {
3676       'columns' => [
3677         'bannum',  'serial',   '',     '', '', '',
3678         'payby',   'char',     '',       4, '', '',
3679         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
3680         #'paymask', 'varchar',  'NULL', $char_d, '', ''
3681         '_date',            @date_type,         '', '',
3682         'end_date',         @date_type,         '', '',
3683         'otaker',  'varchar',  'NULL',      32, '', '',
3684         'usernum',     'int',  'NULL',      '', '', '',
3685         'bantype', 'varchar',  'NULL', $char_d, '', '',
3686         'reason',  'varchar',  'NULL', $char_d, '', '',
3687       ],
3688       'primary_key' => 'bannum',
3689       'unique'      => [],
3690       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
3691     },
3692
3693     'pkg_category' => {
3694       'columns' => [
3695         'categorynum',        'serial',     '',      '', '', '',
3696         'categoryname',      'varchar',     '', $char_d, '', '',
3697         'weight',                'int', 'NULL',      '', '', '',
3698         'ticketing_queueid',     'int', 'NULL',      '', '', '',
3699         'condense',             'char', 'NULL',       1, '', '',
3700         'disabled',             'char', 'NULL',       1, '', '',
3701       ],
3702       'primary_key' => 'categorynum',
3703       'unique' => [],
3704       'index' => [ ['disabled'] ],
3705     },
3706
3707     'pkg_class' => {
3708       'columns' => [
3709         'classnum',    'serial',   '',      '', '', '',
3710         'classname',   'varchar',  '', $char_d, '', '',
3711         'categorynum', 'int',  'NULL',      '', '', '',
3712         'disabled',    'char', 'NULL',       1, '', '',
3713         'fcc_ds0s',      'int',     'NULL', '', '', '',
3714       ],
3715       'primary_key' => 'classnum',
3716       'unique' => [],
3717       'index' => [ ['disabled'] ],
3718     },
3719
3720     'cdr' => {
3721       'columns' => [
3722         # qw( name type null length default local );
3723
3724         ###
3725         #asterisk fields
3726         ###
3727
3728         'acctid',   'bigserial',  '', '', '', '',
3729         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
3730         'calldate', 'timestamp',   '',      '', \'now()', '',
3731         'clid',        'varchar',  '', $char_d, \"''", '',
3732         'src',         'varchar',  '', $char_d, \"''", '',
3733         'dst',         'varchar',  '', $char_d, \"''", '',
3734         'dcontext',    'varchar',  '', $char_d, \"''", '',
3735         'channel',     'varchar',  '', $char_d, \"''", '',
3736         'dstchannel',  'varchar',  '', $char_d, \"''", '',
3737         'lastapp',     'varchar',  '', $char_d, \"''", '',
3738         'lastdata',    'varchar',  '',     255, \"''", '',
3739
3740         #currently only opensips
3741         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
3742         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
3743
3744         #currently only u4:
3745         # terminating number (as opposed to dialed destination)
3746         'dst_term',    'varchar',  'NULL', $char_d, '', '',
3747
3748         #these don't seem to be logged by most of the SQL cdr_* modules
3749         #except tds under sql-illegal names, so;
3750         # ... don't rely on them for rating?
3751         # and, what they hey, i went ahead and changed the names and data types
3752         # to freeside-style dates...
3753           #'start',  'timestamp', 'NULL',  '',    '', '',
3754           #'answer', 'timestamp', 'NULL',  '',    '', '',
3755           #'end',    'timestamp', 'NULL',  '',    '', '',
3756         'startdate',  @date_type, '', '',
3757         'answerdate', @date_type, '', '',
3758         'enddate',    @date_type, '', '',
3759         #
3760
3761         'duration',    'int',      '',      '',     0, '',
3762         'billsec',     'int',      '',      '',     0, '',
3763         'disposition', 'varchar',  '',      45, \"''", '',
3764         'amaflags',    'int',      '',      '',     0, '',
3765         'accountcode', 'varchar',  '',      32, \"''", '',
3766         'uniqueid',    'varchar',  '', $char_d, \"''", '',
3767         'userfield',   'varchar',  '',     512, \"''", '',
3768
3769         'max_callers', 'int',  'NULL',      '',    '', '',
3770
3771         ###
3772         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
3773         # ones we adoped moved to "own fields" section below
3774         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
3775         ###
3776
3777         'upstream_currency',      'char', 'NULL',       3, '', '',
3778         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
3779
3780         # how it was rated internally...
3781         'ratedetailnum',           'int', 'NULL',      '', '', '',
3782
3783         'distance',            'decimal', 'NULL',      '', '', '',
3784         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
3785
3786         #cdr_calltype: the big list in appendix 2
3787         'calltypenum',             'int', 'NULL',      '', '', '',
3788
3789         'description',         'varchar', 'NULL', $char_d, '', '',
3790         'quantity',                'int', 'NULL',      '', '', '',
3791
3792         'upstream_rateid',         'int', 'NULL',      '', '', '',
3793
3794         ###
3795         # more fields, for GSM imports
3796         ###
3797         'servicecode',             'int', 'NULL',      '', '', '',
3798         'quantity_able',           'int', 'NULL',      '', '', '',
3799
3800         ###
3801         #and now for our own fields
3802         ###
3803
3804         'cdrtypenum',              'int', 'NULL',      '', '', '',
3805
3806         'charged_party',       'varchar', 'NULL', $char_d, '', '',
3807         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
3808
3809         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
3810         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
3811         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
3812
3813         # how it was rated internally...
3814         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
3815         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
3816         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
3817         'rated_seconds',              'int', 'NULL',      '', '', '',
3818         'rated_minutes', 'double precision', 'NULL',      '', '', '',
3819         'rated_granularity',          'int', 'NULL',      '', '', '',
3820         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
3821         'rated_classnum',             'int', 'NULL',      '', '', '',
3822         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
3823         'rated_cost',            'decimal', 'NULL',  '10,4', '', '',
3824
3825         'carrierid',               'bigint', 'NULL',      '', '', '',
3826
3827         # service it was matched to
3828         'svcnum',             'int',   'NULL',     '',   '', '',
3829
3830         #NULL, done (or something)
3831         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
3832
3833         #NULL, done (or something)
3834         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
3835
3836         #an indexed place to put big numbers
3837         'cdrid',         'bigint',     'NULL',     '',  '', '',
3838
3839         #for taqua accountcode rewriting, for starters
3840         'sessionnum',       'int',    'NULL',      '', '', '',
3841         'subscriber',   'varchar',    'NULL', $char_d, '', '',
3842
3843         #old
3844         'cdrbatch',     'varchar',    'NULL',     255, '', '',
3845         #new
3846         'cdrbatchnum',      'int',    'NULL',      '', '', '',
3847
3848         # FK to cust_bill_pkg_detail; having a value here absolutely means
3849         # that the CDR appears on an invoice
3850         'detailnum',     'bigint',    'NULL',      '', '', '',
3851       ],
3852       'primary_key' => 'acctid',
3853       'unique' => [],
3854       'index' => [ [ 'calldate' ],
3855                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
3856                    [ 'lastapp' ],
3857                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
3858                    [ 'sessionnum' ], [ 'subscriber' ],
3859                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
3860                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
3861                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ], [ 'dst_term' ],
3862                  ],
3863     },
3864
3865     'cdr_batch' => {
3866       'columns' => [
3867         'cdrbatchnum',   'serial',    '',   '', '', '',
3868         'cdrbatch', 'varchar', 'NULL', 255, '', '',
3869         '_date',     @date_type, '', '',
3870       ],
3871       'primary_key' => 'cdrbatchnum',
3872       'unique' => [ [ 'cdrbatch' ] ],
3873       'index' => [],
3874     },
3875
3876     'cdr_termination' => {
3877       'columns' => [
3878         'cdrtermnum', 'bigserial',     '',      '', '', '',
3879         'acctid',        'bigint',     '',      '', '', '',
3880         'termpart',         'int',     '',      '', '', '',#future use see below
3881         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
3882         'rated_seconds',    'int', 'NULL',      '', '', '',
3883         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3884         'status',       'varchar', 'NULL',      32, '', '',
3885         'svcnum',           'int', 'NULL',      '', '', '',
3886       ],
3887       'primary_key' => 'cdrtermnum',
3888       'unique'      => [ [ 'acctid', 'termpart' ] ],
3889       'index'       => [ [ 'acctid' ], [ 'status' ], ],
3890     },
3891
3892     #to handle multiple termination/settlement passes...
3893    # 'part_termination' => {
3894    #   'columns' => [
3895    #     'termpart',       'int', '',      '', '', '',
3896    #     'termname',   'varchar', '', $char_d, '', '',
3897    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
3898    #   ],
3899    #   'primary_key' => 'termpart',
3900    #   'unique' => [],
3901    #   'index'  => [],
3902    # },
3903
3904     #the remaining cdr_ tables are not really used
3905     'cdr_calltype' => {
3906       'columns' => [
3907         'calltypenum',   'serial',  '', '', '', '',
3908         'calltypename',  'varchar', '', $char_d, '', '',
3909       ],
3910       'primary_key' => 'calltypenum',
3911       'unique'      => [],
3912       'index'       => [],
3913     },
3914
3915     'cdr_type' => {
3916       'columns' => [
3917         'cdrtypenum'  => 'serial',  '', '', '', '',
3918         'cdrtypename' => 'varchar', '', $char_d, '', '',
3919       ],
3920       'primary_key' => 'cdrtypenum',
3921       'unique'      => [],
3922       'index'       => [],
3923     },
3924
3925     'cdr_carrier' => {
3926       'columns' => [
3927         'carrierid'   =>  'serial',     '',      '', '', '',
3928         'carriername' => 'varchar',     '', $char_d, '', '',
3929         'disabled'    =>    'char', 'NULL',       1, '', '',
3930       ],
3931       'primary_key' => 'carrierid',
3932       'unique'      => [],
3933       'index'       => [],
3934     },
3935
3936     #'cdr_file' => {
3937     #  'columns' => [
3938     #    'filenum',    'serial',     '', '', '', '',
3939     #    'filename',  'varchar',     '', '', '', '',
3940     #    'status',    'varchar', 'NULL', '', '', '',
3941     #  ],
3942     #  'primary_key' => 'filenum',
3943     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
3944     #                                   # agent-virtualize or have a customer
3945     #                                   # with dup-filename needs or something
3946     #                                   # (only used by cdr.http_and_import for
3947     #                                   #  chrissakes)
3948     #  'index'  => [],
3949     #},
3950
3951     'inventory_item' => {
3952       'columns' => [
3953         'itemnum',   'serial',      '',      '', '', '',
3954         'classnum',  'int',         '',      '', '', '',
3955         'agentnum',  'int',     'NULL',      '', '', '',
3956         'item',      'varchar',     '', $char_d, '', '',
3957         'svcnum',    'int',     'NULL',      '', '', '',
3958         'svc_field', 'varchar', 'NULL', $char_d, '', '',
3959       ],
3960       'primary_key' => 'itemnum',
3961       'unique' => [ [ 'classnum', 'item' ] ],
3962       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3963     },
3964
3965     'inventory_class' => {
3966       'columns' => [
3967         'classnum',  'serial',       '',      '', '', '',
3968         'classname', 'varchar',      '', $char_d, '', '',
3969       ],
3970       'primary_key' => 'classnum',
3971       'unique' => [],
3972       'index'  => [],
3973     },
3974
3975     'access_user_session' => {
3976       'columns' => [
3977         'sessionnum',   'serial',  '',      '', '', '',
3978         'sessionkey',  'varchar',  '', $char_d, '', '',
3979         'usernum',         'int',  '',      '', '', '',
3980         'start_date', @date_type,               '', '',
3981         'last_date',  @date_type,               '', '',
3982       ],
3983       'primary_key' => 'sessionnum',
3984       'unique' => [ [ 'sessionkey' ] ],
3985       'index'  => [],
3986     },
3987
3988     'access_user' => {
3989       'columns' => [
3990         'usernum',            'serial',      '',      '', '', '',
3991         'username',           'varchar',     '', $char_d, '', '',
3992         '_password',          'varchar',     '', $char_d, '', '',
3993         'last',               'varchar',     '', $char_d, '', '',
3994         'first',              'varchar',     '', $char_d, '', '',
3995         'user_custnum',           'int', 'NULL',      '', '', '',
3996         'report_salesnum',        'int', 'NULL',      '', '', '',
3997         'disabled',              'char', 'NULL',       1, '', '',
3998       ],
3999       'primary_key' => 'usernum',
4000       'unique' => [ [ 'username' ] ],
4001       'index'  => [ [ 'user_custnum' ] ],
4002     },
4003
4004     'access_user_pref' => {
4005       'columns' => [
4006         'prefnum',    'serial',       '', '', '', '',
4007         'usernum',     'int',       '', '', '', '',
4008         'prefname', 'varchar', '', $char_d, '', '',
4009         'prefvalue', 'text', 'NULL', '', '', '',
4010         'expiration', @date_type, '', '',
4011       ],
4012       'primary_key' => 'prefnum',
4013       'unique' => [],
4014       'index'  => [ [ 'usernum' ] ],
4015     },
4016
4017     'access_group' => {
4018       'columns' => [
4019         'groupnum',   'serial', '',      '', '', '',
4020         'groupname', 'varchar', '', $char_d, '', '',
4021       ],
4022       'primary_key' => 'groupnum',
4023       'unique' => [ [ 'groupname' ] ],
4024       'index'  => [],
4025     },
4026
4027     'access_usergroup' => {
4028       'columns' => [
4029         'usergroupnum', 'serial', '', '', '', '',
4030         'usernum',         'int', '', '', '', '',
4031         'groupnum',        'int', '', '', '', '',
4032       ],
4033       'primary_key' => 'usergroupnum',
4034       'unique' => [ [ 'usernum', 'groupnum' ] ],
4035       'index'  => [ [ 'usernum' ] ],
4036     },
4037
4038     'access_groupagent' => {
4039       'columns' => [
4040         'groupagentnum', 'serial', '', '', '', '',
4041         'groupnum',         'int', '', '', '', '',
4042         'agentnum',         'int', '', '', '', '',
4043       ],
4044       'primary_key' => 'groupagentnum',
4045       'unique' => [ [ 'groupnum', 'agentnum' ] ],
4046       'index'  => [ [ 'groupnum' ] ],
4047     },
4048
4049     'access_right' => {
4050       'columns' => [
4051         'rightnum',   'serial', '',      '', '', '',
4052         'righttype', 'varchar', '', $char_d, '', '',
4053         'rightobjnum',   'int', '',      '', '', '',
4054         'rightname', 'varchar', '', $char_d, '', '',
4055       ],
4056       'primary_key' => 'rightnum',
4057       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
4058       'index'  => [],
4059     },
4060
4061     'access_user_log' => {
4062       'columns'      => [
4063         'lognum',  'serial', '',        '', '', '',
4064         'usernum',    'int', '',        '', '', '',
4065         'path',   'varchar', '', 2*$char_d, '', '',
4066         '_date',         @date_type,        '', '',
4067       ],
4068       'primary_key'  => 'lognum',
4069       'unique'       => [],
4070       'index'        => [ ['usernum'], ['path'], ['_date'] ],
4071     },
4072
4073     'sched_item' => {
4074       'columns' => [
4075         'itemnum',   'serial',      '', '', '', '',
4076         'usernum',      'int',  'NULL', '', '', '',
4077         #'itemname', 'varchar', $char_d, '', '', '',
4078         'disabled',    'char',  'NULL',  1, '', '',
4079       ],
4080       'primary_key'  => 'itemnum',
4081       'unique'       => [ [ 'usernum' ] ],
4082       'index'        => [],
4083     },
4084
4085     #'sched_item_class'
4086
4087     'sched_avail' => {
4088       'columns' => [
4089         'availnum',      'serial', '', '', '', '',
4090         'itemnum',          'int', '', '', '', '',
4091         'wday',             'int', '', '', '', '',
4092         'stime',            'int', '', '', '', '',
4093         'etime',            'int', '', '', '', '',
4094         'override_date',    @date_type,    '', '',
4095       ],
4096       'primary_key'  => 'availnum',
4097       'unique'       => [],
4098       'index'        => [],
4099     },
4100
4101     'svc_phone' => {
4102       'columns' => [
4103         'svcnum',                         'int',     '',      '', '', '',
4104         'countrycode',                'varchar',     '',       3, '', '',
4105         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
4106         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
4107         'pin',                        'varchar', 'NULL', $char_d, '', '',
4108         'sip_password',               'varchar', 'NULL', $char_d, '', '',
4109         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
4110         'pbxsvc',                         'int', 'NULL',      '', '', '',
4111         'domsvc',                         'int', 'NULL',      '', '', '',
4112         'locationnum',                    'int', 'NULL',      '', '', '',
4113         'forwarddst',                 'varchar', 'NULL',      15, '', '',
4114         'email',                      'varchar', 'NULL',     255, '', '',
4115         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
4116         'portable',                      'char', 'NULL',       1, '', '',
4117         'lrn',                           'char', 'NULL',      10, '', '',
4118         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
4119         'lnp_due_date',                   'int', 'NULL',      '', '', '',
4120         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
4121         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
4122         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
4123         'sms_carrierid',                  'int', 'NULL',      '', '', '',
4124         'sms_account',                'varchar', 'NULL', $char_d, '', '',
4125         'max_simultaneous',               'int', 'NULL',      '', '', '',
4126         'e911_class',                    'char', 'NULL',       1, '', '',
4127         'e911_type',                     'char', 'NULL',       1, '', '',
4128         'circuit_svcnum',                 'int', 'NULL',      '', '', '',
4129         'sip_server',                 'varchar', 'NULL', $char_d, '', '',
4130       ],
4131       'primary_key' => 'svcnum',
4132       'unique' => [ [ 'sms_carrierid', 'sms_account'] ],
4133       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
4134                     ['locationnum'], ['sms_carrierid'],
4135                   ],
4136     },
4137
4138     'phone_device' => {
4139       'columns' => [
4140         'devicenum', 'serial',     '', '', '', '',
4141         'devicepart',   'int',     '', '', '', '',
4142         'svcnum',       'int',     '', '', '', '',
4143         'mac_addr', 'varchar', 'NULL', 12, '', '',
4144       ],
4145       'primary_key' => 'devicenum',
4146       'unique' => [ [ 'mac_addr' ], ],
4147       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
4148     },
4149
4150     'part_device' => {
4151       'columns' => [
4152         'devicepart', 'serial',  '',      '', '', '',
4153         'devicename', 'varchar', '', $char_d, '', '',
4154         'inventory_classnum', 'int', 'NULL', '', '', '',
4155         'title',      'varchar', 'NULL', $char_d, '', '',
4156       ],
4157       'primary_key' => 'devicepart',
4158       'unique' => [ [ 'devicename' ] ], #?
4159       'index'  => [],
4160     },
4161
4162     'phone_avail' => {
4163       'columns' => [
4164         'availnum',    'serial',      '',      '', '', '',
4165         'exportnum',   'int',         '',      '', '', '',
4166         'countrycode', 'varchar',     '',       3, '', '',
4167         'state',       'char',    'NULL',       2, '', '',
4168         'npa',         'char',        '',       3, '', '',
4169         'nxx',         'char',    'NULL',       3, '', '',
4170         'station',     'char',    'NULL',       4, '', '',
4171         'name',        'varchar', 'NULL', $char_d, '', '',
4172         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
4173         'latanum',      'int',     'NULL',      '', '', '',
4174         'msanum',       'int', 'NULL', '', '', '',
4175         'ordernum',      'int',     'NULL',      '', '', '',
4176         'svcnum',      'int',     'NULL',      '', '', '',
4177         'availbatch', 'varchar',  'NULL', $char_d, '', '',
4178       ],
4179       'primary_key' => 'availnum',
4180       'unique' => [],
4181       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
4182                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
4183                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
4184                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
4185                     [ 'svcnum' ],
4186                     [ 'availbatch' ],
4187                     [ 'latanum' ],
4188                   ],
4189     },
4190
4191     'lata' => {
4192       'columns' => [
4193         'latanum',    'int',      '',      '', '', '',
4194         'description',   'varchar',    '',      $char_d, '', '',
4195         'have_usage',   'int',    'NULL',      '', '', '',
4196       ],
4197       'primary_key' => 'latanum',
4198       'unique' => [],
4199       'index'  => [],
4200     },
4201
4202     'msa' => {
4203       'columns' => [
4204         'msanum',    'int',      '',      '', '', '',
4205         'description',   'varchar',    '',      $char_d, '', '',
4206       ],
4207       'primary_key' => 'msanum',
4208       'unique' => [],
4209       'index'  => [],
4210     },
4211
4212     'rate_center' => {
4213       'columns' => [
4214         'ratecenternum',    'serial',      '',      '', '', '',
4215         'description',   'varchar',    '',      $char_d, '', '',
4216       ],
4217       'primary_key' => 'ratecenternum',
4218       'unique' => [],
4219       'index'  => [],
4220     },
4221
4222     'did_vendor' => {
4223       'columns' => [
4224         'vendornum',    'serial',      '',      '', '', '',
4225         'vendorname',   'varchar',        '',     $char_d, '', '',
4226       ],
4227       'primary_key' => 'vendornum',
4228       'unique' => [],
4229       'index'  => [],
4230     },
4231
4232     'did_order_item' => {
4233       'columns' => [
4234         'orderitemnum',    'serial',      '',      '', '', '',
4235         'ordernum',    'int',      '',      '', '', '',
4236         'msanum',      'int',     'NULL',      '', '', '',
4237         'npa',      'int',     'NULL',      '', '', '',
4238         'latanum',      'int',     'NULL',      '', '', '',
4239         'ratecenternum',      'int',     'NULL',      '', '', '',
4240         'state',       'char',    'NULL',       2, '', '',
4241         'quantity',      'int',     '',      '', '', '',
4242         'custnum',   'int', 'NULL', '', '', '',
4243       ],
4244       'primary_key' => 'orderitemnum',
4245       'unique' => [],
4246       'index'  => [],
4247     },
4248
4249     'did_order' => {
4250       'columns' => [
4251         'ordernum',    'serial',      '',      '', '', '',
4252         'vendornum',   'int',       '',      '', '', '',
4253         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
4254         'custnum',   'int', 'NULL', '', '', '',
4255         'submitted',      'int',     '',      '', '', '',
4256         'confirmed',      'int',     'NULL',      '', '', '',
4257         'received',      'int',     'NULL',      '', '', '',
4258       ],
4259       'primary_key' => 'ordernum',
4260       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
4261       'index'  => [],
4262     },
4263
4264     'reason_type' => {
4265       'columns' => [
4266         'typenum',   'serial',  '', '', '', '',
4267         'class',     'char', '', 1, '', '',
4268         'type',     'varchar', '', $char_d, '', '',
4269       ],
4270       'primary_key' => 'typenum',
4271       'unique' => [],
4272       'index' => [],
4273     },
4274
4275     'reason' => {
4276       'columns' => [
4277         'reasonnum',     'serial',  '', '', '', '',
4278         'reason_type',   'int',  '', '', '', '',
4279         'reason',        'text', '', '', '', '',
4280         'disabled',      'char',    'NULL', 1, '', '',
4281         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
4282         'unsuspend_hold','char',    'NULL', 1, '', '',
4283         'unused_credit', 'char',    'NULL', 1, '', '',
4284         'feepart',        'int', 'NULL', '', '', '',
4285         'fee_on_unsuspend','char',  'NULL', 1, '', '',
4286         'fee_hold',      'char',    'NULL', 1, '', '',
4287       ],
4288       'primary_key' => 'reasonnum',
4289       'unique' => [],
4290       'index' => [],
4291     },
4292
4293     'conf' => {
4294       'columns' => [
4295         'confnum',  'serial',     '',      '', '', '',
4296         'agentnum', 'int',    'NULL',      '', '', '',
4297         'locale',   'varchar','NULL',      16, '', '',
4298         'name',     'varchar',    '', $char_d, '', '',
4299         'value',    'text',   'NULL',      '', '', '',
4300       ],
4301       'primary_key' => 'confnum',
4302       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
4303       'index' => [],
4304     },
4305
4306     'pkg_referral' => {
4307       'columns' => [
4308         'pkgrefnum',     'serial', '', '', '', '',
4309         'pkgnum',        'int',    '', '', '', '',
4310         'refnum',        'int',    '', '', '', '',
4311       ],
4312       'primary_key' => 'pkgrefnum',
4313       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
4314       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
4315     },
4316
4317     'svc_pbx' => {
4318       'columns' => [
4319         'svcnum',           'int',     '',      '', '', '',
4320         'id',               'int', 'NULL',      '', '', '',
4321         'uuid',            'char', 'NULL',      36, '', '',
4322         'title',        'varchar', 'NULL', $char_d, '', '',
4323         'max_extensions',   'int', 'NULL',      '', '', '',
4324         'max_simultaneous', 'int', 'NULL',      '', '', '',
4325         'ip_addr',      'varchar', 'NULL',      40, '', '',
4326       ],
4327       'primary_key' => 'svcnum',
4328       'unique' => [],
4329       'index'  => [ [ 'id' ], [ 'uuid' ] ],
4330     },
4331
4332     'pbx_extension' => {
4333       'columns' => [
4334         'extensionnum',  'serial',     '',      '', '', '',
4335         'svcnum',           'int',     '',      '', '', '',
4336         'extension',    'varchar',     '', $char_d, '', '',
4337         'pin',          'varchar', 'NULL', $char_d, '', '',
4338         'sip_password', 'varchar', 'NULL', $char_d, '', '',
4339         'phone_name',   'varchar', 'NULL', $char_d, '', '',
4340       ],
4341       'primary_key'  => 'extensionnum',
4342       'unique'       => [ [ 'svcnum', 'extension' ] ],
4343       'index'        => [ [ 'svcnum' ] ],
4344     },
4345
4346     'svc_mailinglist' => { #svc_group?
4347       'columns' => [
4348         'svcnum',            'int',     '',            '', '', '',
4349         'username',      'varchar',     '', $username_len, '', '',
4350         'domsvc',            'int',     '',            '', '', '',
4351         'listnum',           'int',     '',            '', '', '',
4352         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
4353         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
4354         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
4355         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
4356       ],
4357       'primary_key' => 'svcnum',
4358       'unique' => [],
4359       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
4360     },
4361
4362     'mailinglist' => {
4363       'columns' => [
4364         'listnum',   'serial', '',      '', '', '',
4365         'listname', 'varchar', '', $char_d, '', '',
4366       ],
4367       'primary_key' => 'listnum',
4368       'unique' => [],
4369       'index'  => [],
4370     },
4371
4372     'mailinglistmember' => {
4373       'columns' => [
4374         'membernum',        'serial',     '',   '', '', '',
4375         'listnum',             'int',     '',   '', '', '',
4376         'svcnum',              'int', 'NULL',   '', '', '',
4377         'contactemailnum',     'int', 'NULL',   '', '', '',
4378         'email',           'varchar', 'NULL',  255, '', '',
4379       ],
4380       'primary_key' => 'membernum',
4381       'unique'      => [],
4382       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
4383     },
4384
4385     'bill_batch' => {
4386       'columns' => [
4387         'batchnum',         'serial',     '',  '', '', '',
4388         'agentnum',            'int', 'NULL',  '', '', '',
4389         'status',             'char', 'NULL', '1', '', '',
4390         'pdf',                'blob', 'NULL',  '', '', '',
4391       ],
4392       'primary_key' => 'batchnum',
4393       'unique'      => [],
4394       'index'       => [ ['agentnum'] ],
4395     },
4396
4397     'cust_bill_batch' => {
4398       'columns' => [
4399         'billbatchnum',     'serial',     '', '', '', '',
4400         'batchnum',            'int',     '', '', '', '',
4401         'invnum',              'int',     '', '', '', '',
4402       ],
4403       'primary_key' => 'billbatchnum',
4404       'unique'      => [],
4405       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
4406     },
4407
4408     'cust_bill_batch_option' => {
4409       'columns' => [
4410         'optionnum', 'serial', '', '', '', '',
4411         'billbatchnum', 'int', '', '', '', '',
4412         'optionname', 'varchar', '', $char_d, '', '',
4413         'optionvalue', 'text', 'NULL', '', '', '',
4414       ],
4415       'primary_key' => 'optionnum',
4416       'unique'      => [],
4417       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
4418     },
4419
4420     'msg_template' => {
4421       'columns' => [
4422         'msgnum',     'serial',     '',      '', '', '',
4423         'msgname',   'varchar',     '', $char_d, '', '',
4424         'agentnum',      'int', 'NULL',      '', '', '',
4425         'subject',   'varchar', 'NULL',     512, '', '',
4426         'mime_type', 'varchar',     '', $char_d, '', '',
4427         'body',         'blob', 'NULL',      '', '', '',
4428         'disabled',     'char', 'NULL',       1, '', '',
4429         'from_addr', 'varchar', 'NULL',     255, '', '',
4430         'bcc_addr',  'varchar', 'NULL',     255, '', '',
4431       ],
4432       'primary_key' => 'msgnum',
4433       'unique'      => [ ],
4434       'index'       => [ ['agentnum'], ],
4435     },
4436
4437     'template_content' => {
4438       'columns' => [
4439         'contentnum', 'serial',     '',      '', '', '',
4440         'msgnum',        'int',     '',      '', '', '',
4441         'locale',    'varchar', 'NULL',      16, '', '',
4442         'subject',   'varchar', 'NULL',     512, '', '',
4443         'body',         'text', 'NULL',      '', '', '',
4444       ],
4445       'primary_key' => 'contentnum',
4446       'unique'      => [ ['msgnum', 'locale'] ],
4447       'index'       => [ ],
4448     },
4449
4450     'cust_msg' => {
4451       'columns' => [
4452         'custmsgnum', 'serial',     '',     '', '', '',
4453         'custnum',       'int', 'NULL',     '', '', '',
4454         'msgnum',        'int', 'NULL',     '', '', '',
4455         '_date',    @date_type,                 '', '',
4456         'env_from',  'varchar', 'NULL',    255, '', '',
4457         'env_to',    'varchar', 'NULL',    255, '', '',
4458         'header',       'blob', 'NULL',     '', '', '',
4459         'body',         'blob', 'NULL',     '', '', '',
4460         'error',     'varchar', 'NULL',    255, '', '',
4461         'status',    'varchar',     '',$char_d, '', '',
4462         'msgtype',   'varchar', 'NULL',     16, '', '',
4463       ],
4464       'primary_key' => 'custmsgnum',
4465       'unique'      => [ ],
4466       'index'       => [ ['custnum'], ],
4467     },
4468
4469     'svc_cert' => {
4470       'columns' => [
4471         'svcnum',                'int',     '',      '', '', '',
4472         'recnum',                'int', 'NULL',      '', '', '',
4473         'privatekey',           'text', 'NULL',      '', '', '',
4474         'csr',                  'text', 'NULL',      '', '', '',
4475         'certificate',          'text', 'NULL',      '', '', '',
4476         'cacert',               'text', 'NULL',      '', '', '',
4477         'common_name',       'varchar', 'NULL', $char_d, '', '',
4478         'organization',      'varchar', 'NULL', $char_d, '', '',
4479         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
4480         'city',              'varchar', 'NULL', $char_d, '', '',
4481         'state',             'varchar', 'NULL', $char_d, '', '',
4482         'country',              'char', 'NULL',       2, '', '',
4483         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
4484       ],
4485       'primary_key' => 'svcnum',
4486       'unique' => [],
4487       'index'  => [], #recnum
4488     },
4489
4490     'svc_port' => {
4491       'columns' => [
4492         'svcnum',                'int',     '',      '', '', '',
4493         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
4494       ],
4495       'primary_key' => 'svcnum',
4496       'unique' => [],
4497       'index'  => [], #recnum
4498     },
4499
4500     'areacode'  => {
4501       'columns' => [
4502         'areanum',   'serial',        '',      '', '', '',
4503         'code',        'char',        '',       3, '', '',
4504         'country',     'char',    'NULL',       2, '', '',
4505         'state',       'char',    'NULL',       2, '', '',
4506         'description','varchar',  'NULL',     255, '', '',
4507       ],
4508       'primary_key' => 'areanum',
4509       'unique' => [ [ 'areanum' ] ],
4510       'index'  => [],
4511     },
4512
4513     'upgrade_journal' => {
4514       'columns' => [
4515         'upgradenum', 'serial', '', '', '', '',
4516         '_date', 'int', '', '', '', '',
4517         'upgrade', 'varchar', '', $char_d, '', '',
4518         'status', 'varchar', '', $char_d, '', '',
4519         'statustext', 'varchar', 'NULL', $char_d, '', '',
4520       ],
4521       'primary_key' => 'upgradenum',
4522       'unique' => [],
4523       'index' => [ [ 'upgrade' ] ],
4524     },
4525
4526     'upload_target' => {
4527       'columns' => [
4528         'targetnum', 'serial', '', '', '', '',
4529         'agentnum', 'int', 'NULL', '', '', '',
4530         'protocol', 'varchar', '', 10, '', '',
4531         'hostname', 'varchar', '', $char_d, '', '',
4532         'port', 'int', 'NULL', '', '', '',
4533         'username', 'varchar', '', $char_d, '', '',
4534         'password', 'varchar', 'NULL', $char_d, '', '',
4535         'path', 'varchar', 'NULL', $char_d, '', '',
4536         'subject', 'varchar', 'NULL', '255', '', '',
4537         'handling', 'varchar', 'NULL', $char_d, '', '',
4538       ],
4539       'primary_key' => 'targetnum',
4540       'unique' => [ [ 'targetnum' ] ],
4541       'index' => [],
4542     },
4543
4544     'log' => {
4545       'columns' => [
4546         'lognum',     'serial', '', '', '', '',
4547         '_date',      'int', '', '', '', '',
4548         'agentnum',   'int', 'NULL', '', '', '',
4549         'tablename',  'varchar', 'NULL', $char_d, '', '',
4550         'tablenum',   'int',  'NULL', '', '', '',
4551         'level',      'int',  '', '', '', '',
4552         'message',    'text', '', '', '', '',
4553       ],
4554       'primary_key' => 'lognum',
4555       'unique'      => [],
4556       'index'       => [ ['_date'], ['level'] ],
4557     },
4558
4559     'log_context' => {
4560       'columns' => [
4561         'logcontextnum', 'serial', '', '', '', '',
4562         'lognum', 'int', '', '', '', '',
4563         'context', 'varchar', '', $char_d, '', '',
4564       ],
4565       'primary_key' => 'logcontextnum',
4566       'unique' => [ [ 'lognum', 'context' ] ],
4567       'index' => [],
4568     },
4569
4570     'svc_alarm' => {
4571       'columns' => [
4572 #       name               type        null   length   default local
4573         'svcnum',          'int',      '',    '',      '',     '',
4574         'alarmsystemnum',  'int',      '',    '',      '',     '',
4575         'alarmtypenum',    'int',      '',    '',      '',     '',
4576         'alarmstationnum', 'int',      '',    '',      '',     '',
4577         'acctnum',         'varchar',  '',    $char_d, '',     '',
4578         '_password',       'varchar',  '',    $char_d, '',     '',
4579         'location',        'varchar', 'NULL', $char_d, '',     '',
4580         'cs_receiver',     'int',     'NULL', '',      '',     '',
4581         'cs_phonenum',     'varchar', 'NULL', $char_d, '',     '',
4582         'serialnum',       'varchar', 'NULL', $char_d, '',     '',
4583         #installer (rep)
4584       ],
4585       'primary_key' => 'svcnum',
4586       'unique' => [],
4587       'index'  => [],
4588     },
4589
4590     'alarm_system' => { #vendors
4591       'columns' => [
4592         'alarmsystemnum',  'serial',     '',      '', '', '',
4593         'agentnum',           'int', 'NULL',      '', '', '',
4594         'systemname',     'varchar',     '', $char_d, '', '',
4595         'disabled',          'char', 'NULL',       1, '', '',
4596       ],
4597       'primary_key' => 'alarmsystemnum',
4598       'unique'      => [ ['agentnum', 'systemname'] ],
4599       'index'       => [ ['agentnum'], ['disabled'] ],
4600     },
4601
4602     'alarm_type' => { #inputs and outputs
4603       'columns' => [
4604         'alarmtypenum', 'serial',     '',      '', '', '',
4605         'agentnum',        'int', 'NULL',      '', '', '',
4606         'inputs',          'int',     '', '', '', '',
4607         'outputs',         'int',     '', '', '', '',
4608         'disabled',       'char', 'NULL',       1, '', '',
4609       ],
4610       'primary_key' => 'alarmtypenum',
4611       'unique'      => [ ['agentnum', 'inputs', 'outputs'] ],
4612       'index'       => [ ['agentnum'], ['disabled'] ],
4613     },
4614
4615     'alarm_station' => { #central station (where the alarm reports to)
4616       'columns' => [
4617         'alarmstationnum', 'serial',     '',      '', '', '',
4618         'agentnum',           'int', 'NULL',      '', '', '',
4619         'stationname',    'varchar',     '', $char_d, '', '',
4620         'disabled',          'char', 'NULL',       1, '', '',
4621       ],
4622       'primary_key' => 'alarmstationnum',
4623       'unique'      => [ ['agentnum', 'stationname'], ],
4624       'index'       => [ ['agentnum'], ['disabled'] ],
4625     },
4626
4627     'svc_cable' => {
4628       'columns' => [
4629         'svcnum',        'int',     '',      '', '', '',
4630         'providernum',   'int', 'NULL',      '', '', '',
4631         'ordernum',  'varchar', 'NULL', $char_d, '', '',
4632         'modelnum',      'int', 'NULL',      '', '', '',
4633         'serialnum', 'varchar', 'NULL', $char_d, '', '',
4634         'mac_addr',  'varchar', 'NULL',      12, '', '',
4635       ],
4636       'primary_key' => 'svcnum',
4637       'unique'       => [ ['serialnum'] , ['mac_addr'] ],
4638       'index'  => [],
4639     },
4640
4641     'cable_model' => {
4642       'columns' => [
4643         'modelnum',    'serial',     '',      '', '', '',
4644         'model_name', 'varchar',     '', $char_d, '', '',
4645         'disabled',      'char', 'NULL',       1, '', '',
4646       ],
4647       'primary_key' => 'modelnum',
4648       'unique' => [ [ 'model_name' ], ],
4649       'index'  => [],
4650     },
4651
4652     'cable_provider' => {
4653       'columns' => [
4654         'providernum', 'serial',     '',      '', '', '',
4655         'provider',   'varchar',     '', $char_d, '', '',
4656         'disabled',      'char', 'NULL',       1, '', '',
4657       ],
4658       'primary_key' => 'providernum',
4659       'unique' => [ [ 'provider' ], ],
4660       'index'  => [],
4661     },
4662
4663     'circuit_type' => {
4664       'columns' => [
4665         'typenum',     'serial',     '',      '', '', '',
4666         'typename',   'varchar',     '', $char_d, '', '',
4667         'disabled',      'char', 'NULL',       1, '', '',
4668         # speed? number of voice lines? anything else?
4669       ],
4670       'primary_key' => 'typenum',
4671       'unique' => [ [ 'typename' ] ],
4672       'index'  => [],
4673     },
4674
4675     'circuit_provider' => {
4676       'columns' => [
4677         'providernum', 'serial',     '',      '', '', '',
4678         'provider',   'varchar',     '', $char_d, '', '',
4679         'disabled',      'char', 'NULL',       1, '', '',
4680       ],
4681       'primary_key' => 'providernum',
4682       'unique' => [ [ 'provider' ], ],
4683       'index'  => [],
4684     },
4685
4686     'circuit_termination' => {
4687       'columns' => [
4688         'termnum',     'serial',     '',      '', '', '',
4689         'termination','varchar',     '', $char_d, '', '',
4690         'disabled',      'char', 'NULL',       1, '', '',
4691       ],
4692       'primary_key' => 'termnum',
4693       'unique' => [ [ 'termination' ] ],
4694       'index' => [],
4695     },
4696
4697     'svc_circuit' => {
4698       'columns' => [
4699         'svcnum',                   'int',     '', '', '', '',
4700         'typenum',                  'int',     '', '', '', '',
4701         'providernum',              'int',     '', '', '', '',
4702         'termnum',                  'int',     '', '', '', '',
4703         'circuit_id',           'varchar',     '', 64, '', '',
4704         'desired_due_date',         'int', 'NULL', '', '', '',
4705         'due_date',                 'int', 'NULL', '', '', '',
4706         'vendor_order_id',      'varchar', 'NULL', $char_d,  '', '',
4707         'vendor_qual_id',       'varchar', 'NULL', $char_d,  '', '',
4708         'vendor_order_type',    'varchar', 'NULL', $char_d,  '', '',
4709         'vendor_order_status',  'varchar', 'NULL', $char_d,  '', '',
4710         'endpoint_ip_addr',     'varchar', 'NULL', 40, '', '',
4711         'endpoint_mac_addr',    'varchar', 'NULL', 12, '', '',
4712       ],
4713       'primary_key' => 'svcnum',
4714       'unique'      => [],
4715       'index'       => [ [ 'providernum' ], [ 'typenum' ] ],
4716     },
4717
4718     'svc_fiber' => {
4719       'columns' => [
4720         'svcnum',         'int',     '',      '', '', '',
4721         'oltnum',         'int', 'NULL',      '', '', '',
4722         'shelf',          'int', 'NULL',      '', '', '',
4723         'card',           'int', 'NULL',      '', '', '',
4724         'olt_port',       'int', 'NULL',      '', '', '',
4725         'ont_id',         'int', 'NULL',      '', '', '',
4726         'ont_typenum',    'int', 'NULL',      '', '', '',
4727         'ont_serial', 'varchar', 'NULL', $char_d, '', '',
4728         'ont_port',   'varchar', 'NULL',      16, '', '',
4729         'vlan',           'int', 'NULL',      '', '', '',
4730         'signal',         'int', 'NULL',      '', '', '',
4731         'speed_up',       'int', 'NULL',      '', '', '',
4732         'speed_down',     'int', 'NULL',      '', '', '',
4733         'ont_install','varchar', 'NULL', $char_d, '', '',
4734       ],
4735       'primary_key' => 'svcnum',
4736       'unique'      => [ ],
4737       'index'       => [ [ 'ont_serial' ] ],
4738     },
4739
4740     'fiber_olt' => {
4741       'columns' => [
4742         'oltnum',   'serial', '',       '', '', '',
4743         'oltname', 'varchar', '',  $char_d, '', '',
4744         'serial',  'varchar', '',  $char_d, '', '',
4745         'disabled',   'char', 'NULL',    1, '', '',
4746       ],
4747       'primary_key' => 'oltnum',
4748       'unique' => [ ],
4749       'index'  => [ ],
4750     },
4751
4752     'vend_main' => {
4753       'columns' => [
4754         'vendnum',   'serial',     '',      '', '', '',
4755         'vendname', 'varchar',     '', $char_d, '', '',
4756         'classnum',     'int',     '',      '', '', '',
4757         'disabled',    'char', 'NULL',       1, '', '',
4758       ],
4759       'primary_key'  => 'vendnum',
4760       'unique'       => [ ['vendname', 'disabled'] ],
4761       'index'        => [],
4762       'foreign_keys' => [
4763                           { columns    => [ 'classnum' ],
4764                             table      => 'vend_class',
4765                           },
4766                         ],
4767     },
4768
4769     'vend_class' => {
4770       'columns' => [
4771         'classnum',     'serial',     '',      '', '', '',
4772         'classname',   'varchar',     '', $char_d, '', '',
4773         'disabled',       'char', 'NULL',       1, '', '',
4774       ],
4775       'primary_key' => 'classnum',
4776       'unique'      => [],
4777       'index'       => [ ['disabled'] ],
4778     },
4779
4780     'vend_bill' => {
4781       'columns' => [
4782         'vendbillnum',    'serial',     '',      '', '', '',
4783         'vendnum',           'int',     '',      '', '', '',
4784         #'_date',        @date_type,                  '', '',
4785         '_date',     'int', '', '',                   '', '',
4786         'charged',     @money_type,                  '', '',
4787       ],
4788       'primary_key'  => 'vendbillnum',
4789       'unique'       => [],
4790       'index'        => [ ['vendnum'], ['_date'], ],
4791       'foreign_keys' => [
4792                           { columns    => [ 'vendnum' ],
4793                             table      => 'vend_main',
4794                           },
4795                         ],
4796     },
4797
4798     'vend_pay' => {
4799       'columns' => [
4800         'vendpaynum',   'serial',    '',       '', '', '',
4801         'vendnum',         'int',    '',       '', '', '',
4802         #'_date',     @date_type,                   '', '',
4803         '_date',     'int', '', '',                   '', '',
4804         'paid',      @money_type,                  '', '',
4805       ],
4806       'primary_key'  => 'vendpaynum',
4807       'unique'       => [],
4808       'index'        => [ [ 'vendnum' ], [ '_date' ], ],
4809       'foreign_keys' => [
4810                           { columns    => [ 'vendnum' ],
4811                             table      => 'vend_main',
4812                           },
4813                         ],
4814     },
4815
4816     'vend_bill_pay' => {
4817       'columns' => [
4818         'vendbillpaynum', 'serial',     '',   '', '', '',
4819         'vendbillnum',       'int',     '',   '', '', '',
4820         'vendpaynum',        'int',     '',   '', '', '',
4821         'amount',  @money_type, '', '',
4822         #? '_date',   @date_type, '', '',
4823       ],
4824       'primary_key'  => 'vendbillpaynum',
4825       'unique'       => [],
4826       'index'        => [ [ 'vendbillnum' ], [ 'vendpaynum' ] ],
4827       'foreign_keys' => [
4828                           { columns    => [ 'vendbillnum' ],
4829                             table      => 'vend_bill',
4830                           },
4831                           { columns    => [ 'vendpaynum' ],
4832                             table      => 'vend_pay',
4833                           },
4834                         ],
4835     },
4836     %{ tables_hashref_torrus() },
4837
4838     # tables of ours for doing torrus virtual port combining
4839     'torrus_srvderive' => {
4840       'columns' => [
4841         'derivenum',     'serial',     '', '', '', '',
4842         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
4843         'last_srv_date',   'date', 'NULL', '', '', '',
4844       ],
4845       'primary_key' => 'derivenum',
4846       'unique' => [ ['serviceid'] ],
4847       'index'  => [],
4848     },
4849
4850     'torrus_srvderive_component' => {
4851       'columns' => [
4852         'componentnum', 'serial', '', '', '', '',
4853         'derivenum',       'int', '', '', '', '',
4854         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
4855       ],
4856       'primary_key' => 'componentnum',
4857       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
4858       'index'       => [ [ 'derivenum', ], ],
4859     },
4860
4861     'invoice_mode' => {
4862       'columns' => [
4863         'modenum',      'serial', '', '', '', '',
4864         'agentnum',        'int', 'NULL', '', '', '',
4865         'modename',    'varchar', '', 32, '', '',
4866       ],
4867       'primary_key' => 'modenum',
4868       'unique'      => [ ],
4869       'index'       => [ ],
4870     },
4871
4872     'invoice_conf' => {
4873       'columns' => [
4874         'confnum',              'serial',   '', '', '', '',
4875         'modenum',              'int',      '', '', '', '',
4876         'locale',               'varchar',  'NULL', 16, '', '',
4877         'notice_name',          'varchar',  'NULL', 64, '', '',
4878         'subject',              'varchar',  'NULL', 64, '', '',
4879         'htmlnotes',            'text',     'NULL', '', '', '',
4880         'htmlfooter',           'text',     'NULL', '', '', '',
4881         'htmlsummary',          'text',     'NULL', '', '', '',
4882         'htmlreturnaddress',    'text',     'NULL', '', '', '',
4883         'latexnotes',           'text',     'NULL', '', '', '',
4884         'latexfooter',          'text',     'NULL', '', '', '',
4885         'latexsummary',         'text',     'NULL', '', '', '',
4886         'latexsmallfooter',     'text',     'NULL', '', '', '',
4887         'latexreturnaddress',   'text',     'NULL', '', '', '',
4888         'with_latexcoupon',     'char',     'NULL', '1', '', '',
4889         'htmlwatermark',        'text',     'NULL', '', '', '',
4890         'latexwatermark',       'text',     'NULL', '', '', '',
4891         'lpr',                  'varchar',  'NULL', $char_d, '', '',
4892       ],
4893       'primary_key' => 'confnum',
4894       'unique' => [ [ 'modenum', 'locale' ] ],
4895       'index'  => [ ],
4896     },
4897
4898     'export_batch' => {
4899       'columns' => [
4900         'batchnum',    'serial',     '',      '', '', '',
4901         'exportnum',      'int',     '',      '', '', '',
4902         '_date',          'int',     '',      '', '', '',
4903         'status',     'varchar', 'NULL',      32, '', '',
4904         'statustext',    'text', 'NULL',      '', '', '',
4905       ],
4906       'primary_key'  => 'batchnum',
4907       'unique'       => [],
4908       'index'        => [ [ 'exportnum' ], [ 'status' ] ],
4909     },
4910
4911     'export_batch_item' => {
4912       'columns' => [
4913         'itemnum',     'serial',     '',      '', '', '',
4914         'batchnum',       'int',     '',      '', '', '',
4915         'svcnum',         'int',     '',      '', '', '',
4916         'action',     'varchar',     '',      32, '', '',
4917         'data',          'text', 'NULL',      '', '', '',
4918         'frozen',        'char', 'NULL',       1, '', '',
4919       ],
4920       'primary_key'  => 'itemnum',
4921       'unique'       => [],
4922       'index'        => [ [ 'batchnum' ], [ 'svcnum' ] ],
4923     },
4924
4925     # lookup table for states, similar to msa and lata
4926     'state' => {
4927       'columns' => [
4928         'statenum', 'int',  '', '', '', '',
4929         'country',  'char', '',  2, '', '',
4930         'state',    'char', '', $char_d, '', '',
4931         'fips',     'char', '',  3, '', '',
4932       ],
4933       'primary_key' => 'statenum',
4934       'unique' => [ [ 'country', 'state' ], ],
4935       'index' => [],
4936     },
4937
4938     # eventually link to tower/sector?
4939     'deploy_zone' => {
4940       'columns' => [
4941         'zonenum',        'serial',  '',     '',      '', '',
4942         'description',    'char',    'NULL', $char_d, '', '',
4943         'agentnum',       'int',     '',     '',      '', '',
4944         'censusyear',     'char',    'NULL', 4,      '', '',
4945         'dbaname',        'char',    'NULL', $char_d, '', '',
4946         'zonetype',       'char',    '',     1,       '', '',
4947         'technology',     'int',     '',     '',      '', '',
4948         'spectrum',       'int',     'NULL', '',      '', '',
4949         'adv_speed_up',   'decimal', '',     '10,3', '0', '',
4950         'adv_speed_down', 'decimal', '',     '10,3', '0', '',
4951         'cir_speed_up',   'decimal', '',     '10,3', '0', '',
4952         'cir_speed_down', 'decimal', '',     '10,3', '0', '',
4953         'is_broadband',   'char',    'NULL', 1,       '', '',
4954         'is_voice',       'char',    'NULL', 1,       '', '',
4955         'is_consumer',    'char',    'NULL', 1,       '', '',
4956         'is_business',    'char',    'NULL', 1,       '', '',
4957         'active_date',    @date_type,                 '', '',
4958         'expire_date',    @date_type,                 '', '',
4959       ],
4960       'primary_key' => 'zonenum',
4961       'unique' => [],
4962       'index'  => [ [ 'agentnum' ] ],
4963     },
4964
4965     'deploy_zone_block' => {
4966       'columns' => [
4967         'blocknum',       'serial',  '',     '',      '', '',
4968         'zonenum',        'int',     '',     '',      '', '',
4969         'censusblock',    'char',    '',     15,      '', '',
4970         'censusyear',     'char','NULL',      4,      '', '',
4971       ],
4972       'primary_key' => 'blocknum',
4973       'unique' => [],
4974       'index'  => [ [ 'zonenum' ] ],
4975     },
4976
4977     'deploy_zone_vertex' => {
4978       'columns' => [
4979         'vertexnum',      'serial',  '',     '',      '', '',
4980         'zonenum',        'int',     '',     '',      '', '',
4981         'latitude',       'decimal', '',     '10,7',  '', '',
4982         'longitude',      'decimal', '',     '10,7',  '', '',
4983       ],
4984       'primary_key' => 'vertexnum',
4985       'unique' => [ ],
4986       'index'  => [ ],
4987     },
4988
4989     'cacti_page' => {
4990       'columns' => [
4991         'cacti_pagenum',  'serial',   '',     '', '', '',
4992         'exportnum',      'int',      'NULL', '', '', '',
4993         'svcnum',         'int',      'NULL', '', '', '',
4994         'graphnum',       'int',      'NULL', '', '', '',
4995         'imported',       @date_type,             '', '',
4996         'content',        'text',     'NULL', '', '', '',
4997       ],
4998       'primary_key' => 'cacti_pagenum',
4999       'unique'  => [ ],
5000       'index'   => [ ['svcnum'], ['imported'] ],
5001     },
5002
5003     'report_batch' => {
5004       'columns' => [
5005         'reportbatchnum', 'serial',      '',  '', '', '',
5006         'reportname',     'varchar',     '', 255, '', '',
5007         'agentnum',           'int', 'NULL',  '', '', '',
5008         'send_date',     @date_type,              '', '',
5009         'sdate',         @date_type,              '', '',
5010         'edate',         @date_type,              '', '',
5011         'usernum',            'int', 'NULL',  '', '', '',
5012         'msgnum',             'int', 'NULL',  '', '', '',
5013         # add report params here as necessary
5014       ],
5015       'primary_key' => 'reportbatchnum',
5016       'unique' => [],
5017       'index'  => [],
5018       'foreign_keys' => [
5019                           { columns    => [ 'agentnum' ],
5020                             table      => 'agent',
5021                             references => [ 'agentnum' ],
5022                           },
5023                           { columns    => [ 'usernum' ],
5024                             table      => 'access_user',
5025                             references => [ 'usernum' ],
5026                           },
5027                           { columns    => [ 'msgnum' ],
5028                             table      => 'msg_template',
5029                             references => [ 'msgnum' ],
5030                           },
5031                         ],
5032     },
5033
5034     'password_history' => {
5035       'columns' => [
5036         'passwordnum',        'serial',  '',          '', '', '',
5037         '_password',          'varchar', 'NULL', $char_d, '', '',
5038         'encryption_method',  'varchar', 'NULL', $char_d, '', '',
5039         'created',   @date_type,   '', '',
5040         # each table that needs password history gets a column here, and
5041         # an entry in foreign_keys.
5042         'svc_acct__svcnum',     'int', 'NULL', '', '', '',
5043         'svc_dsl__svcnum',      'int', 'NULL', '', '', '',
5044         'svc_alarm__svcnum',    'int', 'NULL', '', '', '',
5045         'agent__agentnum',      'int', 'NULL', '', '', '',
5046         'contact__contactnum',  'int', 'NULL', '', '', '',
5047         'access_user__usernum', 'int', 'NULL', '', '', '',
5048       ],
5049       'primary_key' => 'passwordnum',
5050       'unique' => [],
5051       'index'  => [],
5052       'foreign_keys' => [
5053                           { columns     => [ 'svc_acct__svcnum' ],
5054                             table       => 'svc_acct',
5055                             references  => [ 'svcnum' ],
5056                           },
5057                           { columns     => [ 'svc_dsl__svcnum' ],
5058                             table       => 'svc_dsl',
5059                             references  => [ 'svcnum' ],
5060                           },
5061                           { columns     => [ 'svc_alarm__svcnum' ],
5062                             table       => 'svc_alarm',
5063                             references  => [ 'svcnum' ],
5064                           },
5065                           { columns    => [ 'agent__agentnum' ],
5066                             table      => 'agent',
5067                             references => [ 'agentnum' ],
5068                           },
5069                           { columns    => [ 'contact__contactnum' ],
5070                             table      => 'contact',
5071                             references => [ 'contactnum' ],
5072                           },
5073                           { columns    => [ 'access_user__usernum' ],
5074                             table      => 'access_user',
5075                             references => [ 'usernum' ],
5076                           },
5077                         ],
5078     },
5079
5080     # name type nullability length default local
5081
5082     #'new_table' => {
5083     #  'columns' => [
5084     #    'num', 'serial',       '', '', '', '',
5085     #  ],
5086     #  'primary_key' => 'num',
5087     #  'unique' => [],
5088     #  'index'  => [],
5089     #},
5090
5091   };
5092
5093 }
5094
5095 =back
5096
5097 =head1 BUGS
5098
5099 =head1 SEE ALSO
5100
5101 L<DBIx::DBSchema>
5102
5103 =cut
5104
5105 1;
5106