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