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       unless ( defined $hash{'default'} ) {
 106         warn "$tablename:\n".
 107              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
 108       }
 109
 110       push @columns, new DBIx::DBSchema::Column ( \%hash );
 111     }
 112
 113     #false laziness w/sub indices in DBIx::DBSchema::DBD (well, sorta)
 114     #and sub sql_create_table in DBIx::DBSchema::Table (slighty more?)
 115     my $unique = $tables_hashref->{$tablename}{'unique'};
 116     my $index  = $tables_hashref->{$tablename}{'index'};
 117     my @indices = ();
 118     push @indices, map {
 119                          DBIx::DBSchema::Index->new({
 120                            'name'    => $tablename. $indexnum++,
 121                            'unique'  => 1,
 122                            'columns' => $_,
 123                          });
 124                        }
 125                        @$unique;
 126     push @indices, map {
 127                          DBIx::DBSchema::Index->new({
 128                            'name'    => $tablename. $indexnum++,
 129                            'unique'  => 0,
 130                            'columns' => $_,
 131                          });
 132                        }
 133                        @$index;
 134
 135     DBIx::DBSchema::Table->new({
 136       'name'          => $tablename,
 137       'primary_key'   => $tables_hashref->{$tablename}{'primary_key'},
 138       'columns'       => \@columns,
 139       'indices'       => \@indices,
 140       'local_options' => $local_options,
 141     });
 142
 143   } keys %$tables_hashref;
 144
 145   if ( $DEBUG ) {
 146     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 147     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 148   }
 149
 150   #add radius attributes to svc_acct
 151   #
 152   #my($svc_acct)=$dbdef->table('svc_acct');
 153   #
 154   #my($attribute);
 155   #foreach $attribute (@attributes) {
 156   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 157   #    'radius_'. $attribute,
 158   #    'varchar',
 159   #    'NULL',
 160   #    $char_d,
 161   #  ));
 162   #}
 163   #
 164   #foreach $attribute (@check_attributes) {
 165   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 166   #    'rc_'. $attribute,
 167   #    'varchar',
 168   #    'NULL',
 169   #    $char_d,
 170   #  ));
 171   #}
 172
 173   #create history tables (false laziness w/create-history-tables)
 174   foreach my $table (
 175     grep { ! /^clientapi_session/ }
 176     grep { ! /^h_/ }
 177     $dbdef->tables
 178   ) {
 179     my $tableobj = $dbdef->table($table)
 180       or die "unknown table $table";
 181
 182     my %indices = $tableobj->indices;
 183
 184     my %h_indices = map {
 185                           ( "h_$_" =>
 186                               DBIx::DBSchema::Index->new({
 187                                 'name'    => 'h_'. $indices{$_}->name,
 188                                 'unique'  => 0,
 189                                 'columns' => [ @{$indices{$_}->columns} ],
 190                               })
 191                           );
 192                         }
 193                         keys %indices;
 194
 195     $h_indices{"h_${table}_srckey"} = DBIx::DBSchema::Index->new({
 196                                         'name'    => "h_${table}_srckey",
 197                                         'unique'  => 0,
 198                                         'columns' => [ 'history_action', #right?
 199                                                        $tableobj->primary_key,
 200                                                      ],
 201                                       });
 202
 203     $h_indices{"h_${table}_srckey2"} = DBIx::DBSchema::Index->new({
 204                                          'name'    => "h_${table}_srckey2",
 205                                          'unique'  => 0,
 206                                          'columns' => [ 'history_date',
 207                                                         $tableobj->primary_key,
 208                                                       ],
 209                                        });
 210
 211     my $h_tableobj = DBIx::DBSchema::Table->new( {
 212       'name'          => "h_$table",
 213       'primary_key'   => 'historynum',
 214       'indices'       => \%h_indices,
 215       'local_options' => $local_options,
 216       'columns'       => [
 217           DBIx::DBSchema::Column->new( {
 218             'name'    => 'historynum',
 219             'type'    => 'serial',
 220             'null'    => 'NOT NULL',
 221             'length'  => '',
 222             'default' => '',
 223             'local'   => '',
 224           } ),
 225           DBIx::DBSchema::Column->new( {
 226             'name'    => 'history_date',
 227             'type'    => 'int',
 228             'null'    => 'NULL',
 229             'length'  => '',
 230             'default' => '',
 231             'local'   => '',
 232           } ),
 233           DBIx::DBSchema::Column->new( {
 234             'name'    => 'history_user',
 235             'type'    => 'varchar',
 236             'null'    => 'NOT NULL',
 237             'length'  => '80',
 238             'default' => '',
 239             'local'   => '',
 240           } ),
 241           DBIx::DBSchema::Column->new( {
 242             'name'    => 'history_action',
 243             'type'    => 'varchar',
 244             'null'    => 'NOT NULL',
 245             'length'  => '80',
 246             'default' => '',
 247             'local'   => '',
 248           } ),
 249           map {
 250             my $column = $tableobj->column($_);
 251
 252             #clone so as to not disturb the original
 253             $column = DBIx::DBSchema::Column->new( {
 254               map { $_ => $column->$_() }
 255                 qw( name type null length default local )
 256             } );
 257
 258             if ( $column->type =~ /^(\w*)SERIAL$/i ) {
 259               $column->type('int');
 260               $column->null('NULL');
 261             }
 262             #$column->default('')
 263             #  if $column->default =~ /^nextval\(/i;
 264             #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 265             #$column->local($local);
 266             $column;
 267           } $tableobj->columns
 268       ],
 269     } );
 270     $dbdef->addtable($h_tableobj);
 271   }
 272
 273   if ( $datasrc =~ /^dbi:mysql/i ) {
 274
 275     my $dup_lock_table = DBIx::DBSchema::Table->new( {
 276       'name'          => 'duplicate_lock',
 277       'primary_key'   => 'duplocknum',
 278       'local_options' => $local_options,
 279       'columns'       => [
 280         DBIx::DBSchema::Column->new( {
 281           'name'    => 'duplocknum',
 282           'type'    => 'serial',
 283           'null'    => 'NOT NULL',
 284           'length'  => '',
 285           'default' => '',
 286           'local'   => '',
 287         } ),
 288         DBIx::DBSchema::Column->new( {
 289           'name'    => 'lockname',
 290           'type'    => 'varchar',
 291           'null'    => 'NOT NULL',
 292           'length'  => '80',
 293           'default' => '',
 294           'local'   => '',
 295         } ),
 296       ],
 297       'indices' => { 'duplicate_lock1' =>
 298                        DBIx::DBSchema::Index->new({
 299                          'name'    => 'duplicate_lock1',
 300                          'unique'  => 1,
 301                          'columns' => [ 'lockname' ],
 302                        })
 303                    },
 304     } );
 305
 306     $dbdef->addtable($dup_lock_table);
 307
 308   }
 309
 310   $dbdef;
 311
 312 }
 313
 314 sub tables_hashref {
 315
 316   my $char_d = 80; #default maxlength for text fields
 317
 318   #my(@date_type)  = ( 'timestamp', '', ''     );
 319   my @date_type  = ( 'int', 'NULL', ''     );
 320   my @perl_type = ( 'text', 'NULL', ''  );
 321   my @money_type = ( 'decimal',   '', '10,2' );
 322   my @money_typen = ( 'decimal',   'NULL', '10,2' );
 323   my @taxrate_type  = ( 'decimal',   '',     '14,8' ); # requires pg 8 for
 324   my @taxrate_typen = ( 'decimal',   'NULL', '14,8' ); # fs-upgrade to work
 325
 326   my $username_len = 32; #usernamemax config file
 327
 328     # name type nullability length default local
 329
 330   return {
 331
 332     'agent' => {
 333       'columns' => [
 334         'agentnum',          'serial',    '',       '', '', '',
 335         'agent',            'varchar',    '',  $char_d, '', '',
 336         'typenum',              'int',    '',       '', '', '',
 337         'ticketing_queueid',    'int', 'NULL',      '', '', '',
 338         'invoice_template', 'varchar', 'NULL', $char_d, '', '',
 339         'agent_custnum',        'int', 'NULL',      '', '', '',
 340         'disabled',            'char', 'NULL',       1, '', '',
 341         'username',         'varchar', 'NULL', $char_d, '', '', #deprecated
 342         '_password',        'varchar', 'NULL', $char_d, '', '', #deprecated
 343         'freq',              'int', 'NULL', '', '', '', #deprecated (never used)
 344         'prog',                     @perl_type, '', '', #deprecated (never used)
 345       ],
 346       'primary_key' => 'agentnum',
 347       #'unique' => [ [ 'agent_custnum' ] ], #one agent per customer?
 348                                             #insert is giving it a value, tho..
 349       #'index' => [ ['typenum'], ['disabled'] ],
 350       'unique' => [],
 351       'index' => [ ['typenum'], ['disabled'], ['agent_custnum'] ],
 352     },
 353
 354     'agent_type' => {
 355       'columns' => [
 356         'typenum',   'serial',  '', '', '', '',
 357         'atype',     'varchar', '', $char_d, '', '',
 358       ],
 359       'primary_key' => 'typenum',
 360       'unique' => [],
 361       'index' => [],
 362     },
 363
 364     'type_pkgs' => {
 365       'columns' => [
 366         'typepkgnum', 'serial', '', '', '', '',
 367         'typenum',   'int',  '', '', '', '',
 368         'pkgpart',   'int',  '', '', '', '',
 369       ],
 370       'primary_key' => 'typepkgnum',
 371       'unique' => [ ['typenum', 'pkgpart'] ],
 372       'index' => [ ['typenum'] ],
 373     },
 374
 375     'cust_bill' => {
 376       'columns' => [
 377         'invnum',    'serial',  '', '', '', '',
 378         'custnum',   'int',  '', '', '', '',
 379         '_date',     @date_type, '', '',
 380         'charged',   @money_type, '', '',
 381         'printed',   'int',  '', '', '', '',
 382         'closed',    'char', 'NULL', 1, '', '',
 383       ],
 384       'primary_key' => 'invnum',
 385       'unique' => [],
 386       'index' => [ ['custnum'], ['_date'] ],
 387     },
 388
 389     'cust_bill_event' => {
 390       'columns' => [
 391         'eventnum',    'serial',  '', '', '', '',
 392         'invnum',   'int',  '', '', '', '',
 393         'eventpart',   'int',  '', '', '', '',
 394         '_date',     @date_type, '', '',
 395         'status', 'varchar', '', $char_d, '', '',
 396         'statustext', 'text', 'NULL', '', '', '',
 397       ],
 398       'primary_key' => 'eventnum',
 399       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 400       'unique' => [],
 401       'index' => [ ['invnum'], ['status'], ['eventpart'],
 402                    ['statustext'], ['_date'],
 403                  ],
 404     },
 405
 406     'part_bill_event' => {
 407       'columns' => [
 408         'eventpart',    'serial',  '', '', '', '',
 409         'freq',        'varchar',       'NULL',     $char_d, '', '',
 410         'payby',       'char',  '', 4, '', '',
 411         'event',       'varchar',           '',     $char_d, '', '',
 412         'eventcode',    @perl_type, '', '',
 413         'seconds',     'int', 'NULL', '', '', '',
 414         'weight',      'int', '', '', '', '',
 415         'plan',       'varchar', 'NULL', $char_d, '', '',
 416         'plandata',   'text', 'NULL', '', '', '',
 417         'reason',     'int', 'NULL', '', '', '',
 418         'disabled',     'char', 'NULL', 1, '', '',
 419       ],
 420       'primary_key' => 'eventpart',
 421       'unique' => [],
 422       'index' => [ ['payby'], ['disabled'], ],
 423     },
 424
 425     'part_event' => {
 426       'columns' => [
 427         'eventpart',   'serial',      '',      '', '', '',
 428         'agentnum',    'int',     'NULL',      '', '', '',
 429         'event',       'varchar',     '', $char_d, '', '',
 430         'eventtable',  'varchar',     '', $char_d, '', '',
 431         'check_freq',  'varchar', 'NULL', $char_d, '', '',
 432         'weight',      'int',         '',      '', '', '',
 433         'action',      'varchar',     '', $char_d, '', '',
 434         'disabled',     'char',   'NULL',       1, '', '',
 435       ],
 436       'primary_key' => 'eventpart',
 437       'unique' => [],
 438       'index' => [ ['agentnum'], ['eventtable'], ['check_freq'], ['disabled'], ],
 439     },
 440
 441     'part_event_option' => {
 442       'columns' => [
 443         'optionnum', 'serial', '', '', '', '',
 444         'eventpart', 'int', '', '', '', '',
 445         'optionname', 'varchar', '', $char_d, '', '',
 446         'optionvalue', 'text', 'NULL', '', '', '',
 447       ],
 448       'primary_key' => 'optionnum',
 449       'unique'      => [],
 450       'index'       => [ [ 'eventpart' ], [ 'optionname' ] ],
 451     },
 452
 453     'part_event_condition' => {
 454       'columns' => [
 455         'eventconditionnum', 'serial', '', '', '', '',
 456         'eventpart', 'int', '', '', '', '',
 457         'conditionname', 'varchar', '', $char_d, '', '',
 458       ],
 459       'primary_key' => 'eventconditionnum',
 460       'unique'      => [],
 461       'index'       => [ [ 'eventpart' ], [ 'conditionname' ] ],
 462     },
 463
 464     'part_event_condition_option' => {
 465       'columns' => [
 466         'optionnum', 'serial', '', '', '', '',
 467         'eventconditionnum', 'int', '', '', '', '',
 468         'optionname', 'varchar', '', $char_d, '', '',
 469         'optionvalue', 'text', 'NULL', '', '', '',
 470       ],
 471       'primary_key' => 'optionnum',
 472       'unique'      => [],
 473       'index'       => [ [ 'eventconditionnum' ], [ 'optionname' ] ],
 474     },
 475
 476     'part_event_condition_option_option' => {
 477       'columns' => [
 478         'optionoptionnum', 'serial', '', '', '', '',
 479         'optionnum', 'int', '', '', '', '',
 480         'optionname', 'varchar', '', $char_d, '', '',
 481         'optionvalue', 'text', 'NULL', '', '', '',
 482       ],
 483       'primary_key' => 'optionoptionnum',
 484       'unique'      => [],
 485       'index'       => [ [ 'optionnum' ], [ 'optionname' ] ],
 486     },
 487
 488     'cust_event' => {
 489       'columns' => [
 490         'eventnum',    'serial',  '', '', '', '',
 491         'eventpart',   'int',  '', '', '', '',
 492         'tablenum',   'int',  '', '', '', '',
 493         '_date',     @date_type, '', '',
 494         'status', 'varchar', '', $char_d, '', '',
 495         'statustext', 'text', 'NULL', '', '', '',
 496       ],
 497       'primary_key' => 'eventnum',
 498       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 499       'unique' => [],
 500       'index' => [ ['eventpart'], ['tablenum'], ['status'],
 501                    ['statustext'], ['_date'],
 502                  ],
 503     },
 504
 505     'cust_bill_pkg' => {
 506       'columns' => [
 507         'billpkgnum',        'serial',     '',      '', '', '',
 508         'invnum',               'int',     '',      '', '', '',
 509         'pkgnum',               'int',     '',      '', '', '',
 510         'pkgpart_override',     'int', 'NULL',      '', '', '',
 511         'setup',               @money_type,             '', '',
 512         'recur',               @money_type,             '', '',
 513         'sdate',               @date_type,              '', '',
 514         'edate',               @date_type,              '', '',
 515         'itemdesc',         'varchar', 'NULL', $char_d, '', '',
 516         'section',          'varchar', 'NULL', $char_d, '', '',
 517         'quantity',             'int', 'NULL',      '', '', '',
 518         'unitsetup',           @money_typen,            '', '',
 519         'unitrecur',           @money_typen,            '', '',
 520       ],
 521       'primary_key' => 'billpkgnum',
 522       'unique' => [],
 523       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 524     },
 525
 526     'cust_bill_pkg_detail' => {
 527       'columns' => [
 528         'detailnum', 'serial', '', '', '', '',
 529         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 530         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 531         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 532         'amount',  @money_typen, '', '',
 533         'format',  'char', 'NULL', 1, '', '',
 534         'classnum', 'int', 'NULL', '', '', '',
 535         'detail',  'varchar', '', 255, '', '',
 536       ],
 537       'primary_key' => 'detailnum',
 538       'unique' => [],
 539       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 540     },
 541
 542     'cust_bill_pkg_display' => {
 543       'columns' => [
 544         'billpkgdisplaynum', 'serial', '', '', '', '',
 545         'billpkgnum', 'int', '', '', '', '',
 546         'section',  'varchar', 'NULL', $char_d, '', '',
 547         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 548         #'unitrecur', @money_typen, '', '',     #this too?
 549         'post_total', 'char', 'NULL', 1, '', '',
 550         'type',       'char', 'NULL', 1, '', '',
 551         'summary',    'char', 'NULL', 1, '', '',
 552       ],
 553       'primary_key' => 'billpkgdisplaynum',
 554       'unique' => [],
 555       'index' => [ ['billpkgnum'], ],
 556     },
 557
 558     'cust_bill_pkg_tax_location' => {
 559       'columns' => [
 560         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 561         'billpkgnum',               'int',      '', '', '', '',
 562         'taxnum',                   'int',      '', '', '', '',
 563         'taxtype',              'varchar',      '', $char_d, '', '',
 564         'pkgnum',                   'int',      '', '', '', '',
 565         'locationnum',              'int',      '', '', '', '', #redundant?
 566         'amount',                   @money_type,        '', '',
 567       ],
 568       'primary_key' => 'billpkgtaxlocationnum',
 569       'unique' => [],
 570       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 571     },
 572
 573     'cust_bill_pkg_tax_rate_location' => {
 574       'columns' => [
 575         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 576         'billpkgnum',                   'int',      '', '', '', '',
 577         'taxnum',                       'int',      '', '', '', '',
 578         'taxtype',                  'varchar',      '', $char_d, '', '',
 579         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 580         'taxratelocationnum',           'int',      '', '', '', '',
 581         'amount',                       @money_type,        '', '',
 582       ],
 583       'primary_key' => 'billpkgtaxratelocationnum',
 584       'unique' => [],
 585       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 586     },
 587
 588     'cust_credit' => {
 589       'columns' => [
 590         'crednum',  'serial', '', '', '', '',
 591         'custnum',  'int', '', '', '', '',
 592         '_date',    @date_type, '', '',
 593         'amount',   @money_type, '', '',
 594         'otaker',   'varchar', '', 32, '', '',
 595         'reason',   'text', 'NULL', '', '', '',
 596         'reasonnum', 'int', 'NULL', '', '', '',
 597         'addlinfo', 'text', 'NULL', '', '', '',
 598         'closed',    'char', 'NULL', 1, '', '',
 599       ],
 600       'primary_key' => 'crednum',
 601       'unique' => [],
 602       'index' => [ ['custnum'], ['_date'] ],
 603     },
 604
 605     'cust_credit_bill' => {
 606       'columns' => [
 607         'creditbillnum', 'serial', '', '', '', '',
 608         'crednum',  'int', '', '', '', '',
 609         'invnum',  'int', '', '', '', '',
 610         '_date',    @date_type, '', '',
 611         'amount',   @money_type, '', '',
 612       ],
 613       'primary_key' => 'creditbillnum',
 614       'unique' => [],
 615       'index' => [ ['crednum'], ['invnum'] ],
 616     },
 617
 618     'cust_credit_bill_pkg' => {
 619       'columns' => [
 620         'creditbillpkgnum', 'serial', '',      '', '', '',
 621         'creditbillnum',       'int', '',      '', '', '',
 622         'billpkgnum',          'int', '',      '', '', '',
 623         'amount',            @money_type,          '', '',
 624         'setuprecur',      'varchar', '', $char_d, '', '',
 625         'sdate',   @date_type, '', '',
 626         'edate',   @date_type, '', '',
 627       ],
 628       'primary_key' => 'creditbillpkgnum',
 629       'unique'      => [],
 630       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 631     },
 632
 633     'cust_main' => {
 634       'columns' => [
 635         'custnum',  'serial',  '',     '', '', '',
 636         'agentnum', 'int',  '',     '', '', '',
 637         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 638         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 639 #        'titlenum', 'int',  'NULL',   '', '', '',
 640         'last',     'varchar', '',     $char_d, '', '',
 641 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 642         'first',    'varchar', '',     $char_d, '', '',
 643         'ss',       'varchar', 'NULL', 11, '', '',
 644         'stateid', 'varchar', 'NULL', $char_d, '', '',
 645         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 646         'birthdate' ,@date_type, '', '',
 647         'signupdate',@date_type, '', '',
 648         'dundate',   @date_type, '', '',
 649         'company',  'varchar', 'NULL', $char_d, '', '',
 650         'address1', 'varchar', '',     $char_d, '', '',
 651         'address2', 'varchar', 'NULL', $char_d, '', '',
 652         'city',     'varchar', '',     $char_d, '', '',
 653         'county',   'varchar', 'NULL', $char_d, '', '',
 654         'state',    'varchar', 'NULL', $char_d, '', '',
 655         'zip',      'varchar', 'NULL', 10, '', '',
 656         'country',  'char', '',     2, '', '',
 657         'daytime',  'varchar', 'NULL', 20, '', '',
 658         'night',    'varchar', 'NULL', 20, '', '',
 659         'fax',      'varchar', 'NULL', 12, '', '',
 660         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 661 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 662         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 663         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 664         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 665         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 666         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 667         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 668         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 669         'ship_zip',      'varchar', 'NULL', 10, '', '',
 670         'ship_country',  'char', 'NULL', 2, '', '',
 671         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 672         'ship_night',    'varchar', 'NULL', 20, '', '',
 673         'ship_fax',      'varchar', 'NULL', 12, '', '',
 674         'payby',    'char', '',     4, '', '',
 675         'payinfo',  'varchar', 'NULL', 512, '', '',
 676         'paycvv',   'varchar', 'NULL', 512, '', '',
 677         'paymask', 'varchar', 'NULL', $char_d, '', '',
 678         #'paydate',  @date_type, '', '',
 679         'paydate',  'varchar', 'NULL', 10, '', '',
 680         'paystart_month', 'int', 'NULL', '', '', '',
 681         'paystart_year',  'int', 'NULL', '', '', '',
 682         'payissue', 'varchar', 'NULL', 2, '', '',
 683         'payname',  'varchar', 'NULL', $char_d, '', '',
 684         'paystate', 'varchar', 'NULL', $char_d, '', '',
 685         'paytype',  'varchar', 'NULL', $char_d, '', '',
 686         'payip',    'varchar', 'NULL', 15, '', '',
 687         'geocode',  'varchar', 'NULL', 20,  '', '',
 688         'tax',      'char', 'NULL', 1, '', '',
 689         'otaker',   'varchar', '',    32, '', '',
 690         'refnum',   'int',  '',     '', '', '',
 691         'referral_custnum', 'int',  'NULL', '', '', '',
 692         'comments', 'text', 'NULL', '', '', '',
 693         'spool_cdr','char', 'NULL', 1, '', '',
 694         'squelch_cdr','char', 'NULL', 1, '', '',
 695         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 696         'archived', 'char', 'NULL', 1, '', '',
 697       ],
 698       'primary_key' => 'custnum',
 699       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 700       #'index' => [ ['last'], ['company'] ],
 701       'index' => [
 702                    [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
 703                    [ 'referral_custnum' ],
 704                    [ 'payby' ], [ 'paydate' ],
 705                    [ 'archived' ],
 706                    #billing
 707                    [ 'last' ], [ 'company' ],
 708                    [ 'county' ], [ 'state' ], [ 'country' ],
 709                    [ 'zip' ],
 710                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 711                    #shipping
 712                    [ 'ship_last' ], [ 'ship_company' ],
 713                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 714                    [ 'ship_zip' ],
 715                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 716                  ],
 717     },
 718
 719     #eventually use for billing & ship from cust_main too
 720     #for now, just cust_pkg locations
 721     'cust_location' => {
 722       'columns' => [
 723         'locationnum',  'serial',     '',      '', '', '',
 724         'custnum',         'int',     '',      '', '', '',
 725         'address1',    'varchar',     '', $char_d, '', '',
 726         'address2',    'varchar', 'NULL', $char_d, '', '',
 727         'city',        'varchar',     '', $char_d, '', '',
 728         'county',      'varchar', 'NULL', $char_d, '', '',
 729         'state',       'varchar', 'NULL', $char_d, '', '',
 730         'zip',         'varchar', 'NULL',      10, '', '',
 731         'country',        'char',     '',       2, '', '',
 732         'geocode',     'varchar', 'NULL',      20, '', '',
 733       ],
 734       'primary_key' => 'locationnum',
 735       'unique'      => [],
 736       'index'       => [ [ 'custnum' ],
 737                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 738                        ],
 739     },
 740
 741     'cust_main_invoice' => {
 742       'columns' => [
 743         'destnum',  'serial',  '',     '', '', '',
 744         'custnum',  'int',  '',     '', '', '',
 745         'dest',     'varchar', '',  $char_d, '', '',
 746       ],
 747       'primary_key' => 'destnum',
 748       'unique' => [],
 749       'index' => [ ['custnum'], ],
 750     },
 751
 752     'cust_main_note' => {
 753       'columns' => [
 754         'notenum',  'serial',  '',     '', '', '',
 755         'custnum',  'int',  '',     '', '', '',
 756         '_date',    @date_type, '', '',
 757         'otaker',   'varchar', '',    32, '', '',
 758         'comments', 'text', 'NULL', '', '', '',
 759       ],
 760       'primary_key' => 'notenum',
 761       'unique' => [],
 762       'index' => [ [ 'custnum' ], [ '_date' ], ],
 763     },
 764
 765     'cust_main_county' => { #county+state+country are checked off the
 766                             #cust_main_county for validation and to provide
 767                             # a tax rate.
 768       'columns' => [
 769         'taxnum',   'serial',   '',    '', '', '',
 770         'state',    'varchar',  'NULL',    $char_d, '', '',
 771         'county',   'varchar',  'NULL',    $char_d, '', '',
 772         'country',  'char',  '', 2, '', '',
 773         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 774         'exempt_amount', @money_type, '', '',
 775         'tax',      'real',  '',    '', '', '', #tax %
 776         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 777         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 778         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 779       ],
 780       'primary_key' => 'taxnum',
 781       'unique' => [],
 782   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 783       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
 784                    [ 'taxclass' ],
 785                  ],
 786     },
 787
 788     'tax_rate'    => {
 789       'columns' => [
 790         'taxnum',       'serial',     '',      '', '', '',
 791         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 792         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 793         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 794         'taxclassnum', 'int',      '',      '', '', '',
 795         'effective_date', @date_type, '', '',
 796         'tax',        @taxrate_type,      '', '',        # tax %
 797         'excessrate', @taxrate_typen,     '', '',        # second tax %
 798         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 799         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 800         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
 801         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
 802         'unittype',    'int',  'NULL', '', '', '',      # for fee
 803         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
 804         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
 805         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
 806         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
 807         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 808         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 809         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 810         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 811         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 812         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 813         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 814         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 815         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 816         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
 817       ],
 818       'primary_key' => 'taxnum',
 819       'unique' => [],
 820       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 821     },
 822
 823     'tax_rate_location' => {
 824       'columns' => [
 825         'taxratelocationnum', 'serial',  '',     '', '', '',
 826         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
 827         'geocode',            'varchar', '',     20,      '', '',
 828         'city',               'varchar', 'NULL', $char_d, '', '',
 829         'county',             'varchar', 'NULL', $char_d, '', '',
 830         'state',              'char',    'NULL',       2, '', '',
 831         'disabled',           'char',    'NULL', 1, '', '',
 832       ],
 833       'primary_key' => 'taxratelocationnum',
 834       'unique' => [],
 835       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
 836     },
 837
 838     'cust_tax_location' => {
 839       'columns' => [
 840         'custlocationnum', 'serial',  '',     '', '', '',
 841         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 842         'city',            'varchar', 'NULL', $char_d, '', '',
 843         'postalcity',      'varchar', 'NULL', $char_d, '', '',
 844         'county',          'varchar', 'NULL', $char_d, '', '',
 845         'zip',             'char',    '',     5,  '', '',
 846         'state',           'char',    '',     2,  '', '',
 847         'plus4hi',         'char',    'NULL', 4,  '', '',
 848         'plus4lo',         'char',    'NULL', 4,  '', '',
 849         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 850         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
 851         'geocode',         'varchar', '',    20,  '', '',
 852       ],
 853       'primary_key' => 'custlocationnum',
 854       'unique' => [],
 855       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 856     },
 857
 858     'tax_class' => {
 859       'columns' => [
 860         'taxclassnum',  'serial',  '',            '', '', '',
 861         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
 862         'taxclass',     'varchar', '',       $char_d, '', '',
 863         'description',  'varchar', '',     2*$char_d, '', '',
 864       ],
 865       'primary_key' => 'taxclassnum',
 866       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
 867       'index' => [],
 868     },
 869
 870     'cust_pay_pending' => {
 871       'columns' => [
 872         'paypendingnum','serial',      '',  '', '', '',
 873         'custnum',      'int',         '',  '', '', '',
 874         'paid',         @money_type,            '', '',
 875         '_date',        @date_type,             '', '',
 876         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
 877                                                         # be index into payby
 878                                                         # table eventually
 879         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
 880         'paymask',      'varchar', 'NULL', $char_d, '', '',
 881         'paydate',      'varchar', 'NULL', 10, '', '',
 882         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
 883         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
 884         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 885
 886         'status',       'varchar',     '', $char_d, '', '',
 887         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
 888         'statustext',   'text',    'NULL',  '', '', '',
 889         'gatewaynum',   'int',     'NULL',  '', '', '',
 890         #'cust_balance', @money_type,            '', '',
 891         'paynum',       'int',     'NULL',  '', '', '',
 892         'jobnum',       'int',     'NULL',  '', '', '',
 893       ],
 894       'primary_key' => 'paypendingnum',
 895       'unique'      => [ [ 'payunique' ] ],
 896       'index'       => [ [ 'custnum' ], [ 'status' ], ],
 897     },
 898
 899     'cust_pay' => {
 900       'columns' => [
 901         'paynum',   'serial',    '',   '', '', '',
 902         'custnum',  'int',    '',   '', '', '',
 903         '_date',    @date_type, '', '',
 904         'paid',     @money_type, '', '',
 905         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
 906         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 907                                                  # index into payby table
 908                                                  # eventually
 909         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 910         'paymask', 'varchar', 'NULL', $char_d, '', '',
 911         'paydate',  'varchar', 'NULL', 10, '', '',
 912         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 913         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 914         'closed',    'char', 'NULL', 1, '', '',
 915       ],
 916       'primary_key' => 'paynum',
 917       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
 918       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 919     },
 920
 921     'cust_pay_void' => {
 922       'columns' => [
 923         'paynum',    'int',    '',   '', '', '',
 924         'custnum',   'int',    '',   '', '', '',
 925         'paid',      @money_type, '', '',
 926         '_date',     @date_type, '', '',
 927         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 928                                                   # index into payby table
 929                                                   # eventually
 930         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 931         'paymask', 'varchar', 'NULL', $char_d, '', '',
 932         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 933         'closed',    'char', 'NULL', 1, '', '',
 934         'void_date', @date_type, '', '',
 935         'reason',    'varchar',   'NULL', $char_d, '', '',
 936         'otaker',   'varchar', '', 32, '', '',
 937       ],
 938       'primary_key' => 'paynum',
 939       'unique' => [],
 940       'index' => [ [ 'custnum' ] ],
 941     },
 942
 943     'cust_bill_pay' => {
 944       'columns' => [
 945         'billpaynum', 'serial',     '',   '', '', '',
 946         'invnum',  'int',     '',   '', '', '',
 947         'paynum',  'int',     '',   '', '', '',
 948         'amount',  @money_type, '', '',
 949         '_date',   @date_type, '', '',
 950       ],
 951       'primary_key' => 'billpaynum',
 952       'unique' => [],
 953       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 954     },
 955
 956     'cust_bill_pay_batch' => {
 957       'columns' => [
 958         'billpaynum', 'serial',     '',   '', '', '',
 959         'invnum',  'int',     '',   '', '', '',
 960         'paybatchnum',  'int',     '',   '', '', '',
 961         'amount',  @money_type, '', '',
 962         '_date',   @date_type, '', '',
 963       ],
 964       'primary_key' => 'billpaynum',
 965       'unique' => [],
 966       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 967     },
 968
 969     'cust_bill_pay_pkg' => {
 970       'columns' => [
 971         'billpaypkgnum', 'serial', '', '', '', '',
 972         'billpaynum',       'int', '', '', '', '',
 973         'billpkgnum',       'int', '', '', '', '',
 974         'amount',         @money_type,     '', '',
 975         'setuprecur',      'varchar', '', $char_d, '', '',
 976         'sdate',   @date_type, '', '',
 977         'edate',   @date_type, '', '',
 978       ],
 979       'primary_key' => 'billpaypkgnum',
 980       'unique'      => [],
 981       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 982     },
 983
 984     'pay_batch' => { #batches of payments to an external processor
 985       'columns' => [
 986         'batchnum',   'serial',    '',   '', '', '',
 987         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 988         'status',     'char', 'NULL',     1, '', '',
 989         'download',   @date_type, '', '',
 990         'upload',     @date_type, '', '',
 991       ],
 992       'primary_key' => 'batchnum',
 993       'unique' => [],
 994       'index' => [],
 995     },
 996
 997     'cust_pay_batch' => { #what's this used for again?  list of customers
 998                           #in current CARD batch? (necessarily CARD?)
 999       'columns' => [
1000         'paybatchnum',   'serial',    '',   '', '', '',
1001         'batchnum',   'int',    '',   '', '', '',
1002         'invnum',   'int',    '',   '', '', '',
1003         'custnum',   'int',    '',   '', '', '',
1004         'last',     'varchar', '',     $char_d, '', '',
1005         'first',    'varchar', '',     $char_d, '', '',
1006         'address1', 'varchar', '',     $char_d, '', '',
1007         'address2', 'varchar', 'NULL', $char_d, '', '',
1008         'city',     'varchar', '',     $char_d, '', '',
1009         'state',    'varchar', 'NULL', $char_d, '', '',
1010         'zip',      'varchar', 'NULL', 10, '', '',
1011         'country',  'char', '',     2, '', '',
1012         #        'trancode', 'int', '', '', '', ''
1013         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1014         'payinfo',  'varchar', '',     512, '', '',
1015         #'exp',      @date_type, '', ''
1016         'exp',      'varchar', 'NULL',     11, '', '',
1017         'payname',  'varchar', 'NULL', $char_d, '', '',
1018         'amount',   @money_type, '', '',
1019         'status',   'varchar', 'NULL',     $char_d, '', '',
1020       ],
1021       'primary_key' => 'paybatchnum',
1022       'unique' => [],
1023       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1024     },
1025
1026     'cust_pkg' => {
1027       'columns' => [
1028         'pkgnum',           'serial',     '', '', '', '',
1029         'custnum',             'int',     '', '', '', '',
1030         'pkgpart',             'int',     '', '', '', '',
1031         'locationnum',         'int', 'NULL', '', '', '',
1032         'otaker',          'varchar',     '', 32, '', '',
1033         'setup',          @date_type,             '', '',
1034         'bill',           @date_type,             '', '',
1035         'last_bill',      @date_type,             '', '',
1036         'susp',           @date_type,             '', '',
1037         'adjourn',        @date_type,             '', '',
1038         'cancel',         @date_type,             '', '',
1039         'expire',         @date_type,             '', '',
1040         'change_date',    @date_type,             '', '',
1041         'change_pkgnum',       'int', 'NULL', '', '', '',
1042         'change_pkgpart',      'int', 'NULL', '', '', '',
1043         'change_locationnum',  'int', 'NULL', '', '', '',
1044         'manual_flag',        'char', 'NULL',  1, '', '',
1045         'quantity',            'int', 'NULL', '', '', '',
1046       ],
1047       'primary_key' => 'pkgnum',
1048       'unique' => [],
1049       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1050                    ['setup'], ['last_bill'], ['bill'], ['susp'], ['adjourn'],
1051                    ['expire'], ['cancel'],
1052                    ['change_date'],
1053                  ],
1054     },
1055
1056     'cust_pkg_option' => {
1057       'columns' => [
1058         'optionnum', 'serial', '', '', '', '',
1059         'pkgnum', 'int', '', '', '', '',
1060         'optionname', 'varchar', '', $char_d, '', '',
1061         'optionvalue', 'text', 'NULL', '', '', '',
1062       ],
1063       'primary_key' => 'optionnum',
1064       'unique'      => [],
1065       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1066     },
1067
1068     'cust_pkg_detail' => {
1069       'columns' => [
1070         'pkgdetailnum', 'serial', '',      '', '', '',
1071         'pkgnum',          'int', '',      '', '', '',
1072         'detail',      'varchar', '', $char_d, '', '',
1073         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1074         'weight',          'int', '',      '', '', '',
1075       ],
1076       'primary_key' => 'pkgdetailnum',
1077       'unique' => [],
1078       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1079     },
1080
1081     'cust_pkg_reason' => {
1082       'columns' => [
1083         'num',      'serial',    '',   '', '', '',
1084         'pkgnum',   'int',    '',   '', '', '',
1085         'reasonnum','int',    '',   '', '', '',
1086         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1087         'otaker',   'varchar', '', 32, '', '',
1088         'date',     @date_type, '', '',
1089       ],
1090       'primary_key' => 'num',
1091       'unique' => [],
1092       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1093     },
1094
1095     'cust_refund' => {
1096       'columns' => [
1097         'refundnum',    'serial',    '',   '', '', '',
1098         'custnum',  'int',    '',   '', '', '',
1099         '_date',        @date_type, '', '',
1100         'refund',       @money_type, '', '',
1101         'otaker',       'varchar',   '',   32, '', '',
1102         'reason',       'varchar',   '',   $char_d, '', '',
1103         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1104                                                      # be index into payby
1105                                                      # table eventually
1106         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1107         'paymask', 'varchar', 'NULL', $char_d, '', '',
1108         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1109         'closed',    'char', 'NULL', 1, '', '',
1110       ],
1111       'primary_key' => 'refundnum',
1112       'unique' => [],
1113       'index' => [ ['custnum'], ['_date'] ],
1114     },
1115
1116     'cust_credit_refund' => {
1117       'columns' => [
1118         'creditrefundnum', 'serial',     '',   '', '', '',
1119         'crednum',  'int',     '',   '', '', '',
1120         'refundnum',  'int',     '',   '', '', '',
1121         'amount',  @money_type, '', '',
1122         '_date',   @date_type, '', '',
1123       ],
1124       'primary_key' => 'creditrefundnum',
1125       'unique' => [],
1126       'index' => [ ['crednum'], ['refundnum'] ],
1127     },
1128
1129
1130     'cust_svc' => {
1131       'columns' => [
1132         'svcnum',    'serial',    '',   '', '', '',
1133         'pkgnum',    'int',    'NULL',   '', '', '',
1134         'svcpart',   'int',    '',   '', '', '',
1135         'overlimit', @date_type, '', '',
1136       ],
1137       'primary_key' => 'svcnum',
1138       'unique' => [],
1139       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1140     },
1141
1142     'cust_svc_option' => {
1143       'columns' => [
1144         'optionnum',   'serial', '', '', '', '',
1145         'svcnum',      'int', '', '', '', '',
1146         'optionname',  'varchar', '', $char_d, '', '',
1147         'optionvalue', 'text', 'NULL', '', '', '',
1148       ],
1149       'primary_key' => 'optionnum',
1150       'unique'      => [],
1151       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1152     },
1153
1154     'part_pkg' => {
1155       'columns' => [
1156         'pkgpart',       'serial',    '',   '', '', '',
1157         'pkg',           'varchar',   '',   $char_d, '', '',
1158         'comment',       'varchar',   '',   $char_d, '', '',
1159         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1160         'setup',         @perl_type, '', '',
1161         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1162         'recur',         @perl_type, '', '',
1163         'setuptax',      'char', 'NULL', 1, '', '',
1164         'recurtax',      'char', 'NULL', 1, '', '',
1165         'plan',          'varchar', 'NULL', $char_d, '', '',
1166         'plandata',      'text', 'NULL', '', '', '',
1167         'disabled',      'char', 'NULL', 1, '', '',
1168         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1169         'classnum',      'int',     'NULL', '', '', '',
1170         'taxproductnum', 'int',     'NULL', '', '', '',
1171         'pay_weight',    'real',    'NULL', '', '', '',
1172         'credit_weight', 'real',    'NULL', '', '', '',
1173         'agentnum',      'int',     'NULL', '', '', '',
1174
1175       ],
1176       'primary_key' => 'pkgpart',
1177       'unique' => [],
1178       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1179     },
1180
1181     'part_pkg_link' => {
1182       'columns' => [
1183         'pkglinknum',  'serial',  '',      '', '', '',
1184         'src_pkgpart', 'int',     '',      '', '', '',
1185         'dst_pkgpart', 'int',     '',      '', '', '',
1186         'link_type',   'varchar', '', $char_d, '', '',
1187       ],
1188       'primary_key' => 'pkglinknum',
1189       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1190       'index'  => [ [ 'src_pkgpart' ] ],
1191     },
1192
1193     'part_pkg_taxclass' => {
1194       'columns' => [
1195         'taxclassnum',  'serial', '',       '', '', '',
1196         'taxclass',     'varchar', '', $char_d, '', '',
1197       ],
1198       'primary_key' => 'taxclassnum',
1199       'unique'      => [ [ 'taxclass' ] ],
1200       'index'       => [],
1201     },
1202
1203     'part_pkg_taxproduct' => {
1204       'columns' => [
1205         'taxproductnum', 'serial',      '',        '', '', '',
1206         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1207         'taxproduct',    'varchar',     '',   $char_d, '', '',
1208         'description',   'varchar',     '', 3*$char_d, '', '',
1209       ],
1210       'primary_key' => 'taxproductnum',
1211       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1212       'index'       => [],
1213     },
1214
1215     'part_pkg_taxrate' => {
1216       'columns' => [
1217         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1218         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1219         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1220         'taxproductnum', 'int',  '',     '',       '', '',
1221         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1222         'county',           'varchar', 'NULL', $char_d, '', '',
1223         'state',            'varchar', 'NULL', $char_d, '', '',
1224         'local',            'varchar', 'NULL', $char_d, '', '',
1225         'country',          'char',    'NULL', 2,       '', '',
1226         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1227         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1228         'taxclassnum',      'int',     'NULL', '',      '', '',
1229         'effdate',          @date_type, '', '',
1230         'taxable',          'char',    'NULL', 1,       '', '',
1231       ],
1232       'primary_key' => 'pkgtaxratenum',
1233       'unique' => [],
1234       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1235     },
1236
1237     'part_pkg_taxoverride' => {
1238       'columns' => [
1239         'taxoverridenum', 'serial', '', '', '', '',
1240         'pkgpart',        'serial', '', '', '', '',
1241         'taxclassnum',    'serial', '', '', '', '',
1242         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1243       ],
1244       'primary_key' => 'taxoverridenum',
1245       'unique' => [],
1246       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1247     },
1248
1249 #    'part_title' => {
1250 #      'columns' => [
1251 #        'titlenum',   'int',    '',   '',
1252 #        'title',      'varchar',   '',   $char_d,
1253 #      ],
1254 #      'primary_key' => 'titlenum',
1255 #      'unique' => [ [] ],
1256 #      'index' => [ [] ],
1257 #    },
1258
1259     'pkg_svc' => {
1260       'columns' => [
1261         'pkgsvcnum',  'serial', '',  '', '', '',
1262         'pkgpart',    'int',    '',   '', '', '',
1263         'svcpart',    'int',    '',   '', '', '',
1264         'quantity',   'int',    '',   '', '', '',
1265         'primary_svc','char', 'NULL',  1, '', '',
1266       ],
1267       'primary_key' => 'pkgsvcnum',
1268       'unique' => [ ['pkgpart', 'svcpart'] ],
1269       'index' => [ ['pkgpart'], ['quantity'] ],
1270     },
1271
1272     'part_referral' => {
1273       'columns' => [
1274         'refnum',   'serial',     '',        '', '', '',
1275         'referral', 'varchar',    '',   $char_d, '', '',
1276         'disabled', 'char',   'NULL',         1, '', '',
1277         'agentnum', 'int',    'NULL',        '', '', '',
1278       ],
1279       'primary_key' => 'refnum',
1280       'unique' => [],
1281       'index' => [ ['disabled'], ['agentnum'], ],
1282     },
1283
1284     'part_svc' => {
1285       'columns' => [
1286         'svcpart',    'serial',    '',   '', '', '',
1287         'svc',        'varchar',   '',   $char_d, '', '',
1288         'svcdb',      'varchar',   '',   $char_d, '', '',
1289         'disabled',   'char',  'NULL',   1, '', '',
1290       ],
1291       'primary_key' => 'svcpart',
1292       'unique' => [],
1293       'index' => [ [ 'disabled' ] ],
1294     },
1295
1296     'part_svc_column' => {
1297       'columns' => [
1298         'columnnum',   'serial',         '', '', '', '',
1299         'svcpart',     'int',         '', '', '', '',
1300         'columnname',  'varchar',     '', 64, '', '',
1301         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1302         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1303         'columnflag',  'char',    'NULL', 1, '', '',
1304       ],
1305       'primary_key' => 'columnnum',
1306       'unique' => [ [ 'svcpart', 'columnname' ] ],
1307       'index' => [ [ 'svcpart' ] ],
1308     },
1309
1310     #(this should be renamed to part_pop)
1311     'svc_acct_pop' => {
1312       'columns' => [
1313         'popnum',    'serial',    '',   '', '', '',
1314         'city',      'varchar',   '',   $char_d, '', '',
1315         'state',     'varchar',   '',   $char_d, '', '',
1316         'ac',        'char',   '',   3, '', '',
1317         'exch',      'char',   '',   3, '', '',
1318         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1319       ],
1320       'primary_key' => 'popnum',
1321       'unique' => [],
1322       'index' => [ [ 'state' ] ],
1323     },
1324
1325     'part_pop_local' => {
1326       'columns' => [
1327         'localnum',  'serial',     '',     '', '', '',
1328         'popnum',    'int',     '',     '', '', '',
1329         'city',      'varchar', 'NULL', $char_d, '', '',
1330         'state',     'char',    'NULL', 2, '', '',
1331         'npa',       'char',    '',     3, '', '',
1332         'nxx',       'char',    '',     3, '', '',
1333       ],
1334       'primary_key' => 'localnum',
1335       'unique' => [],
1336       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1337     },
1338
1339     'svc_acct' => {
1340       'columns' => [
1341         'svcnum',    'int',    '',   '', '', '',
1342         'username',  'varchar',   '',   $username_len, '', '',
1343         '_password', 'varchar',   '',  512, '', '',
1344         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1345         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1346         'popnum',    'int',    'NULL',   '', '', '',
1347         'uid',       'int', 'NULL',   '', '', '',
1348         'gid',       'int', 'NULL',   '', '', '',
1349         'finger',    'varchar',   'NULL',   $char_d, '', '',
1350         'dir',       'varchar',   'NULL',   $char_d, '', '',
1351         'shell',     'varchar',   'NULL',   $char_d, '', '',
1352         'quota',     'varchar',   'NULL',   $char_d, '', '',
1353         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1354         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1355         'seconds_threshold',   'int', 'NULL',   '', '', '',
1356         'upbytes',   'bigint', 'NULL',   '', '', '',
1357         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1358         'downbytes', 'bigint', 'NULL',   '', '', '',
1359         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1360         'totalbytes','bigint', 'NULL',   '', '', '',
1361         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1362         'domsvc',    'int', '',   '', '', '',
1363         'last_login',  @date_type, '', '',
1364         'last_logout', @date_type, '', '',
1365       ],
1366       'primary_key' => 'svcnum',
1367       #'unique' => [ [ 'username', 'domsvc' ] ],
1368       'unique' => [],
1369       'index' => [ ['username'], ['domsvc'] ],
1370     },
1371
1372     'acct_rt_transaction' => {
1373       'columns' => [
1374         'svcrtid',   'int',    '',   '', '', '',
1375         'svcnum',    'int',    '',   '', '', '',
1376         'transaction_id',       'int', '',   '', '', '',
1377         '_date',   @date_type, '', '',
1378         'seconds',   'int', '',   '', '', '', #uhhhh
1379         'support',   'int', '',   '', '', '',
1380       ],
1381       'primary_key' => 'svcrtid',
1382       'unique' => [],
1383       'index' => [ ['svcnum', 'transaction_id'] ],
1384     },
1385
1386     #'svc_charge' => {
1387     #  'columns' => [
1388     #    'svcnum',    'int',    '',   '',
1389     #    'amount',    @money_type,
1390     #  ],
1391     #  'primary_key' => 'svcnum',
1392     #  'unique' => [ [] ],
1393     #  'index' => [ [] ],
1394     #},
1395
1396     'svc_domain' => {
1397       'columns' => [
1398         'svcnum',           'int',    '',        '', '', '',
1399         'domain',       'varchar',    '',   $char_d, '', '',
1400         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1401         'catchall',         'int', 'NULL',       '', '', '',
1402         'parent_svcnum',    'int', 'NULL',       '', '', '',
1403         'registrarnum',     'int', 'NULL',       '', '', '',
1404         'registrarkey', 'varchar', 'NULL',      512, '', '',
1405         'setup_date',  @date_type, '', '',
1406         'renewal_interval', 'int', 'NULL',       '', '', '',
1407         'expiration_date', @date_type, '', '',
1408       ],
1409       'primary_key' => 'svcnum',
1410       'unique' => [ ],
1411       'index' => [ ['domain'] ],
1412     },
1413
1414     'domain_record' => {
1415       'columns' => [
1416         'recnum',    'serial',     '',  '', '', '',
1417         'svcnum',    'int',     '',  '', '', '',
1418         'reczone',   'varchar', '',  255, '', '',
1419         'recaf',     'char',    '',  2, '', '',
1420         'rectype',   'varchar',    '',  5, '', '',
1421         'recdata',   'varchar', '',  255, '', '',
1422       ],
1423       'primary_key' => 'recnum',
1424       'unique'      => [],
1425       'index'       => [ ['svcnum'] ],
1426     },
1427
1428     'registrar' => {
1429       'columns' => [
1430         'registrarnum',   'serial', '',      '', '', '',
1431         'registrarname', 'varchar', '', $char_d, '', '',
1432       ],
1433       'primary_key' => 'registrarnum',
1434       'unique'      => [],
1435       'index'       => [],
1436     },
1437
1438     'svc_forward' => {
1439       'columns' => [
1440         'svcnum',   'int',            '',   '', '', '',
1441         'srcsvc',   'int',        'NULL',   '', '', '',
1442         'src',      'varchar',    'NULL',  255, '', '',
1443         'dstsvc',   'int',        'NULL',   '', '', '',
1444         'dst',      'varchar',    'NULL',  255, '', '',
1445       ],
1446       'primary_key' => 'svcnum',
1447       'unique'      => [],
1448       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1449     },
1450
1451     'svc_www' => {
1452       'columns' => [
1453         'svcnum',   'int',      '',  '', '', '',
1454         'recnum',   'int',      '',  '', '', '',
1455         'usersvc',  'int',  'NULL',  '', '', '',
1456         'config',   'text', 'NULL',  '', '', '',
1457       ],
1458       'primary_key' => 'svcnum',
1459       'unique'      => [],
1460       'index'       => [],
1461     },
1462
1463     #'svc_wo' => {
1464     #  'columns' => [
1465     #    'svcnum',    'int',    '',   '',
1466     #    'svcnum',    'int',    '',   '',
1467     #    'svcnum',    'int',    '',   '',
1468     #    'worker',    'varchar',   '',   $char_d,
1469     #    '_date',     @date_type,
1470     #  ],
1471     #  'primary_key' => 'svcnum',
1472     #  'unique' => [ [] ],
1473     #  'index' => [ [] ],
1474     #},
1475
1476     'prepay_credit' => {
1477       'columns' => [
1478         'prepaynum',   'serial',     '',   '', '', '',
1479         'identifier',  'varchar', '', $char_d, '', '',
1480         'amount',      @money_type, '', '',
1481         'seconds',     'int',     'NULL', '', '', '',
1482         'upbytes',     'bigint',     'NULL', '', '', '',
1483         'downbytes',   'bigint',     'NULL', '', '', '',
1484         'totalbytes',  'bigint',     'NULL', '', '', '',
1485         'agentnum',    'int',     'NULL', '', '', '',
1486       ],
1487       'primary_key' => 'prepaynum',
1488       'unique'      => [ ['identifier'] ],
1489       'index'       => [],
1490     },
1491
1492     'port' => {
1493       'columns' => [
1494         'portnum',  'serial',     '',   '', '', '',
1495         'ip',       'varchar', 'NULL', 15, '', '',
1496         'nasport',  'int',     'NULL', '', '', '',
1497         'nasnum',   'int',     '',   '', '', '',
1498       ],
1499       'primary_key' => 'portnum',
1500       'unique'      => [],
1501       'index'       => [],
1502     },
1503
1504     'nas' => {
1505       'columns' => [
1506         'nasnum',   'serial',     '',    '', '', '',
1507         'nas',      'varchar', '',    $char_d, '', '',
1508         'nasip',    'varchar', '',    15, '', '',
1509         'nasfqdn',  'varchar', '',    $char_d, '', '',
1510         'last',     'int',     '',    '', '', '',
1511       ],
1512       'primary_key' => 'nasnum',
1513       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1514       'index'       => [ [ 'last' ] ],
1515     },
1516
1517 #    'session' => {
1518 #      'columns' => [
1519 #        'sessionnum', 'serial',       '',   '', '', '',
1520 #        'portnum',    'int',       '',   '', '', '',
1521 #        'svcnum',     'int',       '',   '', '', '',
1522 #        'login',      @date_type, '', '',
1523 #        'logout',     @date_type, '', '',
1524 #      ],
1525 #      'primary_key' => 'sessionnum',
1526 #      'unique'      => [],
1527 #      'index'       => [ [ 'portnum' ] ],
1528 #    },
1529
1530     'queue' => {
1531       'columns' => [
1532         'jobnum',      'serial',     '',      '', '', '',
1533         'job',           'text',     '',      '', '', '',
1534         '_date',          'int',     '',      '', '', '',
1535         'status',     'varchar',     '', $char_d, '', '',
1536         'statustext',    'text', 'NULL',      '', '', '',
1537         'svcnum',         'int', 'NULL',      '', '', '',
1538         'custnum',        'int', 'NULL',      '', '', '',
1539         'secure',        'char', 'NULL',       1, '', '',
1540         'priority',       'int', 'NULL',      '', '', '',
1541       ],
1542       'primary_key' => 'jobnum',
1543       'unique'      => [],
1544       'index'       => [ [ 'secure' ], [ 'priority' ],
1545                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1546                        ],
1547     },
1548
1549     'queue_arg' => {
1550       'columns' => [
1551         'argnum', 'serial', '', '', '', '',
1552         'jobnum', 'int', '', '', '', '',
1553         'arg', 'text', 'NULL', '', '', '',
1554       ],
1555       'primary_key' => 'argnum',
1556       'unique'      => [],
1557       'index'       => [ [ 'jobnum' ] ],
1558     },
1559
1560     'queue_depend' => {
1561       'columns' => [
1562         'dependnum', 'serial', '', '', '', '',
1563         'jobnum', 'int', '', '', '', '',
1564         'depend_jobnum', 'int', '', '', '', '',
1565       ],
1566       'primary_key' => 'dependnum',
1567       'unique'      => [],
1568       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1569     },
1570
1571     'export_svc' => {
1572       'columns' => [
1573         'exportsvcnum' => 'serial', '', '', '', '',
1574         'exportnum'    => 'int', '', '', '', '',
1575         'svcpart'      => 'int', '', '', '', '',
1576       ],
1577       'primary_key' => 'exportsvcnum',
1578       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1579       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1580     },
1581
1582     'part_export' => {
1583       'columns' => [
1584         'exportnum', 'serial', '', '', '', '',
1585         'machine', 'varchar', '', $char_d, '', '',
1586         'exporttype', 'varchar', '', $char_d, '', '',
1587         'nodomain',     'char', 'NULL', 1, '', '',
1588       ],
1589       'primary_key' => 'exportnum',
1590       'unique'      => [],
1591       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1592     },
1593
1594     'part_export_option' => {
1595       'columns' => [
1596         'optionnum', 'serial', '', '', '', '',
1597         'exportnum', 'int', '', '', '', '',
1598         'optionname', 'varchar', '', $char_d, '', '',
1599         'optionvalue', 'text', 'NULL', '', '', '',
1600       ],
1601       'primary_key' => 'optionnum',
1602       'unique'      => [],
1603       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1604     },
1605
1606     'radius_usergroup' => {
1607       'columns' => [
1608         'usergroupnum', 'serial', '', '', '', '',
1609         'svcnum',       'int', '', '', '', '',
1610         'groupname',    'varchar', '', $char_d, '', '',
1611       ],
1612       'primary_key' => 'usergroupnum',
1613       'unique'      => [],
1614       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1615     },
1616
1617     'msgcat' => {
1618       'columns' => [
1619         'msgnum', 'serial', '', '', '', '',
1620         'msgcode', 'varchar', '', $char_d, '', '',
1621         'locale', 'varchar', '', 16, '', '',
1622         'msg', 'text', '', '', '', '',
1623       ],
1624       'primary_key' => 'msgnum',
1625       'unique'      => [ [ 'msgcode', 'locale' ] ],
1626       'index'       => [],
1627     },
1628
1629     'cust_tax_exempt' => {
1630       'columns' => [
1631         'exemptnum', 'serial', '', '', '', '',
1632         'custnum',   'int', '', '', '', '',
1633         'taxnum',    'int', '', '', '', '',
1634         'year',      'int', '', '', '', '',
1635         'month',     'int', '', '', '', '',
1636         'amount',   @money_type, '', '',
1637       ],
1638       'primary_key' => 'exemptnum',
1639       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1640       'index'       => [],
1641     },
1642
1643     'cust_tax_exempt_pkg' => {
1644       'columns' => [
1645         'exemptpkgnum',  'serial', '', '', '', '',
1646         #'custnum',      'int', '', '', '', ''
1647         'billpkgnum',   'int', '', '', '', '',
1648         'taxnum',       'int', '', '', '', '',
1649         'year',         'int', '', '', '', '',
1650         'month',        'int', '', '', '', '',
1651         'amount',       @money_type, '', '',
1652       ],
1653       'primary_key' => 'exemptpkgnum',
1654       'unique' => [],
1655       'index'  => [ [ 'taxnum', 'year', 'month' ],
1656                     [ 'billpkgnum' ],
1657                     [ 'taxnum' ]
1658                   ],
1659     },
1660
1661     'router' => {
1662       'columns' => [
1663         'routernum', 'serial', '', '', '', '',
1664         'routername', 'varchar', '', $char_d, '', '',
1665         'svcnum', 'int', 'NULL', '', '', '',
1666         'agentnum',   'int', 'NULL', '', '', '',
1667       ],
1668       'primary_key' => 'routernum',
1669       'unique'      => [],
1670       'index'       => [],
1671     },
1672
1673     'part_svc_router' => {
1674       'columns' => [
1675         'svcrouternum', 'serial', '', '', '', '',
1676         'svcpart', 'int', '', '', '', '',
1677         'routernum', 'int', '', '', '', '',
1678       ],
1679       'primary_key' => 'svcrouternum',
1680       'unique'      => [],
1681       'index'       => [],
1682     },
1683
1684     'addr_block' => {
1685       'columns' => [
1686         'blocknum', 'serial', '', '', '', '',
1687         'routernum', 'int', '', '', '', '',
1688         'ip_gateway', 'varchar', '', 15, '', '',
1689         'ip_netmask', 'int', '', '', '', '',
1690         'agentnum',   'int', 'NULL', '', '', '',
1691         'manual_flag', 'char', 'NULL', 1, '', '',
1692       ],
1693       'primary_key' => 'blocknum',
1694       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1695       'index'       => [],
1696     },
1697
1698     'svc_broadband' => {
1699       'columns' => [
1700         'svcnum', 'int', '', '', '', '',
1701         'description', 'varchar', 'NULL', $char_d, '', '',
1702         'blocknum', 'int', '', '', '', '',
1703         'speed_up', 'int', '', '', '', '',
1704         'speed_down', 'int', '', '', '', '',
1705         'ip_addr', 'varchar', '', 15, '', '',
1706         'mac_addr', 'varchar', 'NULL', 12, '', '',
1707         'authkey',  'varchar', 'NULL', 32, '', '',
1708         'latitude', 'decimal', 'NULL', '', '', '',
1709         'longitude', 'decimal', 'NULL', '', '', '',
1710         'altitude', 'decimal', 'NULL', '', '', '',
1711         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1712         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1713       ],
1714       'primary_key' => 'svcnum',
1715       'unique'      => [ [ 'mac_addr' ] ],
1716       'index'       => [],
1717     },
1718
1719     'part_virtual_field' => {
1720       'columns' => [
1721         'vfieldpart', 'serial', '', '', '', '',
1722         'dbtable', 'varchar', '', 32, '', '',
1723         'name', 'varchar', '', 32, '', '',
1724         'check_block', 'text', 'NULL', '', '', '',
1725         'length', 'int', 'NULL', '', '', '',
1726         'list_source', 'text', 'NULL', '', '', '',
1727         'label', 'varchar', 'NULL', 80, '', '',
1728       ],
1729       'primary_key' => 'vfieldpart',
1730       'unique' => [],
1731       'index' => [],
1732     },
1733
1734     'virtual_field' => {
1735       'columns' => [
1736         'vfieldnum', 'serial', '', '', '', '',
1737         'recnum', 'int', '', '', '', '',
1738         'vfieldpart', 'int', '', '', '', '',
1739         'value', 'varchar', '', 128, '', '',
1740       ],
1741       'primary_key' => 'vfieldnum',
1742       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1743       'index' => [],
1744     },
1745
1746     'acct_snarf' => {
1747       'columns' => [
1748         'snarfnum',  'int', '', '', '', '',
1749         'svcnum',    'int', '', '', '', '',
1750         'machine',   'varchar', '', 255, '', '',
1751         'protocol',  'varchar', '', $char_d, '', '',
1752         'username',  'varchar', '', $char_d, '', '',
1753         '_password', 'varchar', '', $char_d, '', '',
1754       ],
1755       'primary_key' => 'snarfnum',
1756       'unique' => [],
1757       'index'  => [ [ 'svcnum' ] ],
1758     },
1759
1760     'svc_external' => {
1761       'columns' => [
1762         'svcnum', 'int', '', '', '', '',
1763         'id',     'int', 'NULL', '', '', '',
1764         'title',  'varchar', 'NULL', $char_d, '', '',
1765       ],
1766       'primary_key' => 'svcnum',
1767       'unique'      => [],
1768       'index'       => [],
1769     },
1770
1771     'cust_pay_refund' => {
1772       'columns' => [
1773         'payrefundnum', 'serial', '', '', '', '',
1774         'paynum',  'int', '', '', '', '',
1775         'refundnum',  'int', '', '', '', '',
1776         '_date',    @date_type, '', '',
1777         'amount',   @money_type, '', '',
1778       ],
1779       'primary_key' => 'payrefundnum',
1780       'unique' => [],
1781       'index' => [ ['paynum'], ['refundnum'] ],
1782     },
1783
1784     'part_pkg_option' => {
1785       'columns' => [
1786         'optionnum', 'serial', '', '', '', '',
1787         'pkgpart', 'int', '', '', '', '',
1788         'optionname', 'varchar', '', $char_d, '', '',
1789         'optionvalue', 'text', 'NULL', '', '', '',
1790       ],
1791       'primary_key' => 'optionnum',
1792       'unique'      => [],
1793       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1794     },
1795
1796     'rate' => {
1797       'columns' => [
1798         'ratenum',  'serial', '', '', '', '',
1799         'ratename', 'varchar', '', $char_d, '', '',
1800       ],
1801       'primary_key' => 'ratenum',
1802       'unique'      => [],
1803       'index'       => [],
1804     },
1805
1806     'rate_detail' => {
1807       'columns' => [
1808         'ratedetailnum',   'serial', '', '', '', '',
1809         'ratenum',         'int',     '', '', '', '',
1810         'orig_regionnum',  'int', 'NULL', '', '', '',
1811         'dest_regionnum',  'int',     '', '', '', '',
1812         'min_included',    'int',     '', '', '', '',
1813         #'min_charge',      @money_type, '', '',
1814         'min_charge',      'decimal', '', '10,5', '', '',
1815         'sec_granularity', 'int',     '', '', '', '',
1816         #time period (link to table of periods)?
1817         'classnum',        'int',     'NULL', '', '', '',
1818       ],
1819       'primary_key' => 'ratedetailnum',
1820       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1821       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1822     },
1823
1824     'rate_region' => {
1825       'columns' => [
1826         'regionnum',   'serial',      '', '', '', '',
1827         'regionname',  'varchar',     '', $char_d, '', '',
1828       ],
1829       'primary_key' => 'regionnum',
1830       'unique'      => [],
1831       'index'       => [],
1832     },
1833
1834     'rate_prefix' => {
1835       'columns' => [
1836         'prefixnum',   'serial',      '', '', '', '',
1837         'regionnum',   'int',         '', '', '', '',
1838         'countrycode', 'varchar',     '',  3, '', '',
1839         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
1840         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
1841       ],
1842       'primary_key' => 'prefixnum',
1843       'unique'      => [],
1844       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1845     },
1846
1847     'usage_class' => {
1848       'columns' => [
1849         'classnum',    'serial',   '',      '', '', '',
1850         'classname',   'varchar',  '', $char_d, '', '',
1851         'disabled',    'char', 'NULL',       1, '', '',
1852       ],
1853       'primary_key' => 'classnum',
1854       'unique' => [],
1855       'index' => [ ['disabled'] ],
1856     },
1857
1858     'reg_code' => {
1859       'columns' => [
1860         'codenum',   'serial',    '', '', '', '',
1861         'code',      'varchar',   '', $char_d, '', '',
1862         'agentnum',  'int',       '', '', '', '',
1863       ],
1864       'primary_key' => 'codenum',
1865       'unique'      => [ [ 'agentnum', 'code' ] ],
1866       'index'       => [ [ 'agentnum' ] ],
1867     },
1868
1869     'reg_code_pkg' => {
1870       'columns' => [
1871         'codepkgnum', 'serial', '', '', '', '',
1872         'codenum',   'int',    '', '', '', '',
1873         'pkgpart',   'int',    '', '', '', '',
1874       ],
1875       'primary_key' => 'codepkgnum',
1876       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1877       'index'       => [ [ 'codenum' ] ],
1878     },
1879
1880     'clientapi_session' => {
1881       'columns' => [
1882         'sessionnum',  'serial',  '', '', '', '',
1883         'sessionid',  'varchar',  '', $char_d, '', '',
1884         'namespace',  'varchar',  '', $char_d, '', '',
1885       ],
1886       'primary_key' => 'sessionnum',
1887       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1888       'index'       => [],
1889     },
1890
1891     'clientapi_session_field' => {
1892       'columns' => [
1893         'fieldnum',    'serial',     '', '', '', '',
1894         'sessionnum',     'int',     '', '', '', '',
1895         'fieldname',  'varchar',     '', $char_d, '', '',
1896         'fieldvalue',    'text', 'NULL', '', '', '',
1897       ],
1898       'primary_key' => 'fieldnum',
1899       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1900       'index'       => [],
1901     },
1902
1903     'payment_gateway' => {
1904       'columns' => [
1905         'gatewaynum',       'serial',   '',     '', '', '',
1906         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
1907         'gateway_module',   'varchar',  '',     $char_d, '', '',
1908         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1909         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1910         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1911         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
1912         'disabled',   'char',  'NULL',   1, '', '',
1913       ],
1914       'primary_key' => 'gatewaynum',
1915       'unique' => [],
1916       'index'  => [ [ 'disabled' ] ],
1917     },
1918
1919     'payment_gateway_option' => {
1920       'columns' => [
1921         'optionnum',   'serial',  '',     '', '', '',
1922         'gatewaynum',  'int',     '',     '', '', '',
1923         'optionname',  'varchar', '',     $char_d, '', '',
1924         'optionvalue', 'text',    'NULL', '', '', '',
1925       ],
1926       'primary_key' => 'optionnum',
1927       'unique'      => [],
1928       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1929     },
1930
1931     'agent_payment_gateway' => {
1932       'columns' => [
1933         'agentgatewaynum', 'serial', '', '', '', '',
1934         'agentnum',        'int', '', '', '', '',
1935         'gatewaynum',      'int', '', '', '', '',
1936         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1937         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1938       ],
1939       'primary_key' => 'agentgatewaynum',
1940       'unique'      => [],
1941       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1942     },
1943
1944     'banned_pay' => {
1945       'columns' => [
1946         'bannum',  'serial',   '',     '', '', '',
1947         'payby',   'char',     '',       4, '', '',
1948         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1949         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1950         '_date',   @date_type, '', '',
1951         'otaker',  'varchar',  '',     32, '', '',
1952         'reason',  'varchar',  'NULL', $char_d, '', '',
1953       ],
1954       'primary_key' => 'bannum',
1955       'unique'      => [ [ 'payby', 'payinfo' ] ],
1956       'index'       => [],
1957     },
1958
1959     'pkg_category' => {
1960       'columns' => [
1961         'categorynum',   'serial',  '', '', '', '',
1962         'categoryname',  'varchar', '', $char_d, '', '',
1963         'disabled',      'char', 'NULL',   1, '', '',
1964       ],
1965       'primary_key' => 'categorynum',
1966       'unique' => [],
1967       'index' => [ ['disabled'] ],
1968     },
1969
1970     'pkg_class' => {
1971       'columns' => [
1972         'classnum',    'serial',   '',      '', '', '',
1973         'classname',   'varchar',  '', $char_d, '', '',
1974         'categorynum', 'int',  'NULL',      '', '', '',
1975         'disabled',    'char', 'NULL',       1, '', '',
1976       ],
1977       'primary_key' => 'classnum',
1978       'unique' => [],
1979       'index' => [ ['disabled'] ],
1980     },
1981
1982     'cdr' => {
1983       'columns' => [
1984         # qw( name type null length default local );
1985
1986         ###
1987         #asterisk fields
1988         ###
1989
1990         'acctid',   'bigserial',  '', '', '', '',
1991         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1992         'calldate', 'timestamp',   '',      '', \'now()', '',
1993         'clid',        'varchar',  '', $char_d, \"''", '',
1994         'src',         'varchar',  '', $char_d, \"''", '',
1995         'dst',         'varchar',  '', $char_d, \"''", '',
1996         'dcontext',    'varchar',  '', $char_d, \"''", '',
1997         'channel',     'varchar',  '', $char_d, \"''", '',
1998         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1999         'lastapp',     'varchar',  '', $char_d, \"''", '',
2000         'lastdata',    'varchar',  '', $char_d, \"''", '',
2001
2002         #these don't seem to be logged by most of the SQL cdr_* modules
2003         #except tds under sql-illegal names, so;
2004         # ... don't rely on them for rating?
2005         # and, what they hey, i went ahead and changed the names and data types
2006         # to freeside-style dates...
2007           #'start',  'timestamp', 'NULL',  '',    '', '',
2008           #'answer', 'timestamp', 'NULL',  '',    '', '',
2009           #'end',    'timestamp', 'NULL',  '',    '', '',
2010         'startdate',  @date_type, '', '',
2011         'answerdate', @date_type, '', '',
2012         'enddate',    @date_type, '', '',
2013         #
2014
2015         'duration',    'int',      '',      '',     0, '',
2016         'billsec',     'int',      '',      '',     0, '',
2017         'disposition', 'varchar',  '',      45, \"''", '',
2018         'amaflags',    'int',      '',      '',     0, '',
2019         'accountcode', 'varchar',  '',      20, \"''", '',
2020         'uniqueid',    'varchar',  '',      32, \"''", '',
2021         'userfield',   'varchar',  '',     255, \"''", '',
2022
2023         ###
2024         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2025         # defaults
2026         ###
2027
2028         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2029         'cdrtypenum',              'int', 'NULL',      '', '', '',
2030
2031         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2032
2033         'upstream_currency',      'char', 'NULL',       3, '', '',
2034         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2035         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2036
2037         # how it was rated internally...
2038         'ratedetailnum',           'int', 'NULL',      '', '', '',
2039         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
2040
2041         'distance',            'decimal', 'NULL',      '', '', '',
2042         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2043
2044         #cdr_calltype: the big list in appendix 2
2045         'calltypenum',             'int', 'NULL',      '', '', '',
2046
2047         'description',         'varchar', 'NULL', $char_d, '', '',
2048         'quantity',                'int', 'NULL',      '', '', '',
2049
2050         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2051         'carrierid',               'int', 'NULL',      '', '', '',
2052
2053         'upstream_rateid',         'int', 'NULL',      '', '', '',
2054
2055         ###
2056         #and now for our own fields
2057         ###
2058
2059         # a svcnum... right..?
2060         'svcnum',             'int',   'NULL',     '',   '', '',
2061
2062         #NULL, done (or something)
2063         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2064
2065         #NULL, done (or something)
2066         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2067
2068         'cdrbatch', 'varchar', 'NULL', $char_d, '', '',
2069
2070       ],
2071       'primary_key' => 'acctid',
2072       'unique' => [],
2073       'index' => [ [ 'calldate' ], [ 'src' ], [ 'dst' ], [ 'charged_party' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'freesiderewritestatus' ], [ 'cdrbatch' ], ],
2074     },
2075
2076     'cdr_calltype' => {
2077       'columns' => [
2078         'calltypenum',   'serial',  '', '', '', '',
2079         'calltypename',  'varchar', '', $char_d, '', '',
2080       ],
2081       'primary_key' => 'calltypenum',
2082       'unique'      => [],
2083       'index'       => [],
2084     },
2085
2086     'cdr_type' => {
2087       'columns' => [
2088         'cdrtypenum'  => 'serial',  '', '', '', '',
2089         'cdrtypename' => 'varchar', '', $char_d, '', '',
2090       ],
2091       'primary_key' => 'cdrtypenum',
2092       'unique'      => [],
2093       'index'       => [],
2094     },
2095
2096     'cdr_carrier' => {
2097       'columns' => [
2098         'carrierid'   => 'serial',  '', '', '', '',
2099         'carriername' => 'varchar', '', $char_d, '', '',
2100       ],
2101       'primary_key' => 'carrierid',
2102       'unique'      => [],
2103       'index'       => [],
2104     },
2105
2106     #map upstream rateid to ours...
2107     'cdr_upstream_rate' => {
2108       'columns' => [
2109         'upstreamratenum', 'serial',  '', '', '', '',
2110         'upstream_rateid', 'varchar', '', $char_d, '', '',
2111         'ratedetailnum',   'int', 'NULL', '', '', '',
2112       ],
2113       'primary_key' => 'upstreamratenum', #XXX need a primary key
2114       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2115       'index'  => [],
2116     },
2117
2118     #'cdr_file' => {
2119     #  'columns' => [
2120     #    'filenum',    'serial',     '', '', '', '',
2121     #    'filename',  'varchar',     '', '', '', '',
2122     #    'status',    'varchar', 'NULL', '', '', '',
2123     #  ],
2124     #  'primary_key' => 'filenum',
2125     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2126     #                                   # agent-virtualize or have a customer
2127     #                                   # with dup-filename needs or something
2128     #                                   # (only used by cdr.http_and_import for
2129     #                                   #  chrissakes)
2130     #  'index'  => [],
2131     #},
2132
2133     'inventory_item' => {
2134       'columns' => [
2135         'itemnum',  'serial',      '',      '', '', '',
2136         'classnum', 'int',         '',      '', '', '',
2137         'item',     'varchar',     '', $char_d, '', '',
2138         'svcnum',   'int',     'NULL',      '', '', '',
2139       ],
2140       'primary_key' => 'itemnum',
2141       'unique' => [ [ 'classnum', 'item' ] ],
2142       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2143     },
2144
2145     'inventory_class' => {
2146       'columns' => [
2147         'classnum',  'serial',       '',      '', '', '',
2148         'classname', 'varchar',      '', $char_d, '', '',
2149       ],
2150       'primary_key' => 'classnum',
2151       'unique' => [],
2152       'index'  => [],
2153     },
2154
2155     'access_user' => {
2156       'columns' => [
2157         'usernum',   'serial',  '',      '', '', '',
2158         'username',  'varchar', '', $char_d, '', '',
2159         '_password', 'varchar', '', $char_d, '', '',
2160         'last',      'varchar', '', $char_d, '', '',
2161         'first',     'varchar', '', $char_d, '', '',
2162         'disabled',     'char', 'NULL',   1, '', '',
2163       ],
2164       'primary_key' => 'usernum',
2165       'unique' => [ [ 'username' ] ],
2166       'index'  => [],
2167     },
2168
2169     'access_user_pref' => {
2170       'columns' => [
2171         'prefnum',    'serial',       '', '', '', '',
2172         'usernum',     'int',       '', '', '', '',
2173         'prefname', 'varchar', '', $char_d, '', '',
2174         'prefvalue', 'text', 'NULL', '', '', '',
2175         'expiration', @date_type, '', '',
2176       ],
2177       'primary_key' => 'prefnum',
2178       'unique' => [],
2179       'index'  => [ [ 'usernum' ] ],
2180     },
2181
2182     'access_group' => {
2183       'columns' => [
2184         'groupnum',   'serial', '',      '', '', '',
2185         'groupname', 'varchar', '', $char_d, '', '',
2186       ],
2187       'primary_key' => 'groupnum',
2188       'unique' => [ [ 'groupname' ] ],
2189       'index'  => [],
2190     },
2191
2192     'access_usergroup' => {
2193       'columns' => [
2194         'usergroupnum', 'serial', '', '', '', '',
2195         'usernum',         'int', '', '', '', '',
2196         'groupnum',        'int', '', '', '', '',
2197       ],
2198       'primary_key' => 'usergroupnum',
2199       'unique' => [ [ 'usernum', 'groupnum' ] ],
2200       'index'  => [ [ 'usernum' ] ],
2201     },
2202
2203     'access_groupagent' => {
2204       'columns' => [
2205         'groupagentnum', 'serial', '', '', '', '',
2206         'groupnum',         'int', '', '', '', '',
2207         'agentnum',         'int', '', '', '', '',
2208       ],
2209       'primary_key' => 'groupagentnum',
2210       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2211       'index'  => [ [ 'groupnum' ] ],
2212     },
2213
2214     'access_right' => {
2215       'columns' => [
2216         'rightnum',   'serial', '',      '', '', '',
2217         'righttype', 'varchar', '', $char_d, '', '',
2218         'rightobjnum',   'int', '',      '', '', '',
2219         'rightname', 'varchar', '', $char_d, '', '',
2220       ],
2221       'primary_key' => 'rightnum',
2222       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2223       'index'  => [],
2224     },
2225
2226     'svc_phone' => {
2227       'columns' => [
2228         'svcnum',       'int',         '',      '', '', '',
2229         'countrycode',  'varchar',     '',       3, '', '',
2230         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2231         'pin',          'varchar', 'NULL', $char_d, '', '',
2232         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2233         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2234       ],
2235       'primary_key' => 'svcnum',
2236       'unique' => [],
2237       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2238     },
2239
2240     'phone_avail' => {
2241       'columns' => [
2242         'availnum',    'serial',      '',      '', '', '',
2243         'exportnum',   'int',         '',      '', '', '',
2244         'countrycode', 'varchar',     '',       3, '', '',
2245         'state',       'char',    'NULL',       2, '', '',
2246         'npa',         'char',        '',       3, '', '',
2247         'nxx',         'char',    'NULL',       3, '', '',
2248         'station',     'char',    'NULL',       4, '', '',
2249         'name',        'varchar', 'NULL', $char_d, '', '',
2250         'svcnum',      'int',     'NULL',      '', '', '',
2251         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2252       ],
2253       'primary_key' => 'availnum',
2254       'unique' => [],
2255       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2256                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2257                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2258                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2259                     [ 'svcnum' ],
2260                     [ 'availbatch' ],
2261                   ],
2262     },
2263
2264     'reason_type' => {
2265       'columns' => [
2266         'typenum',   'serial',  '', '', '', '',
2267         'class',     'char', '', 1, '', '',
2268         'type',     'varchar', '', $char_d, '', '',
2269       ],
2270       'primary_key' => 'typenum',
2271       'unique' => [],
2272       'index' => [],
2273     },
2274
2275     'reason' => {
2276       'columns' => [
2277         'reasonnum',     'serial',  '', '', '', '',
2278         'reason_type',   'int',  '', '', '', '',
2279         'reason',        'text', '', '', '', '',
2280         'disabled',      'char',    'NULL', 1, '', '',
2281       ],
2282       'primary_key' => 'reasonnum',
2283       'unique' => [],
2284       'index' => [],
2285     },
2286
2287     'conf' => {
2288       'columns' => [
2289         'confnum',  'serial',  '', '', '', '',
2290         'agentnum', 'int',  'NULL', '', '', '',
2291         'name',     'varchar', '', $char_d, '', '',
2292         'value',    'text', 'NULL', '', '', '',
2293       ],
2294       'primary_key' => 'confnum',
2295       'unique' => [ [ 'agentnum', 'name' ]],
2296       'index' => [],
2297     },
2298
2299     'pkg_referral' => {
2300       'columns' => [
2301         'pkgrefnum',     'serial', '', '', '', '',
2302         'pkgnum',        'int',    '', '', '', '',
2303         'refnum',        'int',    '', '', '', '',
2304       ],
2305       'primary_key' => 'pkgrefnum',
2306       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2307       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2308     },
2309     # name type nullability length default local
2310
2311     #'new_table' => {
2312     #  'columns' => [
2313     #    'num', 'serial',       '', '', '', '',
2314     #  ],
2315     #  'primary_key' => 'num',
2316     #  'unique' => [],
2317     #  'index'  => [],
2318     #},
2319
2320   };
2321
2322 }
2323
2324 =back
2325
2326 =head1 BUGS
2327
2328 =head1 SEE ALSO
2329
2330 L<DBIx::DBSchema>
2331
2332 =cut
2333
2334 1;
2335