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