FS/FS/Schema.pm

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