Initial refactoring to use ::File for all physical file access instead of allowing...
[dbsrgits/DBM-Deep.git] / lib / DBM / Deep.pm
1 package DBM::Deep;
2
3 ##
4 # DBM::Deep
5 #
6 # Description:
7 #    Multi-level database module for storing hash trees, arrays and simple
8 #    key/value pairs into FTP-able, cross-platform binary database files.
9 #
10 #    Type `perldoc DBM::Deep` for complete documentation.
11 #
12 # Usage Examples:
13 #    my %db;
14 #    tie %db, 'DBM::Deep', 'my_database.db'; # standard tie() method
15 #
16 #    my $db = new DBM::Deep( 'my_database.db' ); # preferred OO method
17 #
18 #    $db->{my_scalar} = 'hello world';
19 #    $db->{my_hash} = { larry => 'genius', hashes => 'fast' };
20 #    $db->{my_array} = [ 1, 2, 3, time() ];
21 #    $db->{my_complex} = [ 'hello', { perl => 'rules' }, 42, 99 ];
22 #    push @{$db->{my_array}}, 'another value';
23 #    my @key_list = keys %{$db->{my_hash}};
24 #    print "This module " . $db->{my_complex}->[1]->{perl} . "!\n";
25 #
26 # Copyright:
27 #    (c) 2002-2006 Joseph Huckaby.  All Rights Reserved.
28 #    This program is free software; you can redistribute it and/or
29 #    modify it under the same terms as Perl itself.
30 ##
31
32 use 5.6.0;
33
34 use strict;
35 use warnings;
36
37 use Fcntl qw( :DEFAULT :flock :seek );
38 use Digest::MD5 ();
39 use Scalar::Util ();
40
41 use DBM::Deep::Engine;
42 use DBM::Deep::File;
43
44 use vars qw( $VERSION );
45 $VERSION = q(0.99_01);
46
47 ##
48 # Setup constants for users to pass to new()
49 ##
50 sub TYPE_HASH   () { DBM::Deep::Engine->SIG_HASH   }
51 sub TYPE_ARRAY  () { DBM::Deep::Engine->SIG_ARRAY  }
52
53 sub _get_args {
54     my $proto = shift;
55
56     my $args;
57     if (scalar(@_) > 1) {
58         if ( @_ % 2 ) {
59             $proto->_throw_error( "Odd number of parameters to " . (caller(1))[2] );
60         }
61         $args = {@_};
62     }
63     elsif ( ref $_[0] ) {
64         unless ( eval { local $SIG{'__DIE__'}; %{$_[0]} || 1 } ) {
65             $proto->_throw_error( "Not a hashref in args to " . (caller(1))[2] );
66         }
67         $args = $_[0];
68     }
69     else {
70         $args = { file => shift };
71     }
72
73     return $args;
74 }
75
76 sub new {
77     ##
78     # Class constructor method for Perl OO interface.
79     # Calls tie() and returns blessed reference to tied hash or array,
80     # providing a hybrid OO/tie interface.
81     ##
82     my $class = shift;
83     my $args = $class->_get_args( @_ );
84
85     ##
86     # Check if we want a tied hash or array.
87     ##
88     my $self;
89     if (defined($args->{type}) && $args->{type} eq TYPE_ARRAY) {
90         $class = 'DBM::Deep::Array';
91         require DBM::Deep::Array;
92         tie @$self, $class, %$args;
93     }
94     else {
95         $class = 'DBM::Deep::Hash';
96         require DBM::Deep::Hash;
97         tie %$self, $class, %$args;
98     }
99
100     return bless $self, $class;
101 }
102
103 # This initializer is called from the various TIE* methods. new() calls tie(),
104 # which allows for a single point of entry.
105 sub _init {
106     my $class = shift;
107     my ($args) = @_;
108
109     $args->{fileobj} = DBM::Deep::File->new( $args )
110         unless exists $args->{fileobj};
111
112     # locking implicitly enables autoflush
113     if ($args->{locking}) { $args->{autoflush} = 1; }
114
115     # These are the defaults to be optionally overridden below
116     my $self = bless {
117         type        => TYPE_HASH,
118         base_offset => undef,
119
120         parent      => undef,
121         parent_key  => undef,
122
123         fileobj     => undef,
124     }, $class;
125     $self->{engine} = DBM::Deep::Engine->new( { %{$args}, obj => $self } );
126
127     # Grab the parameters we want to use
128     foreach my $param ( keys %$self ) {
129         next unless exists $args->{$param};
130         $self->{$param} = $args->{$param};
131     }
132
133     $self->{engine}->setup_fh( $self );
134
135     $self->{fileobj}->set_db( $self );
136
137     return $self;
138 }
139
140 sub TIEHASH {
141     shift;
142     require DBM::Deep::Hash;
143     return DBM::Deep::Hash->TIEHASH( @_ );
144 }
145
146 sub TIEARRAY {
147     shift;
148     require DBM::Deep::Array;
149     return DBM::Deep::Array->TIEARRAY( @_ );
150 }
151
152 sub lock {
153     my $self = shift->_get_self;
154     return $self->_fileobj->lock( $self, @_ );
155 }
156
157 sub unlock {
158     my $self = shift->_get_self;
159     return $self->_fileobj->unlock( $self, @_ );
160 }
161
162 sub _copy_value {
163     my $self = shift->_get_self;
164     my ($spot, $value) = @_;
165
166     if ( !ref $value ) {
167         ${$spot} = $value;
168     }
169     elsif ( eval { local $SIG{__DIE__}; $value->isa( 'DBM::Deep' ) } ) {
170         ${$spot} = $value->_repr;
171         $value->_copy_node( ${$spot} );
172     }
173     else {
174         my $r = Scalar::Util::reftype( $value );
175         my $c = Scalar::Util::blessed( $value );
176         if ( $r eq 'ARRAY' ) {
177             ${$spot} = [ @{$value} ];
178         }
179         else {
180             ${$spot} = { %{$value} };
181         }
182         ${$spot} = bless ${$spot}, $c
183             if defined $c;
184     }
185
186     return 1;
187 }
188
189 sub _copy_node {
190     die "Must be implemented in a child class\n";
191 }
192
193 sub _repr {
194     die "Must be implemented in a child class\n";
195 }
196
197 sub export {
198     ##
199     # Recursively export into standard Perl hashes and arrays.
200     ##
201     my $self = shift->_get_self;
202
203     my $temp = $self->_repr;
204
205     $self->lock();
206     $self->_copy_node( $temp );
207     $self->unlock();
208
209     return $temp;
210 }
211
212 sub import {
213     ##
214     # Recursively import Perl hash/array structure
215     ##
216     if (!ref($_[0])) { return; } # Perl calls import() on use -- ignore
217
218     my $self = shift->_get_self;
219     my ($struct) = @_;
220
221     # struct is not a reference, so just import based on our type
222     if (!ref($struct)) {
223         $struct = $self->_repr( @_ );
224     }
225
226     return $self->_import( $struct );
227 }
228
229 sub optimize {
230     ##
231     # Rebuild entire database into new file, then move
232     # it back on top of original.
233     ##
234     my $self = shift->_get_self;
235
236 #XXX Need to create a new test for this
237 #    if ($self->_fileobj->{links} > 1) {
238 #        $self->_throw_error("Cannot optimize: reference count is greater than 1");
239 #    }
240
241     my $db_temp = DBM::Deep->new(
242         file => $self->_fileobj->{file} . '.tmp',
243         type => $self->_type
244     );
245
246     $self->lock();
247     $self->_copy_node( $db_temp );
248     undef $db_temp;
249
250     ##
251     # Attempt to copy user, group and permissions over to new file
252     ##
253     my @stats = stat($self->_fh);
254     my $perms = $stats[2] & 07777;
255     my $uid = $stats[4];
256     my $gid = $stats[5];
257     chown( $uid, $gid, $self->_fileobj->{file} . '.tmp' );
258     chmod( $perms, $self->_fileobj->{file} . '.tmp' );
259
260     # q.v. perlport for more information on this variable
261     if ( $^O eq 'MSWin32' || $^O eq 'cygwin' ) {
262         ##
263         # Potential race condition when optmizing on Win32 with locking.
264         # The Windows filesystem requires that the filehandle be closed
265         # before it is overwritten with rename().  This could be redone
266         # with a soft copy.
267         ##
268         $self->unlock();
269         $self->_fileobj->close;
270     }
271
272     if (!rename $self->_fileobj->{file} . '.tmp', $self->_fileobj->{file}) {
273         unlink $self->_fileobj->{file} . '.tmp';
274         $self->unlock();
275         $self->_throw_error("Optimize failed: Cannot copy temp file over original: $!");
276     }
277
278     $self->unlock();
279     $self->_fileobj->close;
280     $self->_fileobj->open;
281     $self->{engine}->setup_fh( $self );
282
283     return 1;
284 }
285
286 sub clone {
287     ##
288     # Make copy of object and return
289     ##
290     my $self = shift->_get_self;
291
292     return DBM::Deep->new(
293         type => $self->_type,
294         base_offset => $self->_base_offset,
295         fileobj => $self->_fileobj,
296     );
297 }
298
299 {
300     my %is_legal_filter = map {
301         $_ => ~~1,
302     } qw(
303         store_key store_value
304         fetch_key fetch_value
305     );
306
307     sub set_filter {
308         ##
309         # Setup filter function for storing or fetching the key or value
310         ##
311         my $self = shift->_get_self;
312         my $type = lc shift;
313         my $func = shift;
314
315         if ( $is_legal_filter{$type} ) {
316             $self->_fileobj->{"filter_$type"} = $func;
317             return 1;
318         }
319
320         return;
321     }
322 }
323
324 sub begin_work {
325     my $self = shift->_get_self;
326     $self->_fileobj->begin_transaction;
327     return 1;
328 }
329
330 sub rollback {
331     my $self = shift->_get_self;
332     $self->_fileobj->end_transaction;
333     return 1;
334 }
335
336 sub commit {
337     my $self = shift->_get_self;
338     # At this point, we need to replay the actions taken
339     $self->_fileobj->end_transaction;
340     return 1;
341 }
342
343 ##
344 # Accessor methods
345 ##
346
347 sub _fileobj {
348     my $self = $_[0]->_get_self;
349     return $self->{fileobj};
350 }
351
352 sub _type {
353     my $self = $_[0]->_get_self;
354     return $self->{type};
355 }
356
357 sub _base_offset {
358     my $self = $_[0]->_get_self;
359     return $self->{base_offset};
360 }
361
362 sub _fh {
363     my $self = $_[0]->_get_self;
364     return $self->_fileobj->{fh};
365 }
366
367 ##
368 # Utility methods
369 ##
370
371 sub _throw_error {
372     die "DBM::Deep: $_[1]\n";
373 }
374
375 sub _is_writable {
376     my $fh = shift;
377     (O_WRONLY | O_RDWR) & fcntl( $fh, F_GETFL, my $slush = 0);
378 }
379
380 #sub _is_readable {
381 #    my $fh = shift;
382 #    (O_RDONLY | O_RDWR) & fcntl( $fh, F_GETFL, my $slush = 0);
383 #}
384
385 sub _find_parent {
386     my $self = shift;
387
388     my $base = '';
389     if ( my $parent = $self->{parent} ) {
390         my $child = $self;
391         while ( 1 ) {
392             $base = (
393                 $parent->_type eq TYPE_HASH
394                     ? "\{$child->{parent_key}\}"
395                     : "\[$child->{parent_key}\]"
396             ) . $base;
397
398             $child = $parent;
399             $parent = $parent->{parent};
400             last unless $parent;
401         }
402     }
403     return '$db->' . $base;
404 }
405
406 sub STORE {
407     ##
408     # Store single hash key/value or array element in database.
409     ##
410     my $self = shift->_get_self;
411     my ($key, $value, $orig_key) = @_;
412
413
414     if ( $^O ne 'MSWin32' && !_is_writable( $self->_fh ) ) {
415         $self->_throw_error( 'Cannot write to a readonly filehandle' );
416     }
417
418     if ( defined $orig_key ) {
419         my $lhs = $self->_find_parent;
420         if ( $self->_type eq TYPE_HASH ) {
421             $lhs .= "\{$orig_key\}";
422         }
423         else {
424             $lhs .= "\[$orig_key\]";
425         }
426
427         my $rhs;
428
429         my $r = Scalar::Util::reftype( $value ) || '';
430         if ( $r eq 'HASH' ) {
431             $rhs = '{}';
432         }
433         elsif ( $r eq 'ARRAY' ) {
434             $rhs = '[]';
435         }
436         elsif ( defined $value ) {
437             $rhs = "'$value'";
438         }
439         else {
440             $rhs = "undef";
441         }
442
443         if ( my $c = Scalar::Util::blessed( $value ) ) {
444             $rhs = "bless $rhs, '$c'";
445         }
446
447         $self->_fileobj->audit( "$lhs = $rhs;" );
448     }
449
450     ##
451     # Request exclusive lock for writing
452     ##
453     $self->lock( LOCK_EX );
454
455     my $md5 = $self->{engine}{digest}->($key);
456
457     my $tag = $self->{engine}->find_bucket_list( $self->_base_offset, $md5, { create => 1 } );
458
459     # User may be storing a hash, in which case we do not want it run
460     # through the filtering system
461     if ( !ref($value) && $self->_fileobj->{filter_store_value} ) {
462         $value = $self->_fileobj->{filter_store_value}->( $value );
463     }
464
465     ##
466     # Add key/value to bucket list
467     ##
468     my $result = $self->{engine}->add_bucket( $tag, $md5, $key, $value, undef, $orig_key ); 
469
470     $self->unlock();
471
472     return $result;
473 }
474
475 sub FETCH {
476     ##
477     # Fetch single value or element given plain key or array index
478     ##
479     my $self = shift->_get_self;
480     my ($key, $orig_key) = @_;
481
482     my $md5 = $self->{engine}{digest}->($key);
483
484     ##
485     # Request shared lock for reading
486     ##
487     $self->lock( LOCK_SH );
488
489     my $tag = $self->{engine}->find_bucket_list( $self->_base_offset, $md5 );
490     if (!$tag) {
491         $self->unlock();
492         return;
493     }
494
495     ##
496     # Get value from bucket list
497     ##
498     my $result = $self->{engine}->get_bucket_value( $tag, $md5, $orig_key );
499
500     $self->unlock();
501
502     # Filters only apply to scalar values, so the ref check is making
503     # sure the fetched bucket is a scalar, not a child hash or array.
504     return ($result && !ref($result) && $self->_fileobj->{filter_fetch_value})
505         ? $self->_fileobj->{filter_fetch_value}->($result)
506         : $result;
507 }
508
509 sub DELETE {
510     ##
511     # Delete single key/value pair or element given plain key or array index
512     ##
513     my $self = shift->_get_self;
514     my ($key, $orig_key) = @_;
515
516     if ( $^O ne 'MSWin32' && !_is_writable( $self->_fh ) ) {
517         $self->_throw_error( 'Cannot write to a readonly filehandle' );
518     }
519
520     if ( defined $orig_key ) {
521         my $lhs = $self->_find_parent;
522         if ( $self->_type eq TYPE_HASH ) {
523             $lhs .= "\{$orig_key\}";
524         }
525         else {
526             $lhs .= "\[$orig_key]\]";
527         }
528
529         $self->_fileobj->audit( "delete $lhs;" );
530     }
531
532     ##
533     # Request exclusive lock for writing
534     ##
535     $self->lock( LOCK_EX );
536
537     my $md5 = $self->{engine}{digest}->($key);
538
539     my $tag = $self->{engine}->find_bucket_list( $self->_base_offset, $md5 );
540     if (!$tag) {
541         $self->unlock();
542         return;
543     }
544
545     ##
546     # Delete bucket
547     ##
548     my $value = $self->{engine}->get_bucket_value( $tag, $md5 );
549
550     if (defined $value && !ref($value) && $self->_fileobj->{filter_fetch_value}) {
551         $value = $self->_fileobj->{filter_fetch_value}->($value);
552     }
553
554     my $result = $self->{engine}->delete_bucket( $tag, $md5, $orig_key );
555
556     ##
557     # If this object is an array and the key deleted was on the end of the stack,
558     # decrement the length variable.
559     ##
560
561     $self->unlock();
562
563     return $value;
564 }
565
566 sub EXISTS {
567     ##
568     # Check if a single key or element exists given plain key or array index
569     ##
570     my $self = shift->_get_self;
571     my ($key) = @_;
572
573     my $md5 = $self->{engine}{digest}->($key);
574
575     ##
576     # Request shared lock for reading
577     ##
578     $self->lock( LOCK_SH );
579
580     my $tag = $self->{engine}->find_bucket_list( $self->_base_offset, $md5 );
581     if (!$tag) {
582         $self->unlock();
583
584         ##
585         # For some reason, the built-in exists() function returns '' for false
586         ##
587         return '';
588     }
589
590     ##
591     # Check if bucket exists and return 1 or ''
592     ##
593     my $result = $self->{engine}->bucket_exists( $tag, $md5 ) || '';
594
595     $self->unlock();
596
597     return $result;
598 }
599
600 sub CLEAR {
601     ##
602     # Clear all keys from hash, or all elements from array.
603     ##
604     my $self = shift->_get_self;
605
606     if ( $^O ne 'MSWin32' && !_is_writable( $self->_fh ) ) {
607         $self->_throw_error( 'Cannot write to a readonly filehandle' );
608     }
609
610     {
611         my $lhs = $self->_find_parent;
612
613         my $rhs = '()';
614         if ( $self->_type eq TYPE_HASH ) {
615             $lhs = '%{' . $lhs . '}';
616         }
617         else {
618             $lhs = '@{' . $lhs . '}';
619         }
620
621         $self->_fileobj->audit( "$lhs = $rhs;" );
622     }
623
624     ##
625     # Request exclusive lock for writing
626     ##
627     $self->lock( LOCK_EX );
628
629     #my $fh = $self->_fh;
630     #
631     #seek($fh, $self->_base_offset + $self->_fileobj->{file_offset}, SEEK_SET);
632     #if (eof $fh) {
633     #    $self->unlock();
634     #    return;
635     #}
636
637 #XXX This needs updating to use _release_space
638     $self->{engine}->write_tag(
639         $self->_base_offset, $self->_type,
640         chr(0)x$self->{engine}{index_size},
641     );
642
643     $self->unlock();
644
645     return 1;
646 }
647
648 ##
649 # Public method aliases
650 ##
651 sub put { (shift)->STORE( @_ ) }
652 sub store { (shift)->STORE( @_ ) }
653 sub get { (shift)->FETCH( @_ ) }
654 sub fetch { (shift)->FETCH( @_ ) }
655 sub delete { (shift)->DELETE( @_ ) }
656 sub exists { (shift)->EXISTS( @_ ) }
657 sub clear { (shift)->CLEAR( @_ ) }
658
659 1;
660 __END__
661
662 =head1 NAME
663
664 DBM::Deep - A pure perl multi-level hash/array DBM
665
666 =head1 SYNOPSIS
667
668   use DBM::Deep;
669   my $db = DBM::Deep->new( "foo.db" );
670
671   $db->{key} = 'value'; # tie() style
672   print $db->{key};
673
674   $db->put('key' => 'value'); # OO style
675   print $db->get('key');
676
677   # true multi-level support
678   $db->{my_complex} = [
679       'hello', { perl => 'rules' },
680       42, 99,
681   ];
682
683 =head1 DESCRIPTION
684
685 A unique flat-file database module, written in pure perl.  True
686 multi-level hash/array support (unlike MLDBM, which is faked), hybrid
687 OO / tie() interface, cross-platform FTPable files, and quite fast.  Can
688 handle millions of keys and unlimited hash levels without significant
689 slow-down.  Written from the ground-up in pure perl -- this is NOT a
690 wrapper around a C-based DBM.  Out-of-the-box compatibility with Unix,
691 Mac OS X and Windows.
692
693 =head1 VERSION DIFFERENCES
694
695 B<NOTE>: 0.99_01 and above have significant file format differences from 0.98 and
696 before. While attempts have been made to be backwards compatible, no guarantees.
697
698 =head1 INSTALLATION
699
700 Hopefully you are using Perl's excellent CPAN module, which will download
701 and install the module for you.  If not, get the tarball, and run these
702 commands:
703
704     tar zxf DBM-Deep-*
705     cd DBM-Deep-*
706     perl Makefile.PL
707     make
708     make test
709     make install
710
711 =head1 SETUP
712
713 Construction can be done OO-style (which is the recommended way), or using
714 Perl's tie() function.  Both are examined here.
715
716 =head2 OO CONSTRUCTION
717
718 The recommended way to construct a DBM::Deep object is to use the new()
719 method, which gets you a blessed, tied hash or array reference.
720
721     my $db = DBM::Deep->new( "foo.db" );
722
723 This opens a new database handle, mapped to the file "foo.db".  If this
724 file does not exist, it will automatically be created.  DB files are
725 opened in "r+" (read/write) mode, and the type of object returned is a
726 hash, unless otherwise specified (see L<OPTIONS> below).
727
728 You can pass a number of options to the constructor to specify things like
729 locking, autoflush, etc.  This is done by passing an inline hash:
730
731     my $db = DBM::Deep->new(
732         file => "foo.db",
733         locking => 1,
734         autoflush => 1
735     );
736
737 Notice that the filename is now specified I<inside> the hash with
738 the "file" parameter, as opposed to being the sole argument to the
739 constructor.  This is required if any options are specified.
740 See L<OPTIONS> below for the complete list.
741
742
743
744 You can also start with an array instead of a hash.  For this, you must
745 specify the C<type> parameter:
746
747     my $db = DBM::Deep->new(
748         file => "foo.db",
749         type => DBM::Deep->TYPE_ARRAY
750     );
751
752 B<Note:> Specifing the C<type> parameter only takes effect when beginning
753 a new DB file.  If you create a DBM::Deep object with an existing file, the
754 C<type> will be loaded from the file header, and an error will be thrown if
755 the wrong type is passed in.
756
757 =head2 TIE CONSTRUCTION
758
759 Alternately, you can create a DBM::Deep handle by using Perl's built-in
760 tie() function.  The object returned from tie() can be used to call methods,
761 such as lock() and unlock(), but cannot be used to assign to the DBM::Deep
762 file (as expected with most tie'd objects).
763
764     my %hash;
765     my $db = tie %hash, "DBM::Deep", "foo.db";
766
767     my @array;
768     my $db = tie @array, "DBM::Deep", "bar.db";
769
770 As with the OO constructor, you can replace the DB filename parameter with
771 a hash containing one or more options (see L<OPTIONS> just below for the
772 complete list).
773
774     tie %hash, "DBM::Deep", {
775         file => "foo.db",
776         locking => 1,
777         autoflush => 1
778     };
779
780 =head2 OPTIONS
781
782 There are a number of options that can be passed in when constructing your
783 DBM::Deep objects.  These apply to both the OO- and tie- based approaches.
784
785 =over
786
787 =item * file
788
789 Filename of the DB file to link the handle to.  You can pass a full absolute
790 filesystem path, partial path, or a plain filename if the file is in the
791 current working directory.  This is a required parameter (though q.v. fh).
792
793 =item * fh
794
795 If you want, you can pass in the fh instead of the file. This is most useful for doing
796 something like:
797
798   my $db = DBM::Deep->new( { fh => \*DATA } );
799
800 You are responsible for making sure that the fh has been opened appropriately for your
801 needs. If you open it read-only and attempt to write, an exception will be thrown. If you
802 open it write-only or append-only, an exception will be thrown immediately as DBM::Deep
803 needs to read from the fh.
804
805 =item * file_offset
806
807 This is the offset within the file that the DBM::Deep db starts. Most of the time, you will
808 not need to set this. However, it's there if you want it.
809
810 If you pass in fh and do not set this, it will be set appropriately.
811
812 =item * type
813
814 This parameter specifies what type of object to create, a hash or array.  Use
815 one of these two constants:
816
817 =over 4
818
819 =item * C<DBM::Deep-E<gt>TYPE_HASH>
820
821 =item * C<DBM::Deep-E<gt>TYPE_ARRAY>.
822
823 =back
824
825 This only takes effect when beginning a new file.  This is an optional
826 parameter, and defaults to C<DBM::Deep-E<gt>TYPE_HASH>.
827
828 =item * locking
829
830 Specifies whether locking is to be enabled.  DBM::Deep uses Perl's Fnctl flock()
831 function to lock the database in exclusive mode for writes, and shared mode for
832 reads.  Pass any true value to enable.  This affects the base DB handle I<and
833 any child hashes or arrays> that use the same DB file.  This is an optional
834 parameter, and defaults to 0 (disabled).  See L<LOCKING> below for more.
835
836 =item * autoflush
837
838 Specifies whether autoflush is to be enabled on the underlying filehandle.
839 This obviously slows down write operations, but is required if you may have
840 multiple processes accessing the same DB file (also consider enable I<locking>).
841 Pass any true value to enable.  This is an optional parameter, and defaults to 0
842 (disabled).
843
844 =item * autobless
845
846 If I<autobless> mode is enabled, DBM::Deep will preserve the class something
847 is blessed into, and restores it when fetched.  This is an optional parameter, and defaults to 1 (enabled).
848
849 B<Note:> If you use the OO-interface, you will not be able to call any methods
850 of DBM::Deep on the blessed item. This is considered to be a feature.
851
852 =item * filter_*
853
854 See L</FILTERS> below.
855
856 =back
857
858 =head1 TIE INTERFACE
859
860 With DBM::Deep you can access your databases using Perl's standard hash/array
861 syntax.  Because all DBM::Deep objects are I<tied> to hashes or arrays, you can
862 treat them as such.  DBM::Deep will intercept all reads/writes and direct them
863 to the right place -- the DB file.  This has nothing to do with the
864 L<TIE CONSTRUCTION> section above.  This simply tells you how to use DBM::Deep
865 using regular hashes and arrays, rather than calling functions like C<get()>
866 and C<put()> (although those work too).  It is entirely up to you how to want
867 to access your databases.
868
869 =head2 HASHES
870
871 You can treat any DBM::Deep object like a normal Perl hash reference.  Add keys,
872 or even nested hashes (or arrays) using standard Perl syntax:
873
874     my $db = DBM::Deep->new( "foo.db" );
875
876     $db->{mykey} = "myvalue";
877     $db->{myhash} = {};
878     $db->{myhash}->{subkey} = "subvalue";
879
880     print $db->{myhash}->{subkey} . "\n";
881
882 You can even step through hash keys using the normal Perl C<keys()> function:
883
884     foreach my $key (keys %$db) {
885         print "$key: " . $db->{$key} . "\n";
886     }
887
888 Remember that Perl's C<keys()> function extracts I<every> key from the hash and
889 pushes them onto an array, all before the loop even begins.  If you have an
890 extra large hash, this may exhaust Perl's memory.  Instead, consider using
891 Perl's C<each()> function, which pulls keys/values one at a time, using very
892 little memory:
893
894     while (my ($key, $value) = each %$db) {
895         print "$key: $value\n";
896     }
897
898 Please note that when using C<each()>, you should always pass a direct
899 hash reference, not a lookup.  Meaning, you should B<never> do this:
900
901     # NEVER DO THIS
902     while (my ($key, $value) = each %{$db->{foo}}) { # BAD
903
904 This causes an infinite loop, because for each iteration, Perl is calling
905 FETCH() on the $db handle, resulting in a "new" hash for foo every time, so
906 it effectively keeps returning the first key over and over again. Instead,
907 assign a temporary variable to C<$db->{foo}>, then pass that to each().
908
909 =head2 ARRAYS
910
911 As with hashes, you can treat any DBM::Deep object like a normal Perl array
912 reference.  This includes inserting, removing and manipulating elements,
913 and the C<push()>, C<pop()>, C<shift()>, C<unshift()> and C<splice()> functions.
914 The object must have first been created using type C<DBM::Deep-E<gt>TYPE_ARRAY>,
915 or simply be a nested array reference inside a hash.  Example:
916
917     my $db = DBM::Deep->new(
918         file => "foo-array.db",
919         type => DBM::Deep->TYPE_ARRAY
920     );
921
922     $db->[0] = "foo";
923     push @$db, "bar", "baz";
924     unshift @$db, "bah";
925
926     my $last_elem = pop @$db; # baz
927     my $first_elem = shift @$db; # bah
928     my $second_elem = $db->[1]; # bar
929
930     my $num_elements = scalar @$db;
931
932 =head1 OO INTERFACE
933
934 In addition to the I<tie()> interface, you can also use a standard OO interface
935 to manipulate all aspects of DBM::Deep databases.  Each type of object (hash or
936 array) has its own methods, but both types share the following common methods:
937 C<put()>, C<get()>, C<exists()>, C<delete()> and C<clear()>.
938
939 =over
940
941 =item * new() / clone()
942
943 These are the constructor and copy-functions.
944
945 =item * put() / store()
946
947 Stores a new hash key/value pair, or sets an array element value.  Takes two
948 arguments, the hash key or array index, and the new value.  The value can be
949 a scalar, hash ref or array ref.  Returns true on success, false on failure.
950
951     $db->put("foo", "bar"); # for hashes
952     $db->put(1, "bar"); # for arrays
953
954 =item * get() / fetch()
955
956 Fetches the value of a hash key or array element.  Takes one argument: the hash
957 key or array index.  Returns a scalar, hash ref or array ref, depending on the
958 data type stored.
959
960     my $value = $db->get("foo"); # for hashes
961     my $value = $db->get(1); # for arrays
962
963 =item * exists()
964
965 Checks if a hash key or array index exists.  Takes one argument: the hash key
966 or array index.  Returns true if it exists, false if not.
967
968     if ($db->exists("foo")) { print "yay!\n"; } # for hashes
969     if ($db->exists(1)) { print "yay!\n"; } # for arrays
970
971 =item * delete()
972
973 Deletes one hash key/value pair or array element.  Takes one argument: the hash
974 key or array index.  Returns true on success, false if not found.  For arrays,
975 the remaining elements located after the deleted element are NOT moved over.
976 The deleted element is essentially just undefined, which is exactly how Perl's
977 internal arrays work.  Please note that the space occupied by the deleted
978 key/value or element is B<not> reused again -- see L<UNUSED SPACE RECOVERY>
979 below for details and workarounds.
980
981     $db->delete("foo"); # for hashes
982     $db->delete(1); # for arrays
983
984 =item * clear()
985
986 Deletes B<all> hash keys or array elements.  Takes no arguments.  No return
987 value.  Please note that the space occupied by the deleted keys/values or
988 elements is B<not> reused again -- see L<UNUSED SPACE RECOVERY> below for
989 details and workarounds.
990
991     $db->clear(); # hashes or arrays
992
993 =item * lock() / unlock()
994
995 q.v. Locking.
996
997 =item * optimize()
998
999 Recover lost disk space.
1000
1001 =item * import() / export()
1002
1003 Data going in and out.
1004
1005 =back
1006
1007 =head2 HASHES
1008
1009 For hashes, DBM::Deep supports all the common methods described above, and the
1010 following additional methods: C<first_key()> and C<next_key()>.
1011
1012 =over
1013
1014 =item * first_key()
1015
1016 Returns the "first" key in the hash.  As with built-in Perl hashes, keys are
1017 fetched in an undefined order (which appears random).  Takes no arguments,
1018 returns the key as a scalar value.
1019
1020     my $key = $db->first_key();
1021
1022 =item * next_key()
1023
1024 Returns the "next" key in the hash, given the previous one as the sole argument.
1025 Returns undef if there are no more keys to be fetched.
1026
1027     $key = $db->next_key($key);
1028
1029 =back
1030
1031 Here are some examples of using hashes:
1032
1033     my $db = DBM::Deep->new( "foo.db" );
1034
1035     $db->put("foo", "bar");
1036     print "foo: " . $db->get("foo") . "\n";
1037
1038     $db->put("baz", {}); # new child hash ref
1039     $db->get("baz")->put("buz", "biz");
1040     print "buz: " . $db->get("baz")->get("buz") . "\n";
1041
1042     my $key = $db->first_key();
1043     while ($key) {
1044         print "$key: " . $db->get($key) . "\n";
1045         $key = $db->next_key($key);
1046     }
1047
1048     if ($db->exists("foo")) { $db->delete("foo"); }
1049
1050 =head2 ARRAYS
1051
1052 For arrays, DBM::Deep supports all the common methods described above, and the
1053 following additional methods: C<length()>, C<push()>, C<pop()>, C<shift()>,
1054 C<unshift()> and C<splice()>.
1055
1056 =over
1057
1058 =item * length()
1059
1060 Returns the number of elements in the array.  Takes no arguments.
1061
1062     my $len = $db->length();
1063
1064 =item * push()
1065
1066 Adds one or more elements onto the end of the array.  Accepts scalars, hash
1067 refs or array refs.  No return value.
1068
1069     $db->push("foo", "bar", {});
1070
1071 =item * pop()
1072
1073 Fetches the last element in the array, and deletes it.  Takes no arguments.
1074 Returns undef if array is empty.  Returns the element value.
1075
1076     my $elem = $db->pop();
1077
1078 =item * shift()
1079
1080 Fetches the first element in the array, deletes it, then shifts all the
1081 remaining elements over to take up the space.  Returns the element value.  This
1082 method is not recommended with large arrays -- see L<LARGE ARRAYS> below for
1083 details.
1084
1085     my $elem = $db->shift();
1086
1087 =item * unshift()
1088
1089 Inserts one or more elements onto the beginning of the array, shifting all
1090 existing elements over to make room.  Accepts scalars, hash refs or array refs.
1091 No return value.  This method is not recommended with large arrays -- see
1092 <LARGE ARRAYS> below for details.
1093
1094     $db->unshift("foo", "bar", {});
1095
1096 =item * splice()
1097
1098 Performs exactly like Perl's built-in function of the same name.  See L<perldoc
1099 -f splice> for usage -- it is too complicated to document here.  This method is
1100 not recommended with large arrays -- see L<LARGE ARRAYS> below for details.
1101
1102 =back
1103
1104 Here are some examples of using arrays:
1105
1106     my $db = DBM::Deep->new(
1107         file => "foo.db",
1108         type => DBM::Deep->TYPE_ARRAY
1109     );
1110
1111     $db->push("bar", "baz");
1112     $db->unshift("foo");
1113     $db->put(3, "buz");
1114
1115     my $len = $db->length();
1116     print "length: $len\n"; # 4
1117
1118     for (my $k=0; $k<$len; $k++) {
1119         print "$k: " . $db->get($k) . "\n";
1120     }
1121
1122     $db->splice(1, 2, "biz", "baf");
1123
1124     while (my $elem = shift @$db) {
1125         print "shifted: $elem\n";
1126     }
1127
1128 =head1 LOCKING
1129
1130 Enable automatic file locking by passing a true value to the C<locking>
1131 parameter when constructing your DBM::Deep object (see L<SETUP> above).
1132
1133     my $db = DBM::Deep->new(
1134         file => "foo.db",
1135         locking => 1
1136     );
1137
1138 This causes DBM::Deep to C<flock()> the underlying filehandle with exclusive
1139 mode for writes, and shared mode for reads.  This is required if you have
1140 multiple processes accessing the same database file, to avoid file corruption.
1141 Please note that C<flock()> does NOT work for files over NFS.  See L<DB OVER
1142 NFS> below for more.
1143
1144 =head2 EXPLICIT LOCKING
1145
1146 You can explicitly lock a database, so it remains locked for multiple
1147 transactions.  This is done by calling the C<lock()> method, and passing an
1148 optional lock mode argument (defaults to exclusive mode).  This is particularly
1149 useful for things like counters, where the current value needs to be fetched,
1150 then incremented, then stored again.
1151
1152     $db->lock();
1153     my $counter = $db->get("counter");
1154     $counter++;
1155     $db->put("counter", $counter);
1156     $db->unlock();
1157
1158     # or...
1159
1160     $db->lock();
1161     $db->{counter}++;
1162     $db->unlock();
1163
1164 You can pass C<lock()> an optional argument, which specifies which mode to use
1165 (exclusive or shared).  Use one of these two constants: C<DBM::Deep-E<gt>LOCK_EX>
1166 or C<DBM::Deep-E<gt>LOCK_SH>.  These are passed directly to C<flock()>, and are the
1167 same as the constants defined in Perl's C<Fcntl> module.
1168
1169     $db->lock( DBM::Deep->LOCK_SH );
1170     # something here
1171     $db->unlock();
1172
1173 =head1 IMPORTING/EXPORTING
1174
1175 You can import existing complex structures by calling the C<import()> method,
1176 and export an entire database into an in-memory structure using the C<export()>
1177 method.  Both are examined here.
1178
1179 =head2 IMPORTING
1180
1181 Say you have an existing hash with nested hashes/arrays inside it.  Instead of
1182 walking the structure and adding keys/elements to the database as you go,
1183 simply pass a reference to the C<import()> method.  This recursively adds
1184 everything to an existing DBM::Deep object for you.  Here is an example:
1185
1186     my $struct = {
1187         key1 => "value1",
1188         key2 => "value2",
1189         array1 => [ "elem0", "elem1", "elem2" ],
1190         hash1 => {
1191             subkey1 => "subvalue1",
1192             subkey2 => "subvalue2"
1193         }
1194     };
1195
1196     my $db = DBM::Deep->new( "foo.db" );
1197     $db->import( $struct );
1198
1199     print $db->{key1} . "\n"; # prints "value1"
1200
1201 This recursively imports the entire C<$struct> object into C<$db>, including
1202 all nested hashes and arrays.  If the DBM::Deep object contains exsiting data,
1203 keys are merged with the existing ones, replacing if they already exist.
1204 The C<import()> method can be called on any database level (not just the base
1205 level), and works with both hash and array DB types.
1206
1207 B<Note:> Make sure your existing structure has no circular references in it.
1208 These will cause an infinite loop when importing.
1209
1210 =head2 EXPORTING
1211
1212 Calling the C<export()> method on an existing DBM::Deep object will return
1213 a reference to a new in-memory copy of the database.  The export is done
1214 recursively, so all nested hashes/arrays are all exported to standard Perl
1215 objects.  Here is an example:
1216
1217     my $db = DBM::Deep->new( "foo.db" );
1218
1219     $db->{key1} = "value1";
1220     $db->{key2} = "value2";
1221     $db->{hash1} = {};
1222     $db->{hash1}->{subkey1} = "subvalue1";
1223     $db->{hash1}->{subkey2} = "subvalue2";
1224
1225     my $struct = $db->export();
1226
1227     print $struct->{key1} . "\n"; # prints "value1"
1228
1229 This makes a complete copy of the database in memory, and returns a reference
1230 to it.  The C<export()> method can be called on any database level (not just
1231 the base level), and works with both hash and array DB types.  Be careful of
1232 large databases -- you can store a lot more data in a DBM::Deep object than an
1233 in-memory Perl structure.
1234
1235 B<Note:> Make sure your database has no circular references in it.
1236 These will cause an infinite loop when exporting.
1237
1238 =head1 FILTERS
1239
1240 DBM::Deep has a number of hooks where you can specify your own Perl function
1241 to perform filtering on incoming or outgoing data.  This is a perfect
1242 way to extend the engine, and implement things like real-time compression or
1243 encryption.  Filtering applies to the base DB level, and all child hashes /
1244 arrays.  Filter hooks can be specified when your DBM::Deep object is first
1245 constructed, or by calling the C<set_filter()> method at any time.  There are
1246 four available filter hooks, described below:
1247
1248 =over
1249
1250 =item * filter_store_key
1251
1252 This filter is called whenever a hash key is stored.  It
1253 is passed the incoming key, and expected to return a transformed key.
1254
1255 =item * filter_store_value
1256
1257 This filter is called whenever a hash key or array element is stored.  It
1258 is passed the incoming value, and expected to return a transformed value.
1259
1260 =item * filter_fetch_key
1261
1262 This filter is called whenever a hash key is fetched (i.e. via
1263 C<first_key()> or C<next_key()>).  It is passed the transformed key,
1264 and expected to return the plain key.
1265
1266 =item * filter_fetch_value
1267
1268 This filter is called whenever a hash key or array element is fetched.
1269 It is passed the transformed value, and expected to return the plain value.
1270
1271 =back
1272
1273 Here are the two ways to setup a filter hook:
1274
1275     my $db = DBM::Deep->new(
1276         file => "foo.db",
1277         filter_store_value => \&my_filter_store,
1278         filter_fetch_value => \&my_filter_fetch
1279     );
1280
1281     # or...
1282
1283     $db->set_filter( "filter_store_value", \&my_filter_store );
1284     $db->set_filter( "filter_fetch_value", \&my_filter_fetch );
1285
1286 Your filter function will be called only when dealing with SCALAR keys or
1287 values.  When nested hashes and arrays are being stored/fetched, filtering
1288 is bypassed.  Filters are called as static functions, passed a single SCALAR
1289 argument, and expected to return a single SCALAR value.  If you want to
1290 remove a filter, set the function reference to C<undef>:
1291
1292     $db->set_filter( "filter_store_value", undef );
1293
1294 =head2 REAL-TIME ENCRYPTION EXAMPLE
1295
1296 Here is a working example that uses the I<Crypt::Blowfish> module to
1297 do real-time encryption / decryption of keys & values with DBM::Deep Filters.
1298 Please visit L<http://search.cpan.org/search?module=Crypt::Blowfish> for more
1299 on I<Crypt::Blowfish>.  You'll also need the I<Crypt::CBC> module.
1300
1301     use DBM::Deep;
1302     use Crypt::Blowfish;
1303     use Crypt::CBC;
1304
1305     my $cipher = Crypt::CBC->new({
1306         'key'             => 'my secret key',
1307         'cipher'          => 'Blowfish',
1308         'iv'              => '$KJh#(}q',
1309         'regenerate_key'  => 0,
1310         'padding'         => 'space',
1311         'prepend_iv'      => 0
1312     });
1313
1314     my $db = DBM::Deep->new(
1315         file => "foo-encrypt.db",
1316         filter_store_key => \&my_encrypt,
1317         filter_store_value => \&my_encrypt,
1318         filter_fetch_key => \&my_decrypt,
1319         filter_fetch_value => \&my_decrypt,
1320     );
1321
1322     $db->{key1} = "value1";
1323     $db->{key2} = "value2";
1324     print "key1: " . $db->{key1} . "\n";
1325     print "key2: " . $db->{key2} . "\n";
1326
1327     undef $db;
1328     exit;
1329
1330     sub my_encrypt {
1331         return $cipher->encrypt( $_[0] );
1332     }
1333     sub my_decrypt {
1334         return $cipher->decrypt( $_[0] );
1335     }
1336
1337 =head2 REAL-TIME COMPRESSION EXAMPLE
1338
1339 Here is a working example that uses the I<Compress::Zlib> module to do real-time
1340 compression / decompression of keys & values with DBM::Deep Filters.
1341 Please visit L<http://search.cpan.org/search?module=Compress::Zlib> for
1342 more on I<Compress::Zlib>.
1343
1344     use DBM::Deep;
1345     use Compress::Zlib;
1346
1347     my $db = DBM::Deep->new(
1348         file => "foo-compress.db",
1349         filter_store_key => \&my_compress,
1350         filter_store_value => \&my_compress,
1351         filter_fetch_key => \&my_decompress,
1352         filter_fetch_value => \&my_decompress,
1353     );
1354
1355     $db->{key1} = "value1";
1356     $db->{key2} = "value2";
1357     print "key1: " . $db->{key1} . "\n";
1358     print "key2: " . $db->{key2} . "\n";
1359
1360     undef $db;
1361     exit;
1362
1363     sub my_compress {
1364         return Compress::Zlib::memGzip( $_[0] ) ;
1365     }
1366     sub my_decompress {
1367         return Compress::Zlib::memGunzip( $_[0] ) ;
1368     }
1369
1370 B<Note:> Filtering of keys only applies to hashes.  Array "keys" are
1371 actually numerical index numbers, and are not filtered.
1372
1373 =head1 ERROR HANDLING
1374
1375 Most DBM::Deep methods return a true value for success, and call die() on
1376 failure.  You can wrap calls in an eval block to catch the die.
1377
1378     my $db = DBM::Deep->new( "foo.db" ); # create hash
1379     eval { $db->push("foo"); }; # ILLEGAL -- push is array-only call
1380
1381     print $@;           # prints error message
1382
1383 =head1 LARGEFILE SUPPORT
1384
1385 If you have a 64-bit system, and your Perl is compiled with both LARGEFILE
1386 and 64-bit support, you I<may> be able to create databases larger than 2 GB.
1387 DBM::Deep by default uses 32-bit file offset tags, but these can be changed
1388 by specifying the 'pack_size' parameter when constructing the file.
1389
1390     DBM::Deep->new(
1391         filename => $filename,
1392         pack_size => 'large',
1393     );
1394
1395 This tells DBM::Deep to pack all file offsets with 8-byte (64-bit) quad words
1396 instead of 32-bit longs.  After setting these values your DB files have a
1397 theoretical maximum size of 16 XB (exabytes).
1398
1399 You can also use C<pack_size =E<gt> 'small'> in order to use 16-bit file
1400 offsets.
1401
1402 B<Note:> Changing these values will B<NOT> work for existing database files.
1403 Only change this for new files. Once the value has been set, it is stored in
1404 the file's header and cannot be changed for the life of the file. These
1405 parameters are per-file, meaning you can access 32-bit and 64-bit files, as
1406 you chose.
1407
1408 B<Note:> We have not personally tested files larger than 2 GB -- all my
1409 systems have only a 32-bit Perl.  However, I have received user reports that
1410 this does indeed work!
1411
1412 =head1 LOW-LEVEL ACCESS
1413
1414 If you require low-level access to the underlying filehandle that DBM::Deep uses,
1415 you can call the C<_fh()> method, which returns the handle:
1416
1417     my $fh = $db->_fh();
1418
1419 This method can be called on the root level of the datbase, or any child
1420 hashes or arrays.  All levels share a I<root> structure, which contains things
1421 like the filehandle, a reference counter, and all the options specified
1422 when you created the object.  You can get access to this file object by
1423 calling the C<_fileobj()> method.
1424
1425     my $file_obj = $db->_fileobj();
1426
1427 This is useful for changing options after the object has already been created,
1428 such as enabling/disabling locking.  You can also store your own temporary user
1429 data in this structure (be wary of name collision), which is then accessible from
1430 any child hash or array.
1431
1432 =head1 CUSTOM DIGEST ALGORITHM
1433
1434 DBM::Deep by default uses the I<Message Digest 5> (MD5) algorithm for hashing
1435 keys.  However you can override this, and use another algorithm (such as SHA-256)
1436 or even write your own.  But please note that DBM::Deep currently expects zero
1437 collisions, so your algorithm has to be I<perfect>, so to speak. Collision
1438 detection may be introduced in a later version.
1439
1440 You can specify a custom digest algorithm by passing it into the parameter
1441 list for new(), passing a reference to a subroutine as the 'digest' parameter,
1442 and the length of the algorithm's hashes (in bytes) as the 'hash_size'
1443 parameter. Here is a working example that uses a 256-bit hash from the
1444 I<Digest::SHA256> module.  Please see
1445 L<http://search.cpan.org/search?module=Digest::SHA256> for more information.
1446
1447     use DBM::Deep;
1448     use Digest::SHA256;
1449
1450     my $context = Digest::SHA256::new(256);
1451
1452     my $db = DBM::Deep->new(
1453         filename => "foo-sha.db",
1454         digest => \&my_digest,
1455         hash_size => 32,
1456     );
1457
1458     $db->{key1} = "value1";
1459     $db->{key2} = "value2";
1460     print "key1: " . $db->{key1} . "\n";
1461     print "key2: " . $db->{key2} . "\n";
1462
1463     undef $db;
1464     exit;
1465
1466     sub my_digest {
1467         return substr( $context->hash($_[0]), 0, 32 );
1468     }
1469
1470 B<Note:> Your returned digest strings must be B<EXACTLY> the number
1471 of bytes you specify in the hash_size parameter (in this case 32).
1472
1473 B<Note:> If you do choose to use a custom digest algorithm, you must set it
1474 every time you access this file. Otherwise, the default (MD5) will be used.
1475
1476 =head1 CIRCULAR REFERENCES
1477
1478 DBM::Deep has B<experimental> support for circular references.  Meaning you
1479 can have a nested hash key or array element that points to a parent object.
1480 This relationship is stored in the DB file, and is preserved between sessions.
1481 Here is an example:
1482
1483     my $db = DBM::Deep->new( "foo.db" );
1484
1485     $db->{foo} = "bar";
1486     $db->{circle} = $db; # ref to self
1487
1488     print $db->{foo} . "\n"; # prints "bar"
1489     print $db->{circle}->{foo} . "\n"; # prints "bar" again
1490
1491 B<Note>: Passing the object to a function that recursively walks the
1492 object tree (such as I<Data::Dumper> or even the built-in C<optimize()> or
1493 C<export()> methods) will result in an infinite loop. This will be fixed in
1494 a future release.
1495
1496 =head1 CAVEATS / ISSUES / BUGS
1497
1498 This section describes all the known issues with DBM::Deep.  It you have found
1499 something that is not listed here, please send e-mail to L<jhuckaby@cpan.org>.
1500
1501 =head2 UNUSED SPACE RECOVERY
1502
1503 One major caveat with DBM::Deep is that space occupied by existing keys and
1504 values is not recovered when they are deleted.  Meaning if you keep deleting
1505 and adding new keys, your file will continuously grow.  I am working on this,
1506 but in the meantime you can call the built-in C<optimize()> method from time to
1507 time (perhaps in a crontab or something) to recover all your unused space.
1508
1509     $db->optimize(); # returns true on success
1510
1511 This rebuilds the ENTIRE database into a new file, then moves it on top of
1512 the original.  The new file will have no unused space, thus it will take up as
1513 little disk space as possible.  Please note that this operation can take
1514 a long time for large files, and you need enough disk space to temporarily hold
1515 2 copies of your DB file.  The temporary file is created in the same directory
1516 as the original, named with a ".tmp" extension, and is deleted when the
1517 operation completes.  Oh, and if locking is enabled, the DB is automatically
1518 locked for the entire duration of the copy.
1519
1520 B<WARNING:> Only call optimize() on the top-level node of the database, and
1521 make sure there are no child references lying around.  DBM::Deep keeps a reference
1522 counter, and if it is greater than 1, optimize() will abort and return undef.
1523
1524 =head2 REFERENCES
1525
1526 (The reasons given assume a high level of Perl understanding, specifically of
1527 references. You can safely skip this section.)
1528
1529 Currently, the only references supported are HASH and ARRAY. The other reference
1530 types (SCALAR, CODE, GLOB, and REF) cannot be supported for various reasons.
1531
1532 =over 4
1533
1534 =item * GLOB
1535
1536 These are things like filehandles and other sockets. They can't be supported
1537 because it's completely unclear how DBM::Deep should serialize them.
1538
1539 =item * SCALAR / REF
1540
1541 The discussion here refers to the following type of example:
1542
1543   my $x = 25;
1544   $db->{key1} = \$x;
1545
1546   $x = 50;
1547
1548   # In some other process ...
1549
1550   my $val = ${ $db->{key1} };
1551
1552   is( $val, 50, "What actually gets stored in the DB file?" );
1553
1554 The problem is one of synchronization. When the variable being referred to
1555 changes value, the reference isn't notified. This means that the new value won't
1556 be stored in the datafile for other processes to read. There is no TIEREF.
1557
1558 It is theoretically possible to store references to values already within a
1559 DBM::Deep object because everything already is synchronized, but the change to
1560 the internals would be quite large. Specifically, DBM::Deep would have to tie
1561 every single value that is stored. This would bloat the RAM footprint of
1562 DBM::Deep at least twofold (if not more) and be a significant performance drain,
1563 all to support a feature that has never been requested.
1564
1565 =item * CODE
1566
1567 L<http://search.cpan.org/search?module=Data::Dump::Streamer> provides a
1568 mechanism for serializing coderefs, including saving off all closure state.
1569 However, just as for SCALAR and REF, that closure state may change without
1570 notifying the DBM::Deep object storing the reference.
1571
1572 =back
1573
1574 =head2 FILE CORRUPTION
1575
1576 The current level of error handling in DBM::Deep is minimal.  Files I<are> checked
1577 for a 32-bit signature when opened, but other corruption in files can cause
1578 segmentation faults.  DBM::Deep may try to seek() past the end of a file, or get
1579 stuck in an infinite loop depending on the level of corruption.  File write
1580 operations are not checked for failure (for speed), so if you happen to run
1581 out of disk space, DBM::Deep will probably fail in a bad way.  These things will
1582 be addressed in a later version of DBM::Deep.
1583
1584 =head2 DB OVER NFS
1585
1586 Beware of using DB files over NFS.  DBM::Deep uses flock(), which works well on local
1587 filesystems, but will NOT protect you from file corruption over NFS.  I've heard
1588 about setting up your NFS server with a locking daemon, then using lockf() to
1589 lock your files, but your mileage may vary there as well.  From what I
1590 understand, there is no real way to do it.  However, if you need access to the
1591 underlying filehandle in DBM::Deep for using some other kind of locking scheme like
1592 lockf(), see the L<LOW-LEVEL ACCESS> section above.
1593
1594 =head2 COPYING OBJECTS
1595
1596 Beware of copying tied objects in Perl.  Very strange things can happen.
1597 Instead, use DBM::Deep's C<clone()> method which safely copies the object and
1598 returns a new, blessed, tied hash or array to the same level in the DB.
1599
1600     my $copy = $db->clone();
1601
1602 B<Note>: Since clone() here is cloning the object, not the database location, any
1603 modifications to either $db or $copy will be visible in both.
1604
1605 =head2 LARGE ARRAYS
1606
1607 Beware of using C<shift()>, C<unshift()> or C<splice()> with large arrays.
1608 These functions cause every element in the array to move, which can be murder
1609 on DBM::Deep, as every element has to be fetched from disk, then stored again in
1610 a different location.  This will be addressed in the forthcoming version 1.00.
1611
1612 =head2 WRITEONLY FILES
1613
1614 If you pass in a filehandle to new(), you may have opened it in either a readonly or
1615 writeonly mode. STORE will verify that the filehandle is writable. However, there
1616 doesn't seem to be a good way to determine if a filehandle is readable. And, if the
1617 filehandle isn't readable, it's not clear what will happen. So, don't do that.
1618
1619 =head1 PERFORMANCE
1620
1621 This section discusses DBM::Deep's speed and memory usage.
1622
1623 =head2 SPEED
1624
1625 Obviously, DBM::Deep isn't going to be as fast as some C-based DBMs, such as
1626 the almighty I<BerkeleyDB>.  But it makes up for it in features like true
1627 multi-level hash/array support, and cross-platform FTPable files.  Even so,
1628 DBM::Deep is still pretty fast, and the speed stays fairly consistent, even
1629 with huge databases.  Here is some test data:
1630
1631     Adding 1,000,000 keys to new DB file...
1632
1633     At 100 keys, avg. speed is 2,703 keys/sec
1634     At 200 keys, avg. speed is 2,642 keys/sec
1635     At 300 keys, avg. speed is 2,598 keys/sec
1636     At 400 keys, avg. speed is 2,578 keys/sec
1637     At 500 keys, avg. speed is 2,722 keys/sec
1638     At 600 keys, avg. speed is 2,628 keys/sec
1639     At 700 keys, avg. speed is 2,700 keys/sec
1640     At 800 keys, avg. speed is 2,607 keys/sec
1641     At 900 keys, avg. speed is 2,190 keys/sec
1642     At 1,000 keys, avg. speed is 2,570 keys/sec
1643     At 2,000 keys, avg. speed is 2,417 keys/sec
1644     At 3,000 keys, avg. speed is 1,982 keys/sec
1645     At 4,000 keys, avg. speed is 1,568 keys/sec
1646     At 5,000 keys, avg. speed is 1,533 keys/sec
1647     At 6,000 keys, avg. speed is 1,787 keys/sec
1648     At 7,000 keys, avg. speed is 1,977 keys/sec
1649     At 8,000 keys, avg. speed is 2,028 keys/sec
1650     At 9,000 keys, avg. speed is 2,077 keys/sec
1651     At 10,000 keys, avg. speed is 2,031 keys/sec
1652     At 20,000 keys, avg. speed is 1,970 keys/sec
1653     At 30,000 keys, avg. speed is 2,050 keys/sec
1654     At 40,000 keys, avg. speed is 2,073 keys/sec
1655     At 50,000 keys, avg. speed is 1,973 keys/sec
1656     At 60,000 keys, avg. speed is 1,914 keys/sec
1657     At 70,000 keys, avg. speed is 2,091 keys/sec
1658     At 80,000 keys, avg. speed is 2,103 keys/sec
1659     At 90,000 keys, avg. speed is 1,886 keys/sec
1660     At 100,000 keys, avg. speed is 1,970 keys/sec
1661     At 200,000 keys, avg. speed is 2,053 keys/sec
1662     At 300,000 keys, avg. speed is 1,697 keys/sec
1663     At 400,000 keys, avg. speed is 1,838 keys/sec
1664     At 500,000 keys, avg. speed is 1,941 keys/sec
1665     At 600,000 keys, avg. speed is 1,930 keys/sec
1666     At 700,000 keys, avg. speed is 1,735 keys/sec
1667     At 800,000 keys, avg. speed is 1,795 keys/sec
1668     At 900,000 keys, avg. speed is 1,221 keys/sec
1669     At 1,000,000 keys, avg. speed is 1,077 keys/sec
1670
1671 This test was performed on a PowerMac G4 1gHz running Mac OS X 10.3.2 & Perl
1672 5.8.1, with an 80GB Ultra ATA/100 HD spinning at 7200RPM.  The hash keys and
1673 values were between 6 - 12 chars in length.  The DB file ended up at 210MB.
1674 Run time was 12 min 3 sec.
1675
1676 =head2 MEMORY USAGE
1677
1678 One of the great things about DBM::Deep is that it uses very little memory.
1679 Even with huge databases (1,000,000+ keys) you will not see much increased
1680 memory on your process.  DBM::Deep relies solely on the filesystem for storing
1681 and fetching data.  Here is output from I</usr/bin/top> before even opening a
1682 database handle:
1683
1684       PID USER     PRI  NI  SIZE  RSS SHARE STAT %CPU %MEM   TIME COMMAND
1685     22831 root      11   0  2716 2716  1296 R     0.0  0.2   0:07 perl
1686
1687 Basically the process is taking 2,716K of memory.  And here is the same
1688 process after storing and fetching 1,000,000 keys:
1689
1690       PID USER     PRI  NI  SIZE  RSS SHARE STAT %CPU %MEM   TIME COMMAND
1691     22831 root      14   0  2772 2772  1328 R     0.0  0.2  13:32 perl
1692
1693 Notice the memory usage increased by only 56K.  Test was performed on a 700mHz
1694 x86 box running Linux RedHat 7.2 & Perl 5.6.1.
1695
1696 =head1 DB FILE FORMAT
1697
1698 In case you were interested in the underlying DB file format, it is documented
1699 here in this section.  You don't need to know this to use the module, it's just
1700 included for reference.
1701
1702 =head2 SIGNATURE
1703
1704 DBM::Deep files always start with a 32-bit signature to identify the file type.
1705 This is at offset 0.  The signature is "DPDB" in network byte order.  This is
1706 checked for when the file is opened and an error will be thrown if it's not found.
1707
1708 =head2 TAG
1709
1710 The DBM::Deep file is in a I<tagged format>, meaning each section of the file
1711 has a standard header containing the type of data, the length of data, and then
1712 the data itself.  The type is a single character (1 byte), the length is a
1713 32-bit unsigned long in network byte order, and the data is, well, the data.
1714 Here is how it unfolds:
1715
1716 =head2 MASTER INDEX
1717
1718 Immediately after the 32-bit file signature is the I<Master Index> record.
1719 This is a standard tag header followed by 1024 bytes (in 32-bit mode) or 2048
1720 bytes (in 64-bit mode) of data.  The type is I<H> for hash or I<A> for array,
1721 depending on how the DBM::Deep object was constructed.
1722
1723 The index works by looking at a I<MD5 Hash> of the hash key (or array index
1724 number).  The first 8-bit char of the MD5 signature is the offset into the
1725 index, multipled by 4 in 32-bit mode, or 8 in 64-bit mode.  The value of the
1726 index element is a file offset of the next tag for the key/element in question,
1727 which is usually a I<Bucket List> tag (see below).
1728
1729 The next tag I<could> be another index, depending on how many keys/elements
1730 exist.  See L<RE-INDEXING> below for details.
1731
1732 =head2 BUCKET LIST
1733
1734 A I<Bucket List> is a collection of 16 MD5 hashes for keys/elements, plus
1735 file offsets to where the actual data is stored.  It starts with a standard
1736 tag header, with type I<B>, and a data size of 320 bytes in 32-bit mode, or
1737 384 bytes in 64-bit mode.  Each MD5 hash is stored in full (16 bytes), plus
1738 the 32-bit or 64-bit file offset for the I<Bucket> containing the actual data.
1739 When the list fills up, a I<Re-Index> operation is performed (See
1740 L<RE-INDEXING> below).
1741
1742 =head2 BUCKET
1743
1744 A I<Bucket> is a tag containing a key/value pair (in hash mode), or a
1745 index/value pair (in array mode).  It starts with a standard tag header with
1746 type I<D> for scalar data (string, binary, etc.), or it could be a nested
1747 hash (type I<H>) or array (type I<A>).  The value comes just after the tag
1748 header.  The size reported in the tag header is only for the value, but then,
1749 just after the value is another size (32-bit unsigned long) and then the plain
1750 key itself.  Since the value is likely to be fetched more often than the plain
1751 key, I figured it would be I<slightly> faster to store the value first.
1752
1753 If the type is I<H> (hash) or I<A> (array), the value is another I<Master Index>
1754 record for the nested structure, where the process begins all over again.
1755
1756 =head2 RE-INDEXING
1757
1758 After a I<Bucket List> grows to 16 records, its allocated space in the file is
1759 exhausted.  Then, when another key/element comes in, the list is converted to a
1760 new index record.  However, this index will look at the next char in the MD5
1761 hash, and arrange new Bucket List pointers accordingly.  This process is called
1762 I<Re-Indexing>.  Basically, a new index tag is created at the file EOF, and all
1763 17 (16 + new one) keys/elements are removed from the old Bucket List and
1764 inserted into the new index.  Several new Bucket Lists are created in the
1765 process, as a new MD5 char from the key is being examined (it is unlikely that
1766 the keys will all share the same next char of their MD5s).
1767
1768 Because of the way the I<MD5> algorithm works, it is impossible to tell exactly
1769 when the Bucket Lists will turn into indexes, but the first round tends to
1770 happen right around 4,000 keys.  You will see a I<slight> decrease in
1771 performance here, but it picks back up pretty quick (see L<SPEED> above).  Then
1772 it takes B<a lot> more keys to exhaust the next level of Bucket Lists.  It's
1773 right around 900,000 keys.  This process can continue nearly indefinitely --
1774 right up until the point the I<MD5> signatures start colliding with each other,
1775 and this is B<EXTREMELY> rare -- like winning the lottery 5 times in a row AND
1776 getting struck by lightning while you are walking to cash in your tickets.
1777 Theoretically, since I<MD5> hashes are 128-bit values, you I<could> have up to
1778 340,282,366,921,000,000,000,000,000,000,000,000,000 keys/elements (I believe
1779 this is 340 unodecillion, but don't quote me).
1780
1781 =head2 STORING
1782
1783 When a new key/element is stored, the key (or index number) is first run through
1784 I<Digest::MD5> to get a 128-bit signature (example, in hex:
1785 b05783b0773d894396d475ced9d2f4f6).  Then, the I<Master Index> record is checked
1786 for the first char of the signature (in this case I<b0>).  If it does not exist,
1787 a new I<Bucket List> is created for our key (and the next 15 future keys that
1788 happen to also have I<b> as their first MD5 char).  The entire MD5 is written
1789 to the I<Bucket List> along with the offset of the new I<Bucket> record (EOF at
1790 this point, unless we are replacing an existing I<Bucket>), where the actual
1791 data will be stored.
1792
1793 =head2 FETCHING
1794
1795 Fetching an existing key/element involves getting a I<Digest::MD5> of the key
1796 (or index number), then walking along the indexes.  If there are enough
1797 keys/elements in this DB level, there might be nested indexes, each linked to
1798 a particular char of the MD5.  Finally, a I<Bucket List> is pointed to, which
1799 contains up to 16 full MD5 hashes.  Each is checked for equality to the key in
1800 question.  If we found a match, the I<Bucket> tag is loaded, where the value and
1801 plain key are stored.
1802
1803 Fetching the plain key occurs when calling the I<first_key()> and I<next_key()>
1804 methods.  In this process the indexes are walked systematically, and each key
1805 fetched in increasing MD5 order (which is why it appears random).   Once the
1806 I<Bucket> is found, the value is skipped and the plain key returned instead.
1807 B<Note:> Do not count on keys being fetched as if the MD5 hashes were
1808 alphabetically sorted.  This only happens on an index-level -- as soon as the
1809 I<Bucket Lists> are hit, the keys will come out in the order they went in --
1810 so it's pretty much undefined how the keys will come out -- just like Perl's
1811 built-in hashes.
1812
1813 =head1 CODE COVERAGE
1814
1815 We use B<Devel::Cover> to test the code coverage of our tests, below is the
1816 B<Devel::Cover> report on this module's test suite.
1817
1818   ----------------------------------- ------ ------ ------ ------ ------ ------
1819   File                                  stmt   bran   cond    sub   time  total
1820   ----------------------------------- ------ ------ ------ ------ ------ ------
1821   blib/lib/DBM/Deep.pm                  94.9   80.6   73.0  100.0   37.9   90.4
1822   blib/lib/DBM/Deep/Array.pm           100.0   91.1  100.0  100.0   18.2   98.1
1823   blib/lib/DBM/Deep/Engine.pm           98.9   87.3   80.0  100.0   34.2   95.2
1824   blib/lib/DBM/Deep/Hash.pm            100.0   87.5  100.0  100.0    9.7   97.3
1825   Total                                 97.9   85.9   79.7  100.0  100.0   94.3
1826   ----------------------------------- ------ ------ ------ ------ ------ ------
1827
1828 =head1 MORE INFORMATION
1829
1830 Check out the DBM::Deep Google Group at L<http://groups.google.com/group/DBM-Deep>
1831 or send email to L<DBM-Deep@googlegroups.com>.
1832
1833 =head1 AUTHORS
1834
1835 Joseph Huckaby, L<jhuckaby@cpan.org>
1836
1837 Rob Kinyon, L<rkinyon@cpan.org>
1838
1839 Special thanks to Adam Sah and Rich Gaushell!  You know why :-)
1840
1841 =head1 SEE ALSO
1842
1843 perltie(1), Tie::Hash(3), Digest::MD5(3), Fcntl(3), flock(2), lockf(3), nfs(5),
1844 Digest::SHA256(3), Crypt::Blowfish(3), Compress::Zlib(3)
1845
1846 =head1 LICENSE
1847
1848 Copyright (c) 2002-2006 Joseph Huckaby.  All Rights Reserved.
1849 This is free software, you may use it and distribute it under the
1850 same terms as Perl itself.
1851
1852 =cut