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