habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
api-reference-docs
elasticsearch-js/docs/reference/api/Esql.md
Josh Mock b140fcda7f Another round of tweaks
2025-05-28 10:02:30 -05:00

7.8 KiB
Raw Permalink Blame History

Esql [class-Esql]

Constructor

new Esql(transport: [Transport](./Transport.md));

Properties [class-properties-Esql]

Name Type Description
acceptedParams Record<string, { path: string[]; body: string[]; query: string[]; }>  
transport Transport  

Methods [class-methods-Esql]

Name Signature Description
asyncQuery asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md)>; Run an async ES
asyncQuery asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md), unknown>>;  
asyncQuery asyncQuery(this: [That](./That.md), params: [EsqlAsyncQueryRequest](./EsqlAsyncQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryResponse](./EsqlAsyncQueryResponse.md)>;  
asyncQueryDelete asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md)>; Delete an async ES
asyncQueryDelete asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md), unknown>>;  
asyncQueryDelete asyncQueryDelete(this: [That](./That.md), params: [EsqlAsyncQueryDeleteRequest](./EsqlAsyncQueryDeleteRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryDeleteResponse](./EsqlAsyncQueryDeleteResponse.md)>;  
asyncQueryGet asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md)>; Get async ES
asyncQueryGet asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md), unknown>>;  
asyncQueryGet asyncQueryGet(this: [That](./That.md), params: [EsqlAsyncQueryGetRequest](./EsqlAsyncQueryGetRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryGetResponse](./EsqlAsyncQueryGetResponse.md)>;  
asyncQueryStop asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md)>; Stop async ES
asyncQueryStop asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md), unknown>>;  
asyncQueryStop asyncQueryStop(this: [That](./That.md), params: [EsqlAsyncQueryStopRequest](./EsqlAsyncQueryStopRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlAsyncQueryStopResponse](./EsqlAsyncQueryStopResponse.md)>;  
getQuery getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md)>; Get a specific running ES
getQuery getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md), unknown>>;  
getQuery getQuery(this: [That](./That.md), params: [EsqlGetQueryRequest](./EsqlGetQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlGetQueryResponse](./EsqlGetQueryResponse.md)>;  
listQueries listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md)>; Get running ES
listQueries listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md), unknown>>;  
listQueries listQueries(this: [That](./That.md), params?: [EsqlListQueriesRequest](./EsqlListQueriesRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlListQueriesResponse](./EsqlListQueriesResponse.md)>;  
query query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptionsWithOutMeta](./TransportRequestOptionsWithOutMeta.md)): Promise<[EsqlQueryResponse](./EsqlQueryResponse.md)>; Run an ES
query query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptionsWithMeta](./TransportRequestOptionsWithMeta.md)): Promise<[TransportResult](./TransportResult.md)<[EsqlQueryResponse](./EsqlQueryResponse.md), unknown>>;  
query query(this: [That](./That.md), params: [EsqlQueryRequest](./EsqlQueryRequest.md), options?: [TransportRequestOptions](./TransportRequestOptions.md)): Promise<[EsqlQueryResponse](./EsqlQueryResponse.md)>;