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