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'], ['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         'regionname', 'varchar', 'NULL', $char_d, '', '',
 695         'detail',  'varchar', '', 255, '', '',
 696       ],
 697       'primary_key' => 'detailnum',
 698       'unique' => [],
 699       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 700     },
 701
 702     'cust_bill_pkg_display' => {
 703       'columns' => [
 704         'billpkgdisplaynum', 'serial', '', '', '', '',
 705         'billpkgnum', 'int', '', '', '', '',
 706         'section',  'varchar', 'NULL', $char_d, '', '',
 707         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 708         #'unitrecur', @money_typen, '', '',     #this too?
 709         'post_total', 'char', 'NULL', 1, '', '',
 710         'type',       'char', 'NULL', 1, '', '',
 711         'summary',    'char', 'NULL', 1, '', '',
 712       ],
 713       'primary_key' => 'billpkgdisplaynum',
 714       'unique' => [],
 715       'index' => [ ['billpkgnum'], ],
 716     },
 717
 718     'cust_bill_pkg_tax_location' => {
 719       'columns' => [
 720         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 721         'billpkgnum',               'int',      '', '', '', '',
 722         'taxnum',                   'int',      '', '', '', '',
 723         'taxtype',              'varchar',      '', $char_d, '', '',
 724         'pkgnum',                   'int',      '', '', '', '',
 725         'locationnum',              'int',      '', '', '', '', #redundant?
 726         'amount',                   @money_type,        '', '',
 727       ],
 728       'primary_key' => 'billpkgtaxlocationnum',
 729       'unique' => [],
 730       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 731     },
 732
 733     'cust_bill_pkg_tax_rate_location' => {
 734       'columns' => [
 735         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 736         'billpkgnum',                   'int',      '', '', '', '',
 737         'taxnum',                       'int',      '', '', '', '',
 738         'taxtype',                  'varchar',      '', $char_d, '', '',
 739         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 740         'taxratelocationnum',           'int',      '', '', '', '',
 741         'amount',                       @money_type,        '', '',
 742       ],
 743       'primary_key' => 'billpkgtaxratelocationnum',
 744       'unique' => [],
 745       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 746     },
 747
 748     'cust_credit' => {
 749       'columns' => [
 750         'crednum',  'serial', '', '', '', '',
 751         'custnum',  'int', '', '', '', '',
 752         '_date',    @date_type, '', '',
 753         'amount',   @money_type, '', '',
 754         'otaker',   'varchar', 'NULL', 32, '', '',
 755         'usernum',   'int', 'NULL', '', '', '',
 756         'reason',   'text', 'NULL', '', '', '',
 757         'reasonnum', 'int', 'NULL', '', '', '',
 758         'addlinfo', 'text', 'NULL', '', '', '',
 759         'closed',    'char', 'NULL', 1, '', '',
 760         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 761         'eventnum', 'int', 'NULL', '', '', '', #triggering event for commission
 762       ],
 763       'primary_key' => 'crednum',
 764       'unique' => [],
 765       'index' => [ ['custnum'], ['_date'], ['usernum'], ['eventnum'] ],
 766     },
 767
 768     'cust_credit_bill' => {
 769       'columns' => [
 770         'creditbillnum', 'serial', '', '', '', '',
 771         'crednum',  'int', '', '', '', '',
 772         'invnum',  'int', '', '', '', '',
 773         '_date',    @date_type, '', '',
 774         'amount',   @money_type, '', '',
 775         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
 776       ],
 777       'primary_key' => 'creditbillnum',
 778       'unique' => [],
 779       'index' => [ ['crednum'], ['invnum'] ],
 780     },
 781
 782     'cust_credit_bill_pkg' => {
 783       'columns' => [
 784         'creditbillpkgnum', 'serial', '',      '', '', '',
 785         'creditbillnum',       'int', '',      '', '', '',
 786         'billpkgnum',          'int', '',      '', '', '',
 787         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
 788         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
 789         'amount',            @money_type,          '', '',
 790         'setuprecur',      'varchar', '', $char_d, '', '',
 791         'sdate',   @date_type, '', '',
 792         'edate',   @date_type, '', '',
 793       ],
 794       'primary_key' => 'creditbillpkgnum',
 795       'unique'      => [],
 796       'index'       => [ [ 'creditbillnum' ],
 797                          [ 'billpkgnum' ],
 798                          [ 'billpkgtaxlocationnum' ],
 799                          [ 'billpkgtaxratelocationnum' ],
 800                        ],
 801     },
 802
 803     'cust_main' => {
 804       'columns' => [
 805         'custnum',  'serial',  '',     '', '', '',
 806         'agentnum', 'int',  '',     '', '', '',
 807         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 808         'classnum', 'int', 'NULL', '', '', '',
 809         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 810 #        'titlenum', 'int',  'NULL',   '', '', '',
 811         'last',     'varchar', '',     $char_d, '', '',
 812 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 813         'first',    'varchar', '',     $char_d, '', '',
 814         'ss',       'varchar', 'NULL', 11, '', '',
 815         'stateid', 'varchar', 'NULL', $char_d, '', '',
 816         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 817         'birthdate' ,@date_type, '', '',
 818         'signupdate',@date_type, '', '',
 819         'dundate',   @date_type, '', '',
 820         'company',  'varchar', 'NULL', $char_d, '', '',
 821         'address1', 'varchar', '',     $char_d, '', '',
 822         'address2', 'varchar', 'NULL', $char_d, '', '',
 823         'city',     'varchar', '',     $char_d, '', '',
 824         'county',   'varchar', 'NULL', $char_d, '', '',
 825         'state',    'varchar', 'NULL', $char_d, '', '',
 826         'zip',      'varchar', 'NULL', 10, '', '',
 827         'country',  'char', '',     2, '', '',
 828         'daytime',  'varchar', 'NULL', 20, '', '',
 829         'night',    'varchar', 'NULL', 20, '', '',
 830         'fax',      'varchar', 'NULL', 12, '', '',
 831         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 832 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 833         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 834         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 835         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 836         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 837         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 838         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 839         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 840         'ship_zip',      'varchar', 'NULL', 10, '', '',
 841         'ship_country',  'char', 'NULL', 2, '', '',
 842         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 843         'ship_night',    'varchar', 'NULL', 20, '', '',
 844         'ship_fax',      'varchar', 'NULL', 12, '', '',
 845         'payby',    'char', '',     4, '', '',
 846         'payinfo',  'varchar', 'NULL', 512, '', '',
 847         'paycvv',   'varchar', 'NULL', 512, '', '',
 848         'paymask', 'varchar', 'NULL', $char_d, '', '',
 849         #'paydate',  @date_type, '', '',
 850         'paydate',  'varchar', 'NULL', 10, '', '',
 851         'paystart_month', 'int', 'NULL', '', '', '',
 852         'paystart_year',  'int', 'NULL', '', '', '',
 853         'payissue', 'varchar', 'NULL', 2, '', '',
 854         'payname',  'varchar', 'NULL', $char_d, '', '',
 855         'paystate', 'varchar', 'NULL', $char_d, '', '',
 856         'paytype',  'varchar', 'NULL', $char_d, '', '',
 857         'payip',    'varchar', 'NULL', 15, '', '',
 858         'geocode',  'varchar', 'NULL', 20,  '', '',
 859         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
 860         'tax',      'char', 'NULL', 1, '', '',
 861         'otaker',   'varchar', 'NULL',    32, '', '',
 862         'usernum',   'int', 'NULL', '', '', '',
 863         'refnum',   'int',  '',     '', '', '',
 864         'referral_custnum', 'int',  'NULL', '', '', '',
 865         'comments', 'text', 'NULL', '', '', '',
 866         'spool_cdr','char', 'NULL', 1, '', '',
 867         'squelch_cdr','char', 'NULL', 1, '', '',
 868         'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
 869         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 870         'credit_limit', @money_typen, '', '',
 871         'archived', 'char', 'NULL', 1, '', '',
 872         'email_csv_cdr', 'char', 'NULL', 1, '', '',
 873       ],
 874       'primary_key' => 'custnum',
 875       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 876       #'index' => [ ['last'], ['company'] ],
 877       'index' => [
 878                    [ 'agentnum' ], [ 'refnum' ], [ 'classnum' ], [ 'usernum' ],
 879                    [ 'custbatch' ],
 880                    [ 'referral_custnum' ],
 881                    [ 'payby' ], [ 'paydate' ],
 882                    [ 'archived' ],
 883                    #billing
 884                    [ 'last' ], [ 'company' ],
 885                    [ 'county' ], [ 'state' ], [ 'country' ],
 886                    [ 'zip' ],
 887                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 888                    #shipping
 889                    [ 'ship_last' ], [ 'ship_company' ],
 890                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 891                    [ 'ship_zip' ],
 892                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 893                  ],
 894     },
 895
 896     'cust_recon' => {  # what purpose does this serve?
 897       'columns' => [
 898         'reconid',      'serial',  '',          '', '', '',
 899         'recondate',    @date_type,                 '', '',
 900         'custnum',      'int'   ,  '',          '', '', '',
 901         'agentnum',     'int',     '',          '', '', '',
 902         'last',         'varchar', '',     $char_d, '', '',
 903         'first',        'varchar', '',     $char_d, '', '',
 904         'address1',     'varchar', '',     $char_d, '', '',
 905         'address2',     'varchar', 'NULL', $char_d, '', '',
 906         'city',         'varchar', '',     $char_d, '', '',
 907         'state',        'varchar', 'NULL', $char_d, '', '',
 908         'zip',          'varchar', 'NULL',      10, '', '',
 909         'pkg',          'varchar', 'NULL', $char_d, '', '',
 910         'adjourn',      @date_type,                 '', '',
 911         'status',       'varchar', 'NULL',      10, '', '',
 912         'agent_custid', 'varchar',  '',    $char_d, '', '',
 913         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 914         'agent_adjourn', @date_type,                '', '',
 915         'comments',     'text',    'NULL',      '', '', '',
 916       ],
 917       'primary_key' => 'reconid',
 918       'unique' => [],
 919       'index' => [],
 920     },
 921
 922     #eventually for cust_main too
 923     'contact' => {
 924       'columns' => [
 925         'contactnum', 'serial',     '',      '', '', '',
 926         'prospectnum',   'int', 'NULL',      '', '', '',
 927         'custnum',       'int', 'NULL',      '', '', '',
 928         'locationnum',   'int', 'NULL',      '', '', '', #not yet
 929 #        'titlenum',      'int', 'NULL',      '', '', '', #eg Mr. Mrs. Dr. Rev.
 930         'last',      'varchar',     '', $char_d, '', '',
 931 #        'middle',    'varchar', 'NULL', $char_d, '', '',
 932         'first',     'varchar',     '', $char_d, '', '',
 933         'title',     'varchar', 'NULL', $char_d, '', '', #eg Head Bottle Washer
 934         'comment',   'varchar', 'NULL', $char_d, '', '',
 935         'disabled',     'char', 'NULL',       1, '', '',
 936       ],
 937       'primary_key' => 'contactnum',
 938       'unique'      => [],
 939       'index'       => [ [ 'prospectnum' ], [ 'custnum' ], [ 'locationnum' ],
 940                          [ 'last' ], [ 'first' ],
 941                        ],
 942     },
 943
 944     'contact_phone' => {
 945       'columns' => [
 946         'contactphonenum', 'serial',     '', '', '', '',
 947         'contactnum',         'int',     '', '', '', '',
 948         'phonetypenum',       'int',     '', '', '', '',
 949         'countrycode',    'varchar',     '',  3, '', '',
 950         'phonenum',       'varchar',     '', 14, '', '',
 951         'extension',      'varchar', 'NULL',  7, '', '',
 952         #?#'comment',        'varchar',     '', $char_d, '', '',
 953       ],
 954       'primary_key' => 'contactphonenum',
 955       'unique'      => [],
 956       'index'       => [],
 957     },
 958
 959     'phone_type' => {
 960       'columns' => [
 961         'phonetypenum',  'serial', '',      '', '', '',
 962         'typename',     'varchar', '', $char_d, '', '',
 963         'weight',           'int', '',      '', '', '',
 964       ],
 965       'primary_key' => 'phonetypenum',
 966       'unique'      => [ [ 'typename' ], ],
 967       'index'       => [],
 968     },
 969
 970     'contact_email' => {
 971       'columns' => [
 972         'contactemailnum', 'serial', '',      '', '', '',
 973         'contactnum',         'int', '',      '', '', '',
 974         'emailaddress',   'varchar', '', $char_d, '', '',
 975       ],
 976       'primary_key' => 'contactemailnum',
 977       'unique'      => [ [ 'emailaddress' ], ],
 978       'index'       => [],
 979     },
 980
 981     'prospect_main' => {
 982       'columns' => [
 983         'prospectnum',  'serial',     '',      '', '', '',
 984         'agentnum',        'int',     '',      '', '', '',
 985         'company',     'varchar',     '', $char_d, '', '',
 986         #'disabled',     'char', 'NULL',       1, '', '',
 987       ],
 988       'primary_key' => 'prospectnum',
 989       'unique'      => [],
 990       'index'       => [ [ 'company' ], [ 'agentnum' ], ],
 991     },
 992
 993     #eventually use for billing & ship from cust_main too
 994     #for now, just cust_pkg locations
 995     'cust_location' => { #'location' now that its prospects too, but...
 996       'columns' => [
 997         'locationnum',  'serial',     '',      '', '', '',
 998         'prospectnum',     'int', 'NULL',      '', '', '',
 999         'custnum',         'int', 'NULL',      '', '', '',
1000         'address1',    'varchar',     '', $char_d, '', '',
1001         'address2',    'varchar', 'NULL', $char_d, '', '',
1002         'city',        'varchar',     '', $char_d, '', '',
1003         'county',      'varchar', 'NULL', $char_d, '', '',
1004         'state',       'varchar', 'NULL', $char_d, '', '',
1005         'zip',         'varchar', 'NULL',      10, '', '',
1006         'country',        'char',     '',       2, '', '',
1007         'geocode',     'varchar', 'NULL',      20, '', '',
1008         'location_type',     'varchar', 'NULL',      20, '', '',
1009         'location_number',     'varchar', 'NULL',      20, '', '',
1010         'location_kind',     'char', 'NULL',      1, '', '',
1011         'disabled',      'char', 'NULL',   1, '', '',
1012       ],
1013       'primary_key' => 'locationnum',
1014       'unique'      => [],
1015       'index'       => [ [ 'prospectnum' ], [ 'custnum' ],
1016                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
1017                        ],
1018     },
1019
1020     'cust_main_invoice' => {
1021       'columns' => [
1022         'destnum',  'serial',  '',     '', '', '',
1023         'custnum',  'int',  '',     '', '', '',
1024         'dest',     'varchar', '',  $char_d, '', '',
1025       ],
1026       'primary_key' => 'destnum',
1027       'unique' => [],
1028       'index' => [ ['custnum'], ],
1029     },
1030
1031     'cust_main_note' => {
1032       'columns' => [
1033         'notenum',  'serial',  '',     '', '', '',
1034         'custnum',  'int',  '',     '', '', '',
1035         'classnum',      'int',     'NULL', '', '', '',
1036         '_date',    @date_type, '', '',
1037         'otaker',   'varchar', 'NULL',    32, '', '',
1038         'usernum',   'int', 'NULL', '', '', '',
1039         'comments', 'text', 'NULL', '', '', '',
1040       ],
1041       'primary_key' => 'notenum',
1042       'unique' => [],
1043       'index' => [ [ 'custnum' ], [ '_date' ], [ 'usernum' ], ],
1044     },
1045
1046     'cust_note_class' => {
1047       'columns' => [
1048         'classnum',    'serial',   '',      '', '', '',
1049         'classname',   'varchar',  '', $char_d, '', '',
1050         'disabled',    'char', 'NULL',       1, '', '',
1051       ],
1052       'primary_key' => 'classnum',
1053       'unique' => [],
1054       'index' => [ ['disabled'] ],
1055     },
1056
1057     'cust_category' => {
1058       'columns' => [
1059         'categorynum',   'serial',  '', '', '', '',
1060         'categoryname',  'varchar', '', $char_d, '', '',
1061         'weight',         'int', 'NULL',  '', '', '',
1062         'disabled',      'char', 'NULL',   1, '', '',
1063       ],
1064       'primary_key' => 'categorynum',
1065       'unique' => [],
1066       'index' => [ ['disabled'] ],
1067     },
1068
1069     'cust_class' => {
1070       'columns' => [
1071         'classnum',    'serial',   '',      '', '', '',
1072         'classname',   'varchar',  '', $char_d, '', '',
1073         'categorynum', 'int',  'NULL',      '', '', '',
1074         'disabled',    'char', 'NULL',       1, '', '',
1075       ],
1076       'primary_key' => 'classnum',
1077       'unique' => [],
1078       'index' => [ ['disabled'] ],
1079     },
1080
1081     'cust_tag' => {
1082       'columns' => [
1083         'custtagnum', 'serial', '', '', '', '',
1084         'custnum',       'int', '', '', '', '',
1085         'tagnum',        'int', '', '', '', '',
1086       ],
1087       'primary_key' => 'custtagnum',
1088       'unique'      => [ [ 'custnum', 'tagnum' ] ],
1089       'index'       => [ [ 'custnum' ] ],
1090     },
1091
1092     'part_tag' => {
1093       'columns' => [
1094         'tagnum',    'serial',     '',      '', '', '',
1095         'tagname',  'varchar',     '', $char_d, '', '',
1096         'tagdesc',  'varchar', 'NULL', $char_d, '', '',
1097         'tagcolor', 'varchar', 'NULL',       6, '', '',
1098         'disabled',    'char', 'NULL',       1, '', '',
1099       ],
1100       'primary_key' => 'tagnum',
1101       'unique'      => [], #[ [ 'tagname' ] ], #?
1102       'index'       => [ [ 'disabled' ] ],
1103     },
1104
1105     'cust_main_exemption' => {
1106       'columns' => [
1107         'exemptionnum', 'serial', '',      '', '', '',
1108         'custnum',         'int', '',      '', '', '',
1109         'taxname',     'varchar', '', $char_d, '', '',
1110         #start/end dates?  for reporting?
1111       ],
1112       'primary_key' => 'exemptionnum',
1113       'unique'      => [],
1114       'index'       => [ [ 'custnum' ] ],
1115     },
1116
1117     'cust_tax_adjustment' => {
1118       'columns' => [
1119         'adjustmentnum', 'serial',     '',      '', '', '',
1120         'custnum',          'int',     '',      '', '', '',
1121         'taxname',      'varchar',     '', $char_d, '', '',
1122         'amount',    @money_type,                   '', '',
1123         'comment',     'varchar',  'NULL', $char_d, '', '',
1124         'billpkgnum',       'int', 'NULL',      '', '', '',
1125         #more?  no cust_bill_pkg_tax_location?
1126       ],
1127       'primary_key' => 'adjustmentnum',
1128       'unique'      => [],
1129       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
1130     },
1131
1132     'cust_main_county' => { #county+state+country are checked off the
1133                             #cust_main_county for validation and to provide
1134                             # a tax rate.
1135       'columns' => [
1136         'taxnum',   'serial',   '',    '', '', '',
1137         'city',     'varchar',  'NULL',    $char_d, '', '',
1138         'county',   'varchar',  'NULL',    $char_d, '', '',
1139         'state',    'varchar',  'NULL',    $char_d, '', '',
1140         'country',  'char',  '', 2, '', '',
1141         'taxclass',   'varchar', 'NULL', $char_d, '', '',
1142         'exempt_amount', @money_type, '', '',
1143         'tax',      'real',  '',    '', '', '', #tax %
1144         'taxname',  'varchar',  'NULL',    $char_d, '', '',
1145         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
1146         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
1147       ],
1148       'primary_key' => 'taxnum',
1149       'unique' => [],
1150   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
1151       'index' => [ [ 'city' ], [ 'county' ], [ 'state' ], [ 'country' ],
1152                    [ 'taxclass' ],
1153                  ],
1154     },
1155
1156     'tax_rate'    => {
1157       'columns' => [
1158         'taxnum',       'serial',     '',      '', '', '',
1159         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
1160         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
1161         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
1162         'taxclassnum', 'int',      '',      '', '', '',
1163         'effective_date', @date_type, '', '',
1164         'tax',        @taxrate_type,      '', '',        # tax %
1165         'excessrate', @taxrate_typen,     '', '',        # second tax %
1166         'taxbase',    @money_typen, '', '',              # amount at first tax rate
1167         'taxmax',     @money_typen, '', '',              # maximum about at both rates
1168         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
1169         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
1170         'unittype',    'int',  'NULL', '', '', '',      # for fee
1171         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
1172         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
1173         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
1174         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
1175         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
1176         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
1177         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
1178         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
1179         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
1180         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
1181         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
1182         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
1183         'inoutcity',   'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1184         'inoutlocal',  'char', 'NULL', 1, '', '',  # '', 'I', or 'O'
1185         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
1186         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
1187       ],
1188       'primary_key' => 'taxnum',
1189       'unique' => [],
1190       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
1191     },
1192
1193     'tax_rate_location' => {
1194       'columns' => [
1195         'taxratelocationnum', 'serial',  '',     '', '', '',
1196         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
1197         'geocode',            'varchar', '',     20,      '', '',
1198         'city',               'varchar', 'NULL', $char_d, '', '',
1199         'county',             'varchar', 'NULL', $char_d, '', '',
1200         'state',              'char',    'NULL',       2, '', '',
1201         'disabled',           'char',    'NULL', 1, '', '',
1202       ],
1203       'primary_key' => 'taxratelocationnum',
1204       'unique' => [],
1205       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
1206     },
1207
1208     'cust_tax_location' => {
1209       'columns' => [
1210         'custlocationnum', 'serial',  '',     '', '', '',
1211         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
1212         'city',            'varchar', 'NULL', $char_d, '', '',
1213         'postalcity',      'varchar', 'NULL', $char_d, '', '',
1214         'county',          'varchar', 'NULL', $char_d, '', '',
1215         'zip',             'char',    '',     5,  '', '',
1216         'state',           'char',    '',     2,  '', '',
1217         'plus4hi',         'char',    'NULL', 4,  '', '',
1218         'plus4lo',         'char',    'NULL', 4,  '', '',
1219         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
1220         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
1221         'geocode',         'varchar', '',    20,  '', '',
1222       ],
1223       'primary_key' => 'custlocationnum',
1224       'unique' => [],
1225       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
1226     },
1227
1228     'tax_class' => {
1229       'columns' => [
1230         'taxclassnum',  'serial',  '',            '', '', '',
1231         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
1232         'taxclass',     'varchar', '',       $char_d, '', '',
1233         'description',  'varchar', '',     2*$char_d, '', '',
1234       ],
1235       'primary_key' => 'taxclassnum',
1236       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
1237       'index' => [],
1238     },
1239
1240     'cust_pay_pending' => {
1241       'columns' => [
1242         'paypendingnum','serial',      '',  '', '', '',
1243         'custnum',      'int',         '',  '', '', '',
1244         'paid',         @money_type,            '', '',
1245         '_date',        @date_type,             '', '',
1246         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
1247                                                         # be index into payby
1248                                                         # table eventually
1249         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
1250         'paymask',      'varchar', 'NULL', $char_d, '', '',
1251         'paydate',      'varchar', 'NULL', 10, '', '',
1252         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
1253         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
1254         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1255
1256         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1257         'status',       'varchar',     '', $char_d, '', '',
1258         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
1259         'statustext',   'text',    'NULL',  '', '', '',
1260         'gatewaynum',   'int',     'NULL',  '', '', '',
1261         #'cust_balance', @money_type,            '', '',
1262         'paynum',       'int',     'NULL',  '', '', '',
1263         'jobnum',       'int',     'NULL',  '', '', '',
1264       ],
1265       'primary_key' => 'paypendingnum',
1266       'unique'      => [ [ 'payunique' ] ],
1267       'index'       => [ [ 'custnum' ], [ 'status' ], ],
1268     },
1269
1270     'cust_pay' => {
1271       'columns' => [
1272         'paynum',   'serial',    '',   '', '', '',
1273         'custnum',  'int',    '',   '', '', '',
1274         '_date',    @date_type, '', '',
1275         'paid',     @money_type, '', '',
1276         'otaker',   'varchar', 'NULL', 32, '', '',
1277         'usernum',   'int', 'NULL', '', '', '',
1278         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1279                                                  # index into payby table
1280                                                  # eventually
1281         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
1282         'paymask', 'varchar', 'NULL', $char_d, '', '',
1283         'paydate',  'varchar', 'NULL', 10, '', '',
1284         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1285         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
1286         'closed',    'char', 'NULL', 1, '', '',
1287         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1288       ],
1289       'primary_key' => 'paynum',
1290       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
1291       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ], [ 'usernum' ] ],
1292     },
1293
1294     'cust_pay_void' => {
1295       'columns' => [
1296         'paynum',    'int',    '',   '', '', '',
1297         'custnum',   'int',    '',   '', '', '',
1298         'paid',      @money_type, '', '',
1299         '_date',     @date_type, '', '',
1300         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1301                                                   # index into payby table
1302                                                   # eventually
1303         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
1304         'paymask', 'varchar', 'NULL', $char_d, '', '',
1305         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
1306         'closed',    'char', 'NULL', 1, '', '',
1307         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1308         'void_date', @date_type, '', '',
1309         'reason',    'varchar',   'NULL', $char_d, '', '',
1310         'otaker',   'varchar', 'NULL', 32, '', '',
1311         'usernum',   'int', 'NULL', '', '', '',
1312         'void_usernum',   'int', 'NULL', '', '', '',
1313       ],
1314       'primary_key' => 'paynum',
1315       'unique' => [],
1316       'index' => [ [ 'custnum' ], [ 'usernum' ], [ 'void_usernum' ] ],
1317     },
1318
1319     'cust_bill_pay' => {
1320       'columns' => [
1321         'billpaynum', 'serial',     '',   '', '', '',
1322         'invnum',  'int',     '',   '', '', '',
1323         'paynum',  'int',     '',   '', '', '',
1324         'amount',  @money_type, '', '',
1325         '_date',   @date_type, '', '',
1326         'pkgnum', 'int', 'NULL', '', '', '', #desired pkgnum for pkg-balances
1327       ],
1328       'primary_key' => 'billpaynum',
1329       'unique' => [],
1330       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1331     },
1332
1333     'cust_bill_pay_batch' => {
1334       'columns' => [
1335         'billpaynum', 'serial',     '',   '', '', '',
1336         'invnum',  'int',     '',   '', '', '',
1337         'paybatchnum',  'int',     '',   '', '', '',
1338         'amount',  @money_type, '', '',
1339         '_date',   @date_type, '', '',
1340       ],
1341       'primary_key' => 'billpaynum',
1342       'unique' => [],
1343       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1344     },
1345
1346     'cust_bill_pay_pkg' => {
1347       'columns' => [
1348         'billpaypkgnum', 'serial', '', '', '', '',
1349         'billpaynum',       'int', '', '', '', '',
1350         'billpkgnum',       'int', '', '', '', '',
1351         'billpkgtaxlocationnum', 'int', 'NULL', '', '', '',
1352         'billpkgtaxratelocationnum', 'int', 'NULL', '', '', '',
1353         'amount',         @money_type,     '', '',
1354         'setuprecur',      'varchar', '', $char_d, '', '',
1355         'sdate',   @date_type, '', '',
1356         'edate',   @date_type, '', '',
1357       ],
1358       'primary_key' => 'billpaypkgnum',
1359       'unique'      => [],
1360       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1361     },
1362
1363     'pay_batch' => { #batches of payments to an external processor
1364       'columns' => [
1365         'batchnum',   'serial',    '',   '', '', '',
1366         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1367         'status',     'char', 'NULL',     1, '', '',
1368         'download',   @date_type, '', '',
1369         'upload',     @date_type, '', '',
1370       ],
1371       'primary_key' => 'batchnum',
1372       'unique' => [],
1373       'index' => [],
1374     },
1375
1376     'cust_pay_batch' => { #what's this used for again?  list of customers
1377                           #in current CARD batch? (necessarily CARD?)
1378       'columns' => [
1379         'paybatchnum',   'serial',    '',   '', '', '',
1380         'batchnum',   'int',    '',   '', '', '',
1381         'invnum',   'int',    '',   '', '', '',
1382         'custnum',   'int',    '',   '', '', '',
1383         'last',     'varchar', '',     $char_d, '', '',
1384         'first',    'varchar', '',     $char_d, '', '',
1385         'address1', 'varchar', '',     $char_d, '', '',
1386         'address2', 'varchar', 'NULL', $char_d, '', '',
1387         'city',     'varchar', '',     $char_d, '', '',
1388         'state',    'varchar', 'NULL', $char_d, '', '',
1389         'zip',      'varchar', 'NULL', 10, '', '',
1390         'country',  'char', '',     2, '', '',
1391         #        'trancode', 'int', '', '', '', ''
1392         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1393         'payinfo',  'varchar', '',     512, '', '',
1394         #'exp',      @date_type, '', ''
1395         'exp',      'varchar', 'NULL',     11, '', '',
1396         'payname',  'varchar', 'NULL', $char_d, '', '',
1397         'amount',   @money_type, '', '',
1398         'status',   'varchar', 'NULL',     $char_d, '', '',
1399       ],
1400       'primary_key' => 'paybatchnum',
1401       'unique' => [],
1402       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1403     },
1404
1405     'cust_pkg' => {
1406       'columns' => [
1407         'pkgnum',           'serial',     '', '', '', '',
1408         'custnum',             'int',     '', '', '', '',
1409         'pkgpart',             'int',     '', '', '', '',
1410         'pkgbatch',        'varchar', 'NULL', $char_d, '', '',
1411         'locationnum',         'int', 'NULL', '', '', '',
1412         'otaker',          'varchar', 'NULL', 32, '', '',
1413         'usernum',             'int', 'NULL', '', '', '',
1414         'order_date',     @date_type,             '', '',
1415         'start_date',     @date_type,             '', '',
1416         'setup',          @date_type,             '', '',
1417         'bill',           @date_type,             '', '',
1418         'last_bill',      @date_type,             '', '',
1419         'susp',           @date_type,             '', '',
1420         'adjourn',        @date_type,             '', '',
1421         'cancel',         @date_type,             '', '',
1422         'expire',         @date_type,             '', '',
1423         'contract_end',   @date_type,             '', '',
1424         'change_date',    @date_type,             '', '',
1425         'change_pkgnum',       'int', 'NULL', '', '', '',
1426         'change_pkgpart',      'int', 'NULL', '', '', '',
1427         'change_locationnum',  'int', 'NULL', '', '', '',
1428         'manual_flag',        'char', 'NULL',  1, '', '',
1429         'no_auto',            'char', 'NULL',  1, '', '',
1430         'quantity',            'int', 'NULL', '', '', '',
1431       ],
1432       'primary_key' => 'pkgnum',
1433       'unique' => [],
1434       'index' => [ ['custnum'], ['pkgpart'], [ 'pkgbatch' ], [ 'locationnum' ],
1435                    [ 'usernum' ],
1436                    [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1437                    ['susp'], ['adjourn'], ['expire'], ['cancel'],
1438                    ['change_date'], ['order_date'],
1439                  ],
1440     },
1441
1442     'cust_pkg_option' => {
1443       'columns' => [
1444         'optionnum', 'serial', '', '', '', '',
1445         'pkgnum', 'int', '', '', '', '',
1446         'optionname', 'varchar', '', $char_d, '', '',
1447         'optionvalue', 'text', 'NULL', '', '', '',
1448       ],
1449       'primary_key' => 'optionnum',
1450       'unique'      => [],
1451       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1452     },
1453
1454     'cust_pkg_detail' => {
1455       'columns' => [
1456         'pkgdetailnum', 'serial', '',      '', '', '',
1457         'pkgnum',          'int', '',      '', '', '',
1458         'detail',      'varchar', '', $char_d, '', '',
1459         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1460         'weight',          'int', '',      '', '', '',
1461       ],
1462       'primary_key' => 'pkgdetailnum',
1463       'unique' => [],
1464       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1465     },
1466
1467     'cust_pkg_reason' => {
1468       'columns' => [
1469         'num',      'serial',    '',   '', '', '',
1470         'pkgnum',   'int',    '',   '', '', '',
1471         'reasonnum','int',    '',   '', '', '',
1472         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1473         'otaker',   'varchar', 'NULL', 32, '', '',
1474         'usernum',   'int', 'NULL', '', '', '',
1475         'date',     @date_type, '', '',
1476       ],
1477       'primary_key' => 'num',
1478       'unique' => [],
1479       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], [ 'usernum' ], ],
1480     },
1481
1482     'cust_pkg_discount' => {
1483       'columns' => [
1484         'pkgdiscountnum', 'serial', '',     '', '', '',
1485         'pkgnum',            'int', '',     '', '', '',
1486         'discountnum',       'int', '',     '', '', '',
1487         'months_used',   'decimal', 'NULL', '', '', '',
1488         'end_date',     @date_type,             '', '',
1489         'otaker',        'varchar', 'NULL', 32, '', '',
1490         'usernum',           'int', 'NULL', '', '', '',
1491         'disabled',         'char', 'NULL',  1, '', '',
1492       ],
1493       'primary_key' => 'pkgdiscountnum',
1494       'unique' => [],
1495       'index'  => [ [ 'pkgnum' ], [ 'discountnum' ], [ 'usernum' ], ],
1496     },
1497
1498     'cust_bill_pkg_discount' => {
1499       'columns' => [
1500         'billpkgdiscountnum', 'serial',     '', '', '', '',
1501         'billpkgnum',            'int',     '', '', '', '',
1502         'pkgdiscountnum',        'int',     '', '', '', '',
1503         'amount',          @money_type,             '', '',
1504         'months',            'decimal', 'NULL', '', '', '',
1505       ],
1506       'primary_key' => 'billpkgdiscountnum',
1507       'unique' => [],
1508       'index' => [ [ 'billpkgnum' ], [ 'pkgdiscountnum' ] ],
1509     },
1510
1511     'discount' => {
1512       'columns' => [
1513         'discountnum', 'serial',     '',      '', '', '',
1514         #'agentnum',       'int', 'NULL',      '', '', '',
1515         'name',       'varchar', 'NULL', $char_d, '', '',
1516         'amount',   @money_type,                  '', '',
1517         'percent',    'decimal',     '',      '', '', '',
1518         'months',     'decimal', 'NULL',      '', '', '',
1519         'disabled',      'char', 'NULL',       1, '', '',
1520       ],
1521       'primary_key' => 'discountnum',
1522       'unique' => [],
1523       'index'  => [], # [ 'agentnum' ], ],
1524     },
1525
1526     'cust_refund' => {
1527       'columns' => [
1528         'refundnum',    'serial',    '',   '', '', '',
1529         'custnum',  'int',    '',   '', '', '',
1530         '_date',        @date_type, '', '',
1531         'refund',       @money_type, '', '',
1532         'otaker',       'varchar',   'NULL',   32, '', '',
1533         'usernum',   'int', 'NULL', '', '', '',
1534         'reason',       'varchar',   '',   $char_d, '', '',
1535         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1536                                                      # be index into payby
1537                                                      # table eventually
1538         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1539         'paymask', 'varchar', 'NULL', $char_d, '', '',
1540         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1541         'closed',    'char', 'NULL', 1, '', '',
1542       ],
1543       'primary_key' => 'refundnum',
1544       'unique' => [],
1545       'index' => [ ['custnum'], ['_date'], [ 'usernum' ], ],
1546     },
1547
1548     'cust_credit_refund' => {
1549       'columns' => [
1550         'creditrefundnum', 'serial',     '',   '', '', '',
1551         'crednum',  'int',     '',   '', '', '',
1552         'refundnum',  'int',     '',   '', '', '',
1553         'amount',  @money_type, '', '',
1554         '_date',   @date_type, '', '',
1555       ],
1556       'primary_key' => 'creditrefundnum',
1557       'unique' => [],
1558       'index' => [ ['crednum'], ['refundnum'] ],
1559     },
1560
1561
1562     'cust_svc' => {
1563       'columns' => [
1564         'svcnum',    'serial',    '',   '', '', '',
1565         'pkgnum',    'int',    'NULL',   '', '', '',
1566         'svcpart',   'int',    '',   '', '', '',
1567         'overlimit', @date_type, '', '',
1568       ],
1569       'primary_key' => 'svcnum',
1570       'unique' => [],
1571       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1572     },
1573
1574     'cust_svc_option' => {
1575       'columns' => [
1576         'optionnum',   'serial', '', '', '', '',
1577         'svcnum',      'int', '', '', '', '',
1578         'optionname',  'varchar', '', $char_d, '', '',
1579         'optionvalue', 'text', 'NULL', '', '', '',
1580       ],
1581       'primary_key' => 'optionnum',
1582       'unique'      => [],
1583       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1584     },
1585
1586     'part_pkg' => {
1587       'columns' => [
1588         'pkgpart',       'serial',    '',   '', '', '',
1589         'pkg',           'varchar',   '',   $char_d, '', '',
1590         'comment',       'varchar',   '',   $char_d, '', '',
1591         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1592         'setup',         @perl_type, '', '',
1593         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1594         'recur',         @perl_type, '', '',
1595         'setuptax',      'char', 'NULL', 1, '', '',
1596         'recurtax',      'char', 'NULL', 1, '', '',
1597         'plan',          'varchar', 'NULL', $char_d, '', '',
1598         'plandata',      'text', 'NULL', '', '', '',
1599         'disabled',      'char', 'NULL', 1, '', '',
1600         'custom',        'char', 'NULL', 1, '', '',
1601         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1602         'classnum',      'int',     'NULL', '', '', '',
1603         'addon_classnum','int',     'NULL', '', '', '',
1604         'taxproductnum', 'int',     'NULL', '', '', '',
1605         'setup_cost',    @money_typen,          '', '',
1606         'recur_cost',    @money_typen,          '', '',
1607         'pay_weight',    'real',    'NULL', '', '', '',
1608         'credit_weight', 'real',    'NULL', '', '', '',
1609         'agentnum',      'int',     'NULL', '', '', '',
1610         'fcc_ds0s',      'int',     'NULL', '', '', '',
1611         'no_auto',      'char',     'NULL',  1, '', '',
1612       ],
1613       'primary_key' => 'pkgpart',
1614       'unique' => [],
1615       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'classnum' ],
1616                    [ 'agentnum' ],
1617                  ],
1618     },
1619
1620     'part_pkg_link' => {
1621       'columns' => [
1622         'pkglinknum',  'serial',   '',      '', '', '',
1623         'src_pkgpart', 'int',      '',      '', '', '',
1624         'dst_pkgpart', 'int',      '',      '', '', '',
1625         'link_type',   'varchar',  '', $char_d, '', '',
1626         'hidden',      'char', 'NULL',       1, '', '',
1627       ],
1628       'primary_key' => 'pkglinknum',
1629       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type', 'hidden' ] ],
1630       'index'  => [ [ 'src_pkgpart' ] ],
1631     },
1632     # XXX somewhat borked unique: we don't really want a hidden and unhidden
1633     # it turns out we'd prefer to use svc, bill, and invisibill (or something)
1634
1635     'part_pkg_discount' => {
1636       'columns' => [
1637         'pkgdiscountnum', 'serial',   '',      '', '', '',
1638         'pkgpart',        'int',      '',      '', '', '',
1639         'discountnum',    'int',      '',      '', '', '',
1640       ],
1641       'primary_key' => 'pkgdiscountnum',
1642       'unique' => [ [ 'pkgpart', 'discountnum' ] ],
1643       'index'  => [],
1644     },
1645
1646     'part_pkg_taxclass' => {
1647       'columns' => [
1648         'taxclassnum',  'serial', '',       '', '', '',
1649         'taxclass',     'varchar', '', $char_d, '', '',
1650         'disabled', 'char',   'NULL',         1, '', '',
1651       ],
1652       'primary_key' => 'taxclassnum',
1653       'unique'      => [ [ 'taxclass' ] ],
1654       'index'       => [ [ 'disabled' ] ],
1655     },
1656
1657     'part_pkg_taxproduct' => {
1658       'columns' => [
1659         'taxproductnum', 'serial',      '',        '', '', '',
1660         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1661         'taxproduct',    'varchar',     '',   $char_d, '', '',
1662         'description',   'varchar',     '', 3*$char_d, '', '',
1663       ],
1664       'primary_key' => 'taxproductnum',
1665       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1666       'index'       => [],
1667     },
1668
1669     'part_pkg_taxrate' => {
1670       'columns' => [
1671         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1672         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1673         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1674         'taxproductnum', 'int',  '',     '',       '', '',
1675         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1676         'county',           'varchar', 'NULL', $char_d, '', '',
1677         'state',            'varchar', 'NULL', $char_d, '', '',
1678         'local',            'varchar', 'NULL', $char_d, '', '',
1679         'country',          'char',    'NULL', 2,       '', '',
1680         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1681         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1682         'taxclassnum',      'int',     'NULL', '',      '', '',
1683         'effdate',          @date_type, '', '',
1684         'taxable',          'char',    'NULL', 1,       '', '',
1685       ],
1686       'primary_key' => 'pkgtaxratenum',
1687       'unique' => [],
1688       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1689     },
1690
1691     'part_pkg_taxoverride' => {
1692       'columns' => [
1693         'taxoverridenum', 'serial', '', '', '', '',
1694         'pkgpart',           'int', '', '', '', '',
1695         'taxclassnum',       'int', '', '', '', '',
1696         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1697       ],
1698       'primary_key' => 'taxoverridenum',
1699       'unique' => [],
1700       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1701     },
1702
1703 #    'part_title' => {
1704 #      'columns' => [
1705 #        'titlenum',   'int',    '',   '',
1706 #        'title',      'varchar',   '',   $char_d,
1707 #      ],
1708 #      'primary_key' => 'titlenum',
1709 #      'unique' => [ [] ],
1710 #      'index' => [ [] ],
1711 #    },
1712
1713     'pkg_svc' => {
1714       'columns' => [
1715         'pkgsvcnum',  'serial', '',  '', '', '',
1716         'pkgpart',    'int',    '',   '', '', '',
1717         'svcpart',    'int',    '',   '', '', '',
1718         'quantity',   'int',    '',   '', '', '',
1719         'primary_svc','char', 'NULL',  1, '', '',
1720         'hidden',     'char', 'NULL',  1, '', '',
1721       ],
1722       'primary_key' => 'pkgsvcnum',
1723       'unique' => [ ['pkgpart', 'svcpart'] ],
1724       'index' => [ ['pkgpart'], ['quantity'] ],
1725     },
1726
1727     'part_referral' => {
1728       'columns' => [
1729         'refnum',   'serial',     '',        '', '', '',
1730         'referral', 'varchar',    '',   $char_d, '', '',
1731         'disabled', 'char',   'NULL',         1, '', '',
1732         'agentnum', 'int',    'NULL',        '', '', '',
1733       ],
1734       'primary_key' => 'refnum',
1735       'unique' => [],
1736       'index' => [ ['disabled'], ['agentnum'], ],
1737     },
1738
1739     'part_svc' => {
1740       'columns' => [
1741         'svcpart',    'serial',    '',   '', '', '',
1742         'svc',        'varchar',   '',   $char_d, '', '',
1743         'svcdb',      'varchar',   '',   $char_d, '', '',
1744         'disabled',   'char',  'NULL',   1, '', '',
1745       ],
1746       'primary_key' => 'svcpart',
1747       'unique' => [],
1748       'index' => [ [ 'disabled' ] ],
1749     },
1750
1751     'part_svc_column' => {
1752       'columns' => [
1753         'columnnum',   'serial',         '', '', '', '',
1754         'svcpart',     'int',         '', '', '', '',
1755         'columnname',  'varchar',     '', 64, '', '',
1756         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1757         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1758         'columnflag',  'char',    'NULL', 1, '', '',
1759       ],
1760       'primary_key' => 'columnnum',
1761       'unique' => [ [ 'svcpart', 'columnname' ] ],
1762       'index' => [ [ 'svcpart' ] ],
1763     },
1764
1765     #(this should be renamed to part_pop)
1766     'svc_acct_pop' => {
1767       'columns' => [
1768         'popnum',    'serial',    '',   '', '', '',
1769         'city',      'varchar',   '',   $char_d, '', '',
1770         'state',     'varchar',   '',   $char_d, '', '',
1771         'ac',        'char',   '',   3, '', '',
1772         'exch',      'char',   '',   3, '', '',
1773         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1774       ],
1775       'primary_key' => 'popnum',
1776       'unique' => [],
1777       'index' => [ [ 'state' ] ],
1778     },
1779
1780     'part_pop_local' => {
1781       'columns' => [
1782         'localnum',  'serial',     '',     '', '', '',
1783         'popnum',    'int',     '',     '', '', '',
1784         'city',      'varchar', 'NULL', $char_d, '', '',
1785         'state',     'char',    'NULL', 2, '', '',
1786         'npa',       'char',    '',     3, '', '',
1787         'nxx',       'char',    '',     3, '', '',
1788       ],
1789       'primary_key' => 'localnum',
1790       'unique' => [],
1791       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1792     },
1793
1794     'qual' => {
1795       'columns' => [
1796         'qualnum',  'serial',     '',     '', '', '',
1797         'custnum',    'int',     'NULL',     '', '', '',
1798         'prospectnum',    'int',     'NULL',     '', '', '',
1799         'locationnum',    'int',     'NULL',     '', '', '',
1800         'phonenum',     'varchar', 'NULL',       24, '', '',
1801         'exportnum',      'int', 'NULL', '', '', '',
1802         'vendor_qual_id',      'varchar', 'NULL', $char_d, '', '',
1803         'status',      'char', '', 1, '', '',
1804       ],
1805       'primary_key' => 'qualnum',
1806       'unique' => [],
1807       'index' => [ [ 'locationnum' ], ['custnum'], ['prospectnum'],
1808                     ['phonenum'], ['vendor_qual_id'] ],
1809     },
1810
1811     'qual_option' => {
1812       'columns' => [
1813         'optionnum', 'serial', '', '', '', '',
1814         'qualnum',  'int',     '',     '', '', '',
1815         'optionname', 'varchar', '', $char_d, '', '',
1816         'optionvalue', 'text', 'NULL', '', '', '',
1817       ],
1818       'primary_key' => 'optionnum',
1819       'unique' => [],
1820       'index' => [],
1821     },
1822
1823     'svc_acct' => {
1824       'columns' => [
1825         'svcnum',    'int',    '',   '', '', '',
1826         'username',  'varchar',   '',   $username_len, '', '',
1827         '_password', 'varchar',   'NULL',  512, '', '',
1828         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1829         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1830         'popnum',    'int',    'NULL',   '', '', '',
1831         'uid',       'int', 'NULL',   '', '', '',
1832         'gid',       'int', 'NULL',   '', '', '',
1833         'finger',    'varchar',   'NULL',   $char_d, '', '',
1834         'dir',       'varchar',   'NULL',   $char_d, '', '',
1835         'shell',     'varchar',   'NULL',   $char_d, '', '',
1836         'quota',     'varchar',   'NULL',   $char_d, '', '',
1837         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1838         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1839         'seconds_threshold',   'int', 'NULL',   '', '', '',
1840         'upbytes',   'bigint', 'NULL',   '', '', '',
1841         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1842         'downbytes', 'bigint', 'NULL',   '', '', '',
1843         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1844         'totalbytes','bigint', 'NULL',   '', '', '',
1845         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1846         'domsvc',    'int',     '', '', '', '',
1847         'pbxsvc',    'int', 'NULL', '', '', '',
1848         'last_login',  @date_type, '', '',
1849         'last_logout', @date_type, '', '',
1850         #cardfortress field(s)
1851         'cf_privatekey',      'text', 'NULL',      '', '', '',
1852         #communigate pro fields (quota = MaxAccountSize)
1853         'cgp_aliases',     'varchar', 'NULL',     255, '', '',
1854         #settings
1855         'cgp_type',        'varchar', 'NULL', $char_d, '', '', #AccountType
1856         'file_quota',      'varchar', 'NULL', $char_d, '', '', #MaxWebSize
1857         'file_maxnum',     'varchar', 'NULL', $char_d, '', '', #MaxWebFiles
1858         'file_maxsize',    'varchar', 'NULL', $char_d, '', '', #MaxFileSize
1859         'cgp_accessmodes', 'varchar', 'NULL',     255, '', '', #AccessModes
1860         'password_selfchange','char', 'NULL',       1, '', '', #PWDAllowed
1861         'password_recover',   'char', 'NULL',       1, 'Y','', #PasswordRecovery
1862         'cgp_rulesallowed','varchar', 'NULL', $char_d, '', '', #RulesAllowed
1863         'cgp_rpopallowed',    'char', 'NULL',       1, '', '', #RPOPAllowed
1864         'cgp_mailtoall',      'char', 'NULL',       1, '', '', #MailToAll
1865         'cgp_addmailtrailer', 'char', 'NULL',       1, '', '', #AddMailTrailer
1866         'cgp_archiveafter',    'int', 'NULL',      '', '', '', #ArchiveMessagesAfter
1867         #XXX mailing lists
1868         #preferences
1869         'cgp_deletemode',     'varchar', 'NULL', $char_d, '', '',#DeleteMode
1870         'cgp_emptytrash',     'varchar', 'NULL', $char_d, '', '',#EmptyTrash
1871         'cgp_language',       'varchar', 'NULL', $char_d, '', '',#Language
1872         'cgp_timezone',       'varchar', 'NULL', $char_d, '', '',#TimeZone
1873         'cgp_skinname',       'varchar', 'NULL', $char_d, '', '',#SkinName
1874         'cgp_prontoskinname', 'varchar', 'NULL', $char_d, '', '',#ProntoSkinName
1875         'cgp_sendmdnmode',    'varchar', 'NULL', $char_d, '', '',#SendMDNMode
1876         #mail
1877         #XXX RPOP settings
1878       ],
1879       'primary_key' => 'svcnum',
1880       #'unique' => [ [ 'username', 'domsvc' ] ],
1881       'unique' => [],
1882       'index' => [ ['username'], ['domsvc'], ['pbxsvc'] ],
1883     },
1884
1885     'acct_rt_transaction' => {
1886       'columns' => [
1887         'svcrtid',   'int',    '',   '', '', '',
1888         'svcnum',    'int',    '',   '', '', '',
1889         'transaction_id',       'int', '',   '', '', '',
1890         '_date',   @date_type, '', '',
1891         'seconds',   'int', '',   '', '', '', #uhhhh
1892         'support',   'int', '',   '', '', '',
1893       ],
1894       'primary_key' => 'svcrtid',
1895       'unique' => [],
1896       'index' => [ ['svcnum', 'transaction_id'] ],
1897     },
1898
1899     #'svc_charge' => {
1900     #  'columns' => [
1901     #    'svcnum',    'int',    '',   '',
1902     #    'amount',    @money_type,
1903     #  ],
1904     #  'primary_key' => 'svcnum',
1905     #  'unique' => [ [] ],
1906     #  'index' => [ [] ],
1907     #},
1908
1909     'svc_domain' => {
1910       'columns' => [
1911         'svcnum',           'int',    '',        '', '', '',
1912         'domain',       'varchar',    '',   $char_d, '', '',
1913         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1914         'catchall',         'int', 'NULL',       '', '', '',
1915         'parent_svcnum',    'int', 'NULL',       '', '', '',
1916         'registrarnum',     'int', 'NULL',       '', '', '',
1917         'registrarkey', 'varchar', 'NULL',      512, '', '',
1918         'setup_date',      @date_type, '', '',
1919         'renewal_interval', 'int', 'NULL',       '', '', '',
1920         'expiration_date', @date_type, '', '',
1921         #communigate pro fields (quota = MaxAccountSize)
1922         'max_accounts',     'int', 'NULL',       '', '', '',
1923         'trailer',         'text', 'NULL',       '', '', '',
1924         'cgp_aliases',  'varchar', 'NULL',      255, '', '',
1925         'cgp_accessmodes','varchar','NULL',     255, '', '', #DomainAccessModes
1926         'cgp_certificatetype','varchar','NULL', $char_d, '', '',
1927         #settings
1928         'acct_def_password_selfchange',   'char', 'NULL',       1,  '', '',
1929         'acct_def_password_recover',      'char', 'NULL',       1, 'Y', '',
1930         'acct_def_cgp_accessmodes',    'varchar', 'NULL',     255,  '', '',
1931         'acct_def_quota',              'varchar', 'NULL', $char_d,  '', '',
1932         'acct_def_file_quota',         'varchar', 'NULL', $char_d,  '', '',
1933         'acct_def_file_maxnum',        'varchar', 'NULL', $char_d,  '', '',
1934         'acct_def_file_maxsize',       'varchar', 'NULL', $char_d,  '', '',
1935         'acct_def_cgp_rulesallowed',   'varchar', 'NULL', $char_d,  '', '',
1936         'acct_def_cgp_rpopallowed',       'char', 'NULL',       1,  '', '',
1937         'acct_def_cgp_mailtoall',         'char', 'NULL',       1,  '', '',
1938         'acct_def_cgp_addmailtrailer',    'char', 'NULL',       1,  '', '',
1939         'acct_def_cgp_archiveafter',       'int', 'NULL',      '',  '', '',
1940         #preferences
1941         'acct_def_cgp_deletemode',     'varchar', 'NULL', $char_d,  '', '',
1942         'acct_def_cgp_emptytrash',     'varchar', 'NULL', $char_d,  '', '',
1943         'acct_def_cgp_language',       'varchar', 'NULL', $char_d,  '', '',
1944         'acct_def_cgp_timezone',       'varchar', 'NULL', $char_d,  '', '',
1945         'acct_def_cgp_skinname',       'varchar', 'NULL', $char_d,  '', '',
1946         'acct_def_cgp_prontoskinname', 'varchar', 'NULL', $char_d,  '', '',
1947         'acct_def_cgp_sendmdnmode',    'varchar', 'NULL', $char_d,  '', '',
1948       ],
1949       'primary_key' => 'svcnum',
1950       'unique' => [ ],
1951       'index' => [ ['domain'] ],
1952     },
1953
1954     'svc_dsl' => {
1955       'columns' => [
1956         'svcnum',           'int',    '',        '', '', '',
1957         'pushed',     'int', 'NULL',       '', '', '',
1958         'desired_due_date',     'int', 'NULL',       '', '', '',
1959         'due_date',     'int', 'NULL',       '', '', '',
1960         'vendor_order_id',              'varchar', 'NULL', $char_d,  '', '',
1961         'vendor_qual_id',              'varchar', 'NULL', $char_d,  '', '',
1962         'vendor_order_type',   'varchar', 'NULL', $char_d,  '', '',
1963         'vendor_order_status',   'varchar', 'NULL', $char_d,  '', '',
1964         'first',              'varchar', 'NULL', $char_d,  '', '',
1965         'last',              'varchar', 'NULL', $char_d,  '', '',
1966         'company',              'varchar', 'NULL', $char_d,  '', '',
1967         'phonenum',     'varchar', 'NULL',       24, '', '',
1968         'loop_type',   'char', 'NULL',       1,  '', '',
1969         'local_voice_provider', 'varchar', 'NULL', $char_d,  '', '',
1970         'circuitnum',              'varchar', 'NULL', $char_d,  '', '',
1971         'rate_band',              'varchar', 'NULL', $char_d,  '', '',
1972         'isp_chg',   'char', 'NULL',       1,  '', '',
1973         'isp_prev',              'varchar', 'NULL', $char_d,  '', '',
1974         'username',              'varchar', 'NULL', $char_d,  '', '',
1975         'password',              'varchar', 'NULL', $char_d,  '', '',
1976         'staticips',             'text', 'NULL', '',  '', '',
1977         'monitored',    'char', 'NULL',       1,  '', '',
1978         'last_pull',     'int', 'NULL',       '', '', '',
1979       ],
1980       'primary_key' => 'svcnum',
1981       'unique' => [ ],
1982       'index' => [ ['phonenum'], ['vendor_order_id'] ],
1983     },
1984
1985     'dsl_note' => {
1986       'columns' => [
1987         'notenum',           'serial',    '',        '', '', '',
1988         'svcnum',     'int', '',       '', '', '',
1989         'author',     'varchar', 'NULL', $char_d,  '', '',
1990         'priority',   'char', 'NULL',       1,  '', '',
1991         '_date',     'int', 'NULL',       '', '', '',
1992         'note',     'text', '',       '', '', '',
1993       ],
1994       'primary_key' => 'notenum',
1995       'unique' => [ ],
1996       'index' => [ ['svcnum'] ],
1997     },
1998
1999     'domain_record' => {
2000       'columns' => [
2001         'recnum',    'serial',     '',  '', '', '',
2002         'svcnum',    'int',     '',  '', '', '',
2003         'reczone',   'varchar', '',  255, '', '',
2004         'recaf',     'char',    '',  2, '', '',
2005         'rectype',   'varchar',    '',  5, '', '',
2006         'recdata',   'varchar', '',  255, '', '',
2007         'ttl',       'int',     'NULL', '', '', '',
2008       ],
2009       'primary_key' => 'recnum',
2010       'unique'      => [],
2011       'index'       => [ ['svcnum'] ],
2012     },
2013
2014     'registrar' => {
2015       'columns' => [
2016         'registrarnum',   'serial', '',      '', '', '',
2017         'registrarname', 'varchar', '', $char_d, '', '',
2018       ],
2019       'primary_key' => 'registrarnum',
2020       'unique'      => [],
2021       'index'       => [],
2022     },
2023
2024     'cgp_rule' => {
2025       'columns' => [
2026         'rulenum',  'serial',     '',      '', '', '',
2027         'name',    'varchar',     '', $char_d, '', '',
2028         'comment', 'varchar', 'NULL', $char_d, '', '',
2029         'svcnum',      'int',     '',      '', '', '',
2030         'priority',    'int',     '',      '', '', '',
2031       ],
2032       'primary_key' => 'rulenum',
2033       'unique'      => [ [ 'svcnum', 'name' ] ],
2034       'index'       => [ [ 'svcnum' ] ],
2035     },
2036
2037     'cgp_rule_condition' => {
2038       'columns' => [
2039         'ruleconditionnum',  'serial',     '',      '', '', '',
2040         'conditionname',    'varchar',     '', $char_d, '', '',
2041         'op',               'varchar', 'NULL', $char_d, '', '',
2042         'params',           'varchar', 'NULL',     255, '', '',
2043         'rulenum',              'int',     '',      '', '', '',
2044       ],
2045       'primary_key' => 'ruleconditionnum',
2046       'unique'      => [],
2047       'index'       => [ [ 'rulenum' ] ],
2048     },
2049
2050     'cgp_rule_action' => {
2051        'columns' => [
2052         'ruleactionnum',  'serial',     '',      '', '', '',
2053         'action',        'varchar',     '', $char_d, '', '',
2054         'params',        'varchar', 'NULL',     255, '', '',
2055         'rulenum',           'int',     '',      '', '', '',
2056       ],
2057       'primary_key' => 'ruleactionnum',
2058       'unique'      => [],
2059       'index'       => [ [ 'rulenum' ] ],
2060    },
2061
2062     'svc_forward' => {
2063       'columns' => [
2064         'svcnum',   'int',            '',   '', '', '',
2065         'srcsvc',   'int',        'NULL',   '', '', '',
2066         'src',      'varchar',    'NULL',  255, '', '',
2067         'dstsvc',   'int',        'NULL',   '', '', '',
2068         'dst',      'varchar',    'NULL',  255, '', '',
2069       ],
2070       'primary_key' => 'svcnum',
2071       'unique'      => [],
2072       'index'       => [ ['srcsvc'], ['dstsvc'] ],
2073     },
2074
2075     'svc_www' => {
2076       'columns' => [
2077         'svcnum',   'int',      '',  '', '', '',
2078         'recnum',   'int',      '',  '', '', '',
2079         'usersvc',  'int',  'NULL',  '', '', '',
2080         'config',   'text', 'NULL',  '', '', '',
2081       ],
2082       'primary_key' => 'svcnum',
2083       'unique'      => [],
2084       'index'       => [],
2085     },
2086
2087     #'svc_wo' => {
2088     #  'columns' => [
2089     #    'svcnum',    'int',    '',   '',
2090     #    'svcnum',    'int',    '',   '',
2091     #    'svcnum',    'int',    '',   '',
2092     #    'worker',    'varchar',   '',   $char_d,
2093     #    '_date',     @date_type,
2094     #  ],
2095     #  'primary_key' => 'svcnum',
2096     #  'unique' => [ [] ],
2097     #  'index' => [ [] ],
2098     #},
2099
2100     'prepay_credit' => {
2101       'columns' => [
2102         'prepaynum',   'serial',     '',   '', '', '',
2103         'identifier',  'varchar', '', $char_d, '', '',
2104         'amount',      @money_type, '', '',
2105         'seconds',     'int',     'NULL', '', '', '',
2106         'upbytes',     'bigint',     'NULL', '', '', '',
2107         'downbytes',   'bigint',     'NULL', '', '', '',
2108         'totalbytes',  'bigint',     'NULL', '', '', '',
2109         'agentnum',    'int',     'NULL', '', '', '',
2110       ],
2111       'primary_key' => 'prepaynum',
2112       'unique'      => [ ['identifier'] ],
2113       'index'       => [],
2114     },
2115
2116     'port' => {
2117       'columns' => [
2118         'portnum',  'serial',     '',   '', '', '',
2119         'ip',       'varchar', 'NULL', 15, '', '',
2120         'nasport',  'int',     'NULL', '', '', '',
2121         'nasnum',   'int',     '',   '', '', '',
2122       ],
2123       'primary_key' => 'portnum',
2124       'unique'      => [],
2125       'index'       => [],
2126     },
2127
2128     'nas' => {
2129       'columns' => [
2130         'nasnum',   'serial',     '',    '', '', '',
2131         'nas',      'varchar', '',    $char_d, '', '',
2132         'nasip',    'varchar', '',    15, '', '',
2133         'nasfqdn',  'varchar', '',    $char_d, '', '',
2134         'last',     'int',     '',    '', '', '',
2135       ],
2136       'primary_key' => 'nasnum',
2137       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
2138       'index'       => [ [ 'last' ] ],
2139     },
2140
2141 #    'session' => {
2142 #      'columns' => [
2143 #        'sessionnum', 'serial',       '',   '', '', '',
2144 #        'portnum',    'int',       '',   '', '', '',
2145 #        'svcnum',     'int',       '',   '', '', '',
2146 #        'login',      @date_type, '', '',
2147 #        'logout',     @date_type, '', '',
2148 #      ],
2149 #      'primary_key' => 'sessionnum',
2150 #      'unique'      => [],
2151 #      'index'       => [ [ 'portnum' ] ],
2152 #    },
2153
2154     'queue' => {
2155       'columns' => [
2156         'jobnum',      'serial',     '',      '', '', '',
2157         'job',        'varchar',     '',     512, '', '',
2158         '_date',          'int',     '',      '', '', '',
2159         'status',     'varchar',     '', $char_d, '', '',
2160         'statustext',    'text', 'NULL',      '', '', '',
2161         'svcnum',         'int', 'NULL',      '', '', '',
2162         'custnum',        'int', 'NULL',      '', '', '',
2163         'secure',        'char', 'NULL',       1, '', '',
2164         'priority',       'int', 'NULL',      '', '', '',
2165       ],
2166       'primary_key' => 'jobnum',
2167       'unique'      => [],
2168       'index'       => [ [ 'secure' ], [ 'priority' ],
2169                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
2170                        ],
2171     },
2172
2173     'queue_arg' => {
2174       'columns' => [
2175         'argnum', 'serial', '', '', '', '',
2176         'jobnum', 'int', '', '', '', '',
2177         'frozen', 'char', 'NULL',       1, '', '',
2178         'arg', 'text', 'NULL', '', '', '',
2179       ],
2180       'primary_key' => 'argnum',
2181       'unique'      => [],
2182       'index'       => [ [ 'jobnum' ] ],
2183     },
2184
2185     'queue_depend' => {
2186       'columns' => [
2187         'dependnum', 'serial', '', '', '', '',
2188         'jobnum', 'int', '', '', '', '',
2189         'depend_jobnum', 'int', '', '', '', '',
2190       ],
2191       'primary_key' => 'dependnum',
2192       'unique'      => [],
2193       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
2194     },
2195
2196     'export_svc' => {
2197       'columns' => [
2198         'exportsvcnum' => 'serial', '', '', '', '',
2199         'exportnum'    => 'int', '', '', '', '',
2200         'svcpart'      => 'int', '', '', '', '',
2201       ],
2202       'primary_key' => 'exportsvcnum',
2203       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
2204       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
2205     },
2206
2207     'export_device' => {
2208       'columns' => [
2209         'exportdevicenum' => 'serial', '', '', '', '',
2210         'exportnum'    => 'int', '', '', '', '',
2211         'devicepart'      => 'int', '', '', '', '',
2212       ],
2213       'primary_key' => 'exportdevicenum',
2214       'unique'      => [ [ 'exportnum', 'devicepart' ] ],
2215       'index'       => [ [ 'exportnum' ], [ 'devicepart' ] ],
2216     },
2217
2218     'part_export' => {
2219       'columns' => [
2220         'exportnum', 'serial', '', '', '', '',
2221         'exportname', 'varchar', 'NULL', $char_d, '', '',
2222         'machine', 'varchar', '', $char_d, '', '',
2223         'exporttype', 'varchar', '', $char_d, '', '',
2224         'nodomain',     'char', 'NULL', 1, '', '',
2225       ],
2226       'primary_key' => 'exportnum',
2227       'unique'      => [],
2228       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
2229     },
2230
2231     'part_export_option' => {
2232       'columns' => [
2233         'optionnum', 'serial', '', '', '', '',
2234         'exportnum', 'int', '', '', '', '',
2235         'optionname', 'varchar', '', $char_d, '', '',
2236         'optionvalue', 'text', 'NULL', '', '', '',
2237       ],
2238       'primary_key' => 'optionnum',
2239       'unique'      => [],
2240       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
2241     },
2242
2243     'radius_usergroup' => {
2244       'columns' => [
2245         'usergroupnum', 'serial', '', '', '', '',
2246         'svcnum',       'int', '', '', '', '',
2247         'groupname',    'varchar', '', $char_d, '', '',
2248       ],
2249       'primary_key' => 'usergroupnum',
2250       'unique'      => [],
2251       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
2252     },
2253
2254     'msgcat' => {
2255       'columns' => [
2256         'msgnum', 'serial', '', '', '', '',
2257         'msgcode', 'varchar', '', $char_d, '', '',
2258         'locale', 'varchar', '', 16, '', '',
2259         'msg', 'text', '', '', '', '',
2260       ],
2261       'primary_key' => 'msgnum',
2262       'unique'      => [ [ 'msgcode', 'locale' ] ],
2263       'index'       => [],
2264     },
2265
2266     'cust_tax_exempt' => {
2267       'columns' => [
2268         'exemptnum', 'serial', '', '', '', '',
2269         'custnum',   'int', '', '', '', '',
2270         'taxnum',    'int', '', '', '', '',
2271         'year',      'int', '', '', '', '',
2272         'month',     'int', '', '', '', '',
2273         'amount',   @money_type, '', '',
2274       ],
2275       'primary_key' => 'exemptnum',
2276       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
2277       'index'       => [],
2278     },
2279
2280     'cust_tax_exempt_pkg' => {
2281       'columns' => [
2282         'exemptpkgnum',  'serial', '', '', '', '',
2283         #'custnum',      'int', '', '', '', ''
2284         'billpkgnum',   'int', '', '', '', '',
2285         'taxnum',       'int', '', '', '', '',
2286         'year',         'int', '', '', '', '',
2287         'month',        'int', '', '', '', '',
2288         'creditbillpkgnum', 'int', 'NULL', '', '', '',
2289         'amount',       @money_type, '', '',
2290       ],
2291       'primary_key' => 'exemptpkgnum',
2292       'unique' => [],
2293       'index'  => [ [ 'taxnum', 'year', 'month' ],
2294                     [ 'billpkgnum' ],
2295                     [ 'taxnum' ],
2296                     [ 'creditbillpkgnum' ],
2297                   ],
2298     },
2299
2300     'router' => {
2301       'columns' => [
2302         'routernum', 'serial', '', '', '', '',
2303         'routername', 'varchar', '', $char_d, '', '',
2304         'svcnum', 'int', 'NULL', '', '', '',
2305         'agentnum',   'int', 'NULL', '', '', '',
2306       ],
2307       'primary_key' => 'routernum',
2308       'unique'      => [],
2309       'index'       => [],
2310     },
2311
2312     'part_svc_router' => {
2313       'columns' => [
2314         'svcrouternum', 'serial', '', '', '', '',
2315         'svcpart', 'int', '', '', '', '',
2316         'routernum', 'int', '', '', '', '',
2317       ],
2318       'primary_key' => 'svcrouternum',
2319       'unique'      => [],
2320       'index'       => [],
2321     },
2322
2323     'addr_block' => {
2324       'columns' => [
2325         'blocknum', 'serial', '', '', '', '',
2326         'routernum', 'int', '', '', '', '',
2327         'ip_gateway', 'varchar', '', 15, '', '',
2328         'ip_netmask', 'int', '', '', '', '',
2329         'agentnum',   'int', 'NULL', '', '', '',
2330         'manual_flag', 'char', 'NULL', 1, '', '',
2331       ],
2332       'primary_key' => 'blocknum',
2333       'unique'      => [ [ 'blocknum', 'routernum' ] ],
2334       'index'       => [],
2335     },
2336
2337     'svc_broadband' => {
2338       'columns' => [
2339         'svcnum', 'int', '', '', '', '',
2340         'description', 'varchar', 'NULL', $char_d, '', '',
2341         'blocknum', 'int', 'NULL', '', '', '',
2342         'speed_up', 'int', '', '', '', '',
2343         'speed_down', 'int', '', '', '', '',
2344         'ip_addr', 'varchar', 'NULL', 15, '', '',
2345         'mac_addr', 'varchar', 'NULL', 12, '', '',
2346         'authkey',  'varchar', 'NULL', 32, '', '',
2347         'latitude', 'decimal', 'NULL', '', '', '',
2348         'longitude', 'decimal', 'NULL', '', '', '',
2349         'altitude', 'decimal', 'NULL', '', '', '',
2350         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
2351         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
2352       ],
2353       'primary_key' => 'svcnum',
2354       'unique'      => [ [ 'mac_addr' ] ],
2355       'index'       => [],
2356     },
2357
2358     'part_virtual_field' => {
2359       'columns' => [
2360         'vfieldpart', 'serial', '', '', '', '',
2361         'dbtable', 'varchar', '', 32, '', '',
2362         'name', 'varchar', '', 32, '', '',
2363         'check_block', 'text', 'NULL', '', '', '',
2364         'length', 'int', 'NULL', '', '', '',
2365         'list_source', 'text', 'NULL', '', '', '',
2366         'label', 'varchar', 'NULL', 80, '', '',
2367       ],
2368       'primary_key' => 'vfieldpart',
2369       'unique' => [],
2370       'index' => [],
2371     },
2372
2373     'virtual_field' => {
2374       'columns' => [
2375         'vfieldnum', 'serial', '', '', '', '',
2376         'recnum', 'int', '', '', '', '',
2377         'vfieldpart', 'int', '', '', '', '',
2378         'value', 'varchar', '', 128, '', '',
2379       ],
2380       'primary_key' => 'vfieldnum',
2381       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
2382       'index' => [],
2383     },
2384
2385     'acct_snarf' => {
2386       'columns' => [
2387         'snarfnum',    'serial',     '',      '', '', '',
2388         'snarfname',  'varchar', 'NULL', $char_d, '', '',
2389         'svcnum',         'int',     '',      '', '', '',
2390         'machine',    'varchar',     '',     255, '', '',
2391         'protocol',   'varchar',     '', $char_d, '', '',
2392         'username',   'varchar',     '', $char_d, '', '',
2393         '_password',  'varchar',     '', $char_d, '', '',
2394         'check_freq',     'int', 'NULL',      '', '', '',
2395         'leavemail',     'char', 'NULL',       1, '', '',
2396         'apop',          'char', 'NULL',       1, '', '',
2397         'tls',           'char', 'NULL',       1, '', '',
2398         'mailbox',    'varchar', 'NULL', $char_d, '', '',
2399       ],
2400       'primary_key' => 'snarfnum',
2401       'unique' => [],
2402       'index'  => [ [ 'svcnum' ] ],
2403     },
2404
2405     'svc_external' => {
2406       'columns' => [
2407         'svcnum', 'int', '', '', '', '',
2408         'id',     'int', 'NULL', '', '', '',
2409         'title',  'varchar', 'NULL', $char_d, '', '',
2410       ],
2411       'primary_key' => 'svcnum',
2412       'unique'      => [],
2413       'index'       => [],
2414     },
2415
2416     'cust_pay_refund' => {
2417       'columns' => [
2418         'payrefundnum', 'serial', '', '', '', '',
2419         'paynum',  'int', '', '', '', '',
2420         'refundnum',  'int', '', '', '', '',
2421         '_date',    @date_type, '', '',
2422         'amount',   @money_type, '', '',
2423       ],
2424       'primary_key' => 'payrefundnum',
2425       'unique' => [],
2426       'index' => [ ['paynum'], ['refundnum'] ],
2427     },
2428
2429     'part_pkg_option' => {
2430       'columns' => [
2431         'optionnum', 'serial', '', '', '', '',
2432         'pkgpart', 'int', '', '', '', '',
2433         'optionname', 'varchar', '', $char_d, '', '',
2434         'optionvalue', 'text', 'NULL', '', '', '',
2435       ],
2436       'primary_key' => 'optionnum',
2437       'unique'      => [],
2438       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
2439     },
2440
2441     'part_pkg_vendor' => {
2442       'columns' => [
2443         'num', 'serial', '', '', '', '',
2444         'pkgpart', 'int', '', '', '', '',
2445         'exportnum', 'int', '', '', '', '',
2446         'vendor_pkg_id', 'varchar', '', $char_d, '', '',
2447       ],
2448       'primary_key' => 'num',
2449       'unique' => [ [ 'pkgpart', 'exportnum' ] ],
2450       'index'       => [ [ 'pkgpart' ] ],
2451     },
2452
2453     'part_pkg_report_option' => {
2454       'columns' => [
2455         'num',      'serial',   '',      '', '', '',
2456         'name',     'varchar',  '', $char_d, '', '',
2457         'disabled', 'char', 'NULL',       1, '', '',
2458       ],
2459       'primary_key' => 'num',
2460       'unique' => [ [ 'name' ] ],
2461       'index' => [ [ 'disabled' ] ],
2462     },
2463
2464     'rate' => {
2465       'columns' => [
2466         'ratenum',  'serial', '', '', '', '',
2467         'ratename', 'varchar', '', $char_d, '', '',
2468       ],
2469       'primary_key' => 'ratenum',
2470       'unique'      => [],
2471       'index'       => [],
2472     },
2473
2474     'rate_detail' => {
2475       'columns' => [
2476         'ratedetailnum',   'serial',  '',     '', '', '',
2477         'ratenum',         'int',     '',     '', '', '',
2478         'orig_regionnum',  'int', 'NULL',     '', '', '',
2479         'dest_regionnum',  'int',     '',     '', '', '',
2480         'min_included',    'int',     '',     '', '', '',
2481         'conn_charge',     'decimal', '', '10,4', '0', '',
2482         'conn_sec',        'int',     '',     '', '0', '',
2483         'min_charge',      'decimal', '', '10,5', '', '', #@money_type, '', '',
2484         'sec_granularity', 'int',     '',     '', '', '',
2485         'ratetimenum',     'int', 'NULL',     '', '', '',
2486         'classnum',        'int', 'NULL',     '', '', '',
2487       ],
2488       'primary_key' => 'ratedetailnum',
2489       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
2490       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
2491     },
2492
2493     'rate_region' => {
2494       'columns' => [
2495         'regionnum',   'serial',      '', '', '', '',
2496         'regionname',  'varchar',     '', $char_d, '', '',
2497       ],
2498       'primary_key' => 'regionnum',
2499       'unique'      => [],
2500       'index'       => [],
2501     },
2502
2503     'rate_prefix' => {
2504       'columns' => [
2505         'prefixnum',   'serial',      '', '', '', '',
2506         'regionnum',   'int',         '', '', '', '',
2507         'countrycode', 'varchar',     '',  3, '', '',
2508         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
2509         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
2510       ],
2511       'primary_key' => 'prefixnum',
2512       'unique'      => [],
2513       'index'       => [ [ 'countrycode' ], [ 'npa' ], [ 'regionnum' ] ],
2514     },
2515
2516     'rate_time' => {
2517       'columns' => [
2518         'ratetimenum', 'serial',      '',      '', '', '',
2519         'ratetimename',   'varchar',      '', $char_d, '', '',
2520       ],
2521       'primary_key' => 'ratetimenum',
2522       'unique'      => [],
2523       'index'       => [],
2524     },
2525
2526     'rate_time_interval' => {
2527       'columns' => [
2528         'intervalnum', 'serial', '', '', '', '',
2529         'stime',          'int', '', '', '', '',
2530         'etime',          'int', '', '', '', '',
2531         'ratetimenum',    'int', '', '', '', '',
2532       ],
2533       'primary_key' => 'intervalnum',
2534       'unique'      => [],
2535       'index'       => [],
2536     },
2537
2538     'usage_class' => {
2539       'columns' => [
2540         'classnum',    'serial',      '',      '', '', '',
2541         'weight',      'int',     'NULL',      '', '', '',
2542         'classname',   'varchar',     '', $char_d, '', '',
2543         'format',      'varchar', 'NULL', $char_d, '', '',
2544         'disabled',    'char',    'NULL',       1, '', '',
2545       ],
2546       'primary_key' => 'classnum',
2547       'unique' => [],
2548       'index' => [ ['disabled'] ],
2549     },
2550
2551     'reg_code' => {
2552       'columns' => [
2553         'codenum',   'serial',    '', '', '', '',
2554         'code',      'varchar',   '', $char_d, '', '',
2555         'agentnum',  'int',       '', '', '', '',
2556       ],
2557       'primary_key' => 'codenum',
2558       'unique'      => [ [ 'agentnum', 'code' ] ],
2559       'index'       => [ [ 'agentnum' ] ],
2560     },
2561
2562     'reg_code_pkg' => {
2563       'columns' => [
2564         'codepkgnum', 'serial', '', '', '', '',
2565         'codenum',   'int',    '', '', '', '',
2566         'pkgpart',   'int',    '', '', '', '',
2567       ],
2568       'primary_key' => 'codepkgnum',
2569       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
2570       'index'       => [ [ 'codenum' ] ],
2571     },
2572
2573     'clientapi_session' => {
2574       'columns' => [
2575         'sessionnum',  'serial',  '', '', '', '',
2576         'sessionid',  'varchar',  '', $char_d, '', '',
2577         'namespace',  'varchar',  '', $char_d, '', '',
2578       ],
2579       'primary_key' => 'sessionnum',
2580       'unique'      => [ [ 'sessionid', 'namespace' ] ],
2581       'index'       => [],
2582     },
2583
2584     'clientapi_session_field' => {
2585       'columns' => [
2586         'fieldnum',    'serial',     '', '', '', '',
2587         'sessionnum',     'int',     '', '', '', '',
2588         'fieldname',  'varchar',     '', $char_d, '', '',
2589         'fieldvalue',    'text', 'NULL', '', '', '',
2590       ],
2591       'primary_key' => 'fieldnum',
2592       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
2593       'index'       => [],
2594     },
2595
2596     'payment_gateway' => {
2597       'columns' => [
2598         'gatewaynum',       'serial',   '',     '', '', '',
2599         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
2600         'gateway_module',   'varchar',  '',     $char_d, '', '',
2601         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
2602         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
2603         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
2604         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
2605         'disabled',   'char',  'NULL',   1, '', '',
2606       ],
2607       'primary_key' => 'gatewaynum',
2608       'unique' => [],
2609       'index'  => [ [ 'disabled' ] ],
2610     },
2611
2612     'payment_gateway_option' => {
2613       'columns' => [
2614         'optionnum',   'serial',  '',     '', '', '',
2615         'gatewaynum',  'int',     '',     '', '', '',
2616         'optionname',  'varchar', '',     $char_d, '', '',
2617         'optionvalue', 'text',    'NULL', '', '', '',
2618       ],
2619       'primary_key' => 'optionnum',
2620       'unique'      => [],
2621       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2622     },
2623
2624     'agent_payment_gateway' => {
2625       'columns' => [
2626         'agentgatewaynum', 'serial', '', '', '', '',
2627         'agentnum',        'int', '', '', '', '',
2628         'gatewaynum',      'int', '', '', '', '',
2629         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2630         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2631       ],
2632       'primary_key' => 'agentgatewaynum',
2633       'unique'      => [],
2634       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2635     },
2636
2637     'banned_pay' => {
2638       'columns' => [
2639         'bannum',  'serial',   '',     '', '', '',
2640         'payby',   'char',     '',       4, '', '',
2641         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2642         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2643         '_date',   @date_type, '', '',
2644         'otaker',  'varchar',  'NULL',     32, '', '',
2645         'usernum',   'int', 'NULL', '', '', '',
2646         'reason',  'varchar',  'NULL', $char_d, '', '',
2647       ],
2648       'primary_key' => 'bannum',
2649       'unique'      => [ [ 'payby', 'payinfo' ] ],
2650       'index'       => [ [ 'usernum' ] ],
2651     },
2652
2653     'pkg_category' => {
2654       'columns' => [
2655         'categorynum',   'serial',  '', '', '', '',
2656         'categoryname',  'varchar', '', $char_d, '', '',
2657         'weight',         'int', 'NULL',  '', '', '',
2658         'condense',      'char', 'NULL',   1, '', '',
2659         'disabled',      'char', 'NULL',   1, '', '',
2660       ],
2661       'primary_key' => 'categorynum',
2662       'unique' => [],
2663       'index' => [ ['disabled'] ],
2664     },
2665
2666     'pkg_class' => {
2667       'columns' => [
2668         'classnum',    'serial',   '',      '', '', '',
2669         'classname',   'varchar',  '', $char_d, '', '',
2670         'categorynum', 'int',  'NULL',      '', '', '',
2671         'disabled',    'char', 'NULL',       1, '', '',
2672       ],
2673       'primary_key' => 'classnum',
2674       'unique' => [],
2675       'index' => [ ['disabled'] ],
2676     },
2677
2678     'cdr' => {
2679       'columns' => [
2680         # qw( name type null length default local );
2681
2682         ###
2683         #asterisk fields
2684         ###
2685
2686         'acctid',   'bigserial',  '', '', '', '',
2687         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2688         'calldate', 'timestamp',   '',      '', \'now()', '',
2689         'clid',        'varchar',  '', $char_d, \"''", '',
2690         'src',         'varchar',  '', $char_d, \"''", '',
2691         'dst',         'varchar',  '', $char_d, \"''", '',
2692         'dcontext',    'varchar',  '', $char_d, \"''", '',
2693         'channel',     'varchar',  '', $char_d, \"''", '',
2694         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2695         'lastapp',     'varchar',  '', $char_d, \"''", '',
2696         'lastdata',    'varchar',  '', $char_d, \"''", '',
2697
2698         #these don't seem to be logged by most of the SQL cdr_* modules
2699         #except tds under sql-illegal names, so;
2700         # ... don't rely on them for rating?
2701         # and, what they hey, i went ahead and changed the names and data types
2702         # to freeside-style dates...
2703           #'start',  'timestamp', 'NULL',  '',    '', '',
2704           #'answer', 'timestamp', 'NULL',  '',    '', '',
2705           #'end',    'timestamp', 'NULL',  '',    '', '',
2706         'startdate',  @date_type, '', '',
2707         'answerdate', @date_type, '', '',
2708         'enddate',    @date_type, '', '',
2709         #
2710
2711         'duration',    'int',      '',      '',     0, '',
2712         'billsec',     'int',      '',      '',     0, '',
2713         'disposition', 'varchar',  '',      45, \"''", '',
2714         'amaflags',    'int',      '',      '',     0, '',
2715         'accountcode', 'varchar',  '',      20, \"''", '',
2716         'uniqueid',    'varchar',  '',      32, \"''", '',
2717         'userfield',   'varchar',  '',     255, \"''", '',
2718
2719         'max_callers', 'int',  'NULL',      '',    '', '',
2720
2721         ###
2722         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2723         # defaults
2724         # though these are now used elsewhere:
2725         # charged_party, upstream_price, rated_price, carrierid
2726         ###
2727
2728         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2729         'cdrtypenum',              'int', 'NULL',      '', '', '',
2730
2731         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2732
2733         'upstream_currency',      'char', 'NULL',       3, '', '',
2734         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2735         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2736
2737         # how it was rated internally...
2738         'ratedetailnum',           'int', 'NULL',      '', '', '',
2739         'rated_price',         'decimal', 'NULL',  '10,4', '', '',
2740
2741         'distance',            'decimal', 'NULL',      '', '', '',
2742         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2743
2744         #cdr_calltype: the big list in appendix 2
2745         'calltypenum',             'int', 'NULL',      '', '', '',
2746
2747         'description',         'varchar', 'NULL', $char_d, '', '',
2748         'quantity',                'int', 'NULL',      '', '', '',
2749
2750         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2751         'carrierid',               'int', 'NULL',      '', '', '',
2752
2753         'upstream_rateid',         'int', 'NULL',      '', '', '',
2754
2755         ###
2756         #and now for our own fields
2757         ###
2758
2759         # a svcnum... right..?
2760         'svcnum',             'int',   'NULL',     '',   '', '',
2761
2762         #NULL, done (or something)
2763         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2764
2765         #NULL, done (or something)
2766         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2767
2768         #an indexed place to put big numbers
2769         'cdrid',         'bigint',     'NULL',     '',  '', '',
2770
2771         #old
2772         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2773         #new
2774         'cdrbatchnum', 'int', 'NULL', '', '', '',
2775
2776       ],
2777       'primary_key' => 'acctid',
2778       'unique' => [],
2779       'index' => [ [ 'calldate' ],
2780                    [ 'src' ], [ 'dst' ], [ 'dcontext' ], [ 'charged_party' ],
2781                    [ 'accountcode' ], [ 'carrierid' ], [ 'cdrid' ],
2782                    [ 'freesidestatus' ], [ 'freesiderewritestatus' ],
2783                    [ 'cdrbatch' ], [ 'cdrbatchnum' ],
2784                  ],
2785     },
2786
2787     'cdr_batch' => {
2788       'columns' => [
2789         'cdrbatchnum',   'serial',    '',   '', '', '',
2790         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2791         '_date',     @date_type, '', '',
2792       ],
2793       'primary_key' => 'cdrbatchnum',
2794       'unique' => [ [ 'cdrbatch' ] ],
2795       'index' => [],
2796     },
2797
2798     'cdr_termination' => {
2799       'columns' => [
2800         'cdrtermnum', 'bigserial',     '',      '', '', '',
2801         'acctid',        'bigint',     '',      '', '', '',
2802         'termpart',         'int',     '',      '', '', '',#future use see below
2803         'rated_price',  'decimal', 'NULL',  '10,4', '', '',
2804         'status',       'varchar', 'NULL',      32, '', '',
2805         'svcnum',           'int', 'NULL',      '', '', '',
2806       ],
2807       'primary_key' => 'cdrtermnum',
2808       'unique'      => [ [ 'acctid', 'termpart' ] ],
2809       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2810     },
2811
2812     #to handle multiple termination/settlement passes...
2813    # 'part_termination' => {
2814    #   'columns' => [
2815    #     'termpart',       'int', '',      '', '', '',
2816    #     'termname',   'varchar', '', $char_d, '', '',
2817    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2818    #   ],
2819    #   'primary_key' => 'termpart',
2820    #   'unique' => [],
2821    #   'index'  => [],
2822    # },
2823
2824     #the remaining cdr_ tables are not really used
2825     'cdr_calltype' => {
2826       'columns' => [
2827         'calltypenum',   'serial',  '', '', '', '',
2828         'calltypename',  'varchar', '', $char_d, '', '',
2829       ],
2830       'primary_key' => 'calltypenum',
2831       'unique'      => [],
2832       'index'       => [],
2833     },
2834
2835     'cdr_type' => {
2836       'columns' => [
2837         'cdrtypenum'  => 'serial',  '', '', '', '',
2838         'cdrtypename' => 'varchar', '', $char_d, '', '',
2839       ],
2840       'primary_key' => 'cdrtypenum',
2841       'unique'      => [],
2842       'index'       => [],
2843     },
2844
2845     'cdr_carrier' => {
2846       'columns' => [
2847         'carrierid'   => 'serial',  '', '', '', '',
2848         'carriername' => 'varchar', '', $char_d, '', '',
2849       ],
2850       'primary_key' => 'carrierid',
2851       'unique'      => [],
2852       'index'       => [],
2853     },
2854
2855     #'cdr_file' => {
2856     #  'columns' => [
2857     #    'filenum',    'serial',     '', '', '', '',
2858     #    'filename',  'varchar',     '', '', '', '',
2859     #    'status',    'varchar', 'NULL', '', '', '',
2860     #  ],
2861     #  'primary_key' => 'filenum',
2862     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2863     #                                   # agent-virtualize or have a customer
2864     #                                   # with dup-filename needs or something
2865     #                                   # (only used by cdr.http_and_import for
2866     #                                   #  chrissakes)
2867     #  'index'  => [],
2868     #},
2869
2870     'inventory_item' => {
2871       'columns' => [
2872         'itemnum',  'serial',      '',      '', '', '',
2873         'classnum', 'int',         '',      '', '', '',
2874         'agentnum', 'int',     'NULL',      '', '', '',
2875         'item',     'varchar',     '', $char_d, '', '',
2876         'svcnum',   'int',     'NULL',      '', '', '',
2877       ],
2878       'primary_key' => 'itemnum',
2879       'unique' => [ [ 'classnum', 'item' ] ],
2880       'index'  => [ [ 'classnum' ], [ 'agentnum' ], [ 'svcnum' ] ],
2881     },
2882
2883     'inventory_class' => {
2884       'columns' => [
2885         'classnum',  'serial',       '',      '', '', '',
2886         'classname', 'varchar',      '', $char_d, '', '',
2887       ],
2888       'primary_key' => 'classnum',
2889       'unique' => [],
2890       'index'  => [],
2891     },
2892
2893     'access_user' => {
2894       'columns' => [
2895         'usernum',   'serial',  '',      '', '', '',
2896         'username',  'varchar', '', $char_d, '', '',
2897         '_password', 'varchar', '', $char_d, '', '',
2898         'last',      'varchar', '', $char_d, '', '',
2899         'first',     'varchar', '', $char_d, '', '',
2900         'user_custnum',  'int', 'NULL',  '', '', '',
2901         'disabled',     'char', 'NULL',   1, '', '',
2902       ],
2903       'primary_key' => 'usernum',
2904       'unique' => [ [ 'username' ] ],
2905       'index'  => [ [ 'user_custnum' ] ],
2906     },
2907
2908     'access_user_pref' => {
2909       'columns' => [
2910         'prefnum',    'serial',       '', '', '', '',
2911         'usernum',     'int',       '', '', '', '',
2912         'prefname', 'varchar', '', $char_d, '', '',
2913         'prefvalue', 'text', 'NULL', '', '', '',
2914         'expiration', @date_type, '', '',
2915       ],
2916       'primary_key' => 'prefnum',
2917       'unique' => [],
2918       'index'  => [ [ 'usernum' ] ],
2919     },
2920
2921     'access_group' => {
2922       'columns' => [
2923         'groupnum',   'serial', '',      '', '', '',
2924         'groupname', 'varchar', '', $char_d, '', '',
2925       ],
2926       'primary_key' => 'groupnum',
2927       'unique' => [ [ 'groupname' ] ],
2928       'index'  => [],
2929     },
2930
2931     'access_usergroup' => {
2932       'columns' => [
2933         'usergroupnum', 'serial', '', '', '', '',
2934         'usernum',         'int', '', '', '', '',
2935         'groupnum',        'int', '', '', '', '',
2936       ],
2937       'primary_key' => 'usergroupnum',
2938       'unique' => [ [ 'usernum', 'groupnum' ] ],
2939       'index'  => [ [ 'usernum' ] ],
2940     },
2941
2942     'access_groupagent' => {
2943       'columns' => [
2944         'groupagentnum', 'serial', '', '', '', '',
2945         'groupnum',         'int', '', '', '', '',
2946         'agentnum',         'int', '', '', '', '',
2947       ],
2948       'primary_key' => 'groupagentnum',
2949       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2950       'index'  => [ [ 'groupnum' ] ],
2951     },
2952
2953     'access_right' => {
2954       'columns' => [
2955         'rightnum',   'serial', '',      '', '', '',
2956         'righttype', 'varchar', '', $char_d, '', '',
2957         'rightobjnum',   'int', '',      '', '', '',
2958         'rightname', 'varchar', '', $char_d, '', '',
2959       ],
2960       'primary_key' => 'rightnum',
2961       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2962       'index'  => [],
2963     },
2964
2965     'svc_phone' => {
2966       'columns' => [
2967         'svcnum',       'int',         '',      '', '', '',
2968         'countrycode',  'varchar',     '',       3, '', '',
2969         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2970         'pin',          'varchar', 'NULL', $char_d, '', '',
2971         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2972         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2973         'pbxsvc',           'int', 'NULL',      '', '', '',
2974         'domsvc',           'int', 'NULL',      '', '', '',
2975         'locationnum',      'int', 'NULL', '', '', '',
2976         'route',   'varchar', 'NULL', $char_d, '', '',
2977         'lnp_status',   'varchar', 'NULL', $char_d, '', '',
2978         'portable',     'char', 'NULL',       1,  '', '',
2979         'lrn',     'char',     'NULL',      10, '', '',
2980         'lnp_desired_due_date',     'int', 'NULL',       '', '', '',
2981         'lnp_due_date',     'int', 'NULL',       '', '', '',
2982         'lnp_other_provider', 'varchar', 'NULL', $char_d,  '', '',
2983         'lnp_other_provider_account', 'varchar', 'NULL', $char_d,  '', '',
2984         'lnp_reject_reason', 'varchar', 'NULL', $char_d,  '', '',
2985       ],
2986       'primary_key' => 'svcnum',
2987       'unique' => [],
2988       'index'  => [ ['countrycode', 'phonenum'], ['pbxsvc'], ['domsvc'],
2989                     ['locationnum'],
2990                   ],
2991     },
2992
2993     'phone_device' => {
2994       'columns' => [
2995         'devicenum', 'serial',     '', '', '', '',
2996         'devicepart',   'int',     '', '', '', '',
2997         'svcnum',       'int',     '', '', '', '',
2998         'mac_addr', 'varchar', 'NULL', 12, '', '',
2999       ],
3000       'primary_key' => 'devicenum',
3001       'unique' => [ [ 'mac_addr' ], ],
3002       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
3003     },
3004
3005     'part_device' => {
3006       'columns' => [
3007         'devicepart', 'serial',  '',      '', '', '',
3008         'devicename', 'varchar', '', $char_d, '', '',
3009         #'classnum', #tie to an inventory class?
3010       ],
3011       'primary_key' => 'devicepart',
3012       'unique' => [ [ 'devicename' ] ], #?
3013       'index'  => [],
3014     },
3015
3016     'phone_avail' => {
3017       'columns' => [
3018         'availnum',    'serial',      '',      '', '', '',
3019         'exportnum',   'int',         '',      '', '', '',
3020         'countrycode', 'varchar',     '',       3, '', '',
3021         'state',       'char',    'NULL',       2, '', '',
3022         'npa',         'char',        '',       3, '', '',
3023         'nxx',         'char',    'NULL',       3, '', '',
3024         'station',     'char',    'NULL',       4, '', '',
3025         'name',        'varchar', 'NULL', $char_d, '', '',
3026         'svcnum',      'int',     'NULL',      '', '', '',
3027         'availbatch', 'varchar',  'NULL', $char_d, '', '',
3028       ],
3029       'primary_key' => 'availnum',
3030       'unique' => [],
3031       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
3032                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
3033                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
3034                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
3035                     [ 'svcnum' ],
3036                     [ 'availbatch' ],
3037                   ],
3038     },
3039
3040     'reason_type' => {
3041       'columns' => [
3042         'typenum',   'serial',  '', '', '', '',
3043         'class',     'char', '', 1, '', '',
3044         'type',     'varchar', '', $char_d, '', '',
3045       ],
3046       'primary_key' => 'typenum',
3047       'unique' => [],
3048       'index' => [],
3049     },
3050
3051     'reason' => {
3052       'columns' => [
3053         'reasonnum',     'serial',  '', '', '', '',
3054         'reason_type',   'int',  '', '', '', '',
3055         'reason',        'text', '', '', '', '',
3056         'disabled',      'char',    'NULL', 1, '', '',
3057       ],
3058       'primary_key' => 'reasonnum',
3059       'unique' => [],
3060       'index' => [],
3061     },
3062
3063     'conf' => {
3064       'columns' => [
3065         'confnum',  'serial',  '', '', '', '',
3066         'agentnum', 'int',  'NULL', '', '', '',
3067         'name',     'varchar', '', $char_d, '', '',
3068         'value',    'text', 'NULL', '', '', '',
3069       ],
3070       'primary_key' => 'confnum',
3071       'unique' => [ [ 'agentnum', 'name' ]],
3072       'index' => [],
3073     },
3074
3075     'pkg_referral' => {
3076       'columns' => [
3077         'pkgrefnum',     'serial', '', '', '', '',
3078         'pkgnum',        'int',    '', '', '', '',
3079         'refnum',        'int',    '', '', '', '',
3080       ],
3081       'primary_key' => 'pkgrefnum',
3082       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
3083       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
3084     },
3085
3086     'svc_pbx' => {
3087       'columns' => [
3088         'svcnum',           'int',     '',      '', '', '',
3089         'id',               'int', 'NULL',      '', '', '',
3090         'title',        'varchar', 'NULL', $char_d, '', '',
3091         'max_extensions',   'int', 'NULL',      '', '', '',
3092         'max_simultaneous', 'int', 'NULL',      '', '', '',
3093       ],
3094       'primary_key' => 'svcnum',
3095       'unique' => [],
3096       'index'  => [ [ 'id' ] ],
3097     },
3098
3099     'svc_mailinglist' => { #svc_group?
3100       'columns' => [
3101         'svcnum',            'int',     '',            '', '', '',
3102         'username',      'varchar',     '', $username_len, '', '',
3103         'domsvc',            'int',     '',            '', '', '',
3104         'listnum',           'int',     '',            '', '', '',
3105         'reply_to',         'char', 'NULL',             1, '', '',#SetReplyTo
3106         'remove_from',      'char', 'NULL',             1, '', '',#RemoveAuthor
3107         'reject_auto',      'char', 'NULL',             1, '', '',#RejectAuto
3108         'remove_to_and_cc', 'char', 'NULL',             1, '', '',#RemoveToAndCc
3109       ],
3110       'primary_key' => 'svcnum',
3111       'unique' => [],
3112       'index'  => [ ['username'], ['domsvc'], ['listnum'] ],
3113     },
3114
3115     'mailinglist' => {
3116       'columns' => [
3117         'listnum',   'serial', '',      '', '', '',
3118         'listname', 'varchar', '', $char_d, '', '',
3119       ],
3120       'primary_key' => 'listnum',
3121       'unique' => [],
3122       'index'  => [],
3123     },
3124
3125     'mailinglistmember' => {
3126       'columns' => [
3127         'membernum',        'serial',     '',   '', '', '',
3128         'listnum',             'int',     '',   '', '', '',
3129         'svcnum',              'int', 'NULL',   '', '', '',
3130         'contactemailnum',     'int', 'NULL',   '', '', '',
3131         'email',           'varchar', 'NULL',  255, '', '',
3132       ],
3133       'primary_key' => 'membernum',
3134       'unique'      => [],
3135       'index'       => [['listnum'],['svcnum'],['contactemailnum'],['email']],
3136     },
3137
3138     'bill_batch' => {
3139       'columns' => [
3140         'batchnum',         'serial',     '', '', '', '',
3141         'status',             'char', 'NULL','1', '', '',
3142         'pdf',                'blob', 'NULL', '', '', '',
3143       ],
3144       'primary_key' => 'batchnum',
3145       'unique'      => [],
3146       'index'       => [],
3147     },
3148
3149     'cust_bill_batch' => {
3150       'columns' => [
3151         'billbatchnum',     'serial',     '', '', '', '',
3152         'batchnum',            'int',     '', '', '', '',
3153         'invnum',              'int',     '', '', '', '',
3154       ],
3155       'primary_key' => 'billbatchnum',
3156       'unique'      => [],
3157       'index'       => [ [ 'batchnum' ], [ 'invnum' ] ],
3158     },
3159
3160     'cust_bill_batch_option' => {
3161       'columns' => [
3162         'optionnum', 'serial', '', '', '', '',
3163         'billbatchnum', 'int', '', '', '', '',
3164         'optionname', 'varchar', '', $char_d, '', '',
3165         'optionvalue', 'text', 'NULL', '', '', '',
3166       ],
3167       'primary_key' => 'optionnum',
3168       'unique'      => [],
3169       'index'       => [ [ 'billbatchnum' ], [ 'optionname' ] ],
3170     },
3171
3172     'msg_template' => {
3173       'columns' => [
3174         'msgnum',     'serial',     '',      '', '', '',
3175         'msgname',   'varchar',     '', $char_d, '', '',
3176         'agentnum',      'int', 'NULL',      '', '', '',
3177         'subject',   'varchar', 'NULL',     512, '', '',
3178         'mime_type', 'varchar',     '', $char_d, '', '',
3179         'body',         'blob', 'NULL',      '', '', '',
3180         'disabled',     'char', 'NULL',       1, '', '',
3181         'from_addr', 'varchar', 'NULL',     255, '', '',
3182         'bcc_addr',  'varchar', 'NULL',     255, '', '',
3183       ],
3184       'primary_key' => 'msgnum',
3185       'unique'      => [ ['msgname', 'mime_type'] ],
3186       'index'       => [ ['agentnum'], ]
3187     },
3188
3189     'svc_cert' => {
3190       'columns' => [
3191         'svcnum',                'int',     '',      '', '', '',
3192         'recnum',                'int', 'NULL',      '', '', '',
3193         'privatekey',           'text', 'NULL',      '', '', '',
3194         'csr',                  'text', 'NULL',      '', '', '',
3195         'certificate',          'text', 'NULL',      '', '', '',
3196         'cacert',               'text', 'NULL',      '', '', '',
3197         'common_name',       'varchar', 'NULL', $char_d, '', '',
3198         'organization',      'varchar', 'NULL', $char_d, '', '',
3199         'organization_unit', 'varchar', 'NULL', $char_d, '', '',
3200         'city',              'varchar', 'NULL', $char_d, '', '',
3201         'state',             'varchar', 'NULL', $char_d, '', '',
3202         'country',              'char', 'NULL',       2, '', '',
3203         'cert_contact',      'varchar', 'NULL', $char_d, '', '',
3204       ],
3205       'primary_key' => 'svcnum',
3206       'unique' => [],
3207       'index'  => [], #recnum
3208     },
3209
3210     'nms_device' => {
3211       'columns' => [
3212         'nms_devicenum', 'serial',     '',      '', '', '',
3213         #'agentnum',         'int', 'NULL',      '', '', '',
3214         'devicename',   'varchar',     '', $char_d, '', '',
3215         'ip',           'varchar',     '',      15, '', '',
3216         'protocol',     'varchar',     '', $char_d, '', '',
3217 #        'last',     'int',     '',    '', '', '',
3218       ],
3219       'primary_key' => 'nms_devicenum',
3220       'unique' => [],
3221       'index'  => [],
3222     },
3223
3224     'nms_deviceport' => {
3225       'columns' => [
3226         'portnum',       'serial',     '', '', '', '',
3227         'nms_devicenum',    'int',     '', '', '', '',
3228         'deviceport',       'int',     '', '', '', '',
3229         #'ip',       'varchar', 'NULL', 15, '', '',
3230         'svcnum',           'int', 'NULL', '', '', '',
3231       ],
3232       'primary_key' => 'portnum',
3233       'unique'      => [ [ 'nms_devicenum', 'deviceport' ] ],
3234       'index'       => [ [ 'svcnum' ] ],
3235     },
3236
3237     'svc_port' => {
3238       'columns' => [
3239         'svcnum',                'int',     '',      '', '', '',
3240       ],
3241       'primary_key' => 'svcnum',
3242       'unique' => [],
3243       'index'  => [], #recnum
3244     },
3245
3246     %{ tables_hashref_torrus() },
3247
3248
3249     # name type nullability length default local
3250
3251     #'new_table' => {
3252     #  'columns' => [
3253     #    'num', 'serial',       '', '', '', '',
3254     #  ],
3255     #  'primary_key' => 'num',
3256     #  'unique' => [],
3257     #  'index'  => [],
3258     #},
3259
3260   };
3261
3262 }
3263
3264 =back
3265
3266 =head1 BUGS
3267
3268 =head1 SEE ALSO
3269
3270 L<DBIx::DBSchema>
3271
3272 =cut
3273
3274 1;
3275