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