SearchQueryResult (Couchbase Java SDK)

All Superinterfaces:

Iterable<SearchQueryRow>

All Known Implementing Classes:

DefaultSearchQueryResult
```
@InterfaceStability.Committed
 @InterfaceAudience.Public
public interface SearchQueryResult
extends Iterable<SearchQueryRow>
```
The main interface for FTS query results. It is also an Iterable<SearchQueryRow>, where iteration is similar to iterating over hitsOrFail().

Since:

2.3.0

Author:

Simon Baslé, Michael Nitschinger

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`List<String>`	`errors()` When an execution error happens (including partial results), this method returns a `List` of the error(s) in `JSON format`.
`Map<String,FacetResult>`	`facets()` If one or more facet were requested via the `SearchQuery#addFacets(SearchFacet...)` method when querying, contains the result of each facet.
`List<SearchQueryRow>`	`hits()` The list of FTS result rows, or “hits”, for the FTS query.
`List<SearchQueryRow>`	`hitsOrFail()` The list of FTS result rows, or “hits”, for the FTS query.
`Iterator<SearchQueryRow>`	`iterator()` Returns an iterator over the hits (`SearchQueryRow`).
`SearchMetrics`	`metrics()` Provides a `SearchMetrics` object giving statistics on the request like number of hits, total time taken…
`SearchStatus`	`status()` The `SearchStatus` allows to check if the request was a full success (`SearchStatus.isSuccess()`) and gives more details about status for each queried index.

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - status
```
SearchStatus status()
```
    The SearchStatus allows to check if the request was a full success (SearchStatus.isSuccess()) and gives more details about status for each queried index.
  - hits
```
List<SearchQueryRow> hits()
```
    The list of FTS result rows, or “hits”, for the FTS query. This method always returns a list, including when an execution error (eg. partial results) occurred.
    
    See Also:
    
    for a variant that throws an exception whenever execution errors have occurred., to get a list of execution errors in JSON form.
  - hitsOrFail
```
List<SearchQueryRow> hitsOrFail()
```
    The list of FTS result rows, or “hits”, for the FTS query. In case of an execution error (eg. partial results), a CompositeException is thrown instead.
    
    See Also:
    
    for a variant that lists partial results instead of throwing the exception., to get a list of execution errors in JSON form.
  - errors
```
List<String> errors()
```
    When an execution error happens (including partial results), this method returns a List of the error(s) in JSON format.
    
    See Also:
    
    to get results, including partial results (rather than throwing an exception)., to get only full results, but throwing an exception whenever execution errors have occurred.
  - facets
```
Map<String,FacetResult> facets()
```
    If one or more facet were requested via the SearchQuery#addFacets(SearchFacet...) method when querying, contains the result of each facet. The map keys are the names given to each requested facet.
  - metrics
```
SearchMetrics metrics()
```
    Provides a SearchMetrics object giving statistics on the request like number of hits, total time taken…
  - iterator
```
Iterator<SearchQueryRow> iterator()
```
    Returns an iterator over the hits (SearchQueryRow). If an execution error happened, the corresponding exception is thrown instead (same as attempting to iterate over hitsOrFail()).
    
    Specified by:
    
    iterator in interface Iterable<SearchQueryRow>
    
    Returns:
    
    an Iterator of rows/hits.

Interface SearchQueryResult

Method Summary

Methods inherited from interface java.lang.Iterable

Method Detail

status

hits

hitsOrFail

errors

facets

metrics

iterator