.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40) .\" .\" 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 "DBIx::SearchBuilder::Handle::Pg 3pm" .TH DBIx::SearchBuilder::Handle::Pg 3pm "2021-01-24" "perl v5.32.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" .Vb 1 \& DBIx::SearchBuilder::Handle::Pg \- A Postgres specific Handle object .Ve .SH "SYNOPSIS" .IX Header "SYNOPSIS" .SH "DESCRIPTION" .IX Header "DESCRIPTION" This module provides a subclass of DBIx::SearchBuilder::Handle that compensates for some of the idiosyncrasies of Postgres. .SH "METHODS" .IX Header "METHODS" .SS "Connect" .IX Subsection "Connect" Connect takes a hashref and passes it off to SUPER::Connect; Forces the timezone to \s-1GMT\s0 it returns a database handle. .SS "BuildDSN" .IX Subsection "BuildDSN" Extend \*(L"BuildDNS\*(R" in DBIx::SearchBuilder::Handle to force \&\f(CW\*(C`client_encoding\*(C'\fR to be \s-1UTF\-8,\s0 so that character strings can be safely passed to, and retrieved from, the database. See \&\*(L"Encoding\*(R" in DBD::Pg. .SS "Insert" .IX Subsection "Insert" Takes a table name as the first argument and assumes that the rest of the arguments are an array of key-value pairs to be inserted. .PP In case of insert failure, returns a Class::ReturnValue object preloaded with error info. .SS "InsertQueryString" .IX Subsection "InsertQueryString" Postgres sepcific overriding method for \&\*(L"InsertQueryString\*(R" in DBIx::SearchBuilder::Handle. .SS "IdSequenceName \s-1TABLE\s0" .IX Subsection "IdSequenceName TABLE" Takes a \s-1TABLE\s0 name and returns the name of the sequence of the primary key for that table. .SS "BinarySafeBLOBs" .IX Subsection "BinarySafeBLOBs" Return undef, as no current version of postgres supports binary-safe blobs .SS "ApplyLimits \s-1STATEMENTREF ROWS_PER_PAGE FIRST_ROW\s0" .IX Subsection "ApplyLimits STATEMENTREF ROWS_PER_PAGE FIRST_ROW" takes an \s-1SQL SELECT\s0 statement and massages it to return \s-1ROWS_PER_PAGE\s0 starting with \s-1FIRST_ROW\s0; .SS "_MakeClauseCaseInsensitive \s-1FIELD OPERATOR VALUE\s0" .IX Subsection "_MakeClauseCaseInsensitive FIELD OPERATOR VALUE" Takes a field, operator and value. performs the magic necessary to make your database treat this clause as case insensitive. .PP Returns a \s-1FIELD OPERATOR VALUE\s0 triple. .SS "DistinctQuery \s-1STATEMENTREF\s0" .IX Subsection "DistinctQuery STATEMENTREF" takes an incomplete \s-1SQL SELECT\s0 statement and massages it to return a \s-1DISTINCT\s0 result set. .SS "SimpleDateTimeFunctions" .IX Subsection "SimpleDateTimeFunctions" Returns hash reference with specific date time functions of this database for \*(L"DateTimeFunction\*(R" in DBIx::SearchBuilder::Handle. .SS "ConvertTimezoneFunction" .IX Subsection "ConvertTimezoneFunction" Custom implementation of \*(L"ConvertTimezoneFunction\*(R" in DBIx::SearchBuilder::Handle. .PP In Pg time and timestamp data types may be \*(L"with time zone\*(R" or \*(L"without time zone\*(R". So if Field argument is timestamp \*(L"with time zone\*(R" then From argument is not required and is useless. Otherwise From argument identifies time zone of the Field argument that is \*(L"without time zone\*(R". .PP For consistency with other DBs use timestamp columns without time zones and provide From argument. .SH "SEE ALSO" .IX Header "SEE ALSO" DBIx::SearchBuilder, DBIx::SearchBuilder::Handle