🚧 Under construction 🚧

Elastic ES|QL JS

The purpose of this package is to provide comprehensive ES|QL functionality including low-level parsing, building, traversal, pretty-printing and manipulation features on top of a custom compact AST representation.

Installation

npm	yarn	pnpm
npm install @elastic/esql	yarn add @elastic/esql	pnpm add @elastic/esql

Requirements

• Node.js >= 18.0.0

Contents of the package

Creating an ES|QL AST

This package offers 3 tools that allow creating an AST for a query.

The parser allows to convert a query in text form into an AST.

import { Parser } from '@elastic/esql';

const src = 'FROM index | WHERE col0 > 100';
const { root, errors } = await Parser.parse(src);

The composer provides a high-level, secure, and developer-friendly way to build ES|QL queries, allowing to get both an AST or string representation of them.

import { esql } from '@elastic/esql';

const param = 123; // Dynamic parameter, e.g. received from the UI.

const query = esql`
  FROM index
    | WHERE @timestamp >= ${{ param }}
    | SORT @timestamp DESC
    | KEEP service.name, log.level`;

query.pipe`LIMIT 10`;

Check also the synth API for building independent nodes.

The builder is a low level API that allows to create AST nodes.

import { Builder } from '@elastic/esql';

const limitCommandASTNode = Builder.command({
    name: 'limit',
    args: [Builder.expression.literal.integer(10)],
});

Traversing an ES|QL AST

This package exposes 2 ways of traversing an ES|QL AST.

The walker class is simpler to use, the developer can provide a set of callbacks which are called when the walker visits a specific type of node.

import { Walker } from '@elastic/esql';

const walker = new Walker({
  visitCommand: (node: ESQLCommand) => {
    // Called for every command node.
  },
  visitFunction: (fn: ESQLFunction) => {
    // Called every time a function expression is visited.
  },
});

walker.walk(ast);

The visitor API provides a feature-rich way to traverse the ES|QL AST. It is more powerful than the Walker API, as it allows to traverse the AST in a more flexible way. Said that, it's also more complicated to use as it does not automatically traverse the entire tree, read its dedicated documentation to get insights on it.

import { Visitor } from '@elastic/esql';

new Visitor()
  .on('visitExpression', (ctx) => console.log(ctx.node.type))
  .on('visitCommand', (ctx) => [...ctx.visitArguments()])
  .on('visitQuery', (ctx) => [...ctx.visitCommands()])
  .visitQuery(root);

Modifying an ES|QL AST

The mutate API provides methods to navigate and modify the AST.

import { Parser, mutate, BasicPrettyPrinter } from '@elastic/esql';

const { root } = Parser.parse('FROM index METADATA _lang');

// [ '_lang' ]
console.log([...mutate.commands.from.metadata.list(root)]); 

mutate.commands.from.metadata.upsert(root, '_id');

// [ '_lang', '_id' ]
console.log([...mutate.commands.from.metadata.list(root)]); 

const src = BasicPrettyPrinter.print(root);

// FROM index METADATA _lang, _id
console.log(src); 

Pretty printing

The pretty_print API lets you format the AST to text.

import { parse, WrappingPrettyPrinter } from '@elastic/esql';

const src = 'FROM index | WHERE x > 100 | LIMIT 100';
const { root } = parse(src, { withFormatting: true });
const text = WrappingPrettyPrinter.print(root, { multiline: true });

/**
  FROM index
  | WHERE x > 100
  | LIMIT 100
*/
console.log(text);

Licence

Licensed under Elastic License 2.0.