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