tangram::type::dump::perl(3pm) [debian man page]

Tangram::Type::Dump::Perl(3pm)				User Contributed Perl Documentation			    Tangram::Type::Dump::Perl(3pm)

NAME

       Tangram::Type::Dump::Perl - map any Perl object as scalar dump

SYNOPSIS

	  use Tangram::Core;
	  use Tangram::Type::Dump::Perl; # always

	  $schema = Tangram::Schema->new(
	     classes => { NaturalPerson => { fields => {

	     perl_dump =>
	     {
		diary => # diary is a perl hash
		{
		   col => 'diarydata',
		   sql => 'TEXT',
		   indent => 0,
		   terse => 1,
		   purity => 0
		},

		lucky_numbers => 'int', # use defaults
	     }

DESCRIPTION

       Maps arbitrary Perl data structures by serializing to a string representation. The persistent fields are grouped in a hash under the
       "perl_dump" key in the field hash.

       Serialization is done by Data::Dumper, which traverses the Perl data structure and creates a string representation of it. The resulting
       string will be mapped to the DBMS as a scalar value. During restore, the scalar value will be eval'd to reconstruct the original data
       structure.

       As of Tangram 2.07.1, persistent references are safely handled via the Tangram::Type::Dump utility class.

       The field names are passed in a hash that associates a field name with a field descriptor. The field descriptor may be either a hash or a
       string. The hash uses the following fields:

       * col
       * sql
       * indent
       * terse
       * purity

       The optional fields "col" and "sql" specify the column name and the column type for the scalar value in the database. If not present, "col"
       defaults to the field name and "sql" defaults to VARCHAR(255).  Values will be always quoted as they are passed to the database.

       The remaining optional fields control the serialization process. They will be passed down to Data::Dumper as values to the corresponding
       Data::Dumper options. The default settings are: no indentation ("indent=0"), compact format ("terse=1"), and quick dump ("purity=0").

AUTHOR

       This mapping was contributed by Gabor Herr <herr@iti.informatik.tu-darmstadt.de>

perl v5.8.8							    2006-03-29					    Tangram::Type::Dump::Perl(3pm)

Tangram::Type::Set::FromMany(3pm)			User Contributed Perl Documentation			 Tangram::Type::Set::FromMany(3pm)

NAME

       Tangram::Type::Set::FromMany - maps Set::Object using a link table

SYNOPSIS

	  use Tangram;

	  # or
	  use Tangram::Core;
	  use Tangram::Type::Set::FromMany;

	  $schema = Tangram::Schema->new(

	     classes => { Company => { fields => {

	     set =>
	     {
		# long form
		employee =>
		{
		   class => 'Person',
		   table => 'Company_employees',
		   coll => 'company',
		   item => 'employee',
		},

		# short form
		assets => 'Asset',
	     }

DESCRIPTION

       Maps a reference to a Set::Object. The persistent fields are grouped in a hash under the "set" key in the field hash.

       The set may contain only objects of persistent classes. These classes must have a common persistent base class.

       Tangram uses a link table to save the state of the collection. The table has two columns: one contains the id of the container objects; the
       other contains the ids of the elements.

       The field names are passed in a hash that associates a field name with a field descriptor. The field descriptor may be either a hash or a
       string. The hash uses the following fields:

       * class
       * aggreg
       * table
       * coll
       * item
       * deep_update

       Mandatory field "class" specifies the class of the elements.

       Optional field "aggreg" specifies that the elements of the collection must be removed (erased) from persistent storage along with the con-
       taining object. The default is not to aggregate.

       Optional field "table" sets the name of the link table. This defaults to 'C_F', where C is the class of the containing object and F is the
       field name.

       Optional field "coll" sets the name the column containing the ids of the containing objects. This defaults to 'coll'.

       Optional field "item" sets the name the column containing the ids of the elements. This defaults to 'item'.

       Optional field "deep_update" specificies that all elements have to be updated automatically when "update" is called on the collection
       object. Automatic update ensures consisitency between the Perl representation and the DBMS state, but degrades update performance so use it
       with caution. The default is not to do automatic updates.

       If the descriptor is a string, it is interpreted as the name of the element's class. This is equivalent to specifying only the "class"
       field in the hash variant.

perl v5.8.8							    2006-03-29					 Tangram::Type::Set::FromMany(3pm)