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