.\" 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 "Rose::DB::Object::Metadata::Column::Interval 3pm"
.TH Rose::DB::Object::Metadata::Column::Interval 3pm "2022-10-14" "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"
Rose::DB::Object::Metadata::Column::Interval \- Interval column metadata.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use Rose::DB::Object::Metadata::Column::Interval;
\&
\&  $col = Rose::DB::Object::Metadata::Column::Interval\->new(...);
\&  $col\->make_methods(...);
\&  ...
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Objects of this class store and manipulate metadata for interval columns in a database.  Column metadata objects store information about columns (data type, size, etc.) and are responsible for creating object methods that manipulate column values.
.PP
This class inherits from Rose::DB::Object::Metadata::Column. Inherited methods that are not overridden will not be documented a second time here.  See the Rose::DB::Object::Metadata::Column documentation for more information.
.SH "METHOD MAP"
.IX Header "METHOD MAP"
.ie n .IP """get_set""" 4
.el .IP "\f(CWget_set\fR" 4
.IX Item "get_set"
Rose::DB::Object::MakeMethods::Generic, date, ...
.ie n .IP """get""" 4
.el .IP "\f(CWget\fR" 4
.IX Item "get"
Rose::DB::Object::MakeMethods::Time, date, ...
.ie n .IP """get_set""" 4
.el .IP "\f(CWget_set\fR" 4
.IX Item "get_set"
Rose::DB::Object::MakeMethods::Time, date, ...
.PP
See the Rose::DB::Object::Metadata::Column documentation for an explanation of this method map.
.SH "OBJECT METHODS"
.IX Header "OBJECT METHODS"
.IP "\fBend_of_month_mode \s-1MODE\s0\fR" 4
.IX Item "end_of_month_mode MODE"
This mode determines how math is done on duration objects.  If defined, the \f(CW\*(C`end_of_month\*(C'\fR setting for each DateTime::Duration object created by this column will have its mode set to \s-1MODE.\s0  Otherwise, the \f(CW\*(C`end_of_month\*(C'\fR parameter will not be passed to the DateTime::Duration constructor.
.Sp
Valid modes are \f(CW\*(C`wrap\*(C'\fR, \f(CW\*(C`limit\*(C'\fR, and \f(CW\*(C`preserve\*(C'\fR.  See the documentation for DateTime::Duration for a full explanation.
.IP "\fBparse_value \s-1DB, VALUE\s0\fR" 4
.IX Item "parse_value DB, VALUE"
Convert \s-1VALUE\s0 to the equivalent DateTime::Duration object.  \s-1VALUE\s0 maybe returned unmodified if it is a valid interval keyword or otherwise has special meaning to the underlying database.  \s-1DB\s0 is a Rose::DB object that is used as part of the parsing process.  Both arguments are required.
.IP "\fBscale [\s-1INT\s0]\fR" 4
.IX Item "scale [INT]"
Get or set the integer number of places past the decimal point preserved for fractional seconds.  Defaults to 0.
.Sp
Returns \*(L"interval\*(R".
.IP "\fBtype\fR" 4
.IX Item "type"
Returns \*(L"interval\*(R".
.SH "AUTHOR"
.IX Header "AUTHOR"
John C. Siracusa (siracusa@gmail.com)
.SH "LICENSE"
.IX Header "LICENSE"
Copyright (c) 2010 by John C. Siracusa.  All rights reserved.  This program is
free software; you can redistribute it and/or modify it under the same terms
as Perl itself.