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