esquerydsl

KO | EN

gitlite — search

#ai #golang #machine-learning #rust #deep-learning #docker #macos #java #windows #awesome #cli #awesome-list #security #open-source

(★ 38)

Safely create complex ES Search Queries via the Query DSL in golang

esquerydsl Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

![build](https://github.com/mottaquikarim/esquerydsl/workflows/Build%20Status/badge.svg) [![GoDoc](https://godoc.org/github.com/mottaquikarim/esquerydsl?status.svg)](https://godoc.org/github.com/mottaquikarim/esquerydsl) [![Go Report Card](https://goreportcard.com/badge/github.com/mottaquikarim/esquerydsl)](https://goreportcard.com/report/github.com/mottaquikarim/esquerydsl) [![Maintainability](https://api.codeclimate.com/v1/badges/0c5ab314f03a459ce286/maintainability)](https://codeclimate.com/github/mottaquikarim/esquerydsl/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/0c5ab314f03a459ce286/test_coverage)](https://codeclimate.com/github/mottaquikarim/esquerydsl/test_coverage)
# [ES Query DSL](https://godoc.org/github.com/mottaquikarim/esquerydsl)
Structs and marshal-ers that help wrangle writing elastic search queries using the [ES query DSL](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl.html) spec

## Installation

```bash
go get github.com/mottaquikarim/esquerydsl
```

## Usage

(You can copy paste the snippet below into [playground](https://play.golang.org/) and see for yourself)

```go
package main

import (
	"encoding/json"
	"fmt"

"github.com/mottaquikarim/esquerydsl"
)

func main() {
	body, _ := json.Marshal(esquerydsl.QueryDoc{
		Index: "some_index",
		Sort:  []map[string]string{map[string]string{"id": "asc"}},
		And: []esquerydsl.QueryItem{
			esquerydsl.QueryItem{
				Field: "some_index_id",
				Value: "some-long-key-id-value",
				Type:  esquerydsl.Match,
			},
		},
	})
	fmt.Println(string(body))
	// {"query":{"bool":{"must":[{"match":{"some_index_id":"some-long-key-id-value"}}]}},"sort":[{"id":"asc"}]}
}

```

(Please find additional examples in the unit tests)

### MultiSearch Support

```go
package main

import (
	"fmt"

"github.com/mottaquikarim/esquerydsl"
)

func main() {
	doc, _ := esquerydsl.MultiSearchDoc([]esquerydsl.QueryDoc{
		esquerydsl.QueryDoc{
			Index: "index1",
			And: []esquerydsl.QueryItem{
				esquerydsl.QueryItem{
					Field: "user.id",
					Value: "kimchy!",
					Type:  esquerydsl.QueryString,
				},
			},
		},
		esquerydsl.QueryDoc{
			Index: "index2",
			And: []esquerydsl.QueryItem{
				esquerydsl.QueryItem{
					Field: "some_index_id",
					Value: "some-long-key-id-value",
					Type:  esquerydsl.Match,
				},
			},
		},
	})
	fmt.Println(doc)
	// OUTPUT:

// {"index":"index1"}
	// {"query":{"bool":{"must":[{"query_string":{"analyze_wildcard":true,"fields":["user.id"],"query":"kimchy\\!"}}]}}}
	// {"index":"index2"}
	// {"query":{"bool":{"must":[{"match":{"some_index_id":"some-long-key-id-value"}}]}}}

// ...
	// eventually, pass this in like so:

// request := esapi.MsearchRequest{
	//	Body: strings.NewReader(doc),
	// }

}

```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

### Run Tests

```bash
make test
```

### Format

```bash
make fmt
```

### Lint

```bash
make lint
```

## License
[MIT](https://choosealicense.com/licenses/mit/)

esquerydsl

esquerydsl Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

esquerydsl

esquerydsl Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README