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

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

NAME

       KiokuDB::Set - Set::Object wrapper for KiokuDB with lazy loading.

SYNOPSIS

	   use KiokuDB::Util qw(set);

	   my $set = set(); # KiokuDB::Set::Transient

	   $set->insert($object);

	   warn $set->size;

	   my $id = $dir->store( $set );

DESCRIPTION

       This role defines the API implemented by KiokuDB::Set::Transient, KiokuDB::Set::Deferred, and KiokuDB::Set::Loaded.

       These three classes are modeled after Set::Object, but have implementation details specific to KiokuDB.

   Transient Sets
       Transient sets are in memory, they are sets that have been constructed by the user for subsequent insertion into storage.

       When you create a new set, this is what you should use.

       KiokuDB::Util provides convenience functions ("set" in KiokuDB::Util and "weak_set" in KiokuDB::Util) to construct transient sets
       concisely.

   Deferred Sets
       When a set is loaded from the backend, it is deferred by default. This means that the objects inside the set are not yet loaded, and will
       be fetched only as needed.

       When set members are needed, the set is upgraded in place into a KiokuDB::Set::Loaded object.

   Loaded Sets
       This is the result of vivifying the members of a deferred set, and is similar to transient sets in implementation.

perl v5.12.4							    2011-06-27							 KiokuDB::Set(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)