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