DOKK / manpages / debian 12 / libcatmandu-perl / Catmandu::Bag.3pm.en
Catmandu::Bag(3pm) User Contributed Perl Documentation Catmandu::Bag(3pm)

Catmandu::Bag - A Catmandu::Store compartment to persist data

    my $store = Catmandu::Store::DBI->new(data_source => 'DBI:mysql:database=test');
    my $store = Catmandu::Store::DBI->new(
            data_source => 'DBI:mysql:database=test',
            bags => { journals => {
                            fix => [ ... ] ,
                            autocommit => 1 ,
                            plugins => [ ... ] ,
                            id_generator => Catmandu::IdGenerator::UUID->new ,
                      }
                    },
            bag_class => Catmandu::Bag->with_plugins('Datestamps')
            );
    # Use the default bag...
    my $bag = $store->bag;
    # Or a named bag...
    my $bag = $store->bag('journals');
    # Every bag is an iterator...
    $bag->each(sub { ... });
    $bag->take(10)->each(sub { ... });
    $bag->add($hash);
    $bag->add_many($iterator);
    $bag->add_many([ $hash, $hash , ...]);
    # Commit changes...
    $bag->commit;
    if ($bag->exists($id)) {
        # ...
    }
    my $obj = $bag->get($id);
    $bag->delete($id);
    $bag->delete_all;

Contains an array of fixes (or Fix files) to be applied before importing data into the bag.
An array of Catmandu::Pluggable to apply to the bag items.
When set to a true value an commit automatically gets executed when the bag goes out of scope.
A Catmandu::IdGenerator or name of an IdGenerator class. By default Catmandu::IdGenerator::UUID is used.
Use a custom key to hold id's in this bag. See Catmandu::Store for the default or store wide value. Also aliased as "id_field".

Add a hash to the bag or updates an existing hash by using its '_id' key. Returns the stored hash on success or undef on failure.

Add or update one or more items to the bag.

Retrieves the item with identifier $id from the bag.

Returns 1 if the item with identifier $id exists in the bag.

Retrieves the item with identifier $id from the store or adds $hash with _id $id if it's not found.

Deletes the item with $id from the bag.

Clear the bag.

Add the current datetime to each record.

    $bag->touch('date_updated', 'iso_date_time');

See Catmandu::Util::now for possible format values.

Commit changes.

Return the current logger.

Plugins are a kind of fixes that should be available for each bag. E.g. the Datestamps plugin will automatically store into each bag item the fields 'date_updated' and 'date_created'. The with_plugins accept one or an array of plugin classnames and returns a subclass of the Bag with the plugin methods implemented.

Catmandu::Iterable, Catmandu::Searchable, Catmandu::Fix, Catmandu::Pluggable

2023-03-03 perl v5.36.0