.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{ . if \nF \{ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Tangram::Type::Hash::Scalar 3pm" .TH Tangram::Type::Hash::Scalar 3pm "2015-10-09" "perl v5.20.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Tangram::Type::Hash::Scalar \- map Perl hash of scalar keys and values .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Tangram::Core; \& use Tangram::Type::Hash::Scalar; # always \& \& $schema = Tangram::Schema\->new( \& classes => { NaturalPerson => { fields => { \& \& flat_hash => \& { \& opinions => \& { \& table => \*(AqNP_ops\*(Aq, \& key_sql => \*(AqVARCHAR(10)\*(Aq, \& type => \*(Aqint\*(Aq, \& sql => \*(AqNUMERIC(1)\*(Aq, \& }, \& \& lucky_numbers => \*(Aqint\*(Aq, # use defaults \& } .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Maps references to a Perl hash. The persistent fields are grouped in a hash under the \f(CW\*(C`flat_hash\*(C'\fR key in the field hash. .PP The hash may contain as keys and values only 'simple' scalars like integers, strings or real numbers. It may not contain references. For hashs of objects, see Tangram::Type::Hash::FromMany and Tangram::Type::Hash::FromOne. .PP Tangram uses a table to save the state of the collection. The table has three columns, which contain .IP "\(bu" 4 the id of the container object .IP "\(bu" 4 the key of the element in the hash .IP "\(bu" 4 the value of the element .PP 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: .IP "\(bu" 4 key_type .IP "\(bu" 4 key_sql .IP "\(bu" 4 type .IP "\(bu" 4 sql .IP "\(bu" 4 table .PP The optional fields \f(CW\*(C`key_type\*(C'\fR and \f(CW\*(C`type\*(C'\fR specify the key and value types of the hash. If the type is \f(CW\*(C`string\*(C'\fR Tangram quotes the values as they are passed to the database. Not specifying a \f(CW\*(C`type\*(C'\fR is exactly equivalent to specifying \f(CW\*(C`string\*(C'\fR. .PP Optional field \f(CW\*(C`table\*(C'\fR sets the name of the table that contains the elements. This defaults to 'C_F', where C is the class of the containing object and F is the field name. .PP The optional fields \f(CW\*(C`key_sql\*(C'\fR and \f(CW\*(C`sql\*(C'\fR specify the type that \&\fIdeploy()\fR (see Tangram::Deploy) should use for the column containing the key and value of the hash. If this field is not present, the \s-1SQL\s0 type is derived from the \f(CW\*(C`type\*(C'\fR field: if \f(CW\*(C`type\*(C'\fR is \f(CW\*(C`string\*(C'\fR (or is absent) \s-1VARCHAR\s0(255) is used; otherwise, the \f(CW\*(C`type\*(C'\fR field is interpreted as a \s-1SQL\s0 type. .PP If the descriptor is a string, it is interpreted as the value of the \&\f(CW\*(C`type\*(C'\fR field and all the other fields take the default value. .SH "AUTHOR" .IX Header "AUTHOR" This mapping was contributed by Gabor Herr