debian man page for kiokudb::backend::role::scan

KiokuDB::Backend::Role::Scan(3pm)			User Contributed Perl Documentation			 KiokuDB::Backend::Role::Scan(3pm)

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

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

	   sub all_entries {
	       my $self = shift;

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

DESCRIPTION
       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.

perl v5.12.4							    2010-10-11					 KiokuDB::Backend::Role::Scan(3pm)