KiokuDB::Backend::Role::Scan - Root set iteration

Author

       Yuval Kogman <nothingmuch@woobling.org>

Copyright And License

       This software is copyright (c) 2014 by Yuval Kogman, Infinity Interactive.

       This  is  free  software;  you  can  redistribute  it and/or modify it under the same terms as the Perl 5
       programming language system itself.

perl v5.34.0                                       2022-05-23                  KiokuDB::Backend::Role::Scan(3pm)

Description

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

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

Name

       KiokuDB::Backend::Role::Scan - Root set iteration

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.

Required Methods

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

Synopsis

           with qw(KiokuDB::Backend::Role::Scan);

           sub all_entries {
               my $self = shift;

               # return all root set entries
               return Data::Stream::Bulk::Foo->new(...);
           }