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       ],
1393       'primary_key'  => 'detailnum',
1394       'unique'       => [],
1395       'index'        => [ [ 'quotationpkgnum' ] ],
1396       'foreign_keys' => [
1397                           { columns    => [ 'quotationpkgnum' ],
1398                             table      => 'quotation_pkg',
1399                             references => [ 'quotationpkgnum' ],
1400                           },
1401                         ],
1402     },
1403
1404     'quotation_pkg_discount' => {
1405       'columns' => [
1406         'quotationpkgdiscountnum', 'serial', '', '', '', '',
1407         'quotationpkgnum',            'int', '', '', '', '',
1408         'discountnum',                'int', '', '', '', '',
1409         'setup_amount',        @money_typen,         '', '',
1410         'recur_amount',        @money_typen,         '', '',
1411         #'end_date',              @date_type,         '', '',
1412       ],
1413       'primary_key' => 'quotationpkgdiscountnum',
1414       'unique' => [],
1415       'index'  => [ [ 'quotationpkgnum' ], ], #[ 'discountnum' ] ],
1416     },
1417
1418     'quotation_pkg_tax' => {
1419       'columns' => [
1420         'quotationtaxnum',  'serial',     '',      '', '', '',
1421         'quotationpkgnum',     'int',     '',      '', '', '',
1422         'itemdesc',        'varchar',     '', $char_d, '', '',
1423         'taxnum',              'int',     '',      '', '', '',
1424         'taxtype',         'varchar',     '', $char_d, '', '',
1425         'setup_amount',    @money_type,                '', '',
1426         'recur_amount',    @money_type,                '', '',
1427       ],
1428       'primary_key' => 'quotationtaxnum',,
1429       'unique' => [],
1430       'index'  => [ [ 'quotationpkgnum' ] ],
1431     },
1432
1433     'cust_location' => { #'location' now that its prospects too, but...
1434       'columns' => [
1435         'locationnum',      'serial',     '',      '', '', '',
1436         'prospectnum',         'int', 'NULL',      '', '', '',
1437         'custnum',             'int', 'NULL',      '', '', '',
1438         'locationname',    'varchar', 'NULL', $char_d, '', '',
1439         'address1',        'varchar',     '', $char_d, '', '',
1440         'address2',        'varchar', 'NULL', $char_d, '', '',
1441         'city',            'varchar', 'NULL', $char_d, '', '',
1442         'county',          'varchar', 'NULL', $char_d, '', '',
1443         'state',           'varchar', 'NULL', $char_d, '', '',
1444         'zip',             'varchar', 'NULL',      10, '', '',
1445         'latitude',        'decimal', 'NULL',  '10,7', '', '',
1446         'longitude',       'decimal', 'NULL',  '10,7', '', '',
1447         'coord_auto',         'char', 'NULL',       1, '', '',
1448         'addr_clean',         'char', 'NULL',       1, '', '',
1449         'country',            'char',     '',       2, '', '',
1450         'geocode',         'varchar', 'NULL',      20, '', '',
1451         'district',        'varchar', 'NULL',      20, '', '',
1452         'censustract',     'varchar', 'NULL',      20, '', '',
1453         'censusyear',         'char', 'NULL',       4, '', '',
1454         'location_type',   'varchar', 'NULL',      20, '', '',
1455         'location_number', 'varchar', 'NULL',      20, '', '',
1456         'location_kind',      'char', 'NULL',       1, '', '',
1457         'disabled',           'char', 'NULL',       1, '', '',
1458       ],
1459       'primary_key' => 'locationnum',
1460       'unique'      => [],
1461       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1462                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1463                          [ 'city' ], [ 'district' ]
1464                        ],
1465     },
1466
1467     'cust_main_invoice' => {
1468       'columns' => [
1469         'destnum',  'serial',  '',     '', '', '',
1470         'custnum',  'int',  '',     '', '', '',
1471         'dest',     'varchar', '',  $char_d, '', '',
1472       ],
1473       'primary_key' => 'destnum',
1474       'unique' => [],
1475       'index' => [ ['custnum'], ],
1476     },
1477
1478     'cust_main_credit_limit' => {
1479       'columns' => [
1480         'creditlimitnum',   'serial', '', '', '', '',
1481         'custnum',             'int', '', '', '', '',
1482         '_date',          @date_type,         '', '',
1483         'amount',       @money_typen,         '', '',
1484         #'amount_currency', 'char', 'NULL',  3, '', '',
1485         'credit_limit', @money_typen,         '', '',
1486         #'credit_limit_currency', 'char', 'NULL',  3, '', '',
1487       ],
1488       'primary_key'  => 'creditlimitnum',
1489       'unique'       => [],
1490       'index'        => [ ['custnum'], ],
1491     },
1492
1493     'cust_main_note' => {
1494       'columns' => [
1495         'notenum',   'serial',    '',  '', '', '',
1496         'custnum',      'int',    '',  '', '', '',
1497         'classnum',     'int', 'NULL', '', '', '',
1498         '_date',          @date_type,      '', '',
1499         'otaker',   'varchar', 'NULL', 32, '', '',
1500         'usernum',      'int', 'NULL', '', '', '',
1501         'comments',    'text', 'NULL', '', '', '',
1502         'sticky',       'int',     '', '',  0, '',
1503       ],
1504       'primary_key' => 'notenum',
1505       'unique' => [],
1506       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1507     },
1508
1509     'cust_note_class' => {
1510       'columns' => [
1511         'classnum',    'serial',   '',      '', '', '',
1512         'classname',   'varchar',  '', $char_d, '', '',
1513         'disabled',    'char', 'NULL',       1, '', '',
1514       ],
1515       'primary_key' => 'classnum',
1516       'unique' => [],
1517       'index' => [ ['disabled'] ],
1518     },
1519
1520     'cust_category' => {
1521       'columns' => [
1522         'categorynum',   'serial',  '', '', '', '',
1523         'categoryname',  'varchar', '', $char_d, '', '',
1524         'weight',         'int', 'NULL',  '', '', '',
1525         'disabled',      'char', 'NULL',   1, '', '',
1526       ],
1527       'primary_key' => 'categorynum',
1528       'unique' => [],
1529       'index' => [ ['disabled'] ],
1530     },
1531
1532     'cust_class' => {
1533       'columns' => [
1534         'classnum',     'serial',     '',      '', '', '',
1535         'classname',   'varchar',     '', $char_d, '', '',
1536         'categorynum',     'int', 'NULL',      '', '', '',
1537         'tax',            'char', 'NULL',       1, '', '',
1538         'disabled',       'char', 'NULL',       1, '', '',
1539       ],
1540       'primary_key' => 'classnum',
1541       'unique' => [],
1542       'index' => [ ['disabled'] ],
1543     },
1544
1545     'cust_tag' => {
1546       'columns' => [
1547         'custtagnum', 'serial', '', '', '', '',
1548         'custnum',       'int', '', '', '', '',
1549         'tagnum',        'int', '', '', '', '',
1550       ],
1551       'primary_key' => 'custtagnum',
1552       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1553       'index'       => [ [ 'custnum' ] ],
1554     },
1555
1556     'part_tag' => {
1557       'columns' => [
1558         'tagnum',    'serial',     '',      '', '', '',
1559         'tagname',  'varchar',     '', $char_d, '', '',
1560         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1561         'tagcolor', 'varchar', 'NULL',       6, '', '',
1562         'by_default',  'char', 'NULL',       1, '', '',
1563         'disabled',    'char', 'NULL',       1, '', '',
1564       ],
1565       'primary_key' => 'tagnum',
1566       'unique'      => [], #[ [ 'tagname' ] ], #?
1567       'index'       => [ [ 'disabled' ] ],
1568     },
1569
1570     'cust_main_exemption' => {
1571       'columns' => [
1572         'exemptionnum',   'serial',     '',      '', '', '',
1573         'custnum',           'int',     '',      '', '', '',
1574         'taxname',       'varchar',     '', $char_d, '', '',
1575         'exempt_number', 'varchar', 'NULL', $char_d, '', '',
1576         #start/end dates?  for reporting?
1577       ],
1578       'primary_key' => 'exemptionnum',
1579       'unique'      => [],
1580       'index'       => [ [ 'custnum' ] ],
1581     },
1582
1583     'cust_tax_adjustment' => {
1584       'columns' => [
1585         'adjustmentnum', 'serial',     '',      '', '', '',
1586         'custnum',          'int',     '',      '', '', '',
1587         'taxname',      'varchar',     '', $char_d, '', '',
1588         'amount',    @money_type,                   '', '',
1589         'comment',     'varchar',  'NULL', $char_d, '', '',
1590         'billpkgnum',       'int', 'NULL',      '', '', '',
1591         #more?  no cust_bill_pkg_tax_location?
1592       ],
1593       'primary_key' => 'adjustmentnum',
1594       'unique'      => [],
1595       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1596     },
1597
1598     'cust_main_county' => { #district+city+county+state+country are checked
1599                             #off the cust_main_county for validation and to
1600                             #provide a tax rate.
1601       'columns' => [
1602         'taxnum',   'serial',   '',    '', '', '',
1603         'district', 'varchar',  'NULL',    20, '', '',
1604         'city',     'varchar',  'NULL',    $char_d, '', '',
1605         'county',   'varchar',  'NULL',    $char_d, '', '',
1606         'state',    'varchar',  'NULL',    $char_d, '', '',
1607         'country',  'char',  '', 2, '', '',
1608         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1609         'exempt_amount', @money_type, '', '',
1610         'tax',      'real',  '',    '', '', '', #tax %
1611         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1612         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1613         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1614       ],
1615       'primary_key' => 'taxnum',
1616       'unique' => [],
1617   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1618       'index' => [ [ 'district' ], [ 'city' ], [ 'county' ], [ 'state' ],
1619                    [ 'country' ],
1620                    [ 'taxclass' ],
1621                  ],
1622     },
1623
1624     'tax_rate'    => {
1625       'columns' => [
1626         'taxnum',       'serial',     '',      '', '', '',
1627         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1628         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1629         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1630         'taxclassnum', 'int',      '',      '', '', '',
1631         'effective_date', @date_type, '', '',
1632         'tax',        @taxrate_type,      '', '',        # tax %
1633         'excessrate', @taxrate_typen,     '', '',        # second tax %
1634         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1635         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1636         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1637         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1638         'unittype',    'int',  'NULL', '', '', '',      # for fee
1639         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1640         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1641         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1642         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1643         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1644         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1645         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1646         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1647         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1648         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1649         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1650         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1651         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1652         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1653         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1654         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1655       ],
1656       'primary_key' => 'taxnum',
1657       'unique' => [],
1658       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1659     },
1660
1661     'tax_rate_location' => {
1662       'columns' => [
1663         'taxratelocationnum', 'serial',  '',     '', '', '',
1664         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1665         'geocode',            'varchar', '',     20,      '', '',
1666         'city',               'varchar', 'NULL', $char_d, '', '',
1667         'county',             'varchar', 'NULL', $char_d, '', '',
1668         'state',              'char',    'NULL',       2, '', '',
1669         'disabled',           'char',    'NULL', 1, '', '',
1670       ],
1671       'primary_key' => 'taxratelocationnum',
1672       'unique' => [],
1673       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1674     },
1675
1676     'cust_tax_location' => {
1677       'columns' => [
1678         'custlocationnum', 'serial',  '',     '', '', '',
1679         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1680         'city',            'varchar', 'NULL', $char_d, '', '',
1681         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1682         'county',          'varchar', 'NULL', $char_d, '', '',
1683         'zip',             'char',    '',     5,  '', '',
1684         'state',           'char',    '',     2,  '', '',
1685         'plus4hi',         'char',    'NULL', 4,  '', '',
1686         'plus4lo',         'char',    'NULL', 4,  '', '',
1687         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1688         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1689         'geocode',         'varchar', '',    20,  '', '',
1690       ],
1691       'primary_key' => 'custlocationnum',
1692       'unique' => [],
1693       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1694     },
1695
1696     'tax_class' => {
1697       'columns' => [
1698         'taxclassnum',  'serial',  '',            '', '', '',
1699         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1700         'taxclass',     'varchar', '',       $char_d, '', '',
1701         'description',  'varchar', '',     2*$char_d, '', '',
1702       ],
1703       'primary_key' => 'taxclassnum',
1704       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1705       'index' => [],
1706     },
1707
1708     'cust_pay_pending' => {
1709       'columns' => [
1710         'paypendingnum','serial',      '',  '', '', '',
1711         'custnum',      'int',         '',  '', '', '',
1712         'paid',         @money_type,            '', '',
1713         '_date',        @date_type,             '', '',
1714         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1715                                                         # be index into payby
1716                                                         # table eventually
1717         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1718         'paymask',      'varchar', 'NULL', $char_d, '', '',
1719         'paydate',      'varchar', 'NULL', 10, '', '',
1720         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1721         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1722         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1723
1724         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1725         'status',       'varchar',     '', $char_d, '', '',
1726         'session_id',   'varchar', 'NULL', 1024, '', '', # SHA-512-hex
1727         'statustext',   'text',    'NULL',  '', '', '',
1728         'gatewaynum',   'int',     'NULL',  '', '', '',
1729         #'cust_balance', @money_type,            '', '',
1730         'paynum',       'int',     'NULL',  '', '', '',
1731         'void_paynum',  'int',     'NULL',  '', '', '',
1732         'jobnum',    'bigint',     'NULL',  '', '', '',
1733         'invnum',       'int',     'NULL',  '', '', '',
1734         'manual',       'char',    'NULL',   1, '', '',
1735         'discount_term','int',     'NULL',  '', '', '',
1736       ],
1737       'primary_key' => 'paypendingnum',
1738       'unique'      => [ [ 'payunique' ] ],
1739       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1740     },
1741
1742     'cust_pay' => {
1743       'columns' => [
1744         'paynum',   'serial',    '',   '', '', '',
1745         'custnum',  'int',    '',   '', '', '',
1746         '_date',    @date_type, '', '',
1747         'paid',     @money_type, '', '',
1748         'otaker',   'varchar', 'NULL', 32, '', '',
1749         'usernum',   'int', 'NULL', '', '', '',
1750         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1751                                                  # index into payby table
1752                                                  # eventually
1753         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1754         'paymask', 'varchar', 'NULL', $char_d, '', '',
1755         'paydate',  'varchar', 'NULL', 10, '', '',
1756         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1757         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1758         'closed',    'char', 'NULL', 1, '', '',
1759         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1760         'no_auto_apply',  'char', 'NULL',       1, '', '',
1761         # cash/check deposit info fields
1762         'bank',       'varchar', 'NULL', $char_d, '', '',
1763         'depositor',  'varchar', 'NULL', $char_d, '', '',
1764         'account',    'varchar', 'NULL', 20,      '', '',
1765         'teller',     'varchar', 'NULL', 20,      '', '',
1766
1767         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1768
1769         # credit card/EFT fields (formerly in paybatch)
1770         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1771         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1772         'auth',       'varchar','NULL',16, '', '', # CC auth number
1773         'order_number','varchar','NULL',$char_d, '', '', # transaction number
1774       ],
1775       'primary_key' => 'paynum',
1776       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1777       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1778     },
1779
1780     'cust_pay_void' => {
1781       'columns' => [
1782         'paynum',    'int',    '',   '', '', '',
1783         'custnum',   'int',    '',   '', '', '',
1784         '_date',     @date_type, '', '',
1785         'paid',      @money_type, '', '',
1786         'otaker',   'varchar', 'NULL', 32, '', '',
1787         'usernum',   'int', 'NULL', '', '', '',
1788         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1789                                                   # index into payby table
1790                                                   # eventually
1791         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1792         'paymask', 'varchar', 'NULL', $char_d, '', '',
1793         #'paydate' ?
1794         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1795         'closed',    'char', 'NULL', 1, '', '',
1796         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1797         # cash/check deposit info fields
1798         'bank',       'varchar', 'NULL', $char_d, '', '',
1799         'depositor',  'varchar', 'NULL', $char_d, '', '',
1800         'account',    'varchar', 'NULL', 20,      '', '',
1801         'teller',     'varchar', 'NULL', 20,      '', '',
1802         'batchnum',       'int', 'NULL', '', '', '', #pay_batch foreign key
1803
1804         # credit card/EFT fields (formerly in paybatch)
1805         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1806         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1807         'auth',       'varchar','NULL',16, '', '', # CC auth number
1808         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
1809
1810         #void fields
1811         'void_date', @date_type, '', '',
1812         'reason',    'varchar',   'NULL', $char_d, '', '',
1813         'void_usernum',   'int', 'NULL', '', '', '',
1814       ],
1815       'primary_key' => 'paynum',
1816       'unique' => [],
1817       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1818     },
1819
1820     'cust_bill_pay' => {
1821       'columns' => [
1822         'billpaynum', 'serial',     '',   '', '', '',
1823         'invnum',  'int',     '',   '', '', '',
1824         'paynum',  'int',     '',   '', '', '',
1825         'amount',  @money_type, '', '',
1826         '_date',   @date_type, '', '',
1827         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1828       ],
1829       'primary_key' => 'billpaynum',
1830       'unique' => [],
1831       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1832     },
1833
1834     'cust_bill_pay_batch' => {
1835       'columns' => [
1836         'billpaynum', 'serial',     '',   '', '', '',
1837         'invnum',  'int',     '',   '', '', '',
1838         'paybatchnum',  'int',     '',   '', '', '',
1839         'amount',  @money_type, '', '',
1840         '_date',   @date_type, '', '',
1841       ],
1842       'primary_key' => 'billpaynum',
1843       'unique' => [],
1844       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1845     },
1846
1847     'cust_bill_pay_pkg' => {
1848       'columns' => [
1849         'billpaypkgnum', 'serial', '', '', '', '',
1850         'billpaynum',       'int', '', '', '', '',
1851         'billpkgnum',       'int', '', '', '', '',
1852         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1853         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1854         'amount',         @money_type,     '', '',
1855         'setuprecur',      'varchar', '', $char_d, '', '',
1856         'sdate',   @date_type, '', '',
1857         'edate',   @date_type, '', '',
1858       ],
1859       'primary_key' => 'billpaypkgnum',
1860       'unique'      => [],
1861       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1862     },
1863
1864     'pay_batch' => { #batches of payments to an external processor
1865       'columns' => [
1866         'batchnum', 'serial',     '', '', '', '',
1867         'agentnum',    'int', 'NULL', '', '', '',
1868         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1869         'status',     'char', 'NULL',  1, '', '',
1870         'download',       @date_type,     '', '',
1871         'upload',         @date_type,     '', '',
1872         'title',   'varchar', 'NULL',255, '', '',
1873         'processor_id',   'varchar', 'NULL',255, '', '',
1874       ],
1875       'primary_key' => 'batchnum',
1876       'unique' => [],
1877       'index' => [],
1878     },
1879
1880     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1881       'columns' => [
1882         'paybatchnum',   'serial',    '',   '', '', '',
1883         'batchnum',   'int',    '',   '', '', '',
1884         'invnum',   'int',    '',   '', '', '',
1885         'custnum',   'int',    '',   '', '', '',
1886         'last',     'varchar', '',     $char_d, '', '',
1887         'first',    'varchar', '',     $char_d, '', '',
1888         'address1', 'varchar', '',     $char_d, '', '',
1889         'address2', 'varchar', 'NULL', $char_d, '', '',
1890         'city',     'varchar', 'NULL',     $char_d, '', '',
1891         'state',    'varchar', 'NULL', $char_d, '', '',
1892         'zip',      'varchar', 'NULL', 10, '', '',
1893         'country',  'char', '',     2, '', '',
1894         #        'trancode', 'int', '', '', '', ''
1895         'payby',    'char',        '',       4, '', '',
1896         'payinfo',  'varchar', 'NULL',     512, '', '',
1897         #'exp',      @date_type, '', ''
1898         'exp',      'varchar', 'NULL',      11, '', '',
1899         'payname',  'varchar', 'NULL', $char_d, '', '',
1900         'amount',   @money_type, '', '',
1901         'status',   'varchar', 'NULL', $char_d, '', '',
1902         'error_message',   'varchar', 'NULL', $char_d, '', '',
1903       ],
1904       'primary_key' => 'paybatchnum',
1905       'unique' => [],
1906       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1907     },
1908
1909     'fcc477map' => {
1910       'columns' => [
1911         'formkey',   'varchar',     '', 255, '', '',
1912         'formvalue',    'text', 'NULL',  '', '', '',
1913       ],
1914       'primary_key' => 'formkey',
1915       'unique'      => [],
1916       'index'       => [],
1917     },
1918
1919     'cust_pkg' => {
1920       'columns' => [
1921         'pkgnum',           'serial',     '', '', '', '',
1922         'custnum',             'int',     '', '', '', '',
1923         'pkgpart',             'int',     '', '', '', '',
1924         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1925         'contactnum',          'int', 'NULL', '', '', '',
1926         'locationnum',         'int', 'NULL', '', '', '',
1927         'otaker',          'varchar', 'NULL', 32, '', '',
1928         'usernum',             'int', 'NULL', '', '', '',
1929         'salesnum',            'int', 'NULL', '', '', '',
1930         'order_date',     @date_type,             '', '',
1931         'start_date',     @date_type,             '', '',
1932         'setup',          @date_type,             '', '',
1933         'bill',           @date_type,             '', '',
1934         'last_bill',      @date_type,             '', '',
1935         'susp',           @date_type,             '', '',
1936         'adjourn',        @date_type,             '', '',
1937         'resume',         @date_type,             '', '',
1938         'cancel',         @date_type,             '', '',
1939         'uncancel',       @date_type,             '', '',
1940         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1941         'expire',         @date_type,             '', '',
1942         'contract_end',   @date_type,             '', '',
1943         'dundate',        @date_type,             '', '',
1944         'change_date',    @date_type,             '', '',
1945         'change_pkgnum',       'int', 'NULL', '', '', '',
1946         'change_pkgpart',      'int', 'NULL', '', '', '',
1947         'change_locationnum',  'int', 'NULL', '', '', '',
1948         'change_custnum',      'int', 'NULL', '', '', '',
1949         'main_pkgnum',         'int', 'NULL', '', '', '',
1950         'pkglinknum',          'int', 'NULL', '', '', '',
1951         'manual_flag',        'char', 'NULL',  1, '', '',
1952         'no_auto',            'char', 'NULL',  1, '', '',
1953         'quantity',            'int', 'NULL', '', '', '',
1954         'agent_pkgid',     'varchar', 'NULL', $char_d, '', '',
1955         'waive_setup',        'char', 'NULL',  1, '', '',
1956         'recur_show_zero',    'char', 'NULL',  1, '', '',
1957         'setup_show_zero',    'char', 'NULL',  1, '', '',
1958         'change_to_pkgnum',    'int', 'NULL', '', '', '',
1959         'separate_bill',      'char', 'NULL',  1, '', '',
1960       ],
1961       'primary_key' => 'pkgnum',
1962       'unique' => [],
1963       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1964                    [ 'usernum' ], [ 'agent_pkgid' ],
1965                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1966                    ['last_bill'], ['susp'], ['adjourn'], ['resume'],
1967                    ['cancel'], ['expire'], ['contract_end'],
1968                    ['change_date'],
1969                    ['no_auto'],
1970                    #['contactnum'],
1971                    ['salesnum'],
1972                    #['uncancel_pkgnum'],
1973                    #['change_pkgnum'], ['change_locationnum'],
1974                    #['change_custnum'],
1975                    ['main_pkgnum'],
1976                    #['pkglinknum'], ['change_to_pkgnum'],
1977                  ],
1978     },
1979
1980     'cust_pkg_option' => {
1981       'columns' => [
1982         'optionnum', 'serial', '', '', '', '',
1983         'pkgnum', 'int', '', '', '', '',
1984         'optionname', 'varchar', '', $char_d, '', '',
1985         'optionvalue', 'text', 'NULL', '', '', '',
1986       ],
1987       'primary_key' => 'optionnum',
1988       'unique'      => [],
1989       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1990     },
1991
1992     'cust_pkg_detail' => {
1993       'columns' => [
1994         'pkgdetailnum', 'serial', '',        '', '', '',
1995         'pkgnum',          'int', '',        '', '', '',
1996         'detail',      'varchar', '', 2*$char_d, '', '',
1997         'detailtype',     'char', '',         1, '', '', #"I"nvoice or "C"omment
1998         'weight',          'int', '',        '', '', '',
1999       ],
2000       'primary_key' => 'pkgdetailnum',
2001       'unique' => [],
2002       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
2003     },
2004
2005     'cust_pkg_reason' => {
2006       'columns' => [
2007         'num',      'serial',    '',   '', '', '',
2008         'pkgnum',   'int',    '',   '', '', '',
2009         'reasonnum','int',    '',   '', '', '',
2010         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
2011         'otaker',   'varchar', 'NULL', 32, '', '',
2012         'usernum',   'int', 'NULL', '', '', '',
2013         'date',     @date_type, '', '',
2014       ],
2015       'primary_key' => 'num',
2016       'unique' => [],
2017       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
2018     },
2019
2020     'cust_pkg_reason_fee' => {
2021       'columns' => [
2022         'pkgreasonfeenum', 'serial', '', '', '', '',
2023         'pkgreasonnum',       'int', '', '', '', '',
2024         'billpkgnum',         'int', 'NULL', '', '', '',
2025         'feepart',            'int', '', '', '', '',
2026         'nextbill',          'char', 'NULL',  1, '', '',
2027       ],
2028       'primary_key'  => 'pkgreasonfeenum',
2029       'unique' => [ [ 'billpkgnum' ], [ 'pkgreasonnum' ] ], # one-to-one link
2030       'index'  => [ [ 'feepart' ] ],
2031     },
2032
2033     'cust_pkg_discount' => {
2034       'columns' => [
2035         'pkgdiscountnum', 'serial', '',        '', '', '',
2036         'pkgnum',            'int', '',        '', '', '',
2037         'discountnum',       'int', '',        '', '', '',
2038         'months_used',   'decimal', 'NULL', '7,4', '', '',
2039         'end_date',     @date_type,                '', '',
2040         'otaker',        'varchar', 'NULL',    32, '', '',
2041         'usernum',           'int', 'NULL',    '', '', '',
2042         'disabled',         'char', 'NULL',     1, '', '',
2043       ],
2044       'primary_key' => 'pkgdiscountnum',
2045       'unique' => [],
2046       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
2047     },
2048
2049     'cust_pkg_usage' => {
2050       'columns' => [
2051         'pkgusagenum', 'serial', '', '', '', '',
2052         'pkgnum',         'int', '', '', '', '',
2053         'minutes',        'double precision', '', '', '', '',
2054         'pkgusagepart',   'int', '', '', '', '',
2055       ],
2056       'primary_key' => 'pkgusagenum',
2057       'unique' => [],
2058       'index'  => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
2059     },
2060
2061     'cdr_cust_pkg_usage' => {
2062       'columns' => [
2063         'cdrusagenum', 'bigserial', '', '', '', '',
2064         'acctid',      'bigint',    '', '', '', '',
2065         'pkgusagenum', 'int',       '', '', '', '',
2066         'minutes',     'double precision',       '', '', '', '',
2067       ],
2068       'primary_key' => 'cdrusagenum',
2069       'unique' => [],
2070       'index'  => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
2071     },
2072
2073     'cust_bill_pkg_discount' => {
2074       'columns' => [
2075         'billpkgdiscountnum', 'serial',        '', '', '', '',
2076         'billpkgnum',            'int',        '', '', '', '',
2077         'pkgdiscountnum',        'int',        '', '', '', '',
2078         'amount',          @money_type,                '', '',
2079         'months',            'decimal', 'NULL', '7,4', '', '',
2080       ],
2081       'primary_key' => 'billpkgdiscountnum',
2082       'unique' => [],
2083       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2084     },
2085
2086     'cust_bill_pkg_discount_void' => {
2087       'columns' => [
2088         'billpkgdiscountnum',    'int',        '', '', '', '',
2089         'billpkgnum',            'int',        '', '', '', '',
2090         'pkgdiscountnum',        'int',        '', '', '', '',
2091         'amount',          @money_type,                '', '',
2092         'months',            'decimal', 'NULL', '7,4', '', '',
2093       ],
2094       'primary_key' => 'billpkgdiscountnum',
2095       'unique' => [],
2096       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
2097     },
2098
2099     'discount' => {
2100       'columns' => [
2101         'discountnum', 'serial',     '',      '', '', '',
2102         #'agentnum',       'int', 'NULL',      '', '', '',
2103         'classnum',       'int', 'NULL',      '', '', '',
2104         'name',       'varchar', 'NULL', $char_d, '', '',
2105         'amount',   @money_type,                  '', '',
2106         'percent',    'decimal',     '',   '7,4', '', '',
2107         'months',     'decimal', 'NULL',   '7,4', '', '',
2108         'disabled',      'char', 'NULL',       1, '', '',
2109         'setup',         'char', 'NULL',       1, '', '',
2110         #'linked',        'char', 'NULL',       1, '', '',
2111       ],
2112       'primary_key' => 'discountnum',
2113       'unique' => [],
2114       'index'  => [], # [ 'agentnum' ], ],
2115     },
2116
2117     'discount_class' => {
2118       'columns' => [
2119         'classnum',    'serial',   '',      '', '', '',
2120         'classname',   'varchar',  '', $char_d, '', '',
2121         #'categorynum', 'int',  'NULL',      '', '', '',
2122         'disabled',    'char', 'NULL',       1, '', '',
2123       ],
2124       'primary_key' => 'classnum',
2125       'unique' => [],
2126       'index' => [ ['disabled'] ],
2127     },
2128
2129     'cust_refund' => {
2130       'columns' => [
2131         'refundnum',    'serial',    '',   '', '', '',
2132         'custnum',  'int',    '',   '', '', '',
2133         '_date',        @date_type, '', '',
2134         'refund',       @money_type, '', '',
2135         'otaker',       'varchar',   'NULL',   32, '', '',
2136         'usernum',   'int', 'NULL', '', '', '',
2137         'reason',       'varchar',   'NULL',   $char_d, '', '',
2138         'reasonnum',   'int', 'NULL', '', '', '',
2139         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
2140                                                      # be index into payby
2141                                                      # table eventually
2142         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
2143         'paymask', 'varchar', 'NULL', $char_d, '', '',
2144         'paybatch',     'varchar',   'NULL', $char_d, '', '',
2145         'closed',    'char', 'NULL', 1, '', '',
2146         # credit card/EFT fields (formerly in paybatch)
2147         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
2148         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
2149         'auth',       'varchar','NULL',16, '', '', # CC auth number
2150         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
2151       ],
2152       'primary_key' => 'refundnum',
2153       'unique' => [],
2154       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
2155     },
2156
2157     'cust_credit_refund' => {
2158       'columns' => [
2159         'creditrefundnum', 'serial',     '',   '', '', '',
2160         'crednum',  'int',     '',   '', '', '',
2161         'refundnum',  'int',     '',   '', '', '',
2162         'amount',  @money_type, '', '',
2163         '_date',   @date_type, '', '',
2164       ],
2165       'primary_key' => 'creditrefundnum',
2166       'unique' => [],
2167       'index' => [ ['crednum'], ['refundnum'] ],
2168     },
2169
2170
2171     'cust_svc' => {
2172       'columns' => [
2173         'svcnum',      'serial',     '', '', '', '',
2174         'pkgnum',         'int', 'NULL', '', '', '',
2175         'svcpart',        'int',     '', '', '', '',
2176         'agent_svcid',    'int', 'NULL', '', '', '',
2177         'overlimit',           @date_type,   '', '',
2178       ],
2179       'primary_key' => 'svcnum',
2180       'unique' => [],
2181       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
2182     },
2183
2184     'cust_svc_option' => {
2185       'columns' => [
2186         'optionnum',   'serial', '', '', '', '',
2187         'svcnum',      'int', '', '', '', '',
2188         'optionname',  'varchar', '', $char_d, '', '',
2189         'optionvalue', 'text', 'NULL', '', '', '',
2190       ],
2191       'primary_key' => 'optionnum',
2192       'unique'      => [],
2193       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
2194     },
2195
2196     'svc_export_machine' => {
2197       'columns' => [
2198         'svcexportmachinenum', 'serial', '', '', '', '',
2199         'svcnum',                 'int', '', '', '', '',
2200         'exportnum',              'int', '', '', '', '',
2201         'machinenum',             'int', '', '', '', '',
2202       ],
2203       'primary_key' => 'svcexportmachinenum',
2204       'unique'      => [ ['svcnum', 'exportnum'] ],
2205       'index'       => [],
2206     },
2207
2208     'part_export_machine' => {
2209       'columns' => [
2210         'machinenum', 'serial', '', '', '', '',
2211         'exportnum',     'int', '', '', '', '',
2212         'machine',    'varchar', 'NULL', $char_d, '', '',
2213         'disabled',      'char', 'NULL',       1, '', '',
2214       ],
2215       'primary_key' => 'machinenum',
2216       'unique'      => [ [ 'exportnum', 'machine' ] ],
2217       'index'       => [ [ 'exportnum' ] ],
2218     },
2219
2220    'part_pkg' => {
2221       'columns' => [
2222         'pkgpart',       'serial',    '',   '', '', '',
2223         'pkgpartbatch',  'varchar', 'NULL', $char_d, '', '',
2224         'pkg',           'varchar',   '',   $char_d, '', '',
2225         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
2226         'promo_code',    'varchar', 'NULL', $char_d, '', '',
2227         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
2228         'setuptax',      'char', 'NULL', 1, '', '',
2229         'recurtax',      'char', 'NULL', 1, '', '',
2230         'plan',          'varchar', 'NULL', $char_d, '', '',
2231         'disabled',      'char', 'NULL', 1, '', '',
2232         'custom',        'char', 'NULL', 1, '', '',
2233         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2234         'classnum',      'int',     'NULL', '', '', '',
2235         'addon_classnum','int',     'NULL', '', '', '',
2236         'taxproductnum', 'int',     'NULL', '', '', '',
2237         'setup_cost',    @money_typen,          '', '',
2238         'recur_cost',    @money_typen,          '', '',
2239         'pay_weight',    'real',    'NULL', '', '', '',
2240         'credit_weight', 'real',    'NULL', '', '', '',
2241         'agentnum',      'int',     'NULL', '', '', '',
2242         'fcc_ds0s',      'int',     'NULL', '', '', '',
2243         'fcc_voip_class','char',    'NULL',  1, '', '',
2244         'no_auto',          'char', 'NULL',  1, '', '',
2245         'recur_show_zero',  'char', 'NULL',  1, '', '',
2246         'setup_show_zero',  'char', 'NULL',  1, '', '',
2247         'successor',     'int',     'NULL', '', '', '',
2248         'family_pkgpart','int',     'NULL', '', '', '',
2249         'delay_start',   'int',     'NULL', '', '', '',
2250         'start_on_hold', 'char',    'NULL',  1, '', '',
2251         'agent_pkgpartid', 'varchar', 'NULL', 20, '', '',
2252       ],
2253       'primary_key' => 'pkgpart',
2254       'unique' => [],
2255       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
2256                    [ 'agentnum' ], ['no_auto'], ['agent_pkgpartid'],
2257                  ],
2258     },
2259
2260     'part_pkg_msgcat' => {
2261       'columns' => [
2262         'pkgpartmsgnum',  'serial',     '',        '', '', '',
2263         'pkgpart',           'int',     '',        '', '', '',
2264         'locale',        'varchar',     '',        16, '', '',
2265         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
2266         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2267       ],
2268       'primary_key' => 'pkgpartmsgnum',
2269       'unique'      => [ [ 'pkgpart', 'locale' ] ],
2270       'index'       => [],
2271     },
2272
2273     'part_fee' => {
2274       'columns' => [
2275         'feepart',       'serial',    '',   '', '', '',
2276         'itemdesc',      'varchar',   '',   $char_d,   '', '',
2277         'comment',       'varchar', 'NULL', 2*$char_d, '', '',
2278         'disabled',      'char',    'NULL',  1, '', '',
2279         'classnum',      'int',     'NULL', '', '', '',
2280         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2281         'taxproductnum', 'int',     'NULL', '', '', '',
2282         'pay_weight',    'real',    'NULL', '', '', '',
2283         'credit_weight', 'real',    'NULL', '', '', '',
2284         'agentnum',      'int',     'NULL', '', '', '',
2285         'amount',   @money_type,                '', '',
2286         'percent',     'decimal',    '', '7,4', '', '',
2287         'basis',         'varchar',  '',    16, '', '',
2288         'minimum',    @money_typen,             '', '',
2289         'maximum',    @money_typen,             '', '',
2290         'limit_credit',  'char',    'NULL',  1, '', '',
2291         'setuprecur',    'char',     '',     5, '', '',
2292         'taxable',       'char',    'NULL',  1, '', '',
2293       ],
2294       'primary_key'  => 'feepart',
2295       'unique'       => [],
2296       'index'        => [ [ 'disabled' ], [ 'classnum' ], [ 'agentnum' ]
2297                         ],
2298     },
2299
2300     'part_fee_msgcat' => {
2301       'columns' => [
2302         'feepartmsgnum',  'serial',     '',        '', '', '',
2303         'feepart',           'int',     '',        '', '', '',
2304         'locale',        'varchar',     '',        16, '', '',
2305         'itemdesc',      'varchar',     '',   $char_d, '', '', #longer/no limit?
2306         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2307       ],
2308       'primary_key'  => 'feepartmsgnum',
2309       'unique'       => [ [ 'feepart', 'locale' ] ],
2310       'index'        => [],
2311     },
2312
2313     'part_fee_usage' => {
2314       'columns' => [
2315         'feepartusagenum','serial',     '',        '', '', '',
2316         'feepart',           'int',     '',        '', '', '',
2317         'classnum',          'int',     '',        '', '', '',
2318         'amount',   @money_type,                '', '',
2319         'percent',     'decimal',    '', '7,4', '', '',
2320       ],
2321       'primary_key'  => 'feepartusagenum',
2322       'unique'       => [ [ 'feepart', 'classnum' ] ],
2323       'index'        => [],
2324     },
2325
2326     'part_pkg_link' => {
2327       'columns' => [
2328         'pkglinknum',  'serial',   '',      '', '', '',
2329         'src_pkgpart', 'int',      '',      '', '', '',
2330         'dst_pkgpart', 'int',      '',      '', '', '',
2331         'link_type',   'varchar',  '', $char_d, '', '',
2332         'hidden',      'char', 'NULL',       1, '', '',
2333       ],
2334       'primary_key' => 'pkglinknum',
2335       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
2336       'index'  => [ [ 'src_pkgpart' ] ],
2337     },
2338     # XXX somewhat borked unique: we don't really want a hidden and unhidden
2339     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
2340
2341     'part_pkg_discount' => {
2342       'columns' => [
2343         'pkgdiscountnum', 'serial',   '',      '', '', '',
2344         'pkgpart',        'int',      '',      '', '', '',
2345         'discountnum',    'int',      '',      '', '', '',
2346       ],
2347       'primary_key' => 'pkgdiscountnum',
2348       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
2349       'index'  => [],
2350     },
2351
2352     'part_pkg_taxclass' => {
2353       'columns' => [
2354         'taxclassnum',  'serial', '',       '', '', '',
2355         'taxclass',     'varchar', '', $char_d, '', '',
2356         'disabled', 'char',   'NULL',         1, '', '',
2357       ],
2358       'primary_key' => 'taxclassnum',
2359       'unique'      => [ [ 'taxclass' ] ],
2360       'index'       => [ [ 'disabled' ] ],
2361     },
2362
2363     'part_pkg_taxproduct' => {
2364       'columns' => [
2365         'taxproductnum', 'serial',      '',        '', '', '',
2366         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
2367         'taxproduct',    'varchar',     '',   $char_d, '', '',
2368         'description',   'varchar',     '', 3*$char_d, '', '',
2369       ],
2370       'primary_key' => 'taxproductnum',
2371       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
2372       'index'       => [],
2373     },
2374
2375     'part_pkg_taxrate' => {
2376       'columns' => [
2377         'pkgtaxratenum', 'serial',  '',     '',      '', '',
2378         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
2379         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
2380         'taxproductnum', 'int',  '',     '',       '', '',
2381         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
2382         'county',           'varchar', 'NULL', $char_d, '', '',
2383         'state',            'varchar', 'NULL', $char_d, '', '',
2384         'local',            'varchar', 'NULL', $char_d, '', '',
2385         'country',          'char',    'NULL', 2,       '', '',
2386         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
2387         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
2388         'taxclassnum',      'int',     'NULL', '',      '', '',
2389         'effdate',          @date_type, '', '',
2390         'taxable',          'char',    'NULL', 1,       '', '',
2391       ],
2392       'primary_key' => 'pkgtaxratenum',
2393       'unique' => [],
2394       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
2395     },
2396
2397     'part_pkg_taxoverride' => {
2398       'columns' => [
2399         'taxoverridenum', 'serial', '', '', '', '',
2400         'pkgpart',           'int', '', '', '', '',
2401         'taxclassnum',       'int', '', '', '', '',
2402         'usage_class',    'varchar', 'NULL', $char_d, '', '',
2403       ],
2404       'primary_key' => 'taxoverridenum',
2405       'unique' => [],
2406       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
2407     },
2408
2409 #    'part_title' => {
2410 #      'columns' => [
2411 #        'titlenum',   'int',    '',   '',
2412 #        'title',      'varchar',   '',   $char_d,
2413 #      ],
2414 #      'primary_key' => 'titlenum',
2415 #      'unique' => [ [] ],
2416 #      'index' => [ [] ],
2417 #    },
2418
2419     'pkg_svc' => {
2420       'columns' => [
2421         'pkgsvcnum',  'serial', '',  '', '', '',
2422         'pkgpart',    'int',    '',   '', '', '',
2423         'svcpart',    'int',    '',   '', '', '',
2424         'quantity',   'int',    '',   '', '', '',
2425         'primary_svc','char', 'NULL',  1, '', '',
2426         'hidden',     'char', 'NULL',  1, '', '',
2427         'provision_hold', 'char', 'NULL', 1, '', '',
2428       ],
2429       'primary_key' => 'pkgsvcnum',
2430       'unique' => [ ['pkgpart', 'svcpart'] ],
2431       'index' => [ ['pkgpart'], ['quantity'] ],
2432     },
2433
2434     'part_referral' => {
2435       'columns' => [
2436         'refnum',   'serial',     '',        '', '', '',
2437         'referral', 'varchar',    '',   $char_d, '', '',
2438         'disabled', 'char',   'NULL',         1, '', '',
2439         'agentnum', 'int',    'NULL',        '', '', '',
2440       ],
2441       'primary_key' => 'refnum',
2442       'unique' => [],
2443       'index' => [ ['disabled'], ['agentnum'], ],
2444     },
2445
2446     'part_svc' => {
2447       'columns' => [
2448         'svcpart',             'serial',     '',        '', '', '',
2449         'svc',                'varchar',     '',   $char_d, '', '',
2450         'svcdb',              'varchar',     '',   $char_d, '', '',
2451         'disabled',              'char', 'NULL',         1, '', '',
2452         'preserve',              'char', 'NULL',         1, '', '',
2453         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
2454         'classnum',               'int', 'NULL',        '', '', '',
2455         'restrict_edit_password','char', 'NULL',         1, '', '',
2456         'has_router',            'char', 'NULL',         1, '', '',
2457 ],
2458       'primary_key' => 'svcpart',
2459       'unique' => [],
2460       'index' => [ [ 'disabled' ] ],
2461     },
2462
2463     'part_svc_column' => {
2464       'columns' => [
2465         'columnnum',   'serial',      '',      '', '', '',
2466         'svcpart',     'int',         '',      '', '', '',
2467         'columnname',  'varchar',     '',      64, '', '',
2468         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
2469         'columnvalue', 'varchar', 'NULL',     512, '', '',
2470         'columnflag',  'char',    'NULL',       1, '', '',
2471         'required',    'char',    'NULL',       1, '', '',
2472       ],
2473       'primary_key' => 'columnnum',
2474       'unique' => [ [ 'svcpart', 'columnname' ] ],
2475       'index' => [ [ 'svcpart' ] ],
2476     },
2477
2478     'part_svc_class' => {
2479       'columns' => [
2480         'classnum',    'serial',   '',      '', '', '',
2481         'classname',   'varchar',  '', $char_d, '', '',
2482         'disabled',    'char', 'NULL',       1, '', '',
2483       ],
2484       'primary_key' => 'classnum',
2485       'unique' => [],
2486       'index' => [ ['disabled'] ],
2487     },
2488
2489     #(this should be renamed to part_pop)
2490     'svc_acct_pop' => {
2491       'columns' => [
2492         'popnum',    'serial',    '',   '', '', '',
2493         'city',      'varchar',   '',   $char_d, '', '',
2494         'state',     'varchar',   '',   $char_d, '', '',
2495         'ac',        'char',   '',   3, '', '',
2496         'exch',      'char',   '',   3, '', '',
2497         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
2498       ],
2499       'primary_key' => 'popnum',
2500       'unique' => [],
2501       'index' => [ [ 'state' ] ],
2502     },
2503
2504     'part_pop_local' => {
2505       'columns' => [
2506         'localnum',  'serial',     '',     '', '', '',
2507         'popnum',    'int',     '',     '', '', '',
2508         'city',      'varchar', 'NULL', $char_d, '', '',
2509         'state',     'char',    'NULL', 2, '', '',
2510         'npa',       'char',    '',     3, '', '',
2511         'nxx',       'char',    '',     3, '', '',
2512       ],
2513       'primary_key' => 'localnum',
2514       'unique' => [],
2515       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
2516     },
2517
2518     'qual' => {
2519       'columns' => [
2520         'qualnum',  'serial',     '',     '', '', '',
2521         'custnum',    'int',     'NULL',     '', '', '',
2522         'prospectnum',    'int',     'NULL',     '', '', '',
2523         'locationnum',    'int',     'NULL',     '', '', '',
2524         'phonenum',     'varchar', 'NULL',       24, '', '',
2525         'exportnum',      'int', 'NULL', '', '', '',
2526         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
2527         'status',      'char', '', 1, '', '',
2528       ],
2529       'primary_key' => 'qualnum',
2530       'unique' => [],
2531       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
2532                     ['phonenum'], ['vendor_qual_id'] ],
2533     },
2534
2535     'qual_option' => {
2536       'columns' => [
2537         'optionnum', 'serial', '', '', '', '',
2538         'qualnum',  'int',     '',     '', '', '',
2539         'optionname', 'varchar', '', $char_d, '', '',
2540         'optionvalue', 'text', 'NULL', '', '', '',
2541       ],
2542       'primary_key' => 'optionnum',
2543       'unique' => [],
2544       'index' => [],
2545     },
2546
2547     'svc_acct' => {
2548       'columns' => [
2549         'svcnum',    'int',    '',   '', '', '',
2550         'username',  'varchar',   '',   $username_len, '', '',
2551         '_password', 'varchar',   'NULL',  512, '', '',
2552         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
2553         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
2554         'popnum',    'int',    'NULL',   '', '', '',
2555         'sectornum', 'int', 'NULL',      '', '', '',
2556         'uid',       'int', 'NULL',   '', '', '',
2557         'gid',       'int', 'NULL',   '', '', '',
2558         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
2559         'dir',       'varchar',   'NULL',   $char_d, '', '',
2560         'shell',     'varchar',   'NULL',   $char_d, '', '',
2561         'quota',     'varchar',   'NULL',   $char_d, '', '',
2562         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
2563         # IP address mgmt
2564         'routernum', 'int', 'NULL',      '', '', '',
2565         'blocknum',  'int', 'NULL',      '', '', '',
2566         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
2567         'seconds_threshold',   'int', 'NULL',   '', '', '',
2568         'upbytes',   'bigint', 'NULL',   '', '', '',
2569         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
2570         'downbytes', 'bigint', 'NULL',   '', '', '',
2571         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
2572         'totalbytes','bigint', 'NULL',   '', '', '',
2573         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
2574         'domsvc',    'int',     '', '', '', '',
2575         'pbxsvc',    'int', 'NULL', '', '', '',
2576         'last_login',  @date_type, '', '',
2577         'last_logout', @date_type, '', '',
2578         #cardfortress field(s)
2579         'cf_privatekey',      'text', 'NULL',      '', '', '',
2580         #communigate pro fields (quota = MaxAccountSize)
2581         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
2582         #settings
2583         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
2584         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
2585         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
2586         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
2587         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
2588         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
2589         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
2590         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
2591         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
2592         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
2593         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
2594         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
2595         #XXX mailing lists
2596         #preferences
2597         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
2598         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
2599         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
2600         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
2601         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
2602         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
2603         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
2604         #mail
2605         #XXX RPOP settings
2606         #
2607       ],
2608       'primary_key' => 'svcnum',
2609       #'unique' => [ [ 'username', 'domsvc' ] ],
2610       'unique' => [],
2611       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
2612     },
2613
2614     'acct_rt_transaction' => {
2615       'columns' => [
2616         'svcrtid',   'int',    '',   '', '', '',
2617         'svcnum',    'int',    '',   '', '', '',
2618         'transaction_id',       'int', '',   '', '', '',
2619         '_date',   @date_type, '', '',
2620         'seconds',   'int', '',   '', '', '', #uhhhh
2621         'support',   'int', '',   '', '', '',
2622       ],
2623       'primary_key' => 'svcrtid',
2624       'unique' => [],
2625       'index' => [ ['svcnum', 'transaction_id'] ],
2626     },
2627
2628     #'svc_charge' => {
2629     #  'columns' => [
2630     #    'svcnum',    'int',    '',   '',
2631     #    'amount',    @money_type,
2632     #  ],
2633     #  'primary_key' => 'svcnum',
2634     #  'unique' => [ [] ],
2635     #  'index' => [ [] ],
2636     #},
2637
2638     'svc_domain' => {
2639       'columns' => [
2640         'svcnum',           'int',    '',        '', '', '',
2641         'domain',       'varchar',    '',   $char_d, '', '',
2642         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2643         'catchall',         'int', 'NULL',       '', '', '',
2644         'parent_svcnum',    'int', 'NULL',       '', '', '',
2645         'quota',        'varchar', 'NULL',  $char_d, '', '',
2646
2647         #registration info
2648         'registrarnum',     'int', 'NULL',       '', '', '',
2649         'registrarkey', 'varchar', 'NULL',      512, '', '',
2650         'setup_date',      @date_type, '', '',
2651         'renewal_interval', 'int', 'NULL',       '', '', '',
2652         'expiration_date', @date_type, '', '',
2653
2654         #some weird shit australia-specific shit?  yuck.. seems totally unused
2655         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2656         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2657
2658         #communigate pro fields (quota = MaxAccountSize)
2659         'max_accounts',     'int', 'NULL',       '', '', '',
2660         'trailer',         'text', 'NULL',       '', '', '',
2661         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2662         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2663         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2664
2665         #(account default) settings
2666         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
2667         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
2668         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2669         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2670         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2671         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2672         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2673         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2674         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
2675         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
2676         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
2677         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2678
2679         #(account default) preferences
2680         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2681         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2682         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2683         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2684         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2685         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2686         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2687       ],
2688       'primary_key' => 'svcnum',
2689       'unique' => [ ],
2690       'index' => [ ['domain'] ],
2691     },
2692
2693     'svc_dsl' => {
2694       'columns' => [
2695         'svcnum',                    'int',    '',        '', '', '',
2696         'pushed',                    'int', 'NULL',       '', '', '',
2697         'desired_due_date',          'int', 'NULL',       '', '', '',
2698         'due_date',                  'int', 'NULL',       '', '', '',
2699         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2700         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2701         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2702         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2703         'first',                 'varchar', 'NULL', $char_d,  '', '',
2704         'last',                  'varchar', 'NULL', $char_d,  '', '',
2705         'company',               'varchar', 'NULL', $char_d,  '', '',
2706         'phonenum',              'varchar', 'NULL',      24, '', '',
2707         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2708         'loop_type',                'char', 'NULL',       1, '', '',
2709         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2710         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2711         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2712         'vpi',                       'int', 'NULL',      '', '', '',
2713         'vci',                       'int', 'NULL',      '', '', '',
2714         'isp_chg',                  'char', 'NULL',       1, '', '',
2715         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2716         'username',              'varchar', 'NULL', $char_d, '', '',
2717         'password',              'varchar', 'NULL', $char_d, '', '',
2718         'staticips',                'text', 'NULL',      '', '', '',
2719         'monitored',                'char', 'NULL',       1, '', '',
2720         'last_pull',                 'int', 'NULL',      '', '', '',
2721       ],
2722       'primary_key' => 'svcnum',
2723       'unique' => [ ],
2724       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2725     },
2726
2727     'dsl_device' => {
2728       'columns' => [
2729         'devicenum', 'serial',     '', '', '', '',
2730         #part_device?  or our own part_dsl_device?
2731         #'devicepart',   'int',     '', '', '', '',
2732         'svcnum',       'int',     '', '', '', '',
2733         'mac_addr', 'varchar',     '', 12, '', '',
2734       ],
2735       'primary_key' => 'devicenum',
2736       'unique' => [ [ 'mac_addr' ], ],
2737       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2738     },
2739
2740     'dsl_note' => {
2741       'columns' => [
2742         'notenum',           'serial',    '',        '', '', '',
2743         'svcnum',     'int', '',       '', '', '',
2744         'author',     'varchar', 'NULL', $char_d,  '', '',
2745         'priority',   'char', 'NULL',       1,  '', '',
2746         '_date',     'int', 'NULL',       '', '', '',
2747         'note',     'text', '',       '', '', '',
2748       ],
2749       'primary_key' => 'notenum',
2750       'unique' => [ ],
2751       'index' => [ ['svcnum'] ],
2752     },
2753
2754     'svc_dish' => {
2755       'columns' => [
2756         'svcnum',   'int',     '',     '', '', '',
2757         'acctnum',  'varchar', '',     16, '', '',
2758         'installdate', @date_type,         '', '',
2759         'note',     'text',    'NULL', '', '', '',
2760       ],
2761       'primary_key' => 'svcnum',
2762       'unique' => [ ],
2763       'index' => [ ],
2764     },
2765
2766     'svc_hardware' => {
2767       'columns' => [
2768         'svcnum',   'int',     '',          '', '', '',
2769         'typenum',  'int',     '',          '', '', '',
2770         'serial',   'varchar', 'NULL', $char_d, '', '',
2771         'ip_addr',  'varchar', 'NULL',      40, '', '',
2772         'hw_addr',  'varchar', 'NULL',      12, '', '',
2773         'smartcard','varchar', 'NULL',      30, '', '',
2774         'statusnum','int',     'NULL',      '', '', '',
2775         'note',     'text',    'NULL',      '', '', '',
2776       ],
2777       'primary_key' => 'svcnum',
2778       'unique' => [ ],
2779       'index' => [ ],
2780     },
2781
2782     'hardware_class' => {
2783       'columns' => [
2784         'classnum',   'serial', '',      '', '', '',
2785         'classname', 'varchar', '', $char_d, '', '',
2786       ],
2787       'primary_key' => 'classnum',
2788       'unique' => [ ],
2789       'index'  => [ ],
2790     },
2791
2792     'hardware_type' => {
2793       'columns' => [
2794         'typenum',  'serial',     '',      '', '', '',
2795         'classnum',    'int',     '',      '', '', '',
2796         'model',   'varchar',     '', $char_d, '', '',
2797         'revision','varchar', 'NULL', $char_d, '', '',
2798       ],
2799       'primary_key' => 'typenum',
2800       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2801       'index'  => [ ],
2802     },
2803
2804     'hardware_status' => {
2805       'columns' => [
2806         'statusnum', 'serial', '',      '', '', '',
2807         'label'    ,'varchar', '', $char_d, '', '',
2808         'disabled',    'char', 'NULL',   1, '', '',
2809       ],
2810       'primary_key' => 'statusnum',
2811       'unique' => [ ],
2812       'index'  => [ ],
2813     },
2814
2815     'domain_record' => {
2816       'columns' => [
2817         'recnum',    'serial',     '',  '', '', '',
2818         'svcnum',    'int',     '',  '', '', '',
2819         'reczone',   'varchar', '',  255, '', '',
2820         'recaf',     'char',    '',  2, '', '',
2821         'rectype',   'varchar',    '',  5, '', '',
2822         'recdata',   'varchar', '',  255, '', '',
2823         'ttl',       'int',     'NULL', '', '', '',
2824       ],
2825       'primary_key' => 'recnum',
2826       'unique'      => [],
2827       'index'       => [ ['svcnum'] ],
2828     },
2829
2830     'registrar' => {
2831       'columns' => [
2832         'registrarnum',   'serial', '',      '', '', '',
2833         'registrarname', 'varchar', '', $char_d, '', '',
2834       ],
2835       'primary_key' => 'registrarnum',
2836       'unique'      => [],
2837       'index'       => [],
2838     },
2839
2840     'cgp_rule' => {
2841       'columns' => [
2842         'rulenum',  'serial',     '',      '', '', '',
2843         'name',    'varchar',     '', $char_d, '', '',
2844         'comment', 'varchar', 'NULL', $char_d, '', '',
2845         'svcnum',      'int',     '',      '', '', '',
2846         'priority',    'int',     '',      '', '', '',
2847       ],
2848       'primary_key' => 'rulenum',
2849       'unique'      => [ [ 'svcnum', 'name' ] ],
2850       'index'       => [ [ 'svcnum' ] ],
2851     },
2852
2853     'cgp_rule_condition' => {
2854       'columns' => [
2855         'ruleconditionnum',  'serial',     '',      '', '', '',
2856         'conditionname',    'varchar',     '', $char_d, '', '',
2857         'op',               'varchar', 'NULL', $char_d, '', '',
2858         'params',           'varchar', 'NULL',     255, '', '',
2859         'rulenum',              'int',     '',      '', '', '',
2860       ],
2861       'primary_key' => 'ruleconditionnum',
2862       'unique'      => [],
2863       'index'       => [ [ 'rulenum' ] ],
2864     },
2865
2866     'cgp_rule_action' => {
2867        'columns' => [
2868         'ruleactionnum',  'serial',     '',      '', '', '',
2869         'action',        'varchar',     '', $char_d, '', '',
2870         'params',        'varchar', 'NULL',     255, '', '',
2871         'rulenum',           'int',     '',      '', '', '',
2872       ],
2873       'primary_key' => 'ruleactionnum',
2874       'unique'      => [],
2875       'index'       => [ [ 'rulenum' ] ],
2876    },
2877
2878     'svc_forward' => {
2879       'columns' => [
2880         'svcnum',   'int',            '',   '', '', '',
2881         'srcsvc',   'int',        'NULL',   '', '', '',
2882         'src',      'varchar',    'NULL',  255, '', '',
2883         'dstsvc',   'int',        'NULL',   '', '', '',
2884         'dst',      'varchar',    'NULL',  255, '', '',
2885       ],
2886       'primary_key' => 'svcnum',
2887       'unique'      => [],
2888       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2889     },
2890
2891     'svc_www' => {
2892       'columns' => [
2893         'svcnum',   'int',      '',  '', '', '',
2894         'recnum',   'int',      '',  '', '', '',
2895         'usersvc',  'int',  'NULL',  '', '', '',
2896         'config',   'text', 'NULL',  '', '', '',
2897       ],
2898       'primary_key' => 'svcnum',
2899       'unique'      => [],
2900       'index'       => [],
2901     },
2902
2903     #'svc_wo' => {
2904     #  'columns' => [
2905     #    'svcnum',    'int',    '',   '',
2906     #    'svcnum',    'int',    '',   '',
2907     #    'svcnum',    'int',    '',   '',
2908     #    'worker',    'varchar',   '',   $char_d,
2909     #    '_date',     @date_type,
2910     #  ],
2911     #  'primary_key' => 'svcnum',
2912     #  'unique' => [ [] ],
2913     #  'index' => [ [] ],
2914     #},
2915
2916     'prepay_credit' => {
2917       'columns' => [
2918         'prepaynum',   'serial',     '',   '', '', '',
2919         'identifier',  'varchar', '', $char_d, '', '',
2920         'amount',      @money_type, '', '',
2921         'seconds',     'int',     'NULL', '', '', '',
2922         'upbytes',     'bigint',     'NULL', '', '', '',
2923         'downbytes',   'bigint',     'NULL', '', '', '',
2924         'totalbytes',  'bigint',     'NULL', '', '', '',
2925         'agentnum',    'int',     'NULL', '', '', '',
2926       ],
2927       'primary_key' => 'prepaynum',
2928       'unique'      => [ ['identifier'] ],
2929       'index'       => [ ['agentnum'] ],
2930     },
2931
2932     'port' => {
2933       'columns' => [
2934         'portnum',  'serial',     '',   '', '', '',
2935         'ip',       'varchar', 'NULL', 15, '', '',
2936         'nasport',  'int',     'NULL', '', '', '',
2937         'nasnum',   'int',     '',   '', '', '',
2938       ],
2939       'primary_key' => 'portnum',
2940       'unique'      => [],
2941       'index'       => [],
2942     },
2943
2944     'nas' => {
2945       'columns' => [
2946         'nasnum',       'serial',     '',  '',              '', '',
2947         'nasname',     'varchar',     '', 128,              '', '',
2948         'shortname',   'varchar', 'NULL',  32,              '', '',
2949         'type',        'varchar',     '',  30,         'other', '',
2950         'ports',           'int', 'NULL',  '',              '', '',
2951         'secret',      'varchar',     '',  60,        'secret', '',
2952         'server',      'varchar', 'NULL',  64,              '', '',
2953         'community',   'varchar', 'NULL',  50,              '', '',
2954         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2955         'svcnum',          'int', 'NULL',  '',              '', '',
2956       ],
2957       'primary_key' => 'nasnum',
2958       'unique'      => [ [ 'nasname' ], ],
2959       'index'       => [],
2960     },
2961
2962     'export_nas' => {
2963       'columns' => [
2964         'exportnasnum', 'serial', '', '', '', '',
2965         'exportnum',       'int', '', '', '', '',
2966         'nasnum',          'int', '', '', '', '',
2967       ],
2968       'primary_key' => 'exportnasnum',
2969       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2970       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
2971     },
2972
2973     'queue' => {
2974       'columns' => [
2975         'jobnum',   'bigserial',     '',      '', '', '',
2976         'job',        'varchar',     '',     512, '', '',
2977         '_date',          'int',     '',      '', '', '',
2978         'status',     'varchar',     '', $char_d, '', '',
2979         'statustext',    'text', 'NULL',      '', '', '',
2980         'svcnum',         'int', 'NULL',      '', '', '',
2981         'custnum',        'int', 'NULL',      '', '', '',
2982         'secure',        'char', 'NULL',       1, '', '',
2983         'priority',       'int', 'NULL',      '', '', '',
2984         'usernum',        'int', 'NULL',      '', '', '',
2985       ],
2986       'primary_key' => 'jobnum',
2987       'unique'      => [],
2988       'index'       => [ [ 'secure' ], [ 'priority' ],
2989                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2990                        ],
2991     },
2992
2993     'queue_arg' => {
2994       'columns' => [
2995         'argnum', 'bigserial',     '', '', '', '',
2996         'jobnum',    'bigint',     '', '', '', '',
2997         'frozen',      'char', 'NULL',  1, '', '',
2998         'arg',         'text', 'NULL', '', '', '',
2999       ],
3000       'primary_key' => 'argnum',
3001       'unique'      => [],
3002       'index'       => [ [ 'jobnum' ] ],
3003     },
3004
3005     'queue_depend' => {
3006       'columns' => [
3007         'dependnum',  'bigserial', '', '', '', '',
3008         'jobnum',        'bigint', '', '', '', '',
3009         'depend_jobnum', 'bigint', '', '', '', '',
3010       ],
3011       'primary_key' => 'dependnum',
3012       'unique'      => [],
3013       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
3014     },
3015
3016     'queue_stat' => {
3017       'columns' => [
3018         'statnum', 'bigserial',     '',  '', '', '',
3019         'jobnum',     'bigint',     '',  '', '', '',
3020         'job',       'varchar',     '', 512, '', '',
3021         'custnum',       'int', 'NULL',  '', '', '',
3022         'insert_date', @date_type, '', '',
3023         'start_date',  @date_type, '', '',
3024         'end_date',    @date_type, '', '',
3025       ],
3026       'primary_key'  => 'statnum',
3027       'unique'       => [], #[ ['jobnum'] ],
3028       'index'        => [],
3029     },
3030
3031     'export_svc' => {
3032       'columns' => [
3033         'exportsvcnum' => 'serial', '', '', '', '',
3034         'exportnum'    => 'int', '', '', '', '',
3035         'svcpart'      => 'int', '', '', '', '',
3036         'role'         => 'varchar', 'NULL', 16, '', '',
3037       ],
3038       'primary_key' => 'exportsvcnum',
3039       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
3040       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
3041     },
3042
3043     'export_device' => {
3044       'columns' => [
3045         'exportdevicenum' => 'serial', '', '', '', '',
3046         'exportnum'    => 'int', '', '', '', '',
3047         'devicepart'      => 'int', '', '', '', '',
3048       ],
3049       'primary_key' => 'exportdevicenum',
3050       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
3051       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
3052     },
3053
3054     'part_export' => {
3055       'columns' => [
3056         'exportnum',   'serial',     '',      '', '', '',
3057         'exportname', 'varchar', 'NULL', $char_d, '', '',
3058         'machine',    'varchar', 'NULL', $char_d, '', '',
3059         'exporttype', 'varchar',     '', $char_d, '', '',
3060         'nodomain',      'char', 'NULL',       1, '', '',
3061         'default_machine','int', 'NULL',      '', '', '',
3062         'no_suspend',    'char', 'NULL',       1, '', '',
3063         # could also have 'no_insert', 'no_replace', etc.
3064       ],
3065       'primary_key' => 'exportnum',
3066       'unique'      => [],
3067       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
3068     },
3069
3070     'part_export_option' => {
3071       'columns' => [
3072         'optionnum', 'serial', '', '', '', '',
3073         'exportnum', 'int', '', '', '', '',
3074         'optionname', 'varchar', '', $char_d, '', '',
3075         'optionvalue', 'text', 'NULL', '', '', '',
3076       ],
3077       'primary_key' => 'optionnum',
3078       'unique'      => [],
3079       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
3080     },
3081
3082     'radius_usergroup' => {
3083       'columns' => [
3084         'usergroupnum', 'serial', '', '', '', '',
3085         'svcnum',       'int', '', '', '', '',
3086         'groupname',    'varchar', 'NULL', $char_d, '', '',
3087         'groupnum',     'int', 'NULL', '', '', '',
3088       ],
3089       'primary_key' => 'usergroupnum',
3090       'unique'      => [],
3091       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
3092     },
3093
3094     'radius_group' => {
3095       'columns' => [
3096         'groupnum', 'serial', '', '', '', '',
3097         'groupname',    'varchar', '', $char_d, '', '',
3098         'description',  'varchar', 'NULL', $char_d, '', '',
3099         'priority', 'int', '', '', '1', '',
3100         'speed_up', 'int', 'NULL', '', '', '',
3101         'speed_down', 'int', 'NULL', '', '', '',
3102       ],
3103       'primary_key' => 'groupnum',
3104       'unique'      => [ ['groupname'] ],
3105       'index'       => [],
3106     },
3107
3108     'radius_attr' => {
3109       'columns' => [
3110         'attrnum',   'serial', '',      '', '', '',
3111         'groupnum',     'int', '',      '', '', '',
3112         'attrname', 'varchar', '', $char_d, '', '',
3113         'value',    'varchar', '',     255, '', '',
3114         'attrtype',    'char', '',       1, '', '',
3115         'op',          'char', '',       2, '', '',
3116       ],
3117       'primary_key' => 'attrnum',
3118       'unique'      => [],
3119       'index'       => [ ['groupnum'], ],
3120     },
3121
3122     'msgcat' => {
3123       'columns' => [
3124         'msgnum', 'serial', '', '', '', '',
3125         'msgcode', 'varchar', '', 255, '', '',
3126         'locale', 'varchar', '', 16, '', '',
3127         'msg', 'text', '', '', '', '',
3128       ],
3129       'primary_key' => 'msgnum',
3130       'unique'      => [ [ 'msgcode', 'locale' ] ],
3131       'index'       => [],
3132     },
3133
3134     'cust_tax_exempt' => {
3135       'columns' => [
3136         'exemptnum', 'serial', '', '', '', '',
3137         'custnum',   'int', '', '', '', '',
3138         'taxnum',    'int', '', '', '', '',
3139         'year',      'int', '', '', '', '',
3140         'month',     'int', '', '', '', '',
3141         'amount',   @money_type, '', '',
3142       ],
3143       'primary_key' => 'exemptnum',
3144       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
3145       'index'       => [],
3146     },
3147
3148     'cust_tax_exempt_pkg' => {
3149       'columns' => [
3150         'exemptpkgnum',  'serial', '', '', '', '',
3151         #'custnum',      'int', '', '', '', ''
3152         'billpkgnum',   'int', '', '', '', '',
3153         'taxnum',       'int', '', '', '', '',
3154         'taxtype',  'varchar', 'NULL', $char_d, '', '',
3155         'year',         'int', 'NULL', '', '', '',
3156         'month',        'int', 'NULL', '', '', '',
3157         'creditbillpkgnum', 'int', 'NULL', '', '', '',
3158         'amount',       @money_type, '', '',
3159         # exemption type flags
3160         'exempt_cust',          'char', 'NULL', 1, '', '',
3161         'exempt_setup',         'char', 'NULL', 1, '', '',
3162         'exempt_recur',         'char', 'NULL', 1, '', '',
3163         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
3164         'exempt_monthly',       'char', 'NULL', 1, '', '',
3165       ],
3166       'primary_key' => 'exemptpkgnum',
3167       'unique' => [],
3168       'index'  => [ [ 'taxnum', 'year', 'month' ],
3169                     [ 'billpkgnum' ],
3170                     [ 'taxnum', 'taxtype' ],
3171                     [ 'creditbillpkgnum' ],
3172                   ],
3173     },
3174
3175     'cust_tax_exempt_pkg_void' => {
3176       'columns' => [
3177         'exemptpkgnum',  'int', '', '', '', '',
3178         #'custnum',      'int', '', '', '', ''
3179         'billpkgnum',   'int', '', '', '', '',
3180         'taxnum',       'int', '', '', '', '',
3181         'taxtype',  'varchar', 'NULL', $char_d, '', '',
3182         'year',         'int', 'NULL', '', '', '',
3183         'month',        'int', 'NULL', '', '', '',
3184         'creditbillpkgnum', 'int', 'NULL', '', '', '',
3185         'amount',       @money_type, '', '',
3186         # exemption type flags
3187         'exempt_cust',          'char', 'NULL', 1, '', '',
3188         'exempt_setup',         'char', 'NULL', 1, '', '',
3189         'exempt_recur',         'char', 'NULL', 1, '', '',
3190         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
3191         'exempt_monthly',       'char', 'NULL', 1, '', '',
3192       ],
3193       'primary_key' => 'exemptpkgnum',
3194       'unique' => [],
3195       'index'  => [ [ 'taxnum', 'year', 'month' ],
3196                     [ 'billpkgnum' ],
3197                     [ 'taxnum', 'taxtype' ],
3198                     [ 'creditbillpkgnum' ],
3199                   ],
3200     },
3201
3202     'router' => {
3203       'columns' => [
3204         'routernum', 'serial', '', '', '', '',
3205         'routername', 'varchar', '', $char_d, '', '',
3206         'svcnum', 'int', 'NULL', '', '', '',
3207         'agentnum',   'int', 'NULL', '', '', '',
3208         'manual_addr', 'char', 'NULL', 1, '', '',
3209       ],
3210       'primary_key' => 'routernum',
3211       'unique'      => [],
3212       'index'       => [],
3213     },
3214
3215     'part_svc_router' => {
3216       'columns' => [
3217         'svcrouternum', 'serial', '', '', '', '',
3218         'svcpart', 'int', '', '', '', '',
3219         'routernum', 'int', '', '', '', '',
3220       ],
3221       'primary_key' => 'svcrouternum',
3222       'unique'      => [],
3223       'index'       => [],
3224     },
3225
3226     'addr_block' => {
3227       'columns' => [
3228         'blocknum', 'serial', '', '', '', '',
3229         'routernum', 'int', '', '', '', '',
3230         'ip_gateway', 'varchar', '', 15, '', '',
3231         'ip_netmask', 'int', '', '', '', '',
3232         'agentnum',   'int', 'NULL', '', '', '',
3233         'manual_flag', 'char', 'NULL', 1, '', '',
3234       ],
3235       'primary_key' => 'blocknum',
3236       'unique'      => [ [ 'blocknum', 'routernum' ] ],
3237       'index'       => [],
3238     },
3239
3240     'addr_range' => {
3241       'columns' => [
3242         'rangenum', 'serial', '', '', '', '',
3243         'start',    'varchar', '', 15, '', '',
3244         'length',   'int', '', '', '', '',
3245         'status',   'varchar', 'NULL', 32, '', '',
3246       ],
3247       'primary_key' => 'rangenum',
3248       'unique'      => [],
3249       'index'       => [],
3250     },
3251
3252     'svc_broadband' => {
3253       'columns' => [
3254         'svcnum',                  'int',     '',        '', '', '',
3255         'description',         'varchar', 'NULL',   $char_d, '', '',
3256         'routernum',               'int', 'NULL',        '', '', '',
3257         'blocknum',                'int', 'NULL',        '', '', '',
3258         'sectornum',               'int', 'NULL',        '', '', '',
3259         'speed_up',                'int', 'NULL',        '', '', '',
3260         'speed_down',              'int', 'NULL',        '', '', '',
3261         'ip_addr',             'varchar', 'NULL',        15, '', '',
3262         'mac_addr',            'varchar', 'NULL',        12, '', '',
3263         'authkey',             'varchar', 'NULL',        32, '', '',
3264         'latitude',            'decimal', 'NULL',    '10,7', '', '',
3265         'longitude',           'decimal', 'NULL',    '10,7', '', '',
3266         'altitude',            'decimal', 'NULL',        '', '', '',
3267         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
3268         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
3269         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
3270         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
3271         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
3272         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
3273         'rssi',                    'int', 'NULL',        '', '', '',
3274         'suid',                    'int', 'NULL',        '', '', '',
3275         'shared_svcnum',           'int', 'NULL',        '', '', '',
3276         'serviceid',           'varchar', 'NULL',        64, '', '',#srvexport/reportfields
3277       ],
3278       'primary_key' => 'svcnum',
3279       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
3280       'index'       => [],
3281     },
3282
3283     'tower' => {
3284       'columns' => [
3285         'towernum',    'serial',     '',      '', '', '',
3286         #'agentnum',       'int', 'NULL',      '', '', '',
3287         'towername',  'varchar',     '', $char_d, '', '',
3288         'disabled',      'char', 'NULL',       1, '', '',
3289         'latitude',   'decimal', 'NULL',  '10,7', '', '',
3290         'longitude',  'decimal', 'NULL',  '10,7', '', '',
3291         'coord_auto',    'char', 'NULL',       1, '', '',
3292         'altitude',   'decimal', 'NULL',      '', '', '',
3293         'height',     'decimal', 'NULL',      '', '', '',
3294         'veg_height', 'decimal', 'NULL',      '', '', '',
3295         'color',      'varchar', 'NULL',       6, '', '',
3296       ],
3297       'primary_key' => 'towernum',
3298       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
3299       'index'       => [],
3300     },
3301
3302     'tower_sector' => {
3303       'columns' => [
3304         'sectornum',     'serial',     '',      '', '', '',
3305         'towernum',         'int',     '',      '', '', '',
3306         'sectorname',   'varchar',     '', $char_d, '', '',
3307         'ip_addr',      'varchar', 'NULL',      15, '', '',
3308         'height',       'decimal', 'NULL',      '', '', '',
3309         'freq_mhz',         'int', 'NULL',      '', '', '',
3310         'direction',        'int', 'NULL',      '', '', '',
3311         'width',            'int', 'NULL',      '', '', '',
3312         #downtilt etc? rfpath has profile files for devices/antennas you upload?
3313         'sector_range', 'decimal', 'NULL',      '', '', '',  #?
3314       ],
3315       'primary_key' => 'sectornum',
3316       'unique'      => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
3317       'index'       => [ [ 'towernum' ] ],
3318     },
3319
3320     'part_virtual_field' => {
3321       'columns' => [
3322         'vfieldpart', 'serial', '', '', '', '',
3323         'dbtable', 'varchar', '', 32, '', '',
3324         'name', 'varchar', '', 32, '', '',
3325         'length', 'int', 'NULL', '', '', '',
3326         'label', 'varchar', 'NULL', 80, '', '',
3327       ],
3328       'primary_key' => 'vfieldpart',
3329       'unique' => [],
3330       'index' => [],
3331     },
3332
3333     'virtual_field' => {
3334       'columns' => [
3335         'vfieldnum', 'serial', '', '', '', '',
3336         'recnum', 'int', '', '', '', '',
3337         'vfieldpart', 'int', '', '', '', '',
3338         'value', 'varchar', '', 128, '', '',
3339       ],
3340       'primary_key' => 'vfieldnum',
3341       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
3342       'index' => [],
3343     },
3344
3345     'acct_snarf' => {
3346       'columns' => [
3347         'snarfnum',    'serial',     '',      '', '', '',
3348         'snarfname',  'varchar', 'NULL', $char_d, '', '',
3349         'svcnum',         'int',     '',      '', '', '',
3350         'machine',    'varchar',     '',     255, '', '',
3351         'protocol',   'varchar',     '', $char_d, '', '',
3352         'username',   'varchar',     '', $char_d, '', '',
3353         '_password',  'varchar',     '', $char_d, '', '',
3354         'check_freq',     'int', 'NULL',      '', '', '',
3355         'leavemail',     'char', 'NULL',       1, '', '',
3356         'apop',          'char', 'NULL',       1, '', '',
3357         'tls',           'char', 'NULL',       1, '', '',
3358         'mailbox',    'varchar', 'NULL', $char_d, '', '',
3359       ],
3360       'primary_key' => 'snarfnum',
3361       'unique' => [],
3362       'index'  => [ [ 'svcnum' ] ],
3363     },
3364
3365     'svc_external' => {
3366       'columns' => [
3367         'svcnum',     'int',     '',      '', '', '',
3368         'id',      'bigint', 'NULL',      '', '', '',
3369         'title',  'varchar', 'NULL', $char_d, '', '',
3370       ],
3371       'primary_key' => 'svcnum',
3372       'unique'      => [],
3373       'index'       => [],
3374     },
3375
3376     'cust_pay_refund' => {
3377       'columns' => [
3378         'payrefundnum', 'serial', '', '', '', '',
3379         'paynum',  'int', '', '', '', '',
3380         'refundnum',  'int', '', '', '', '',
3381         '_date',    @date_type, '', '',
3382         'amount',   @money_type, '', '',
3383       ],
3384       'primary_key' => 'payrefundnum',
3385       'unique' => [],
3386       'index' => [ ['paynum'], ['refundnum'] ],
3387     },
3388
3389     'part_pkg_option' => {
3390       'columns' => [
3391         'optionnum', 'serial', '', '', '', '',
3392         'pkgpart', 'int', '', '', '', '',
3393         'optionname', 'varchar', '', $char_d, '', '',
3394         'optionvalue', 'text', 'NULL', '', '', '',
3395       ],
3396       'primary_key' => 'optionnum',
3397       'unique'      => [],
3398       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
3399     },
3400
3401     'part_pkg_vendor' => {
3402       'columns' => [
3403         'num', 'serial', '', '', '', '',
3404         'pkgpart', 'int', '', '', '', '',
3405         'exportnum', 'int', '', '', '', '',
3406         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
3407       ],
3408       'primary_key' => 'num',
3409       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
3410       'index'       => [ [ 'pkgpart' ] ],
3411     },
3412
3413     'part_pkg_report_option' => {
3414       'columns' => [
3415         'num',      'serial',   '',      '', '', '',
3416         'name',     'varchar',  '', $char_d, '', '',
3417         'disabled', 'char', 'NULL',       1, '', '',
3418       ],
3419       'primary_key' => 'num',
3420       'unique' => [ [ 'name' ] ],
3421       'index' => [ [ 'disabled' ] ],
3422     },
3423
3424     'part_pkg_usage' => {
3425       'columns' => [
3426         'pkgusagepart', 'serial',   '', '', '', '',
3427         'pkgpart',  'int',      '', '', '', '',
3428         'minutes',  'double precision',      '', '', '', '',
3429         'priority', 'int',  'NULL', '', '', '',
3430         'shared',   'char', 'NULL',  1, '', '',
3431         'rollover', 'char', 'NULL',  1, '', '',
3432         'description',  'varchar', 'NULL', $char_d, '', '',
3433       ],
3434       'primary_key' => 'pkgusagepart',
3435       'unique'      => [],
3436       'index'       => [ [ 'pkgpart' ] ],
3437     },
3438
3439     'part_pkg_usage_class' => {
3440       'columns' => [
3441         'num',       'serial',  '', '', '', '',
3442         'pkgusagepart', 'int',  '', '', '', '',
3443         'classnum',     'int','NULL', '', '', '',
3444       ],
3445       'primary_key' => 'num',
3446       'unique'      => [ [ 'pkgusagepart', 'classnum' ] ],
3447       'index'       => [],
3448     },
3449
3450     'part_pkg_fcc_option' => {
3451       'columns' => [
3452         'num',        'serial', '', '', '', '',
3453         'fccoptionname', 'varchar', '', $char_d, '', '',
3454         'pkgpart',       'int', '', '', '', '',
3455         'optionvalue',   'varchar', 'NULL', $char_d, '', '',
3456       ],
3457       'primary_key' => 'num',
3458       'unique'      => [ [ 'fccoptionname', 'pkgpart' ] ],
3459       'index'       => [],
3460     },
3461
3462     'rate' => {
3463       'columns' => [
3464         'ratenum',          'serial',     '', '', '', '',
3465         'ratename',        'varchar', '',$char_d, '', '',
3466         'agentnum',            'int', 'NULL', '', '', '',
3467         'default_detailnum',   'int', 'NULL', '', '', '',
3468       ],
3469       'primary_key' => 'ratenum',
3470       'unique'      => [],
3471       'index'       => [],
3472     },
3473
3474     'rate_detail' => {
3475       'columns' => [
3476         'ratedetailnum',   'serial',  '',     '',      '', '',
3477         'ratenum',         'int',     '',     '',      '', '',
3478         'orig_regionnum',  'int', 'NULL',     '',      '', '',
3479         'dest_regionnum',  'int', 'NULL',     '',      '', '',
3480         'min_included',    'int',     '',     '',      '', '',
3481         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
3482         'conn_cost',       'decimal', '', '10,4', '0.0000', '',
3483         'conn_sec',        'int',     '',     '',      '0', '',
3484         'min_charge',      'decimal', '', '10,5',       '', '',
3485         'min_cost',        'decimal', '', '10,5','0.00000', '',
3486         'sec_granularity', 'int',     '',     '',       '', '',
3487         'ratetimenum',     'int', 'NULL',     '',       '', '',
3488         'classnum',        'int', 'NULL',     '',       '', '',
3489         'cdrtypenum',      'int', 'NULL',     '',       '', '',
3490         'region_group',   'char', 'NULL',      1,       '', '',
3491         'upstream_mult_charge',  'decimal',  '', '10,4', '0.0000', '',
3492         'upstream_mult_cost',    'decimal',  '', '10,4', '0.0000', '',
3493       ],
3494       'primary_key' => 'ratedetailnum',
3495       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
3496       'index'       => [ [ 'ratenum', 'dest_regionnum' ],
3497                          [ 'ratenum', 'ratetimenum' ]
3498                        ],
3499     },
3500
3501     'rate_region' => {
3502       'columns' => [
3503         'regionnum',   'serial',      '', '', '', '',
3504         'regionname',  'varchar',     '', $char_d, '', '',
3505         'exact_match', 'char',    'NULL',  1, '', '',
3506       ],
3507       'primary_key' => 'regionnum',
3508       'unique'      => [],
3509       'index'       => [],
3510     },
3511
3512     'rate_prefix' => {
3513       'columns' => [
3514         'prefixnum',   'serial',      '', '', '', '',
3515         'regionnum',   'int',         '', '', '', '',
3516         'countrycode', 'varchar',     '',  3, '', '',
3517         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
3518         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
3519         'latanum',     'int',     'NULL',      '', '', '',
3520         'state',       'char',    'NULL',       2, '', '',
3521         'ocn',         'char',    'NULL',       4, '', '',
3522       ],
3523       'primary_key' => 'prefixnum',
3524       'unique'      => [],
3525       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
3526     },
3527
3528     'rate_time' => {
3529       'columns' => [
3530         'ratetimenum', 'serial',      '',      '', '', '',
3531         'ratetimename',   'varchar',      '', $char_d, '', '',
3532       ],
3533       'primary_key' => 'ratetimenum',
3534       'unique'      => [],
3535       'index'       => [],
3536     },
3537
3538     'rate_time_interval' => {
3539       'columns' => [
3540         'intervalnum', 'serial', '', '', '', '',
3541         'stime',          'int', '', '', '', '',
3542         'etime',          'int', '', '', '', '',
3543         'ratetimenum',    'int', '', '', '', '',
3544       ],
3545       'primary_key' => 'intervalnum',
3546       'unique'      => [],
3547       'index'       => [],
3548     },
3549
3550     #not really part of the above rate_ stuff (used with flat rate rather than
3551     # rated billing), but could be eventually, and its a rate
3552     'rate_tier' => {
3553       'columns' => [
3554         'tiernum',   'serial', '',      '', '', '',
3555         'tiername', 'varchar', '', $char_d, '', '',
3556       ],
3557       'primary_key' => 'tiernum',
3558       'unique'      => [ [ 'tiername'], ],
3559       'index'       => [],
3560     },
3561
3562     'rate_tier_detail' => {
3563       'columns' => [
3564         'tierdetailnum', 'serial', '',     '', '', '',
3565         'tiernum',          'int', '',     '', '', '',
3566         'min_quan',         'int', '',     '', '', '',
3567         'min_charge',   'decimal', '', '10,4', '', '',
3568       ],
3569       'primary_key' => 'tierdetailnum',
3570       'unique'      => [],
3571       'index'       => [ ['tiernum'], ],
3572     },
3573
3574     'usage_class' => {
3575       'columns' => [
3576         'classnum',    'serial',      '',      '', '', '',
3577         'weight',      'int',     'NULL',      '', '', '',
3578         'classname',   'varchar',     '', $char_d, '', '',
3579         'format',      'varchar', 'NULL', $char_d, '', '',
3580         'disabled',    'char',    'NULL',       1, '', '',
3581       ],
3582       'primary_key' => 'classnum',
3583       'unique' => [],
3584       'index' => [ ['disabled'] ],
3585     },
3586
3587     'reg_code' => {
3588       'columns' => [
3589         'codenum',   'serial',    '', '', '', '',
3590         'code',      'varchar',   '', $char_d, '', '',
3591         'agentnum',  'int',       '', '', '', '',
3592       ],
3593       'primary_key' => 'codenum',
3594       'unique'      => [ [ 'agentnum', 'code' ] ],
3595       'index'       => [ [ 'agentnum' ] ],
3596     },
3597
3598     'reg_code_pkg' => {
3599       'columns' => [
3600         'codepkgnum', 'serial', '', '', '', '',
3601         'codenum',   'int',    '', '', '', '',
3602         'pkgpart',   'int',    '', '', '', '',
3603       ],
3604       'primary_key' => 'codepkgnum',
3605       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
3606       'index'       => [ [ 'codenum' ] ],
3607     },
3608
3609     'clientapi_session' => {
3610       'columns' => [
3611         'sessionnum',  'serial',  '', '', '', '',
3612         'sessionid',  'varchar',  '', $char_d, '', '',
3613         'namespace',  'varchar',  '', $char_d, '', '',
3614       ],
3615       'primary_key' => 'sessionnum',
3616       'unique'      => [ [ 'sessionid', 'namespace' ] ],
3617       'index'       => [],
3618     },
3619
3620     'clientapi_session_field' => {
3621       'columns' => [
3622         'fieldnum',    'serial',     '', '', '', '',
3623         'sessionnum',     'int',     '', '', '', '',
3624         'fieldname',  'varchar',     '', $char_d, '', '',
3625         'fieldvalue',    'text', 'NULL', '', '', '',
3626       ],
3627       'primary_key' => 'fieldnum',
3628       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
3629       'index'       => [],
3630     },
3631
3632     'payment_gateway' => {
3633       'columns' => [
3634         'gatewaynum',       'serial',   '',     '', '', '',
3635         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
3636         'gateway_module',   'varchar',  '',     $char_d, '', '',
3637         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
3638         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
3639         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
3640         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
3641         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
3642         'disabled',   'char',  'NULL',   1, '', '',
3643       ],
3644       'primary_key' => 'gatewaynum',
3645       'unique' => [],
3646       'index'  => [ [ 'disabled' ] ],
3647     },
3648
3649     'payment_gateway_option' => {
3650       'columns' => [
3651         'optionnum',   'serial',  '',     '', '', '',
3652         'gatewaynum',  'int',     '',     '', '', '',
3653         'optionname',  'varchar', '',     $char_d, '', '',
3654         'optionvalue', 'text',    'NULL', '', '', '',
3655       ],
3656       'primary_key' => 'optionnum',
3657       'unique'      => [],
3658       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
3659     },
3660
3661     'agent_payment_gateway' => {
3662       'columns' => [
3663         'agentgatewaynum', 'serial', '', '', '', '',
3664         'agentnum',        'int', '', '', '', '',
3665         'gatewaynum',      'int', '', '', '', '',
3666         'cardtype',        'varchar', 'NULL', $char_d, '', '',
3667         'taxclass',        'varchar', 'NULL', $char_d, '', '',
3668       ],
3669       'primary_key' => 'agentgatewaynum',
3670       'unique'      => [],
3671       'index'       => [ [ 'agentnum', 'cardtype' ], ],
3672     },
3673
3674     'banned_pay' => {
3675       'columns' => [
3676         'bannum',  'serial',   '',     '', '', '',
3677         'payby',   'char',     '',       4, '', '',
3678         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
3679         #'paymask', 'varchar',  'NULL', $char_d, '', ''
3680         '_date',            @date_type,         '', '',
3681         'end_date',         @date_type,         '', '',
3682         'otaker',  'varchar',  'NULL',      32, '', '',
3683         'usernum',     'int',  'NULL',      '', '', '',
3684         'bantype', 'varchar',  'NULL', $char_d, '', '',
3685         'reason',  'varchar',  'NULL', $char_d, '', '',
3686       ],
3687       'primary_key' => 'bannum',
3688       'unique'      => [],
3689       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
3690     },
3691
3692     'pkg_category' => {
3693       'columns' => [
3694         'categorynum',        'serial',     '',      '', '', '',
3695         'categoryname',      'varchar',     '', $char_d, '', '',
3696         'weight',                'int', 'NULL',      '', '', '',
3697         'ticketing_queueid',     'int', 'NULL',      '', '', '',
3698         'condense',             'char', 'NULL',       1, '', '',
3699         'disabled',             'char', 'NULL',       1, '', '',
3700       ],
3701       'primary_key' => 'categorynum',
3702       'unique' => [],
3703       'index' => [ ['disabled'] ],
3704     },
3705
3706     'pkg_class' => {
3707       'columns' => [
3708         'classnum',    'serial',   '',      '', '', '',
3709         'classname',   'varchar',  '', $char_d, '', '',
3710         'categorynum', 'int',  'NULL',      '', '', '',
3711         'disabled',    'char', 'NULL',       1, '', '',
3712         'fcc_ds0s',      'int',     'NULL', '', '', '',
3713       ],
3714       'primary_key' => 'classnum',
3715       'unique' => [],
3716       'index' => [ ['disabled'] ],
3717     },
3718
3719     'cdr' => {
3720       'columns' => [
3721         # qw( name type null length default local );
3722
3723         ###
3724         #asterisk fields
3725         ###
3726
3727         'acctid',   'bigserial',  '', '', '', '',
3728         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
3729         'calldate', 'timestamp',   '',      '', \'now()', '',
3730         'clid',        'varchar',  '', $char_d, \"''", '',
3731         'src',         'varchar',  '', $char_d, \"''", '',
3732         'dst',         'varchar',  '', $char_d, \"''", '',
3733         'dcontext',    'varchar',  '', $char_d, \"''", '',
3734         'channel',     'varchar',  '', $char_d, \"''", '',
3735         'dstchannel',  'varchar',  '', $char_d, \"''", '',
3736         'lastapp',     'varchar',  '', $char_d, \"''", '',
3737         'lastdata',    'varchar',  '',     255, \"''", '',
3738
3739         #currently only opensips
3740         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
3741         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
3742
3743         #currently only u4:
3744         # terminating number (as opposed to dialed destination)
3745         'dst_term',    'varchar',  'NULL', $char_d, '', '',
3746
3747         #these don't seem to be logged by most of the SQL cdr_* modules
3748         #except tds under sql-illegal names, so;
3749         # ... don't rely on them for rating?
3750         # and, what they hey, i went ahead and changed the names and data types
3751         # to freeside-style dates...
3752           #'start',  'timestamp', 'NULL',  '',    '', '',
3753           #'answer', 'timestamp', 'NULL',  '',    '', '',
3754           #'end',    'timestamp', 'NULL',  '',    '', '',
3755         'startdate',  @date_type, '', '',
3756         'answerdate', @date_type, '', '',
3757         'enddate',    @date_type, '', '',
3758         #
3759
3760         'duration',    'int',      '',      '',     0, '',
3761         'billsec',     'int',      '',      '',     0, '',
3762         'disposition', 'varchar',  '',      45, \"''", '',
3763         'amaflags',    'int',      '',      '',     0, '',
3764         'accountcode', 'varchar',  '',      32, \"''", '',
3765         'uniqueid',    'varchar',  '', $char_d, \"''", '',
3766         'userfield',   'varchar',  '',     512, \"''", '',
3767
3768         'max_callers', 'int',  'NULL',      '',    '', '',
3769
3770         ###
3771         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
3772         # ones we adoped moved to "own fields" section below
3773         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
3774         ###
3775
3776         'upstream_currency',      'char', 'NULL',       3, '', '',
3777         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
3778
3779         # how it was rated internally...
3780         'ratedetailnum',           'int', 'NULL',      '', '', '',
3781
3782         'distance',            'decimal', 'NULL',      '', '', '',
3783         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
3784
3785         #cdr_calltype: the big list in appendix 2
3786         'calltypenum',             'int', 'NULL',      '', '', '',
3787
3788         'description',         'varchar', 'NULL', $char_d, '', '',
3789         'quantity',                'int', 'NULL',      '', '', '',
3790
3791         'upstream_rateid',         'int', 'NULL',      '', '', '',
3792
3793         ###
3794         # more fields, for GSM imports
3795         ###
3796         'servicecode',             'int', 'NULL',      '', '', '',
3797         'quantity_able',           'int', 'NULL',      '', '', '',
3798
3799         ###
3800         #and now for our own fields
3801         ###
3802
3803         'cdrtypenum',              'int', 'NULL',      '', '', '',
3804
3805         'charged_party',       'varchar', 'NULL', $char_d, '', '',
3806         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
3807
3808         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
3809         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
3810         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
3811
3812         # how it was rated internally...
3813         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
3814         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
3815         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
3816         'rated_seconds',              'int', 'NULL',      '', '', '',
3817         'rated_minutes', 'double precision', 'NULL',      '', '', '',
3818         'rated_granularity',          'int', 'NULL',      '', '', '',
3819         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
3820         'rated_classnum',             'int', 'NULL',      '', '', '',
3821         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
3822         'rated_cost',            'decimal', 'NULL',  '10,4', '', '',
3823
3824         'carrierid',               'bigint', 'NULL',      '', '', '',
3825
3826         # service it was matched to
3827         'svcnum',             'int',   'NULL',     '',   '', '',
3828
3829         #NULL, done (or something)
3830         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
3831
3832         #NULL, done (or something)
3833         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
3834
3835         #an indexed place to put big numbers
3836         'cdrid',         'bigint',     'NULL',     '',  '', '',
3837
3838         #for taqua accountcode rewriting, for starters
3839         'sessionnum',       'int',    'NULL',      '', '', '',
3840         'subscriber',   'varchar',    'NULL', $char_d, '', '',
3841
3842         #old
3843         'cdrbatch',     'varchar',    'NULL',     255, '', '',
3844         #new
3845         'cdrbatchnum',      'int',    'NULL',      '', '', '',
3846
3847       ],
3848       'primary_key' => 'acctid',
3849       'unique' => [],
3850       'index' => [ [ 'calldate' ],
3851                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
3852                    [ 'lastapp' ],
3853                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
3854                    [ 'sessionnum' ], [ 'subscriber' ],
3855                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
3856                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
3857                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ], [ 'dst_term' ],
3858                  ],
3859     },
3860
3861     'cdr_batch' => {
3862       'columns' => [
3863         'cdrbatchnum',   'serial',    '',   '', '', '',
3864         'cdrbatch', 'varchar', 'NULL', 255, '', '',
3865         '_date',     @date_type, '', '',
3866       ],
3867       'primary_key' => 'cdrbatchnum',
3868       'unique' => [ [ 'cdrbatch' ] ],
3869       'index' => [],
3870     },
3871
3872     'cdr_termination' => {
3873       'columns' => [
3874         'cdrtermnum', 'bigserial',     '',      '', '', '',
3875         'acctid',        'bigint',     '',      '', '', '',
3876         'termpart',         'int',     '',      '', '', '',#future use see below
3877         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
3878         'rated_seconds',    'int', 'NULL',      '', '', '',
3879         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3880         'status',       'varchar', 'NULL',      32, '', '',
3881         'svcnum',           'int', 'NULL',      '', '', '',
3882       ],
3883       'primary_key' => 'cdrtermnum',
3884       'unique'      => [ [ 'acctid', 'termpart' ] ],
3885       'index'       => [ [ 'acctid' ], [ 'status' ], ],
3886     },
3887
3888     #to handle multiple termination/settlement passes...
3889    # 'part_termination' => {
3890    #   'columns' => [
3891    #     'termpart',       'int', '',      '', '', '',
3892    #     'termname',   'varchar', '', $char_d, '', '',
3893    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
3894    #   ],
3895    #   'primary_key' => 'termpart',
3896    #   'unique' => [],
3897    #   'index'  => [],
3898    # },
3899
3900     #the remaining cdr_ tables are not really used
3901     'cdr_calltype' => {
3902       'columns' => [
3903         'calltypenum',   'serial',  '', '', '', '',
3904         'calltypename',  'varchar', '', $char_d, '', '',
3905       ],
3906       'primary_key' => 'calltypenum',
3907       'unique'      => [],
3908       'index'       => [],
3909     },
3910
3911     'cdr_type' => {
3912       'columns' => [
3913         'cdrtypenum'  => 'serial',  '', '', '', '',
3914         'cdrtypename' => 'varchar', '', $char_d, '', '',
3915       ],
3916       'primary_key' => 'cdrtypenum',
3917       'unique'      => [],
3918       'index'       => [],
3919     },
3920
3921     'cdr_carrier' => {
3922       'columns' => [
3923         'carrierid'   =>  'serial',     '',      '', '', '',
3924         'carriername' => 'varchar',     '', $char_d, '', '',
3925         'disabled'    =>    'char', 'NULL',       1, '', '',
3926       ],
3927       'primary_key' => 'carrierid',
3928       'unique'      => [],
3929       'index'       => [],
3930     },
3931
3932     #'cdr_file' => {
3933     #  'columns' => [
3934     #    'filenum',    'serial',     '', '', '', '',
3935     #    'filename',  'varchar',     '', '', '', '',
3936     #    'status',    'varchar', 'NULL', '', '', '',
3937     #  ],
3938     #  'primary_key' => 'filenum',
3939     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
3940     #                                   # agent-virtualize or have a customer
3941     #                                   # with dup-filename needs or something
3942     #                                   # (only used by cdr.http_and_import for
3943     #                                   #  chrissakes)
3944     #  'index'  => [],
3945     #},
3946
3947     'inventory_item' => {
3948       'columns' => [
3949         'itemnum',   'serial',      '',      '', '', '',
3950         'classnum',  'int',         '',      '', '', '',
3951         'agentnum',  'int',     'NULL',      '', '', '',
3952         'item',      'varchar',     '', $char_d, '', '',
3953         'svcnum',    'int',     'NULL',      '', '', '',
3954         'svc_field', 'varchar', 'NULL', $char_d, '', '',
3955       ],
3956       'primary_key' => 'itemnum',
3957       'unique' => [ [ 'classnum', 'item' ] ],
3958       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3959     },
3960
3961     'inventory_class' => {
3962       'columns' => [
3963         'classnum',  'serial',       '',      '', '', '',
3964         'classname', 'varchar',      '', $char_d, '', '',
3965       ],
3966       'primary_key' => 'classnum',
3967       'unique' => [],
3968       'index'  => [],
3969     },
3970
3971     'access_user_session' => {
3972       'columns' => [
3973         'sessionnum',   'serial',  '',      '', '', '',
3974         'sessionkey',  'varchar',  '', $char_d, '', '',
3975         'usernum',         'int',  '',      '', '', '',
3976         'start_date', @date_type,               '', '',
3977         'last_date',  @date_type,               '', '',
3978       ],
3979       'primary_key' => 'sessionnum',
3980       'unique' => [ [ 'sessionkey' ] ],
3981       'index'  => [],
3982     },
3983
3984     'access_user' => {
3985       'columns' => [
3986         'usernum',            'serial',      '',      '', '', '',
3987         'username',           'varchar',     '', $char_d, '', '',
3988         '_password',          'varchar',     '', $char_d, '', '',
3989         'last',               'varchar',     '', $char_d, '', '',
3990         'first',              'varchar',     '', $char_d, '', '',
3991         'user_custnum',           'int', 'NULL',      '', '', '',
3992         'report_salesnum',        'int', 'NULL',      '', '', '',
3993         'disabled',              'char', 'NULL',       1, '', '',
3994       ],
3995       'primary_key' => 'usernum',
3996       'unique' => [ [ 'username' ] ],
3997       'index'  => [ [ 'user_custnum' ] ],
3998     },
3999
4000     'access_user_pref' => {
4001       'columns' => [
4002         'prefnum',    'serial',       '', '', '', '',
4003         'usernum',     'int',       '', '', '', '',
4004         'prefname', 'varchar', '', $char_d, '', '',
4005         'prefvalue', 'text', 'NULL', '', '', '',
4006         'expiration', @date_type, '', '',
4007       ],
4008       'primary_key' => 'prefnum',
4009       'unique' => [],
4010       'index'  => [ [ 'usernum' ] ],
4011     },
4012
4013     'access_group' => {
4014       'columns' => [
4015         'groupnum',   'serial', '',      '', '', '',
4016         'groupname', 'varchar', '', $char_d, '', '',
4017       ],
4018       'primary_key' => 'groupnum',
4019       'unique' => [ [ 'groupname' ] ],
4020       'index'  => [],
4021     },
4022
4023     'access_usergroup' => {
4024       'columns' => [
4025         'usergroupnum', 'serial', '', '', '', '',
4026         'usernum',         'int', '', '', '', '',
4027         'groupnum',        'int', '', '', '', '',
4028       ],
4029       'primary_key' => 'usergroupnum',
4030       'unique' => [ [ 'usernum', 'groupnum' ] ],
4031       'index'  => [ [ 'usernum' ] ],
4032     },
4033
4034     'access_groupagent' => {
4035       'columns' => [
4036         'groupagentnum', 'serial', '', '', '', '',
4037         'groupnum',         'int', '', '', '', '',
4038         'agentnum',         'int', '', '', '', '',
4039       ],
4040       'primary_key' => 'groupagentnum',
4041       'unique' => [ [ 'groupnum', 'agentnum' ] ],
4042       'index'  => [ [ 'groupnum' ] ],
4043     },
4044
4045     'access_right' => {
4046       'columns' => [
4047         'rightnum',   'serial', '',      '', '', '',
4048         'righttype', 'varchar', '', $char_d, '', '',
4049         'rightobjnum',   'int', '',      '', '', '',
4050         'rightname', 'varchar', '', $char_d, '', '',
4051       ],
4052       'primary_key' => 'rightnum',
4053       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
4054       'index'  => [],
4055     },
4056
4057     'access_user_log' => {
4058       'columns'      => [
4059         'lognum',  'serial', '',        '', '', '',
4060         'usernum',    'int', '',        '', '', '',
4061         'path',   'varchar', '', 2*$char_d, '', '',
4062         '_date',         @date_type,        '', '',
4063       ],
4064       'primary_key'  => 'lognum',
4065       'unique'       => [],
4066       'index'        => [ ['usernum'], ['path'], ['_date'] ],
4067     },
4068
4069     'sched_item' => {
4070       'columns' => [
4071         'itemnum',   'serial',      '', '', '', '',
4072         'usernum',      'int',  'NULL', '', '', '',
4073         #'itemname', 'varchar', $char_d, '', '', '',
4074         'disabled',    'char',  'NULL',  1, '', '',
4075       ],
4076       'primary_key'  => 'itemnum',
4077       'unique'       => [ [ 'usernum' ] ],
4078       'index'        => [],
4079     },
4080
4081     #'sched_item_class'
4082
4083     'sched_avail' => {
4084       'columns' => [
4085         'availnum',      'serial', '', '', '', '',
4086         'itemnum',          'int', '', '', '', '',
4087         'wday',             'int', '', '', '', '',
4088         'stime',            'int', '', '', '', '',
4089         'etime',            'int', '', '', '', '',
4090         'override_date',    @date_type,    '', '',
4091       ],
4092       'primary_key'  => 'availnum',
4093       'unique'       => [],
4094       'index'        => [],
4095     },
4096
4097     'svc_phone' => {
4098       'columns' => [
4099         'svcnum',                         'int',     '',      '', '', '',
4100         'countrycode',                'varchar',     '',       3, '', '',
4101         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
4102         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
4103         'pin',                        'varchar', 'NULL', $char_d, '', '',
4104         'sip_password',               'varchar', 'NULL', $char_d, '', '',
4105         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
4106         'pbxsvc',                         'int', 'NULL',      '', '', '',
4107         'domsvc',                         'int', 'NULL',      '', '', '',
4108         'locationnum',                    'int', 'NULL',      '', '', '',
4109         'forwarddst',                 'varchar', 'NULL',      15, '', '',
4110         'email',                      'varchar', 'NULL',     255, '', '',
4111         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
4112         'portable',                      'char', 'NULL',       1, '', '',
4113         'lrn',                           'char', 'NULL',      10, '', '',
4114         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
4115         'lnp_due_date',                   'int', 'NULL',      '', '', '',
4116         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
4117         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
4118         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
4119         'sms_carrierid',                  'int', 'NULL',      '', '', '',
4120         'sms_account',                'varchar', 'NULL', $char_d, '', '',
4121         'max_simultaneous',               'int', 'NULL',      '', '', '',
4122         'e911_class',                    'char', 'NULL',       1, '', '',
4123         'e911_type',                     'char', 'NULL',       1, '', '',
4124         'circuit_svcnum',                 'int', 'NULL',      '', '', '',
4125         'sip_server',                 'varchar', 'NULL', $char_d, '', '',
4126       ],
4127       'primary_key' => 'svcnum',
4128       'unique' => [ [ 'sms_carrierid', 'sms_account'] ],
4129       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
4130                     ['locationnum'], ['sms_carrierid'],
4131                   ],
4132     },
4133
4134     'phone_device' => {
4135       'columns' => [
4136         'devicenum', 'serial',     '', '', '', '',
4137         'devicepart',   'int',     '', '', '', '',
4138         'svcnum',       'int',     '', '', '', '',
4139         'mac_addr', 'varchar', 'NULL', 12, '', '',
4140       ],
4141       'primary_key' => 'devicenum',
4142       'unique' => [ [ 'mac_addr' ], ],
4143       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
4144     },
4145
4146     'part_device' => {
4147       'columns' => [
4148         'devicepart', 'serial',  '',      '', '', '',
4149         'devicename', 'varchar', '', $char_d, '', '',
4150         'inventory_classnum', 'int', 'NULL', '', '', '',
4151         'title',      'varchar', 'NULL', $char_d, '', '',
4152       ],
4153       'primary_key' => 'devicepart',
4154       'unique' => [ [ 'devicename' ] ], #?
4155       'index'  => [],
4156     },
4157
4158     'phone_avail' => {
4159       'columns' => [
4160         'availnum',    'serial',      '',      '', '', '',
4161         'exportnum',   'int',         '',      '', '', '',
4162         'countrycode', 'varchar',     '',       3, '', '',
4163         'state',       'char',    'NULL',       2, '', '',
4164         'npa',         'char',        '',       3, '', '',
4165         'nxx',         'char',    'NULL',       3, '', '',
4166         'station',     'char',    'NULL',       4, '', '',
4167         'name',        'varchar', 'NULL', $char_d, '', '',
4168         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
4169         'latanum',      'int',     'NULL',      '', '', '',
4170         'msanum',       'int', 'NULL', '', '', '',
4171         'ordernum',      'int',     'NULL',      '', '', '',
4172         'svcnum',      'int',     'NULL',      '', '', '',
4173         'availbatch', 'varchar',  'NULL', $char_d, '', '',
4174       ],
4175       'primary_key' => 'availnum',
4176       'unique' => [],
4177       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
4178                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
4179                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
4180                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
4181                     [ 'svcnum' ],
4182                     [ 'availbatch' ],
4183                     [ 'latanum' ],
4184                   ],
4185     },
4186
4187     'lata' => {
4188       'columns' => [
4189         'latanum',    'int',      '',      '', '', '',
4190         'description',   'varchar',    '',      $char_d, '', '',
4191         'have_usage',   'int',    'NULL',      '', '', '',
4192       ],
4193       'primary_key' => 'latanum',
4194       'unique' => [],
4195       'index'  => [],
4196     },
4197
4198     'msa' => {
4199       'columns' => [
4200         'msanum',    'int',      '',      '', '', '',
4201         'description',   'varchar',    '',      $char_d, '', '',
4202       ],
4203       'primary_key' => 'msanum',
4204       'unique' => [],
4205       'index'  => [],
4206     },
4207
4208     'rate_center' => {
4209       'columns' => [
4210         'ratecenternum',    'serial',      '',      '', '', '',
4211         'description',   'varchar',    '',      $char_d, '', '',
4212       ],
4213       'primary_key' => 'ratecenternum',
4214       'unique' => [],
4215       'index'  => [],
4216     },
4217
4218     'did_vendor' => {
4219       'columns' => [
4220         'vendornum',    'serial',      '',      '', '', '',
4221         'vendorname',   'varchar',        '',     $char_d, '', '',
4222       ],
4223       'primary_key' => 'vendornum',
4224       'unique' => [],
4225       'index'  => [],
4226     },
4227
4228     'did_order_item' => {
4229       'columns' => [
4230         'orderitemnum',    'serial',      '',      '', '', '',
4231         'ordernum',    'int',      '',      '', '', '',
4232         'msanum',      'int',     'NULL',      '', '', '',
4233         'npa',      'int',     'NULL',      '', '', '',
4234         'latanum',      'int',     'NULL',      '', '', '',
4235         'ratecenternum',      'int',     'NULL',      '', '', '',
4236         'state',       'char',    'NULL',       2, '', '',
4237         'quantity',      'int',     '',      '', '', '',
4238         'custnum',   'int', 'NULL', '', '', '',
4239       ],
4240       'primary_key' => 'orderitemnum',
4241       'unique' => [],
4242       'index'  => [],
4243     },
4244
4245     'did_order' => {
4246       'columns' => [
4247         'ordernum',    'serial',      '',      '', '', '',
4248         'vendornum',   'int',       '',      '', '', '',
4249         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
4250         'custnum',   'int', 'NULL', '', '', '',
4251         'submitted',      'int',     '',      '', '', '',
4252         'confirmed',      'int',     'NULL',      '', '', '',
4253         'received',      'int',     'NULL',      '', '', '',
4254       ],
4255       'primary_key' => 'ordernum',
4256       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
4257       'index'  => [],
4258     },
4259
4260     'reason_type' => {
4261       'columns' => [
4262         'typenum',   'serial',  '', '', '', '',
4263         'class',     'char', '', 1, '', '',
4264         'type',     'varchar', '', $char_d, '', '',
4265       ],
4266       'primary_key' => 'typenum',
4267       'unique' => [],
4268       'index' => [],
4269     },
4270
4271     'reason' => {
4272       'columns' => [
4273         'reasonnum',     'serial',  '', '', '', '',
4274         'reason_type',   'int',  '', '', '', '',
4275         'reason',        'text', '', '', '', '',
4276         'disabled',      'char',    'NULL', 1, '', '',
4277         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
4278         'unsuspend_hold','char',    'NULL', 1, '', '',
4279         'unused_credit', 'char',    'NULL', 1, '', '',
4280         'feepart',        'int', 'NULL', '', '', '',
4281         'fee_on_unsuspend','char',  'NULL', 1, '', '',
4282         'fee_hold',      'char',    'NULL', 1, '', '',
4283       ],
4284       'primary_key' => 'reasonnum',
4285       'unique' => [],
4286       'index' => [],
4287     },
4288
4289     'conf' => {
4290       'columns' => [
4291         'confnum',  'serial',     '',      '', '', '',
4292         'agentnum', 'int',    'NULL',      '', '', '',
4293         'locale',   'varchar','NULL',      16, '', '',
4294         'name',     'varchar',    '', $char_d, '', '',
4295         'value',    'text',   'NULL',      '', '', '',
4296       ],
4297       'primary_key' => 'confnum',
4298       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
4299       'index' => [],
4300     },
4301
4302     'pkg_referral' => {
4303       'columns' => [
4304         'pkgrefnum',     'serial', '', '', '', '',
4305         'pkgnum',        'int',    '', '', '', '',
4306         'refnum',        'int',    '', '', '', '',
4307       ],
4308       'primary_key' => 'pkgrefnum',
4309       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
4310       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
4311     },
4312
4313     'svc_pbx' => {
4314       'columns' => [
4315         'svcnum',           'int',     '',      '', '', '',
4316         'id',               'int', 'NULL',      '', '', '',
4317         'uuid',            'char', 'NULL',      36, '', '',
4318         'title',        'varchar', 'NULL', $char_d, '', '',
4319         'max_extensions',   'int', 'NULL',      '', '', '',
4320         'max_simultaneous', 'int', 'NULL',      '', '', '',
4321         'ip_addr',      'varchar', 'NULL',      40, '', '',
4322       ],
4323       'primary_key' => 'svcnum',
4324       'unique' => [],
4325       'index'  => [ [ 'id' ], [ 'uuid' ] ],
4326     },
4327
4328     'pbx_extension' => {
4329       'columns' => [
4330         'extensionnum',  'serial',     '',      '', '', '',
4331         'svcnum',           'int',     '',      '', '', '',
4332         'extension',    'varchar',     '', $char_d, '', '',
4333         'pin',          'varchar', 'NULL', $char_d, '', '',
4334         'sip_password', 'varchar', 'NULL', $char_d, '', '',
4335         'phone_name',   'varchar', 'NULL', $char_d, '', '',
4336       ],
4337       'primary_key'  => 'extensionnum',
4338       'unique'       => [ [ 'svcnum', 'extension' ] ],
4339       'index'        => [ [ 'svcnum' ] ],
4340     },
4341
4342     'svc_mailinglist' => { #svc_group?
4343       'columns' => [
4344         'svcnum',            'int',     '',            '', '', '',
4345         'username',      'varchar',     '', $username_len, '', '',
4346         'domsvc',            'int',     '',            '', '', '',
4347         'listnum',           'int',     '',            '', '', '',
4348         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
4349         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
4350         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
4351         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
4352       ],
4353       'primary_key' => 'svcnum',
4354       'unique' => [],
4355       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
4356     },
4357
4358     'mailinglist' => {
4359       'columns' => [
4360         'listnum',   'serial', '',      '', '', '',
4361         'listname', 'varchar', '', $char_d, '', '',
4362       ],
4363       'primary_key' => 'listnum',
4364       'unique' => [],
4365       'index'  => [],
4366     },
4367
4368     'mailinglistmember' => {
4369       'columns' => [
4370         'membernum',        'serial',     '',   '', '', '',
4371         'listnum',             'int',     '',   '', '', '',
4372         'svcnum',              'int', 'NULL',   '', '', '',
4373         'contactemailnum',     'int', 'NULL',   '', '', '',
4374         'email',           'varchar', 'NULL',  255, '', '',
4375       ],
4376       'primary_key' => 'membernum',
4377       'unique'      => [],
4378       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
4379     },
4380
4381     'bill_batch' => {
4382       'columns' => [
4383         'batchnum',         'serial',     '',  '', '', '',
4384         'agentnum',            'int', 'NULL',  '', '', '',
4385         'status',             'char', 'NULL', '1', '', '',
4386         'pdf',                'blob', 'NULL',  '', '', '',
4387       ],
4388       'primary_key' => 'batchnum',
4389       'unique'      => [],
4390       'index'       => [ ['agentnum'] ],
4391     },
4392
4393     'cust_bill_batch' => {
4394       'columns' => [
4395         'billbatchnum',     'serial',     '', '', '', '',
4396         'batchnum',            'int',     '', '', '', '',
4397         'invnum',              'int',     '', '', '', '',
4398       ],
4399       'primary_key' => 'billbatchnum',
4400       'unique'      => [],
4401       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
4402     },
4403
4404     'cust_bill_batch_option' => {
4405       'columns' => [
4406         'optionnum', 'serial', '', '', '', '',
4407         'billbatchnum', 'int', '', '', '', '',
4408         'optionname', 'varchar', '', $char_d, '', '',
4409         'optionvalue', 'text', 'NULL', '', '', '',
4410       ],
4411       'primary_key' => 'optionnum',
4412       'unique'      => [],
4413       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
4414     },
4415
4416     'msg_template' => {
4417       'columns' => [
4418         'msgnum',     'serial',     '',      '', '', '',
4419         'msgname',   'varchar',     '', $char_d, '', '',
4420         'agentnum',      'int', 'NULL',      '', '', '',
4421         'subject',   'varchar', 'NULL',     512, '', '',
4422         'mime_type', 'varchar',     '', $char_d, '', '',
4423         'body',         'blob', 'NULL',      '', '', '',
4424         'disabled',     'char', 'NULL',       1, '', '',
4425         'from_addr', 'varchar', 'NULL',     255, '', '',
4426         'bcc_addr',  'varchar', 'NULL',     255, '', '',
4427       ],
4428       'primary_key' => 'msgnum',
4429       'unique'      => [ ],
4430       'index'       => [ ['agentnum'], ],
4431     },
4432
4433     'template_content' => {
4434       'columns' => [
4435         'contentnum', 'serial',     '',      '', '', '',
4436         'msgnum',        'int',     '',      '', '', '',
4437         'locale',    'varchar', 'NULL',      16, '', '',
4438         'subject',   'varchar', 'NULL',     512, '', '',
4439         'body',         'text', 'NULL',      '', '', '',
4440       ],
4441       'primary_key' => 'contentnum',
4442       'unique'      => [ ['msgnum', 'locale'] ],
4443       'index'       => [ ],
4444     },
4445
4446     'cust_msg' => {
4447       'columns' => [
4448         'custmsgnum', 'serial',     '',     '', '', '',
4449         'custnum',       'int', 'NULL',     '', '', '',
4450         'msgnum',        'int', 'NULL',     '', '', '',
4451         '_date',    @date_type,                 '', '',
4452         'env_from',  'varchar', 'NULL',    255, '', '',
4453         'env_to',    'varchar', 'NULL',    255, '', '',
4454         'header',       'blob', 'NULL',     '', '', '',
4455         'body',         'blob', 'NULL',     '', '', '',
4456         'error',     'varchar', 'NULL',    255, '', '',
4457         'status',    'varchar',     '',$char_d, '', '',
4458         'msgtype',   'varchar', 'NULL',     16, '', '',
4459       ],
4460       'primary_key' => 'custmsgnum',
4461       'unique'      => [ ],
4462       'index'       => [ ['custnum'], ],
4463     },
4464
4465     'svc_cert' => {
4466       'columns' => [
4467         'svcnum',                'int',     '',      '', '', '',
4468         'recnum',                'int', 'NULL',      '', '', '',
4469         'privatekey',           'text', 'NULL',      '', '', '',
4470         'csr',                  'text', 'NULL',      '', '', '',
4471         'certificate',          'text', 'NULL',      '', '', '',
4472         'cacert',               'text', 'NULL',      '', '', '',
4473         'common_name',       'varchar', 'NULL', $char_d, '', '',
4474         'organization',      'varchar', 'NULL', $char_d, '', '',
4475         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
4476         'city',              'varchar', 'NULL', $char_d, '', '',
4477         'state',             'varchar', 'NULL', $char_d, '', '',
4478         'country',              'char', 'NULL',       2, '', '',
4479         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
4480       ],
4481       'primary_key' => 'svcnum',
4482       'unique' => [],
4483       'index'  => [], #recnum
4484     },
4485
4486     'svc_port' => {
4487       'columns' => [
4488         'svcnum',                'int',     '',      '', '', '',
4489         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
4490       ],
4491       'primary_key' => 'svcnum',
4492       'unique' => [],
4493       'index'  => [], #recnum
4494     },
4495
4496     'areacode'  => {
4497       'columns' => [
4498         'areanum',   'serial',        '',      '', '', '',
4499         'code',        'char',        '',       3, '', '',
4500         'country',     'char',    'NULL',       2, '', '',
4501         'state',       'char',    'NULL',       2, '', '',
4502         'description','varchar',  'NULL',     255, '', '',
4503       ],
4504       'primary_key' => 'areanum',
4505       'unique' => [ [ 'areanum' ] ],
4506       'index'  => [],
4507     },
4508
4509     'upgrade_journal' => {
4510       'columns' => [
4511         'upgradenum', 'serial', '', '', '', '',
4512         '_date', 'int', '', '', '', '',
4513         'upgrade', 'varchar', '', $char_d, '', '',
4514         'status', 'varchar', '', $char_d, '', '',
4515         'statustext', 'varchar', 'NULL', $char_d, '', '',
4516       ],
4517       'primary_key' => 'upgradenum',
4518       'unique' => [],
4519       'index' => [ [ 'upgrade' ] ],
4520     },
4521
4522     'upload_target' => {
4523       'columns' => [
4524         'targetnum', 'serial', '', '', '', '',
4525         'agentnum', 'int', 'NULL', '', '', '',
4526         'protocol', 'varchar', '', 10, '', '',
4527         'hostname', 'varchar', '', $char_d, '', '',
4528         'port', 'int', 'NULL', '', '', '',
4529         'username', 'varchar', '', $char_d, '', '',
4530         'password', 'varchar', 'NULL', $char_d, '', '',
4531         'path', 'varchar', 'NULL', $char_d, '', '',
4532         'subject', 'varchar', 'NULL', '255', '', '',
4533         'handling', 'varchar', 'NULL', $char_d, '', '',
4534       ],
4535       'primary_key' => 'targetnum',
4536       'unique' => [ [ 'targetnum' ] ],
4537       'index' => [],
4538     },
4539
4540     'log' => {
4541       'columns' => [
4542         'lognum',     'serial', '', '', '', '',
4543         '_date',      'int', '', '', '', '',
4544         'agentnum',   'int', 'NULL', '', '', '',
4545         'tablename',  'varchar', 'NULL', $char_d, '', '',
4546         'tablenum',   'int',  'NULL', '', '', '',
4547         'level',      'int',  '', '', '', '',
4548         'message',    'text', '', '', '', '',
4549       ],
4550       'primary_key' => 'lognum',
4551       'unique'      => [],
4552       'index'       => [ ['_date'], ['level'] ],
4553     },
4554
4555     'log_context' => {
4556       'columns' => [
4557         'logcontextnum', 'serial', '', '', '', '',
4558         'lognum', 'int', '', '', '', '',
4559         'context', 'varchar', '', $char_d, '', '',
4560       ],
4561       'primary_key' => 'logcontextnum',
4562       'unique' => [ [ 'lognum', 'context' ] ],
4563       'index' => [],
4564     },
4565
4566     'svc_alarm' => {
4567       'columns' => [
4568 #       name               type        null   length   default local
4569         'svcnum',          'int',      '',    '',      '',     '',
4570         'alarmsystemnum',  'int',      '',    '',      '',     '',
4571         'alarmtypenum',    'int',      '',    '',      '',     '',
4572         'alarmstationnum', 'int',      '',    '',      '',     '',
4573         'acctnum',         'varchar',  '',    $char_d, '',     '',
4574         '_password',       'varchar',  '',    $char_d, '',     '',
4575         'location',        'varchar', 'NULL', $char_d, '',     '',
4576         'cs_receiver',     'int',     'NULL', '',      '',     '',
4577         'cs_phonenum',     'varchar', 'NULL', $char_d, '',     '',
4578         'serialnum',       'varchar', 'NULL', $char_d, '',     '',
4579         #installer (rep)
4580       ],
4581       'primary_key' => 'svcnum',
4582       'unique' => [],
4583       'index'  => [],
4584     },
4585
4586     'alarm_system' => { #vendors
4587       'columns' => [
4588         'alarmsystemnum',  'serial',     '',      '', '', '',
4589         'agentnum',           'int', 'NULL',      '', '', '',
4590         'systemname',     'varchar',     '', $char_d, '', '',
4591         'disabled',          'char', 'NULL',       1, '', '',
4592       ],
4593       'primary_key' => 'alarmsystemnum',
4594       'unique'      => [ ['agentnum', 'systemname'] ],
4595       'index'       => [ ['agentnum'], ['disabled'] ],
4596     },
4597
4598     'alarm_type' => { #inputs and outputs
4599       'columns' => [
4600         'alarmtypenum', 'serial',     '',      '', '', '',
4601         'agentnum',        'int', 'NULL',      '', '', '',
4602         'inputs',          'int',     '', '', '', '',
4603         'outputs',         'int',     '', '', '', '',
4604         'disabled',       'char', 'NULL',       1, '', '',
4605       ],
4606       'primary_key' => 'alarmtypenum',
4607       'unique'      => [ ['agentnum', 'inputs', 'outputs'] ],
4608       'index'       => [ ['agentnum'], ['disabled'] ],
4609     },
4610
4611     'alarm_station' => { #central station (where the alarm reports to)
4612       'columns' => [
4613         'alarmstationnum', 'serial',     '',      '', '', '',
4614         'agentnum',           'int', 'NULL',      '', '', '',
4615         'stationname',    'varchar',     '', $char_d, '', '',
4616         'disabled',          'char', 'NULL',       1, '', '',
4617       ],
4618       'primary_key' => 'alarmstationnum',
4619       'unique'      => [ ['agentnum', 'stationname'], ],
4620       'index'       => [ ['agentnum'], ['disabled'] ],
4621     },
4622
4623     'svc_cable' => {
4624       'columns' => [
4625         'svcnum',        'int',     '',      '', '', '',
4626         'providernum',   'int', 'NULL',      '', '', '',
4627         'ordernum',  'varchar', 'NULL', $char_d, '', '',
4628         'modelnum',      'int', 'NULL',      '', '', '',
4629         'serialnum', 'varchar', 'NULL', $char_d, '', '',
4630         'mac_addr',  'varchar', 'NULL',      12, '', '',
4631       ],
4632       'primary_key' => 'svcnum',
4633       'unique'       => [ ['serialnum'] , ['mac_addr'] ],
4634       'index'  => [],
4635     },
4636
4637     'cable_model' => {
4638       'columns' => [
4639         'modelnum',    'serial',     '',      '', '', '',
4640         'model_name', 'varchar',     '', $char_d, '', '',
4641         'disabled',      'char', 'NULL',       1, '', '',
4642       ],
4643       'primary_key' => 'modelnum',
4644       'unique' => [ [ 'model_name' ], ],
4645       'index'  => [],
4646     },
4647
4648     'cable_provider' => {
4649       'columns' => [
4650         'providernum', 'serial',     '',      '', '', '',
4651         'provider',   'varchar',     '', $char_d, '', '',
4652         'disabled',      'char', 'NULL',       1, '', '',
4653       ],
4654       'primary_key' => 'providernum',
4655       'unique' => [ [ 'provider' ], ],
4656       'index'  => [],
4657     },
4658
4659     'circuit_type' => {
4660       'columns' => [
4661         'typenum',     'serial',     '',      '', '', '',
4662         'typename',   'varchar',     '', $char_d, '', '',
4663         'disabled',      'char', 'NULL',       1, '', '',
4664         # speed? number of voice lines? anything else?
4665       ],
4666       'primary_key' => 'typenum',
4667       'unique' => [ [ 'typename' ] ],
4668       'index'  => [],
4669     },
4670
4671     'circuit_provider' => {
4672       'columns' => [
4673         'providernum', 'serial',     '',      '', '', '',
4674         'provider',   'varchar',     '', $char_d, '', '',
4675         'disabled',      'char', 'NULL',       1, '', '',
4676       ],
4677       'primary_key' => 'providernum',
4678       'unique' => [ [ 'provider' ], ],
4679       'index'  => [],
4680     },
4681
4682     'circuit_termination' => {
4683       'columns' => [
4684         'termnum',     'serial',     '',      '', '', '',
4685         'termination','varchar',     '', $char_d, '', '',
4686         'disabled',      'char', 'NULL',       1, '', '',
4687       ],
4688       'primary_key' => 'termnum',
4689       'unique' => [ [ 'termination' ] ],
4690       'index' => [],
4691     },
4692
4693     'svc_circuit' => {
4694       'columns' => [
4695         'svcnum',                   'int',     '', '', '', '',
4696         'typenum',                  'int',     '', '', '', '',
4697         'providernum',              'int',     '', '', '', '',
4698         'termnum',                  'int',     '', '', '', '',
4699         'circuit_id',           'varchar',     '', 64, '', '',
4700         'desired_due_date',         'int', 'NULL', '', '', '',
4701         'due_date',                 'int', 'NULL', '', '', '',
4702         'vendor_order_id',      'varchar', 'NULL', $char_d,  '', '',
4703         'vendor_qual_id',       'varchar', 'NULL', $char_d,  '', '',
4704         'vendor_order_type',    'varchar', 'NULL', $char_d,  '', '',
4705         'vendor_order_status',  'varchar', 'NULL', $char_d,  '', '',
4706         'endpoint_ip_addr',     'varchar', 'NULL', 40, '', '',
4707         'endpoint_mac_addr',    'varchar', 'NULL', 12, '', '',
4708       ],
4709       'primary_key' => 'svcnum',
4710       'unique'      => [],
4711       'index'       => [ [ 'providernum' ], [ 'typenum' ] ],
4712     },
4713
4714     'svc_fiber' => {
4715       'columns' => [
4716         'svcnum',         'int',     '',      '', '', '',
4717         'oltnum',         'int', 'NULL',      '', '', '',
4718         'shelf',          'int', 'NULL',      '', '', '',
4719         'card',           'int', 'NULL',      '', '', '',
4720         'olt_port',       'int', 'NULL',      '', '', '',
4721         'ont_id',         'int', 'NULL',      '', '', '',
4722         'ont_typenum',    'int', 'NULL',      '', '', '',
4723         'ont_serial', 'varchar', 'NULL', $char_d, '', '',
4724         'ont_port',   'varchar', 'NULL',      16, '', '',
4725         'vlan',           'int', 'NULL',      '', '', '',
4726         'signal',         'int', 'NULL',      '', '', '',
4727         'speed_up',       'int', 'NULL',      '', '', '',
4728         'speed_down',     'int', 'NULL',      '', '', '',
4729         'ont_install','varchar', 'NULL', $char_d, '', '',
4730       ],
4731       'primary_key' => 'svcnum',
4732       'unique'      => [ ],
4733       'index'       => [ [ 'ont_serial' ] ],
4734     },
4735
4736     'fiber_olt' => {
4737       'columns' => [
4738         'oltnum',   'serial', '',       '', '', '',
4739         'oltname', 'varchar', '',  $char_d, '', '',
4740         'serial',  'varchar', '',  $char_d, '', '',
4741         'disabled',   'char', 'NULL',    1, '', '',
4742       ],
4743       'primary_key' => 'oltnum',
4744       'unique' => [ ],
4745       'index'  => [ ],
4746     },
4747
4748     'vend_main' => {
4749       'columns' => [
4750         'vendnum',   'serial',     '',      '', '', '',
4751         'vendname', 'varchar',     '', $char_d, '', '',
4752         'classnum',     'int',     '',      '', '', '',
4753         'disabled',    'char', 'NULL',       1, '', '',
4754       ],
4755       'primary_key'  => 'vendnum',
4756       'unique'       => [ ['vendname', 'disabled'] ],
4757       'index'        => [],
4758       'foreign_keys' => [
4759                           { columns    => [ 'classnum' ],
4760                             table      => 'vend_class',
4761                           },
4762                         ],
4763     },
4764
4765     'vend_class' => {
4766       'columns' => [
4767         'classnum',     'serial',     '',      '', '', '',
4768         'classname',   'varchar',     '', $char_d, '', '',
4769         'disabled',       'char', 'NULL',       1, '', '',
4770       ],
4771       'primary_key' => 'classnum',
4772       'unique'      => [],
4773       'index'       => [ ['disabled'] ],
4774     },
4775
4776     'vend_bill' => {
4777       'columns' => [
4778         'vendbillnum',    'serial',     '',      '', '', '',
4779         'vendnum',           'int',     '',      '', '', '',
4780         #'_date',        @date_type,                  '', '',
4781         '_date',     'int', '', '',                   '', '',
4782         'charged',     @money_type,                  '', '',
4783       ],
4784       'primary_key'  => 'vendbillnum',
4785       'unique'       => [],
4786       'index'        => [ ['vendnum'], ['_date'], ],
4787       'foreign_keys' => [
4788                           { columns    => [ 'vendnum' ],
4789                             table      => 'vend_main',
4790                           },
4791                         ],
4792     },
4793
4794     'vend_pay' => {
4795       'columns' => [
4796         'vendpaynum',   'serial',    '',       '', '', '',
4797         'vendnum',         'int',    '',       '', '', '',
4798         #'_date',     @date_type,                   '', '',
4799         '_date',     'int', '', '',                   '', '',
4800         'paid',      @money_type,                  '', '',
4801       ],
4802       'primary_key'  => 'vendpaynum',
4803       'unique'       => [],
4804       'index'        => [ [ 'vendnum' ], [ '_date' ], ],
4805       'foreign_keys' => [
4806                           { columns    => [ 'vendnum' ],
4807                             table      => 'vend_main',
4808                           },
4809                         ],
4810     },
4811
4812     'vend_bill_pay' => {
4813       'columns' => [
4814         'vendbillpaynum', 'serial',     '',   '', '', '',
4815         'vendbillnum',       'int',     '',   '', '', '',
4816         'vendpaynum',        'int',     '',   '', '', '',
4817         'amount',  @money_type, '', '',
4818         #? '_date',   @date_type, '', '',
4819       ],
4820       'primary_key'  => 'vendbillpaynum',
4821       'unique'       => [],
4822       'index'        => [ [ 'vendbillnum' ], [ 'vendpaynum' ] ],
4823       'foreign_keys' => [
4824                           { columns    => [ 'vendbillnum' ],
4825                             table      => 'vend_bill',
4826                           },
4827                           { columns    => [ 'vendpaynum' ],
4828                             table      => 'vend_pay',
4829                           },
4830                         ],
4831     },
4832     %{ tables_hashref_torrus() },
4833
4834     # tables of ours for doing torrus virtual port combining
4835     'torrus_srvderive' => {
4836       'columns' => [
4837         'derivenum',     'serial',     '', '', '', '',
4838         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
4839         'last_srv_date',   'date', 'NULL', '', '', '',
4840       ],
4841       'primary_key' => 'derivenum',
4842       'unique' => [ ['serviceid'] ],
4843       'index'  => [],
4844     },
4845
4846     'torrus_srvderive_component' => {
4847       'columns' => [
4848         'componentnum', 'serial', '', '', '', '',
4849         'derivenum',       'int', '', '', '', '',
4850         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
4851       ],
4852       'primary_key' => 'componentnum',
4853       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
4854       'index'       => [ [ 'derivenum', ], ],
4855     },
4856
4857     'invoice_mode' => {
4858       'columns' => [
4859         'modenum',      'serial', '', '', '', '',
4860         'agentnum',        'int', 'NULL', '', '', '',
4861         'modename',    'varchar', '', 32, '', '',
4862       ],
4863       'primary_key' => 'modenum',
4864       'unique'      => [ ],
4865       'index'       => [ ],
4866     },
4867
4868     'invoice_conf' => {
4869       'columns' => [
4870         'confnum',              'serial',   '', '', '', '',
4871         'modenum',              'int',      '', '', '', '',
4872         'locale',               'varchar',  'NULL', 16, '', '',
4873         'notice_name',          'varchar',  'NULL', 64, '', '',
4874         'subject',              'varchar',  'NULL', 64, '', '',
4875         'htmlnotes',            'text',     'NULL', '', '', '',
4876         'htmlfooter',           'text',     'NULL', '', '', '',
4877         'htmlsummary',          'text',     'NULL', '', '', '',
4878         'htmlreturnaddress',    'text',     'NULL', '', '', '',
4879         'latexnotes',           'text',     'NULL', '', '', '',
4880         'latexfooter',          'text',     'NULL', '', '', '',
4881         'latexsummary',         'text',     'NULL', '', '', '',
4882         'latexsmallfooter',     'text',     'NULL', '', '', '',
4883         'latexreturnaddress',   'text',     'NULL', '', '', '',
4884         'with_latexcoupon',     'char',     'NULL', '1', '', '',
4885         'htmlwatermark',        'text',     'NULL', '', '', '',
4886         'latexwatermark',       'text',     'NULL', '', '', '',
4887         'lpr',                  'varchar',  'NULL', $char_d, '', '',
4888       ],
4889       'primary_key' => 'confnum',
4890       'unique' => [ [ 'modenum', 'locale' ] ],
4891       'index'  => [ ],
4892     },
4893
4894     'export_batch' => {
4895       'columns' => [
4896         'batchnum',    'serial',     '',      '', '', '',
4897         'exportnum',      'int',     '',      '', '', '',
4898         '_date',          'int',     '',      '', '', '',
4899         'status',     'varchar', 'NULL',      32, '', '',
4900         'statustext',    'text', 'NULL',      '', '', '',
4901       ],
4902       'primary_key'  => 'batchnum',
4903       'unique'       => [],
4904       'index'        => [ [ 'exportnum' ], [ 'status' ] ],
4905     },
4906
4907     'export_batch_item' => {
4908       'columns' => [
4909         'itemnum',     'serial',     '',      '', '', '',
4910         'batchnum',       'int',     '',      '', '', '',
4911         'svcnum',         'int',     '',      '', '', '',
4912         'action',     'varchar',     '',      32, '', '',
4913         'data',          'text', 'NULL',      '', '', '',
4914         'frozen',        'char', 'NULL',       1, '', '',
4915       ],
4916       'primary_key'  => 'itemnum',
4917       'unique'       => [],
4918       'index'        => [ [ 'batchnum' ], [ 'svcnum' ] ],
4919     },
4920
4921     # lookup table for states, similar to msa and lata
4922     'state' => {
4923       'columns' => [
4924         'statenum', 'int',  '', '', '', '',
4925         'country',  'char', '',  2, '', '',
4926         'state',    'char', '', $char_d, '', '',
4927         'fips',     'char', '',  3, '', '',
4928       ],
4929       'primary_key' => 'statenum',
4930       'unique' => [ [ 'country', 'state' ], ],
4931       'index' => [],
4932     },
4933
4934     # eventually link to tower/sector?
4935     'deploy_zone' => {
4936       'columns' => [
4937         'zonenum',        'serial',  '',     '',      '', '',
4938         'description',    'char',    'NULL', $char_d, '', '',
4939         'agentnum',       'int',     '',     '',      '', '',
4940         'censusyear',     'char',    'NULL', 4,      '', '',
4941         'dbaname',        'char',    'NULL', $char_d, '', '',
4942         'zonetype',       'char',    '',     1,       '', '',
4943         'technology',     'int',     '',     '',      '', '',
4944         'spectrum',       'int',     'NULL', '',      '', '',
4945         'adv_speed_up',   'decimal', '',     '10,3', '0', '',
4946         'adv_speed_down', 'decimal', '',     '10,3', '0', '',
4947         'cir_speed_up',   'decimal', '',     '10,3', '0', '',
4948         'cir_speed_down', 'decimal', '',     '10,3', '0', '',
4949         'is_broadband',   'char',    'NULL', 1,       '', '',
4950         'is_voice',       'char',    'NULL', 1,       '', '',
4951         'is_consumer',    'char',    'NULL', 1,       '', '',
4952         'is_business',    'char',    'NULL', 1,       '', '',
4953         'active_date',    @date_type,                 '', '',
4954         'expire_date',    @date_type,                 '', '',
4955       ],
4956       'primary_key' => 'zonenum',
4957       'unique' => [],
4958       'index'  => [ [ 'agentnum' ] ],
4959     },
4960
4961     'deploy_zone_block' => {
4962       'columns' => [
4963         'blocknum',       'serial',  '',     '',      '', '',
4964         'zonenum',        'int',     '',     '',      '', '',
4965         'censusblock',    'char',    '',     15,      '', '',
4966         'censusyear',     'char','NULL',      4,      '', '',
4967       ],
4968       'primary_key' => 'blocknum',
4969       'unique' => [],
4970       'index'  => [ [ 'zonenum' ] ],
4971     },
4972
4973     'deploy_zone_vertex' => {
4974       'columns' => [
4975         'vertexnum',      'serial',  '',     '',      '', '',
4976         'zonenum',        'int',     '',     '',      '', '',
4977         'latitude',       'decimal', '',     '10,7',  '', '',
4978         'longitude',      'decimal', '',     '10,7',  '', '',
4979       ],
4980       'primary_key' => 'vertexnum',
4981       'unique' => [ ],
4982       'index'  => [ ],
4983     },
4984
4985     'cacti_page' => {
4986       'columns' => [
4987         'cacti_pagenum',  'serial',   '',     '', '', '',
4988         'exportnum',      'int',      'NULL', '', '', '',
4989         'svcnum',         'int',      'NULL', '', '', '',
4990         'graphnum',       'int',      'NULL', '', '', '',
4991         'imported',       @date_type,             '', '',
4992         'content',        'text',     'NULL', '', '', '',
4993       ],
4994       'primary_key' => 'cacti_pagenum',
4995       'unique'  => [ ],
4996       'index'   => [ ['svcnum'], ['imported'] ],
4997     },
4998
4999     'report_batch' => {
5000       'columns' => [
5001         'reportbatchnum', 'serial',      '',  '', '', '',
5002         'reportname',     'varchar',     '', 255, '', '',
5003         'agentnum',           'int', 'NULL',  '', '', '',
5004         'send_date',     @date_type,              '', '',
5005         'sdate',         @date_type,              '', '',
5006         'edate',         @date_type,              '', '',
5007         'usernum',            'int', 'NULL',  '', '', '',
5008         'msgnum',             'int', 'NULL',  '', '', '',
5009         # add report params here as necessary
5010       ],
5011       'primary_key' => 'reportbatchnum',
5012       'unique' => [],
5013       'index'  => [],
5014       'foreign_keys' => [
5015                           { columns    => [ 'agentnum' ],
5016                             table      => 'agent',
5017                             references => [ 'agentnum' ],
5018                           },
5019                           { columns    => [ 'usernum' ],
5020                             table      => 'access_user',
5021                             references => [ 'usernum' ],
5022                           },
5023                           { columns    => [ 'msgnum' ],
5024                             table      => 'msg_template',
5025                             references => [ 'msgnum' ],
5026                           },
5027                         ],
5028     },
5029
5030     'password_history' => {
5031       'columns' => [
5032         'passwordnum',        'serial',  '',          '', '', '',
5033         '_password',          'varchar', 'NULL', $char_d, '', '',
5034         'encryption_method',  'varchar', 'NULL', $char_d, '', '',
5035         'created',   @date_type,   '', '',
5036         # each table that needs password history gets a column here, and
5037         # an entry in foreign_keys.
5038         'svc_acct__svcnum',     'int', 'NULL', '', '', '',
5039         'svc_dsl__svcnum',      'int', 'NULL', '', '', '',
5040         'svc_alarm__svcnum',    'int', 'NULL', '', '', '',
5041         'agent__agentnum',      'int', 'NULL', '', '', '',
5042         'contact__contactnum',  'int', 'NULL', '', '', '',
5043         'access_user__usernum', 'int', 'NULL', '', '', '',
5044       ],
5045       'primary_key' => 'passwordnum',
5046       'unique' => [],
5047       'index'  => [],
5048       'foreign_keys' => [
5049                           { columns     => [ 'svc_acct__svcnum' ],
5050                             table       => 'svc_acct',
5051                             references  => [ 'svcnum' ],
5052                           },
5053                           { columns     => [ 'svc_dsl__svcnum' ],
5054                             table       => 'svc_dsl',
5055                             references  => [ 'svcnum' ],
5056                           },
5057                           { columns     => [ 'svc_alarm__svcnum' ],
5058                             table       => 'svc_alarm',
5059                             references  => [ 'svcnum' ],
5060                           },
5061                           { columns    => [ 'agent__agentnum' ],
5062                             table      => 'agent',
5063                             references => [ 'agentnum' ],
5064                           },
5065                           { columns    => [ 'contact__contactnum' ],
5066                             table      => 'contact',
5067                             references => [ 'contactnum' ],
5068                           },
5069                           { columns    => [ 'access_user__usernum' ],
5070                             table      => 'access_user',
5071                             references => [ 'usernum' ],
5072                           },
5073                         ],
5074     },
5075
5076     # name type nullability length default local
5077
5078     #'new_table' => {
5079     #  'columns' => [
5080     #    'num', 'serial',       '', '', '', '',
5081     #  ],
5082     #  'primary_key' => 'num',
5083     #  'unique' => [],
5084     #  'index'  => [],
5085     #},
5086
5087   };
5088
5089 }
5090
5091 =back
5092
5093 =head1 BUGS
5094
5095 =head1 SEE ALSO
5096
5097 L<DBIx::DBSchema>
5098
5099 =cut
5100
5101 1;
5102