/ 
Rose-DB-0.672
River stage two • 15 direct dependents • 27 total dependents
/ Rose::DB::Informix

NAME

Rose::DB::Informix - Informix driver class for Rose::DB.

SYNOPSIS

use Rose::DB;

Rose::DB->register_db(
  domain   => 'development',
  type     => 'main',
  driver   => 'Informix',
  database => 'dev_db',
  host     => 'localhost',
  username => 'devuser',
  password => 'mysecret',
  server_time_zone => 'UTC',
);


Rose::DB->default_domain('development');
Rose::DB->default_type('main');
...

# Set max length of varchar columns used to emulate the array data type
Rose::DB::Informix->max_array_characters(128);

$db = Rose::DB->new; # $db is really a Rose::DB::Informix object

$dt  = $db->parse_datetime_year_to_minute(...);
$val = $db->format_datetime_year_to_minute($dt);

$dt  = $db->parse_datetime_year_to_second(...);
$val = $db->format_datetime_year_to_second($dt);
...

DESCRIPTION

This is the subclass that Rose::DB blesses an object into when the driver is "Informix". This mapping of drivers to class names is configurable. See the documentation for Rose::DB's new() and driver_class() methods for more information.

Using this class directly is not recommended. Instead, use Rose::DB and let it bless objects into the appropriate class for you, according to its driver_class() mappings.

This class inherits from Rose::DB. Only the methods that are new or have different behaviors are documented here. See the Rose::DB documentation for information on the inherited methods.

CLASS METHODS

max_array_characters [INT]

Get or set the maximum length of varchar columns used to emulate the array data type. The default value is 255.

Informix does not have a native "ARRAY" data type, but it can be emulated using a "VARCHAR" column and a specially formatted string. The formatting and parsing of this string is handled by the format_array() and parse_array() object methods. The maximum length limit is honored by the format_array() object method.

Informix does have a native "SET" data type, serviced by the parse_set() and format_set() object methods. This is a better choice than the emulated array data type if you don't care about the order of the stored values.

OBJECT METHODS

Value Parsing and Formatting

format_array ARRAYREF | LIST

Given a reference to an array or a list of values, return a specially formatted string. Undef is returned if ARRAYREF points to an empty array or if LIST is not passed. The array or list must not contain undefined values.

If the resulting string is longer than max_array_characters(), a fatal error will occur.

format_date DATETIME

Converts the DateTime object DATETIME into the appropriate format for the "DATE" data type.

format_datetime DATETIME

Converts the DateTime object DATETIME into the appropriate format for the "DATETIME YEAR TO SECOND" data type.

format_datetime_year_to_fraction DATETIME

Converts the DateTime object DATETIME into the appropriate format for the "DATETIME YEAR TO FRACTION" data type.

format_datetime_year_to_fraction_[1-5] DATETIME

Converts the DateTime object DATETIME into the appropriate format for the "DATETIME YEAR TO FRACTION(N)" data type, where N is an integer from 1 to 5.

format_datetime_year_to_minute DATETIME

Converts the DateTime object DATETIME into the appropriate format for the "DATETIME YEAR TO MINUTE" data type.

format_datetime_year_to_second DATETIME

Converts the DateTime object DATETIME into the appropriate format for the "DATETIME YEAR TO SECOND" data type.

format_set ARRAYREF | LIST

Given a reference to an array or a list of values, return a string formatted according to the rules of Informix's "SET" data type. Undef is returned if ARRAYREF points to an empty array or if LIST is not passed. If th array or list contains undefined values, a fatal error will occur.

format_timestamp DATETIME

Converts the DateTime object DATETIME into the appropriate format for the "DATETIME YEAR TO FRACTION(5)" data type.

parse_array STRING | LIST | ARRAYREF

Parse STRING and return a reference to an array. STRING should be formatted according to the Informix array data type emulation format returned by format_array(). Undef is returned if STRING is undefined.

If a LIST of more than one item is passed, a reference to an array containing the values in LIST is returned.

If a an ARRAYREF is passed, it is returned as-is.

parse_boolean STRING

Parse STRING and return a boolean value of 1 or 0. STRING should be formatted according to Informix's native "boolean" data type. Acceptable values are 't', 'T', or '1' for true, and 'f', 'F', or '0' for false.

If STRING is a valid boolean keyword (according to validate_boolean_keyword()) or if it looks like a function call (matches /^\w+\(.*\)$/) it is returned unmodified. Returns undef if STRING could not be parsed as a valid "boolean" value.

parse_datetime STRING

Parse STRING and return a DateTime object. STRING should be formatted according to the Informix "DATETIME YEAR TO SECOND" data type.

If STRING is a valid "datetime year to second" keyword (according to validate_datetime_year_to_second_keyword()) it is returned unmodified. Returns undef if STRING could not be parsed as a valid "DATETIME YEAR TO SECOND" value.

parse_datetime_year_to_fraction STRING

Parse STRING and return a DateTime object. STRING should be formatted according to the Informix "DATETIME YEAR TO FRACTION" data type.

