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