.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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 >0, 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
.\" ========================================================================
.\"
.IX Title "Tangram::Type::Dump::Perl 3pm"
.TH Tangram::Type::Dump::Perl 3pm "2022-10-16" "perl v5.34.0" "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::Dump::Perl \- map any Perl object as scalar dump
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&   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 => \*(Aqdiarydata\*(Aq,
\&            sql => \*(AqTEXT\*(Aq,
\&            indent => 0,
\&            terse => 1,
\&            purity => 0
\&         },
\&
\&         lucky_numbers => \*(Aqint\*(Aq, # use defaults
\&      }
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Maps arbitrary Perl data structures by serializing to a string
representation. The persistent fields are grouped in a hash under the
\&\f(CW\*(C`perl_dump\*(C'\fR key in the field hash.
.PP
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 \s-1DBMS\s0 as a scalar value. During
restore, the scalar value will be eval'd to reconstruct the
original data structure.
.PP
As of Tangram 2.07.1, persistent references are safely handled via the
Tangram::Type::Dump utility class.
.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
col
.IP "\(bu" 4
sql
.IP "\(bu" 4
indent
.IP "\(bu" 4
terse
.IP "\(bu" 4
purity
.PP
The optional fields \f(CW\*(C`col\*(C'\fR and \f(CW\*(C`sql\*(C'\fR specify the column name and the
column type for the scalar value in the database. If not present,
\&\f(CW\*(C`col\*(C'\fR defaults to the field name and \f(CW\*(C`sql\*(C'\fR defaults to \s-1VARCHAR\s0(255).
Values will be always quoted as they are passed to the database.
.PP
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
(\f(CW\*(C`indent=0\*(C'\fR), compact format (\f(CW\*(C`terse=1\*(C'\fR), and quick dump
(\f(CW\*(C`purity=0\*(C'\fR).
.SH "AUTHOR"
.IX Header "AUTHOR"
This mapping was contributed by Gabor Herr
<herr@iti.informatik.tu\-darmstadt.de>