kiokudb::entry(3pm) [debian man page]

KiokuDB::Entry(3pm)					User Contributed Perl Documentation				       KiokuDB::Entry(3pm)

NAME

       KiokuDB::Entry - An entry in the database

SYNOPSIS

	   KiokuDB::Entry->new(
	       id => ...,
	       data => ...
	   );

DESCRIPTION

       This object provides the meta data for a single storage entry.

ATTRIBUTES

       id  The UUID for the entry.

	   If there is no ID then the entry is intrinsic.

       root
	   Whether or not this is a member of the root set (not subject to garbage collection, because storage was explicitly requested).

       data
	   A simplified data structure modeling this object/reference. This is a tree, not a graph, and has no shared data (JSON compliant). All
	   references are symbolic, using a KiokuDB::Reference object with UIDs as the address space.

       class
	   If the entry is blessed, this contains the class of that object.

	   In the future this might be a complex structure for anonymous classes, e.g. the class and the runtime roles.

       class_meta
	   Optional information such as runtime roles to be applied to the object is stored in this hashref.

       tied
	   One of "HASH", "ARRAY", "SCALAR" or "GLOB".

	   "data" is assumed to be a reference or an intrinsic entry for the object driving the tied structure (e.g. the "tied(%hash)").

       prev
	   Contains a link to a KiokuDB::Entry objects that precedes this one.

	   The last entry that was loaded from the store, or successfully written to the store for a given UUID is kept in the live object set.

	   The collapser creates transient Entry objects, which if written to the store successfully replace the previous one.

       backend_data
	   Backends can use this to store additional meta data as they see fit.

	   For instance, this is used in the CouchDB backend to track entry revisions for the opportunistic locking, and in
	   KiokuDB::Backend::BDB::GIN to to store extracted keys.

       deleted
	   Used for marking entries for deletion.

	   Deletion entries can be generated using the "deletion_entry" method, which creates a new derived entry with no data but retaining the
	   ID.

perl v5.12.4							    2010-10-11						       KiokuDB::Entry(3pm)

Check Out this Related Man Page

KiokuDB::TypeMap::Entry::Callback(3pm)			User Contributed Perl Documentation		    KiokuDB::TypeMap::Entry::Callback(3pm)

NAME

       KiokuDB::TypeMap::Entry::Callback - Callback based inflation/deflation of objects

SYNOPSIS

	   KiokuDB::TypeMap->new(
	       entries => {
		   'My::Class' => KiokuDB::TypeMap::Entry::Callback->new(
		       expand => "new", # My::Class->new(%$self)
		       collapse => sub {
			   my $self = shift;
			   return %$self; # provide args to 'new' in this example
		       },
		       id => sub { "foo" }, # 'id' callback is optional
		   ),
	       },
	   );

DESCRIPTION

       This KiokuDB::TypeMap entry provides callback based inflation/deflation.

       The major limitation of this method is that it cannot be used for self referential structures. This is because the object being inflated is
       only constructed after all of its arguments are.

       For the overwhelming majority of the use cases this is good enough though.

ATTRIBUTES

       collapse
	   A method name or code reference invoked on the object during collapsing.

	   This is evaluated in list context, and the list of values it returns will be collapsed by the KiokuDB::Collapser and then stored.

       expand
	   A method name or code reference invoked on the class of the object during loading.

	   The arguments are as returned by the "collapse" callback.

       id  An optional method name or code reference invoked to get an ID for the object.

	   If one is not provided the default (UUID based) generation is used.

       intrinsic
	   A boolean denoting whether or not the object should be collapsed with no ID, and serialized as part of its parent object.

	   This is useful for value like objects, for whom the reference address makes no difference (such as URI objects).

perl v5.12.4							    2010-10-11				    KiokuDB::TypeMap::Entry::Callback(3pm)

Linux and UNIX Man Pages

kiokudb::entry(3pm) [debian man page]

Check Out this Related Man Page