view release on metacpan or  search on metacpan

lib/Apache/Solr.pod  view on Meta::CPAN

is also a value character in a field name token.  So, it is very unwise to
enable this rewrite even though it makes your Perl pretty.

   f_cat_facet  => { missing => 1 },  # by default means:
  'f.cat.facet' => { missing => 1 },

   f.myinteger_i.facet.range.start    # is by default rules:
   f.myinteger.i.facet.range.start    # which is broken.

Wrong default kept to be backwards compatible.

=back

=head2 Attributes

=over 4

=item $obj-E<gt>B<agent>()

Returns the LWP::UserAgent object which maintains the connection to
the server.

=item $obj-E<gt>B<autocommit>( [BOOLEAN] )

Z<>

=item $obj-E<gt>B<core>( [$core] )

Returns the C<$core>, when not defined the default core as set by L<new(core)|Apache::Solr/"Constructors">.
May return C<undef>.

=item $obj-E<gt>B<fieldKeySimplify>()

[1.12] Returns C<true> when underscores in field paths are to be interpreted as dots.
This is C<true> by default, but deprecated.  Please expliticly disable this rewrite
rule by setting L<new(field_key_simplify)|Apache::Solr/"Constructors"> to C<false>.

=item $obj-E<gt>B<server>( [$uri|STRING] )

Returns the URI object which refers to the server base address.  You need
to C<clone()> it before modifying.  You may set a new value as C<STRING> or C<$uri>
object.

=item $obj-E<gt>B<serverVersion>()

Returns the specified version of the Solr server software (by default the
latest).  Treat this version as string, to avoid rounding errors.

=back

=head2 Commands

=head3 Search

=over 4

=item $obj-E<gt>B<queryTerms>($terms)

Search for often used terms. See L<https://wiki.apache.org/solr/TermsComponent>

C<$terms> are passed to L<expandTerms()|Apache::Solr/"Parameter pre-processing"> before being used.

B<Be warned:> The result is not sorted when XML communication is used,
even when you explicitly request it.

» example: 

  my $r = $self->queryTerms(fl => 'subject', limit => 100);
  if($r->success)
  {    foreach my $hit ($r->terms('subject'))
      {    my ($term, $count) = @$hit;
          print "term=$term, count=$count\n";
      }
  }

  if(my $r = $self->queryTerms(fl => 'subject', limit => 100))
     ...

=item $obj-E<gt>B<select>( [\%options], @parameters )

Find information in the document collection.

This method has a HUGE number of parameters.  These values are passed in
the uri of the http query to the solr server.  See L<expandSelect()|Apache::Solr/"Parameter pre-processing"> for
all the simplifications offered here.  Sets of there parameters
may need configuration help in the server as well.

[1.06] You may pass some options to process the selected results (the
L<Apache::Solr::Result|Apache::Solr::Result> object initiation).  For instance, C<sequential>.
For backwards compatability reasons, they have to be passed in a HASH
as optional first parameter.

=back

=head3 Updates

See L<https://wiki.apache.org/solr/UpdateXmlMessages>.  Missing are the
atomic updates.

=over 4

=item $obj-E<gt>B<addDocument>($doc|\@docs, %options)

Add one or more documents (L<Apache::Solr::Document|Apache::Solr::Document> objects) to the Solr
database on the server.

 -Option            --Default
  allowDups           false
  commit              <autocommit>
  commitWithin        undef
  overwrite           true
  overwriteCommitted  <not allowDups>
  overwritePending    <not allowDups>

=over 2

=item allowDups => BOOLEAN

[removed since Solr 4.0]  Use option C<overwrite>.

=item commit => BOOLEAN

=item commitWithin => $seconds

[Since Solr 3.4] Automatically translated into 'commit' for older
servers.  Currently, the resolution is milli-seconds.

=item overwrite => BOOLEAN

=item overwriteCommitted => BOOLEAN

[removed since Solr 4.0]  Use option C<overwrite>.

