package Catmandu::Store;
use namespace::clean;
use Catmandu::Sane;
use Hash::Util::FieldHash ();
use Sub::Quote qw(quote_sub);
use Moo::Role;
with 'Catmandu::Logger';
has bag_class => (
is => 'ro',
default => sub { ref($_[0]).'::Bag' },
);
has default_bag => (
is => 'ro',
default => sub { 'data' },
);
has bags => (
is => 'ro',
default => sub { +{} },
);
{
Hash::Util::FieldHash::fieldhash my %bag_instances;
sub bag {
my $self = shift;
my $name = shift // $self->default_bag;
$bag_instances{$self}{$name} ||= do {
my $pkg = $self->bag_class;
if (my $options = $self->bags->{$name}) {
$options = {%$options};
if (my $plugins = delete $options->{plugins}) {
$pkg = $pkg->with_plugins($plugins);
}
$pkg->new(%$options, store => $self, name => $name);
} else {
$pkg->new(store => $self, name => $name);
}
};
}
}
# forward methods to default bag
{
my $pkg = __PACKAGE__;
my @delegate = (
# Catmandu::Iterable methods
qw(to_array count slice each tap any many all map reduce first rest take
pluck invoke contains includes group interleave max min benchmark),
# Catmandu::Addable methods
qw(add add_many commit),
# Catmandu::Bag methods
qw(get delete delete_all get_or_add to_hash),
);
for my $sub (@delegate) {
quote_sub("${pkg}::${sub}",
"my \$self = shift; \$self->bag->${sub}(\@_)");
}
}
1;
=head1 NAME
Catmandu::Store - Namespace for packages that can make data persistent
=head1 SYNOPSIS
use Catmandu::Store::DBI;
my $store = Catmandu::Store::DBI->new(data_source => 'DBI:mysql:database=test');
my $obj1 = $store->bag->add({ name => 'Patrick' });
printf "obj1 stored as %s\n" , $obj1->{_id};
# Force an id in the store
my $obj2 = $store->bag->add({ _id => 'test123' , name => 'Nicolas' });
my $obj3 = $store->bag->get('test123');
$store->bag->delete('test123');
$store->bag->delete_all;
# Some stores can be searched
my $hits = $store->bag->search(query => 'name:Patrick');
=head1 DESCRIPTION
A Catmandu::Store is a stub for Perl packages that can store data into
databases or search engines. The database as a whole is called a 'store'.
Databases also have compartments (e.g. tables) called L<Catmandu::Bag>-s.
Some stores can be searched using L<Catmandu::Searchable> methods.
=head1 METHODS
=head2 new(%store_args, bag_class => $class, default_bag => $name, bags => { $bagname => \%bag_args })
Create a new Catmandu::Store. Optionally provide the class name of a sub-class of
L<Catmandu::Bag>, and the name of the default bag ('data'). Startup parameters can be
provided for each $bagname using the 'bags' parameter. E.g.
my $store = Catmandu::Store::Hash->new(
bags => {myBag => {plugins => ['Datestamps']}});
# $store->bag('myBag') will now contain Datestamps
my $bag_class = "Catmandu::Store::Hash::Bag"
my $store = Catmandu::Store::Hash->new(
bag_class => $bag_class->with_plugins('Datestamps')
);
# All $store->bag(...)'s will now contain Datestamps
=head2 bag($name)
Create or retieve a bag with name $name. Returns a L<Catmandu::Bag>.
=head2 log
Return the current logger. Can be used when creating your own Stores.
E.g.
package Catmandu::Store::Hash;
...
sub generator {
my ($self) = @_;
$self->log->debug("generating record");
...
}
See also: L<Catmandu> for activating the logger in your main code.
=head1 SEE ALSO
L<Catmandu::Bag>, L<Catmandu::Searchable>
=cut