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