.\" 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 "WebService::Solr::Query 3pm"
.TH WebService::Solr::Query 3pm "2022-10-16" "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"
WebService::Solr::Query \- Abstract query syntax for Solr queries
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&    my $query  = WebService::Solr::Query\->new( { foo => \*(Aqbar\*(Aq } );
\&    my $result = $solr\->search( $query );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
WebService::Solr::Query provides a programmatic way to generate
queries to be sent to Solr. Syntax wise, it attempts to be as close to 
SQL::Abstract \s-1WHERE\s0 clauses as possible, with obvious exceptions for 
idioms that do not exist in \s-1SQL.\s0 Just as values in SQL::Abstract are 
SQL-escaped, this module does the appropriate Solr-escaping on all values 
passed to the object (see \f(CW\*(C`escape()\*(C'\fR).
.SH "QUERY SYNTAX"
.IX Header "QUERY SYNTAX"
.SS "Key-Value Pairs"
.IX Subsection "Key-Value Pairs"
The simplest way to search is with key value pairs.
.PP
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { foo => \*(Aqbar\*(Aq } );
\&    # RESULT: (foo:"bar")
.Ve
.SS "Implicit \s-1AND\s0 and \s-1OR\s0"
.IX Subsection "Implicit AND and OR"
By default, data received as a \s-1HASHREF\s0 is \s-1AND\s0'ed together.
.PP
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { foo => \*(Aqbar\*(Aq, baz => \*(Aqquux\*(Aq } );
\&    # RESULT: (foo:"bar" AND baz:"quux")
.Ve
.PP
Furthermore, data received as an \s-1ARRAYREF\s0 is \s-1OR\s0'ed together.
.PP
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { foo => [ \*(Aqbar\*(Aq, \*(Aqbaz\*(Aq ] } );
\&    # RESULT: (foo:"bar" OR foo:"baz")
.Ve
.SS "Nested \s-1AND\s0 and \s-1OR\s0"
.IX Subsection "Nested AND and OR"
The ability to nest \s-1AND\s0 and \s-1OR\s0 boolean operators is essential to express
complex queries. The \f(CW\*(C`\-and\*(C'\fR and \f(CW\*(C`\-or\*(C'\fR prefixes have been provided for this
need.
.PP
.Vb 4
\&    my $q = WebService::Solr::Query\->new( { foo => [
\&        \-and => { \-prohibit => \*(Aqbar\*(Aq }, { \-require => \*(Aqbaz\*(Aq }
\&    ] } );
\&    # RESULT: (((\-foo:"bar") AND (+foo:"baz")))
\&
\&    my $q = WebService::Solr::Query\->new( { foo => [
\&        \-or => { \-require => \*(Aqbar\*(Aq }, { \-prohibit => \*(Aqbaz\*(Aq }
\&    ] } );
\&    # RESULT: (((+foo:"bar") OR (\-foo:"baz")))
.Ve
.SS "Default Field"
.IX Subsection "Default Field"
To search the default field, use the \f(CW\*(C`\-default\*(C'\fR prefix.
.PP
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { \-default => \*(Aqbar\*(Aq } );
\&    # RESULT: ("bar")
.Ve
.SS "Require/Prohibit"
.IX Subsection "Require/Prohibit"
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { foo => { \-require => \*(Aqbar\*(Aq } } );
\&    # RESULT: (+foo:"bar")
\&
\&    my $q = WebService::Solr::Query\->new( { foo => { \-prohibit => \*(Aqbar\*(Aq } } );
\&    # RESULT: (\-foo:"bar")
.Ve
.SS "Range"
.IX Subsection "Range"
There are two types of range queries, inclusive (\f(CW\*(C`\-range_inc\*(C'\fR) and 
exclusive (\f(CW\*(C`\-range_exc\*(C'\fR). The \f(CW\*(C`\-range\*(C'\fR prefix can be used in place of
\&\f(CW\*(C`\-range_inc\*(C'\fR.
.PP
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { foo => { \-range => [\*(Aqa\*(Aq, \*(Aqz\*(Aq] } } );
\&    # RESULT: (+foo:[a TO z])
\&
\&    my $q = WebService::Solr::Query\->new( { foo => { \-range_exc => [\*(Aqa\*(Aq, \*(Aqz\*(Aq] } } );
\&    # RESULT: (+foo:{a TO z})
.Ve
.SS "Boost"
.IX Subsection "Boost"
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { foo => { \-boost => [ \*(Aqbar\*(Aq, \*(Aq2.0\*(Aq ] } } );
\&    # RESULT: (foo:"bar"^2.0)
.Ve
.SS "Proximity"
.IX Subsection "Proximity"
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { foo => { \-proximity => [ \*(Aqbar baz\*(Aq, 10 ] } } );
\&    # RESULT: (foo:"bar baz"~10)
.Ve
.SS "Fuzzy"
.IX Subsection "Fuzzy"
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { foo => { \-fuzzy => [ \*(Aqbar\*(Aq, \*(Aq0.8\*(Aq ] } } );
\&    # RESULT: (foo:bar~0.8)
.Ve
.SS "Literal Queries"
.IX Subsection "Literal Queries"
Specifying a scalar ref as a value in a key-value pair will allow arbitrary
queries to be sent across the line. \fB\s-1NB:\s0\fR This will bypass any data
massaging done on regular strings, thus the onus of properly escaping the
data is left to the user.
.PP
.Vb 2
\&    my $q = WebService::Solr::Query\->new( { \*(Aq*\*(Aq => \e\*(Aq*\*(Aq } )
\&    # RESULT (*:*)
.Ve
.SH "ACCESSORS"
.IX Header "ACCESSORS"
.IP "\(bu" 4
query \- stores the original query structure
.SH "METHODS"
.IX Header "METHODS"
.SS "new( \e%query )"
.IX Subsection "new( %query )"
Creates a new query object with the given hashref.
.SS "stringify( )"
.IX Subsection "stringify( )"
Converts the supplied structure into a Solr/Lucene query.
.ie n .SS "escape( $value )"
.el .SS "escape( \f(CW$value\fP )"
.IX Subsection "escape( $value )"
The following values must be escaped in a search value:
.PP
.Vb 1
\&    + \- & | ! ( ) { } [ ] ^ " ~ * ? : \e
.Ve
.PP
\&\fB\s-1NB:\s0\fR Values sent to \f(CW\*(C`new()\*(C'\fR are automatically escaped for you.
.ie n .SS "unescape( $value )"
.el .SS "unescape( \f(CW$value\fP )"
.IX Subsection "unescape( $value )"
Unescapes values escaped in \f(CW\*(C`escape()\*(C'\fR.
.SS "D"
.IX Subsection "D"
Debugging constant, default: off.
.SS "\s-1BUILDARGS\s0"
.IX Subsection "BUILDARGS"
Moo method to handle input to \f(CW\*(C`new()\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\(bu" 4
WebService::Solr
.IP "\(bu" 4
http://wiki.apache.org/solr/SolrQuerySyntax
.SH "AUTHORS"
.IX Header "AUTHORS"
Andy Lester \f(CW\*(C`andy@petdance.com\*(C'\fR
.PP
Brian Cassidy <bricas@cpan.org>
.PP
Jos Boumans <kane@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2008\-2014 National Adult Literacy Database
Copyright 2015\-2020 Andy Lester
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.