- Storage::DBI now detects between the two DBDs
- (RT #51888) Applied POD patch (Thanks, FWIE!)
- (RT #44981) Added VERSION to ::Array, ::Engine, and ::Hash
+ - Removed extraneous slashes from POD links (Thanks ilmari!)
1.0019_001 Dec 31 22:00:00 2009 EST
(This is the first developer release for 1.0020.)
=head1 PURPOSE
-This is an internal-use-only object for L<DBM::Deep/>. It mediates the low-level
-mapping between the L<DBM::Deep/> objects and the storage medium.
+This is an internal-use-only object for L<DBM::Deep>. It mediates the low-level
+mapping between the L<DBM::Deep> objects and the storage medium.
The purpose of this documentation is to provide low-level documentation for
developers. It is B<not> intended to be used by the general public. This
=head2 write_value( $obj, $key, $value )
This takes an object that provides _base_offset(), a string for the
-key, and a value. This value can be anything storable within L<DBM::Deep/>.
+key, and a value. This value can be anything storable within L<DBM::Deep>.
This returns 1 upon success.
=head1 PURPOSE
-This is the engine for use with L<DBM::Deep::Storage::File/>.
+This is the engine for use with L<DBM::Deep::Storage::File>.
=head1 EXTERNAL METHODS
=head1 PURPOSE
-This is an internal-use-only object for L<DBM::Deep/>. It is the iterator
+This is an internal-use-only object for L<DBM::Deep>. It is the iterator
for FIRSTKEY() and NEXTKEY().
=head1 OVERVIEW
=over 4
-=item * engine (of type L<DBM::Deep::Engine/>
+=item * engine (of type L<DBM::Deep::Engine>
=item * base_offset (the base_offset of the invoking DBM::Deep object)
=head1 PURPOSE
-This is an internal-use-only object for L<DBM::Deep/>. It acts as the mediator
-between the L<DBM::Deep::Iterator/> object and a L<DBM::Deep::Engine::Sector::BucketList/>
+This is an internal-use-only object for L<DBM::Deep>. It acts as the mediator
+between the L<DBM::Deep::Iterator> object and a L<DBM::Deep::Engine::Sector::BucketList>
sector.
=head1 OVERVIEW
This object, despite the implied class hiearchy, does B<NOT> inherit from
-L<DBM::Deep::Iterator/>. Instead, it delegates to it, essentially acting as a
+L<DBM::Deep::Iterator>. Instead, it delegates to it, essentially acting as a
facade over it. L<DBM::Deep::Iterator/get_next_key> will instantiate one of
these objects as needed to handle an BucketList sector.
=over 4
-=item * iterator (of type L<DBM::Deep::Iterator/>
+=item * iterator (of type L<DBM::Deep::Iterator>
-=item * sector (of type L<DBM::Deep::Engine::Sector::BucketList/>
+=item * sector (of type L<DBM::Deep::Engine::Sector::BucketList>
=back
=head1 PURPOSE
-This is an internal-use-only object for L<DBM::Deep/>. It acts as the mediator
-between the L<DBM::Deep::Iterator/> object and a L<DBM::Deep::Engine::Sector::Index/>
+This is an internal-use-only object for L<DBM::Deep>. It acts as the mediator
+between the L<DBM::Deep::Iterator> object and a L<DBM::Deep::Engine::Sector::Index>
sector.
=head1 OVERVIEW
This object, despite the implied class hiearchy, does B<NOT> inherit from
-L<DBM::Deep::Iterator/>. Instead, it delegates to it, essentially acting as a
+L<DBM::Deep::Iterator>. Instead, it delegates to it, essentially acting as a
facade over it. L<DBM::Deep::Iterator/get_next_key> will instantiate one of
these objects as needed to handle an Index sector.
=over 4
-=item * iterator (of type L<DBM::Deep::Iterator/>
+=item * iterator (of type L<DBM::Deep::Iterator>
-=item * sector (of type L<DBM::Deep::Engine::Sector::Index/>
+=item * sector (of type L<DBM::Deep::Engine::Sector::Index>
=back
=head1 PURPOSE
-This is an internal-use-only object for L<DBM::Deep/>. It acts as a NULL object
-in the same vein as MARCEL's L<Class::Null/>. I couldn't use L<Class::Null/>
+This is an internal-use-only object for L<DBM::Deep>. It acts as a NULL object
+in the same vein as MARCEL's L<Class::Null>. I couldn't use L<Class::Null>
because DBM::Deep needed an object that always evaluated as undef, not an
implementation of the Null Class pattern.
The API for that is unclear right now.
The following methods manage the locking status. In all cases, they take
-a L<DBM::Deep/> object and returns nothing.
+a L<DBM::Deep> object and returns nothing.
=over 4
=head1 PURPOSE
-This is an internal-use-only object for L<DBM::Deep/>. It mediates the low-level
+This is an internal-use-only object for L<DBM::Deep>. It mediates the low-level
interaction with the storage mechanism.
Currently, the only storage mechanism supported is the file system.