elasticsql

package
v0.0.0-...-9d95335 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 22, 2024 License: MIT Imports: 5 Imported by: 0

README

elasticsql

forked from https://github.com/cch123/elasticsql

This tool converts sql where clause to elasticsearch dsl

Currently support:

  • sql and expression
  • sql or expression
  • equal(=) support
  • not equal(!=) support
  • gt(>) support
  • gte(>=) support
  • lt(<) support
  • lte(<=) support
  • sql in (eg. id in (1,2,3) ) expression
  • sql not in (eg. id not in (1,2,3) ) expression
  • paren bool support (eg. where (a=1 or b=1) and (c=1 or d=1))
  • sql like expression (currently use match phrase, perhaps will change to wildcard in the future)
  • sql order by support
  • sql limit support
  • sql not like expression
  • field missing check
  • support aggregation like count(*), count(field), min(field), max(field), avg(field)
  • support aggregation like stats(field), extended_stats(field), percentiles(field) which are not standard sql function
  • null check expression(is null/is not null)
  • join expression
  • having support

Usage

go get -u github.com/cch123/elasticsql

Demo :

package main

import (
	"fmt"

	"github.com/bingoohuang/gg/pkg/elasticsql"
)

var where = `
a=1 and x = '三个男人'
and create_time between '2015-01-01T00:00:00+0800' and '2016-01-01T00:00:00+0800'
and process_id > 1 order by id desc limit 100,10
`

func main() {
	dsl, _ := elasticsql.Convert(where)
	fmt.Println(dsl)
}

will produce :

{
  "query": {
    "bool": {
      "must": [
        {
          "match": {
            "a": {
              "query": "1",
              "type": "phrase"
            }
          }
        },
        {
          "match": {
            "x": {
              "query": "三个男人",
              "type": "phrase"
            }
          }
        },
        {
          "range": {
            "create_time": {
              "from": "2015-01-01T00:00:00+0800",
              "to": "2016-01-01T00:00:00+0800"
            }
          }
        },
        {
          "range": {
            "process_id": {
              "gt": "1"
            }
          }
        }
      ]
    }
  },
  "from": 100,
  "size": 10,
  "sort": [
    {
      "id": "desc"
    }
  ]
}

If your sql contains some keywords, eg. order, timestamp, don't forget to escape these fields as follows:

select * from `order` where `timestamp` = 1 and `desc`.id > 0

Warning

To use this tool, you need to understand the term query and match phrase query of elasticsearch.

Setting a field to analyzed or not analyzed will get different results.

Details

For more details of convertion, please refer to the wiki

Other info

When writing this tool, I tried to avoid the deprecated dsl filters and aggregations, so it is compatible with most versions of the elasticsearch

If you have any advices or ideas, welcome to submit an issue or Pull Request!

License

MIT

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Convert

func Convert(sql string) (dsl string, err error)

Convert will transform sql to elasticsearch dsl string

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL