Redis 中文文档
Integration Tests

RediSearch Go Client


Go client for RediSearch, based on redigo.

Installing


  1. ``` shell
  2. go get github.com/RediSearch/redisearch-go/redisearch
  3. ```

Usage Example


  1. ``` go
  2. package main
  3. import (
  4. "fmt"
  5. "log"
  6. "time"

  8. "github.com/RediSearch/redisearch-go/redisearch"
  9. )

  11. func ExampleClient() {

  13. // Create a client. By default a client is schemaless
  14. // unless a schema is provided when creating the index
  15. c := redisearch.NewClient("localhost:6379", "myIndex")

  17. // Create a schema
  18. sc := redisearch.NewSchema(redisearch.DefaultOptions).
  19.   AddField(redisearch.NewTextField("body")).
  20.   AddField(redisearch.NewTextFieldOptions("title", redisearch.TextFieldOptions{Weight: 5.0, Sortable: true})).
  21.   AddField(redisearch.NewNumericField("date"))

  23. // Drop an existing index. If the index does not exist an error is returned
  24. c.Drop()

  26. // Create the index with the given schema
  27. if err := c.CreateIndex(sc); err != nil {
  28.   log.Fatal(err)
  29. }

  31. // Create a document with an id and given score
  32. doc := redisearch.NewDocument("doc1", 1.0)
  33. doc.Set("title", "Hello world").
  34.   Set("body", "foo bar").
  35.   Set("date", time.Now().Unix())

  37. // Index the document. The API accepts multiple documents at a time
  38. if err := c.Index([]redisearch.Document{doc}...); err != nil {
  39.   log.Fatal(err)
  40. }

  42. // Searching with limit and sorting
  43. docs, total, err := c.Search(redisearch.NewQuery("hello world").
  44.   Limit(0, 2).
  45.   SetReturnFields("title"))

  47. fmt.Println(docs[0].Id, docs[0].Properties["title"], total, err)
  48. // Output: doc1 Hello world 1
  49. }
  50. ```

Supported RediSearch Commands


Command Recommended API and godoc
:--- :---
FT.CREATE CreateIndex
FT.ADD IndexOptions
FT.ALTER AddField
FT.ALIASADD AliasAdd
FT.ALIASUPDATE AliasUpdate
FT.ALIASDEL AliasDel
FT.INFO Info
FT.SEARCH Search
FT.AGGREGATE AggregateQuery
FT.CURSOR Aggregate + (*WithCursor option set to True)
FT.EXPLAIN Explain
FT.DEL DeleteDocument
FT.GET Get
FT.MGET MultiGet
FT.DROP Drop
FT.TAGVALS GetTagVals
FT.SUGADD AddTerms
FT.SUGGET SuggestOpts
FT.SUGDEL DeleteTerms
FT.SUGLEN Autocompleter.Length
FT.SYNUPDATE SynUpdate
FT.SYNDUMP SynDump
FT.SPELLCHECK SpellCheck
FT.DICTADD DictAdd
FT.DICTDEL DictDel
FT.DICTDUMP DictDump
FT.CONFIG SetConfig、GetConfig