view release on metacpan or  search on metacpan

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

=encoding utf8

=head1 NAME

Apache::Solr::Result - Apache Solr (Lucene) result container

=head1 SYNOPSIS

  # All operations return a ::Result object
  my $result = $solr->select(...);

  $result->success or die $result->solrError; # error reported by Solr
  $result->success or die $result->errors;    # any error caught by this object
  if($result)  # same as if($result->success)

  # Lots of trace information included
  $result->showTimings;

  # ::Document containing the requested fields from a select() search
  my $doc1   = $result->selected(0);

  # ::Document containing the highlight info from a selected document
  my $hl1    = $result->highlighted($doc1);

  # Some operations have helper methods
  my $result = $solr->queryTerm(...);
  print Dumper $result->terms;

=head1 DESCRIPTION

=head1 METHODS

=head2 Constructors

=over 4

=item Apache::Solr::Result-E<gt>B<new>(%options)

 -Option    --Default
  core        undef
  endpoint    <required>
  params      []
  request     undef
  response    undef
  sequential  false

=over 2

=item core => L<Apache::Solr|Apache::Solr> object

=item endpoint => URI

=item params => ARRAY|HASH

The parameters used for the query.  [1.11] not required anymore.

=item request => HTTP::Request object

=item response => HTTP::Response object

=item sequential => BOOLEAN