Test run of new docs
This commit is contained in:
Josh Mock
127
docs/reference-search.asciidoc
Normal file
127
docs/reference-search.asciidoc
Normal file
@ -0,0 +1,127 @@
|
||||
[[reference-search]]
|
||||
|
||||
////////
|
||||
===========================================================================================================================
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|
||||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|
||||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|
||||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|
||||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|
||||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|
||||
|| You should update the script that does the generation, which can be found in: ||
|
||||
|| https://github.com/elastic/elastic-client-generator-js ||
|
||||
|| ||
|
||||
|| You can run the script with the following command: ||
|
||||
|| npm run elasticsearch -- --version <version> ||
|
||||
|| ||
|
||||
|| ||
|
||||
|| ||
|
||||
===========================================================================================================================
|
||||
////////
|
||||
|
||||
[discrete]
|
||||
=== client.search
|
||||
|
||||
Run a search. Get search hits that match the query defined in the request. You can provide search queries using the `q` query string parameter or the request body. If both are specified, only the query parameter is used.
|
||||
|
||||
{ref}/search-search.html[{es} documentation]
|
||||
|
||||
[discrete]
|
||||
==== Function signature
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
(SearchRequest, options?): Promise<SearchResponse>
|
||||
----
|
||||
|
||||
[discrete]
|
||||
===== `SearchRequest`
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
interface SearchRequest extends <<shared-type-request-base, RequestBase>> {
|
||||
index?: <<shared-type-indices, Indices>>
|
||||
allow_no_indices?: boolean
|
||||
allow_partial_search_results?: boolean
|
||||
analyzer?: string
|
||||
analyze_wildcard?: boolean
|
||||
batched_reduce_size?: <<shared-type-long, long>>
|
||||
ccs_minimize_roundtrips?: boolean
|
||||
default_operator?: QueryDslOperator
|
||||
df?: string
|
||||
expand_wildcards?: <<shared-type-expand-wildcards, ExpandWildcards>>
|
||||
ignore_throttled?: boolean
|
||||
ignore_unavailable?: boolean
|
||||
include_named_queries_score?: boolean
|
||||
lenient?: boolean
|
||||
max_concurrent_shard_requests?: <<shared-type-long, long>>
|
||||
min_compatible_shard_node?: <<shared-type-version-string, VersionString>>
|
||||
preference?: string
|
||||
pre_filter_shard_size?: <<shared-type-long, long>>
|
||||
request_cache?: boolean
|
||||
routing?: <<shared-type-routing, Routing>>
|
||||
scroll?: <<shared-type-duration, Duration>>
|
||||
search_type?: <<shared-type-search-type, SearchType>>
|
||||
suggest_field?: <<shared-type-field, Field>>
|
||||
suggest_mode?: <<shared-type-suggest-mode, SuggestMode>>
|
||||
suggest_size?: <<shared-type-long, long>>
|
||||
suggest_text?: string
|
||||
typed_keys?: boolean
|
||||
rest_total_hits_as_int?: boolean
|
||||
_source_excludes?: <<shared-type-fields, Fields>>
|
||||
_source_includes?: <<shared-type-fields, Fields>>
|
||||
q?: string
|
||||
force_synthetic_source?: boolean
|
||||
aggregations?: Record<string, AggregationsAggregationContainer>
|
||||
/** @alias aggregations */
|
||||
aggs?: Record<string, AggregationsAggregationContainer>
|
||||
collapse?: SearchFieldCollapse
|
||||
explain?: boolean
|
||||
ext?: Record<string, any>
|
||||
from?: <<shared-type-integer, integer>>
|
||||
highlight?: SearchHighlight
|
||||
track_total_hits?: SearchTrackHits
|
||||
indices_boost?: Record<<<shared-type-index-name, IndexName>>, <<shared-type-double, double>>>[]
|
||||
docvalue_fields?: (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
|
||||
knn?: <<shared-type-knn-search, KnnSearch>> | <<shared-type-knn-search, KnnSearch>>[]
|
||||
rank?: <<shared-type-rank-container, RankContainer>>
|
||||
min_score?: <<shared-type-double, double>>
|
||||
post_filter?: QueryDslQueryContainer
|
||||
profile?: boolean
|
||||
query?: QueryDslQueryContainer
|
||||
rescore?: SearchRescore | SearchRescore[]
|
||||
retriever?: <<shared-type-retriever-container, RetrieverContainer>>
|
||||
script_fields?: Record<string, <<shared-type-script-field, ScriptField>>>
|
||||
search_after?: <<shared-type-sort-results, SortResults>>
|
||||
size?: <<shared-type-integer, integer>>
|
||||
slice?: <<shared-type-sliced-scroll, SlicedScroll>>
|
||||
sort?: <<shared-type-sort, Sort>>
|
||||
_source?: SearchSourceConfig
|
||||
fields?: (QueryDslFieldAndFormat | <<shared-type-field, Field>>)[]
|
||||
suggest?: SearchSuggester
|
||||
terminate_after?: <<shared-type-long, long>>
|
||||
timeout?: string
|
||||
track_scores?: boolean
|
||||
version?: boolean
|
||||
seq_no_primary_term?: boolean
|
||||
stored_fields?: <<shared-type-fields, Fields>>
|
||||
pit?: SearchPointInTimeReference
|
||||
runtime_mappings?: MappingRuntimeFields
|
||||
stats?: string[]
|
||||
}
|
||||
----
|
||||
|
||||
[discrete]
|
||||
===== `SearchResponse`
|
||||
|
||||
[source,ts]
|
||||
----
|
||||
type SearchResponse<TDocument = unknown, TAggregations = Record<<<shared-type-aggregate-name, AggregateName>>, AggregationsAggregate>> = SearchResponseBody<TDocument, TAggregations>
|
||||
----
|
||||
|
||||
Reference in New Issue
Block a user