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