golib
/
esquery
2
0
Fork 0
Code Pull Requests Releases Activity

Update README

This commit is contained in:
Caleb Champlin 2020-10-17 13:43:02 -06:00
parent 39f0dd59c1
commit 52ccf20965
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -76,7 +76,7 @@ func main() {
).
Size(20).
Run(
es,
es,
es.Search.WithContext(context.TODO()),
es.Search.WithIndex("test"),
)
@ -124,6 +124,7 @@ The following queries are currently supported:
| `"match_phrase_prefix"` | `MatchPhrasePrefix()` |
| `"match_all"` | `MatchAll()` |
| `"match_none"` | `MatchNone()` |
| `"multi_match"` | `MultiMatch()` |
| `"exists"` | `Exists()` |
| `"fuzzy"` | `Fuzzy()` |
| `"ids"` | `IDs()` |
@ -158,6 +159,23 @@ The following aggregations are currently supported:
| `"top_hits"` | `TopHits()` |
| `"terms"` | `TermsAgg()` |
### Supported Top Level Options
The following top level options are currently supported:
| ElasticSearch DSL | `esquery.Search` Function |
| ------------------------|--------------------------------------- |
| `"highlight"` | `Highlight()` |
| `"explain"` | `Explain()` |
| `"from"` | `From()` |
| `"postFilter"` | `PostFilter()` |
| `"query"` | `Query()` |
| `"aggs"` | `Aggs()` |
| `"size"` | `Size()` |
| `"sort"` | `Sort()` |
| `"source"` | `SourceIncludes(), SourceExcludes()` |
| `"timeout"` | `Timeout()` |
#### Custom Queries and Aggregations
To execute an arbitrary query or aggregation (including those not yet supported by the library), use the `CustomQuery()` or `CustomAgg()` functions, respectively. Both accept any `map[string]interface{}` value.