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