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