FS/FS/Schema.pm

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