MongoDBx::KeyValue - Use MongoDB as if it were a key-value store.
my $mkv = MongoDBx::KeyValue->new(kvdb => 'my_key_value_database', %opts);
# 'kvdb' is required, other options are passed to MongoDB::Connection->new()
$mkv->set('cache', 'index.html', 'IndexIndex');
my $index = $mkv->get('cache', 'index.html');
print $index; # prints 'IndexIndex'
MongoDBx::KeyValue is a very simple module for easy using of MongoDB as
a key-value store (similar to Redis, Riak or Memcached).
The interface is very simple. You can get the value of a key from a
certain bucket by using the "get()" method. A bucket is really just a
MongoDB collection. This terminology is used just for resemblance to the
Riak terminology. Setting the value for a key is similarly easy, by
providing the "set()" method with the name of the bucket, the key, and
its value. If the key already exists in the bucket, its value will be
The value for a key can be anything that MongoDB supports, including
simple scalars (strings, numbers, etc.), hash or array references, or
whatever else MongoDB supports such as DateTime objects. While no
checking is made for keys, you probably should only use scalars for the
key. For every key-value document stored in the database, the key is
saved as the "_id" attribute, while the value is saved in the "value"
new( %opts )
Creates a new instance of this module and connects to the MongoDB
server. The only required option is 'kvdb', which should hold the name
of the database to use for the key-value store. All other options will
be passed to "MongoDB::Connection-"new>, so take a look at "ATTRIBUTES"
in MongoDB::Connection for a list of all supported options.
get( $bucket, $key )
Attempts to find the value for the key $key in the bucket named $bucket.
Returns "undef" if not found.
set( $bucket, $key, $value )
Sets the value for the key named $key inside the bucket named $bucket.
If the key already exists, its valu will be replaced with the new one.
It's probably better for keys to be scalars, but values can be anything,
including hash-refs, array-refs and whatever MongoDB can store natively.
Returns the MongoDB::Database object of the key-value store.
bucket( $bucket_name )
All this really does is return a MongoDB::Collection object for the
collection named $bucket_name. Use it if you need MongoDB collection
objects for some reason.
This module generates the following errors:
* "You must provide the name of the key-value database to use (as
parameter 'kvdb')." - This error will be issued by the new() method
if you don't provide it with the 'kvdb' parameter, which should hold
the name of the database to use as the key-value store.
This module only depends on MongoDB.
BUGS AND LIMITATIONS
No bugs have been reported.
Please report any bugs or feature requests to
"bug-MongoDBx-KeyValue@rt.cpan.org", or through the web interface at
LICENSE AND COPYRIGHT
Copyright (c) 2011, Ido Perlmuter "ido at ido50 dot net".
This module is free software; you can redistribute it and/or modify it
under the same terms as Perl itself, either version 5.8.1 or any later
version. See perlartistic and perlgpl.
The full text of the license can be found in the LICENSE file included
with this module.
DISCLAIMER OF WARRANTY
BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE LIABLE
TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH