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