KiokuDB::Role::API - Role for L<KiokuDB> api (used to setup delegations).


KiokuDB documentation Contained in the KiokuDB distribution.

Index


Code Index:

NAME

Top

KiokuDB::Role::API - Role for KiokuDB api (used to setup delegations).

SYNOPSIS

Top

    has directory => (
        isa => "KiokuDB",
        handles => "KiokuDB::Role::API",
    );

DESCRIPTION

Top

This role provides requires declarations for the runtime methods of KiokuDB. This is useful for setting up delegations.

This is used in e.g. KiokuX::User.

METHODS

Top

new_scope
txn_do
lookup
exists
store
insert
update
deep_update
delete
is_root
set_root
unset_root
all_objects
root_set
grep
scan
clear_live_objects
new_scope
object_to_id
objects_to_ids
id_to_object
ids_to_objects
live_objects
directory

The directory method should be used to fetch the actual KiokuDB delegate. This will work no matter how deeply it is nested.


KiokuDB documentation Contained in the KiokuDB distribution.

package KiokuDB::Role::API;
use Moose::Role;

use namespace::clean -except => 'meta';

requires qw(
    new_scope
    txn_do
    scoped_txn

    lookup

    exists

    store store_nonroot

    insert insert_nonroot
    update
    deep_update

    delete

    is_root

    set_root
    unset_root

    search

    all_objects
    root_set

    grep
    scan

    clear_live_objects

    new_scope

    object_to_id
    objects_to_ids

    id_to_object
    ids_to_objects

    live_objects

    directory
);

__PACKAGE__

__END__