github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/docs/development/plugins/data/server/kibana-plugin-plugins-data-server.isearchstart.md
Lukas Olson 44368b0b66
[data.search] Add request handler context and asScoped pattern (#80775) 
* [Search] Add request context and asScoped pattern

* Update docs

* Unify interface for getting search client

* Update examples/search_examples/server/my_strategy.ts

Co-authored-by: Anton Dosov <dosantappdev@gmail.com>

* Review feedback

* Fix checks

* Fix CI

* Fix security search

* Fix test

* Fix test for reals

* Fix types

Co-authored-by: Anton Dosov <dosantappdev@gmail.com>
2020-11-04 11:58:15 -07:00

1.4 KiB
Raw Blame History

Home > kibana-plugin-plugins-data-server > ISearchStart

ISearchStart interface

Signature:

export interface ISearchStart<SearchStrategyRequest extends IKibanaSearchRequest = IEsSearchRequest, SearchStrategyResponse extends IKibanaSearchResponse = IEsSearchResponse>

Properties

Property Type Description
aggs AggsStart
asScoped (request: KibanaRequest) => ISearchClient
getSearchStrategy (name?: string) => ISearchStrategy<SearchStrategyRequest, SearchStrategyResponse> Get other registered search strategies by name (or, by default, the Elasticsearch strategy). For example, if a new strategy needs to use the already-registered ES search strategy, it can use this function to accomplish that.
searchSource {
asScoped: (request: KibanaRequest) => Promise<ISearchStartSearchSource>;
}