Skip to content

[add] added supported commands table to Readme #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 27, 2020
Merged

[add] added supported commands table to Readme #38

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 37 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ go get github.com/RediSearch/redisearch-go/redisearch
# Usage Example

```go

package main
import (
"fmt"
"log"
Expand Down Expand Up @@ -70,3 +70,39 @@ func ExampleClient() {
// Output: doc1 Hello world 1 <nil>
}
```


## Supported RediSearch Commands

| Command | Recommended API and godoc |
| :--- | ----: |
| [FT.CREATE](https://oss.redislabs.com/redisearch/Commands.html#ftcreate) | [CreateIndex](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.CreateIndex) |
| [FT.ADD](https://oss.redislabs.com/redisearch/Commands.html#ftadd) | [IndexOptions](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.IndexOptions) |
| [FT.ADDHASH](https://oss.redislabs.com/redisearch/Commands.html#ftaddhash) | N/A |
| [FT.ALTER](https://oss.redislabs.com/redisearch/Commands.html#ftalter) | N/A |
| [FT.ALIASADD](https://oss.redislabs.com/redisearch/Commands.html#ftaliasadd) | N/A |
| [FT.ALIASUPDATE](https://oss.redislabs.com/redisearch/Commands.html#ftaliasupdate) | N/A |
| [FT.ALIASDEL](https://oss.redislabs.com/redisearch/Commands.html#ftaliasdel) | N/A |
| [FT.INFO](https://oss.redislabs.com/redisearch/Commands.html#ftinfo) | [Info](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Info) |
| [FT.SEARCH](https://oss.redislabs.com/redisearch/Commands.html#ftsearch) | [Search](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Search) |
| [FT.AGGREGATE](https://oss.redislabs.com/redisearch/Commands.html#ftaggregate) | [Aggregate](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Aggregate) |
| [FT.CURSOR](https://oss.redislabs.com/redisearch/Aggregations.html#cursor_api) | [Aggregate](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Aggregate) + (*WithCursor option set to True) |
| [FT.EXPLAIN](https://oss.redislabs.com/redisearch/Commands.html#ftexplain) | [Explain](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Explain) |
| [FT.DEL](https://oss.redislabs.com/redisearch/Commands.html#ftdel) | [Delete](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Delete) |
| [FT.GET](https://oss.redislabs.com/redisearch/Commands.html#ftget) | N/A |
| [FT.MGET](https://oss.redislabs.com/redisearch/Commands.html#ftmget) | N/A |
| [FT.DROP](https://oss.redislabs.com/redisearch/Commands.html#ftdrop) | [Drop](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Drop) |
| [FT.TAGVALS](https://oss.redislabs.com/redisearch/Commands.html#fttagvals) | N/A |
| [FT.SUGADD](https://oss.redislabs.com/redisearch/Commands.html#ftsugadd) | N/A |
| [FT.SUGGET](https://oss.redislabs.com/redisearch/Commands.html#ftsugget) | N/A |
| [FT.SUGDEL](https://oss.redislabs.com/redisearch/Commands.html#ftsugdel) | N/A |
| [FT.SUGLEN](https://oss.redislabs.com/redisearch/Commands.html#ftsuglen) | N/A |
| [FT.SYNADD](https://oss.redislabs.com/redisearch/Commands.html#ftsynadd) | N/A |
| [FT.SYNUPDATE](https://oss.redislabs.com/redisearch/Commands.html#ftsynupdate) | N/A |
| [FT.SYNDUMP](https://oss.redislabs.com/redisearch/Commands.html#ftsyndump) | N/A |
| [FT.SPELLCHECK](https://oss.redislabs.com/redisearch/Commands.html#ftspellcheck) | [SpellCheck](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.SpellCheck) |
| [FT.DICTADD](https://oss.redislabs.com/redisearch/Commands.html#ftdictadd) | N/A |
| [FT.DICTDEL](https://oss.redislabs.com/redisearch/Commands.html#ftdictdel) | N/A |
| [FT.DICTDUMP](https://oss.redislabs.com/redisearch/Commands.html#ftdictdump) | N/A |
| [FT.CONFIG](https://oss.redislabs.com/redisearch/Commands.html#ftconfig) | N/A |

1 change: 0 additions & 1 deletion redisearch/aggregate.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -123,7 +123,6 @@ type AggregateQuery struct {
Max int
WithSchema bool
Verbatim bool
// TODO: add cursor
WithCursor bool
Cursor *Cursor
// TODO: add load fields
Expand Down