diff options
Diffstat (limited to 'client/README.md')
| -rw-r--r-- | client/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/client/README.md b/client/README.md new file mode 100644 index 00000000000..ddea3591e38 --- /dev/null +++ b/client/README.md @@ -0,0 +1,28 @@ +# vespa_query_dsl +This lib is used for composing vespa YQL queries + +referece: https://docs.vespa.ai/documentation/reference/query-language-reference.html + +# usage +please refer the unit test: + +https://github.com/vespa-engine/vespa/blob/master/client/src/test/groovy/com/yahoo/vespa/client/dsl/QTest.groovy + +# todos +- [ ] support `predicate` (https://docs.vespa.ai/documentation/predicate-fields.html) +- [ ] support methods for checking positive/negative conditions for specific field +- [X] support order by annotation +- [X] support order by +- [X] support sub operators in contains (sameElement, phrase, near, onear, equiv) +- [X] support group syntax +- [X] support `nonEmpty` +- [X] support `dotProduct` +- [X] support `weightedSet` +- [X] support `wand` +- [X] support `weakAnd` +- [x] support `userInput` +- [x] support `rank` +- [x] support filter annotation +- [X] unit tests +- [X] support other annotations +- [X] handle edge cases (e.g. `Q.b("test").contains("a").build()`) |