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