KiokuDB::Backend::Role::Scan(3pm)

KiokuDB::Backend::Role::Scan3pm

Root set iteration

Usage

    with qw(KiokuDB::Backend::Role::Scan);
    sub all_entries {
        my $self = shift;
        # return all root set entries
        return Data::Stream::Bulk::Foo->new(...);
    }

Version

version 0.57

Overview

This is a role for iterative scanning of all entries in a backend.

It is used for database backups, and various other tasks.

Required methods

all_entries

Should return a Data::Stream::Bulk stream enumerating all entries in the database.

Optional methods

These method have default implementations defined in terms of "all_entries" but maybe overridden if there is a more optimal solution than just filtering that stream.

root_entries

Should return a Data::Stream::Bulk of just the root entries.

child_entries

Should return a Data::Stream::Bulk of everything but the root entries.

Releases

6 releases since Debian 7 (Wheezy); the text changed 2 times.

  1. 7
  2. 8–10
  3. 12–13

Author

Yuval Kogman <[email protected]>

From libkiokudb-perl 0.57-3 in Debian 13 (Trixie). Parsed by carta from the page's man source.