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