If STRING is a valid "datetime year to fraction" keyword (according to validate_datetime_year_to_fraction_keyword()) it is returned unmodified. Returns undef if STRING could not be parsed as a valid "DATETIME YEAR TO FRACTION" value.

parse_datetime_year_to_fraction_[1-5] STRING

These five methods parse STRING and return a DateTime object. STRING should be formatted according to the Informix "DATETIME YEAR TO FRACTION(N)" data type, where N is an integer from 1 to 5.

If STRING is a valid "datetime year to fraction" keyword (according to validate_datetime_year_to_fraction_keyword()) it is returned unmodified. Returns undef if STRING could not be parsed as a valid "DATETIME YEAR TO FRACTION(N)" value.

parse_datetime_year_to_minute STRING

Parse STRING and return a DateTime object. STRING should be formatted according to the Informix "DATETIME YEAR TO MINUTE" data type.

If STRING is a valid "datetime year to minute" keyword (according to validate_datetime_year_to_minute_keyword()) it is returned unmodified. Returns undef if STRING could not be parsed as a valid "DATETIME YEAR TO MINUTE" value.

parse_datetime_year_to_second STRING

Parse STRING and return a DateTime object. STRING should be formatted according to the Informix "DATETIME YEAR TO SECOND" data type.

If STRING is a valid "datetime year to second" keyword (according to validate_datetime_year_to_second_keyword()) it is returned unmodified. Returns undef if STRING could not be parsed as a valid "DATETIME YEAR TO SECOND" value.

parse_set STRING | LIST | ARRAYREF

Parse STRING and return a reference to an array. STRING should be formatted according to Informix's "SET" data type. Undef is returned if STRING is undefined.

If a LIST of more than one item is passed, a reference to an array containing the values in LIST is returned.

If a an ARRAYREF is passed, it is returned as-is.

parse_timestamp STRING

Parse STRING and return a DateTime object. STRING should be formatted according to the Informix "DATETIME YEAR TO FRACTION(5)" data type.

If STRING is a valid timestamp keyword (according to validate_timestamp_keyword()) it is returned unmodified. Returns undef if STRING could not be parsed as a valid "DATETIME YEAR TO FRACTION(5)" value.

validate_date_keyword STRING

Returns true if STRING is a valid keyword for the Informix "date", false otherwise. Valid date keywords are:

current
today

The keywords are not case sensitive. Any string that looks like a function call (matches /^\w+\(.*\)$/) is also considered a valid date keyword.

validate_datetime_keyword STRING

Returns true if STRING is a valid keyword for the Informix "datetime year to second" data type, false otherwise. Valid datetime keywords are:

current
current year to second
current year to minute
current year to hour
current year to day
current year to month
today

The keywords are not case sensitive. Any string that looks like a function call (matches /^\w+\(.*\)$/) is also considered a valid datetime keyword.

validate_datetime_year_to_fraction_keyword STRING

Returns true if STRING is a valid keyword for the Informix "datetime year to fraction(n)" data type (where n is an integer from 1 to 5), false otherwise. Valid "datetime year to fraction" keywords are:

current
current year to fraction
current year to fraction(1)
current year to fraction(2)
current year to fraction(3)
current year to fraction(4)
current year to fraction(5)
current year to second
current year to minute
current year to hour
current year to day
current year to month
today

The keywords are not case sensitive. Any string that looks like a function call (matches /^\w+\(.*\)$/) is also considered a valid "datetime year to fraction" keyword.

validate_datetime_year_to_minute_keyword STRING

Returns true if STRING is a valid keyword for the Informix "datetime year to minute" data type, false otherwise. Valid "datetime year to minute" keywords are:

current
current year to minute
current year to hour
current year to day
current year to month
today

The keywords are not case sensitive. Any string that looks like a function call (matches /^\w+\(.*\)$/) is also considered a valid "datetime year to minute" keyword.

validate_datetime_year_to_second_keyword STRING

Returns true if STRING is a valid keyword for the Informix "datetime year to second" data type, false otherwise. Valid datetime keywords are:

current
current year to second
current year to minute
current year to hour
current year to day
current year to month
today

The keywords are not case sensitive. Any string that looks like a function call (matches /^\w+\(.*\)$/) is also considered a valid "datetime year to second" keyword.

validate_timestamp_keyword STRING

Returns true if STRING is a valid keyword for the Informix "timestamp" data type, false otherwise. Valid timestamp keywords are:

current
current year to fraction
current year to fraction(1)
current year to fraction(2)
current year to fraction(3)
current year to fraction(4)
current year to fraction(5)
current year to second
current year to minute
current year to hour
current year to day
current year to month
today

The keywords are not case sensitive. Any string that looks like a function call (matches /^\w+\(.*\)$/) is also considered a valid timestamp keyword.

AUTHOR

John C. Siracusa (siracusa@mindspring.com)

COPYRIGHT

Copyright (c) 2006 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.