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