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         'itemcomment',      'varchar', 'NULL', $char_d, '', '',
 517         'section',          'varchar', 'NULL', $char_d, '', '',
 518         'quantity',             'int', 'NULL',      '', '', '',
 519         'unitsetup',           @money_typen,            '', '',
 520         'unitrecur',           @money_typen,            '', '',
 521       ],
 522       'primary_key' => 'billpkgnum',
 523       'unique' => [],
 524       'index' => [ ['invnum'], [ 'pkgnum' ], [ 'itemdesc' ], ],
 525     },
 526
 527     'cust_bill_pkg_detail' => {
 528       'columns' => [
 529         'detailnum', 'serial', '', '', '', '',
 530         'billpkgnum', 'int', 'NULL', '', '', '',        # should not be nullable
 531         'pkgnum',  'int', 'NULL', '', '', '',           # deprecated
 532         'invnum',  'int', 'NULL', '', '', '',           # deprecated
 533         'amount',  @money_typen, '', '',
 534         'format',  'char', 'NULL', 1, '', '',
 535         'classnum', 'int', 'NULL', '', '', '',
 536         'detail',  'varchar', '', 255, '', '',
 537       ],
 538       'primary_key' => 'detailnum',
 539       'unique' => [],
 540       'index' => [ [ 'billpkgnum' ], [ 'classnum' ], [ 'pkgnum', 'invnum' ] ],
 541     },
 542
 543     'cust_bill_pkg_display' => {
 544       'columns' => [
 545         'billpkgdisplaynum', 'serial', '', '', '', '',
 546         'billpkgnum', 'int', '', '', '', '',
 547         'section',  'varchar', 'NULL', $char_d, '', '',
 548         #'unitsetup', @money_typen, '', '',     #override the linked real one?
 549         #'unitrecur', @money_typen, '', '',     #this too?
 550         'post_total', 'char', 'NULL', 1, '', '',
 551         'type',       'char', 'NULL', 1, '', '',
 552         'summary',    'char', 'NULL', 1, '', '',
 553       ],
 554       'primary_key' => 'billpkgdisplaynum',
 555       'unique' => [],
 556       'index' => [ ['billpkgnum'], ],
 557     },
 558
 559     'cust_bill_pkg_tax_location' => {
 560       'columns' => [
 561         'billpkgtaxlocationnum', 'serial',      '', '', '', '',
 562         'billpkgnum',               'int',      '', '', '', '',
 563         'taxnum',                   'int',      '', '', '', '',
 564         'taxtype',              'varchar',      '', $char_d, '', '',
 565         'pkgnum',                   'int',      '', '', '', '',
 566         'locationnum',              'int',      '', '', '', '', #redundant?
 567         'amount',                   @money_type,        '', '',
 568       ],
 569       'primary_key' => 'billpkgtaxlocationnum',
 570       'unique' => [],
 571       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'pkgnum' ], [ 'locationnum' ] ],
 572     },
 573
 574     'cust_bill_pkg_tax_rate_location' => {
 575       'columns' => [
 576         'billpkgtaxratelocationnum', 'serial',      '', '', '', '',
 577         'billpkgnum',                   'int',      '', '', '', '',
 578         'taxnum',                       'int',      '', '', '', '',
 579         'taxtype',                  'varchar',      '', $char_d, '', '',
 580         'locationtaxid',            'varchar',  'NULL', $char_d, '', '',
 581         'taxratelocationnum',           'int',      '', '', '', '',
 582         'amount',                       @money_type,        '', '',
 583       ],
 584       'primary_key' => 'billpkgtaxratelocationnum',
 585       'unique' => [],
 586       'index'  => [ [ 'billpkgnum' ], [ 'taxnum' ], [ 'taxratelocationnum' ] ],
 587     },
 588
 589     'cust_credit' => {
 590       'columns' => [
 591         'crednum',  'serial', '', '', '', '',
 592         'custnum',  'int', '', '', '', '',
 593         '_date',    @date_type, '', '',
 594         'amount',   @money_type, '', '',
 595         'otaker',   'varchar', '', 32, '', '',
 596         'reason',   'text', 'NULL', '', '', '',
 597         'reasonnum', 'int', 'NULL', '', '', '',
 598         'addlinfo', 'text', 'NULL', '', '', '',
 599         'closed',    'char', 'NULL', 1, '', '',
 600       ],
 601       'primary_key' => 'crednum',
 602       'unique' => [],
 603       'index' => [ ['custnum'], ['_date'] ],
 604     },
 605
 606     'cust_credit_bill' => {
 607       'columns' => [
 608         'creditbillnum', 'serial', '', '', '', '',
 609         'crednum',  'int', '', '', '', '',
 610         'invnum',  'int', '', '', '', '',
 611         '_date',    @date_type, '', '',
 612         'amount',   @money_type, '', '',
 613       ],
 614       'primary_key' => 'creditbillnum',
 615       'unique' => [],
 616       'index' => [ ['crednum'], ['invnum'] ],
 617     },
 618
 619     'cust_credit_bill_pkg' => {
 620       'columns' => [
 621         'creditbillpkgnum', 'serial', '',      '', '', '',
 622         'creditbillnum',       'int', '',      '', '', '',
 623         'billpkgnum',          'int', '',      '', '', '',
 624         'amount',            @money_type,          '', '',
 625         'setuprecur',      'varchar', '', $char_d, '', '',
 626         'sdate',   @date_type, '', '',
 627         'edate',   @date_type, '', '',
 628       ],
 629       'primary_key' => 'creditbillpkgnum',
 630       'unique'      => [],
 631       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 632     },
 633
 634     'cust_main' => {
 635       'columns' => [
 636         'custnum',  'serial',  '',     '', '', '',
 637         'agentnum', 'int',  '',     '', '', '',
 638         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 639         'custbatch', 'varchar', 'NULL', $char_d, '', '',
 640 #        'titlenum', 'int',  'NULL',   '', '', '',
 641         'last',     'varchar', '',     $char_d, '', '',
 642 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 643         'first',    'varchar', '',     $char_d, '', '',
 644         'ss',       'varchar', 'NULL', 11, '', '',
 645         'stateid', 'varchar', 'NULL', $char_d, '', '',
 646         'stateid_state', 'varchar', 'NULL', $char_d, '', '',
 647         'birthdate' ,@date_type, '', '',
 648         'signupdate',@date_type, '', '',
 649         'dundate',   @date_type, '', '',
 650         'company',  'varchar', 'NULL', $char_d, '', '',
 651         'address1', 'varchar', '',     $char_d, '', '',
 652         'address2', 'varchar', 'NULL', $char_d, '', '',
 653         'city',     'varchar', '',     $char_d, '', '',
 654         'county',   'varchar', 'NULL', $char_d, '', '',
 655         'state',    'varchar', 'NULL', $char_d, '', '',
 656         'zip',      'varchar', 'NULL', 10, '', '',
 657         'country',  'char', '',     2, '', '',
 658         'daytime',  'varchar', 'NULL', 20, '', '',
 659         'night',    'varchar', 'NULL', 20, '', '',
 660         'fax',      'varchar', 'NULL', 12, '', '',
 661         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 662 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 663         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 664         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 665         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 666         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 667         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 668         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 669         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 670         'ship_zip',      'varchar', 'NULL', 10, '', '',
 671         'ship_country',  'char', 'NULL', 2, '', '',
 672         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 673         'ship_night',    'varchar', 'NULL', 20, '', '',
 674         'ship_fax',      'varchar', 'NULL', 12, '', '',
 675         'payby',    'char', '',     4, '', '',
 676         'payinfo',  'varchar', 'NULL', 512, '', '',
 677         'paycvv',   'varchar', 'NULL', 512, '', '',
 678         'paymask', 'varchar', 'NULL', $char_d, '', '',
 679         #'paydate',  @date_type, '', '',
 680         'paydate',  'varchar', 'NULL', 10, '', '',
 681         'paystart_month', 'int', 'NULL', '', '', '',
 682         'paystart_year',  'int', 'NULL', '', '', '',
 683         'payissue', 'varchar', 'NULL', 2, '', '',
 684         'payname',  'varchar', 'NULL', $char_d, '', '',
 685         'paystate', 'varchar', 'NULL', $char_d, '', '',
 686         'paytype',  'varchar', 'NULL', $char_d, '', '',
 687         'payip',    'varchar', 'NULL', 15, '', '',
 688         'geocode',  'varchar', 'NULL', 20,  '', '',
 689         'censustract', 'varchar', 'NULL', 20,  '', '', # 7 to save space?
 690         'tax',      'char', 'NULL', 1, '', '',
 691         'otaker',   'varchar', '',    32, '', '',
 692         'refnum',   'int',  '',     '', '', '',
 693         'referral_custnum', 'int',  'NULL', '', '', '',
 694         'comments', 'text', 'NULL', '', '', '',
 695         'spool_cdr','char', 'NULL', 1, '', '',
 696         'squelch_cdr','char', 'NULL', 1, '', '',
 697         'cdr_termination_percentage', 'decimal', 'NULL', '', '', '',
 698         'invoice_terms', 'varchar', 'NULL', $char_d, '', '',
 699         'archived', 'char', 'NULL', 1, '', '',
 700       ],
 701       'primary_key' => 'custnum',
 702       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 703       #'index' => [ ['last'], ['company'] ],
 704       'index' => [
 705                    [ 'agentnum' ], [ 'refnum' ], [ 'custbatch' ],
 706                    [ 'referral_custnum' ],
 707                    [ 'payby' ], [ 'paydate' ],
 708                    [ 'archived' ],
 709                    #billing
 710                    [ 'last' ], [ 'company' ],
 711                    [ 'county' ], [ 'state' ], [ 'country' ],
 712                    [ 'zip' ],
 713                    [ 'daytime' ], [ 'night' ], [ 'fax' ],
 714                    #shipping
 715                    [ 'ship_last' ], [ 'ship_company' ],
 716                    [ 'ship_county' ], [ 'ship_state' ], [ 'ship_country' ],
 717                    [ 'ship_zip' ],
 718                    [ 'ship_daytime' ], [ 'ship_night' ], [ 'ship_fax' ],
 719                  ],
 720     },
 721
 722     'cust_recon' => {  # what purpose does this serve?
 723       'columns' => [
 724         'reconid',      'serial',  '',          '', '', '',
 725         'recondate',    @date_type,                 '', '',
 726         'custnum',      'int'   ,  '',          '', '', '',
 727         'agentnum',     'int',     '',          '', '', '',
 728         'last',         'varchar', '',     $char_d, '', '',
 729         'first',        'varchar', '',     $char_d, '', '',
 730         'address1',     'varchar', '',     $char_d, '', '',
 731         'address2',     'varchar', 'NULL', $char_d, '', '',
 732         'city',         'varchar', '',     $char_d, '', '',
 733         'state',        'varchar', 'NULL', $char_d, '', '',
 734         'zip',          'varchar', 'NULL',      10, '', '',
 735         'pkg',          'varchar', 'NULL', $char_d, '', '',
 736         'adjourn',      @date_type,                 '', '',
 737         'status',       'varchar', 'NULL',      10, '', '',
 738         'agent_custid', 'varchar',  '',    $char_d, '', '',
 739         'agent_pkg',    'varchar', 'NULL', $char_d, '', '',
 740         'agent_adjourn', @date_type,                '', '',
 741         'comments',     'text',    'NULL',      '', '', '',
 742       ],
 743       'primary_key' => 'reconid',
 744       'unique' => [],
 745       'index' => [],
 746     },
 747
 748     #eventually use for billing & ship from cust_main too
 749     #for now, just cust_pkg locations
 750     'cust_location' => {
 751       'columns' => [
 752         'locationnum',  'serial',     '',      '', '', '',
 753         'custnum',         'int',     '',      '', '', '',
 754         'address1',    'varchar',     '', $char_d, '', '',
 755         'address2',    'varchar', 'NULL', $char_d, '', '',
 756         'city',        'varchar',     '', $char_d, '', '',
 757         'county',      'varchar', 'NULL', $char_d, '', '',
 758         'state',       'varchar', 'NULL', $char_d, '', '',
 759         'zip',         'varchar', 'NULL',      10, '', '',
 760         'country',        'char',     '',       2, '', '',
 761         'geocode',     'varchar', 'NULL',      20, '', '',
 762       ],
 763       'primary_key' => 'locationnum',
 764       'unique'      => [],
 765       'index'       => [ [ 'custnum' ],
 766                          [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 767                        ],
 768     },
 769
 770     'cust_main_invoice' => {
 771       'columns' => [
 772         'destnum',  'serial',  '',     '', '', '',
 773         'custnum',  'int',  '',     '', '', '',
 774         'dest',     'varchar', '',  $char_d, '', '',
 775       ],
 776       'primary_key' => 'destnum',
 777       'unique' => [],
 778       'index' => [ ['custnum'], ],
 779     },
 780
 781     'cust_main_note' => {
 782       'columns' => [
 783         'notenum',  'serial',  '',     '', '', '',
 784         'custnum',  'int',  '',     '', '', '',
 785         '_date',    @date_type, '', '',
 786         'otaker',   'varchar', '',    32, '', '',
 787         'comments', 'text', 'NULL', '', '', '',
 788       ],
 789       'primary_key' => 'notenum',
 790       'unique' => [],
 791       'index' => [ [ 'custnum' ], [ '_date' ], ],
 792     },
 793
 794     'cust_main_exemption' => {
 795       'columns' => [
 796         'exemptionnum', 'serial', '',      '', '', '',
 797         'custnum',         'int', '',      '', '', '',
 798         'taxname',     'varchar', '', $char_d, '', '',
 799         #start/end dates?  for reporting?
 800       ],
 801       'primary_key' => 'exemptionnum',
 802       'unique'      => [],
 803       'index'       => [ [ 'custnum' ] ],
 804     },
 805
 806     'cust_tax_adjustment' => {
 807       'columns' => [
 808         'adjustmentnum', 'serial',     '',      '', '', '',
 809         'custnum',          'int',     '',      '', '', '',
 810         'taxname',      'varchar',     '', $char_d, '', '',
 811         'amount',    @money_type,                   '', '',
 812         'comment',     'varchar',  'NULL', $char_d, '', '',
 813         'billpkgnum',       'int', 'NULL',      '', '', '',
 814         #more?  no cust_bill_pkg_tax_location?
 815       ],
 816       'primary_key' => 'adjustmentnum',
 817       'unique'      => [],
 818       'index'       => [ [ 'custnum' ], [ 'billpkgnum' ] ],
 819     },
 820
 821     'cust_main_county' => { #county+state+country are checked off the
 822                             #cust_main_county for validation and to provide
 823                             # a tax rate.
 824       'columns' => [
 825         'taxnum',   'serial',   '',    '', '', '',
 826         'state',    'varchar',  'NULL',    $char_d, '', '',
 827         'county',   'varchar',  'NULL',    $char_d, '', '',
 828         'country',  'char',  '', 2, '', '',
 829         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 830         'exempt_amount', @money_type, '', '',
 831         'tax',      'real',  '',    '', '', '', #tax %
 832         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 833         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 834         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 835       ],
 836       'primary_key' => 'taxnum',
 837       'unique' => [],
 838   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 839       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ],
 840                    [ 'taxclass' ],
 841                  ],
 842     },
 843
 844     'tax_rate'    => {
 845       'columns' => [
 846         'taxnum',       'serial',     '',      '', '', '',
 847         'geocode',     'varchar', 'NULL', $char_d, '', '',#cch provides 10 char
 848         'data_vendor', 'varchar', 'NULL', $char_d, '', '',#auto update source
 849         'location',    'varchar', 'NULL', $char_d, '', '',#provided by tax authority
 850         'taxclassnum', 'int',      '',      '', '', '',
 851         'effective_date', @date_type, '', '',
 852         'tax',        @taxrate_type,      '', '',        # tax %
 853         'excessrate', @taxrate_typen,     '', '',        # second tax %
 854         'taxbase',    @money_typen, '', '',              # amount at first tax rate
 855         'taxmax',     @money_typen, '', '',              # maximum about at both rates
 856         'usetax',        @taxrate_typen,     '', '',     # tax % when non-local
 857         'useexcessrate', @taxrate_typen,     '', '',     # second tax % when non-local
 858         'unittype',    'int',  'NULL', '', '', '',      # for fee
 859         'fee',         @taxrate_typen,     '', '',      # amount tax per unit
 860         'excessfee',   @taxrate_typen,     '', '',      # second amount tax per unit
 861         'feebase',     @taxrate_typen,     '', '',      # units taxed at first rate
 862         'feemax',      @taxrate_typen,     '', '',      # maximum number of unit taxed
 863         'maxtype',     'int',  'NULL', '', '', '',      # indicator of how thresholds accumulate
 864         'taxname', 'varchar',  'NULL', $char_d, '', '', # may appear on invoice
 865         'taxauth',     'int',  'NULL', '', '', '',      # tax authority
 866         'basetype',    'int',  'NULL', '', '', '', # indicator of basis for tax
 867         'passtype',    'int',  'NULL', '', '', '', # indicator declaring how item should be shown
 868         'passflag',    'char', 'NULL', 1, '', '',  # Y = required to list as line item, N = Prohibited
 869         'setuptax',    'char', 'NULL', 1, '', '',  # Y = setup tax exempt
 870         'recurtax',    'char', 'NULL', 1, '', '',  # Y = recur tax exempt
 871         'manual',      'char', 'NULL', 1, '', '',  # Y = manually edited
 872         'disabled',    'char', 'NULL', 1, '', '',  # Y = tax disabled
 873       ],
 874       'primary_key' => 'taxnum',
 875       'unique' => [],
 876       'index' => [ ['taxclassnum'], ['data_vendor', 'geocode'] ],
 877     },
 878
 879     'tax_rate_location' => {
 880       'columns' => [
 881         'taxratelocationnum', 'serial',  '',     '', '', '',
 882         'data_vendor',        'varchar', 'NULL', $char_d, '', '',
 883         'geocode',            'varchar', '',     20,      '', '',
 884         'city',               'varchar', 'NULL', $char_d, '', '',
 885         'county',             'varchar', 'NULL', $char_d, '', '',
 886         'state',              'char',    'NULL',       2, '', '',
 887         'disabled',           'char',    'NULL', 1, '', '',
 888       ],
 889       'primary_key' => 'taxratelocationnum',
 890       'unique' => [],
 891       'index' => [ [ 'data_vendor', 'geocode', 'disabled' ] ],
 892     },
 893
 894     'cust_tax_location' => {
 895       'columns' => [
 896         'custlocationnum', 'serial',  '',     '', '', '',
 897         'data_vendor',     'varchar', 'NULL', $char_d, '', '', # update source
 898         'city',            'varchar', 'NULL', $char_d, '', '',
 899         'postalcity',      'varchar', 'NULL', $char_d, '', '',
 900         'county',          'varchar', 'NULL', $char_d, '', '',
 901         'zip',             'char',    '',     5,  '', '',
 902         'state',           'char',    '',     2,  '', '',
 903         'plus4hi',         'char',    'NULL', 4,  '', '',
 904         'plus4lo',         'char',    'NULL', 4,  '', '',
 905         'default_location','char',    'NULL', 1,  '', '', # Y = default for zip
 906         'cityflag',        'char',    'NULL', 1,  '', '', # I(n)/O(out)/B(oth)/NULL
 907         'geocode',         'varchar', '',    20,  '', '',
 908       ],
 909       'primary_key' => 'custlocationnum',
 910       'unique' => [],
 911       'index' => [ [ 'zip', 'plus4lo', 'plus4hi' ] ],
 912     },
 913
 914     'tax_class' => {
 915       'columns' => [
 916         'taxclassnum',  'serial',  '',            '', '', '',
 917         'data_vendor',  'varchar', 'NULL',   $char_d, '', '',
 918         'taxclass',     'varchar', '',       $char_d, '', '',
 919         'description',  'varchar', '',     2*$char_d, '', '',
 920       ],
 921       'primary_key' => 'taxclassnum',
 922       'unique' => [ [ 'data_vendor', 'taxclass' ] ],
 923       'index' => [],
 924     },
 925
 926     'cust_pay_pending' => {
 927       'columns' => [
 928         'paypendingnum','serial',      '',  '', '', '',
 929         'custnum',      'int',         '',  '', '', '',
 930         'paid',         @money_type,            '', '',
 931         '_date',        @date_type,             '', '',
 932         'payby',        'char',        '',   4, '', '', #CARD/BILL/COMP, should
 933                                                         # be index into payby
 934                                                         # table eventually
 935         'payinfo',      'varchar', 'NULL', 512, '', '', #see cust_main above
 936         'paymask',      'varchar', 'NULL', $char_d, '', '',
 937         'paydate',      'varchar', 'NULL', 10, '', '',
 938         'recurring_billing', 'varchar', 'NULL', $char_d, '', '',
 939         #'paybatch',     'varchar', 'NULL', $char_d, '', '', #for auditing purposes.
 940         'payunique',    'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 941
 942         'status',       'varchar',     '', $char_d, '', '',
 943         'session_id',   'varchar', 'NULL', $char_d, '', '', #only need 32
 944         'statustext',   'text',    'NULL',  '', '', '',
 945         'gatewaynum',   'int',     'NULL',  '', '', '',
 946         #'cust_balance', @money_type,            '', '',
 947         'paynum',       'int',     'NULL',  '', '', '',
 948         'jobnum',       'int',     'NULL',  '', '', '',
 949       ],
 950       'primary_key' => 'paypendingnum',
 951       'unique'      => [ [ 'payunique' ] ],
 952       'index'       => [ [ 'custnum' ], [ 'status' ], ],
 953     },
 954
 955     'cust_pay' => {
 956       'columns' => [
 957         'paynum',   'serial',    '',   '', '', '',
 958         'custnum',  'int',    '',   '', '', '',
 959         '_date',    @date_type, '', '',
 960         'paid',     @money_type, '', '',
 961         'otaker',   'varchar', 'NULL', 32, '', '',  #NULL for the upgrade so we can create & populate the field
 962         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 963                                                  # index into payby table
 964                                                  # eventually
 965         'payinfo',  'varchar',   'NULL', 512, '', '', #see cust_main above
 966         'paymask', 'varchar', 'NULL', $char_d, '', '',
 967         'paydate',  'varchar', 'NULL', 10, '', '',
 968         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 969         'payunique', 'varchar', 'NULL', $char_d, '', '', #separate paybatch "unique" functions from current usage
 970         'closed',    'char', 'NULL', 1, '', '',
 971       ],
 972       'primary_key' => 'paynum',
 973       #i guess not now, with cust_pay_pending, if we actually make it here, we _do_ want to record it# 'unique' => [ [ 'payunique' ] ],
 974       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 975     },
 976
 977     'cust_pay_void' => {
 978       'columns' => [
 979         'paynum',    'int',    '',   '', '', '',
 980         'custnum',   'int',    '',   '', '', '',
 981         'paid',      @money_type, '', '',
 982         '_date',     @date_type, '', '',
 983         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 984                                                   # index into payby table
 985                                                   # eventually
 986         'payinfo',   'varchar',   'NULL', 512, '', '', #see cust_main above
 987         'paymask', 'varchar', 'NULL', $char_d, '', '',
 988         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 989         'closed',    'char', 'NULL', 1, '', '',
 990         'void_date', @date_type, '', '',
 991         'reason',    'varchar',   'NULL', $char_d, '', '',
 992         'otaker',   'varchar', '', 32, '', '',
 993       ],
 994       'primary_key' => 'paynum',
 995       'unique' => [],
 996       'index' => [ [ 'custnum' ] ],
 997     },
 998
 999     'cust_bill_pay' => {
1000       'columns' => [
1001         'billpaynum', 'serial',     '',   '', '', '',
1002         'invnum',  'int',     '',   '', '', '',
1003         'paynum',  'int',     '',   '', '', '',
1004         'amount',  @money_type, '', '',
1005         '_date',   @date_type, '', '',
1006       ],
1007       'primary_key' => 'billpaynum',
1008       'unique' => [],
1009       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
1010     },
1011
1012     'cust_bill_pay_batch' => {
1013       'columns' => [
1014         'billpaynum', 'serial',     '',   '', '', '',
1015         'invnum',  'int',     '',   '', '', '',
1016         'paybatchnum',  'int',     '',   '', '', '',
1017         'amount',  @money_type, '', '',
1018         '_date',   @date_type, '', '',
1019       ],
1020       'primary_key' => 'billpaynum',
1021       'unique' => [],
1022       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
1023     },
1024
1025     'cust_bill_pay_pkg' => {
1026       'columns' => [
1027         'billpaypkgnum', 'serial', '', '', '', '',
1028         'billpaynum',       'int', '', '', '', '',
1029         'billpkgnum',       'int', '', '', '', '',
1030         'amount',         @money_type,     '', '',
1031         'setuprecur',      'varchar', '', $char_d, '', '',
1032         'sdate',   @date_type, '', '',
1033         'edate',   @date_type, '', '',
1034       ],
1035       'primary_key' => 'billpaypkgnum',
1036       'unique'      => [],
1037       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
1038     },
1039
1040     'pay_batch' => { #batches of payments to an external processor
1041       'columns' => [
1042         'batchnum',   'serial',    '',   '', '', '',
1043         'payby',      'char',      '',    4, '', '', # CARD/CHEK
1044         'status',     'char', 'NULL',     1, '', '',
1045         'download',   @date_type, '', '',
1046         'upload',     @date_type, '', '',
1047       ],
1048       'primary_key' => 'batchnum',
1049       'unique' => [],
1050       'index' => [],
1051     },
1052
1053     'cust_pay_batch' => { #what's this used for again?  list of customers
1054                           #in current CARD batch? (necessarily CARD?)
1055       'columns' => [
1056         'paybatchnum',   'serial',    '',   '', '', '',
1057         'batchnum',   'int',    '',   '', '', '',
1058         'invnum',   'int',    '',   '', '', '',
1059         'custnum',   'int',    '',   '', '', '',
1060         'last',     'varchar', '',     $char_d, '', '',
1061         'first',    'varchar', '',     $char_d, '', '',
1062         'address1', 'varchar', '',     $char_d, '', '',
1063         'address2', 'varchar', 'NULL', $char_d, '', '',
1064         'city',     'varchar', '',     $char_d, '', '',
1065         'state',    'varchar', 'NULL', $char_d, '', '',
1066         'zip',      'varchar', 'NULL', 10, '', '',
1067         'country',  'char', '',     2, '', '',
1068         #        'trancode', 'int', '', '', '', ''
1069         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
1070         'payinfo',  'varchar', '',     512, '', '',
1071         #'exp',      @date_type, '', ''
1072         'exp',      'varchar', 'NULL',     11, '', '',
1073         'payname',  'varchar', 'NULL', $char_d, '', '',
1074         'amount',   @money_type, '', '',
1075         'status',   'varchar', 'NULL',     $char_d, '', '',
1076       ],
1077       'primary_key' => 'paybatchnum',
1078       'unique' => [],
1079       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
1080     },
1081
1082     'cust_pkg' => {
1083       'columns' => [
1084         'pkgnum',           'serial',     '', '', '', '',
1085         'custnum',             'int',     '', '', '', '',
1086         'pkgpart',             'int',     '', '', '', '',
1087         'locationnum',         'int', 'NULL', '', '', '',
1088         'otaker',          'varchar',     '', 32, '', '',
1089         'start_date',     @date_type,             '', '',
1090         'setup',          @date_type,             '', '',
1091         'bill',           @date_type,             '', '',
1092         'last_bill',      @date_type,             '', '',
1093         'susp',           @date_type,             '', '',
1094         'adjourn',        @date_type,             '', '',
1095         'cancel',         @date_type,             '', '',
1096         'expire',         @date_type,             '', '',
1097         'change_date',    @date_type,             '', '',
1098         'change_pkgnum',       'int', 'NULL', '', '', '',
1099         'change_pkgpart',      'int', 'NULL', '', '', '',
1100         'change_locationnum',  'int', 'NULL', '', '', '',
1101         'manual_flag',        'char', 'NULL',  1, '', '',
1102         'quantity',            'int', 'NULL', '', '', '',
1103       ],
1104       'primary_key' => 'pkgnum',
1105       'unique' => [],
1106       'index' => [ ['custnum'], ['pkgpart'], [ 'locationnum' ],
1107                    [ 'start_date' ], ['setup'], ['last_bill'], ['bill'],
1108                    ['susp'], ['adjourn'], ['expire'], ['cancel'],
1109                    ['change_date'],
1110                  ],
1111     },
1112
1113     'cust_pkg_option' => {
1114       'columns' => [
1115         'optionnum', 'serial', '', '', '', '',
1116         'pkgnum', 'int', '', '', '', '',
1117         'optionname', 'varchar', '', $char_d, '', '',
1118         'optionvalue', 'text', 'NULL', '', '', '',
1119       ],
1120       'primary_key' => 'optionnum',
1121       'unique'      => [],
1122       'index'       => [ [ 'pkgnum' ], [ 'optionname' ] ],
1123     },
1124
1125     'cust_pkg_detail' => {
1126       'columns' => [
1127         'pkgdetailnum', 'serial', '',      '', '', '',
1128         'pkgnum',          'int', '',      '', '', '',
1129         'detail',      'varchar', '', $char_d, '', '',
1130         'detailtype',     'char', '',       1, '', '', # "I"nvoice or "C"omment
1131         'weight',          'int', '',      '', '', '',
1132       ],
1133       'primary_key' => 'pkgdetailnum',
1134       'unique' => [],
1135       'index'  => [ [ 'pkgnum', 'detailtype' ] ],
1136     },
1137
1138     'cust_pkg_reason' => {
1139       'columns' => [
1140         'num',      'serial',    '',   '', '', '',
1141         'pkgnum',   'int',    '',   '', '', '',
1142         'reasonnum','int',    '',   '', '', '',
1143         'action',   'char', 'NULL', 1, '', '',     #should not be nullable
1144         'otaker',   'varchar', '', 32, '', '',
1145         'date',     @date_type, '', '',
1146       ],
1147       'primary_key' => 'num',
1148       'unique' => [],
1149       'index' => [ [ 'pkgnum' ], [ 'reasonnum' ], ['action'], ],
1150     },
1151
1152     'cust_refund' => {
1153       'columns' => [
1154         'refundnum',    'serial',    '',   '', '', '',
1155         'custnum',  'int',    '',   '', '', '',
1156         '_date',        @date_type, '', '',
1157         'refund',       @money_type, '', '',
1158         'otaker',       'varchar',   '',   32, '', '',
1159         'reason',       'varchar',   '',   $char_d, '', '',
1160         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
1161                                                      # be index into payby
1162                                                      # table eventually
1163         'payinfo',      'varchar',   'NULL', 512, '', '', #see cust_main above
1164         'paymask', 'varchar', 'NULL', $char_d, '', '',
1165         'paybatch',     'varchar',   'NULL', $char_d, '', '',
1166         'closed',    'char', 'NULL', 1, '', '',
1167       ],
1168       'primary_key' => 'refundnum',
1169       'unique' => [],
1170       'index' => [ ['custnum'], ['_date'] ],
1171     },
1172
1173     'cust_credit_refund' => {
1174       'columns' => [
1175         'creditrefundnum', 'serial',     '',   '', '', '',
1176         'crednum',  'int',     '',   '', '', '',
1177         'refundnum',  'int',     '',   '', '', '',
1178         'amount',  @money_type, '', '',
1179         '_date',   @date_type, '', '',
1180       ],
1181       'primary_key' => 'creditrefundnum',
1182       'unique' => [],
1183       'index' => [ ['crednum'], ['refundnum'] ],
1184     },
1185
1186
1187     'cust_svc' => {
1188       'columns' => [
1189         'svcnum',    'serial',    '',   '', '', '',
1190         'pkgnum',    'int',    'NULL',   '', '', '',
1191         'svcpart',   'int',    '',   '', '', '',
1192         'overlimit', @date_type, '', '',
1193       ],
1194       'primary_key' => 'svcnum',
1195       'unique' => [],
1196       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
1197     },
1198
1199     'cust_svc_option' => {
1200       'columns' => [
1201         'optionnum',   'serial', '', '', '', '',
1202         'svcnum',      'int', '', '', '', '',
1203         'optionname',  'varchar', '', $char_d, '', '',
1204         'optionvalue', 'text', 'NULL', '', '', '',
1205       ],
1206       'primary_key' => 'optionnum',
1207       'unique'      => [],
1208       'index'       => [ [ 'svcnum' ], [ 'optionname' ] ],
1209     },
1210
1211     'part_pkg' => {
1212       'columns' => [
1213         'pkgpart',       'serial',    '',   '', '', '',
1214         'pkg',           'varchar',   '',   $char_d, '', '',
1215         'comment',       'varchar',   '',   $char_d, '', '',
1216         'promo_code',    'varchar', 'NULL', $char_d, '', '',
1217         'setup',         @perl_type, '', '',
1218         'freq',          'varchar',   '',   $char_d, '', '', #billing frequency
1219         'recur',         @perl_type, '', '',
1220         'setuptax',      'char', 'NULL', 1, '', '',
1221         'recurtax',      'char', 'NULL', 1, '', '',
1222         'plan',          'varchar', 'NULL', $char_d, '', '',
1223         'plandata',      'text', 'NULL', '', '', '',
1224         'disabled',      'char', 'NULL', 1, '', '',
1225         'custom',        'char', 'NULL', 1, '', '',
1226         'taxclass',      'varchar', 'NULL', $char_d, '', '',
1227         'classnum',      'int',     'NULL', '', '', '',
1228         'taxproductnum', 'int',     'NULL', '', '', '',
1229         'setup_cost',    @money_typen,          '', '',
1230         'recur_cost',    @money_typen,          '', '',
1231         'pay_weight',    'real',    'NULL', '', '', '',
1232         'credit_weight', 'real',    'NULL', '', '', '',
1233         'agentnum',      'int',     'NULL', '', '', '',
1234
1235       ],
1236       'primary_key' => 'pkgpart',
1237       'unique' => [],
1238       'index' => [ [ 'promo_code' ], [ 'disabled' ], [ 'agentnum' ], ],
1239     },
1240
1241     'part_pkg_link' => {
1242       'columns' => [
1243         'pkglinknum',  'serial',  '',      '', '', '',
1244         'src_pkgpart', 'int',     '',      '', '', '',
1245         'dst_pkgpart', 'int',     '',      '', '', '',
1246         'link_type',   'varchar', '', $char_d, '', '',
1247       ],
1248       'primary_key' => 'pkglinknum',
1249       'unique' => [ [ 'src_pkgpart', 'dst_pkgpart', 'link_type' ] ],
1250       'index'  => [ [ 'src_pkgpart' ] ],
1251     },
1252
1253     'part_pkg_taxclass' => {
1254       'columns' => [
1255         'taxclassnum',  'serial', '',       '', '', '',
1256         'taxclass',     'varchar', '', $char_d, '', '',
1257         'disabled', 'char',   'NULL',         1, '', '',
1258       ],
1259       'primary_key' => 'taxclassnum',
1260       'unique'      => [ [ 'taxclass' ] ],
1261       'index'       => [ [ 'disabled' ] ],
1262     },
1263
1264     'part_pkg_taxproduct' => {
1265       'columns' => [
1266         'taxproductnum', 'serial',      '',        '', '', '',
1267         'data_vendor',   'varchar', 'NULL',   $char_d, '', '',
1268         'taxproduct',    'varchar',     '',   $char_d, '', '',
1269         'description',   'varchar',     '', 3*$char_d, '', '',
1270       ],
1271       'primary_key' => 'taxproductnum',
1272       'unique'      => [ [ 'data_vendor', 'taxproduct' ] ],
1273       'index'       => [],
1274     },
1275
1276     'part_pkg_taxrate' => {
1277       'columns' => [
1278         'pkgtaxratenum', 'serial',  '',     '',      '', '',
1279         'data_vendor',   'varchar', 'NULL', $char_d, '', '', # update source
1280         'geocode',       'varchar', 'NULL', $char_d, '', '', # cch provides 10
1281         'taxproductnum', 'int',  '',     '',       '', '',
1282         'city',             'varchar', 'NULL', $char_d, '', '', # tax_location?
1283         'county',           'varchar', 'NULL', $char_d, '', '',
1284         'state',            'varchar', 'NULL', $char_d, '', '',
1285         'local',            'varchar', 'NULL', $char_d, '', '',
1286         'country',          'char',    'NULL', 2,       '', '',
1287         'taxclassnumtaxed', 'int',     'NULL', '',      '', '',
1288         'taxcattaxed',      'varchar', 'NULL', $char_d, '', '',
1289         'taxclassnum',      'int',     'NULL', '',      '', '',
1290         'effdate',          @date_type, '', '',
1291         'taxable',          'char',    'NULL', 1,       '', '',
1292       ],
1293       'primary_key' => 'pkgtaxratenum',
1294       'unique' => [],
1295       'index' => [ [ 'data_vendor', 'geocode', 'taxproductnum' ] ],
1296     },
1297
1298     'part_pkg_taxoverride' => {
1299       'columns' => [
1300         'taxoverridenum', 'serial', '', '', '', '',
1301         'pkgpart',        'serial', '', '', '', '',
1302         'taxclassnum',    'serial', '', '', '', '',
1303         'usage_class',    'varchar', 'NULL', $char_d, '', '',
1304       ],
1305       'primary_key' => 'taxoverridenum',
1306       'unique' => [],
1307       'index' => [ [ 'pkgpart' ], [ 'taxclassnum' ] ],
1308     },
1309
1310 #    'part_title' => {
1311 #      'columns' => [
1312 #        'titlenum',   'int',    '',   '',
1313 #        'title',      'varchar',   '',   $char_d,
1314 #      ],
1315 #      'primary_key' => 'titlenum',
1316 #      'unique' => [ [] ],
1317 #      'index' => [ [] ],
1318 #    },
1319
1320     'pkg_svc' => {
1321       'columns' => [
1322         'pkgsvcnum',  'serial', '',  '', '', '',
1323         'pkgpart',    'int',    '',   '', '', '',
1324         'svcpart',    'int',    '',   '', '', '',
1325         'quantity',   'int',    '',   '', '', '',
1326         'primary_svc','char', 'NULL',  1, '', '',
1327       ],
1328       'primary_key' => 'pkgsvcnum',
1329       'unique' => [ ['pkgpart', 'svcpart'] ],
1330       'index' => [ ['pkgpart'], ['quantity'] ],
1331     },
1332
1333     'part_referral' => {
1334       'columns' => [
1335         'refnum',   'serial',     '',        '', '', '',
1336         'referral', 'varchar',    '',   $char_d, '', '',
1337         'disabled', 'char',   'NULL',         1, '', '',
1338         'agentnum', 'int',    'NULL',        '', '', '',
1339       ],
1340       'primary_key' => 'refnum',
1341       'unique' => [],
1342       'index' => [ ['disabled'], ['agentnum'], ],
1343     },
1344
1345     'part_svc' => {
1346       'columns' => [
1347         'svcpart',    'serial',    '',   '', '', '',
1348         'svc',        'varchar',   '',   $char_d, '', '',
1349         'svcdb',      'varchar',   '',   $char_d, '', '',
1350         'disabled',   'char',  'NULL',   1, '', '',
1351       ],
1352       'primary_key' => 'svcpart',
1353       'unique' => [],
1354       'index' => [ [ 'disabled' ] ],
1355     },
1356
1357     'part_svc_column' => {
1358       'columns' => [
1359         'columnnum',   'serial',         '', '', '', '',
1360         'svcpart',     'int',         '', '', '', '',
1361         'columnname',  'varchar',     '', 64, '', '',
1362         'columnlabel', 'varchar', 'NULL', $char_d, '', '',
1363         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
1364         'columnflag',  'char',    'NULL', 1, '', '',
1365       ],
1366       'primary_key' => 'columnnum',
1367       'unique' => [ [ 'svcpart', 'columnname' ] ],
1368       'index' => [ [ 'svcpart' ] ],
1369     },
1370
1371     #(this should be renamed to part_pop)
1372     'svc_acct_pop' => {
1373       'columns' => [
1374         'popnum',    'serial',    '',   '', '', '',
1375         'city',      'varchar',   '',   $char_d, '', '',
1376         'state',     'varchar',   '',   $char_d, '', '',
1377         'ac',        'char',   '',   3, '', '',
1378         'exch',      'char',   '',   3, '', '',
1379         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
1380       ],
1381       'primary_key' => 'popnum',
1382       'unique' => [],
1383       'index' => [ [ 'state' ] ],
1384     },
1385
1386     'part_pop_local' => {
1387       'columns' => [
1388         'localnum',  'serial',     '',     '', '', '',
1389         'popnum',    'int',     '',     '', '', '',
1390         'city',      'varchar', 'NULL', $char_d, '', '',
1391         'state',     'char',    'NULL', 2, '', '',
1392         'npa',       'char',    '',     3, '', '',
1393         'nxx',       'char',    '',     3, '', '',
1394       ],
1395       'primary_key' => 'localnum',
1396       'unique' => [],
1397       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
1398     },
1399
1400     'svc_acct' => {
1401       'columns' => [
1402         'svcnum',    'int',    '',   '', '', '',
1403         'username',  'varchar',   '',   $username_len, '', '',
1404         '_password', 'varchar',   '',  512, '', '',
1405         '_password_encoding', 'varchar', 'NULL', $char_d, '', '',
1406         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
1407         'popnum',    'int',    'NULL',   '', '', '',
1408         'uid',       'int', 'NULL',   '', '', '',
1409         'gid',       'int', 'NULL',   '', '', '',
1410         'finger',    'varchar',   'NULL',   $char_d, '', '',
1411         'dir',       'varchar',   'NULL',   $char_d, '', '',
1412         'shell',     'varchar',   'NULL',   $char_d, '', '',
1413         'quota',     'varchar',   'NULL',   $char_d, '', '',
1414         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
1415         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
1416         'seconds_threshold',   'int', 'NULL',   '', '', '',
1417         'upbytes',   'bigint', 'NULL',   '', '', '',
1418         'upbytes_threshold',   'bigint', 'NULL',   '', '', '',
1419         'downbytes', 'bigint', 'NULL',   '', '', '',
1420         'downbytes_threshold',   'bigint', 'NULL',   '', '', '',
1421         'totalbytes','bigint', 'NULL',   '', '', '',
1422         'totalbytes_threshold',   'bigint', 'NULL',   '', '', '',
1423         'domsvc',    'int', '',   '', '', '',
1424         'last_login',  @date_type, '', '',
1425         'last_logout', @date_type, '', '',
1426       ],
1427       'primary_key' => 'svcnum',
1428       #'unique' => [ [ 'username', 'domsvc' ] ],
1429       'unique' => [],
1430       'index' => [ ['username'], ['domsvc'] ],
1431     },
1432
1433     'acct_rt_transaction' => {
1434       'columns' => [
1435         'svcrtid',   'int',    '',   '', '', '',
1436         'svcnum',    'int',    '',   '', '', '',
1437         'transaction_id',       'int', '',   '', '', '',
1438         '_date',   @date_type, '', '',
1439         'seconds',   'int', '',   '', '', '', #uhhhh
1440         'support',   'int', '',   '', '', '',
1441       ],
1442       'primary_key' => 'svcrtid',
1443       'unique' => [],
1444       'index' => [ ['svcnum', 'transaction_id'] ],
1445     },
1446
1447     #'svc_charge' => {
1448     #  'columns' => [
1449     #    'svcnum',    'int',    '',   '',
1450     #    'amount',    @money_type,
1451     #  ],
1452     #  'primary_key' => 'svcnum',
1453     #  'unique' => [ [] ],
1454     #  'index' => [ [] ],
1455     #},
1456
1457     'svc_domain' => {
1458       'columns' => [
1459         'svcnum',           'int',    '',        '', '', '',
1460         'domain',       'varchar',    '',   $char_d, '', '',
1461         'suffix',       'varchar', 'NULL',  $char_d, '', '',
1462         'catchall',         'int', 'NULL',       '', '', '',
1463         'parent_svcnum',    'int', 'NULL',       '', '', '',
1464         'registrarnum',     'int', 'NULL',       '', '', '',
1465         'registrarkey', 'varchar', 'NULL',      512, '', '',
1466         'setup_date',  @date_type, '', '',
1467         'renewal_interval', 'int', 'NULL',       '', '', '',
1468         'expiration_date', @date_type, '', '',
1469       ],
1470       'primary_key' => 'svcnum',
1471       'unique' => [ ],
1472       'index' => [ ['domain'] ],
1473     },
1474
1475     'domain_record' => {
1476       'columns' => [
1477         'recnum',    'serial',     '',  '', '', '',
1478         'svcnum',    'int',     '',  '', '', '',
1479         'reczone',   'varchar', '',  255, '', '',
1480         'recaf',     'char',    '',  2, '', '',
1481         'rectype',   'varchar',    '',  5, '', '',
1482         'recdata',   'varchar', '',  255, '', '',
1483       ],
1484       'primary_key' => 'recnum',
1485       'unique'      => [],
1486       'index'       => [ ['svcnum'] ],
1487     },
1488
1489     'registrar' => {
1490       'columns' => [
1491         'registrarnum',   'serial', '',      '', '', '',
1492         'registrarname', 'varchar', '', $char_d, '', '',
1493       ],
1494       'primary_key' => 'registrarnum',
1495       'unique'      => [],
1496       'index'       => [],
1497     },
1498
1499     'svc_forward' => {
1500       'columns' => [
1501         'svcnum',   'int',            '',   '', '', '',
1502         'srcsvc',   'int',        'NULL',   '', '', '',
1503         'src',      'varchar',    'NULL',  255, '', '',
1504         'dstsvc',   'int',        'NULL',   '', '', '',
1505         'dst',      'varchar',    'NULL',  255, '', '',
1506       ],
1507       'primary_key' => 'svcnum',
1508       'unique'      => [],
1509       'index'       => [ ['srcsvc'], ['dstsvc'] ],
1510     },
1511
1512     'svc_www' => {
1513       'columns' => [
1514         'svcnum',   'int',      '',  '', '', '',
1515         'recnum',   'int',      '',  '', '', '',
1516         'usersvc',  'int',  'NULL',  '', '', '',
1517         'config',   'text', 'NULL',  '', '', '',
1518       ],
1519       'primary_key' => 'svcnum',
1520       'unique'      => [],
1521       'index'       => [],
1522     },
1523
1524     #'svc_wo' => {
1525     #  'columns' => [
1526     #    'svcnum',    'int',    '',   '',
1527     #    'svcnum',    'int',    '',   '',
1528     #    'svcnum',    'int',    '',   '',
1529     #    'worker',    'varchar',   '',   $char_d,
1530     #    '_date',     @date_type,
1531     #  ],
1532     #  'primary_key' => 'svcnum',
1533     #  'unique' => [ [] ],
1534     #  'index' => [ [] ],
1535     #},
1536
1537     'prepay_credit' => {
1538       'columns' => [
1539         'prepaynum',   'serial',     '',   '', '', '',
1540         'identifier',  'varchar', '', $char_d, '', '',
1541         'amount',      @money_type, '', '',
1542         'seconds',     'int',     'NULL', '', '', '',
1543         'upbytes',     'bigint',     'NULL', '', '', '',
1544         'downbytes',   'bigint',     'NULL', '', '', '',
1545         'totalbytes',  'bigint',     'NULL', '', '', '',
1546         'agentnum',    'int',     'NULL', '', '', '',
1547       ],
1548       'primary_key' => 'prepaynum',
1549       'unique'      => [ ['identifier'] ],
1550       'index'       => [],
1551     },
1552
1553     'port' => {
1554       'columns' => [
1555         'portnum',  'serial',     '',   '', '', '',
1556         'ip',       'varchar', 'NULL', 15, '', '',
1557         'nasport',  'int',     'NULL', '', '', '',
1558         'nasnum',   'int',     '',   '', '', '',
1559       ],
1560       'primary_key' => 'portnum',
1561       'unique'      => [],
1562       'index'       => [],
1563     },
1564
1565     'nas' => {
1566       'columns' => [
1567         'nasnum',   'serial',     '',    '', '', '',
1568         'nas',      'varchar', '',    $char_d, '', '',
1569         'nasip',    'varchar', '',    15, '', '',
1570         'nasfqdn',  'varchar', '',    $char_d, '', '',
1571         'last',     'int',     '',    '', '', '',
1572       ],
1573       'primary_key' => 'nasnum',
1574       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
1575       'index'       => [ [ 'last' ] ],
1576     },
1577
1578 #    'session' => {
1579 #      'columns' => [
1580 #        'sessionnum', 'serial',       '',   '', '', '',
1581 #        'portnum',    'int',       '',   '', '', '',
1582 #        'svcnum',     'int',       '',   '', '', '',
1583 #        'login',      @date_type, '', '',
1584 #        'logout',     @date_type, '', '',
1585 #      ],
1586 #      'primary_key' => 'sessionnum',
1587 #      'unique'      => [],
1588 #      'index'       => [ [ 'portnum' ] ],
1589 #    },
1590
1591     'queue' => {
1592       'columns' => [
1593         'jobnum',      'serial',     '',      '', '', '',
1594         'job',           'text',     '',      '', '', '',
1595         '_date',          'int',     '',      '', '', '',
1596         'status',     'varchar',     '', $char_d, '', '',
1597         'statustext',    'text', 'NULL',      '', '', '',
1598         'svcnum',         'int', 'NULL',      '', '', '',
1599         'custnum',        'int', 'NULL',      '', '', '',
1600         'secure',        'char', 'NULL',       1, '', '',
1601         'priority',       'int', 'NULL',      '', '', '',
1602       ],
1603       'primary_key' => 'jobnum',
1604       'unique'      => [],
1605       'index'       => [ [ 'secure' ], [ 'priority' ],
1606                          [ 'job' ], [ 'svcnum' ], [ 'custnum' ], [ 'status' ],
1607                        ],
1608     },
1609
1610     'queue_arg' => {
1611       'columns' => [
1612         'argnum', 'serial', '', '', '', '',
1613         'jobnum', 'int', '', '', '', '',
1614         'arg', 'text', 'NULL', '', '', '',
1615       ],
1616       'primary_key' => 'argnum',
1617       'unique'      => [],
1618       'index'       => [ [ 'jobnum' ] ],
1619     },
1620
1621     'queue_depend' => {
1622       'columns' => [
1623         'dependnum', 'serial', '', '', '', '',
1624         'jobnum', 'int', '', '', '', '',
1625         'depend_jobnum', 'int', '', '', '', '',
1626       ],
1627       'primary_key' => 'dependnum',
1628       'unique'      => [],
1629       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1630     },
1631
1632     'export_svc' => {
1633       'columns' => [
1634         'exportsvcnum' => 'serial', '', '', '', '',
1635         'exportnum'    => 'int', '', '', '', '',
1636         'svcpart'      => 'int', '', '', '', '',
1637       ],
1638       'primary_key' => 'exportsvcnum',
1639       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1640       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1641     },
1642
1643     'part_export' => {
1644       'columns' => [
1645         'exportnum', 'serial', '', '', '', '',
1646         'machine', 'varchar', '', $char_d, '', '',
1647         'exporttype', 'varchar', '', $char_d, '', '',
1648         'nodomain',     'char', 'NULL', 1, '', '',
1649       ],
1650       'primary_key' => 'exportnum',
1651       'unique'      => [],
1652       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1653     },
1654
1655     'part_export_option' => {
1656       'columns' => [
1657         'optionnum', 'serial', '', '', '', '',
1658         'exportnum', 'int', '', '', '', '',
1659         'optionname', 'varchar', '', $char_d, '', '',
1660         'optionvalue', 'text', 'NULL', '', '', '',
1661       ],
1662       'primary_key' => 'optionnum',
1663       'unique'      => [],
1664       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1665     },
1666
1667     'radius_usergroup' => {
1668       'columns' => [
1669         'usergroupnum', 'serial', '', '', '', '',
1670         'svcnum',       'int', '', '', '', '',
1671         'groupname',    'varchar', '', $char_d, '', '',
1672       ],
1673       'primary_key' => 'usergroupnum',
1674       'unique'      => [],
1675       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1676     },
1677
1678     'msgcat' => {
1679       'columns' => [
1680         'msgnum', 'serial', '', '', '', '',
1681         'msgcode', 'varchar', '', $char_d, '', '',
1682         'locale', 'varchar', '', 16, '', '',
1683         'msg', 'text', '', '', '', '',
1684       ],
1685       'primary_key' => 'msgnum',
1686       'unique'      => [ [ 'msgcode', 'locale' ] ],
1687       'index'       => [],
1688     },
1689
1690     'cust_tax_exempt' => {
1691       'columns' => [
1692         'exemptnum', 'serial', '', '', '', '',
1693         'custnum',   'int', '', '', '', '',
1694         'taxnum',    'int', '', '', '', '',
1695         'year',      'int', '', '', '', '',
1696         'month',     'int', '', '', '', '',
1697         'amount',   @money_type, '', '',
1698       ],
1699       'primary_key' => 'exemptnum',
1700       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1701       'index'       => [],
1702     },
1703
1704     'cust_tax_exempt_pkg' => {
1705       'columns' => [
1706         'exemptpkgnum',  'serial', '', '', '', '',
1707         #'custnum',      'int', '', '', '', ''
1708         'billpkgnum',   'int', '', '', '', '',
1709         'taxnum',       'int', '', '', '', '',
1710         'year',         'int', '', '', '', '',
1711         'month',        'int', '', '', '', '',
1712         'amount',       @money_type, '', '',
1713       ],
1714       'primary_key' => 'exemptpkgnum',
1715       'unique' => [],
1716       'index'  => [ [ 'taxnum', 'year', 'month' ],
1717                     [ 'billpkgnum' ],
1718                     [ 'taxnum' ]
1719                   ],
1720     },
1721
1722     'router' => {
1723       'columns' => [
1724         'routernum', 'serial', '', '', '', '',
1725         'routername', 'varchar', '', $char_d, '', '',
1726         'svcnum', 'int', 'NULL', '', '', '',
1727         'agentnum',   'int', 'NULL', '', '', '',
1728       ],
1729       'primary_key' => 'routernum',
1730       'unique'      => [],
1731       'index'       => [],
1732     },
1733
1734     'part_svc_router' => {
1735       'columns' => [
1736         'svcrouternum', 'serial', '', '', '', '',
1737         'svcpart', 'int', '', '', '', '',
1738         'routernum', 'int', '', '', '', '',
1739       ],
1740       'primary_key' => 'svcrouternum',
1741       'unique'      => [],
1742       'index'       => [],
1743     },
1744
1745     'addr_block' => {
1746       'columns' => [
1747         'blocknum', 'serial', '', '', '', '',
1748         'routernum', 'int', '', '', '', '',
1749         'ip_gateway', 'varchar', '', 15, '', '',
1750         'ip_netmask', 'int', '', '', '', '',
1751         'agentnum',   'int', 'NULL', '', '', '',
1752         'manual_flag', 'char', 'NULL', 1, '', '',
1753       ],
1754       'primary_key' => 'blocknum',
1755       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1756       'index'       => [],
1757     },
1758
1759     'svc_broadband' => {
1760       'columns' => [
1761         'svcnum', 'int', '', '', '', '',
1762         'description', 'varchar', 'NULL', $char_d, '', '',
1763         'blocknum', 'int', '', '', '', '',
1764         'speed_up', 'int', '', '', '', '',
1765         'speed_down', 'int', '', '', '', '',
1766         'ip_addr', 'varchar', '', 15, '', '',
1767         'mac_addr', 'varchar', 'NULL', 12, '', '',
1768         'authkey',  'varchar', 'NULL', 32, '', '',
1769         'latitude', 'decimal', 'NULL', '', '', '',
1770         'longitude', 'decimal', 'NULL', '', '', '',
1771         'altitude', 'decimal', 'NULL', '', '', '',
1772         'vlan_profile', 'varchar', 'NULL', $char_d, '', '',
1773         'performance_profile', 'varchar', 'NULL', $char_d, '', '',
1774       ],
1775       'primary_key' => 'svcnum',
1776       'unique'      => [ [ 'mac_addr' ] ],
1777       'index'       => [],
1778     },
1779
1780     'part_virtual_field' => {
1781       'columns' => [
1782         'vfieldpart', 'serial', '', '', '', '',
1783         'dbtable', 'varchar', '', 32, '', '',
1784         'name', 'varchar', '', 32, '', '',
1785         'check_block', 'text', 'NULL', '', '', '',
1786         'length', 'int', 'NULL', '', '', '',
1787         'list_source', 'text', 'NULL', '', '', '',
1788         'label', 'varchar', 'NULL', 80, '', '',
1789       ],
1790       'primary_key' => 'vfieldpart',
1791       'unique' => [],
1792       'index' => [],
1793     },
1794
1795     'virtual_field' => {
1796       'columns' => [
1797         'vfieldnum', 'serial', '', '', '', '',
1798         'recnum', 'int', '', '', '', '',
1799         'vfieldpart', 'int', '', '', '', '',
1800         'value', 'varchar', '', 128, '', '',
1801       ],
1802       'primary_key' => 'vfieldnum',
1803       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1804       'index' => [],
1805     },
1806
1807     'acct_snarf' => {
1808       'columns' => [
1809         'snarfnum',  'int', '', '', '', '',
1810         'svcnum',    'int', '', '', '', '',
1811         'machine',   'varchar', '', 255, '', '',
1812         'protocol',  'varchar', '', $char_d, '', '',
1813         'username',  'varchar', '', $char_d, '', '',
1814         '_password', 'varchar', '', $char_d, '', '',
1815       ],
1816       'primary_key' => 'snarfnum',
1817       'unique' => [],
1818       'index'  => [ [ 'svcnum' ] ],
1819     },
1820
1821     'svc_external' => {
1822       'columns' => [
1823         'svcnum', 'int', '', '', '', '',
1824         'id',     'int', 'NULL', '', '', '',
1825         'title',  'varchar', 'NULL', $char_d, '', '',
1826       ],
1827       'primary_key' => 'svcnum',
1828       'unique'      => [],
1829       'index'       => [],
1830     },
1831
1832     'cust_pay_refund' => {
1833       'columns' => [
1834         'payrefundnum', 'serial', '', '', '', '',
1835         'paynum',  'int', '', '', '', '',
1836         'refundnum',  'int', '', '', '', '',
1837         '_date',    @date_type, '', '',
1838         'amount',   @money_type, '', '',
1839       ],
1840       'primary_key' => 'payrefundnum',
1841       'unique' => [],
1842       'index' => [ ['paynum'], ['refundnum'] ],
1843     },
1844
1845     'part_pkg_option' => {
1846       'columns' => [
1847         'optionnum', 'serial', '', '', '', '',
1848         'pkgpart', 'int', '', '', '', '',
1849         'optionname', 'varchar', '', $char_d, '', '',
1850         'optionvalue', 'text', 'NULL', '', '', '',
1851       ],
1852       'primary_key' => 'optionnum',
1853       'unique'      => [],
1854       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1855     },
1856
1857     'part_pkg_report_option' => {
1858       'columns' => [
1859         'num',      'serial',   '',      '', '', '',
1860         'name',     'varchar',  '', $char_d, '', '',
1861         'disabled', 'char', 'NULL',       1, '', '',
1862       ],
1863       'primary_key' => 'num',
1864       'unique' => [ [ 'name' ] ],
1865       'index' => [ [ 'disabled' ] ],
1866     },
1867
1868     'rate' => {
1869       'columns' => [
1870         'ratenum',  'serial', '', '', '', '',
1871         'ratename', 'varchar', '', $char_d, '', '',
1872       ],
1873       'primary_key' => 'ratenum',
1874       'unique'      => [],
1875       'index'       => [],
1876     },
1877
1878     'rate_detail' => {
1879       'columns' => [
1880         'ratedetailnum',   'serial', '', '', '', '',
1881         'ratenum',         'int',     '', '', '', '',
1882         'orig_regionnum',  'int', 'NULL', '', '', '',
1883         'dest_regionnum',  'int',     '', '', '', '',
1884         'min_included',    'int',     '', '', '', '',
1885         #'min_charge',      @money_type, '', '',
1886         'min_charge',      'decimal', '', '10,5', '', '',
1887         'sec_granularity', 'int',     '', '', '', '',
1888         #time period (link to table of periods)?
1889         'classnum',        'int',     'NULL', '', '', '',
1890       ],
1891       'primary_key' => 'ratedetailnum',
1892       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1893       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1894     },
1895
1896     'rate_region' => {
1897       'columns' => [
1898         'regionnum',   'serial',      '', '', '', '',
1899         'regionname',  'varchar',     '', $char_d, '', '',
1900       ],
1901       'primary_key' => 'regionnum',
1902       'unique'      => [],
1903       'index'       => [],
1904     },
1905
1906     'rate_prefix' => {
1907       'columns' => [
1908         'prefixnum',   'serial',      '', '', '', '',
1909         'regionnum',   'int',         '', '', '', '',
1910         'countrycode', 'varchar',     '',  3, '', '',
1911         'npa',         'varchar', 'NULL', 10, '', '', #actually the whole prefix
1912         'nxx',         'varchar', 'NULL',  3, '', '', #actually not used
1913       ],
1914       'primary_key' => 'prefixnum',
1915       'unique'      => [],
1916       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1917     },
1918
1919     'usage_class' => {
1920       'columns' => [
1921         'classnum',    'serial',   '',      '', '', '',
1922         'classname',   'varchar',  '', $char_d, '', '',
1923         'disabled',    'char', 'NULL',       1, '', '',
1924       ],
1925       'primary_key' => 'classnum',
1926       'unique' => [],
1927       'index' => [ ['disabled'] ],
1928     },
1929
1930     'reg_code' => {
1931       'columns' => [
1932         'codenum',   'serial',    '', '', '', '',
1933         'code',      'varchar',   '', $char_d, '', '',
1934         'agentnum',  'int',       '', '', '', '',
1935       ],
1936       'primary_key' => 'codenum',
1937       'unique'      => [ [ 'agentnum', 'code' ] ],
1938       'index'       => [ [ 'agentnum' ] ],
1939     },
1940
1941     'reg_code_pkg' => {
1942       'columns' => [
1943         'codepkgnum', 'serial', '', '', '', '',
1944         'codenum',   'int',    '', '', '', '',
1945         'pkgpart',   'int',    '', '', '', '',
1946       ],
1947       'primary_key' => 'codepkgnum',
1948       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1949       'index'       => [ [ 'codenum' ] ],
1950     },
1951
1952     'clientapi_session' => {
1953       'columns' => [
1954         'sessionnum',  'serial',  '', '', '', '',
1955         'sessionid',  'varchar',  '', $char_d, '', '',
1956         'namespace',  'varchar',  '', $char_d, '', '',
1957       ],
1958       'primary_key' => 'sessionnum',
1959       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1960       'index'       => [],
1961     },
1962
1963     'clientapi_session_field' => {
1964       'columns' => [
1965         'fieldnum',    'serial',     '', '', '', '',
1966         'sessionnum',     'int',     '', '', '', '',
1967         'fieldname',  'varchar',     '', $char_d, '', '',
1968         'fieldvalue',    'text', 'NULL', '', '', '',
1969       ],
1970       'primary_key' => 'fieldnum',
1971       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1972       'index'       => [],
1973     },
1974
1975     'payment_gateway' => {
1976       'columns' => [
1977         'gatewaynum',       'serial',   '',     '', '', '',
1978         'gateway_namespace','varchar',  'NULL', $char_d, '', '',
1979         'gateway_module',   'varchar',  '',     $char_d, '', '',
1980         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1981         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1982         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1983         'gateway_callback_url', 'varchar',  'NULL', $char_d, '', '',
1984         'disabled',   'char',  'NULL',   1, '', '',
1985       ],
1986       'primary_key' => 'gatewaynum',
1987       'unique' => [],
1988       'index'  => [ [ 'disabled' ] ],
1989     },
1990
1991     'payment_gateway_option' => {
1992       'columns' => [
1993         'optionnum',   'serial',  '',     '', '', '',
1994         'gatewaynum',  'int',     '',     '', '', '',
1995         'optionname',  'varchar', '',     $char_d, '', '',
1996         'optionvalue', 'text',    'NULL', '', '', '',
1997       ],
1998       'primary_key' => 'optionnum',
1999       'unique'      => [],
2000       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
2001     },
2002
2003     'agent_payment_gateway' => {
2004       'columns' => [
2005         'agentgatewaynum', 'serial', '', '', '', '',
2006         'agentnum',        'int', '', '', '', '',
2007         'gatewaynum',      'int', '', '', '', '',
2008         'cardtype',        'varchar', 'NULL', $char_d, '', '',
2009         'taxclass',        'varchar', 'NULL', $char_d, '', '',
2010       ],
2011       'primary_key' => 'agentgatewaynum',
2012       'unique'      => [],
2013       'index'       => [ [ 'agentnum', 'cardtype' ], ],
2014     },
2015
2016     'banned_pay' => {
2017       'columns' => [
2018         'bannum',  'serial',   '',     '', '', '',
2019         'payby',   'char',     '',       4, '', '',
2020         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
2021         #'paymask', 'varchar',  'NULL', $char_d, '', ''
2022         '_date',   @date_type, '', '',
2023         'otaker',  'varchar',  '',     32, '', '',
2024         'reason',  'varchar',  'NULL', $char_d, '', '',
2025       ],
2026       'primary_key' => 'bannum',
2027       'unique'      => [ [ 'payby', 'payinfo' ] ],
2028       'index'       => [],
2029     },
2030
2031     'pkg_category' => {
2032       'columns' => [
2033         'categorynum',   'serial',  '', '', '', '',
2034         'categoryname',  'varchar', '', $char_d, '', '',
2035         'disabled',      'char', 'NULL',   1, '', '',
2036       ],
2037       'primary_key' => 'categorynum',
2038       'unique' => [],
2039       'index' => [ ['disabled'] ],
2040     },
2041
2042     'pkg_class' => {
2043       'columns' => [
2044         'classnum',    'serial',   '',      '', '', '',
2045         'classname',   'varchar',  '', $char_d, '', '',
2046         'categorynum', 'int',  'NULL',      '', '', '',
2047         'disabled',    'char', 'NULL',       1, '', '',
2048       ],
2049       'primary_key' => 'classnum',
2050       'unique' => [],
2051       'index' => [ ['disabled'] ],
2052     },
2053
2054     'cdr' => {
2055       'columns' => [
2056         # qw( name type null length default local );
2057
2058         ###
2059         #asterisk fields
2060         ###
2061
2062         'acctid',   'bigserial',  '', '', '', '',
2063         #'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
2064         'calldate', 'timestamp',   '',      '', \'now()', '',
2065         'clid',        'varchar',  '', $char_d, \"''", '',
2066         'src',         'varchar',  '', $char_d, \"''", '',
2067         'dst',         'varchar',  '', $char_d, \"''", '',
2068         'dcontext',    'varchar',  '', $char_d, \"''", '',
2069         'channel',     'varchar',  '', $char_d, \"''", '',
2070         'dstchannel',  'varchar',  '', $char_d, \"''", '',
2071         'lastapp',     'varchar',  '', $char_d, \"''", '',
2072         'lastdata',    'varchar',  '', $char_d, \"''", '',
2073
2074         #these don't seem to be logged by most of the SQL cdr_* modules
2075         #except tds under sql-illegal names, so;
2076         # ... don't rely on them for rating?
2077         # and, what they hey, i went ahead and changed the names and data types
2078         # to freeside-style dates...
2079           #'start',  'timestamp', 'NULL',  '',    '', '',
2080           #'answer', 'timestamp', 'NULL',  '',    '', '',
2081           #'end',    'timestamp', 'NULL',  '',    '', '',
2082         'startdate',  @date_type, '', '',
2083         'answerdate', @date_type, '', '',
2084         'enddate',    @date_type, '', '',
2085         #
2086
2087         'duration',    'int',      '',      '',     0, '',
2088         'billsec',     'int',      '',      '',     0, '',
2089         'disposition', 'varchar',  '',      45, \"''", '',
2090         'amaflags',    'int',      '',      '',     0, '',
2091         'accountcode', 'varchar',  '',      20, \"''", '',
2092         'uniqueid',    'varchar',  '',      32, \"''", '',
2093         'userfield',   'varchar',  '',     255, \"''", '',
2094
2095         ###
2096         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
2097         # defaults
2098         ###
2099
2100         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
2101         'cdrtypenum',              'int', 'NULL',      '', '', '',
2102
2103         'charged_party',       'varchar', 'NULL', $char_d, '', '',
2104
2105         'upstream_currency',      'char', 'NULL',       3, '', '',
2106         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
2107         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
2108
2109         # how it was rated internally...
2110         'ratedetailnum',           'int', 'NULL',      '', '', '',
2111         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
2112
2113         'distance',            'decimal', 'NULL',      '', '', '',
2114         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
2115
2116         #cdr_calltype: the big list in appendix 2
2117         'calltypenum',             'int', 'NULL',      '', '', '',
2118
2119         'description',         'varchar', 'NULL', $char_d, '', '',
2120         'quantity',                'int', 'NULL',      '', '', '',
2121
2122         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
2123         'carrierid',               'int', 'NULL',      '', '', '',
2124
2125         'upstream_rateid',         'int', 'NULL',      '', '', '',
2126
2127         ###
2128         #and now for our own fields
2129         ###
2130
2131         # a svcnum... right..?
2132         'svcnum',             'int',   'NULL',     '',   '', '',
2133
2134         #NULL, done (or something)
2135         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
2136
2137         #NULL, done (or something)
2138         'freesiderewritestatus', 'varchar',   'NULL',     32,   '', '',
2139
2140         'cdrbatch', 'varchar', 'NULL', 255, '', '',
2141
2142       ],
2143       'primary_key' => 'acctid',
2144       'unique' => [],
2145       'index' => [ [ 'calldate' ], [ 'src' ], [ 'dst' ], [ 'charged_party' ], [ 'accountcode' ], [ 'freesidestatus' ], [ 'freesiderewritestatus' ], [ 'cdrbatch' ], ],
2146     },
2147
2148     'cdr_termination' => {
2149       'columns' => [
2150         'cdrtermnum', 'bigserial', '',   '', '', '',
2151         'acctid',        'bigint', '',   '', '', '',
2152         'termpart',         'int', '',   '', '', '',#future expansion, see below
2153         'rated_price',  @money_typen,        '', '',
2154         'status',     'varchar', 'NULL', 32, '', '',
2155       ],
2156       'primary_key' => 'cdrtermnum',
2157       'unique'      => [ [ 'acctid', 'termpart' ] ],
2158       'index'       => [ [ 'acctid' ], [ 'status' ], ],
2159     },
2160
2161     #to handle multiple termination/settlement passes...
2162    # 'part_termination' => {
2163    #   'columns' => [
2164    #     'termpart',       'int', '',      '', '', '',
2165    #     'termname',   'varchar', '', $char_d, '', '',
2166    #     'cdr_column', 'varchar', '', $char_d, '', '', #maybe set it here instead of in the price plan?
2167    #   ],
2168    #   'primary_key' => 'termpart',
2169    #   'unique' => [],
2170    #   'index'  => [],
2171    # },
2172
2173     #the remaining cdr_ tables are not really used
2174     'cdr_calltype' => {
2175       'columns' => [
2176         'calltypenum',   'serial',  '', '', '', '',
2177         'calltypename',  'varchar', '', $char_d, '', '',
2178       ],
2179       'primary_key' => 'calltypenum',
2180       'unique'      => [],
2181       'index'       => [],
2182     },
2183
2184     'cdr_type' => {
2185       'columns' => [
2186         'cdrtypenum'  => 'serial',  '', '', '', '',
2187         'cdrtypename' => 'varchar', '', $char_d, '', '',
2188       ],
2189       'primary_key' => 'cdrtypenum',
2190       'unique'      => [],
2191       'index'       => [],
2192     },
2193
2194     'cdr_carrier' => {
2195       'columns' => [
2196         'carrierid'   => 'serial',  '', '', '', '',
2197         'carriername' => 'varchar', '', $char_d, '', '',
2198       ],
2199       'primary_key' => 'carrierid',
2200       'unique'      => [],
2201       'index'       => [],
2202     },
2203
2204     #map upstream rateid to ours...
2205     'cdr_upstream_rate' => {
2206       'columns' => [
2207         'upstreamratenum', 'serial',  '', '', '', '',
2208         'upstream_rateid', 'varchar', '', $char_d, '', '',
2209         'ratedetailnum',   'int', 'NULL', '', '', '',
2210       ],
2211       'primary_key' => 'upstreamratenum', #XXX need a primary key
2212       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
2213       'index'  => [],
2214     },
2215
2216     #'cdr_file' => {
2217     #  'columns' => [
2218     #    'filenum',    'serial',     '', '', '', '',
2219     #    'filename',  'varchar',     '', '', '', '',
2220     #    'status',    'varchar', 'NULL', '', '', '',
2221     #  ],
2222     #  'primary_key' => 'filenum',
2223     #  'unique' => [ [ 'filename' ], ], #just change the index if we need to
2224     #                                   # agent-virtualize or have a customer
2225     #                                   # with dup-filename needs or something
2226     #                                   # (only used by cdr.http_and_import for
2227     #                                   #  chrissakes)
2228     #  'index'  => [],
2229     #},
2230
2231     'inventory_item' => {
2232       'columns' => [
2233         'itemnum',  'serial',      '',      '', '', '',
2234         'classnum', 'int',         '',      '', '', '',
2235         'item',     'varchar',     '', $char_d, '', '',
2236         'svcnum',   'int',     'NULL',      '', '', '',
2237       ],
2238       'primary_key' => 'itemnum',
2239       'unique' => [ [ 'classnum', 'item' ] ],
2240       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
2241     },
2242
2243     'inventory_class' => {
2244       'columns' => [
2245         'classnum',  'serial',       '',      '', '', '',
2246         'classname', 'varchar',      '', $char_d, '', '',
2247       ],
2248       'primary_key' => 'classnum',
2249       'unique' => [],
2250       'index'  => [],
2251     },
2252
2253     'access_user' => {
2254       'columns' => [
2255         'usernum',   'serial',  '',      '', '', '',
2256         'username',  'varchar', '', $char_d, '', '',
2257         '_password', 'varchar', '', $char_d, '', '',
2258         'last',      'varchar', '', $char_d, '', '',
2259         'first',     'varchar', '', $char_d, '', '',
2260         'disabled',     'char', 'NULL',   1, '', '',
2261       ],
2262       'primary_key' => 'usernum',
2263       'unique' => [ [ 'username' ] ],
2264       'index'  => [],
2265     },
2266
2267     'access_user_pref' => {
2268       'columns' => [
2269         'prefnum',    'serial',       '', '', '', '',
2270         'usernum',     'int',       '', '', '', '',
2271         'prefname', 'varchar', '', $char_d, '', '',
2272         'prefvalue', 'text', 'NULL', '', '', '',
2273         'expiration', @date_type, '', '',
2274       ],
2275       'primary_key' => 'prefnum',
2276       'unique' => [],
2277       'index'  => [ [ 'usernum' ] ],
2278     },
2279
2280     'access_group' => {
2281       'columns' => [
2282         'groupnum',   'serial', '',      '', '', '',
2283         'groupname', 'varchar', '', $char_d, '', '',
2284       ],
2285       'primary_key' => 'groupnum',
2286       'unique' => [ [ 'groupname' ] ],
2287       'index'  => [],
2288     },
2289
2290     'access_usergroup' => {
2291       'columns' => [
2292         'usergroupnum', 'serial', '', '', '', '',
2293         'usernum',         'int', '', '', '', '',
2294         'groupnum',        'int', '', '', '', '',
2295       ],
2296       'primary_key' => 'usergroupnum',
2297       'unique' => [ [ 'usernum', 'groupnum' ] ],
2298       'index'  => [ [ 'usernum' ] ],
2299     },
2300
2301     'access_groupagent' => {
2302       'columns' => [
2303         'groupagentnum', 'serial', '', '', '', '',
2304         'groupnum',         'int', '', '', '', '',
2305         'agentnum',         'int', '', '', '', '',
2306       ],
2307       'primary_key' => 'groupagentnum',
2308       'unique' => [ [ 'groupnum', 'agentnum' ] ],
2309       'index'  => [ [ 'groupnum' ] ],
2310     },
2311
2312     'access_right' => {
2313       'columns' => [
2314         'rightnum',   'serial', '',      '', '', '',
2315         'righttype', 'varchar', '', $char_d, '', '',
2316         'rightobjnum',   'int', '',      '', '', '',
2317         'rightname', 'varchar', '', $char_d, '', '',
2318       ],
2319       'primary_key' => 'rightnum',
2320       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
2321       'index'  => [],
2322     },
2323
2324     'svc_phone' => {
2325       'columns' => [
2326         'svcnum',       'int',         '',      '', '', '',
2327         'countrycode',  'varchar',     '',       3, '', '',
2328         'phonenum',     'varchar',     '',      15, '', '',  #12 ?
2329         'pin',          'varchar', 'NULL', $char_d, '', '',
2330         'sip_password', 'varchar', 'NULL', $char_d, '', '',
2331         'phone_name',   'varchar', 'NULL', $char_d, '', '',
2332       ],
2333       'primary_key' => 'svcnum',
2334       'unique' => [],
2335       'index'  => [ [ 'countrycode', 'phonenum' ] ],
2336     },
2337
2338     'phone_device' => {
2339       'columns' => [
2340         'devicenum', 'serial',     '', '', '', '',
2341         'devicepart',   'int',     '', '', '', '',
2342         'svcnum',       'int',     '', '', '', '',
2343         'mac_addr', 'varchar', 'NULL', 12, '', '',
2344       ],
2345       'primary_key' => 'devicenum',
2346       'unique' => [ [ 'mac_addr' ], ],
2347       'index'  => [ [ 'devicepart' ], [ 'svcnum' ], ],
2348     },
2349
2350     'part_device' => {
2351       'columns' => [
2352         'devicepart', 'serial',  '',      '', '', '',
2353         'devicename', 'varchar', '', $char_d, '', '',
2354         #'classnum', #tie to an inventory class?
2355       ],
2356       'primary_key' => 'devicepart',
2357       'unique' => [ [ 'devicename' ] ], #?
2358       'index'  => [],
2359     },
2360
2361     'phone_avail' => {
2362       'columns' => [
2363         'availnum',    'serial',      '',      '', '', '',
2364         'exportnum',   'int',         '',      '', '', '',
2365         'countrycode', 'varchar',     '',       3, '', '',
2366         'state',       'char',    'NULL',       2, '', '',
2367         'npa',         'char',        '',       3, '', '',
2368         'nxx',         'char',    'NULL',       3, '', '',
2369         'station',     'char',    'NULL',       4, '', '',
2370         'name',        'varchar', 'NULL', $char_d, '', '',
2371         'svcnum',      'int',     'NULL',      '', '', '',
2372         'availbatch', 'varchar',  'NULL', $char_d, '', '',
2373       ],
2374       'primary_key' => 'availnum',
2375       'unique' => [],
2376       'index'  => [ [ 'exportnum', 'countrycode', 'state' ],     #npa search
2377                     [ 'exportnum', 'countrycode', 'npa' ],       #nxx search
2378                     [ 'exportnum', 'countrycode', 'npa', 'nxx' ],#station search
2379                     [ 'exportnum', 'countrycode', 'npa', 'nxx', 'station' ], # #
2380                     [ 'svcnum' ],
2381                     [ 'availbatch' ],
2382                   ],
2383     },
2384
2385     'reason_type' => {
2386       'columns' => [
2387         'typenum',   'serial',  '', '', '', '',
2388         'class',     'char', '', 1, '', '',
2389         'type',     'varchar', '', $char_d, '', '',
2390       ],
2391       'primary_key' => 'typenum',
2392       'unique' => [],
2393       'index' => [],
2394     },
2395
2396     'reason' => {
2397       'columns' => [
2398         'reasonnum',     'serial',  '', '', '', '',
2399         'reason_type',   'int',  '', '', '', '',
2400         'reason',        'text', '', '', '', '',
2401         'disabled',      'char',    'NULL', 1, '', '',
2402       ],
2403       'primary_key' => 'reasonnum',
2404       'unique' => [],
2405       'index' => [],
2406     },
2407
2408     'conf' => {
2409       'columns' => [
2410         'confnum',  'serial',  '', '', '', '',
2411         'agentnum', 'int',  'NULL', '', '', '',
2412         'name',     'varchar', '', $char_d, '', '',
2413         'value',    'text', 'NULL', '', '', '',
2414       ],
2415       'primary_key' => 'confnum',
2416       'unique' => [ [ 'agentnum', 'name' ]],
2417       'index' => [],
2418     },
2419
2420     'pkg_referral' => {
2421       'columns' => [
2422         'pkgrefnum',     'serial', '', '', '', '',
2423         'pkgnum',        'int',    '', '', '', '',
2424         'refnum',        'int',    '', '', '', '',
2425       ],
2426       'primary_key' => 'pkgrefnum',
2427       'unique'      => [ [ 'pkgnum', 'refnum' ] ],
2428       'index'       => [ [ 'pkgnum' ], [ 'refnum' ] ],
2429     },
2430     # name type nullability length default local
2431
2432     #'new_table' => {
2433     #  'columns' => [
2434     #    'num', 'serial',       '', '', '', '',
2435     #  ],
2436     #  'primary_key' => 'num',
2437     #  'unique' => [],
2438     #  'index'  => [],
2439     #},
2440
2441   };
2442
2443 }
2444
2445 =back
2446
2447 =head1 BUGS
2448
2449 =head1 SEE ALSO
2450
2451 L<DBIx::DBSchema>
2452
2453 =cut
2454
2455 1;
2456