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         'invnum',       'int',     'NULL',  '', '', '',
1580         'manual',       'char',    'NULL',   1, '', '',
1581         'discount_term','int',     'NULL',  '', '', '',
1582       ],
1583       'primary_key' => 'paypendingnum',
1584       'unique'      => [ [ 'payunique' ] ],
1585       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1586     },
1587
1588     'cust_pay' => {
1589       'columns' => [
1590         'paynum',       'serial',    '',       '', '', '',
1591         'custnum',         'int',    '',       '', '', '',
1592         '_date',     @date_type,                   '', '',
1593         'paid',      @money_type,                  '', '',
1594         'currency',       'char', 'NULL',       3, '', '',
1595         'otaker',      'varchar', 'NULL',      32, '', '',
1596         'usernum',         'int', 'NULL',      '', '', '',
1597         'payby',          'char',     '',       4, '', '',
1598         'payinfo',     'varchar', 'NULL',     512, '', '',
1599         'paymask',     'varchar', 'NULL', $char_d, '', '',
1600         'paydate',     'varchar', 'NULL',      10, '', '',
1601         'paybatch',    'varchar', 'NULL', $char_d, '', '',#for auditing purposes
1602         'payunique',   'varchar', 'NULL', $char_d, '', '',#separate paybatch "unique" functions from current usage
1603         'closed',         'char', 'NULL',       1, '', '',
1604         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1605
1606         # cash/check deposit info fields
1607         'bank',        'varchar', 'NULL', $char_d, '', '',
1608         'depositor',   'varchar', 'NULL', $char_d, '', '',
1609         'account',     'varchar', 'NULL',      20, '', '',
1610         'teller',      'varchar', 'NULL',      20, '', '',
1611
1612         'batchnum',        'int', 'NULL',      '', '', '',#pay_batch foreign key
1613
1614         # credit card/EFT fields (formerly in paybatch)
1615         'gatewaynum',      'int', 'NULL',      '', '', '', # payment_gateway FK
1616         'processor',   'varchar', 'NULL', $char_d, '', '', # module name
1617         'auth',        'varchar', 'NULL',      16, '', '', # CC auth number
1618         'order_number','varchar', 'NULL', $char_d, '', '', # transaction number
1619       ],
1620       'primary_key' => 'paynum',
1621       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1622       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1623     },
1624
1625     'cust_pay_void' => {
1626       'columns' => [
1627         'paynum',          'int',    '',       '', '', '',
1628         'custnum',         'int',    '',       '', '', '',
1629         '_date',      @date_type,                  '', '',
1630         'paid',      @money_type,                  '', '',
1631         'currency',       'char', 'NULL',       3, '', '',
1632         'otaker',      'varchar', 'NULL',      32, '', '',
1633         'usernum',         'int', 'NULL',      '', '', '',
1634         'payby',          'char',     '',       4, '', '',
1635         'payinfo',     'varchar', 'NULL',     512, '', '',
1636         'paymask',     'varchar', 'NULL', $char_d, '', '',
1637         #'paydate' ?
1638         'paybatch',    'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1639         'closed',        'char',  'NULL',       1, '', '',
1640         'pkgnum', 'int',   'NULL', '', '', '', #desired pkgnum for pkg-balances
1641
1642         # cash/check deposit info fields
1643         'bank',       'varchar', 'NULL', $char_d, '', '',
1644         'depositor',  'varchar', 'NULL', $char_d, '', '',
1645         'account',    'varchar', 'NULL',      20, '', '',
1646         'teller',     'varchar', 'NULL',      20, '', '',
1647         'batchnum',       'int', 'NULL',      '', '', '', #pay_batch foreign key
1648
1649         # credit card/EFT fields (formerly in paybatch)
1650         'gatewaynum',      'int', 'NULL',      '', '', '', # payment_gateway FK
1651         'processor',   'varchar', 'NULL', $char_d, '', '', # module name
1652         'auth',        'varchar', 'NULL',      16, '', '', # CC auth number
1653         'order_number','varchar', 'NULL', $char_d, '', '', # transaction number
1654
1655         #void fields
1656         'void_date',  @date_type,                  '', '',
1657         'reason',      'varchar', 'NULL', $char_d, '', '',
1658         'void_usernum',    'int', 'NULL',      '', '', '',
1659       ],
1660       'primary_key' => 'paynum',
1661       'unique' => [],
1662       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1663     },
1664
1665     'cust_bill_pay' => {
1666       'columns' => [
1667         'billpaynum', 'serial',     '',   '', '', '',
1668         'invnum',  'int',     '',   '', '', '',
1669         'paynum',  'int',     '',   '', '', '',
1670         'amount',  @money_type, '', '',
1671         '_date',   @date_type, '', '',
1672         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1673       ],
1674       'primary_key' => 'billpaynum',
1675       'unique' => [],
1676       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1677     },
1678
1679     'cust_bill_pay_batch' => {
1680       'columns' => [
1681         'billpaynum', 'serial',     '',   '', '', '',
1682         'invnum',  'int',     '',   '', '', '',
1683         'paybatchnum',  'int',     '',   '', '', '',
1684         'amount',  @money_type, '', '',
1685         '_date',   @date_type, '', '',
1686       ],
1687       'primary_key' => 'billpaynum',
1688       'unique' => [],
1689       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1690     },
1691
1692     'cust_bill_pay_pkg' => {
1693       'columns' => [
1694         'billpaypkgnum', 'serial', '', '', '', '',
1695         'billpaynum',       'int', '', '', '', '',
1696         'billpkgnum',       'int', '', '', '', '',
1697         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1698         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1699         'amount',         @money_type,     '', '',
1700         'setuprecur',      'varchar', '', $char_d, '', '',
1701         'sdate',   @date_type, '', '',
1702         'edate',   @date_type, '', '',
1703       ],
1704       'primary_key' => 'billpaypkgnum',
1705       'unique'      => [],
1706       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1707     },
1708
1709     'pay_batch' => { #batches of payments to an external processor
1710       'columns' => [
1711         'batchnum', 'serial',     '', '', '', '',
1712         'agentnum',    'int', 'NULL', '', '', '',
1713         'payby',      'char',     '',  4, '', '', # CARD/CHEK
1714         'status',     'char', 'NULL',  1, '', '',
1715         'download',       @date_type,     '', '',
1716         'upload',         @date_type,     '', '',
1717         'title',   'varchar', 'NULL',255, '', '',
1718       ],
1719       'primary_key' => 'batchnum',
1720       'unique' => [],
1721       'index' => [],
1722     },
1723
1724     'cust_pay_batch' => { #list of customers in current CARD/CHEK batch
1725       'columns' => [
1726         'paybatchnum',    'serial',     '',      '', '', '',
1727         'batchnum',          'int',     '',      '', '', '',
1728         'invnum',            'int',     '',      '', '', '',
1729         'custnum',           'int',     '',      '', '', '',
1730         'last',          'varchar',     '', $char_d, '', '',
1731         'first',         'varchar',     '', $char_d, '', '',
1732         'address1',      'varchar',     '', $char_d, '', '',
1733         'address2',      'varchar', 'NULL', $char_d, '', '',
1734         'city',          'varchar',     '', $char_d, '', '',
1735         'state',         'varchar', 'NULL', $char_d, '', '',
1736         'zip',           'varchar', 'NULL',      10, '', '',
1737         'country',          'char',     '',       2, '', '',
1738         'payby',            'char',     '',       4, '', '',
1739         'payinfo',       'varchar', 'NULL',     512, '', '',
1740         #'exp',          @date_type,                  '', '',
1741         'exp',           'varchar', 'NULL',      11, '', '',
1742         'payname',       'varchar', 'NULL', $char_d, '', '',
1743         'amount',      @money_type,                  '', '',
1744         'currency',         'char', 'NULL',       3, '', '',
1745         'status',        'varchar', 'NULL', $char_d, '', '',
1746         'error_message', 'varchar', 'NULL', $char_d, '', '',
1747       ],
1748       'primary_key' => 'paybatchnum',
1749       'unique' => [],
1750       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1751     },
1752
1753     'fcc477map' => {
1754       'columns' => [
1755         'formkey',   'varchar',     '', 255, '', '',
1756         'formvalue',    'text', 'NULL',  '', '', '',
1757       ],
1758       'primary_key' => 'formkey',
1759       'unique'      => [],
1760       'index'       => [],
1761     },
1762
1763     'cust_pkg' => {
1764       'columns' => [
1765         'pkgnum',           'serial',     '', '', '', '',
1766         'custnum',             'int',     '', '', '', '',
1767         'pkgpart',             'int',     '', '', '', '',
1768         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1769         'contactnum',          'int', 'NULL', '', '', '',
1770         'locationnum',         'int', 'NULL', '', '', '',
1771         'otaker',          'varchar', 'NULL', 32, '', '',
1772         'usernum',             'int', 'NULL', '', '', '',
1773         'order_date',     @date_type,             '', '',
1774         'start_date',     @date_type,             '', '',
1775         'setup',          @date_type,             '', '',
1776         'bill',           @date_type,             '', '',
1777         'last_bill',      @date_type,             '', '',
1778         'susp',           @date_type,             '', '',
1779         'adjourn',        @date_type,             '', '',
1780         'resume',         @date_type,             '', '',
1781         'cancel',         @date_type,             '', '',
1782         'uncancel',       @date_type,             '', '',
1783         'uncancel_pkgnum',     'int', 'NULL', '', '', '',
1784         'expire',         @date_type,             '', '',
1785         'contract_end',   @date_type,             '', '',
1786         'dundate',        @date_type,             '', '',
1787         'change_date',    @date_type,             '', '',
1788         'change_pkgnum',       'int', 'NULL', '', '', '',
1789         'change_pkgpart',      'int', 'NULL', '', '', '',
1790         'change_locationnum',  'int', 'NULL', '', '', '',
1791         'change_custnum',      'int', 'NULL', '', '', '',
1792         'main_pkgnum',         'int', 'NULL', '', '', '',
1793         'pkglinknum',          'int', 'NULL', '', '', '',
1794         'manual_flag',        'char', 'NULL',  1, '', '',
1795         'no_auto',            'char', 'NULL',  1, '', '',
1796         'quantity',            'int', 'NULL', '', '', '',
1797         'agent_pkgid',         'int', 'NULL', '', '', '',
1798         'waive_setup',        'char', 'NULL',  1, '', '',
1799         'recur_show_zero',    'char', 'NULL',  1, '', '',
1800         'setup_show_zero',    'char', 'NULL',  1, '', '',
1801       ],
1802       'primary_key' => 'pkgnum',
1803       'unique' => [],
1804       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1805                    [ 'usernum' ], [ 'agent_pkgid' ],
1806                    ['order_date'], [ 'start_date' ], ['setup'], ['bill'],
1807                    ['last_bill'], ['susp'], ['adjourn'], ['cancel'],
1808                    ['expire'], ['contract_end'], ['change_date'], ['no_auto'],
1809                  ],
1810     },
1811
1812     'cust_pkg_option' => {
1813       'columns' => [
1814         'optionnum', 'serial', '', '', '', '',
1815         'pkgnum', 'int', '', '', '', '',
1816         'optionname', 'varchar', '', $char_d, '', '',
1817         'optionvalue', 'text', 'NULL', '', '', '',
1818       ],
1819       'primary_key' => 'optionnum',
1820       'unique'      => [],
1821       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1822     },
1823
1824     'cust_pkg_detail' => {
1825       'columns' => [
1826         'pkgdetailnum', 'serial', '',      '', '', '',
1827         'pkgnum',          'int', '',      '', '', '',
1828         'detail',      'varchar', '', $char_d, '', '',
1829         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1830         'weight',          'int', '',      '', '', '',
1831       ],
1832       'primary_key' => 'pkgdetailnum',
1833       'unique' => [],
1834       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1835     },
1836
1837     'cust_pkg_reason' => {
1838       'columns' => [
1839         'num',      'serial',    '',   '', '', '',
1840         'pkgnum',   'int',    '',   '', '', '',
1841         'reasonnum','int',    '',   '', '', '',
1842         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1843         'otaker',   'varchar', 'NULL', 32, '', '',
1844         'usernum',   'int', 'NULL', '', '', '',
1845         'date',     @date_type, '', '',
1846       ],
1847       'primary_key' => 'num',
1848       'unique' => [],
1849       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1850     },
1851
1852     'cust_pkg_discount' => {
1853       'columns' => [
1854         'pkgdiscountnum', 'serial', '',        '', '', '',
1855         'pkgnum',            'int', '',        '', '', '',
1856         'discountnum',       'int', '',        '', '', '',
1857         'months_used',   'decimal', 'NULL', '7,4', '', '',
1858         'end_date',     @date_type,                '', '',
1859         'otaker',        'varchar', 'NULL',    32, '', '',
1860         'usernum',           'int', 'NULL',    '', '', '',
1861         'disabled',         'char', 'NULL',     1, '', '',
1862       ],
1863       'primary_key' => 'pkgdiscountnum',
1864       'unique' => [],
1865       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1866     },
1867
1868     'cust_pkg_usage' => {
1869       'columns' => [
1870         'pkgusagenum', 'serial', '', '', '', '',
1871         'pkgnum',         'int', '', '', '', '',
1872         'minutes',        'int', '', '', '', '',
1873         'pkgusagepart',   'int', '', '', '', '',
1874       ],
1875       'primary_key' => 'pkgusagenum',
1876       'unique' => [],
1877       'index'  => [ [ 'pkgnum' ], [ 'pkgusagepart' ] ],
1878     },
1879
1880     'cdr_cust_pkg_usage' => {
1881       'columns' => [
1882         'cdrusagenum', 'bigserial', '', '', '', '',
1883         'acctid',      'bigint',    '', '', '', '',
1884         'pkgusagenum', 'int',       '', '', '', '',
1885         'minutes',     'int',       '', '', '', '',
1886       ],
1887       'primary_key' => 'cdrusagenum',
1888       'unique' => [],
1889       'index'  => [ [ 'pkgusagenum' ], [ 'acctid' ] ],
1890     },
1891
1892     'cust_bill_pkg_discount' => {
1893       'columns' => [
1894         'billpkgdiscountnum', 'serial',        '', '', '', '',
1895         'billpkgnum',            'int',        '', '', '', '',
1896         'pkgdiscountnum',        'int',        '', '', '', '',
1897         'amount',          @money_type,                '', '',
1898         'months',            'decimal', 'NULL', '7,4', '', '',
1899       ],
1900       'primary_key' => 'billpkgdiscountnum',
1901       'unique' => [],
1902       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1903     },
1904
1905     'cust_bill_pkg_discount_void' => {
1906       'columns' => [
1907         'billpkgdiscountnum',    'int',        '', '', '', '',
1908         'billpkgnum',            'int',        '', '', '', '',
1909         'pkgdiscountnum',        'int',        '', '', '', '',
1910         'amount',          @money_type,                '', '',
1911         'months',            'decimal', 'NULL', '7,4', '', '',
1912       ],
1913       'primary_key' => 'billpkgdiscountnum',
1914       'unique' => [],
1915       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1916     },
1917
1918     'discount' => {
1919       'columns' => [
1920         'discountnum', 'serial',     '',      '', '', '',
1921         #'agentnum',       'int', 'NULL',      '', '', '',
1922         'name',       'varchar', 'NULL', $char_d, '', '',
1923         'amount',   @money_type,                  '', '',
1924         'percent',    'decimal',     '',   '7,4', '', '',
1925         'months',     'decimal', 'NULL',   '7,4', '', '',
1926         'disabled',      'char', 'NULL',       1, '', '',
1927         'setup',         'char', 'NULL',       1, '', '',
1928         #'linked',        'char', 'NULL',       1, '', '',
1929       ],
1930       'primary_key' => 'discountnum',
1931       'unique' => [],
1932       'index'  => [], # [ 'agentnum' ], ],
1933     },
1934
1935     'cust_refund' => {
1936       'columns' => [
1937         'refundnum',    'serial',    '',   '', '', '',
1938         'custnum',  'int',    '',   '', '', '',
1939         '_date',        @date_type, '', '',
1940         'refund',       @money_type, '', '',
1941         'otaker',       'varchar',   'NULL',   32, '', '',
1942         'usernum',   'int', 'NULL', '', '', '',
1943         'reason',       'varchar',   '',   $char_d, '', '',
1944         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1945                                                      # be index into payby
1946                                                      # table eventually
1947         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1948         'paymask', 'varchar', 'NULL', $char_d, '', '',
1949         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1950         'closed',    'char', 'NULL', 1, '', '',
1951         # credit card/EFT fields (formerly in paybatch)
1952         'gatewaynum',     'int', 'NULL', '', '', '', # payment_gateway FK
1953         'processor',  'varchar', 'NULL', $char_d, '', '', # module name
1954         'auth',       'varchar','NULL',16, '', '', # CC auth number
1955         'order_number', 'varchar','NULL',$char_d, '', '', # transaction number
1956       ],
1957       'primary_key' => 'refundnum',
1958       'unique' => [],
1959       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1960     },
1961
1962     'cust_credit_refund' => {
1963       'columns' => [
1964         'creditrefundnum', 'serial',     '',   '', '', '',
1965         'crednum',  'int',     '',   '', '', '',
1966         'refundnum',  'int',     '',   '', '', '',
1967         'amount',  @money_type, '', '',
1968         '_date',   @date_type, '', '',
1969       ],
1970       'primary_key' => 'creditrefundnum',
1971       'unique' => [],
1972       'index' => [ ['crednum'], ['refundnum'] ],
1973     },
1974
1975
1976     'cust_svc' => {
1977       'columns' => [
1978         'svcnum',      'serial',     '', '', '', '',
1979         'pkgnum',         'int', 'NULL', '', '', '',
1980         'svcpart',        'int',     '', '', '', '',
1981         'agent_svcid',    'int', 'NULL', '', '', '',
1982         'overlimit',           @date_type,   '', '',
1983       ],
1984       'primary_key' => 'svcnum',
1985       'unique' => [],
1986       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'], [ 'agent_svcid' ] ],
1987     },
1988
1989     'cust_svc_option' => {
1990       'columns' => [
1991         'optionnum',   'serial', '', '', '', '',
1992         'svcnum',      'int', '', '', '', '',
1993         'optionname',  'varchar', '', $char_d, '', '',
1994         'optionvalue', 'text', 'NULL', '', '', '',
1995       ],
1996       'primary_key' => 'optionnum',
1997       'unique'      => [],
1998       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1999     },
2000
2001     'svc_export_machine' => {
2002       'columns' => [
2003         'svcexportmachinenum', 'serial', '', '', '', '',
2004         'svcnum',                 'int', '', '', '', '',
2005         'exportnum',              'int', '', '', '', '',
2006         'machinenum',             'int', '', '', '', '',
2007       ],
2008       'primary_key' => 'svcexportmachinenum',
2009       'unique'      => [ ['svcnum', 'exportnum'] ],
2010       'index'       => [],
2011     },
2012
2013     'part_export_machine' => {
2014       'columns' => [
2015         'machinenum', 'serial', '', '', '', '',
2016         'exportnum',     'int', '', '', '', '',
2017         'machine',    'varchar', 'NULL', $char_d, '', '',
2018         'disabled',      'char', 'NULL',       1, '', '',
2019       ],
2020       'primary_key' => 'machinenum',
2021       'unique'      => [ [ 'exportnum', 'machine' ] ],
2022       'index'       => [ [ 'exportnum' ] ],
2023     },
2024
2025    'part_pkg' => {
2026       'columns' => [
2027         'pkgpart',       'serial',    '',   '', '', '',
2028         'pkg',           'varchar',   '',   $char_d, '', '',
2029         'comment',       'varchar',   '', 2*$char_d, '', '',
2030         'promo_code',    'varchar', 'NULL', $char_d, '', '',
2031         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
2032         'setuptax',      'char', 'NULL', 1, '', '',
2033         'recurtax',      'char', 'NULL', 1, '', '',
2034         'plan',          'varchar', 'NULL', $char_d, '', '',
2035         'disabled',      'char', 'NULL', 1, '', '',
2036         'custom',        'char', 'NULL', 1, '', '',
2037         'taxclass',      'varchar', 'NULL', $char_d, '', '',
2038         'classnum',      'int',     'NULL', '', '', '',
2039         'addon_classnum','int',     'NULL', '', '', '',
2040         'taxproductnum', 'int',     'NULL', '', '', '',
2041         'setup_cost',    @money_typen,          '', '',
2042         'recur_cost',    @money_typen,          '', '',
2043         'pay_weight',    'real',    'NULL', '', '', '',
2044         'credit_weight', 'real',    'NULL', '', '', '',
2045         'agentnum',      'int',     'NULL', '', '', '',
2046         'fcc_ds0s',      'int',     'NULL', '', '', '',
2047         'fcc_voip_class','char',    'NULL',  1, '', '',
2048         'no_auto',          'char', 'NULL',  1, '', '',
2049         'recur_show_zero',  'char', 'NULL',  1, '', '',
2050         'setup_show_zero',  'char', 'NULL',  1, '', '',
2051         'successor',     'int',     'NULL', '', '', '',
2052         'family_pkgpart','int',     'NULL', '', '', '',
2053         'delay_start',   'int',     'NULL', '', '', '',
2054       ],
2055       'primary_key' => 'pkgpart',
2056       'unique' => [],
2057       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
2058                    [ 'agentnum' ], ['no_auto'],
2059                  ],
2060     },
2061
2062     'part_pkg_msgcat' => {
2063       'columns' => [
2064         'pkgpartmsgnum',  'serial',     '',        '', '', '',
2065         'pkgpart',           'int',     '',        '', '', '',
2066         'locale',        'varchar',     '',        16, '', '',
2067         'pkg',           'varchar',     '',   $char_d, '', '', #longer/no limit?
2068         'comment',       'varchar', 'NULL', 2*$char_d, '', '', #longer/no limit?
2069       ],
2070       'primary_key' => 'pkgpartmsgnum',
2071       'unique'      => [ [ 'pkgpart', 'locale' ] ],
2072       'index'       => [],
2073     },
2074
2075     'part_pkg_currency' => {
2076       'columns' => [
2077         'pkgcurrencynum', 'serial', '',      '', '', '',
2078         'pkgpart',           'int', '',      '', '', '',
2079         'currency',         'char', '',       3, '', '',
2080         'optionname',    'varchar', '', $char_d, '', '',
2081         'optionvalue',      'text', '',      '', '', '',
2082       ],
2083       'primary_key' => 'pkgcurrencynum',
2084       'unique'      => [ [ 'pkgpart', 'currency', 'optionname' ] ],
2085       'index'       => [ ['pkgpart'] ],
2086     },
2087
2088     'currency_exchange' => {
2089       'columns' => [
2090         'currencyratenum', 'serial', '',    '', '', '',
2091         'from_currency',     'char', '',     3, '', '',
2092         'to_currency',       'char', '',     3, '', '',
2093         'rate',           'decimal', '', '7,6', '', '',
2094       ],
2095       'primary_key' => 'currencyratenum',
2096       'unique'      => [ [ 'from_currency', 'to_currency' ] ],
2097       'index'       => [],
2098     },
2099
2100     'part_pkg_link' => {
2101       'columns' => [
2102         'pkglinknum',  'serial',   '',      '', '', '',
2103         'src_pkgpart', 'int',      '',      '', '', '',
2104         'dst_pkgpart', 'int',      '',      '', '', '',
2105         'link_type',   'varchar',  '', $char_d, '', '',
2106         'hidden',      'char', 'NULL',       1, '', '',
2107       ],
2108       'primary_key' => 'pkglinknum',
2109       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
2110       'index'  => [ [ 'src_pkgpart' ] ],
2111     },
2112     # XXX somewhat borked unique: we don't really want a hidden and unhidden
2113     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
2114
2115     'part_pkg_discount' => {
2116       'columns' => [
2117         'pkgdiscountnum', 'serial',   '',      '', '', '',
2118         'pkgpart',        'int',      '',      '', '', '',
2119         'discountnum',    'int',      '',      '', '', '',
2120       ],
2121       'primary_key' => 'pkgdiscountnum',
2122       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
2123       'index'  => [],
2124     },
2125
2126     'part_pkg_taxclass' => {
2127       'columns' => [
2128         'taxclassnum',  'serial', '',       '', '', '',
2129         'taxclass',     'varchar', '', $char_d, '', '',
2130         'disabled', 'char',   'NULL',         1, '', '',
2131       ],
2132       'primary_key' => 'taxclassnum',
2133       'unique'      => [ [ 'taxclass' ] ],
2134       'index'       => [ [ 'disabled' ] ],
2135     },
2136
2137     'part_pkg_taxproduct' => {
2138       'columns' => [
2139         'taxproductnum', 'serial',      '',        '', '', '',
2140         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
2141         'taxproduct',    'varchar',     '',   $char_d, '', '',
2142         'description',   'varchar',     '', 3*$char_d, '', '',
2143       ],
2144       'primary_key' => 'taxproductnum',
2145       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
2146       'index'       => [],
2147     },
2148
2149     'part_pkg_taxrate' => {
2150       'columns' => [
2151         'pkgtaxratenum', 'serial',  '',     '',      '', '',
2152         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
2153         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
2154         'taxproductnum', 'int',  '',     '',       '', '',
2155         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
2156         'county',           'varchar', 'NULL', $char_d, '', '',
2157         'state',            'varchar', 'NULL', $char_d, '', '',
2158         'local',            'varchar', 'NULL', $char_d, '', '',
2159         'country',          'char',    'NULL', 2,       '', '',
2160         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
2161         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
2162         'taxclassnum',      'int',     'NULL', '',      '', '',
2163         'effdate',          @date_type, '', '',
2164         'taxable',          'char',    'NULL', 1,       '', '',
2165       ],
2166       'primary_key' => 'pkgtaxratenum',
2167       'unique' => [],
2168       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
2169     },
2170
2171     'part_pkg_taxoverride' => {
2172       'columns' => [
2173         'taxoverridenum', 'serial', '', '', '', '',
2174         'pkgpart',           'int', '', '', '', '',
2175         'taxclassnum',       'int', '', '', '', '',
2176         'usage_class',    'varchar', 'NULL', $char_d, '', '',
2177       ],
2178       'primary_key' => 'taxoverridenum',
2179       'unique' => [],
2180       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
2181     },
2182
2183 #    'part_title' => {
2184 #      'columns' => [
2185 #        'titlenum',   'int',    '',   '',
2186 #        'title',      'varchar',   '',   $char_d,
2187 #      ],
2188 #      'primary_key' => 'titlenum',
2189 #      'unique' => [ [] ],
2190 #      'index' => [ [] ],
2191 #    },
2192
2193     'pkg_svc' => {
2194       'columns' => [
2195         'pkgsvcnum',  'serial', '',  '', '', '',
2196         'pkgpart',    'int',    '',   '', '', '',
2197         'svcpart',    'int',    '',   '', '', '',
2198         'quantity',   'int',    '',   '', '', '',
2199         'primary_svc','char', 'NULL',  1, '', '',
2200         'hidden',     'char', 'NULL',  1, '', '',
2201       ],
2202       'primary_key' => 'pkgsvcnum',
2203       'unique' => [ ['pkgpart', 'svcpart'] ],
2204       'index' => [ ['pkgpart'], ['quantity'] ],
2205     },
2206
2207     'part_referral' => {
2208       'columns' => [
2209         'refnum',   'serial',     '',        '', '', '',
2210         'referral', 'varchar',    '',   $char_d, '', '',
2211         'disabled', 'char',   'NULL',         1, '', '',
2212         'agentnum', 'int',    'NULL',        '', '', '',
2213       ],
2214       'primary_key' => 'refnum',
2215       'unique' => [],
2216       'index' => [ ['disabled'], ['agentnum'], ],
2217     },
2218
2219     'part_svc' => {
2220       'columns' => [
2221         'svcpart',             'serial',     '',        '', '', '',
2222         'svc',                'varchar',     '',   $char_d, '', '',
2223         'svcdb',              'varchar',     '',   $char_d, '', '',
2224         'disabled',              'char', 'NULL',         1, '', '',
2225         'preserve',              'char', 'NULL',         1, '', '',
2226         'selfservice_access', 'varchar', 'NULL',   $char_d, '', '',
2227         'classnum',               'int', 'NULL',        '', '', '',
2228         'restrict_edit_password','char', 'NULL',         1, '', '',
2229 ],
2230       'primary_key' => 'svcpart',
2231       'unique' => [],
2232       'index' => [ [ 'disabled' ] ],
2233     },
2234
2235     'part_svc_column' => {
2236       'columns' => [
2237         'columnnum',   'serial',      '',      '', '', '',
2238         'svcpart',     'int',         '',      '', '', '',
2239         'columnname',  'varchar',     '',      64, '', '',
2240         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
2241         'columnvalue', 'varchar', 'NULL',     512, '', '',
2242         'columnflag',  'char',    'NULL',       1, '', '',
2243       ],
2244       'primary_key' => 'columnnum',
2245       'unique' => [ [ 'svcpart', 'columnname' ] ],
2246       'index' => [ [ 'svcpart' ] ],
2247     },
2248
2249     'part_svc_class' => {
2250       'columns' => [
2251         'classnum',    'serial',   '',      '', '', '',
2252         'classname',   'varchar',  '', $char_d, '', '',
2253         'disabled',    'char', 'NULL',       1, '', '',
2254       ],
2255       'primary_key' => 'classnum',
2256       'unique' => [],
2257       'index' => [ ['disabled'] ],
2258     },
2259
2260     #(this should be renamed to part_pop)
2261     'svc_acct_pop' => {
2262       'columns' => [
2263         'popnum',    'serial',    '',   '', '', '',
2264         'city',      'varchar',   '',   $char_d, '', '',
2265         'state',     'varchar',   '',   $char_d, '', '',
2266         'ac',        'char',   '',   3, '', '',
2267         'exch',      'char',   '',   3, '', '',
2268         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
2269       ],
2270       'primary_key' => 'popnum',
2271       'unique' => [],
2272       'index' => [ [ 'state' ] ],
2273     },
2274
2275     'part_pop_local' => {
2276       'columns' => [
2277         'localnum',  'serial',     '',     '', '', '',
2278         'popnum',    'int',     '',     '', '', '',
2279         'city',      'varchar', 'NULL', $char_d, '', '',
2280         'state',     'char',    'NULL', 2, '', '',
2281         'npa',       'char',    '',     3, '', '',
2282         'nxx',       'char',    '',     3, '', '',
2283       ],
2284       'primary_key' => 'localnum',
2285       'unique' => [],
2286       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
2287     },
2288
2289     'qual' => {
2290       'columns' => [
2291         'qualnum',  'serial',     '',     '', '', '',
2292         'custnum',    'int',     'NULL',     '', '', '',
2293         'prospectnum',    'int',     'NULL',     '', '', '',
2294         'locationnum',    'int',     'NULL',     '', '', '',
2295         'phonenum',     'varchar', 'NULL',       24, '', '',
2296         'exportnum',      'int', 'NULL', '', '', '',
2297         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
2298         'status',      'char', '', 1, '', '',
2299       ],
2300       'primary_key' => 'qualnum',
2301       'unique' => [],
2302       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
2303                     ['phonenum'], ['vendor_qual_id'] ],
2304     },
2305
2306     'qual_option' => {
2307       'columns' => [
2308         'optionnum', 'serial', '', '', '', '',
2309         'qualnum',  'int',     '',     '', '', '',
2310         'optionname', 'varchar', '', $char_d, '', '',
2311         'optionvalue', 'text', 'NULL', '', '', '',
2312       ],
2313       'primary_key' => 'optionnum',
2314       'unique' => [],
2315       'index' => [],
2316     },
2317
2318     'svc_acct' => {
2319       'columns' => [
2320         'svcnum',    'int',    '',   '', '', '',
2321         'username',  'varchar',   '',   $username_len, '', '',
2322         '_password', 'varchar',   'NULL',  512, '', '',
2323         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
2324         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
2325         'popnum',    'int',    'NULL',   '', '', '',
2326         'sectornum', 'int', 'NULL',      '', '', '',
2327         'uid',       'int', 'NULL',   '', '', '',
2328         'gid',       'int', 'NULL',   '', '', '',
2329         'finger',    'varchar',   'NULL',   2*$char_d, '', '',
2330         'dir',       'varchar',   'NULL',   $char_d, '', '',
2331         'shell',     'varchar',   'NULL',   $char_d, '', '',
2332         'quota',     'varchar',   'NULL',   $char_d, '', '',
2333         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
2334         # IP address mgmt
2335         'routernum', 'int', 'NULL',      '', '', '',
2336         'blocknum',  'int', 'NULL',      '', '', '',
2337         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
2338         'seconds_threshold',   'int', 'NULL',   '', '', '',
2339         'upbytes',   'bigint', 'NULL',   '', '', '',
2340         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
2341         'downbytes', 'bigint', 'NULL',   '', '', '',
2342         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
2343         'totalbytes','bigint', 'NULL',   '', '', '',
2344         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
2345         'domsvc',    'int',     '', '', '', '',
2346         'pbxsvc',    'int', 'NULL', '', '', '',
2347         'last_login',  @date_type, '', '',
2348         'last_logout', @date_type, '', '',
2349         #cardfortress field(s)
2350         'cf_privatekey',      'text', 'NULL',      '', '', '',
2351         #communigate pro fields (quota = MaxAccountSize)
2352         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
2353         #settings
2354         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
2355         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
2356         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
2357         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
2358         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
2359         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
2360         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
2361         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
2362         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
2363         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
2364         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
2365         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
2366         #XXX mailing lists
2367         #preferences
2368         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
2369         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
2370         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
2371         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
2372         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
2373         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
2374         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
2375         #mail
2376         #XXX RPOP settings
2377         #
2378       ],
2379       'primary_key' => 'svcnum',
2380       #'unique' => [ [ 'username', 'domsvc' ] ],
2381       'unique' => [],
2382       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
2383     },
2384
2385     'acct_rt_transaction' => {
2386       'columns' => [
2387         'svcrtid',   'int',    '',   '', '', '',
2388         'svcnum',    'int',    '',   '', '', '',
2389         'transaction_id',       'int', '',   '', '', '',
2390         '_date',   @date_type, '', '',
2391         'seconds',   'int', '',   '', '', '', #uhhhh
2392         'support',   'int', '',   '', '', '',
2393       ],
2394       'primary_key' => 'svcrtid',
2395       'unique' => [],
2396       'index' => [ ['svcnum', 'transaction_id'] ],
2397     },
2398
2399     #'svc_charge' => {
2400     #  'columns' => [
2401     #    'svcnum',    'int',    '',   '',
2402     #    'amount',    @money_type,
2403     #  ],
2404     #  'primary_key' => 'svcnum',
2405     #  'unique' => [ [] ],
2406     #  'index' => [ [] ],
2407     #},
2408
2409     'svc_domain' => {
2410       'columns' => [
2411         'svcnum',           'int',    '',        '', '', '',
2412         'domain',       'varchar',    '',   $char_d, '', '',
2413         'suffix',       'varchar', 'NULL',  $char_d, '', '',
2414         'catchall',         'int', 'NULL',       '', '', '',
2415         'parent_svcnum',    'int', 'NULL',       '', '', '',
2416         'registrarnum',     'int', 'NULL',       '', '', '',
2417         'registrarkey', 'varchar', 'NULL',      512, '', '',
2418         'setup_date',      @date_type, '', '',
2419         'renewal_interval', 'int', 'NULL',       '', '', '',
2420         'expiration_date', @date_type, '', '',
2421         'au_registrant_name',       'varchar', 'NULL',  $char_d, '', '',
2422         'au_eligibility_type',      'varchar', 'NULL',  $char_d, '', '',
2423         #communigate pro fields (quota = MaxAccountSize)
2424         'max_accounts',     'int', 'NULL',       '', '', '',
2425         'trailer',         'text', 'NULL',       '', '', '',
2426         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
2427         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
2428         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
2429         #settings
2430         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
2431         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
2432         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
2433         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
2434         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
2435         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
2436         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
2437         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
2438         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
2439         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
2440         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
2441         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
2442         #preferences
2443         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
2444         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
2445         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
2446         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
2447         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
2448         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
2449         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
2450       ],
2451       'primary_key' => 'svcnum',
2452       'unique' => [ ],
2453       'index' => [ ['domain'] ],
2454     },
2455
2456     'svc_dsl' => {
2457       'columns' => [
2458         'svcnum',                    'int',    '',        '', '', '',
2459         'pushed',                    'int', 'NULL',       '', '', '',
2460         'desired_due_date',          'int', 'NULL',       '', '', '',
2461         'due_date',                  'int', 'NULL',       '', '', '',
2462         'vendor_order_id',       'varchar', 'NULL', $char_d,  '', '',
2463         'vendor_qual_id',        'varchar', 'NULL', $char_d,  '', '',
2464         'vendor_order_type',     'varchar', 'NULL', $char_d,  '', '',
2465         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
2466         'first',                 'varchar', 'NULL', $char_d,  '', '',
2467         'last',                  'varchar', 'NULL', $char_d,  '', '',
2468         'company',               'varchar', 'NULL', $char_d,  '', '',
2469         'phonenum',              'varchar', 'NULL',      24, '', '',
2470         'gateway_access_number', 'varchar', 'NULL',      24, '', '',
2471         'loop_type',                'char', 'NULL',       1, '', '',
2472         'local_voice_provider',  'varchar', 'NULL', $char_d, '', '',
2473         'circuitnum',            'varchar', 'NULL', $char_d, '', '',
2474         'rate_band',             'varchar', 'NULL', $char_d, '', '',
2475         'vpi',                       'int', 'NULL',      '', '', '',
2476         'vci',                       'int', 'NULL',      '', '', '',
2477         'isp_chg',                  'char', 'NULL',       1, '', '',
2478         'isp_prev',              'varchar', 'NULL', $char_d, '', '',
2479         'username',              'varchar', 'NULL', $char_d, '', '',
2480         'password',              'varchar', 'NULL', $char_d, '', '',
2481         'staticips',                'text', 'NULL',      '', '', '',
2482         'monitored',                'char', 'NULL',       1, '', '',
2483         'last_pull',                 'int', 'NULL',      '', '', '',
2484       ],
2485       'primary_key' => 'svcnum',
2486       'unique' => [ ],
2487       'index' => [ ['phonenum'], ['vendor_order_id'] ],
2488     },
2489
2490     'dsl_device' => {
2491       'columns' => [
2492         'devicenum', 'serial',     '', '', '', '',
2493         #part_device?  or our own part_dsl_device?
2494         #'devicepart',   'int',     '', '', '', '',
2495         'svcnum',       'int',     '', '', '', '',
2496         'mac_addr', 'varchar',     '', 12, '', '',
2497       ],
2498       'primary_key' => 'devicenum',
2499       'unique' => [ [ 'mac_addr' ], ],
2500       'index'  => [ [ 'svcnum' ], ], # [ 'devicepart' ] ],
2501     },
2502
2503     'dsl_note' => {
2504       'columns' => [
2505         'notenum',           'serial',    '',        '', '', '',
2506         'svcnum',     'int', '',       '', '', '',
2507         'author',     'varchar', 'NULL', $char_d,  '', '',
2508         'priority',   'char', 'NULL',       1,  '', '',
2509         '_date',     'int', 'NULL',       '', '', '',
2510         'note',     'text', '',       '', '', '',
2511       ],
2512       'primary_key' => 'notenum',
2513       'unique' => [ ],
2514       'index' => [ ['svcnum'] ],
2515     },
2516
2517     'svc_dish' => {
2518       'columns' => [
2519         'svcnum',   'int',     '',     '', '', '',
2520         'acctnum',  'varchar', '',     16, '', '',
2521         'installdate', @date_type,         '', '',
2522         'note',     'text',    'NULL', '', '', '',
2523       ],
2524       'primary_key' => 'svcnum',
2525       'unique' => [ ],
2526       'index' => [ ],
2527     },
2528
2529     'svc_hardware' => {
2530       'columns' => [
2531         'svcnum',   'int',     '',          '', '', '',
2532         'typenum',  'int',     '',          '', '', '',
2533         'serial',   'varchar', 'NULL', $char_d, '', '',
2534         'ip_addr',  'varchar', 'NULL',      40, '', '',
2535         'hw_addr',  'varchar', 'NULL',      12, '', '',
2536         'smartcard','varchar', 'NULL',      30, '', '',
2537         'statusnum','int',     'NULL',      '', '', '',
2538         'note',     'text',    'NULL',      '', '', '',
2539       ],
2540       'primary_key' => 'svcnum',
2541       'unique' => [ ],
2542       'index' => [ ],
2543     },
2544
2545     'hardware_class' => {
2546       'columns' => [
2547         'classnum',   'serial', '',      '', '', '',
2548         'classname', 'varchar', '', $char_d, '', '',
2549       ],
2550       'primary_key' => 'classnum',
2551       'unique' => [ ],
2552       'index'  => [ ],
2553     },
2554
2555     'hardware_type' => {
2556       'columns' => [
2557         'typenum',  'serial',     '',      '', '', '',
2558         'classnum',    'int',     '',      '', '', '',
2559         'model',   'varchar',     '', $char_d, '', '',
2560         'revision','varchar', 'NULL', $char_d, '', '',
2561       ],
2562       'primary_key' => 'typenum',
2563       'unique' => [ [ 'classnum', 'model', 'revision' ] ],
2564       'index'  => [ ],
2565     },
2566
2567     'hardware_status' => {
2568       'columns' => [
2569         'statusnum', 'serial', '',      '', '', '',
2570         'label'    ,'varchar', '', $char_d, '', '',
2571         'disabled',    'char', 'NULL',   1, '', '',
2572       ],
2573       'primary_key' => 'statusnum',
2574       'unique' => [ ],
2575       'index'  => [ ],
2576     },
2577
2578     'domain_record' => {
2579       'columns' => [
2580         'recnum',    'serial',     '',  '', '', '',
2581         'svcnum',    'int',     '',  '', '', '',
2582         'reczone',   'varchar', '',  255, '', '',
2583         'recaf',     'char',    '',  2, '', '',
2584         'rectype',   'varchar',    '',  5, '', '',
2585         'recdata',   'varchar', '',  255, '', '',
2586         'ttl',       'int',     'NULL', '', '', '',
2587       ],
2588       'primary_key' => 'recnum',
2589       'unique'      => [],
2590       'index'       => [ ['svcnum'] ],
2591     },
2592
2593     'registrar' => {
2594       'columns' => [
2595         'registrarnum',   'serial', '',      '', '', '',
2596         'registrarname', 'varchar', '', $char_d, '', '',
2597       ],
2598       'primary_key' => 'registrarnum',
2599       'unique'      => [],
2600       'index'       => [],
2601     },
2602
2603     'cgp_rule' => {
2604       'columns' => [
2605         'rulenum',  'serial',     '',      '', '', '',
2606         'name',    'varchar',     '', $char_d, '', '',
2607         'comment', 'varchar', 'NULL', $char_d, '', '',
2608         'svcnum',      'int',     '',      '', '', '',
2609         'priority',    'int',     '',      '', '', '',
2610       ],
2611       'primary_key' => 'rulenum',
2612       'unique'      => [ [ 'svcnum', 'name' ] ],
2613       'index'       => [ [ 'svcnum' ] ],
2614     },
2615
2616     'cgp_rule_condition' => {
2617       'columns' => [
2618         'ruleconditionnum',  'serial',     '',      '', '', '',
2619         'conditionname',    'varchar',     '', $char_d, '', '',
2620         'op',               'varchar', 'NULL', $char_d, '', '',
2621         'params',           'varchar', 'NULL',     255, '', '',
2622         'rulenum',              'int',     '',      '', '', '',
2623       ],
2624       'primary_key' => 'ruleconditionnum',
2625       'unique'      => [],
2626       'index'       => [ [ 'rulenum' ] ],
2627     },
2628
2629     'cgp_rule_action' => {
2630        'columns' => [
2631         'ruleactionnum',  'serial',     '',      '', '', '',
2632         'action',        'varchar',     '', $char_d, '', '',
2633         'params',        'varchar', 'NULL',     255, '', '',
2634         'rulenum',           'int',     '',      '', '', '',
2635       ],
2636       'primary_key' => 'ruleactionnum',
2637       'unique'      => [],
2638       'index'       => [ [ 'rulenum' ] ],
2639    },
2640
2641     'svc_forward' => {
2642       'columns' => [
2643         'svcnum',   'int',            '',   '', '', '',
2644         'srcsvc',   'int',        'NULL',   '', '', '',
2645         'src',      'varchar',    'NULL',  255, '', '',
2646         'dstsvc',   'int',        'NULL',   '', '', '',
2647         'dst',      'varchar',    'NULL',  255, '', '',
2648       ],
2649       'primary_key' => 'svcnum',
2650       'unique'      => [],
2651       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2652     },
2653
2654     'svc_www' => {
2655       'columns' => [
2656         'svcnum',   'int',      '',  '', '', '',
2657         'recnum',   'int',      '',  '', '', '',
2658         'usersvc',  'int',  'NULL',  '', '', '',
2659         'config',   'text', 'NULL',  '', '', '',
2660       ],
2661       'primary_key' => 'svcnum',
2662       'unique'      => [],
2663       'index'       => [],
2664     },
2665
2666     #'svc_wo' => {
2667     #  'columns' => [
2668     #    'svcnum',    'int',    '',   '',
2669     #    'svcnum',    'int',    '',   '',
2670     #    'svcnum',    'int',    '',   '',
2671     #    'worker',    'varchar',   '',   $char_d,
2672     #    '_date',     @date_type,
2673     #  ],
2674     #  'primary_key' => 'svcnum',
2675     #  'unique' => [ [] ],
2676     #  'index' => [ [] ],
2677     #},
2678
2679     'prepay_credit' => {
2680       'columns' => [
2681         'prepaynum',   'serial',     '',   '', '', '',
2682         'identifier',  'varchar', '', $char_d, '', '',
2683         'amount',      @money_type, '', '',
2684         'seconds',     'int',     'NULL', '', '', '',
2685         'upbytes',     'bigint',     'NULL', '', '', '',
2686         'downbytes',   'bigint',     'NULL', '', '', '',
2687         'totalbytes',  'bigint',     'NULL', '', '', '',
2688         'agentnum',    'int',     'NULL', '', '', '',
2689       ],
2690       'primary_key' => 'prepaynum',
2691       'unique'      => [ ['identifier'] ],
2692       'index'       => [],
2693     },
2694
2695     'port' => {
2696       'columns' => [
2697         'portnum',  'serial',     '',   '', '', '',
2698         'ip',       'varchar', 'NULL', 15, '', '',
2699         'nasport',  'int',     'NULL', '', '', '',
2700         'nasnum',   'int',     '',   '', '', '',
2701       ],
2702       'primary_key' => 'portnum',
2703       'unique'      => [],
2704       'index'       => [],
2705     },
2706
2707     'nas' => {
2708       'columns' => [
2709         'nasnum',       'serial',     '',  '',              '', '',
2710         'nasname',     'varchar',     '', 128,              '', '',
2711         'shortname',   'varchar', 'NULL',  32,              '', '',
2712         'type',        'varchar',     '',  30,         'other', '',
2713         'ports',           'int', 'NULL',  '',              '', '',
2714         'secret',      'varchar',     '',  60,        'secret', '',
2715         'server',      'varchar', 'NULL',  64,              '', '',
2716         'community',   'varchar', 'NULL',  50,              '', '',
2717         'description', 'varchar',     '', 200, 'RADIUS Client', '',
2718         'svcnum',          'int', 'NULL',  '',              '', '',
2719       ],
2720       'primary_key' => 'nasnum',
2721       'unique'      => [ [ 'nasname' ], ],
2722       'index'       => [],
2723     },
2724
2725     'export_nas' => {
2726       'columns' => [
2727         'exportnasnum', 'serial', '', '', '', '',
2728         'exportnum',       'int', '', '', '', '',
2729         'nasnum',          'int', '', '', '', '',
2730       ],
2731       'primary_key' => 'exportnasnum',
2732       'unique'      => [ [ 'exportnum', 'nasnum' ] ],
2733       'index'       => [ [ 'exportnum' ], [ 'nasnum' ] ],
2734     },
2735
2736     'queue' => {
2737       'columns' => [
2738         'jobnum',   'bigserial',     '',      '', '', '',
2739         'job',        'varchar',     '',     512, '', '',
2740         '_date',          'int',     '',      '', '', '',
2741         'status',     'varchar',     '', $char_d, '', '',
2742         'statustext',    'text', 'NULL',      '', '', '',
2743         'svcnum',         'int', 'NULL',      '', '', '',
2744         'custnum',        'int', 'NULL',      '', '', '',
2745         'secure',        'char', 'NULL',       1, '', '',
2746         'priority',       'int', 'NULL',      '', '', '',
2747       ],
2748       'primary_key' => 'jobnum',
2749       'unique'      => [],
2750       'index'       => [ [ 'secure' ], [ 'priority' ],
2751                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2752                        ],
2753     },
2754
2755     'queue_arg' => {
2756       'columns' => [
2757         'argnum', 'bigserial',     '', '', '', '',
2758         'jobnum',    'bigint',     '', '', '', '',
2759         'frozen',      'char', 'NULL',  1, '', '',
2760         'arg',         'text', 'NULL', '', '', '',
2761       ],
2762       'primary_key' => 'argnum',
2763       'unique'      => [],
2764       'index'       => [ [ 'jobnum' ] ],
2765     },
2766
2767     'queue_depend' => {
2768       'columns' => [
2769         'dependnum',  'bigserial', '', '', '', '',
2770         'jobnum',        'bigint', '', '', '', '',
2771         'depend_jobnum', 'bigint', '', '', '', '',
2772       ],
2773       'primary_key' => 'dependnum',
2774       'unique'      => [],
2775       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2776     },
2777
2778     'export_svc' => {
2779       'columns' => [
2780         'exportsvcnum' => 'serial', '', '', '', '',
2781         'exportnum'    => 'int', '', '', '', '',
2782         'svcpart'      => 'int', '', '', '', '',
2783       ],
2784       'primary_key' => 'exportsvcnum',
2785       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2786       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2787     },
2788
2789     'export_device' => {
2790       'columns' => [
2791         'exportdevicenum' => 'serial', '', '', '', '',
2792         'exportnum'    => 'int', '', '', '', '',
2793         'devicepart'      => 'int', '', '', '', '',
2794       ],
2795       'primary_key' => 'exportdevicenum',
2796       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2797       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2798     },
2799
2800     'part_export' => {
2801       'columns' => [
2802         'exportnum',   'serial',     '',      '', '', '',
2803         'exportname', 'varchar', 'NULL', $char_d, '', '',
2804         'machine',    'varchar', 'NULL', $char_d, '', '',
2805         'exporttype', 'varchar',     '', $char_d, '', '',
2806         'nodomain',      'char', 'NULL',       1, '', '',
2807         'default_machine','int', 'NULL',      '', '', '',
2808       ],
2809       'primary_key' => 'exportnum',
2810       'unique'      => [],
2811       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2812     },
2813
2814     'part_export_option' => {
2815       'columns' => [
2816         'optionnum', 'serial', '', '', '', '',
2817         'exportnum', 'int', '', '', '', '',
2818         'optionname', 'varchar', '', $char_d, '', '',
2819         'optionvalue', 'text', 'NULL', '', '', '',
2820       ],
2821       'primary_key' => 'optionnum',
2822       'unique'      => [],
2823       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2824     },
2825
2826     'radius_usergroup' => {
2827       'columns' => [
2828         'usergroupnum', 'serial', '', '', '', '',
2829         'svcnum',       'int', '', '', '', '',
2830         'groupname',    'varchar', 'NULL', $char_d, '', '',
2831         'groupnum',     'int', 'NULL', '', '', '',
2832       ],
2833       'primary_key' => 'usergroupnum',
2834       'unique'      => [],
2835       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2836     },
2837
2838     'radius_group' => {
2839       'columns' => [
2840         'groupnum', 'serial', '', '', '', '',
2841         'groupname',    'varchar', '', $char_d, '', '',
2842         'description',  'varchar', 'NULL', $char_d, '', '',
2843         'priority', 'int', '', '', '1', '',
2844         'speed_up', 'int', 'NULL', '', '', '',
2845         'speed_down', 'int', 'NULL', '', '', '',
2846       ],
2847       'primary_key' => 'groupnum',
2848       'unique'      => [ ['groupname'] ],
2849       'index'       => [],
2850     },
2851
2852     'radius_attr' => {
2853       'columns' => [
2854         'attrnum',   'serial', '',      '', '', '',
2855         'groupnum',     'int', '',      '', '', '',
2856         'attrname', 'varchar', '', $char_d, '', '',
2857         'value',    'varchar', '',     255, '', '',
2858         'attrtype',    'char', '',       1, '', '',
2859         'op',          'char', '',       2, '', '',
2860       ],
2861       'primary_key' => 'attrnum',
2862       'unique'      => [],
2863       'index'       => [ ['groupnum'], ],
2864     },
2865
2866     'msgcat' => {
2867       'columns' => [
2868         'msgnum', 'serial', '', '', '', '',
2869         'msgcode', 'varchar', '', 255, '', '',
2870         'locale', 'varchar', '', 16, '', '',
2871         'msg', 'text', '', '', '', '',
2872       ],
2873       'primary_key' => 'msgnum',
2874       'unique'      => [ [ 'msgcode', 'locale' ] ],
2875       'index'       => [],
2876     },
2877
2878     'cust_tax_exempt' => {
2879       'columns' => [
2880         'exemptnum', 'serial', '', '', '', '',
2881         'custnum',   'int', '', '', '', '',
2882         'taxnum',    'int', '', '', '', '',
2883         'year',      'int', '', '', '', '',
2884         'month',     'int', '', '', '', '',
2885         'amount',   @money_type, '', '',
2886       ],
2887       'primary_key' => 'exemptnum',
2888       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2889       'index'       => [],
2890     },
2891
2892     'cust_tax_exempt_pkg' => {
2893       'columns' => [
2894         'exemptpkgnum',  'serial', '', '', '', '',
2895         #'custnum',      'int', '', '', '', ''
2896         'billpkgnum',   'int', '', '', '', '',
2897         'taxnum',       'int', '', '', '', '',
2898         'year',         'int', 'NULL', '', '', '',
2899         'month',        'int', 'NULL', '', '', '',
2900         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2901         'amount',       @money_type, '', '',
2902         # exemption type flags
2903         'exempt_cust',          'char', 'NULL', 1, '', '',
2904         'exempt_setup',         'char', 'NULL', 1, '', '',
2905         'exempt_recur',         'char', 'NULL', 1, '', '',
2906         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
2907         'exempt_monthly',       'char', 'NULL', 1, '', '',
2908       ],
2909       'primary_key' => 'exemptpkgnum',
2910       'unique' => [],
2911       'index'  => [ [ 'taxnum', 'year', 'month' ],
2912                     [ 'billpkgnum' ],
2913                     [ 'taxnum' ],
2914                     [ 'creditbillpkgnum' ],
2915                   ],
2916     },
2917
2918     'cust_tax_exempt_pkg_void' => {
2919       'columns' => [
2920         'exemptpkgnum',  'int', '', '', '', '',
2921         #'custnum',      'int', '', '', '', ''
2922         'billpkgnum',   'int', '', '', '', '',
2923         'taxnum',       'int', '', '', '', '',
2924         'year',         'int', 'NULL', '', '', '',
2925         'month',        'int', 'NULL', '', '', '',
2926         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2927         'amount',       @money_type, '', '',
2928         # exemption type flags
2929         'exempt_cust',          'char', 'NULL', 1, '', '',
2930         'exempt_setup',         'char', 'NULL', 1, '', '',
2931         'exempt_recur',         'char', 'NULL', 1, '', '',
2932         'exempt_cust_taxname',  'char', 'NULL', 1, '', '',
2933         'exempt_monthly',       'char', 'NULL', 1, '', '',
2934       ],
2935       'primary_key' => 'exemptpkgnum',
2936       'unique' => [],
2937       'index'  => [ [ 'taxnum', 'year', 'month' ],
2938                     [ 'billpkgnum' ],
2939                     [ 'taxnum' ],
2940                     [ 'creditbillpkgnum' ],
2941                   ],
2942     },
2943
2944     'router' => {
2945       'columns' => [
2946         'routernum', 'serial', '', '', '', '',
2947         'routername', 'varchar', '', $char_d, '', '',
2948         'svcnum', 'int', 'NULL', '', '', '',
2949         'agentnum',   'int', 'NULL', '', '', '',
2950         'manual_addr', 'char', 'NULL', 1, '', '',
2951       ],
2952       'primary_key' => 'routernum',
2953       'unique'      => [],
2954       'index'       => [],
2955     },
2956
2957     'part_svc_router' => {
2958       'columns' => [
2959         'svcrouternum', 'serial', '', '', '', '',
2960         'svcpart', 'int', '', '', '', '',
2961         'routernum', 'int', '', '', '', '',
2962       ],
2963       'primary_key' => 'svcrouternum',
2964       'unique'      => [],
2965       'index'       => [],
2966     },
2967
2968     'addr_block' => {
2969       'columns' => [
2970         'blocknum', 'serial', '', '', '', '',
2971         'routernum', 'int', '', '', '', '',
2972         'ip_gateway', 'varchar', '', 15, '', '',
2973         'ip_netmask', 'int', '', '', '', '',
2974         'agentnum',   'int', 'NULL', '', '', '',
2975         'manual_flag', 'char', 'NULL', 1, '', '',
2976       ],
2977       'primary_key' => 'blocknum',
2978       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2979       'index'       => [],
2980     },
2981
2982     'svc_broadband' => {
2983       'columns' => [
2984         'svcnum',                  'int',     '',        '', '', '',
2985         'description',         'varchar', 'NULL',   $char_d, '', '',
2986         'routernum',               'int', 'NULL',        '', '', '',
2987         'blocknum',                'int', 'NULL',        '', '', '',
2988         'sectornum',               'int', 'NULL',        '', '', '',
2989         'speed_up',                'int', 'NULL',        '', '', '',
2990         'speed_down',              'int', 'NULL',        '', '', '',
2991         'ip_addr',             'varchar', 'NULL',        15, '', '',
2992         'mac_addr',            'varchar', 'NULL',        12, '', '',
2993         'authkey',             'varchar', 'NULL',        32, '', '',
2994         'latitude',            'decimal', 'NULL',    '10,7', '', '',
2995         'longitude',           'decimal', 'NULL',    '10,7', '', '',
2996         'altitude',            'decimal', 'NULL',        '', '', '',
2997         'vlan_profile',        'varchar', 'NULL',   $char_d, '', '',
2998         'performance_profile', 'varchar', 'NULL',   $char_d, '', '',
2999         'plan_id',             'varchar', 'NULL',   $char_d, '', '',
3000         'radio_serialnum',     'varchar', 'NULL',   $char_d, '', '',
3001         'radio_location',      'varchar', 'NULL', 2*$char_d, '', '',
3002         'poe_location',        'varchar', 'NULL', 2*$char_d, '', '',
3003         'rssi',                    'int', 'NULL',        '', '', '',
3004         'suid',                    'int', 'NULL',        '', '', '',
3005         'shared_svcnum',           'int', 'NULL',        '', '', '',
3006       ],
3007       'primary_key' => 'svcnum',
3008       'unique'      => [ [ 'ip_addr' ], [ 'mac_addr' ] ],
3009       'index'       => [],
3010     },
3011
3012     'tower' => {
3013       'columns' => [
3014         'towernum',   'serial',     '',      '', '', '',
3015         #'agentnum',      'int', 'NULL',      '', '', '',
3016         'towername', 'varchar',     '', $char_d, '', '',
3017         'disabled',     'char', 'NULL',       1, '', '',
3018         'latitude', 'decimal', 'NULL',   '10,7', '', '',
3019         'longitude','decimal', 'NULL',   '10,7', '', '',
3020         'altitude', 'decimal', 'NULL',       '', '', '',
3021         'coord_auto',  'char', 'NULL',        1, '', '',
3022       ],
3023       'primary_key' => 'towernum',
3024       'unique'      => [ [ 'towername' ] ], # , 'agentnum' ] ],
3025       'index'       => [],
3026     },
3027
3028     'tower_sector' => {
3029       'columns' => [
3030         'sectornum',   'serial',     '',      '', '', '',
3031         'towernum',       'int',     '',      '', '', '',
3032         'sectorname', 'varchar',     '', $char_d, '', '',
3033         'ip_addr',    'varchar', 'NULL',      15, '', '',
3034       ],
3035       'primary_key' => 'sectornum',
3036       'unique'      => [ [ 'towernum', 'sectorname' ], [ 'ip_addr' ], ],
3037       'index'       => [ [ 'towernum' ] ],
3038     },
3039
3040     'part_virtual_field' => {
3041       'columns' => [
3042         'vfieldpart', 'serial', '', '', '', '',
3043         'dbtable', 'varchar', '', 32, '', '',
3044         'name', 'varchar', '', 32, '', '',
3045         'length', 'int', 'NULL', '', '', '',
3046         'label', 'varchar', 'NULL', 80, '', '',
3047       ],
3048       'primary_key' => 'vfieldpart',
3049       'unique' => [],
3050       'index' => [],
3051     },
3052
3053     'virtual_field' => {
3054       'columns' => [
3055         'vfieldnum', 'serial', '', '', '', '',
3056         'recnum', 'int', '', '', '', '',
3057         'vfieldpart', 'int', '', '', '', '',
3058         'value', 'varchar', '', 128, '', '',
3059       ],
3060       'primary_key' => 'vfieldnum',
3061       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
3062       'index' => [],
3063     },
3064
3065     'acct_snarf' => {
3066       'columns' => [
3067         'snarfnum',    'serial',     '',      '', '', '',
3068         'snarfname',  'varchar', 'NULL', $char_d, '', '',
3069         'svcnum',         'int',     '',      '', '', '',
3070         'machine',    'varchar',     '',     255, '', '',
3071         'protocol',   'varchar',     '', $char_d, '', '',
3072         'username',   'varchar',     '', $char_d, '', '',
3073         '_password',  'varchar',     '', $char_d, '', '',
3074         'check_freq',     'int', 'NULL',      '', '', '',
3075         'leavemail',     'char', 'NULL',       1, '', '',
3076         'apop',          'char', 'NULL',       1, '', '',
3077         'tls',           'char', 'NULL',       1, '', '',
3078         'mailbox',    'varchar', 'NULL', $char_d, '', '',
3079       ],
3080       'primary_key' => 'snarfnum',
3081       'unique' => [],
3082       'index'  => [ [ 'svcnum' ] ],
3083     },
3084
3085     'svc_external' => {
3086       'columns' => [
3087         'svcnum',     'int',     '',      '', '', '',
3088         'id',      'bigint', 'NULL',      '', '', '',
3089         'title',  'varchar', 'NULL', $char_d, '', '',
3090       ],
3091       'primary_key' => 'svcnum',
3092       'unique'      => [],
3093       'index'       => [],
3094     },
3095
3096     'cust_pay_refund' => {
3097       'columns' => [
3098         'payrefundnum', 'serial', '', '', '', '',
3099         'paynum',  'int', '', '', '', '',
3100         'refundnum',  'int', '', '', '', '',
3101         '_date',    @date_type, '', '',
3102         'amount',   @money_type, '', '',
3103       ],
3104       'primary_key' => 'payrefundnum',
3105       'unique' => [],
3106       'index' => [ ['paynum'], ['refundnum'] ],
3107     },
3108
3109     'part_pkg_option' => {
3110       'columns' => [
3111         'optionnum', 'serial', '', '', '', '',
3112         'pkgpart', 'int', '', '', '', '',
3113         'optionname', 'varchar', '', $char_d, '', '',
3114         'optionvalue', 'text', 'NULL', '', '', '',
3115       ],
3116       'primary_key' => 'optionnum',
3117       'unique'      => [],
3118       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
3119     },
3120
3121     'part_pkg_vendor' => {
3122       'columns' => [
3123         'num', 'serial', '', '', '', '',
3124         'pkgpart', 'int', '', '', '', '',
3125         'exportnum', 'int', '', '', '', '',
3126         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
3127       ],
3128       'primary_key' => 'num',
3129       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
3130       'index'       => [ [ 'pkgpart' ] ],
3131     },
3132
3133     'part_pkg_report_option' => {
3134       'columns' => [
3135         'num',      'serial',   '',      '', '', '',
3136         'name',     'varchar',  '', $char_d, '', '',
3137         'disabled', 'char', 'NULL',       1, '', '',
3138       ],
3139       'primary_key' => 'num',
3140       'unique' => [ [ 'name' ] ],
3141       'index' => [ [ 'disabled' ] ],
3142     },
3143
3144     'part_pkg_usage' => {
3145       'columns' => [
3146         'pkgusagepart', 'serial',   '', '', '', '',
3147         'pkgpart',  'int',      '', '', '', '',
3148         'minutes',  'int',      '', '', '', '',
3149         'priority', 'int',  'NULL', '', '', '',
3150         'shared',   'char', 'NULL',  1, '', '',
3151         'rollover', 'char', 'NULL',  1, '', '',
3152         'description',  'varchar', 'NULL', $char_d, '', '',
3153       ],
3154       'primary_key' => 'pkgusagepart',
3155       'unique'      => [],
3156       'index'       => [ [ 'pkgpart' ] ],
3157     },
3158
3159     'part_pkg_usage_class' => {
3160       'columns' => [
3161         'num',       'serial',  '', '', '', '',
3162         'pkgusagepart', 'int',  '', '', '', '',
3163         'classnum',     'int','NULL', '', '', '',
3164       ],
3165       'primary_key' => 'num',
3166       'unique'      => [ [ 'pkgusagepart', 'classnum' ] ],
3167       'index'       => [],
3168     },
3169
3170     'rate' => {
3171       'columns' => [
3172         'ratenum',  'serial', '', '', '', '',
3173         'ratename', 'varchar', '', $char_d, '', '',
3174       ],
3175       'primary_key' => 'ratenum',
3176       'unique'      => [],
3177       'index'       => [],
3178     },
3179
3180     'rate_detail' => {
3181       'columns' => [
3182         'ratedetailnum',   'serial',  '',     '',      '', '',
3183         'ratenum',         'int',     '',     '',      '', '',
3184         'orig_regionnum',  'int', 'NULL',     '',      '', '',
3185         'dest_regionnum',  'int',     '',     '',      '', '',
3186         'min_included',    'int',     '',     '',      '', '',
3187         'conn_charge',     'decimal', '', '10,4', '0.0000', '',
3188         'conn_sec',        'int',     '',     '',      '0', '',
3189         'min_charge',      'decimal', '', '10,5',       '', '',
3190         'sec_granularity', 'int',     '',     '',       '', '',
3191         'ratetimenum',     'int', 'NULL',     '',       '', '',
3192         'classnum',        'int', 'NULL',     '',       '', '',
3193         'cdrtypenum',      'int', 'NULL',     '',       '', '',
3194         'region_group', 'char', 'NULL',        1,       '', '',
3195       ],
3196       'primary_key' => 'ratedetailnum',
3197       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
3198       'index'       => [ [ 'ratenum', 'dest_regionnum' ],
3199                          [ 'ratenum', 'ratetimenum' ]
3200                        ],
3201     },
3202
3203     'rate_region' => {
3204       'columns' => [
3205         'regionnum',   'serial',      '', '', '', '',
3206         'regionname',  'varchar',     '', $char_d, '', '',
3207         'exact_match', 'char',    'NULL',  1, '', '',
3208       ],
3209       'primary_key' => 'regionnum',
3210       'unique'      => [],
3211       'index'       => [],
3212     },
3213
3214     'rate_prefix' => {
3215       'columns' => [
3216         'prefixnum',   'serial',      '', '', '', '',
3217         'regionnum',   'int',         '', '', '', '',
3218         'countrycode', 'varchar',     '',  3, '', '',
3219         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
3220         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
3221         'latanum',     'int',     'NULL',      '', '', '',
3222         'state',       'char',    'NULL',       2, '', '',
3223         'ocn',         'char',    'NULL',       4, '', '',
3224       ],
3225       'primary_key' => 'prefixnum',
3226       'unique'      => [],
3227       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
3228     },
3229
3230     'rate_time' => {
3231       'columns' => [
3232         'ratetimenum', 'serial',      '',      '', '', '',
3233         'ratetimename',   'varchar',      '', $char_d, '', '',
3234       ],
3235       'primary_key' => 'ratetimenum',
3236       'unique'      => [],
3237       'index'       => [],
3238     },
3239
3240     'rate_time_interval' => {
3241       'columns' => [
3242         'intervalnum', 'serial', '', '', '', '',
3243         'stime',          'int', '', '', '', '',
3244         'etime',          'int', '', '', '', '',
3245         'ratetimenum',    'int', '', '', '', '',
3246       ],
3247       'primary_key' => 'intervalnum',
3248       'unique'      => [],
3249       'index'       => [],
3250     },
3251
3252     #not really part of the above rate_ stuff (used with flat rate rather than
3253     # rated billing), but could be eventually, and its a rate
3254     'rate_tier' => {
3255       'columns' => [
3256         'tiernum',   'serial', '',      '', '', '',
3257         'tiername', 'varchar', '', $char_d, '', '',
3258       ],
3259       'primary_key' => 'tiernum',
3260       'unique'      => [ [ 'tiername'], ],
3261       'index'       => [],
3262     },
3263
3264     'rate_tier_detail' => {
3265       'columns' => [
3266         'tierdetailnum', 'serial', '',     '', '', '',
3267         'tiernum',          'int', '',     '', '', '',
3268         'min_quan',         'int', '',     '', '', '',
3269         'min_charge',   'decimal', '', '10,4', '', '',
3270       ],
3271       'primary_key' => 'tierdetailnum',
3272       'unique'      => [],
3273       'index'       => [ ['tiernum'], ],
3274     },
3275
3276     'usage_class' => {
3277       'columns' => [
3278         'classnum',    'serial',      '',      '', '', '',
3279         'weight',      'int',     'NULL',      '', '', '',
3280         'classname',   'varchar',     '', $char_d, '', '',
3281         'format',      'varchar', 'NULL', $char_d, '', '',
3282         'disabled',    'char',    'NULL',       1, '', '',
3283       ],
3284       'primary_key' => 'classnum',
3285       'unique' => [],
3286       'index' => [ ['disabled'] ],
3287     },
3288
3289     'reg_code' => {
3290       'columns' => [
3291         'codenum',   'serial',    '', '', '', '',
3292         'code',      'varchar',   '', $char_d, '', '',
3293         'agentnum',  'int',       '', '', '', '',
3294       ],
3295       'primary_key' => 'codenum',
3296       'unique'      => [ [ 'agentnum', 'code' ] ],
3297       'index'       => [ [ 'agentnum' ] ],
3298     },
3299
3300     'reg_code_pkg' => {
3301       'columns' => [
3302         'codepkgnum', 'serial', '', '', '', '',
3303         'codenum',   'int',    '', '', '', '',
3304         'pkgpart',   'int',    '', '', '', '',
3305       ],
3306       'primary_key' => 'codepkgnum',
3307       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
3308       'index'       => [ [ 'codenum' ] ],
3309     },
3310
3311     'clientapi_session' => {
3312       'columns' => [
3313         'sessionnum',  'serial',  '', '', '', '',
3314         'sessionid',  'varchar',  '', $char_d, '', '',
3315         'namespace',  'varchar',  '', $char_d, '', '',
3316       ],
3317       'primary_key' => 'sessionnum',
3318       'unique'      => [ [ 'sessionid', 'namespace' ] ],
3319       'index'       => [],
3320     },
3321
3322     'clientapi_session_field' => {
3323       'columns' => [
3324         'fieldnum',    'serial',     '', '', '', '',
3325         'sessionnum',     'int',     '', '', '', '',
3326         'fieldname',  'varchar',     '', $char_d, '', '',
3327         'fieldvalue',    'text', 'NULL', '', '', '',
3328       ],
3329       'primary_key' => 'fieldnum',
3330       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
3331       'index'       => [],
3332     },
3333
3334     'payment_gateway' => {
3335       'columns' => [
3336         'gatewaynum',       'serial',   '',     '', '', '',
3337         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
3338         'gateway_module',   'varchar',  '',     $char_d, '', '',
3339         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
3340         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
3341         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
3342         'gateway_callback_url', 'varchar',  'NULL', 255, '', '',
3343         'gateway_cancel_url',   'varchar',  'NULL', 255, '', '',
3344         'disabled',   'char',  'NULL',   1, '', '',
3345       ],
3346       'primary_key' => 'gatewaynum',
3347       'unique' => [],
3348       'index'  => [ [ 'disabled' ] ],
3349     },
3350
3351     'payment_gateway_option' => {
3352       'columns' => [
3353         'optionnum',   'serial',  '',     '', '', '',
3354         'gatewaynum',  'int',     '',     '', '', '',
3355         'optionname',  'varchar', '',     $char_d, '', '',
3356         'optionvalue', 'text',    'NULL', '', '', '',
3357       ],
3358       'primary_key' => 'optionnum',
3359       'unique'      => [],
3360       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
3361     },
3362
3363     'agent_payment_gateway' => {
3364       'columns' => [
3365         'agentgatewaynum', 'serial', '', '', '', '',
3366         'agentnum',        'int', '', '', '', '',
3367         'gatewaynum',      'int', '', '', '', '',
3368         'cardtype',        'varchar', 'NULL', $char_d, '', '',
3369         'taxclass',        'varchar', 'NULL', $char_d, '', '',
3370       ],
3371       'primary_key' => 'agentgatewaynum',
3372       'unique'      => [],
3373       'index'       => [ [ 'agentnum', 'cardtype' ], ],
3374     },
3375
3376     'banned_pay' => {
3377       'columns' => [
3378         'bannum',  'serial',   '',     '', '', '',
3379         'payby',   'char',     '',       4, '', '',
3380         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
3381         #'paymask', 'varchar',  'NULL', $char_d, '', ''
3382         '_date',            @date_type,         '', '',
3383         'end_date',         @date_type,         '', '',
3384         'otaker',  'varchar',  'NULL',      32, '', '',
3385         'usernum',     'int',  'NULL',      '', '', '',
3386         'bantype', 'varchar',  'NULL', $char_d, '', '',
3387         'reason',  'varchar',  'NULL', $char_d, '', '',
3388       ],
3389       'primary_key' => 'bannum',
3390       'unique'      => [],
3391       'index'       => [ [ 'payby', 'payinfo' ], [ 'usernum' ], ],
3392     },
3393
3394     'pkg_category' => {
3395       'columns' => [
3396         'categorynum',   'serial',  '', '', '', '',
3397         'categoryname',  'varchar', '', $char_d, '', '',
3398         'weight',         'int', 'NULL',  '', '', '',
3399         'condense',      'char', 'NULL',   1, '', '',
3400         'disabled',      'char', 'NULL',   1, '', '',
3401       ],
3402       'primary_key' => 'categorynum',
3403       'unique' => [],
3404       'index' => [ ['disabled'] ],
3405     },
3406
3407     'pkg_class' => {
3408       'columns' => [
3409         'classnum',    'serial',   '',      '', '', '',
3410         'classname',   'varchar',  '', $char_d, '', '',
3411         'categorynum', 'int',  'NULL',      '', '', '',
3412         'disabled',    'char', 'NULL',       1, '', '',
3413         'fcc_ds0s',      'int',     'NULL', '', '', '',
3414       ],
3415       'primary_key' => 'classnum',
3416       'unique' => [],
3417       'index' => [ ['disabled'] ],
3418     },
3419
3420     'cdr' => {
3421       'columns' => [
3422         # qw( name type null length default local );
3423
3424         ###
3425         #asterisk fields
3426         ###
3427
3428         'acctid',   'bigserial',  '', '', '', '',
3429         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
3430         'calldate', 'timestamp',   '',      '', \'now()', '',
3431         'clid',        'varchar',  '', $char_d, \"''", '',
3432         'src',         'varchar',  '', $char_d, \"''", '',
3433         'dst',         'varchar',  '', $char_d, \"''", '',
3434         'dcontext',    'varchar',  '', $char_d, \"''", '',
3435         'channel',     'varchar',  '', $char_d, \"''", '',
3436         'dstchannel',  'varchar',  '', $char_d, \"''", '',
3437         'lastapp',     'varchar',  '', $char_d, \"''", '',
3438         'lastdata',    'varchar',  '',     255, \"''", '',
3439
3440         #currently only opensips
3441         'src_ip_addr', 'varchar',  'NULL',  15,    '', '',
3442         'dst_ip_addr', 'varchar',  'NULL',  15,    '', '',
3443
3444         #these don't seem to be logged by most of the SQL cdr_* modules
3445         #except tds under sql-illegal names, so;
3446         # ... don't rely on them for rating?
3447         # and, what they hey, i went ahead and changed the names and data types
3448         # to freeside-style dates...
3449           #'start',  'timestamp', 'NULL',  '',    '', '',
3450           #'answer', 'timestamp', 'NULL',  '',    '', '',
3451           #'end',    'timestamp', 'NULL',  '',    '', '',
3452         'startdate',  @date_type, '', '',
3453         'answerdate', @date_type, '', '',
3454         'enddate',    @date_type, '', '',
3455         #
3456
3457         'duration',    'int',      '',      '',     0, '',
3458         'billsec',     'int',      '',      '',     0, '',
3459         'disposition', 'varchar',  '',      45, \"''", '',
3460         'amaflags',    'int',      '',      '',     0, '',
3461         'accountcode', 'varchar',  '',      20, \"''", '',
3462         'uniqueid',    'varchar',  '', $char_d, \"''", '',
3463         'userfield',   'varchar',  '',     512, \"''", '',
3464
3465         'max_callers', 'int',  'NULL',      '',    '', '',
3466
3467         ###
3468         # old fields for unitel/RSLCOM/convergent that don't map to asterisk
3469         # ones we adoped moved to "own fields" section below
3470         # charged_party, upstream_price, rated_price, carrierid, cdrtypenum
3471         ###
3472
3473         'upstream_currency',      'char', 'NULL',       3, '', '',
3474         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
3475
3476         # how it was rated internally...
3477         'ratedetailnum',           'int', 'NULL',      '', '', '',
3478
3479         'distance',            'decimal', 'NULL',      '', '', '',
3480         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
3481
3482         #cdr_calltype: the big list in appendix 2
3483         'calltypenum',             'int', 'NULL',      '', '', '',
3484
3485         'description',         'varchar', 'NULL', $char_d, '', '',
3486         'quantity',                'int', 'NULL',      '', '', '',
3487
3488         'upstream_rateid',         'int', 'NULL',      '', '', '',
3489
3490         ###
3491         # more fields, for GSM imports
3492         ###
3493         'servicecode',             'int', 'NULL',      '', '', '',
3494         'quantity_able',           'int', 'NULL',      '', '', '',
3495
3496         ###
3497         #and now for our own fields
3498         ###
3499
3500         'cdrtypenum',              'int', 'NULL',      '', '', '',
3501
3502         'charged_party',       'varchar', 'NULL', $char_d, '', '',
3503         'charged_party_imsi',  'varchar', 'NULL', $char_d, '', '',
3504
3505         'upstream_price',      'decimal', 'NULL',  '10,5', '', '',
3506         'upstream_src_regionname', 'varchar', 'NULL', $char_d, '', '',
3507         'upstream_dst_regionname', 'varchar', 'NULL', $char_d, '', '',
3508
3509         # how it was rated internally...
3510         'rated_pretty_dst',       'varchar', 'NULL', $char_d, '', '',
3511         'rated_regionname',       'varchar', 'NULL', $char_d, '', '',
3512         'rated_price',            'decimal', 'NULL',  '10,4', '', '',
3513         'rated_seconds',              'int', 'NULL',      '', '', '',
3514         'rated_minutes', 'double precision', 'NULL',      '', '', '',
3515         'rated_granularity',          'int', 'NULL',      '', '', '',
3516         'rated_ratedetailnum',        'int', 'NULL',      '', '', '',
3517         'rated_classnum',             'int', 'NULL',      '', '', '',
3518         'rated_ratename',         'varchar', 'NULL', $char_d, '', '',
3519
3520         'carrierid',               'bigint', 'NULL',      '', '', '',
3521
3522         # service it was matched to
3523         'svcnum',             'int',   'NULL',     '',   '', '',
3524
3525         #NULL, done (or something)
3526         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
3527
3528         #NULL, done (or something)
3529         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
3530
3531         #an indexed place to put big numbers
3532         'cdrid',         'bigint',     'NULL',     '',  '', '',
3533
3534         #for taqua accountcode rewriting, for starters
3535         'sessionnum',       'int',    'NULL',      '', '', '',
3536         'subscriber',   'varchar',    'NULL', $char_d, '', '',
3537
3538         #old
3539         'cdrbatch',     'varchar',    'NULL',     255, '', '',
3540         #new
3541         'cdrbatchnum',      'int',    'NULL',      '', '', '',
3542
3543       ],
3544       'primary_key' => 'acctid',
3545       'unique' => [],
3546       'index' => [ [ 'calldate' ],
3547                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
3548                    [ 'lastapp' ],
3549                    ['accountcode'], ['uniqueid'], ['carrierid'], ['cdrid'],
3550                    [ 'sessionnum' ], [ 'subscriber' ],
3551                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
3552                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
3553                    [ 'src_ip_addr' ], [ 'dst_ip_addr' ],
3554                  ],
3555     },
3556
3557     'cdr_batch' => {
3558       'columns' => [
3559         'cdrbatchnum',   'serial',    '',   '', '', '',
3560         'cdrbatch', 'varchar', 'NULL', 255, '', '',
3561         '_date',     @date_type, '', '',
3562       ],
3563       'primary_key' => 'cdrbatchnum',
3564       'unique' => [ [ 'cdrbatch' ] ],
3565       'index' => [],
3566     },
3567
3568     'cdr_termination' => {
3569       'columns' => [
3570         'cdrtermnum', 'bigserial',     '',      '', '', '',
3571         'acctid',        'bigint',     '',      '', '', '',
3572         'termpart',         'int',     '',      '', '', '',#future use see below
3573         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
3574         'rated_seconds',    'int', 'NULL',      '', '', '',
3575         'rated_minutes', 'double precision', 'NULL',   '', '', '',
3576         'status',       'varchar', 'NULL',      32, '', '',
3577         'svcnum',           'int', 'NULL',      '', '', '',
3578       ],
3579       'primary_key' => 'cdrtermnum',
3580       'unique'      => [ [ 'acctid', 'termpart' ] ],
3581       'index'       => [ [ 'acctid' ], [ 'status' ], ],
3582     },
3583
3584     #to handle multiple termination/settlement passes...
3585    # 'part_termination' => {
3586    #   'columns' => [
3587    #     'termpart',       'int', '',      '', '', '',
3588    #     'termname',   'varchar', '', $char_d, '', '',
3589    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
3590    #   ],
3591    #   'primary_key' => 'termpart',
3592    #   'unique' => [],
3593    #   'index'  => [],
3594    # },
3595
3596     #the remaining cdr_ tables are not really used
3597     'cdr_calltype' => {
3598       'columns' => [
3599         'calltypenum',   'serial',  '', '', '', '',
3600         'calltypename',  'varchar', '', $char_d, '', '',
3601       ],
3602       'primary_key' => 'calltypenum',
3603       'unique'      => [],
3604       'index'       => [],
3605     },
3606
3607     'cdr_type' => {
3608       'columns' => [
3609         'cdrtypenum'  => 'serial',  '', '', '', '',
3610         'cdrtypename' => 'varchar', '', $char_d, '', '',
3611       ],
3612       'primary_key' => 'cdrtypenum',
3613       'unique'      => [],
3614       'index'       => [],
3615     },
3616
3617     'cdr_carrier' => {
3618       'columns' => [
3619         'carrierid'   =>  'serial',     '',      '', '', '',
3620         'carriername' => 'varchar',     '', $char_d, '', '',
3621         'disabled'    =>    'char', 'NULL',       1, '', '',
3622       ],
3623       'primary_key' => 'carrierid',
3624       'unique'      => [],
3625       'index'       => [],
3626     },
3627
3628     #'cdr_file' => {
3629     #  'columns' => [
3630     #    'filenum',    'serial',     '', '', '', '',
3631     #    'filename',  'varchar',     '', '', '', '',
3632     #    'status',    'varchar', 'NULL', '', '', '',
3633     #  ],
3634     #  'primary_key' => 'filenum',
3635     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
3636     #                                   # agent-virtualize or have a customer
3637     #                                   # with dup-filename needs or something
3638     #                                   # (only used by cdr.http_and_import for
3639     #                                   #  chrissakes)
3640     #  'index'  => [],
3641     #},
3642
3643     'inventory_item' => {
3644       'columns' => [
3645         'itemnum',   'serial',      '',      '', '', '',
3646         'classnum',  'int',         '',      '', '', '',
3647         'agentnum',  'int',     'NULL',      '', '', '',
3648         'item',      'varchar',     '', $char_d, '', '',
3649         'svcnum',    'int',     'NULL',      '', '', '',
3650         'svc_field', 'varchar', 'NULL', $char_d, '', '',
3651       ],
3652       'primary_key' => 'itemnum',
3653       'unique' => [ [ 'classnum', 'item' ] ],
3654       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
3655     },
3656
3657     'inventory_class' => {
3658       'columns' => [
3659         'classnum',  'serial',       '',      '', '', '',
3660         'classname', 'varchar',      '', $char_d, '', '',
3661       ],
3662       'primary_key' => 'classnum',
3663       'unique' => [],
3664       'index'  => [],
3665     },
3666
3667     'access_user_session' => {
3668       'columns' => [
3669         'sessionnum',   'serial',  '',      '', '', '',
3670         'sessionkey',  'varchar',  '', $char_d, '', '',
3671         'usernum',         'int',  '',      '', '', '',
3672         'start_date', @date_type,               '', '',
3673         'last_date',  @date_type,               '', '',
3674       ],
3675       'primary_key' => 'sessionnum',
3676       'unique' => [ [ 'sessionkey' ] ],
3677       'index'  => [],
3678     },
3679
3680     'access_user' => {
3681       'columns' => [
3682         'usernum',             'serial',     '',      '', '', '',
3683         'username',           'varchar',     '', $char_d, '', '',
3684         '_password',          'varchar', 'NULL', $char_d, '', '',
3685         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
3686         'last',               'varchar', 'NULL', $char_d, '', '',
3687         'first',              'varchar', 'NULL', $char_d, '', '',
3688         'user_custnum',           'int', 'NULL',      '', '', '',
3689         'disabled',              'char', 'NULL',       1, '', '',
3690       ],
3691       'primary_key' => 'usernum',
3692       'unique' => [ [ 'username' ] ],
3693       'index'  => [ [ 'user_custnum' ] ],
3694     },
3695
3696     'access_user_pref' => {
3697       'columns' => [
3698         'prefnum',    'serial',       '', '', '', '',
3699         'usernum',     'int',       '', '', '', '',
3700         'prefname', 'varchar', '', $char_d, '', '',
3701         'prefvalue', 'text', 'NULL', '', '', '',
3702         'expiration', @date_type, '', '',
3703       ],
3704       'primary_key' => 'prefnum',
3705       'unique' => [],
3706       'index'  => [ [ 'usernum' ] ],
3707     },
3708
3709     'access_group' => {
3710       'columns' => [
3711         'groupnum',   'serial', '',      '', '', '',
3712         'groupname', 'varchar', '', $char_d, '', '',
3713       ],
3714       'primary_key' => 'groupnum',
3715       'unique' => [ [ 'groupname' ] ],
3716       'index'  => [],
3717     },
3718
3719     'access_usergroup' => {
3720       'columns' => [
3721         'usergroupnum', 'serial', '', '', '', '',
3722         'usernum',         'int', '', '', '', '',
3723         'groupnum',        'int', '', '', '', '',
3724       ],
3725       'primary_key' => 'usergroupnum',
3726       'unique' => [ [ 'usernum', 'groupnum' ] ],
3727       'index'  => [ [ 'usernum' ] ],
3728     },
3729
3730     'access_groupagent' => {
3731       'columns' => [
3732         'groupagentnum', 'serial', '', '', '', '',
3733         'groupnum',         'int', '', '', '', '',
3734         'agentnum',         'int', '', '', '', '',
3735       ],
3736       'primary_key' => 'groupagentnum',
3737       'unique' => [ [ 'groupnum', 'agentnum' ] ],
3738       'index'  => [ [ 'groupnum' ] ],
3739     },
3740
3741     'access_groupsales' => {
3742       'columns' => [
3743         'groupsalesnum', 'serial', '', '', '', '',
3744         'groupnum',         'int', '', '', '', '',
3745         'salesnum',         'int', '', '', '', '',
3746       ],
3747       'primary_key' => 'groupsalesnum',
3748       'unique' => [ [ 'groupnum', 'salesnum' ] ],
3749       'index'  => [ [ 'groupnum' ] ],
3750     },
3751
3752     'access_right' => {
3753       'columns' => [
3754         'rightnum',   'serial', '',      '', '', '',
3755         'righttype', 'varchar', '', $char_d, '', '',
3756         'rightobjnum',   'int', '',      '', '', '',
3757         'rightname', 'varchar', '', $char_d, '', '',
3758       ],
3759       'primary_key' => 'rightnum',
3760       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
3761       'index'  => [],
3762     },
3763
3764     'svc_phone' => {
3765       'columns' => [
3766         'svcnum',                         'int',     '',      '', '', '',
3767         'countrycode',                'varchar',     '',       3, '', '',
3768         'phonenum',                   'varchar',     '',      25, '', '', #12 ?
3769         'sim_imsi',                   'varchar', 'NULL',      15, '', '',
3770         'pin',                        'varchar', 'NULL', $char_d, '', '',
3771         'sip_password',               'varchar', 'NULL', $char_d, '', '',
3772         'phone_name',                 'varchar', 'NULL', $char_d, '', '',
3773         'pbxsvc',                         'int', 'NULL',      '', '', '',
3774         'domsvc',                         'int', 'NULL',      '', '', '',
3775         'locationnum',                    'int', 'NULL',      '', '', '',
3776         'forwarddst',                 'varchar', 'NULL',      15, '', '',
3777         'email',                      'varchar', 'NULL',     255, '', '',
3778         'lnp_status',                 'varchar', 'NULL', $char_d, '', '',
3779         'portable',                      'char', 'NULL',       1, '', '',
3780         'lrn',                           'char', 'NULL',      10, '', '',
3781         'lnp_desired_due_date',           'int', 'NULL',      '', '', '',
3782         'lnp_due_date',                   'int', 'NULL',      '', '', '',
3783         'lnp_other_provider',         'varchar', 'NULL', $char_d, '', '',
3784         'lnp_other_provider_account', 'varchar', 'NULL', $char_d, '', '',
3785         'lnp_reject_reason',          'varchar', 'NULL', $char_d, '', '',
3786         'sms_carrierid',                  'int', 'NULL',      '', '', '',
3787         'sms_account',                'varchar', 'NULL', $char_d, '', '',
3788         'max_simultaneous',               'int', 'NULL',      '', '', '',
3789       ],
3790       'primary_key' => 'svcnum',
3791       'unique' => [ [ 'sms_carrierid', 'sms_account'] ],
3792       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
3793                     ['locationnum'], ['sms_carrierid'],
3794                   ],
3795     },
3796
3797     'phone_device' => {
3798       'columns' => [
3799         'devicenum', 'serial',     '', '', '', '',
3800         'devicepart',   'int',     '', '', '', '',
3801         'svcnum',       'int',     '', '', '', '',
3802         'mac_addr', 'varchar', 'NULL', 12, '', '',
3803       ],
3804       'primary_key' => 'devicenum',
3805       'unique' => [ [ 'mac_addr' ], ],
3806       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
3807     },
3808
3809     'part_device' => {
3810       'columns' => [
3811         'devicepart', 'serial',  '',      '', '', '',
3812         'devicename', 'varchar', '', $char_d, '', '',
3813         'inventory_classnum', 'int', 'NULL', '', '', '',
3814       ],
3815       'primary_key' => 'devicepart',
3816       'unique' => [ [ 'devicename' ] ], #?
3817       'index'  => [],
3818     },
3819
3820     'phone_avail' => {
3821       'columns' => [
3822         'availnum',    'serial',      '',      '', '', '',
3823         'exportnum',   'int',         '',      '', '', '',
3824         'countrycode', 'varchar',     '',       3, '', '',
3825         'state',       'char',    'NULL',       2, '', '',
3826         'npa',         'char',        '',       3, '', '',
3827         'nxx',         'char',    'NULL',       3, '', '',
3828         'station',     'char',    'NULL',       4, '', '',
3829         'name',        'varchar', 'NULL', $char_d, '', '',
3830         'rate_center_abbrev', 'varchar', 'NULL', $char_d, '', '',
3831         'latanum',      'int',     'NULL',      '', '', '',
3832         'msanum',       'int', 'NULL', '', '', '',
3833         'ordernum',      'int',     'NULL',      '', '', '',
3834         'svcnum',      'int',     'NULL',      '', '', '',
3835         'availbatch', 'varchar',  'NULL', $char_d, '', '',
3836       ],
3837       'primary_key' => 'availnum',
3838       'unique' => [],
3839       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
3840                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
3841                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
3842                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
3843                     [ 'svcnum' ],
3844                     [ 'availbatch' ],
3845                     [ 'latanum' ],
3846                   ],
3847     },
3848
3849     'lata' => {
3850       'columns' => [
3851         'latanum',    'int',      '',      '', '', '',
3852         'description',   'varchar',    '',      $char_d, '', '',
3853         'have_usage',   'int',    'NULL',      '', '', '',
3854       ],
3855       'primary_key' => 'latanum',
3856       'unique' => [],
3857       'index'  => [],
3858     },
3859
3860     'msa' => {
3861       'columns' => [
3862         'msanum',    'int',      '',      '', '', '',
3863         'description',   'varchar',    '',      $char_d, '', '',
3864       ],
3865       'primary_key' => 'msanum',
3866       'unique' => [],
3867       'index'  => [],
3868     },
3869
3870     'rate_center' => {
3871       'columns' => [
3872         'ratecenternum',    'serial',      '',      '', '', '',
3873         'description',   'varchar',    '',      $char_d, '', '',
3874       ],
3875       'primary_key' => 'ratecenternum',
3876       'unique' => [],
3877       'index'  => [],
3878     },
3879
3880     'did_vendor' => {
3881       'columns' => [
3882         'vendornum',    'serial',      '',      '', '', '',
3883         'vendorname',   'varchar',        '',     $char_d, '', '',
3884       ],
3885       'primary_key' => 'vendornum',
3886       'unique' => [],
3887       'index'  => [],
3888     },
3889
3890     'did_order_item' => {
3891       'columns' => [
3892         'orderitemnum',    'serial',      '',      '', '', '',
3893         'ordernum',    'int',      '',      '', '', '',
3894         'msanum',      'int',     'NULL',      '', '', '',
3895         'npa',      'int',     'NULL',      '', '', '',
3896         'latanum',      'int',     'NULL',      '', '', '',
3897         'ratecenternum',      'int',     'NULL',      '', '', '',
3898         'state',       'char',    'NULL',       2, '', '',
3899         'quantity',      'int',     '',      '', '', '',
3900         'custnum',   'int', 'NULL', '', '', '',
3901       ],
3902       'primary_key' => 'orderitemnum',
3903       'unique' => [],
3904       'index'  => [],
3905     },
3906
3907     'did_order' => {
3908       'columns' => [
3909         'ordernum',    'serial',      '',      '', '', '',
3910         'vendornum',   'int',       '',      '', '', '',
3911         'vendor_order_id',   'varchar',  'NULL',   $char_d, '', '',
3912         'custnum',   'int', 'NULL', '', '', '',
3913         'submitted',      'int',     '',      '', '', '',
3914         'confirmed',      'int',     'NULL',      '', '', '',
3915         'received',      'int',     'NULL',      '', '', '',
3916       ],
3917       'primary_key' => 'ordernum',
3918       'unique' => [ [ 'vendornum', 'vendor_order_id' ] ],
3919       'index'  => [],
3920     },
3921
3922     'reason_type' => {
3923       'columns' => [
3924         'typenum',   'serial',  '', '', '', '',
3925         'class',     'char', '', 1, '', '',
3926         'type',     'varchar', '', $char_d, '', '',
3927       ],
3928       'primary_key' => 'typenum',
3929       'unique' => [],
3930       'index' => [],
3931     },
3932
3933     'reason' => {
3934       'columns' => [
3935         'reasonnum',     'serial',  '', '', '', '',
3936         'reason_type',   'int',  '', '', '', '',
3937         'reason',        'text', '', '', '', '',
3938         'disabled',      'char',    'NULL', 1, '', '',
3939         'unsuspend_pkgpart', 'int',  'NULL', '', '', '',
3940         'unsuspend_hold','char',    'NULL', 1, '', '',
3941       ],
3942       'primary_key' => 'reasonnum',
3943       'unique' => [],
3944       'index' => [],
3945     },
3946
3947     'conf' => {
3948       'columns' => [
3949         'confnum',  'serial',     '',      '', '', '',
3950         'agentnum', 'int',    'NULL',      '', '', '',
3951         'locale',   'varchar','NULL',      16, '', '',
3952         'name',     'varchar',    '', $char_d, '', '',
3953         'value',    'text',   'NULL',      '', '', '',
3954       ],
3955       'primary_key' => 'confnum',
3956       'unique' => [ [ 'agentnum', 'locale', 'name' ] ],
3957       'index' => [],
3958     },
3959
3960     'pkg_referral' => {
3961       'columns' => [
3962         'pkgrefnum',     'serial', '', '', '', '',
3963         'pkgnum',        'int',    '', '', '', '',
3964         'refnum',        'int',    '', '', '', '',
3965       ],
3966       'primary_key' => 'pkgrefnum',
3967       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
3968       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
3969     },
3970
3971     'svc_pbx' => {
3972       'columns' => [
3973         'svcnum',           'int',     '',      '', '', '',
3974         'id',               'int', 'NULL',      '', '', '',
3975         'title',        'varchar', 'NULL', $char_d, '', '',
3976         'max_extensions',   'int', 'NULL',      '', '', '',
3977         'max_simultaneous', 'int', 'NULL',      '', '', '',
3978       ],
3979       'primary_key' => 'svcnum',
3980       'unique' => [],
3981       'index'  => [ [ 'id' ] ],
3982     },
3983
3984     'svc_mailinglist' => { #svc_group?
3985       'columns' => [
3986         'svcnum',            'int',     '',            '', '', '',
3987         'username',      'varchar',     '', $username_len, '', '',
3988         'domsvc',            'int',     '',            '', '', '',
3989         'listnum',           'int',     '',            '', '', '',
3990         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
3991         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
3992         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
3993         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
3994       ],
3995       'primary_key' => 'svcnum',
3996       'unique' => [],
3997       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
3998     },
3999
4000     'mailinglist' => {
4001       'columns' => [
4002         'listnum',   'serial', '',      '', '', '',
4003         'listname', 'varchar', '', $char_d, '', '',
4004       ],
4005       'primary_key' => 'listnum',
4006       'unique' => [],
4007       'index'  => [],
4008     },
4009
4010     'mailinglistmember' => {
4011       'columns' => [
4012         'membernum',        'serial',     '',   '', '', '',
4013         'listnum',             'int',     '',   '', '', '',
4014         'svcnum',              'int', 'NULL',   '', '', '',
4015         'contactemailnum',     'int', 'NULL',   '', '', '',
4016         'email',           'varchar', 'NULL',  255, '', '',
4017       ],
4018       'primary_key' => 'membernum',
4019       'unique'      => [],
4020       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
4021     },
4022
4023     'bill_batch' => {
4024       'columns' => [
4025         'batchnum',         'serial',     '',  '', '', '',
4026         'agentnum',            'int', 'NULL',  '', '', '',
4027         'status',             'char', 'NULL', '1', '', '',
4028         'pdf',                'blob', 'NULL',  '', '', '',
4029       ],
4030       'primary_key' => 'batchnum',
4031       'unique'      => [],
4032       'index'       => [ ['agentnum'] ],
4033     },
4034
4035     'cust_bill_batch' => {
4036       'columns' => [
4037         'billbatchnum',     'serial',     '', '', '', '',
4038         'batchnum',            'int',     '', '', '', '',
4039         'invnum',              'int',     '', '', '', '',
4040       ],
4041       'primary_key' => 'billbatchnum',
4042       'unique'      => [],
4043       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
4044     },
4045
4046     'cust_bill_batch_option' => {
4047       'columns' => [
4048         'optionnum', 'serial', '', '', '', '',
4049         'billbatchnum', 'int', '', '', '', '',
4050         'optionname', 'varchar', '', $char_d, '', '',
4051         'optionvalue', 'text', 'NULL', '', '', '',
4052       ],
4053       'primary_key' => 'optionnum',
4054       'unique'      => [],
4055       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
4056     },
4057
4058     'msg_template' => {
4059       'columns' => [
4060         'msgnum',     'serial',     '',      '', '', '',
4061         'msgname',   'varchar',     '', $char_d, '', '',
4062         'agentnum',      'int', 'NULL',      '', '', '',
4063         'subject',   'varchar', 'NULL',     512, '', '',
4064         'mime_type', 'varchar',     '', $char_d, '', '',
4065         'body',         'blob', 'NULL',      '', '', '',
4066         'disabled',     'char', 'NULL',       1, '', '',
4067         'from_addr', 'varchar', 'NULL',     255, '', '',
4068         'bcc_addr',  'varchar', 'NULL',     255, '', '',
4069       ],
4070       'primary_key' => 'msgnum',
4071       'unique'      => [ ],
4072       'index'       => [ ['agentnum'], ],
4073     },
4074
4075     'template_content' => {
4076       'columns' => [
4077         'contentnum', 'serial',     '',      '', '', '',
4078         'msgnum',        'int',     '',      '', '', '',
4079         'locale',    'varchar', 'NULL',      16, '', '',
4080         'subject',   'varchar', 'NULL',     512, '', '',
4081         'body',         'text', 'NULL',      '', '', '',
4082       ],
4083       'primary_key' => 'contentnum',
4084       'unique'      => [ ['msgnum', 'locale'] ],
4085       'index'       => [ ],
4086     },
4087
4088     'cust_msg' => {
4089       'columns' => [
4090         'custmsgnum', 'serial',     '',     '', '', '',
4091         'custnum',       'int',     '',     '', '', '',
4092         'msgnum',        'int', 'NULL',     '', '', '',
4093         '_date',    @date_type,                 '', '',
4094         'env_from',  'varchar', 'NULL',    255, '', '',
4095         'env_to',    'varchar', 'NULL',    255, '', '',
4096         'header',       'blob', 'NULL',     '', '', '',
4097         'body',         'blob', 'NULL',     '', '', '',
4098         'error',     'varchar', 'NULL',    255, '', '',
4099         'status',    'varchar',     '',$char_d, '', '',
4100       ],
4101       'primary_key' => 'custmsgnum',
4102       'unique'      => [ ],
4103       'index'       => [ ['custnum'], ],
4104     },
4105
4106     'svc_cert' => {
4107       'columns' => [
4108         'svcnum',                'int',     '',      '', '', '',
4109         'recnum',                'int', 'NULL',      '', '', '',
4110         'privatekey',           'text', 'NULL',      '', '', '',
4111         'csr',                  'text', 'NULL',      '', '', '',
4112         'certificate',          'text', 'NULL',      '', '', '',
4113         'cacert',               'text', 'NULL',      '', '', '',
4114         'common_name',       'varchar', 'NULL', $char_d, '', '',
4115         'organization',      'varchar', 'NULL', $char_d, '', '',
4116         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
4117         'city',              'varchar', 'NULL', $char_d, '', '',
4118         'state',             'varchar', 'NULL', $char_d, '', '',
4119         'country',              'char', 'NULL',       2, '', '',
4120         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
4121       ],
4122       'primary_key' => 'svcnum',
4123       'unique' => [],
4124       'index'  => [], #recnum
4125     },
4126
4127     'svc_port' => {
4128       'columns' => [
4129         'svcnum',                'int',     '',      '', '', '',
4130         'serviceid', 'varchar', '', 64, '', '', #srvexport / reportfields
4131       ],
4132       'primary_key' => 'svcnum',
4133       'unique' => [],
4134       'index'  => [], #recnum
4135     },
4136
4137     'areacode'  => {
4138       'columns' => [
4139         'areanum',   'serial',        '',      '', '', '',
4140         'code',        'char',        '',       3, '', '',
4141         'country',     'char',    'NULL',       2, '', '',
4142         'state',       'char',    'NULL',       2, '', '',
4143         'description','varchar',  'NULL',     255, '', '',
4144       ],
4145       'primary_key' => 'areanum',
4146       'unique' => [ [ 'areanum' ] ],
4147       'index'  => [],
4148     },
4149
4150     'upgrade_journal' => {
4151       'columns' => [
4152         'upgradenum', 'serial', '', '', '', '',
4153         '_date', 'int', '', '', '', '',
4154         'upgrade', 'varchar', '', $char_d, '', '',
4155         'status', 'varchar', '', $char_d, '', '',
4156         'statustext', 'varchar', 'NULL', $char_d, '', '',
4157       ],
4158       'primary_key' => 'upgradenum',
4159       'unique' => [ [ 'upgradenum' ] ],
4160       'index' => [ [ 'upgrade' ] ],
4161     },
4162
4163     'upload_target' => {
4164       'columns' => [
4165         'targetnum', 'serial', '', '', '', '',
4166         'agentnum', 'int', 'NULL', '', '', '',
4167         'protocol', 'varchar', '', 10, '', '',
4168         'hostname', 'varchar', '', $char_d, '', '',
4169         'port', 'int', 'NULL', '', '', '',
4170         'username', 'varchar', '', $char_d, '', '',
4171         'password', 'varchar', 'NULL', $char_d, '', '',
4172         'path', 'varchar', 'NULL', $char_d, '', '',
4173         'subject', 'varchar', 'NULL', '255', '', '',
4174         'handling', 'varchar', 'NULL', $char_d, '', '',
4175       ],
4176       'primary_key' => 'targetnum',
4177       'unique' => [ [ 'targetnum' ] ],
4178       'index' => [],
4179     },
4180
4181     'log' => {
4182       'columns' => [
4183         'lognum',     'serial', '', '', '', '',
4184         '_date',      'int', '', '', '', '',
4185         'agentnum',   'int', 'NULL', '', '', '',
4186         'tablename',  'varchar', 'NULL', $char_d, '', '',
4187         'tablenum',   'int',  'NULL', '', '', '',
4188         'level',      'int',  '', '', '', '',
4189         'message',    'text', '', '', '', '',
4190       ],
4191       'primary_key' => 'lognum',
4192       'unique'      => [],
4193       'index'       => [ ['_date'], ['level'] ],
4194     },
4195
4196     'log_context' => {
4197       'columns' => [
4198         'logcontextnum', 'serial', '', '', '', '',
4199         'lognum', 'int', '', '', '', '',
4200         'context', 'varchar', '', 32, '', '',
4201       ],
4202       'primary_key' => 'logcontextnum',
4203       'unique' => [ [ 'lognum', 'context' ] ],
4204       'index' => [],
4205     },
4206
4207     'svc_cable' => {
4208       'columns' => [
4209         'svcnum',         'int',     '',      '', '', '',
4210         #nothing so far...  there should be _something_ uniquely identifying
4211         # each subscriber besides the device info...?
4212       ],
4213       'primary_key' => 'svcnum',
4214       'unique' => [],
4215       'index'  => [],
4216     },
4217
4218     'cable_device' => {
4219       'columns' => [
4220         'devicenum', 'serial',     '',      '', '', '',
4221         'devicepart',   'int',     '',      '', '', '',
4222         'svcnum',       'int',     '',      '', '', '',
4223         'mac_addr', 'varchar', 'NULL',      12, '', '',
4224         'serial',   'varchar', 'NULL', $char_d, '', '',
4225       ],
4226       'primary_key' => 'devicenum',
4227       'unique' => [ [ 'mac_addr' ], ],
4228       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
4229     },
4230
4231     %{ tables_hashref_torrus() },
4232
4233     # tables of ours for doing torrus virtual port combining
4234     'torrus_srvderive' => {
4235       'columns' => [
4236         'derivenum',     'serial',     '', '', '', '',
4237         'serviceid',    'varchar',     '', 64, '', '', #srvexport / reportfields
4238         'last_srv_date',   'date', 'NULL', '', '', '',
4239       ],
4240       'primary_key' => 'derivenum',
4241       'unique' => [ ['serviceid'] ],
4242       'index'  => [],
4243     },
4244
4245     'torrus_srvderive_component' => {
4246       'columns' => [
4247         'componentnum', 'serial', '', '', '', '',
4248         'derivenum',       'int', '', '', '', '',
4249         'serviceid',   'varchar', '', 64, '', '', #srvexport / reportfields
4250       ],
4251       'primary_key' => 'componentnum',
4252       'unique'      => [ [ 'derivenum', 'serviceid' ], ],
4253       'index'       => [ [ 'derivenum', ], ],
4254     },
4255
4256
4257     # name type nullability length default local
4258
4259     #'new_table' => {
4260     #  'columns' => [
4261     #    'num', 'serial',       '', '', '', '',
4262     #  ],
4263     #  'primary_key' => 'num',
4264     #  'unique' => [],
4265     #  'index'  => [],
4266     #},
4267
4268   };
4269
4270 }
4271
4272 =back
4273
4274 =head1 BUGS
4275
4276 =head1 SEE ALSO
4277
4278 L<DBIx::DBSchema>
4279
4280 =cut
4281
4282 1;
4283