Skip to content

esql async search type improvements #256523

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rudolf merged 1 commit into from
Mar 9, 2026
Merged

esql async search type improvements #256523

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions ...gins/shared/data/server/search/strategies/esql_async_search/esql_async_search_strategy.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,13 @@
*/

import type { Logger } from '@kbn/core/server';
import type { TransportResult } from '@elastic/transport';
import { catchError, tap } from 'rxjs';
import { getKbnServerError } from '@kbn/kibana-utils-plugin/server';
import type { IKibanaSearchResponse, IKibanaSearchRequest } from '@kbn/search-types';
import type { SqlQueryRequest } from '@elastic/elasticsearch/lib/api/types';
import type { EsqlAsyncQueryResponse } from '@elastic/elasticsearch/lib/api/types';
import type { ESQLSearchParams } from '@kbn/es-types';
import type { WithRequiredProperty } from '@kbn/utility-types';
import { toAsyncKibanaSearchResponse } from './response_utils';
import {
getCommonDefaultAsyncSubmitParams,
Expand Down Expand Up @@ -66,11 +66,11 @@ export const esqlAsyncSearchStrategyProvider = (
meta: true,
asStream: options.stream,
}
) as unknown as Promise<TransportResult<EsqlAsyncQueryResponse, unknown>>;
);
}

function getEsqlAsyncSearch(
{ id, ...request }: IKibanaSearchRequest<ESQLQueryRequest>,
{ id, ...request }: WithRequiredProperty<IKibanaSearchRequest<ESQLQueryRequest>, 'id'>,
options: IAsyncSearchOptions,
{ esClient }: SearchStrategyDependencies
) {
Expand All @@ -84,7 +84,7 @@ export const esqlAsyncSearchStrategyProvider = (

return esClient.asCurrentUser.esql.asyncQueryGet(
{
id: id!,
id,
...params,
// FIXME: the drop_null_columns param shouldn't be needed here once https://github.com/elastic/elasticsearch/issues/138439 is resolved
drop_null_columns: request.params?.dropNullColumns,
Expand All @@ -99,11 +99,12 @@ export const esqlAsyncSearchStrategyProvider = (
}

async function submitEsqlSearch(
{ id, ...request }: IKibanaSearchRequest<ESQLQueryRequest>,
request: IKibanaSearchRequest<ESQLQueryRequest>,
options: IAsyncSearchOptions,
{ esClient }: SearchStrategyDependencies
) {
const { dropNullColumns, ...requestParams } = request.params!;
if (!request.params) throw new Error('Missing request params');
const { dropNullColumns, ...requestParams } = request.params;

const params = {
...(await getCommonDefaultAsyncSubmitParams(searchConfig, options)),
Expand Down Expand Up @@ -135,14 +136,18 @@ export const esqlAsyncSearchStrategyProvider = (
const { abortSignal, ...options } = searchOptions;
const search = async () => {
const response = await (!id
? submitEsqlSearch({ id, ...request }, options, deps)
? submitEsqlSearch(request, options, deps)
: options.retrieveResults
? stopEsqlAsyncSearch(id, options, deps)
: getEsqlAsyncSearch({ id, ...request }, options, deps));

const { body, headers, meta } = response;

return toAsyncKibanaSearchResponse(body, headers, meta?.request?.params);
return toAsyncKibanaSearchResponse(
body as EsqlAsyncQueryResponse, // We can remove this cast after https://github.com/elastic/elasticsearch-js/issues/3215
headers,
meta?.request?.params
);
};

const cancel = async () => {
Expand Down