Elasticsearch DSL for JavaScript/TypeScript

Fluent, type-safe DSL libraries for building Elasticsearch queries in JavaScript and TypeScript.

Install the package you need:

npm install @elastic/elasticsearch-esql-dsl
		

Then build and execute queries:

import { Client } from '@elastic/elasticsearch'
import { ESQL, E } from '@elastic/elasticsearch-esql-dsl'

const client = new Client({ node: 'http://localhost:9200' })

const query = ESQL.from('employees')
  .where(E('still_hired').eq(true))
  .sort(E('last_name').asc())
  .limit(10)

const response = await client.esql.query({ query: query.render() })
		

The DSL generates ES|QL query strings and does not depend on any specific Elasticsearch version at runtime. However, individual ES|QL commands were introduced in different Elasticsearch versions. The table below shows the minimum Elasticsearch version required for each command.

Core commands available since ES|QL GA (Elasticsearch 8.11+):

Commands introduced in later versions:

• ES|QL query builder — Build ES|QL queries using JavaScript/TypeScript syntax