FS/FS/Schema.pm

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