elastic4s-domain
API
Generated with
elastic4s-domain/com.sksamuel.elastic4s/com.sksamuel.elastic4s.requests/com.sksamuel.elastic4s.requests.searches/SearchRequest

SearchRequest

com.sksamuel.elastic4s.requests.searches.SearchRequest
case class SearchRequest(indexes: Indexes, aggs: Seq[AbstractAggregation], collapse: Option[CollapseRequest], docValues: Seq[String], scriptFields: Seq[ScriptField], storedFields: Seq[String], fetchContext: Option[FetchSourceContext], pref: Option[String], routing: Option[String], terminateAfter: Option[Int], timeout: Option[Duration], minScore: Option[Double], rescorers: Seq[Rescore], trackScores: Option[Boolean], indicesOptions: Option[IndicesOptionsRequest], inners: Seq[InnerHit], indexBoosts: Seq[(String, Double)], keepAlive: Option[String], highlight: Option[Highlight], query: Option[Query], postFilter: Option[Query], requestCache: Option[Boolean], sorts: Seq[Sort], suggs: Seq[Suggestion], globalSuggestionText: Option[String], from: Option[Int], size: Option[Int], slice: Option[(Int, Int)], explain: Option[Boolean], stats: Seq[String], searchType: Option[SearchType], searchAfter: Seq[Any], version: Option[Boolean], seqNoPrimaryTerm: Option[Boolean], profile: Option[Boolean], source: Option[String], trackHits: Option[Boolean], allowPartialSearchResults: Option[Boolean], batchedReduceSize: Option[Int], typedKeys: Option[Boolean], runtimeMappings: Seq[RuntimeMapping], ext: Map[String, Any], knn: Option[Knn], multipleKnn: Seq[Knn])

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def aggs(iterable: Iterable[AbstractAggregation]): SearchRequest
def bool(block: => BoolQuery): SearchRequest
def docValues(first: String, rest: String*): SearchRequest
def docValues(_fields: Seq[String]): SearchRequest
def explain(enabled: Boolean): SearchRequest
def ext(ext: Map[String, Any]): SearchRequest
def fetchSource(fetch: Boolean): SearchRequest
def from(i: Int): SearchRequest
def globalSuggestionText(text: String): SearchRequest
def highlighting(fields: Iterable[HighlightField]): SearchRequest
def highlighting(options: HighlightOptions, fields: Iterable[HighlightField]): SearchRequest
def indexBoost(map: Map[String, Double]): SearchRequest
def indexBoost(tuples: (String, Double)*): SearchRequest
def inner(first: InnerHit, rest: InnerHit*): SearchRequest
def inner(inners: Iterable[InnerHit]): SearchRequest
def keepAlive(keepAlive: String): SearchRequest
def keepAlive(duration: FiniteDuration): SearchRequest
def knn(knn: Knn): SearchRequest
def limit(i: Int): SearchRequest
def matchQuery(field: String, value: Any): SearchRequest
def minScore(min: Double): SearchRequest
def multipleKnn(multipleKnn: Iterable[Knn]): SearchRequest
def postFilter(block: => Query): SearchRequest
def preference(pref: String): SearchRequest
def prefix(name: String, value: Any): SearchRequest
def query(string: String): SearchRequest

Adds a single string query to this search

Adds a single string query to this search

Value parameters

string

the query string

Attributes

def rawQuery(json: String): SearchRequest

Expects a query in json format and sets the query of the search request. i.e. underneath a "query" field if referencing HTTP API Query must be valid json beginning with '{' and ending with '}'. Field names must be double quoted.

Expects a query in json format and sets the query of the search request. i.e. underneath a "query" field if referencing HTTP API Query must be valid json beginning with '{' and ending with '}'. Field names must be double quoted.

Example:

search in "*" limit 5 rawQuery {
"""{ "prefix": { "bands": { "prefix": "coldplay", "boost": 5.0, "rewrite": "yes" } } }"""
} searchType SearchType.Scan

Attributes

def regexQuery(tuple: (String, String)): SearchRequest
def regexQuery(field: String, value: String): SearchRequest
def requestCache(requestCache: Boolean): SearchRequest
def rescore(first: Rescore, rest: Rescore*): SearchRequest
def rescore(rescorers: Iterable[Rescore]): SearchRequest
def routing(r: String): SearchRequest
def runtimeMappings(mappings: Iterable[RuntimeMapping]): SearchRequest
def scriptfields(fields: ScriptField*): SearchRequest

This method introduces zero or more script field definitions into the search construction

This method introduces zero or more script field definitions into the search construction

Value parameters

fields

zero or more ScriptField instances

Attributes

Returns

this, an instance of SearchRequest

def scriptfields(_fields: Iterable[ScriptField]): SearchRequest
def scroll(keepAlive: String): SearchRequest
def scroll(duration: FiniteDuration): SearchRequest
def searchAfter(values: Seq[Any]): SearchRequest
def searchType(searchType: SearchType): SearchRequest
def seqNoPrimaryTerm(seqNoPrimaryTerm: Boolean): SearchRequest
def size(i: Int): SearchRequest
def slice(id: Int, max: Int): SearchRequest
def sortBy(sorts: Sort*): SearchRequest
def sortBy(sorts: Iterable[Sort]): SearchRequest
def sortByFieldAsc(name: String): SearchRequest
def sortByFieldDesc(name: String): SearchRequest
def source(json: String): SearchRequest

Sets the source of the request as a json string. Note, if you use this method any other body-level settings will be ignored.

Sets the source of the request as a json string. Note, if you use this method any other body-level settings will be ignored.

HTTP query-parameter settings can still be used, eg limit, routing, search type etc.

Unlike rawQuery, source is parsed at the "root" level Query must be valid json beginning with '{' and ending with '}'. Field names must be double quoted.

NOTE: This method only works with the HTTP client.

Example:

search in "*" limit 5 source {
"""{ "query": { "prefix": { "bands": { "prefix": "coldplay", "boost": 5.0, "rewrite": "yes" } } } }"""
} searchType SearchType.Scan

Attributes

def sourceExclude(first: String, rest: String*): SearchRequest
def sourceExclude(excludes: Iterable[String]): SearchRequest
def sourceFiltering(includes: Iterable[String], excludes: Iterable[String]): SearchRequest
def sourceInclude(first: String, rest: String*): SearchRequest
def sourceInclude(includes: Iterable[String]): SearchRequest
def start(i: Int): SearchRequest
def stats(groups: String*): SearchRequest
def storedFields(first: String, rest: String*): SearchRequest
def storedFields(_fields: Iterable[String]): SearchRequest
def suggestions(first: Suggestion, rest: Suggestion*): SearchRequest

Adds a new suggestion to the search request, which can be looked up in the response using the name provided.

Adds a new suggestion to the search request, which can be looked up in the response using the name provided.

Attributes

def suggestions(suggs: Iterable[Suggestion]): SearchRequest
def termQuery(tuple: (String, Any)): SearchRequest
def termQuery(field: String, value: Any): SearchRequest
def terminateAfter(terminateAfter: Int): SearchRequest

The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. If set, the response will have a boolean field terminated_early to indicate whether the query execution has actually terminated early. Defaults to no.

The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early. If set, the response will have a boolean field terminated_early to indicate whether the query execution has actually terminated early. Defaults to no.

Attributes

def timeout(timeout: FiniteDuration): SearchRequest
def trackScores(enabled: Boolean): SearchRequest
def trackTotalHits(value: Boolean): SearchRequest
def typedKeys(enabled: Boolean): SearchRequest
def version(version: Boolean): SearchRequest

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with