Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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

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

NAME

       Tangram::Type::Scalar - map scalar fields

SYNOPSIS

	  use Tangram;

	  Tangram::Schema->new(
	     classes => { NaturalPerson => { fields => {
		string => [ qw( name firstName gender ) ],
		int => [ qw( age ) ],
		real => [ qw( height weight ) ],

	  $schema = Tangram::Schema->new(
	     classes => { NaturalPerson => { fields => {
		string =>
		{
		   name    => { sql => 'VARCHAR(100)' },

		   1stname => {
		      col => 'firstName',
		      sql => 'VARCHAR(100) NULL' },

		   gender    => undef()
		},

DESCRIPTION

       Classes Tangram::Type::String, ::Int and ::Real and ::Ref are responsible for mapping the various subtypes of scalars. The first three map-
       pings are documented here since they differ very little. See Tangram::Type::Ref::FromMany for information on mapping references.

       Tangram::Type::String uses DBI's quote() method to quote strings if that method is available, thus making it possible to store binary
       objects or multiline text in databases that support it (thanks to Marian Kelc <marian.kelc@ruhr-uni-bochum.de> for suggesting this improve-
       ment).

       The three predefined typetags "string", "int" and "real" are for the corresponding Perl scalar subtypes.

       Each scalar field is stored in a single column of the table associated to the class.

       The persistent fields may be specified either as a hash or as an array of field names.

       In the hash form, each entry consists in a field name and an associated option hash. The option hash may contain the following fields:

       * col
       * sql
       * automatic

       "col" sets the name of the column used to store the field's value. This field is optional, it defaults to the persistent field name. Over-
       ride if the field name is not an acceptable SQL column name.

       "sql" sets the SQL type of the column. Used by Schema::deploy() when initializing a database. Defaults to 'VARCHAR(255) NULL' for strings,
       'INT NULL' for ints and 'REAL NULL' for reals.

       "automatic", if set to true, tells Tangram not to save the field to storage. This is useful for auto-increment or timestamp columns.

       The persistent fields may also be specified as an array of strings, in which case the defaults are used.

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

Check Out this Related Man Page

Tangram::Type::Array::Scalar(3pm)			User Contributed Perl Documentation			 Tangram::Type::Array::Scalar(3pm)

NAME

       Tangram::Type/Array/Scalar - map Perl array of strings or numbers

SYNOPSIS

	  use Tangram::Core;
	  use Tangram::Type/Array/Scalar; # always

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

	     flat_array =>
	     {
		interests =>
		{
		   table => 'NP_int',
		   sql => 'VARCHAR(50)',
		},

		lucky_numbers => 'int', # use defaults
	     }

DESCRIPTION

       Maps references to a Perl array. The persistent fields are grouped in a hash under the "array" key in the field hash.

       The array may contain only 'simple' scalars like integers, strings or real numbers. It may not contain references. For arrays of objects,
       see Tangram::Type::Array::FromMany and Tangram::Type::Array::FromOne.

       Tangram uses a table to save the state of the collection. The table has three columns, which contain

       * the id of the container object
       * the position of the element in the array
       * the value of the element

       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:

       * type
       * table
       * sql

       Optional field "type" specifies the type of the elements. If the type is "string"Tangram quotes the values as they are passed to the data-
       base.  Not specifying a "type" is exactly equivalent to specifying "string".

       Optional field "table" sets the name of the table that contains the elements. This defaults to 'C_F', where C is the class of the contain-
       ing object and F is the field name.

       Optional field "sql" specifies the type that deploy() (see Tangram::Deploy) should use for the column containing the elements. If this
       field is not present, the SQL type is derived from the "type" field: if "type" is "string" (or is absent) VARCHAR(255) is used; otherwise,
       the "type" field is interpreted as a SQL type.

       If the descriptor is a string, it is interpreted as the value of the "type" field and all the other fields take the default value.

perl v5.8.8							    2006-03-29					 Tangram::Type::Array::Scalar(3pm)
Man Page