kiokudb::backend::serialize::yaml(3pm) [debian man page]

KiokuDB::Backend::Serialize::YAML(3pm)			User Contributed Perl Documentation		    KiokuDB::Backend::Serialize::YAML(3pm)

NAME

       KiokuDB::Backend::Serialize::YAML - YAML::XS based serialization of KiokuDB::Entry objects.

SYNOPSIS

	   package MyBackend;
	   use Moose;

	   with qw(KiokuDB::Backend::Serialize::YAML);

DESCRIPTION

       KiokuDB::Backend::Serialize::Delegate is preferred to using this directly.

METHODS

       serialize $entry
	   Calls YAML::XS::Dump

       deserialize $str
	   Calls YAML::XS::Load

       serialize_to_stream $fh, $entry
	   Serializes the entry and prints to the file handle.

       deserialize_from_stream $fh
	   Reads until a YAML document boundry is reached, and then deserializes the current buffer.

perl v5.12.4							    2010-10-11				    KiokuDB::Backend::Serialize::YAML(3pm)

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

NAME

       KiokuDB::Util - Utility functions for working with KiokuDB

SYNOPSIS

	   use KiokuDB::Util qw(set weak_set);

	   my $set = set(@objects); # create a transient set

	   my $weak = weak_set(@objects); # to avoid circular refs

DESCRIPTION

       This module provides various helper functions for working with KiokuDB.

EXPORTS

       dsn_to_backend $dsn, %args
	   Tries to parse $dsn, load the backend and invoke "new" on it.

	   Used by "connect" in KiokuDB and the various command line interfaces.

       set
       weak_set
	   Instantiate a Set::Object or Set::Object::Weak from the arguments, and then creates a KiokuDB::Set::Transient with the result.

       import_yaml $kiokudb, @files_or_dirs
	   Loads YAML files with MooseX::YAML (if given a directory it will be searched recursively for files with a ".yml" extension are) into
	   the specified KiokuDB directory in a single transaction.

	   The YAML files can contain multiple documents, with each document treated as an object. If the YAML file contains a single non blessed
	   array or hash then that structure will be dereferenced as part of the arguments to "insert".

	   Here is an example of an array of objects, and a custom tag alias to ease authoring of the YAML file:

	       %YAML 1.1
	       %TAG ! !MyFoo::
	       ---
	       - !User
		 id:	    foo
		 real_name: Foo Bar
		 email:     foo@myfoo.com
		 password:  '{cleartext}test123'

	   You can use a hash to specify custom IDs:

	       %YAML 1.1
	       ---
	       the_id: !Some::Class
		   attr: moose

perl v5.12.4							    2010-12-19							KiokuDB::Util(3pm)