FS/FS/Schema.pm

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