KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #developer-tools #ai-agent #claude-code #codex #typescript #ai-agents #deepseek-harness #mcp #cli #rust

sqltoes

★ 20 Open GitHub ↗

convert SQL-like queries to Elasticsearch commands

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

sqltoes (sql to ES)
=========

#### Writing elasticsearch commands is hard, writing SQL queries is...less hard

Motivation: Elasticsearch commands are [confusing to write](https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html) at a certain point. See the Elasticsearch [reference](https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html) for more help.

### Installation

npm install sqltoes

### Use

```js
var sqltoes = require('sqltoes')
var query = {select: ['sum(value)'], where: ['commodity = rice'], groupBy: ['description','year']}

sqltoes(query)
// { aggs: { where_commodity_rice: { filter: [Object], aggs: [Object] } } }

JSON.stringify(sqltoes(query))
// '{"aggs":{"where_commodity_rice":{"filter":{"term":{"commodity":"rice"}},"aggs":{"group_by_description":{"terms":{"field":"description","size":1000},"aggs":{"group_by_year":{"terms":{"field":"year","size":1000},"aggs":{"sum_value":{"sum":{"field":"value"}}}}}}}}}}'
```

### How it works (and what works so far)

Looks for three properties: `select`, `where`, and `groupBy` (currently requires them all)

- Anything in the `select` clause is ignored unless it is wrapped in `sum, min, max, or avg` all of which become a [final aggregation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-aggregations-metrics-sum-aggregation.html)
- The `where` clause supports two types of queries:
  - `[field] = [value]` will be treated as a [term filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-term-filter.html).
  - `[field] in ([value1],value[2])` will be treated as a [terms filter](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl-terms-filter.html).
- Anything in the `groupBy` clause is treated like the second example shown [here](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/_executing_aggregations.html).

### Similar works
- [`sql-where-parser`](https://github.com/shaunpersad/sql-where-parser)
- [`sql2es`](https://github.com/feifeiiiiiiiiiii/sql2es)
- [`sql-es`](https://github.com/ryankirkman/sql-es)

sqltoes

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README