=item overwritePending => BOOLEAN

[removed since Solr 4.0]  Use option C<overwrite>.

=back

=item $obj-E<gt>B<commit>(%options)

Z<>

 -Option        --Default

lib/Apache/Solr.pod  view on Meta::CPAN

=over 2

=item core => $name

=back

» example: 

  my $result = $solr->coreStatus;
  $result or die $result->errors;

  use Data::Dumper;
  print Dumper $result->decoded->{status};

=item $obj-E<gt>B<coreUnload>(%options)

Removes a core from Solr. Active requests will continue to be processed,
but no new requests will be sent to the named core. If a core is
registered under more than one name, only the given name is removed.

 -Option--Default
  core    <this core>

=over 2

=item core => $name

=back

=back

=head2 Helpers

=head3 Parameter pre-processing

Many parameters are passed to the server.  The syntax of the communication
protocol is not optimal for the end-user: it is too verbose and depends on
the Solr server version.

General rules:

=over 4

=item * you can group them on prefix

=item * use underscore as alternative to dots: less quoting needed (see L<new(field_key_simplify)|Apache::Solr/"Constructors">)

=item * boolean values in Perl will get translated into 'C<true>' and 'C<false>'

=item * when an ARRAY (or LIST), the order of the parameters get preserved

=back

=over 4

=item $obj-E<gt>B<deprecated>($message)

Produce a warning C<$message> about deprecated parameters with the
indicated server version.

=item $obj-E<gt>B<expandExtract>(%pairs|\@pairs)

Used by L<extractDocument()|Apache::Solr/"Updates">.

[0.93] If the key is C<literal> or C<literals>, then the keys in the
value HASH (or C<@pairs> ARRAY) get 'literal.' prepended.  "Literals"
are fields you add yourself to the SolrCEL output.  Unless C<extractOnly>,
you need to specify the 'id' literal.

[0.94] You can also use C<fmap>, C<boost>, and C<resource> with an
HASH (or C<@pairs> ARRAY).  [0.97] the value in each PAIR may be a SCALAR
(ref string) which circumvents some copying.

» example: 

  my $result = $solr->extractDocument(string => $document,
      resource_name => $fn, extractOnly => 1,
      literals => { id => 5, b => 'tic' }, literal_xyz => 42,
      fmap => { id => 'doc_id' }, fmap_subject => 'mysubject',
      boost => { abc => 3.5 }, boost_xyz => 2.0
  );

=item $obj-E<gt>B<expandSelect>(%pairs)

The L<select()|Apache::Solr/"Search"> method accepts many, many parameters.  These are passed
to modules in the server, which need configuration before being usable.

Besides the common parameters, like 'q' (query) and 'rows', there
are parameters for various (pluggable) backends, usually prefixed
by the backend abbreviation.

=over 4

=item * expand

=item * facet -> L<https://wiki.apache.org/solr/SimpleFacetParameters>

=item * hl (highlight) -> L<https://wiki.apache.org/solr/HighlightingParameters>

=item * mlt -> L<https://solr.apache.org/guide/8_11/morelikethis.html>

=item * stats -> L<https://wiki.apache.org/solr/StatsComponent>

=item * suggest -> L<https://solr.apache.org/guide/8_11/suggester.html>

=item * group -> L<https://wiki.apache.org/solr/FieldCollapsing>

=back

You may use WebService::Solr::Query to construct the query ('q').

» example: 

  my @r = $solr->expandSelect(
      q => 'inStock:true', rows => 10,
      facet => {limit => -1, field => [qw/cat inStock/], mincount => 1},
      f_cat_facet => {missing => 1},
      hl    => {},
      mlt   => { fl => 'manu,cat', mindf => 1, mintf => 1 },
      stats => { field => [ 'price', 'popularity' ] },
      group => { query => 'price:[0 TO 99.99]', limit => 3 },
  );

  # becomes (one line)
  ...?rows=10&q=inStock:true
    &facet=true&facet.limit=-1&facet.field=cat
       &f.cat.facet.missing=true&facet.mincount=1&facet.field=inStock
    &mlt=true&mlt.fl=manu,cat&mlt.mindf=1&mlt.mintf=1
    &stats=true&stats.field=price&stats.field=popularity
    &group=true&group.query=price:[0+TO+99.99]&group.limit=3

