.\" Automatically generated by Pod::Man 4.09 (Pod::Simple 3.35)
.\"
.\" 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
..
.if !\nF .nr F 0
.if \nF>0 \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    if !\nF==2 \{\
.        nr % 0
.        nr F 2
.    \}
.\}
.\" ========================================================================
.\"
.IX Title "Class::DBI::AbstractSearch 3pm"
.TH Class::DBI::AbstractSearch 3pm "2018-06-25" "perl v5.26.2" "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"
Class::DBI::AbstractSearch \- Abstract Class::DBI's SQL with SQL::Abstract::Limit
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  package CD::Music;
\&  use Class::DBI::AbstractSearch;
\&
\&  package main;
\&  my @music = CD::Music\->search_where(
\&      artist => [ \*(AqOzzy\*(Aq, \*(AqKelly\*(Aq ],
\&      status => { \*(Aq!=\*(Aq, \*(Aqoutdated\*(Aq },
\&  );
\&
\&  my @misc = CD::Music\->search_where(
\&      { artist => [ \*(AqOzzy\*(Aq, \*(AqKelly\*(Aq ],
\&        status => { \*(Aq!=\*(Aq, \*(Aqoutdated\*(Aq } },
\&      { order_by      => "reldate DESC",
\&        limit_dialect => \*(AqLimitOffset\*(Aq,
\&        limit         => 1
\&        offset        => 2 });
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Class::DBI::AbstractSearch is a Class::DBI plugin to glue
SQL::Abstract::Limit into Class::DBI.
.SH "METHODS"
.IX Header "METHODS"
Using this module adds following methods into your data class.
.IP "search_where" 4
.IX Item "search_where"
.Vb 1
\&  $class\->search_where(%where);
.Ve
.Sp
Takes a hash to specify \s-1WHERE\s0 clause. See SQL::Abstract for hash
options.
.Sp
.Vb 1
\&  $class\->search_where(\e%where,\e%attrs);
.Ve
.Sp
Takes hash reference to specify \s-1WHERE\s0 clause. See SQL::Abstract
for hash options. Takes a hash reference to specify additional query
attributes. Class::DBI::AbstractSearch uses these attributes:
.RS 4
.IP "\(bu" 4
\&\fBorder_by\fR
.Sp
Array reference of fields that will be used to order the results of
your query.
.IP "\(bu" 4
\&\fBlimit_dialect\fR
.Sp
Scalar, \s-1DBI\s0 handle, object class, etc. that describes the syntax model
for a \s-1LIMIT/OFFSET SQL\s0 clause.  Please see SQL::Abstract::Limit
for more information.
.IP "\(bu" 4
\&\fBlimit\fR
.Sp
Scalar value that will be used for \s-1LIMIT\s0 argument in a query.
.IP "\(bu" 4
\&\fBoffset\fR
.Sp
Scalar value that will be used for \s-1OFFSET\s0 argument in a query.
.RE
.RS 4
.Sp
Any other attributes are passed to the SQL::Abstract::Limit constructor,
and can be used to control how queries are created.  For example,
to use '\s-1AND\s0' instead of '\s-1OR\s0' by default, use:
.Sp
.Vb 1
\&    $class\->search_where(\e%where, { logic => \*(AqAND\*(Aq });
.Ve
.RE
.SH "AUTHOR"
.IX Header "AUTHOR"
Tatsuhiko Miyagawa <miyagawa@bulknews.net> with some help from
cdbi-talk mailing list, especially:
.PP
.Vb 3
\&  Tim Bunce
\&  Simon Wilcox
\&  Tony Bowden
.Ve
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Class::DBI, SQL::Abstract, SQL::Abstract::Limit