habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update ESQL helper types (#2738) (#2739)

Browse Source 
Co-authored-by: Josh Mock <joshua.mock@elastic.co>
This commit is contained in:
github-actions[bot]
2025-04-14 12:45:12 -05:00
committed by GitHub
parent f17bfaddf6
commit af0188d1d4
1 changed files with 6 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
src/helpers.ts
View File

@ -132,15 +132,6 @@ export interface EsqlColumn {
type: string type: string
} }
export type EsqlValue = any[]
export type EsqlRow = EsqlValue[]
export interface EsqlResponse {
columns: EsqlColumn[]
values: EsqlRow[]
}
export interface EsqlHelper { export interface EsqlHelper {
toRecords: <TDocument>() => Promise<EsqlToRecords<TDocument>> toRecords: <TDocument>() => Promise<EsqlToRecords<TDocument>>
toArrowTable: () => Promise<Table<TypeMap>> toArrowTable: () => Promise<Table<TypeMap>>
@ -963,7 +954,7 @@ export default class Helpers {
esql (params: T.EsqlQueryRequest, reqOptions: TransportRequestOptions = {}): EsqlHelper { esql (params: T.EsqlQueryRequest, reqOptions: TransportRequestOptions = {}): EsqlHelper {
const client = this[kClient] const client = this[kClient]
function toRecords<TDocument> (response: EsqlResponse): TDocument[] { function toRecords<TDocument> (response: T.EsqlEsqlResult): TDocument[] {
const { columns, values } = response const { columns, values } = response
return values.map(row => { return values.map(row => {
const doc: Partial<TDocument> = {} const doc: Partial<TDocument> = {}
@ -990,8 +981,7 @@ export default class Helpers {
params.format = 'json' params.format = 'json'
params.columnar = false params.columnar = false
// @ts-expect-error it's typed as ArrayBuffer but we know it will be JSON const response = await client.esql.query(params, reqOptions)
const response: EsqlResponse = await client.esql.query(params, reqOptions)
const records: TDocument[] = toRecords(response) const records: TDocument[] = toRecords(response)
const { columns } = response const { columns } = response
return { records, columns } return { records, columns }
@ -1005,7 +995,8 @@ export default class Helpers {
params.format = 'arrow' params.format = 'arrow'
const response = await client.esql.query(params, reqOptions) // @ts-expect-error the return type will be ArrayBuffer when the format is set to 'arrow'
const response: ArrayBuffer = await client.esql.query(params, reqOptions)
return tableFromIPC(response) return tableFromIPC(response)
}, },
@ -1018,7 +1009,8 @@ export default class Helpers {
params.format = 'arrow' params.format = 'arrow'
const response = await client.esql.query(params, reqOptions) // @ts-expect-error the return type will be ArrayBuffer when the format is set to 'arrow'
const response: ArrayBuffer = await client.esql.query(params, reqOptions)
return RecordBatchStreamReader.from(response) return RecordBatchStreamReader.from(response)
} }
} }