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.30;
   7 use DBIx::DBSchema::Table;
   8 use DBIx::DBSchema::Column 0.06;
   9 use DBIx::DBSchema::ColGroup::Unique;
  10 use DBIx::DBSchema::ColGroup::Index;
  11 use FS::UID qw(datasrc);
  12
  13 @ISA = qw(Exporter);
  14 @EXPORT_OK = qw( dbdef dbdef_dist reload_dbdef );
  15
  16 $DEBUG = 0;
  17 $me = '[FS::Schema]';
  18
  19 =head1 NAME
  20
  21 FS::Schema - Freeside database schema
  22
  23 =head1 SYNOPSYS
  24
  25     use FS::Schema qw(dbdef dbdef_dist reload_dbdef);
  26
  27     $dbdef = reload_dbdef;
  28     $dbdef = reload_dbdef "/non/standard/filename";
  29     $dbdef = dbdef;
  30     $dbdef_dist = dbdef_dist;
  31
  32 =head1 DESCRIPTION
  33
  34 This class represents the database schema.
  35
  36 =head1 METHODS
  37
  38 =over 4
  39
  40 =item reload_dbdef([FILENAME])
  41
  42 Load a database definition (see L<DBIx::DBSchema>), optionally from a
  43 non-default filename.  This command is executed at startup unless
  44 I<$FS::Schema::setup_hack> is true.  Returns a DBIx::DBSchema object.
  45
  46 =cut
  47
  48 sub reload_dbdef {
  49   my $file = shift;
  50
  51   unless ( exists $dbdef_cache{$file} ) {
  52     warn "[debug]$me loading dbdef for $file\n" if $DEBUG;
  53     $dbdef_cache{$file} = DBIx::DBSchema->load( $file )
  54       or die "can't load database schema from $file: $DBIx::DBSchema::errstr\n";
  55   } else {
  56     warn "[debug]$me re-using cached dbdef for $file\n" if $DEBUG;
  57   }
  58   $dbdef = $dbdef_cache{$file};
  59 }
  60
  61 =item dbdef
  62
  63 Returns the current database definition (represents the current database,
  64 assuming it is up-to-date).  See L<DBIx::DBSchema>.
  65
  66 =cut
  67
  68 sub dbdef { $dbdef; }
  69
  70 =item dbdef_dist [ OPTION => VALUE ... ]
  71
  72 Returns the current canoical database definition as defined in this file.
  73
  74 =cut
  75
  76 sub dbdef_dist {
  77
  78   ###
  79   # create a dbdef object from the old data structure
  80   ###
  81
  82   my $tables_hashref = tables_hashref();
  83
  84   #turn it into objects
  85   my $dbdef = new DBIx::DBSchema map {
  86     my @columns;
  87     while (@{$tables_hashref->{$_}{'columns'}}) {
  88       #my($name, $type, $null, $length, $default, $local) =
  89       my @coldef =
  90         splice @{$tables_hashref->{$_}{'columns'}}, 0, 6;
  91       my %hash = map { $_ => shift @coldef }
  92                      qw( name type null length default local );
  93
  94       unless ( defined $hash{'default'} ) {
  95         warn "$_:\n".
  96              join('', map "$_ => $hash{$_}\n", keys %hash) ;# $stop = <STDIN>;
  97       }
  98
  99       push @columns, new DBIx::DBSchema::Column ( \%hash );
 100     }
 101     DBIx::DBSchema::Table->new(
 102       $_,
 103       $tables_hashref->{$_}{'primary_key'},
 104       DBIx::DBSchema::ColGroup::Unique->new($tables_hashref->{$_}{'unique'}),
 105       DBIx::DBSchema::ColGroup::Index->new($tables_hashref->{$_}{'index'}),
 106       @columns,
 107     );
 108   } keys %$tables_hashref;
 109
 110   if ( $DEBUG ) {
 111     warn "[debug]$me initial dbdef_dist created ($dbdef) with tables:\n";
 112     warn "[debug]$me   $_\n" foreach $dbdef->tables;
 113   }
 114
 115   my $cust_main = $dbdef->table('cust_main');
 116   #unless ($ship) { #remove ship_ from cust_main
 117   #  $cust_main->delcolumn($_) foreach ( grep /^ship_/, $cust_main->columns );
 118   #} else { #add indices
 119     push @{$cust_main->index->lol_ref},
 120       map { [ "ship_$_" ] } qw( last company daytime night fax );
 121   #}
 122
 123   #add radius attributes to svc_acct
 124   #
 125   #my($svc_acct)=$dbdef->table('svc_acct');
 126   #
 127   #my($attribute);
 128   #foreach $attribute (@attributes) {
 129   #  $svc_acct->addcolumn ( new DBIx::DBSchema::Column (
 130   #    'radius_'. $attribute,
 131   #    'varchar',
 132   #    'NULL',
 133   #    $char_d,
 134   #  ));
 135   #}
 136   #
 137   #foreach $attribute (@check_attributes) {
 138   #  $svc_acct->addcolumn( new DBIx::DBSchema::Column (
 139   #    'rc_'. $attribute,
 140   #    'varchar',
 141   #    'NULL',
 142   #    $char_d,
 143   #  ));
 144   #}
 145
 146   #create history tables (false laziness w/create-history-tables)
 147   foreach my $table (
 148     grep { ! /^clientapi_session/ }
 149     grep { ! /^h_/ }
 150     $dbdef->tables
 151   ) {
 152     my $tableobj = $dbdef->table($table)
 153       or die "unknown table $table";
 154
 155     die "unique->lol_ref undefined for $table"
 156       unless defined $tableobj->unique->lol_ref;
 157     die "index->lol_ref undefined for $table"
 158       unless defined $tableobj->index->lol_ref;
 159
 160     my $h_tableobj = DBIx::DBSchema::Table->new( {
 161       name        => "h_$table",
 162       primary_key => 'historynum',
 163       unique      => DBIx::DBSchema::ColGroup::Unique->new( [] ),
 164       'index'     => DBIx::DBSchema::ColGroup::Index->new( [
 165                        @{$tableobj->unique->lol_ref},
 166                        @{$tableobj->index->lol_ref}
 167                      ] ),
 168       columns     => [
 169                        DBIx::DBSchema::Column->new( {
 170                          'name'    => 'historynum',
 171                          'type'    => 'serial',
 172                          'null'    => 'NOT NULL',
 173                          'length'  => '',
 174                          'default' => '',
 175                          'local'   => '',
 176                        } ),
 177                        DBIx::DBSchema::Column->new( {
 178                          'name'    => 'history_date',
 179                          'type'    => 'int',
 180                          'null'    => 'NULL',
 181                          'length'  => '',
 182                          'default' => '',
 183                          'local'   => '',
 184                        } ),
 185                        DBIx::DBSchema::Column->new( {
 186                          'name'    => 'history_user',
 187                          'type'    => 'varchar',
 188                          'null'    => 'NOT NULL',
 189                          'length'  => '80',
 190                          'default' => '',
 191                          'local'   => '',
 192                        } ),
 193                        DBIx::DBSchema::Column->new( {
 194                          'name'    => 'history_action',
 195                          'type'    => 'varchar',
 196                          'null'    => 'NOT NULL',
 197                          'length'  => '80',
 198                          'default' => '',
 199                          'local'   => '',
 200                        } ),
 201                        map {
 202                          my $column = $tableobj->column($_);
 203
 204                          #clone so as to not disturb the original
 205                          $column = DBIx::DBSchema::Column->new( {
 206                            map { $_ => $column->$_() }
 207                              qw( name type null length default local )
 208                          } );
 209
 210                          if ( $column->type eq 'serial' ) {
 211                            $column->type('int');
 212                            $column->null('NULL');
 213                          }
 214                          #$column->default('')
 215                          #  if $column->default =~ /^nextval\(/i;
 216                          #( my $local = $column->local ) =~ s/AUTO_INCREMENT//i;
 217                          #$column->local($local);
 218                          $column;
 219                        } $tableobj->columns
 220                      ],
 221     } );
 222     $dbdef->addtable($h_tableobj);
 223   }
 224
 225   $dbdef;
 226
 227 }
 228
 229 sub tables_hashref {
 230
 231   my $char_d = 80; #default maxlength for text fields
 232
 233   #my(@date_type)  = ( 'timestamp', '', ''     );
 234   my @date_type  = ( 'int', 'NULL', ''     );
 235   my @perl_type = ( 'text', 'NULL', ''  );
 236   my @money_type = ( 'decimal',   '', '10,2' );
 237
 238   my $username_len = 32; #usernamemax config file
 239
 240     # name type nullability length default local
 241
 242   return {
 243
 244     'agent' => {
 245       'columns' => [
 246         'agentnum', 'serial',            '',     '', '', '',
 247         'agent',    'varchar',           '',     $char_d, '', '',
 248         'typenum',  'int',            '',     '', '', '',
 249         'freq',     'int',       'NULL', '', '', '',
 250         'prog',     @perl_type, '', '',
 251         'disabled',     'char', 'NULL', 1, '', '',
 252         'username', 'varchar',       'NULL',     $char_d, '', '',
 253         '_password','varchar',       'NULL',     $char_d, '', '',
 254         'ticketing_queueid', 'int', 'NULL', '', '', '',
 255       ],
 256       'primary_key' => 'agentnum',
 257       'unique' => [],
 258       'index' => [ ['typenum'], ['disabled'] ],
 259     },
 260
 261     'agent_type' => {
 262       'columns' => [
 263         'typenum',   'serial',  '', '', '', '',
 264         'atype',     'varchar', '', $char_d, '', '',
 265       ],
 266       'primary_key' => 'typenum',
 267       'unique' => [],
 268       'index' => [],
 269     },
 270
 271     'type_pkgs' => {
 272       'columns' => [
 273         'typepkgnum', 'serial', '', '', '', '',
 274         'typenum',   'int',  '', '', '', '',
 275         'pkgpart',   'int',  '', '', '', '',
 276       ],
 277       'primary_key' => 'typepkgnum',
 278       'unique' => [ ['typenum', 'pkgpart'] ],
 279       'index' => [ ['typenum'] ],
 280     },
 281
 282     'cust_bill' => {
 283       'columns' => [
 284         'invnum',    'serial',  '', '', '', '',
 285         'custnum',   'int',  '', '', '', '',
 286         '_date',     @date_type, '', '',
 287         'charged',   @money_type, '', '',
 288         'printed',   'int',  '', '', '', '',
 289         'closed',    'char', 'NULL', 1, '', '',
 290       ],
 291       'primary_key' => 'invnum',
 292       'unique' => [],
 293       'index' => [ ['custnum'], ['_date'] ],
 294     },
 295
 296     'cust_bill_event' => {
 297       'columns' => [
 298         'eventnum',    'serial',  '', '', '', '',
 299         'invnum',   'int',  '', '', '', '',
 300         'eventpart',   'int',  '', '', '', '',
 301         '_date',     @date_type, '', '',
 302         'status', 'varchar', '', $char_d, '', '',
 303         'statustext', 'text', 'NULL', '', '', '',
 304       ],
 305       'primary_key' => 'eventnum',
 306       #no... there are retries now #'unique' => [ [ 'eventpart', 'invnum' ] ],
 307       'unique' => [],
 308       'index' => [ ['invnum'], ['status'] ],
 309     },
 310
 311     'part_bill_event' => {
 312       'columns' => [
 313         'eventpart',    'serial',  '', '', '', '',
 314         'freq',        'varchar',       'NULL',     $char_d, '', '',
 315         'payby',       'char',  '', 4, '', '',
 316         'event',       'varchar',           '',     $char_d, '', '',
 317         'eventcode',    @perl_type, '', '',
 318         'seconds',     'int', 'NULL', '', '', '',
 319         'weight',      'int', '', '', '', '',
 320         'plan',       'varchar', 'NULL', $char_d, '', '',
 321         'plandata',   'text', 'NULL', '', '', '',
 322         'reason',     'int', 'NULL', '', '', '',
 323         'disabled',     'char', 'NULL', 1, '', '',
 324       ],
 325       'primary_key' => 'eventpart',
 326       'unique' => [],
 327       'index' => [ ['payby'], ['disabled'], ],
 328     },
 329
 330     'cust_bill_pkg' => {
 331       'columns' => [
 332         'billpkgnum', 'serial', '', '', '', '',
 333         'pkgnum',  'int', '', '', '', '',
 334         'invnum',  'int', '', '', '', '',
 335         'setup',   @money_type, '', '',
 336         'recur',   @money_type, '', '',
 337         'sdate',   @date_type, '', '',
 338         'edate',   @date_type, '', '',
 339         'itemdesc', 'varchar', 'NULL', $char_d, '', '',
 340       ],
 341       'primary_key' => 'billpkgnum',
 342       'unique' => [],
 343       'index' => [ ['invnum'], [ 'pkgnum' ] ],
 344     },
 345
 346     'cust_bill_pkg_detail' => {
 347       'columns' => [
 348         'detailnum', 'serial', '', '', '', '',
 349         'pkgnum',  'int', '', '', '', '',
 350         'invnum',  'int', '', '', '', '',
 351         'detail',  'varchar', '', $char_d, '', '',
 352       ],
 353       'primary_key' => 'detailnum',
 354       'unique' => [],
 355       'index' => [ [ 'pkgnum', 'invnum' ] ],
 356     },
 357
 358     'cust_credit' => {
 359       'columns' => [
 360         'crednum',  'serial', '', '', '', '',
 361         'custnum',  'int', '', '', '', '',
 362         '_date',    @date_type, '', '',
 363         'amount',   @money_type, '', '',
 364         'otaker',   'varchar', '', 32, '', '',
 365         'reason',   'text', 'NULL', '', '', '',
 366         'closed',    'char', 'NULL', 1, '', '',
 367       ],
 368       'primary_key' => 'crednum',
 369       'unique' => [],
 370       'index' => [ ['custnum'] ],
 371     },
 372
 373     'cust_credit_bill' => {
 374       'columns' => [
 375         'creditbillnum', 'serial', '', '', '', '',
 376         'crednum',  'int', '', '', '', '',
 377         'invnum',  'int', '', '', '', '',
 378         '_date',    @date_type, '', '',
 379         'amount',   @money_type, '', '',
 380       ],
 381       'primary_key' => 'creditbillnum',
 382       'unique' => [],
 383       'index' => [ ['crednum'], ['invnum'] ],
 384     },
 385
 386     'cust_credit_bill_pkg' => {
 387       'columns' => [
 388         'creditbillpkgnum', 'serial', '',      '', '', '',
 389         'creditbillnum',       'int', '',      '', '', '',
 390         'billpkgnum',          'int', '',      '', '', '',
 391         'amount',            @money_type,          '', '',
 392         'setuprecur',      'varchar', '', $char_d, '', '',
 393         'sdate',   @date_type, '', '',
 394         'edate',   @date_type, '', '',
 395       ],
 396       'primary_key' => 'creditbillpkgnum',
 397       'unique'      => [],
 398       'index'       => [ [ 'creditbillnum' ], [ 'billpkgnum' ], ],
 399     },
 400
 401     'cust_main' => {
 402       'columns' => [
 403         'custnum',  'serial',  '',     '', '', '',
 404         'agentnum', 'int',  '',     '', '', '',
 405         'agent_custid', 'varchar', 'NULL', $char_d, '', '',
 406 #        'titlenum', 'int',  'NULL',   '', '', '',
 407         'last',     'varchar', '',     $char_d, '', '',
 408 #        'middle',   'varchar', 'NULL', $char_d, '', '',
 409         'first',    'varchar', '',     $char_d, '', '',
 410         'ss',       'varchar', 'NULL', 11, '', '',
 411         'birthdate',@date_type, '', '',
 412         'company',  'varchar', 'NULL', $char_d, '', '',
 413         'address1', 'varchar', '',     $char_d, '', '',
 414         'address2', 'varchar', 'NULL', $char_d, '', '',
 415         'city',     'varchar', '',     $char_d, '', '',
 416         'county',   'varchar', 'NULL', $char_d, '', '',
 417         'state',    'varchar', 'NULL', $char_d, '', '',
 418         'zip',      'varchar', 'NULL', 10, '', '',
 419         'country',  'char', '',     2, '', '',
 420         'daytime',  'varchar', 'NULL', 20, '', '',
 421         'night',    'varchar', 'NULL', 20, '', '',
 422         'fax',      'varchar', 'NULL', 12, '', '',
 423         'ship_last',     'varchar', 'NULL', $char_d, '', '',
 424 #        'ship_middle',   'varchar', 'NULL', $char_d, '', '',
 425         'ship_first',    'varchar', 'NULL', $char_d, '', '',
 426         'ship_company',  'varchar', 'NULL', $char_d, '', '',
 427         'ship_address1', 'varchar', 'NULL', $char_d, '', '',
 428         'ship_address2', 'varchar', 'NULL', $char_d, '', '',
 429         'ship_city',     'varchar', 'NULL', $char_d, '', '',
 430         'ship_county',   'varchar', 'NULL', $char_d, '', '',
 431         'ship_state',    'varchar', 'NULL', $char_d, '', '',
 432         'ship_zip',      'varchar', 'NULL', 10, '', '',
 433         'ship_country',  'char', 'NULL', 2, '', '',
 434         'ship_daytime',  'varchar', 'NULL', 20, '', '',
 435         'ship_night',    'varchar', 'NULL', 20, '', '',
 436         'ship_fax',      'varchar', 'NULL', 12, '', '',
 437         'payby',    'char', '',     4, '', '',
 438         'payinfo',  'varchar', 'NULL', 512, '', '',
 439         'paycvv',   'varchar', 'NULL', 512, '', '',
 440         'paymask', 'varchar', 'NULL', $char_d, '', '',
 441         #'paydate',  @date_type, '', '',
 442         'paydate',  'varchar', 'NULL', 10, '', '',
 443         'paystart_month', 'int', 'NULL', '', '', '',
 444         'paystart_year',  'int', 'NULL', '', '', '',
 445         'payissue', 'varchar', 'NULL', 2, '', '',
 446         'payname',  'varchar', 'NULL', $char_d, '', '',
 447         'payip',    'varchar', 'NULL', 15, '', '',
 448         'tax',      'char', 'NULL', 1, '', '',
 449         'otaker',   'varchar', '',    32, '', '',
 450         'refnum',   'int',  '',     '', '', '',
 451         'referral_custnum', 'int',  'NULL', '', '', '',
 452         'comments', 'text', 'NULL', '', '', '',
 453         'spool_cdr','char', 'NULL', 1, '', '',
 454       ],
 455       'primary_key' => 'custnum',
 456       'unique' => [ [ 'agentnum', 'agent_custid' ] ],
 457       #'index' => [ ['last'], ['company'] ],
 458       'index' => [ ['last'], [ 'company' ], [ 'referral_custnum' ],
 459                    [ 'daytime' ], [ 'night' ], [ 'fax' ], [ 'refnum' ],
 460                    [ 'county' ], [ 'state' ], [ 'country' ], [ 'zip' ],
 461                    [ 'ship_last' ], [ 'ship_company' ],
 462                    [ 'payby' ], [ 'paydate' ],
 463
 464                  ],
 465     },
 466
 467     'cust_main_invoice' => {
 468       'columns' => [
 469         'destnum',  'serial',  '',     '', '', '',
 470         'custnum',  'int',  '',     '', '', '',
 471         'dest',     'varchar', '',  $char_d, '', '',
 472       ],
 473       'primary_key' => 'destnum',
 474       'unique' => [],
 475       'index' => [ ['custnum'], ],
 476     },
 477
 478     'cust_main_note' => {
 479       'columns' => [
 480         'notenum',  'serial',  '',     '', '', '',
 481         'custnum',  'int',  '',     '', '', '',
 482         '_date',    @date_type, '', '',
 483         'otaker',   'varchar', '',    32, '', '',
 484         'comments', 'text', 'NULL', '', '', '',
 485       ],
 486       'primary_key' => 'notenum',
 487       'unique' => [],
 488       'index' => [ [ 'custnum' ], [ '_date' ], ],
 489     },
 490
 491     'cust_main_county' => { #county+state+country are checked off the
 492                             #cust_main_county for validation and to provide
 493                             # a tax rate.
 494       'columns' => [
 495         'taxnum',   'serial',   '',    '', '', '',
 496         'state',    'varchar',  'NULL',    $char_d, '', '',
 497         'county',   'varchar',  'NULL',    $char_d, '', '',
 498         'country',  'char',  '', 2, '', '',
 499         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 500         'exempt_amount', @money_type, '', '',
 501         'tax',      'real',  '',    '', '', '', #tax %
 502         'taxname',  'varchar',  'NULL',    $char_d, '', '',
 503         'setuptax',  'char', 'NULL', 1, '', '', # Y = setup tax exempt
 504         'recurtax',  'char', 'NULL', 1, '', '', # Y = recur tax exempt
 505       ],
 506       'primary_key' => 'taxnum',
 507       'unique' => [],
 508   #    'unique' => [ ['taxnum'], ['state', 'county'] ],
 509       'index' => [ [ 'county' ], [ 'state' ], [ 'country' ] ],
 510     },
 511
 512     'cust_pay' => {
 513       'columns' => [
 514         'paynum',   'serial',    '',   '', '', '',
 515         #now cust_bill_pay #'invnum',   'int',    '',   '', '', '',
 516         'custnum',  'int',    '',   '', '', '',
 517         'paid',     @money_type, '', '',
 518         '_date',    @date_type, '', '',
 519         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 520                                                  # index into payby table
 521                                                  # eventually
 522         'payinfo',  'varchar',   'NULL', $char_d, '', '', #see cust_main above
 523         'paybatch', 'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 524         'closed',    'char', 'NULL', 1, '', '',
 525       ],
 526       'primary_key' => 'paynum',
 527       'unique' => [],
 528       'index' => [ [ 'custnum' ], [ 'paybatch' ], [ 'payby' ], [ '_date' ] ],
 529     },
 530
 531     'cust_pay_void' => {
 532       'columns' => [
 533         'paynum',    'int',    '',   '', '', '',
 534         'custnum',   'int',    '',   '', '', '',
 535         'paid',      @money_type, '', '',
 536         '_date',     @date_type, '', '',
 537         'payby',     'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 538                                                   # index into payby table
 539                                                   # eventually
 540         'payinfo',   'varchar',   'NULL', $char_d, '', '', #see cust_main above
 541         'paybatch',  'varchar',   'NULL', $char_d, '', '', #for auditing purposes.
 542         'closed',    'char', 'NULL', 1, '', '',
 543         'void_date', @date_type, '', '',
 544         'reason',    'varchar',   'NULL', $char_d, '', '',
 545         'otaker',   'varchar', '', 32, '', '',
 546       ],
 547       'primary_key' => 'paynum',
 548       'unique' => [],
 549       'index' => [ [ 'custnum' ] ],
 550     },
 551
 552     'cust_bill_pay' => {
 553       'columns' => [
 554         'billpaynum', 'serial',     '',   '', '', '',
 555         'invnum',  'int',     '',   '', '', '',
 556         'paynum',  'int',     '',   '', '', '',
 557         'amount',  @money_type, '', '',
 558         '_date',   @date_type, '', '',
 559       ],
 560       'primary_key' => 'billpaynum',
 561       'unique' => [],
 562       'index' => [ [ 'paynum' ], [ 'invnum' ] ],
 563     },
 564
 565     'cust_bill_pay_batch' => {
 566       'columns' => [
 567         'billpaynum', 'serial',     '',   '', '', '',
 568         'invnum',  'int',     '',   '', '', '',
 569         'paybatchnum',  'int',     '',   '', '', '',
 570         'amount',  @money_type, '', '',
 571         '_date',   @date_type, '', '',
 572       ],
 573       'primary_key' => 'billpaynum',
 574       'unique' => [],
 575       'index' => [ [ 'paybatchnum' ], [ 'invnum' ] ],
 576     },
 577
 578     'cust_bill_pay_pkg' => {
 579       'columns' => [
 580         'billpaypkgnum', 'serial', '', '', '', '',
 581         'billpaynum',       'int', '', '', '', '',
 582         'billpkgnum',       'int', '', '', '', '',
 583         'amount',         @money_type,     '', '',
 584         'setuprecur',      'varchar', '', $char_d, '', '',
 585         'sdate',   @date_type, '', '',
 586         'edate',   @date_type, '', '',
 587       ],
 588       'primary_key' => 'billpaypkgnum',
 589       'unique'      => [],
 590       'index'       => [ [ 'billpaynum' ], [ 'billpkgnum' ], ],
 591     },
 592
 593     'pay_batch' => { #batches of payments to an external processor
 594       'columns' => [
 595         'batchnum',   'serial',    '',   '', '', '',
 596         'payby',      'char',      '',    4, '', '', # CARD/CHEK
 597         'status',     'char', 'NULL',     1, '', '',
 598         'download',   @date_type, '', '',
 599         'upload',     @date_type, '', '',
 600       ],
 601       'primary_key' => 'batchnum',
 602       'unique' => [],
 603       'index' => [],
 604     },
 605
 606     'cust_pay_batch' => { #what's this used for again?  list of customers
 607                           #in current CARD batch? (necessarily CARD?)
 608       'columns' => [
 609         'paybatchnum',   'serial',    '',   '', '', '',
 610         'batchnum',   'int',    '',   '', '', '',
 611         'invnum',   'int',    '',   '', '', '',
 612         'custnum',   'int',    '',   '', '', '',
 613         'last',     'varchar', '',     $char_d, '', '',
 614         'first',    'varchar', '',     $char_d, '', '',
 615         'address1', 'varchar', '',     $char_d, '', '',
 616         'address2', 'varchar', 'NULL', $char_d, '', '',
 617         'city',     'varchar', '',     $char_d, '', '',
 618         'state',    'varchar', 'NULL', $char_d, '', '',
 619         'zip',      'varchar', 'NULL', 10, '', '',
 620         'country',  'char', '',     2, '', '',
 621         #        'trancode', 'int', '', '', '', ''
 622         'payby',    'char',   '',     4, '', '', # CARD/BILL/COMP, should be
 623         'payinfo',  'varchar', '',     512, '', '',
 624         #'exp',      @date_type, '', ''
 625         'exp',      'varchar', 'NULL',     11, '', '',
 626         'payname',  'varchar', 'NULL', $char_d, '', '',
 627         'amount',   @money_type, '', '',
 628         'status',   'varchar', 'NULL',     $char_d, '', '',
 629       ],
 630       'primary_key' => 'paybatchnum',
 631       'unique' => [],
 632       'index' => [ ['batchnum'], ['invnum'], ['custnum'] ],
 633     },
 634
 635     'cust_pkg' => {
 636       'columns' => [
 637         'pkgnum',    'serial',    '',   '', '', '',
 638         'custnum',   'int',    '',   '', '', '',
 639         'pkgpart',   'int',    '',   '', '', '',
 640         'otaker',    'varchar', '', 32, '', '',
 641         'setup',     @date_type, '', '',
 642         'bill',      @date_type, '', '',
 643         'last_bill', @date_type, '', '',
 644         'susp',      @date_type, '', '',
 645         'cancel',    @date_type, '', '',
 646         'expire',    @date_type, '', '',
 647         'manual_flag', 'char', 'NULL', 1, '', '',
 648       ],
 649       'primary_key' => 'pkgnum',
 650       'unique' => [],
 651       'index' => [ ['custnum'], ['pkgpart'] ],
 652     },
 653
 654     'cust_pkg_reason' => {
 655       'columns' => [
 656         'num',      'serial',    '',   '', '', '',
 657         'pkgnum',   'int',    '',   '', '', '',
 658         'reasonnum','int',    '',   '', '', '',
 659         'otaker',   'varchar', '', 32, '', '',
 660         'date',     @date_type, '', '',
 661       ],
 662       'primary_key' => 'num',
 663       'unique' => [],
 664       'index' => [],
 665     },
 666
 667     'cust_refund' => {
 668       'columns' => [
 669         'refundnum',    'serial',    '',   '', '', '',
 670         #now cust_credit_refund #'crednum',      'int',    '',   '', '', '',
 671         'custnum',  'int',    '',   '', '', '',
 672         '_date',        @date_type, '', '',
 673         'refund',       @money_type, '', '',
 674         'otaker',       'varchar',   '',   32, '', '',
 675         'reason',       'varchar',   '',   $char_d, '', '',
 676         'payby',        'char',   '',     4, '', '', # CARD/BILL/COMP, should
 677                                                      # be index into payby
 678                                                      # table eventually
 679         'payinfo',      'varchar',   'NULL', $char_d, '', '', #see cust_main above
 680         'paybatch',     'varchar',   'NULL', $char_d, '', '',
 681         'closed',    'char', 'NULL', 1, '', '',
 682       ],
 683       'primary_key' => 'refundnum',
 684       'unique' => [],
 685       'index' => [],
 686     },
 687
 688     'cust_credit_refund' => {
 689       'columns' => [
 690         'creditrefundnum', 'serial',     '',   '', '', '',
 691         'crednum',  'int',     '',   '', '', '',
 692         'refundnum',  'int',     '',   '', '', '',
 693         'amount',  @money_type, '', '',
 694         '_date',   @date_type, '', '',
 695       ],
 696       'primary_key' => 'creditrefundnum',
 697       'unique' => [],
 698       'index' => [ [ 'crednum', 'refundnum' ] ],
 699     },
 700
 701
 702     'cust_svc' => {
 703       'columns' => [
 704         'svcnum',    'serial',    '',   '', '', '',
 705         'pkgnum',    'int',    'NULL',   '', '', '',
 706         'svcpart',   'int',    '',   '', '', '',
 707       ],
 708       'primary_key' => 'svcnum',
 709       'unique' => [],
 710       'index' => [ ['svcnum'], ['pkgnum'], ['svcpart'] ],
 711     },
 712
 713     'part_pkg' => {
 714       'columns' => [
 715         'pkgpart',    'serial',    '',   '', '', '',
 716         'pkg',        'varchar',   '',   $char_d, '', '',
 717         'comment',    'varchar',   '',   $char_d, '', '',
 718         'promo_code', 'varchar', 'NULL', $char_d, '', '',
 719         'setup',      @perl_type, '', '',
 720         'freq',       'varchar',   '',   $char_d, '', '', #billing frequency
 721         'recur',      @perl_type, '', '',
 722         'setuptax',  'char', 'NULL', 1, '', '',
 723         'recurtax',  'char', 'NULL', 1, '', '',
 724         'plan',       'varchar', 'NULL', $char_d, '', '',
 725         'plandata',   'text', 'NULL', '', '', '',
 726         'disabled',   'char', 'NULL', 1, '', '',
 727         'taxclass',   'varchar', 'NULL', $char_d, '', '',
 728         'classnum',   'int',     'NULL', '', '', '',
 729       ],
 730       'primary_key' => 'pkgpart',
 731       'unique' => [],
 732       'index' => [ [ 'promo_code' ], [ 'disabled' ] ],
 733     },
 734
 735 #    'part_title' => {
 736 #      'columns' => [
 737 #        'titlenum',   'int',    '',   '',
 738 #        'title',      'varchar',   '',   $char_d,
 739 #      ],
 740 #      'primary_key' => 'titlenum',
 741 #      'unique' => [ [] ],
 742 #      'index' => [ [] ],
 743 #    },
 744
 745     'pkg_svc' => {
 746       'columns' => [
 747         'pkgsvcnum',  'serial', '',  '', '', '',
 748         'pkgpart',    'int',    '',   '', '', '',
 749         'svcpart',    'int',    '',   '', '', '',
 750         'quantity',   'int',    '',   '', '', '',
 751         'primary_svc','char', 'NULL',  1, '', '',
 752       ],
 753       'primary_key' => 'pkgsvcnum',
 754       'unique' => [ ['pkgpart', 'svcpart'] ],
 755       'index' => [ ['pkgpart'] ],
 756     },
 757
 758     'part_referral' => {
 759       'columns' => [
 760         'refnum',   'serial',     '',        '', '', '',
 761         'referral', 'varchar',    '',   $char_d, '', '',
 762         'disabled', 'char',   'NULL',         1, '', '',
 763         'agentnum', 'int',    'NULL',        '', '', '',
 764       ],
 765       'primary_key' => 'refnum',
 766       'unique' => [],
 767       'index' => [ ['disabled'] ],
 768     },
 769
 770     'part_svc' => {
 771       'columns' => [
 772         'svcpart',    'serial',    '',   '', '', '',
 773         'svc',        'varchar',   '',   $char_d, '', '',
 774         'svcdb',      'varchar',   '',   $char_d, '', '',
 775         'disabled',   'char',  'NULL',   1, '', '',
 776       ],
 777       'primary_key' => 'svcpart',
 778       'unique' => [],
 779       'index' => [ [ 'disabled' ] ],
 780     },
 781
 782     'part_svc_column' => {
 783       'columns' => [
 784         'columnnum',   'serial',         '', '', '', '',
 785         'svcpart',     'int',         '', '', '', '',
 786         'columnname',  'varchar',     '', 64, '', '',
 787         'columnvalue', 'varchar', 'NULL', $char_d, '', '',
 788         'columnflag',  'char',    'NULL', 1, '', '',
 789       ],
 790       'primary_key' => 'columnnum',
 791       'unique' => [ [ 'svcpart', 'columnname' ] ],
 792       'index' => [ [ 'svcpart' ] ],
 793     },
 794
 795     #(this should be renamed to part_pop)
 796     'svc_acct_pop' => {
 797       'columns' => [
 798         'popnum',    'serial',    '',   '', '', '',
 799         'city',      'varchar',   '',   $char_d, '', '',
 800         'state',     'varchar',   '',   $char_d, '', '',
 801         'ac',        'char',   '',   3, '', '',
 802         'exch',      'char',   '',   3, '', '',
 803         'loc',       'char',   'NULL',   4, '', '', #NULL for legacy purposes
 804       ],
 805       'primary_key' => 'popnum',
 806       'unique' => [],
 807       'index' => [ [ 'state' ] ],
 808     },
 809
 810     'part_pop_local' => {
 811       'columns' => [
 812         'localnum',  'serial',     '',     '', '', '',
 813         'popnum',    'int',     '',     '', '', '',
 814         'city',      'varchar', 'NULL', $char_d, '', '',
 815         'state',     'char',    'NULL', 2, '', '',
 816         'npa',       'char',    '',     3, '', '',
 817         'nxx',       'char',    '',     3, '', '',
 818       ],
 819       'primary_key' => 'localnum',
 820       'unique' => [],
 821       'index' => [ [ 'npa', 'nxx' ], [ 'popnum' ] ],
 822     },
 823
 824     'svc_acct' => {
 825       'columns' => [
 826         'svcnum',    'int',    '',   '', '', '',
 827         'username',  'varchar',   '',   $username_len, '', '', #unique (& remove dup code)
 828         '_password', 'varchar',   '',   72, '', '', #13 for encryped pw's plus ' *SUSPENDED* (md5 passwords can be 34, blowfish 60)
 829         'sec_phrase', 'varchar',  'NULL',   $char_d, '', '',
 830         'popnum',    'int',    'NULL',   '', '', '',
 831         'uid',       'int', 'NULL',   '', '', '',
 832         'gid',       'int', 'NULL',   '', '', '',
 833         'finger',    'varchar',   'NULL',   $char_d, '', '',
 834         'dir',       'varchar',   'NULL',   $char_d, '', '',
 835         'shell',     'varchar',   'NULL',   $char_d, '', '',
 836         'quota',     'varchar',   'NULL',   $char_d, '', '',
 837         'slipip',    'varchar',   'NULL',   15, '', '', #four TINYINTs, bah.
 838         'seconds',   'int', 'NULL',   '', '', '', #uhhhh
 839         'domsvc',    'int', '',   '', '', '',
 840       ],
 841       'primary_key' => 'svcnum',
 842       #'unique' => [ [ 'username', 'domsvc' ] ],
 843       'unique' => [],
 844       'index' => [ ['username'], ['domsvc'] ],
 845     },
 846
 847     #'svc_charge' => {
 848     #  'columns' => [
 849     #    'svcnum',    'int',    '',   '',
 850     #    'amount',    @money_type,
 851     #  ],
 852     #  'primary_key' => 'svcnum',
 853     #  'unique' => [ [] ],
 854     #  'index' => [ [] ],
 855     #},
 856
 857     'svc_domain' => {
 858       'columns' => [
 859         'svcnum',    'int',    '',   '', '', '',
 860         'domain',    'varchar',    '',   $char_d, '', '',
 861         'catchall',  'int', 'NULL',    '', '', '',
 862       ],
 863       'primary_key' => 'svcnum',
 864       'unique' => [ ['domain'] ],
 865       'index' => [],
 866     },
 867
 868     'domain_record' => {
 869       'columns' => [
 870         'recnum',    'serial',     '',  '', '', '',
 871         'svcnum',    'int',     '',  '', '', '',
 872         'reczone',   'varchar', '',  255, '', '',
 873         'recaf',     'char',    '',  2, '', '',
 874         'rectype',   'varchar',    '',  5, '', '',
 875         'recdata',   'varchar', '',  255, '', '',
 876       ],
 877       'primary_key' => 'recnum',
 878       'unique'      => [],
 879       'index'       => [ ['svcnum'] ],
 880     },
 881
 882     'svc_forward' => {
 883       'columns' => [
 884         'svcnum',   'int',            '',   '', '', '',
 885         'srcsvc',   'int',        'NULL',   '', '', '',
 886         'src',      'varchar',    'NULL',  255, '', '',
 887         'dstsvc',   'int',        'NULL',   '', '', '',
 888         'dst',      'varchar',    'NULL',  255, '', '',
 889       ],
 890       'primary_key' => 'svcnum',
 891       'unique'      => [],
 892       'index'       => [ ['srcsvc'], ['dstsvc'] ],
 893     },
 894
 895     'svc_www' => {
 896       'columns' => [
 897         'svcnum',   'int',    '',  '', '', '',
 898         'recnum',   'int',    '',  '', '', '',
 899         'usersvc',  'int',    '',  '', '', '',
 900       ],
 901       'primary_key' => 'svcnum',
 902       'unique'      => [],
 903       'index'       => [],
 904     },
 905
 906     #'svc_wo' => {
 907     #  'columns' => [
 908     #    'svcnum',    'int',    '',   '',
 909     #    'svcnum',    'int',    '',   '',
 910     #    'svcnum',    'int',    '',   '',
 911     #    'worker',    'varchar',   '',   $char_d,
 912     #    '_date',     @date_type,
 913     #  ],
 914     #  'primary_key' => 'svcnum',
 915     #  'unique' => [ [] ],
 916     #  'index' => [ [] ],
 917     #},
 918
 919     'prepay_credit' => {
 920       'columns' => [
 921         'prepaynum',   'serial',     '',   '', '', '',
 922         'identifier',  'varchar', '', $char_d, '', '',
 923         'amount',      @money_type, '', '',
 924         'seconds',     'int',     'NULL', '', '', '',
 925         'agentnum',    'int',     'NULL', '', '', '',
 926       ],
 927       'primary_key' => 'prepaynum',
 928       'unique'      => [ ['identifier'] ],
 929       'index'       => [],
 930     },
 931
 932     'port' => {
 933       'columns' => [
 934         'portnum',  'serial',     '',   '', '', '',
 935         'ip',       'varchar', 'NULL', 15, '', '',
 936         'nasport',  'int',     'NULL', '', '', '',
 937         'nasnum',   'int',     '',   '', '', '',
 938       ],
 939       'primary_key' => 'portnum',
 940       'unique'      => [],
 941       'index'       => [],
 942     },
 943
 944     'nas' => {
 945       'columns' => [
 946         'nasnum',   'serial',     '',    '', '', '',
 947         'nas',      'varchar', '',    $char_d, '', '',
 948         'nasip',    'varchar', '',    15, '', '',
 949         'nasfqdn',  'varchar', '',    $char_d, '', '',
 950         'last',     'int',     '',    '', '', '',
 951       ],
 952       'primary_key' => 'nasnum',
 953       'unique'      => [ [ 'nas' ], [ 'nasip' ] ],
 954       'index'       => [ [ 'last' ] ],
 955     },
 956
 957     'session' => {
 958       'columns' => [
 959         'sessionnum', 'serial',       '',   '', '', '',
 960         'portnum',    'int',       '',   '', '', '',
 961         'svcnum',     'int',       '',   '', '', '',
 962         'login',      @date_type, '', '',
 963         'logout',     @date_type, '', '',
 964       ],
 965       'primary_key' => 'sessionnum',
 966       'unique'      => [],
 967       'index'       => [ [ 'portnum' ] ],
 968     },
 969
 970     'queue' => {
 971       'columns' => [
 972         'jobnum', 'serial', '', '', '', '',
 973         'job', 'text', '', '', '', '',
 974         '_date', 'int', '', '', '', '',
 975         'status', 'varchar', '', $char_d, '', '',
 976         'statustext', 'text', 'NULL', '', '', '',
 977         'svcnum', 'int', 'NULL', '', '', '',
 978       ],
 979       'primary_key' => 'jobnum',
 980       'unique'      => [],
 981       'index'       => [ [ 'svcnum' ], [ 'status' ] ],
 982     },
 983
 984     'queue_arg' => {
 985       'columns' => [
 986         'argnum', 'serial', '', '', '', '',
 987         'jobnum', 'int', '', '', '', '',
 988         'arg', 'text', 'NULL', '', '', '',
 989       ],
 990       'primary_key' => 'argnum',
 991       'unique'      => [],
 992       'index'       => [ [ 'jobnum' ] ],
 993     },
 994
 995     'queue_depend' => {
 996       'columns' => [
 997         'dependnum', 'serial', '', '', '', '',
 998         'jobnum', 'int', '', '', '', '',
 999         'depend_jobnum', 'int', '', '', '', '',
1000       ],
1001       'primary_key' => 'dependnum',
1002       'unique'      => [],
1003       'index'       => [ [ 'jobnum' ], [ 'depend_jobnum' ] ],
1004     },
1005
1006     'export_svc' => {
1007       'columns' => [
1008         'exportsvcnum' => 'serial', '', '', '', '',
1009         'exportnum'    => 'int', '', '', '', '',
1010         'svcpart'      => 'int', '', '', '', '',
1011       ],
1012       'primary_key' => 'exportsvcnum',
1013       'unique'      => [ [ 'exportnum', 'svcpart' ] ],
1014       'index'       => [ [ 'exportnum' ], [ 'svcpart' ] ],
1015     },
1016
1017     'part_export' => {
1018       'columns' => [
1019         'exportnum', 'serial', '', '', '', '',
1020         'machine', 'varchar', '', $char_d, '', '',
1021         'exporttype', 'varchar', '', $char_d, '', '',
1022         'nodomain',     'char', 'NULL', 1, '', '',
1023       ],
1024       'primary_key' => 'exportnum',
1025       'unique'      => [],
1026       'index'       => [ [ 'machine' ], [ 'exporttype' ] ],
1027     },
1028
1029     'part_export_option' => {
1030       'columns' => [
1031         'optionnum', 'serial', '', '', '', '',
1032         'exportnum', 'int', '', '', '', '',
1033         'optionname', 'varchar', '', $char_d, '', '',
1034         'optionvalue', 'text', 'NULL', '', '', '',
1035       ],
1036       'primary_key' => 'optionnum',
1037       'unique'      => [],
1038       'index'       => [ [ 'exportnum' ], [ 'optionname' ] ],
1039     },
1040
1041     'radius_usergroup' => {
1042       'columns' => [
1043         'usergroupnum', 'serial', '', '', '', '',
1044         'svcnum',       'int', '', '', '', '',
1045         'groupname',    'varchar', '', $char_d, '', '',
1046       ],
1047       'primary_key' => 'usergroupnum',
1048       'unique'      => [],
1049       'index'       => [ [ 'svcnum' ], [ 'groupname' ] ],
1050     },
1051
1052     'msgcat' => {
1053       'columns' => [
1054         'msgnum', 'serial', '', '', '', '',
1055         'msgcode', 'varchar', '', $char_d, '', '',
1056         'locale', 'varchar', '', 16, '', '',
1057         'msg', 'text', '', '', '', '',
1058       ],
1059       'primary_key' => 'msgnum',
1060       'unique'      => [ [ 'msgcode', 'locale' ] ],
1061       'index'       => [],
1062     },
1063
1064     'cust_tax_exempt' => {
1065       'columns' => [
1066         'exemptnum', 'serial', '', '', '', '',
1067         'custnum',   'int', '', '', '', '',
1068         'taxnum',    'int', '', '', '', '',
1069         'year',      'int', '', '', '', '',
1070         'month',     'int', '', '', '', '',
1071         'amount',   @money_type, '', '',
1072       ],
1073       'primary_key' => 'exemptnum',
1074       'unique'      => [ [ 'custnum', 'taxnum', 'year', 'month' ] ],
1075       'index'       => [],
1076     },
1077
1078     'cust_tax_exempt_pkg' => {
1079       'columns' => [
1080         'exemptpkgnum',  'serial', '', '', '', '',
1081         #'custnum',      'int', '', '', '', ''
1082         'billpkgnum',   'int', '', '', '', '',
1083         'taxnum',       'int', '', '', '', '',
1084         'year',         'int', '', '', '', '',
1085         'month',        'int', '', '', '', '',
1086         'amount',       @money_type, '', '',
1087       ],
1088       'primary_key' => 'exemptpkgnum',
1089       'unique' => [],
1090       'index'  => [ [ 'taxnum', 'year', 'month' ],
1091                     [ 'billpkgnum' ],
1092                     [ 'taxnum' ]
1093                   ],
1094     },
1095
1096     'router' => {
1097       'columns' => [
1098         'routernum', 'serial', '', '', '', '',
1099         'routername', 'varchar', '', $char_d, '', '',
1100         'svcnum', 'int', 'NULL', '', '', '',
1101       ],
1102       'primary_key' => 'routernum',
1103       'unique'      => [],
1104       'index'       => [],
1105     },
1106
1107     'part_svc_router' => {
1108       'columns' => [
1109         'svcrouternum', 'serial', '', '', '', '',
1110         'svcpart', 'int', '', '', '', '',
1111         'routernum', 'int', '', '', '', '',
1112       ],
1113       'primary_key' => 'svcrouternum',
1114       'unique'      => [],
1115       'index'       => [],
1116     },
1117
1118     'addr_block' => {
1119       'columns' => [
1120         'blocknum', 'serial', '', '', '', '',
1121         'routernum', 'int', '', '', '', '',
1122         'ip_gateway', 'varchar', '', 15, '', '',
1123         'ip_netmask', 'int', '', '', '', '',
1124       ],
1125       'primary_key' => 'blocknum',
1126       'unique'      => [ [ 'blocknum', 'routernum' ] ],
1127       'index'       => [],
1128     },
1129
1130     'svc_broadband' => {
1131       'columns' => [
1132         'svcnum', 'int', '', '', '', '',
1133         'blocknum', 'int', '', '', '', '',
1134         'speed_up', 'int', '', '', '', '',
1135         'speed_down', 'int', '', '', '', '',
1136         'ip_addr', 'varchar', '', 15, '', '',
1137       ],
1138       'primary_key' => 'svcnum',
1139       'unique'      => [],
1140       'index'       => [],
1141     },
1142
1143     'part_virtual_field' => {
1144       'columns' => [
1145         'vfieldpart', 'int', '', '', '', '',
1146         'dbtable', 'varchar', '', 32, '', '',
1147         'name', 'varchar', '', 32, '', '',
1148         'check_block', 'text', 'NULL', '', '', '',
1149         'length', 'int', 'NULL', '', '', '',
1150         'list_source', 'text', 'NULL', '', '', '',
1151         'label', 'varchar', 'NULL', 80, '', '',
1152       ],
1153       'primary_key' => 'vfieldpart',
1154       'unique' => [],
1155       'index' => [],
1156     },
1157
1158     'virtual_field' => {
1159       'columns' => [
1160         'vfieldnum', 'serial', '', '', '', '',
1161         'recnum', 'int', '', '', '', '',
1162         'vfieldpart', 'int', '', '', '', '',
1163         'value', 'varchar', '', 128, '', '',
1164       ],
1165       'primary_key' => 'vfieldnum',
1166       'unique' => [ [ 'vfieldpart', 'recnum' ] ],
1167       'index' => [],
1168     },
1169
1170     'acct_snarf' => {
1171       'columns' => [
1172         'snarfnum',  'int', '', '', '', '',
1173         'svcnum',    'int', '', '', '', '',
1174         'machine',   'varchar', '', 255, '', '',
1175         'protocol',  'varchar', '', $char_d, '', '',
1176         'username',  'varchar', '', $char_d, '', '',
1177         '_password', 'varchar', '', $char_d, '', '',
1178       ],
1179       'primary_key' => 'snarfnum',
1180       'unique' => [],
1181       'index'  => [ [ 'svcnum' ] ],
1182     },
1183
1184     'svc_external' => {
1185       'columns' => [
1186         'svcnum', 'int', '', '', '', '',
1187         'id',     'int', 'NULL', '', '', '',
1188         'title',  'varchar', 'NULL', $char_d, '', '',
1189       ],
1190       'primary_key' => 'svcnum',
1191       'unique'      => [],
1192       'index'       => [],
1193     },
1194
1195     'cust_pay_refund' => {
1196       'columns' => [
1197         'payrefundnum', 'serial', '', '', '', '',
1198         'paynum',  'int', '', '', '', '',
1199         'refundnum',  'int', '', '', '', '',
1200         '_date',    @date_type, '', '',
1201         'amount',   @money_type, '', '',
1202       ],
1203       'primary_key' => 'payrefundnum',
1204       'unique' => [],
1205       'index' => [ ['paynum'], ['refundnum'] ],
1206     },
1207
1208     'part_pkg_option' => {
1209       'columns' => [
1210         'optionnum', 'serial', '', '', '', '',
1211         'pkgpart', 'int', '', '', '', '',
1212         'optionname', 'varchar', '', $char_d, '', '',
1213         'optionvalue', 'text', 'NULL', '', '', '',
1214       ],
1215       'primary_key' => 'optionnum',
1216       'unique'      => [],
1217       'index'       => [ [ 'pkgpart' ], [ 'optionname' ] ],
1218     },
1219
1220     'rate' => {
1221       'columns' => [
1222         'ratenum',  'serial', '', '', '', '',
1223         'ratename', 'varchar', '', $char_d, '', '',
1224       ],
1225       'primary_key' => 'ratenum',
1226       'unique'      => [],
1227       'index'       => [],
1228     },
1229
1230     'rate_detail' => {
1231       'columns' => [
1232         'ratedetailnum',   'serial', '', '', '', '',
1233         'ratenum',         'int',     '', '', '', '',
1234         'orig_regionnum',  'int', 'NULL', '', '', '',
1235         'dest_regionnum',  'int',     '', '', '', '',
1236         'min_included',    'int',     '', '', '', '',
1237         #'min_charge',      @money_type, '', '',
1238         'min_charge',      'decimal', '', '10,5', '', '',
1239         'sec_granularity', 'int',     '', '', '', '',
1240         #time period (link to table of periods)?
1241       ],
1242       'primary_key' => 'ratedetailnum',
1243       'unique'      => [ [ 'ratenum', 'orig_regionnum', 'dest_regionnum' ] ],
1244       'index'       => [ [ 'ratenum', 'dest_regionnum' ] ],
1245     },
1246
1247     'rate_region' => {
1248       'columns' => [
1249         'regionnum',   'serial',      '', '', '', '',
1250         'regionname',  'varchar',     '', $char_d, '', '',
1251       ],
1252       'primary_key' => 'regionnum',
1253       'unique'      => [],
1254       'index'       => [],
1255     },
1256
1257     'rate_prefix' => {
1258       'columns' => [
1259         'prefixnum',   'serial',    '', '', '', '',
1260         'regionnum',   'int',       '', '',, '', '',
1261         'countrycode', 'varchar',     '', 3, '', '',
1262         'npa',         'varchar', 'NULL', 6, '', '',
1263         'nxx',         'varchar', 'NULL', 3, '', '',
1264       ],
1265       'primary_key' => 'prefixnum',
1266       'unique'      => [],
1267       'index'       => [ [ 'countrycode' ], [ 'regionnum' ] ],
1268     },
1269
1270     'reg_code' => {
1271       'columns' => [
1272         'codenum',   'serial',    '', '', '', '',
1273         'code',      'varchar',   '', $char_d, '', '',
1274         'agentnum',  'int',       '', '', '', '',
1275       ],
1276       'primary_key' => 'codenum',
1277       'unique'      => [ [ 'agentnum', 'code' ] ],
1278       'index'       => [ [ 'agentnum' ] ],
1279     },
1280
1281     'reg_code_pkg' => {
1282       'columns' => [
1283         'codepkgnum', 'serial', '', '', '', '',
1284         'codenum',   'int',    '', '', '', '',
1285         'pkgpart',   'int',    '', '', '', '',
1286       ],
1287       'primary_key' => 'codepkgnum',
1288       'unique'      => [ [ 'codenum', 'pkgpart' ] ],
1289       'index'       => [ [ 'codenum' ] ],
1290     },
1291
1292     'clientapi_session' => {
1293       'columns' => [
1294         'sessionnum',  'serial',  '', '', '', '',
1295         'sessionid',  'varchar',  '', $char_d, '', '',
1296         'namespace',  'varchar',  '', $char_d, '', '',
1297       ],
1298       'primary_key' => 'sessionnum',
1299       'unique'      => [ [ 'sessionid', 'namespace' ] ],
1300       'index'       => [],
1301     },
1302
1303     'clientapi_session_field' => {
1304       'columns' => [
1305         'fieldnum',    'serial',     '', '', '', '',
1306         'sessionnum',     'int',     '', '', '', '',
1307         'fieldname',  'varchar',     '', $char_d, '', '',
1308         'fieldvalue',    'text', 'NULL', '', '', '',
1309       ],
1310       'primary_key' => 'fieldnum',
1311       'unique'      => [ [ 'sessionnum', 'fieldname' ] ],
1312       'index'       => [],
1313     },
1314
1315     'payment_gateway' => {
1316       'columns' => [
1317         'gatewaynum',       'serial',   '',     '', '', '',
1318         'gateway_module',   'varchar',  '',     $char_d, '', '',
1319         'gateway_username', 'varchar',  'NULL', $char_d, '', '',
1320         'gateway_password', 'varchar',  'NULL', $char_d, '', '',
1321         'gateway_action',   'varchar',  'NULL', $char_d, '', '',
1322         'disabled',   'char',  'NULL',   1, '', '',
1323       ],
1324       'primary_key' => 'gatewaynum',
1325       'unique' => [],
1326       'index'  => [ [ 'disabled' ] ],
1327     },
1328
1329     'payment_gateway_option' => {
1330       'columns' => [
1331         'optionnum',   'serial',  '',     '', '', '',
1332         'gatewaynum',  'int',     '',     '', '', '',
1333         'optionname',  'varchar', '',     $char_d, '', '',
1334         'optionvalue', 'text',    'NULL', '', '', '',
1335       ],
1336       'primary_key' => 'optionnum',
1337       'unique'      => [],
1338       'index'       => [ [ 'gatewaynum' ], [ 'optionname' ] ],
1339     },
1340
1341     'agent_payment_gateway' => {
1342       'columns' => [
1343         'agentgatewaynum', 'serial', '', '', '', '',
1344         'agentnum',        'int', '', '', '', '',
1345         'gatewaynum',      'int', '', '', '', '',
1346         'cardtype',        'varchar', 'NULL', $char_d, '', '',
1347         'taxclass',        'varchar', 'NULL', $char_d, '', '',
1348       ],
1349       'primary_key' => 'agentgatewaynum',
1350       'unique'      => [],
1351       'index'       => [ [ 'agentnum', 'cardtype' ], ],
1352     },
1353
1354     'banned_pay' => {
1355       'columns' => [
1356         'bannum',  'serial',   '',     '', '', '',
1357         'payby',   'char',     '',       4, '', '',
1358         'payinfo', 'varchar',  '',     128, '', '', #say, a 512-big digest _hex encoded
1359         #'paymask', 'varchar',  'NULL', $char_d, '', ''
1360         '_date',   @date_type, '', '',
1361         'otaker',  'varchar',  '',     32, '', '',
1362         'reason',  'varchar',  'NULL', $char_d, '', '',
1363       ],
1364       'primary_key' => 'bannum',
1365       'unique'      => [ [ 'payby', 'payinfo' ] ],
1366       'index'       => [],
1367     },
1368
1369     'pkg_class' => {
1370       'columns' => [
1371         'classnum',   'serial',  '', '', '', '',
1372         'classname',  'varchar', '', $char_d, '', '',
1373       ],
1374       'primary_key' => 'classnum',
1375       'unique' => [],
1376       'index' => [],
1377     },
1378
1379     'cdr' => {
1380       'columns' => [
1381         # qw( name type null length default local );
1382
1383         ###
1384         #asterisk fields
1385         ###
1386
1387         'acctid',   'bigserial',  '', '', '', '',
1388         'calldate', 'TIMESTAMP with time zone', '', '', \'now()', '',
1389         'clid',        'varchar',  '', $char_d, \"''", '',
1390         'src',         'varchar',  '', $char_d, \"''", '',
1391         'dst',         'varchar',  '', $char_d, \"''", '',
1392         'dcontext',    'varchar',  '', $char_d, \"''", '',
1393         'channel',     'varchar',  '', $char_d, \"''", '',
1394         'dstchannel',  'varchar',  '', $char_d, \"''", '',
1395         'lastapp',     'varchar',  '', $char_d, \"''", '',
1396         'lastdata',    'varchar',  '', $char_d, \"''", '',
1397
1398         #these don't seem to be logged by most of the SQL cdr_* modules
1399         #except tds under sql-illegal names, so;
1400         # ... don't rely on them for rating?
1401         # and, what they hey, i went ahead and changed the names and data types
1402         # to freeside-style dates...
1403           #'start',  'timestamp', 'NULL',  '',    '', '',
1404           #'answer', 'timestamp', 'NULL',  '',    '', '',
1405           #'end',    'timestamp', 'NULL',  '',    '', '',
1406         'startdate',  @date_type, '', '',
1407         'answerdate', @date_type, '', '',
1408         'enddate',    @date_type, '', '',
1409         #
1410
1411         'duration',    'int',      '',      '',     0, '',
1412         'billsec',     'int',      '',      '',     0, '',
1413         'disposition', 'varchar',  '',      45, \"''", '',
1414         'amaflags',    'int',      '',      '',     0, '',
1415         'accountcode', 'varchar',  '',      20, \"''", '',
1416         'uniqueid',    'varchar',  '',      32, \"''", '',
1417         'userfield',   'varchar',  '',     255, \"''", '',
1418
1419         ###
1420         # fields for unitel/RSLCOM/convergent that don't map well to asterisk
1421         # defaults
1422         ###
1423
1424         #cdr_type: Usage = 1, S&E = 7, OC&C = 8
1425         'cdrtypenum',              'int', 'NULL',      '', '', '',
1426
1427         'charged_party',       'varchar', 'NULL', $char_d, '', '',
1428
1429         'upstream_currency',      'char', 'NULL',       3, '', '',
1430         'upstream_price',      'decimal', 'NULL',  '10,2', '', '',
1431         'upstream_rateplanid',     'int', 'NULL',      '', '', '', #?
1432
1433         # how it was rated internally...
1434         'ratedetailnum',           'int', 'NULL',      '', '', '',
1435         'rated_price',         'decimal', 'NULL',  '10,2', '', '',
1436
1437         'distance',            'decimal', 'NULL',      '', '', '',
1438         'islocal',                 'int', 'NULL',      '', '', '', # '',  '', 0, '' instead?
1439
1440         #cdr_calltype: the big list in appendix 2
1441         'calltypenum',             'int', 'NULL',      '', '', '',
1442
1443         'description',         'varchar', 'NULL', $char_d, '', '',
1444         'quantity',                'int', 'NULL',      '', '', '',
1445
1446         #cdr_carrier: Telstra =1, Optus = 2, RSL COM = 3
1447         'carrierid',               'int', 'NULL',      '', '', '',
1448
1449         'upstream_rateid',         'int', 'NULL',      '', '', '',
1450
1451         ###
1452         #and now for our own fields
1453         ###
1454
1455         # a svcnum... right..?
1456         'svcnum',             'int',   'NULL',     '',   '', '',
1457
1458         #NULL, done (or something)
1459         'freesidestatus', 'varchar',   'NULL',     32,   '', '',
1460
1461       ],
1462       'primary_key' => 'acctid',
1463       'unique' => [],
1464       'index' => [ [ 'calldate' ], [ 'dst' ], [ 'accountcode' ], [ 'freesidestatus' ] ],
1465     },
1466
1467     'cdr_calltype' => {
1468       'columns' => [
1469         'calltypenum',   'serial',  '', '', '', '',
1470         'calltypename',  'varchar', '', $char_d, '', '',
1471       ],
1472       'primary_key' => 'calltypenum',
1473       'unique'      => [],
1474       'index'       => [],
1475     },
1476
1477     'cdr_type' => {
1478       'columns' => [
1479         'cdrtypenum'  => 'serial',  '', '', '', '',
1480         'cdrtypename' => 'varchar', '', '', '', '',
1481       ],
1482       'primary_key' => 'cdrtypenum',
1483       'unique'      => [],
1484       'index'       => [],
1485     },
1486
1487     'cdr_carrier' => {
1488       'columns' => [
1489         'carrierid'   => 'serial',  '', '', '', '',
1490         'carriername' => 'varchar', '', '', '', '',
1491       ],
1492       'primary_key' => 'carrierid',
1493       'unique'      => [],
1494       'index'       => [],
1495     },
1496
1497     #map upstream rateid to ours...
1498     'cdr_upstream_rate' => {
1499       'columns' => [
1500         'upstreamratenum', 'serial',  '', '', '', '',
1501         'upstream_rateid', 'varchar', '', $char_d, '', '',
1502         'ratedetailnum',   'int', 'NULL', '', '', '',
1503       ],
1504       'primary_key' => 'upstreamratenum', #XXX need a primary key
1505       'unique' => [ [ 'upstream_rateid' ] ], #unless we add another field, yeah
1506       'index'  => [],
1507     },
1508
1509     'inventory_item' => {
1510       'columns' => [
1511         'itemnum',  'serial',      '',      '', '', '',
1512         'classnum', 'int',         '',      '', '', '',
1513         'item',     'varchar',     '', $char_d, '', '',
1514         'svcnum',   'int',     'NULL',      '', '', '',
1515       ],
1516       'primary_key' => 'itemnum',
1517       'unique' => [ [ 'classnum', 'item' ] ],
1518       'index'  => [ [ 'classnum' ], [ 'svcnum' ] ],
1519     },
1520
1521     'inventory_class' => {
1522       'columns' => [
1523         'classnum',  'serial',       '',      '', '', '',
1524         'classname', 'varchar',      '', $char_d, '', '',
1525       ],
1526       'primary_key' => 'classnum',
1527       'unique' => [],
1528       'index'  => [],
1529     },
1530
1531     'access_user' => {
1532       'columns' => [
1533         'usernum',   'serial',  '',      '', '', '',
1534         'username',  'varchar', '', $char_d, '', '',
1535         '_password', 'varchar', '', $char_d, '', '',
1536         'last',      'varchar', '', $char_d, '', '',
1537         'first',     'varchar', '', $char_d, '', '',
1538         'disabled',     'char', 'NULL',   1, '', '',
1539       ],
1540       'primary_key' => 'usernum',
1541       'unique' => [ [ 'username' ] ],
1542       'index'  => [],
1543     },
1544
1545     'access_user_pref' => {
1546       'columns' => [
1547         'prefnum',    'serial',       '', '', '', '',
1548         'usernum',     'int',       '', '', '', '',
1549         'prefname', 'varchar', '', $char_d, '', '',
1550         'prefvalue', 'text', 'NULL', '', '', '',
1551       ],
1552       'primary_key' => 'prefnum',
1553       'unique' => [],
1554       'index'  => [ [ 'usernum' ] ],
1555     },
1556
1557     'access_group' => {
1558       'columns' => [
1559         'groupnum',   'serial', '',      '', '', '',
1560         'groupname', 'varchar', '', $char_d, '', '',
1561       ],
1562       'primary_key' => 'groupnum',
1563       'unique' => [ [ 'groupname' ] ],
1564       'index'  => [],
1565     },
1566
1567     'access_usergroup' => {
1568       'columns' => [
1569         'usergroupnum', 'serial', '', '', '', '',
1570         'usernum',         'int', '', '', '', '',
1571         'groupnum',        'int', '', '', '', '',
1572       ],
1573       'primary_key' => 'usergroupnum',
1574       'unique' => [ [ 'usernum', 'groupnum' ] ],
1575       'index'  => [ [ 'usernum' ] ],
1576     },
1577
1578     'access_groupagent' => {
1579       'columns' => [
1580         'groupagentnum', 'serial', '', '', '', '',
1581         'groupnum',         'int', '', '', '', '',
1582         'agentnum',         'int', '', '', '', '',
1583       ],
1584       'primary_key' => 'groupagentnum',
1585       'unique' => [ [ 'groupnum', 'agentnum' ] ],
1586       'index'  => [ [ 'groupnum' ] ],
1587     },
1588
1589     'access_right' => {
1590       'columns' => [
1591         'rightnum',   'serial', '',      '', '', '',
1592         'righttype', 'varchar', '', $char_d, '', '',
1593         'rightobjnum',   'int', '',      '', '', '',
1594         'rightname', 'varchar', '',      '', '', '',
1595       ],
1596       'primary_key' => 'rightnum',
1597       'unique' => [ [ 'righttype', 'rightobjnum', 'rightname' ] ],
1598       'index'  => [],
1599     },
1600
1601     'svc_phone' => {
1602       'columns' => [
1603         'svcnum',      'int',         '',      '', '', '',
1604         'countrycode', 'varchar',     '',       3, '', '',
1605         'phonenum',    'varchar',     '',      15, '', '',  #12 ?
1606         'pin',         'varchar', 'NULL', $char_d, '', '',
1607       ],
1608       'primary_key' => 'svcnum',
1609       'unique' => [],
1610       'index'  => [ [ 'countrycode', 'phonenum' ] ],
1611     },
1612
1613     'reason_type' => {
1614       'columns' => [
1615         'typenum',   'serial',  '', '', '', '',
1616         'class',     'char', '', 1, '', '',
1617         'type',     'varchar', '', $char_d, '', '',
1618       ],
1619       'primary_key' => 'typenum',
1620       'unique' => [],
1621       'index' => [],
1622     },
1623
1624     'reason' => {
1625       'columns' => [
1626         'reasonnum',     'serial',  '', '', '', '',
1627         'reason_type',   'int',  '', '', '', '',
1628         'reason',        'varchar', '', $char_d, '', '',
1629         'disabled',      'char',    'NULL', 1, '', '',
1630       ],
1631       'primary_key' => 'reasonnum',
1632       'unique' => [],
1633       'index' => [],
1634     },
1635
1636     # name type nullability length default local
1637
1638     #'new_table' => {
1639     #  'columns' => [
1640     #    'num', 'serial',       '', '', '', '',
1641     #  ],
1642     #  'primary_key' => 'num',
1643     #  'unique' => [],
1644     #  'index'  => [],
1645     #},
1646
1647   };
1648
1649 }
1650
1651 =back
1652
1653 =head1 BUGS
1654
1655 =head1 SEE ALSO
1656
1657 L<DBIx::DBSchema>
1658
1659 =cut
1660
1661 1;
1662