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