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