Skip to content
Merged
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions src/platform/plugins/shared/esql/AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,30 @@ used by the ES|QL plugin and other consumers.
- Commands: definitions and registry for ES|QL commands.
- Composer API: safe, parameterized ES|QL builder for app code.

### kbn-esql-language data flow
```mermaid
flowchart LR
Grammar["ESQL grammar (synced from Elasticsearch)"] --> Parser["Parser (ANTLR)"]
Query["ESQL query text"] --> Parser
Parser --> CST["CST"]
CST --> AST["ESQL AST"]

Builder["Builder API"] --> AST
Composer["Composer API"] --> AST
Walker["Walker/Mutate"] --> AST
AST --> PrettyPrint["Pretty printing"]

Definitions["Definitions"] --> Registry["Commands registry"]
Registry --> Validation["Validation"]
Registry --> Autocomplete["Autocomplete/Suggest"]
Callbacks["ESQL callbacks: sources/fields"] --> Validation
Callbacks --> Autocomplete

AST --> Validation
AST --> Autocomplete
AST --> Hover["Hover/Signature help"]
```

### Key behavior
- Parser produces partial AST even with invalid queries; `withFormatting` attaches
comments/whitespace to nodes for editor features.
Expand Down
Loading