Skip to content

Commit 4a3f4d9

Browse files
authored
Update README.md to show the new Aggregate function (#160)
* Update README.md to show the new Aggregate function
1 parent f67dc73 commit 4a3f4d9

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
Go client for [RediSearch](http://redisearch.io), based on redigo.
1414

15-
# Installing
15+
# Installing
1616

1717
```sh
1818
go get github.com/RediSearch/redisearch-go/redisearch
@@ -21,7 +21,7 @@ go get github.com/RediSearch/redisearch-go/redisearch
2121
# Usage Example
2222

2323
```go
24-
package main
24+
package main
2525
import (
2626
"fmt"
2727
"log"
@@ -84,7 +84,7 @@ func ExampleClient() {
8484
| [FT.ALIASDEL](https://oss.redislabs.com/redisearch/Commands.html#ftaliasdel) | [AliasDel](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.AliasDel) |
8585
| [FT.INFO](https://oss.redislabs.com/redisearch/Commands.html#ftinfo) | [Info](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Info) |
8686
| [FT.SEARCH](https://oss.redislabs.com/redisearch/Commands.html#ftsearch) | [Search](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Search) |
87-
| [FT.AGGREGATE](https://oss.redislabs.com/redisearch/Commands.html#ftaggregate) | [Aggregate](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Aggregate) |
87+
| [FT.AGGREGATE](https://oss.redislabs.com/redisearch/Commands.html#ftaggregate) | [AggregateQuery](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.AggregateQuery) |
8888
| [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) |
8989
| [FT.EXPLAIN](https://oss.redislabs.com/redisearch/Commands.html#ftexplain) | [Explain](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Explain) |
9090
| [FT.DEL](https://oss.redislabs.com/redisearch/Commands.html#ftdel) | [DeleteDocument](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.DeleteDocument) |

redisearch/client.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ func (i *Client) Aggregate(q *AggregateQuery) (aggregateReply [][]string, total
267267
return
268268
}
269269

270-
// AggregateQuery - New version to Aggregate() function. The values in each map can be string or []string.
270+
// AggregateQuery replaces the Aggregate() function. The reply is slice of maps, with values of either string or []string.
271271
func (i *Client) AggregateQuery(q *AggregateQuery) (total int, aggregateReply []map[string]interface{}, err error) {
272272
res, err := i.aggregate(q)
273273

0 commit comments

Comments
 (0)