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