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