elasticmagic/dev.evo.elasticmagic/BaseSearchQuery

BaseSearchQuery

abstract class BaseSearchQuery<S : BaseDocSource, T : BaseSearchQuery<S, T>>(docSourceFactory: (obj: Deserializer.ObjectCtx) -> S, query: QueryExpression? = null, params: Params = Params())

An abstract class that holds all the search query builder methods. Inheritors of the class can implement some shortcut methods. For instance SearchQuery.execute which can be suspendable or blocking.

Constructors

BaseSearchQuery

fun <S : BaseDocSource> BaseSearchQuery(docSourceFactory: (obj: Deserializer.ObjectCtx) -> S, query: QueryExpression? = null, params: Params = Params())

Types

Companion

object Companion

Functions

aggs

fun aggs(clear: SearchQuery.CLEAR): T

Clears the existing aggregations.

fun aggs(vararg aggregations: Pair<String, Aggregation<*>>): T

fun aggs(aggregations: Map<String, Aggregation<*>>): T

Adds aggregations to the existing query aggregations.

beforeExecute

open fun beforeExecute()

Method is called before query execution. Can be overriden in subclasses of SearchQuery.

clone

fun clone(): T

Clones this search query builder.

docvalueFields

fun docvalueFields(clear: SearchQuery.CLEAR): T

Clears current search query doc value fields.

fun docvalueFields(vararg fields: FieldFormat): T

fun docvalueFields(fields: List<FieldFormat>): T

Adds fields to the search query doc value fields list.

ext

fun ext(clear: SearchQuery.CLEAR): T

Clears current search query extensions.

fun ext(vararg extensions: SearchExt): T

fun ext(extensions: List<SearchExt>): T

Adds extensions to the search query extensions list.

fields

fun fields(clear: SearchQuery.CLEAR): T

Clears current search query retrieval fields.

fun fields(vararg fields: FieldFormat): T

fun fields(fields: List<FieldFormat>): T

Adds fields to the search query retrieval fields list.

filter

fun filter(clear: SearchQuery.CLEAR): T

Clears the existing filters.

fun filter(vararg filters: QueryExpression): T

Combines all the filter expressions together and wraps the existing query using the dev.evo.elasticmagic.query.Bool query expression.

fun filter(filters: List<QueryExpression>): T

from

fun from(from: Int?): T

Sets a number of hits to skip in a search result.

postFilter

fun postFilter(clear: SearchQuery.CLEAR): T

Clears the existing post filters.

fun postFilter(vararg filters: QueryExpression): T

fun postFilter(filters: List<QueryExpression>): T

Filter expressions in the post filter will be applied after the aggregations are calculated. Useful for building faceted filtering.

prepareCount

fun prepareCount(params: Params? = null): SearchQuery.Count

prepareDelete

fun prepareDelete(params: Params? = null): SearchQuery.Delete

prepareSearch

fun prepareSearch(params: Params? = null): SearchQuery.Search<S>

Makes an immutable view of the search query. Be careful when using this method.

prepareUpdate

fun prepareUpdate(script: Script? = null, params: Params? = null): SearchQuery.Update

query

fun query(query: QueryExpression?): T

Replaces main query expression.

queryNode

inline fun <N : QueryExpression> queryNode(handle: NodeHandle<N>, block: (N) -> N): T

Allows to replace a specific query expression node using a handle of the node.

requestCache

fun requestCache(requestCache: Boolean?): T

Enables/disables a request cache of the search query.

rescore

fun rescore(clear: SearchQuery.CLEAR): T

Clears the existing rescorers.

fun rescore(vararg rescores: Rescore): T

Adds rescores to the existing query rescorers. Rescoring is executed after post filter phase.

fun rescore(rescores: List<Rescore>): T

routing

fun routing(routing: Long?): T

Sets a routing parameter of the search query. A search request will be send to a specific shard.

fun routing(routing: String?): T

Updates search type of the search query.

runtimeMappings

fun runtimeMappings(clear: SearchQuery.CLEAR): T

Clears current search query runtime fields.

fun runtimeMappings(vararg fields: BoundRuntimeField<*>): T

fun runtimeMappings(fields: List<BoundRuntimeField<*>>): T

Adds fields to the search query runtime fields list.

scriptFields

fun scriptFields(clear: SearchQuery.CLEAR): T

Clears current search query stored fields.

fun scriptFields(vararg fields: Pair<String, Script>): T

fun scriptFields(fields: Map<String, Script>): T

Adds fields to the search query script fields list.

searchParams

fun searchParams(vararg params: Pair<String, Any?>): T

fun searchParams(params: Map<String, Any?>): T

Updates search parameters.

searchType

fun searchType(searchType: SearchType?): T

Updates search type of the search query.

seqNoPrimaryTerm

fun seqNoPrimaryTerm(seqNoPrimaryTerm: Boolean?): T

Specifies if a sequence number and a primary term should be returned within a hit.

setTimeout

fun setTimeout(timeout: Duration?): T

Sets a timeout for the search query.

size

fun size(size: Int?): T

Sets a maximum number of hits in a search result.

sort

fun sort(clear: SearchQuery.CLEAR): T

Clears the existing sorts.

fun sort(vararg sorts: Sort): T

Adds sorts to the existing query sorting expressions.

fun sort(sorts: List<Sort>): T

Adds sorts from a list to the existing query sorting expressions.

source

fun source(clear: SearchQuery.CLEAR): T

Clears source filtering values that were previously set.

fun source(vararg includes: FieldOperations<*>): T

Adds includes field lists to the document source fields filtering.

fun source(enable: Boolean): T

Disables or enables document's source filtering.

fun source(includes: List<FieldOperations<*>> = emptyList(), excludes: List<FieldOperations<*>> = emptyList()): T

Adds includes and excludes field lists to the document source fields filtering.

stats

fun stats(tag: String?): T

Marks the search query with a tag so it is possible to collect search query statistics by tags.

storedFields

fun storedFields(clear: SearchQuery.CLEAR): T

Clears current search query stored fields.

fun storedFields(vararg fields: FieldOperations<*>): T

fun storedFields(fields: List<FieldOperations<*>>): T

Adds fields to the search query stored fields list.

terminateAfter

fun terminateAfter(terminateAfter: Int?): T

Sets a maximum number of matched documents per shard after which the query should be terminated.

trackScores

fun trackScores(trackScores: Boolean?): T

If trackScores is true forces computing scores even when sorting on a field.

trackTotalHits

fun trackTotalHits(trackTotalHits: Boolean?): T

When trackTotalHits is true the search query will always count the total number of hits that match the query.

version

fun version(version: Boolean?): T

Enables/disables a document version to be returned within a hit.

Inheritors

SearchQuery