use strict;
use warnings FATAL => 'all';
-our $VERSION = q(1.0014);
+our $VERSION = q(1.0015);
-use Data::Dumper ();
use Scalar::Util ();
-use DBM::Deep::Engine;
-use DBM::Deep::File;
+use DBM::Deep::Engine::File ();
+
+use DBM::Deep::SQL::Util;
+use DBM::Deep::SQL::Array;
+use DBM::Deep::SQL::Hash;
use overload
'""' => sub { overload::StrVal( $_[0] ) },
use constant DEBUG => 0;
-##
-# Setup constants for users to pass to new()
-##
sub TYPE_HASH () { DBM::Deep::Engine->SIG_HASH }
sub TYPE_ARRAY () { DBM::Deep::Engine->SIG_ARRAY }
return $args;
}
+# Class constructor method for Perl OO interface.
+# Calls tie() and returns blessed reference to tied hash or array,
+# providing a hybrid OO/tie interface.
sub new {
- ##
- # Class constructor method for Perl OO interface.
- # Calls tie() and returns blessed reference to tied hash or array,
- # providing a hybrid OO/tie interface.
- ##
my $class = shift;
my $args = $class->_get_args( @_ );
+ my $self;
+
+ if (exists $args->{dbi}) {
+ eval {
+ require DBIx::Abstract;
+ }; if ( $@ ) {
+ __PACKAGE__->_throw_error('DBIx::Abstract not installed. You cannot use the SQL mode.');
+ }
+ unless (UNIVERSAL::isa($args->{dbi}, 'DBIx::Abstract')) {
+ $args->{dbi} = DBIx::Abstract->connect($args->{dbi});
+ }
+
+ if (defined $args->{id}) {
+ unless ($args->{id} =~ /^\d+$/ && $args->{id} > 0) {
+ __PACKAGE__->_throw_error('Invalid SQL record id');
+ }
+ my $util = {dbi => $args->{dbi}};
+ bless $util, 'DBM::Deep::SQL::Util';
+ my $q = $util->_select(
+ table => 'rec_item',
+ fields => 'item_type',
+ where => {id => $args->{id}},
+ );
+ if ($q->[0]->[0] eq 'array') {
+ $args->{type} = TYPE_ARRAY;
+ }
+ elsif ($q->[0]->[0] eq 'hash') {
+ $args->{type} = TYPE_HASH;
+ }
+ else {
+ DBM::Deep->_throw_error('Unknown SQL record id');
+ }
+ }
+ else {
+ my $util = {dbi => $args->{dbi}};
+ bless $util, 'DBM::Deep::SQL::Util';
+ if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
+ $args->{id} = $util->_create('array');
+ }
+ else {
+ $args->{id} = $util->_create('hash');
+ }
+ }
+
+ if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
+ $class = 'DBM::Deep::SQL::Array';
+ require DBM::Deep::SQL::Array;
+ tie @$self, $class, %$args;
+ if ($args->{prefetch}) {
+ (tied(@$self))->_prefetch();
+ }
+ return bless $self, $class;
+ }
+ else {
+ $class = 'DBM::Deep::SQL::Hash';
+ require DBM::Deep::SQL::Hash;
+ tie %$self, $class, %$args;
+ if ($args->{prefetch}) {
+ (tied(%$self))->_prefetch();
+ }
+ return bless $self, $class;
+ }
+ }
##
# Check if we want a tied hash or array.
##
- my $self;
if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
$class = 'DBM::Deep::Array';
require DBM::Deep::Array;
engine => undef,
}, $class;
- $args->{engine} = DBM::Deep::Engine->new( { %{$args}, obj => $self } )
- unless exists $args->{engine};
+ unless ( exists $args->{engine} ) {
+ my $class = exists $args->{dbi}
+ ? 'DBM::Deep::Engine::DBI'
+ : 'DBM::Deep::Engine::File';
+
+ $args->{engine} = $class->new({
+ %{$args},
+ obj => $self,
+ });
+ }
# Grab the parameters we want to use
foreach my $param ( keys %$self ) {
}
eval {
- local $SIG{'__DIE__'};
+ local $SIG{'__DIE__'};
- $self->lock_exclusive;
- $self->_engine->setup_fh( $self );
- $self->unlock;
+ $self->lock_exclusive;
+ $self->_engine->setup( $self );
+ $self->unlock;
}; if ( $@ ) {
- my $e = $@;
- eval { local $SIG{'__DIE__'}; $self->unlock; };
- die $e;
+ my $e = $@;
+ eval { local $SIG{'__DIE__'}; $self->unlock; };
+ die $e;
}
return $self;
${$spot} = $value;
}
else {
- # This assumes hash or array only. This is a bad assumption moving forward.
- # -RobK, 2008-05-27
my $r = Scalar::Util::reftype( $value );
my $tied;
if ( $r eq 'ARRAY' ) {
$tied = tied(@$value);
}
- else {
+ elsif ( $r eq 'HASH' ) {
$tied = tied(%$value);
}
+ else {
+ __PACKAGE__->_throw_error( "Unknown type for '$value'" );
+ }
- if ( eval { local $SIG{__DIE__}; $tied->isa( 'DBM::Deep' ) } ) {
+ if ( eval { local $SIG{__DIE__}; $tied->isa( __PACKAGE__ ) } ) {
${$spot} = $tied->_repr;
$tied->_copy_node( ${$spot} );
}
}
my $c = Scalar::Util::blessed( $value );
- if ( defined $c && !$c->isa( 'DBM::Deep') ) {
+ if ( defined $c && !$c->isa( __PACKAGE__ ) ) {
${$spot} = bless ${$spot}, $c
}
}
#}
sub export {
- ##
- # Recursively export into standard Perl hashes and arrays.
- ##
my $self = shift->_get_self;
my $temp = $self->_repr;
return $r if 'HASH' eq $r;
return $r if 'ARRAY' eq $r;
- DBM::Deep->_throw_error(
+ __PACKAGE__->_throw_error(
"Storage of references of type '$r' is not supported."
);
}
sub import {
- # Perl calls import() on use -- ignore
- return if !ref $_[0];
+ return if !ref $_[0]; # Perl calls import() on use -- ignore
my $self = shift->_get_self;
my ($struct) = @_;
my $type = $self->_check_legality( $struct );
if ( !$type ) {
- DBM::Deep->_throw_error( "Cannot import a scalar" );
+ __PACKAGE__->_throw_error( "Cannot import a scalar" );
}
if ( substr( $type, 0, 1 ) ne $self->_type ) {
- DBM::Deep->_throw_error(
+ __PACKAGE__->_throw_error(
"Cannot import " . ('HASH' eq $type ? 'a hash' : 'an array')
. " into " . ('HASH' eq $type ? 'an array' : 'a hash')
);
#XXX Need to keep track of who has a fh to this file in order to
#XXX close them all prior to optimize on Win32/cygwin
+# Rebuild entire database into new file, then move
+# it back on top of original.
sub optimize {
- ##
- # Rebuild entire database into new file, then move
- # it back on top of original.
- ##
my $self = shift->_get_self;
+ # Optimizing is only something we need to do when we're working with our
+ # own file format. Otherwise, let the other guy do the optimizations.
+ return unless $self->_engine->isa( 'DBM::Deep::Engine::File' );
+
#XXX Need to create a new test for this
# if ($self->_engine->storage->{links} > 1) {
# $self->_throw_error("Cannot optimize: reference count is greater than 1");
#XXX Should we use tempfile() here instead of a hard-coded name?
my $temp_filename = $self->_engine->storage->{file} . '.tmp';
- my $db_temp = DBM::Deep->new(
+ my $db_temp = __PACKAGE__->new(
file => $temp_filename,
type => $self->_type,
$self->_engine->storage->open;
$self->lock_exclusive;
- $self->_engine->setup_fh( $self );
+ $self->_engine->setup( $self );
$self->unlock;
return 1;
##
my $self = shift->_get_self;
- return DBM::Deep->new(
+ return __PACKAGE__->new(
type => $self->_type,
base_offset => $self->_base_offset,
staleness => $self->_staleness,
return $rv;
}
-##
# Accessor methods
-##
-
sub _engine {
my $self = $_[0]->_get_self;
return $self->{engine};
return $self->{staleness};
}
-##
# Utility methods
-##
-
sub _throw_error {
my $n = 0;
while( 1 ) {
}
}
+# Store single hash key/value or array element in database.
sub STORE {
- ##
- # Store single hash key/value or array element in database.
- ##
my $self = shift->_get_self;
my ($key, $value) = @_;
- warn "STORE($self, $key, @{[defined$value?$value:'undef']})\n" if DEBUG;
+ warn "STORE($self, '$key', '@{[defined$value?$value:'undef']}')\n" if DEBUG;
unless ( $self->_engine->storage->is_writable ) {
$self->_throw_error( 'Cannot write to a readonly filehandle' );
$value = $self->_engine->storage->{filter_store_value}->( $value );
}
- $self->_engine->write_value( $self, $key, $value);
+ $self->_engine->write_value( $self, $key, $value );
$self->unlock;
return 1;
}
+# Fetch single value or element given plain key or array index
sub FETCH {
- ##
- # Fetch single value or element given plain key or array index
- ##
my $self = shift->_get_self;
my ($key) = @_;
- warn "FETCH($self,$key)\n" if DEBUG;
+ warn "FETCH($self, '$key')\n" if DEBUG;
$self->lock_shared;
- my $result = $self->_engine->read_value( $self, $key);
+ my $result = $self->_engine->read_value( $self, $key );
$self->unlock;
: $result;
}
+# Delete single key/value pair or element given plain key or array index
sub DELETE {
- ##
- # Delete single key/value pair or element given plain key or array index
- ##
my $self = shift->_get_self;
my ($key) = @_;
- warn "DELETE($self,$key)\n" if DEBUG;
+ warn "DELETE($self, '$key')\n" if DEBUG;
unless ( $self->_engine->storage->is_writable ) {
$self->_throw_error( 'Cannot write to a readonly filehandle' );
return $value;
}
+# Check if a single key or element exists given plain key or array index
sub EXISTS {
- ##
- # Check if a single key or element exists given plain key or array index
- ##
my $self = shift->_get_self;
my ($key) = @_;
- warn "EXISTS($self,$key)\n" if DEBUG;
+ warn "EXISTS($self, '$key')\n" if DEBUG;
$self->lock_shared;
return $result;
}
+# Clear all keys from hash, or all elements from array.
sub CLEAR {
- ##
- # Clear all keys from hash, or all elements from array.
- ##
my $self = shift->_get_self;
warn "CLEAR($self)\n" if DEBUG;
return 1;
}
-##
# Public method aliases
-##
-sub put { (shift)->STORE( @_ ) }
-sub store { (shift)->STORE( @_ ) }
-sub get { (shift)->FETCH( @_ ) }
-sub fetch { (shift)->FETCH( @_ ) }
+sub put { (shift)->STORE( @_ ) }
+sub get { (shift)->FETCH( @_ ) }
+sub store { (shift)->STORE( @_ ) }
+sub fetch { (shift)->FETCH( @_ ) }
sub delete { (shift)->DELETE( @_ ) }
sub exists { (shift)->EXISTS( @_ ) }
-sub clear { (shift)->CLEAR( @_ ) }
+sub clear { (shift)->CLEAR( @_ ) }
sub _dump_file {shift->_get_self->_engine->_dump_file;}
projects / dbsrgits/DBM-Deep.git / blobdiff