1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84
|
=head1 NAME
Tangram::Type::TimeAndDate - map date & time fields
=head1 SYNOPSIS
use Tangram;
# any of:
use Tangram::Type::Date; # RAW - use with caution
use Tangram::Type::Time;
use Tangram::Type::Date::Cooked; # pure ISO-8601
use Tangram::Type::Date::DateTime;
use Tangram::Type::Date::Manip;
use Tangram::Type::Date::TimePiece;
Tangram::Schema->new(
classes => {
NaturalPerson => {
fields => {
rawdatetime => [ qw( birth death ) ],
rawdate => [ qw( depart return ) ],
rawtime => [ qw( breakfast lunch dinner ) ],
cookeddatetime => [ qw( cooked ) ],
dmdatetime => [ qw( datemanip ) ],
timepiece => [ qw( fob ) ],
datetime => [ qw( bloat ) ],
=head1 DESCRIPTION
These classes are responsible for mapping strings to SQL date or time
types. These classes are not imported by Tangram.pm, thus they must be
explicitly imported via a C<use> directive.
The three typetags C<rawdate>, C<rawtime> and C<rawdatetime> are for
mapping strings to SQL date/time types, for databases that
differentiate between "dates" and "times". 'Raw' means that Tangram
doesn't attempt to interpret the strings, it merely passes them down
to DBI.
C<cookeddatetime> is like C<rawdatetime> except that the date is
converted from the DBMS format to ISO-8601 in the form :
YYYY-MM-DDTHH:MM:SS
for example:
2004-12-25T13:14:15
Other modules then further cook this ISO date into an object as is the
convention for a particular module. This only works with back-ends
that allow per-connection settings for the default date format, such
as L<Tangram::Driver::Oracle>.
On the way back out, the date is converted back to the DBMS format.
This is achieved via vendor-specific functions mentioned in
C<Tangram::Relational>.
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:
=over 4
=item * col
=item * sql
=back
C<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. Override if the field name is not an acceptable SQL column name.
C<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.
The persistent fields may also be specified as an array of strings, in
which case the defaults are used.
|