{"id":13817107,"url":"https://github.com/RediSearch/redisearch-go","last_synced_at":"2025-05-15T19:30:55.211Z","repository":{"id":23296266,"uuid":"98457401","full_name":"RediSearch/redisearch-go","owner":"RediSearch","description":"Go client for RediSearch","archived":false,"fork":false,"pushed_at":"2024-07-01T07:54:04.000Z","size":2603,"stargazers_count":308,"open_issues_count":26,"forks_count":68,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-04-04T09:39:52.655Z","etag":null,"topics":["golang","redis","redis-client","redis-search","redisearch"],"latest_commit_sha":null,"homepage":"https://redisearch.io","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/RediSearch.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-07-26T19:14:15.000Z","updated_at":"2025-03-28T10:41:58.000Z","dependencies_parsed_at":"2024-04-09T21:47:45.691Z","dependency_job_id":"4f8975f4-254a-42d2-bc4d-8988933b01f0","html_url":"https://github.com/RediSearch/redisearch-go","commit_stats":null,"previous_names":["redislabs/redisearch-go"],"tags_count":14,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RediSearch%2Fredisearch-go","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RediSearch%2Fredisearch-go/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RediSearch%2Fredisearch-go/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/RediSearch%2Fredisearch-go/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/RediSearch","download_url":"https://codeload.github.com/RediSearch/redisearch-go/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254407239,"owners_count":22066196,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["golang","redis","redis-client","redis-search","redisearch"],"created_at":"2024-08-04T06:00:33.775Z","updated_at":"2025-05-15T19:30:54.626Z","avatar_url":"https://github.com/RediSearch.png","language":"Go","funding_links":[],"categories":["Misc","Go"],"sub_categories":[],"readme":"[![license](https://img.shields.io/github/license/RediSearch/redisearch-go.svg)](https://github.com/RediSearch/redisearch-go)\n[![Integration Tests](https://github.com/RediSearch/redisearch-go/actions/workflows/integration.yml/badge.svg)](https://github.com/RediSearch/redisearch-go/actions/workflows/integration.yml)\n[![GitHub issues](https://img.shields.io/github/release/RediSearch/redisearch-go.svg)](https://github.com/RediSearch/redisearch-go/releases/latest)\n[![Codecov](https://codecov.io/gh/RediSearch/redisearch-go/branch/master/graph/badge.svg)](https://codecov.io/gh/RediSearch/redisearch-go)\n[![Go Report Card](https://goreportcard.com/badge/github.com/RediSearch/redisearch-go)](https://goreportcard.com/report/github.com/RediSearch/redisearch-go)\n[![GoDoc](https://godoc.org/github.com/RediSearch/redisearch-go?status.svg)](https://godoc.org/github.com/RediSearch/redisearch-go)\n[![Total alerts](https://img.shields.io/lgtm/alerts/g/RediSearch/redisearch-go.svg?logo=lgtm\u0026logoWidth=18)](https://lgtm.com/projects/g/RediSearch/redisearch-go/alerts/)\n\n# RediSearch Go Client\n[![Forum](https://img.shields.io/badge/Forum-RediSearch-blue)](https://forum.redislabs.com/c/modules/redisearch/)\n[![Discord](https://img.shields.io/discord/697882427875393627?style=flat-square)](https://discord.gg/xTbqgTB)\n\nGo client for [RediSearch](http://redisearch.io), based on redigo.\n\n# Installing\n\n```sh\ngo get github.com/RediSearch/redisearch-go/redisearch\n```\n\n# Usage Example\n\n```go\npackage main\nimport (\n\t\"fmt\"\n\t\"log\"\n\t\"time\"\n\n\t\"github.com/RediSearch/redisearch-go/redisearch\"\n)\n\nfunc ExampleClient() {\n\n\t// Create a client. By default a client is schemaless\n\t// unless a schema is provided when creating the index\n\tc := redisearch.NewClient(\"localhost:6379\", \"myIndex\")\n\n\t// Create a schema\n\tsc := redisearch.NewSchema(redisearch.DefaultOptions).\n\t\tAddField(redisearch.NewTextField(\"body\")).\n\t\tAddField(redisearch.NewTextFieldOptions(\"title\", redisearch.TextFieldOptions{Weight: 5.0, Sortable: true})).\n\t\tAddField(redisearch.NewNumericField(\"date\"))\n\n\t// Drop an existing index. If the index does not exist an error is returned\n\tc.Drop()\n\n\t// Create the index with the given schema\n\tif err := c.CreateIndex(sc); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\t// Create a document with an id and given score\n\tdoc := redisearch.NewDocument(\"doc1\", 1.0)\n\tdoc.Set(\"title\", \"Hello world\").\n\t\tSet(\"body\", \"foo bar\").\n\t\tSet(\"date\", time.Now().Unix())\n\n\t// Index the document. The API accepts multiple documents at a time\n\tif err := c.Index([]redisearch.Document{doc}...); err != nil {\n\t\tlog.Fatal(err)\n\t}\n\n\t// Searching with limit and sorting\n\tdocs, total, err := c.Search(redisearch.NewQuery(\"hello world\").\n\t\tLimit(0, 2).\n\t\tSetReturnFields(\"title\"))\n\n\tfmt.Println(docs[0].Id, docs[0].Properties[\"title\"], total, err)\n\t// Output: doc1 Hello world 1 \u003cnil\u003e\n}\n```\n\n\n## Supported RediSearch Commands\n\n| Command | Recommended API and godoc  |\n| :---          |  ----: |\n| [FT.CREATE](https://oss.redislabs.com/redisearch/Commands.html#ftcreate) |   [CreateIndex](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.CreateIndex)          |\n| [FT.ADD](https://oss.redislabs.com/redisearch/Commands.html#ftadd) |   [IndexOptions](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.IndexOptions)          |\n| [FT.ALTER](https://oss.redislabs.com/redisearch/Commands.html#ftalter) |    [AddField](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.AddField) |\n| [FT.ALIASADD](https://oss.redislabs.com/redisearch/Commands.html#ftaliasadd) |  [AliasAdd](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.AliasAdd)         |\n| [FT.ALIASUPDATE](https://oss.redislabs.com/redisearch/Commands.html#ftaliasupdate) |     [AliasUpdate](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.AliasUpdate)          |\n| [FT.ALIASDEL](https://oss.redislabs.com/redisearch/Commands.html#ftaliasdel) |     [AliasDel](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.AliasDel)        |\n| [FT.INFO](https://oss.redislabs.com/redisearch/Commands.html#ftinfo) |   [Info](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Info)          |\n| [FT.SEARCH](https://oss.redislabs.com/redisearch/Commands.html#ftsearch) |  [Search](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Search)          |\n| [FT.AGGREGATE](https://oss.redislabs.com/redisearch/Commands.html#ftaggregate) |   [AggregateQuery](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.AggregateQuery)          |\n| [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)         |\n| [FT.EXPLAIN](https://oss.redislabs.com/redisearch/Commands.html#ftexplain) |   [Explain](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Explain)        |\n| [FT.DEL](https://oss.redislabs.com/redisearch/Commands.html#ftdel) |   [DeleteDocument](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.DeleteDocument)        |\n| [FT.GET](https://oss.redislabs.com/redisearch/Commands.html#ftget) |    [Get](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Get) |\n| [FT.MGET](https://oss.redislabs.com/redisearch/Commands.html#ftmget) |    [MultiGet](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Multi) |\n| [FT.DROP](https://oss.redislabs.com/redisearch/Commands.html#ftdrop) |   [Drop](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.Drop)        |\n| [FT.TAGVALS](https://oss.redislabs.com/redisearch/Commands.html#fttagvals) |    [GetTagVals](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.GetTagVals) |\n| [FT.SUGADD](https://oss.redislabs.com/redisearch/Commands.html#ftsugadd) |    [AddTerms](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Autocompleter.AddTerms) |\n| [FT.SUGGET](https://oss.redislabs.com/redisearch/Commands.html#ftsugget) |    [SuggestOpts](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Autocompleter.SuggestOpts)  |\n| [FT.SUGDEL](https://oss.redislabs.com/redisearch/Commands.html#ftsugdel) |    [DeleteTerms](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Autocompleter.DeleteTerms)  |\n| [FT.SUGLEN](https://oss.redislabs.com/redisearch/Commands.html#ftsuglen) |    [Autocompleter.Length](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Autocompleter.Length)  |\n| [FT.SYNUPDATE](https://oss.redislabs.com/redisearch/Commands.html#ftsynupdate) |    [SynUpdate](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.SynUpdate) |\n| [FT.SYNDUMP](https://oss.redislabs.com/redisearch/Commands.html#ftsyndump) |    [SynDump](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.SynDump) |\n| [FT.SPELLCHECK](https://oss.redislabs.com/redisearch/Commands.html#ftspellcheck) |  [SpellCheck](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.SpellCheck)        |\n| [FT.DICTADD](https://oss.redislabs.com/redisearch/Commands.html#ftdictadd) |    [DictAdd](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.DictAdd)  |\n| [FT.DICTDEL](https://oss.redislabs.com/redisearch/Commands.html#ftdictdel) |    [DictDel](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.DictDel)  |\n| [FT.DICTDUMP](https://oss.redislabs.com/redisearch/Commands.html#ftdictdump) |    [DictDump](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.DictDump)  |\n| [FT.CONFIG](https://oss.redislabs.com/redisearch/Commands.html#ftconfig) |    [SetConfig](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.SetConfig)、[GetConfig](https://godoc.org/github.com/RediSearch/redisearch-go/redisearch#Client.GetConfig) |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRediSearch%2Fredisearch-go","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FRediSearch%2Fredisearch-go","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FRediSearch%2Fredisearch-go/lists"}