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