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