=item $obj-E<gt>B<expandTerms>(%pairs|\@pairs)

Used by L<queryTerms()|Apache::Solr/"Search"> only.

» example: 

  my @t = $solr->expandTerms('terms.lower.incl' => 'true');
  my @t = $solr->expandTerms([lower_incl => 1]);   # same

  my $r = $self->queryTerms(fl => 'subject', limit => 100);

=item $obj-E<gt>B<ignored>($message)

Produce a warning C<$message> about parameters which will get ignored
because they were not yet supported by the indicated server version.

=item $obj-E<gt>B<removed>($message)

Produce a warning C<$message> about parameters which will not be passed on,
because they were removed from the indicated server version.

=back

=head3 Other helpers

=over 4

=item $obj-E<gt>B<endpoint>($action, %options)

Compute the address to be called (for HTTP)

 -Option--Default
  core    new(core)
  params  []

=over 2

=item core => $name

If no core is specified, the default of the server is addressed.

=item params => %params|\@params

The order of the parameters will be preserved when an ARRAY or parameters
is passed; you never know for a HASH.

=back

=item $obj-E<gt>B<request>($url, $result, $body, $ct)

Send a request to the server C<$url> and return the response
(an HTTP::Response object).  A trace of the activity is
added to the C<$result> object.  The C<$body> of the request
can be provided as bytes or reference to bytes (SCALAR). The
content-type C<$ct> must match the body bytes.

=back

=head1 DETAILS

=head2 Comparison with other implementations

=head3 Compared to WebService::Solr

WebService::Solr is a good module, with a lot of miles.  The main
differences is that C<Apache::Solr> has much more abstraction.

=over 4

=item * simplified parameter syntax, improving readibility

=item * real Perl-level boolean parameters, not 'C<true>' and 'C<false>'

=item * warnings for deprecated and ignored parameters

=item * smart result object with built-in trace and timing

=item * hidden paging of results

=item * flexible logging framework (Log::Report)

=item * both-way XML or both-way JSON, not requests in XML and answers in JSON

=item * access to plugings like terms and tika

=item * no Moose

=back

=head1 DIAGNOSTICS

=over 4

=item Fault: Cannot read document from $fn: $!

Cast by C<extractDocument()>

=item Fault: Read error for document $fn: $!

Cast by C<extractDocument()>

=item Fault: Solr request failed after $elapse seconds after $retries retries: $!

Cast by C<request()>

=item Alert: Solr request failed with $code, $retries retries left: $!

Cast by C<request()>

=item Error: Solr request failed with: $err

Cast by C<request()>

=item Warning: deprecated solr $message

Cast by C<deprecated()>

=item Error: extract requires document as file or string.

Cast by C<extractDocument()>

=item Error: extractDocument() requires Solr v1.4 or higher.

Cast by C<extractDocument()>

=item Error: field $field is not simple for a set.

Cast by C<expandSelect()>

=item Warning: ignored solr $message

Cast by C<ignored()>

=item Warning: removed solr $message

Cast by C<removed()>

=item Error: rollback not supported by your solr server version.

Cast by C<rollback()>

=item Error: set $set cannot be used per field, in $field.

Cast by C<expandSelect()>

=item Error: unknown field set $set.

Cast by C<expandSelect()>

=back

=head1 SEE ALSO

This module is part of Apache-Solr version 1.12,
built on July 15, 2026. Website: F<https://perl.overmeer.net/CPAN/>

=head1 LICENSE

For contributors see file ChangeLog.

This software is copyright (c) 2012-2026 by Mark Overmeer.

This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.