FS/FS/Schema.pm

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