FS/FS/Schema.pm

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