.\" 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 "Jifty::DBI::Column 3pm"
.TH Jifty::DBI::Column 3pm "2022-06-15" "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"
Jifty::DBI::Column \- Encapsulates a single column in a Jifty::DBI::Record table
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class encapsulates a single column in a Jifty::DBI::Record table
description. It replaces the _accessible method in
Jifty::DBI::Record.
.PP
It has the following accessors: \f(CW\*(C`name type default validator boolean
refers_to readable writable length\*(C'\fR.
.SS "new"
.IX Subsection "new"
.SS "is_numeric"
.IX Subsection "is_numeric"
Returns true if the column is of some numeric type, otherwise returns false.
.SS "is_string"
.IX Subsection "is_string"
Returns true if this column is a text field
.SS "is_boolean"
.IX Subsection "is_boolean"
Returns true if this column is a boolean
.SS "serialize_metadata"
.IX Subsection "serialize_metadata"
Returns a hash describing this column object with enough detail to
fully describe it in the database.  Intentionally skips
\&\f(CW\*(C`record_class\*(C'\fR, all column attributes starting with \f(CW\*(C`_\*(C'\fR, and all
column attributes which are undefined.  The \*(L"known\*(R" attributes in the
\&\f(CW\*(C`attributes\*(C'\fR hash are flattened and returned as well.  The list of
known attributes are:
.IP "container" 4
.IX Item "container"
.PD 0
.IP "label hints render_as" 4
.IX Item "label hints render_as"
.IP "display_length" 4
.IX Item "display_length"
.IP "valid_values" 4
.IX Item "valid_values"
.IP "available_values" 4
.IX Item "available_values"
.IP "autocompleted" 4
.IX Item "autocompleted"
.IP "documentation" 4
.IX Item "documentation"
.IP "no_placeholder" 4
.IX Item "no_placeholder"
.PD
Setting this to a true value causes \*(L"load_by_cols\*(R" in Jifty::DBI::record
to not use a placeholder when loading the column.  This can allow the
database to come up with better query plans in some cases.
.SS "serialize_metadata2"
.IX Subsection "serialize_metadata2"
Returns a hash describing this column object with enough detail to
fully describe it in the database.  Intentionally skips \f(CW\*(C`record_class\*(C'\fR,
all column attributes starting with \f(CW\*(C`_\*(C'\fR, and all column attributes
which are undefined.
.SS "validator"
.IX Subsection "validator"
Gets/sets the validator coderef for the column.
.SS "read"
.IX Subsection "read"
\&\s-1DEPRECATED.\s0  Use \f(CW\*(C`$column\->readable\*(C'\fR instead.
.SS "write"
.IX Subsection "write"
\&\s-1DEPRECATED.\s0  Use \f(CW\*(C`$column\->writable\*(C'\fR instead.
.SS "length"
.IX Subsection "length"
\&\s-1DEPRECATED.\s0  Use \f(CW\*(C`$column\->max_length\*(C'\fR instead.
.SS "until"
.IX Subsection "until"
\&\s-1DEPRECATED.\s0  Use \f(CW\*(C`$column\->till\*(C'\fR instead.
.SS "active"
.IX Subsection "active"
Returns the a true value if the column method exists for the current application
version. The current application version is determined by checking the \*(L"schema_version\*(R" in Jifty::DBI::Record of the column's \*(L"record_class\*(R". This method returns a false value if the column is not yet been added or has been dropped.
.PP
This method returns a false value under these circumstances:
.IP "\(bu" 4
Both the \f(CW\*(C`since\*(C'\fR trait and \f(CW\*(C`schema_version\*(C'\fR method are defined and \f(CW\*(C`schema_version\*(C'\fR is less than the version set on \f(CW\*(C`since\*(C'\fR.
.IP "\(bu" 4
Both the \f(CW\*(C`till\*(C'\fR trait and \f(CW\*(C`schema_version\*(C'\fR method are defined and \f(CW\*(C`schema_version\*(C'\fR is greater than or equal to the version set on \f(CW\*(C`till\*(C'\fR.
.PP
Otherwise, this method returns true.