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