MeiliSearch | Website | Blog | Twitter | Documentation | FAQ
⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in Go
MeiliSearch Go is a client for MeiliSearch written in Go. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.
- 🔧 Installation
- 🚀 Getting started
- 🎬 Examples
- ⚙️ Development Workflow
- 🤖 Compatibility with MeiliSearch
With go get in command line:
$ go get github.com/meilisearch/meilisearch-goThere are many easy ways to download and run a MeiliSearch instance.
For example, if you use Docker:
$ docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest --master-key=masterKeyNB: you can also download MeiliSearch from Homebrew or APT.
package main
import (
"fmt"
"os"
"github.com/meilisearch/meilisearch-go"
)
func main() {
var client = meilisearch.NewClient(meilisearch.Config{
Host: "http://127.0.0.1:7700",
APIKey: "masterKey",
})
// Create an index if your index does not already exist
_, err := client.Indexes().Create(meilisearch.CreateIndexRequest{
UID: "books",
})
if err != nil {
fmt.Println(err)
os.Exit(1)
}
documents := []map[string]interface{}{
{"book_id": 123, "title": "Pride and Prejudice"},
{"book_id": 456, "title": "Le Petit Prince"},
{"book_id": 1, "title": "Alice In Wonderland"},
{"book_id": 1344, "title": "The Hobbit"},
{"book_id": 4, "title": "Harry Potter and the Half-Blood Prince"},
{"book_id": 42, "title": "The Hitchhiker's Guide to the Galaxy"},
}
updateRes, err := client.Documents("books").AddOrUpdate(documents) // => { "updateId": 0 }
if err != nil {
fmt.Println(err)
os.Exit(1)
}
fmt.Println(updateRes.UpdateID)
}With the updateId, you can check the status (processed or failed) of your documents addition thanks to this method.
package main
import (
"fmt"
"os"
"github.com/meilisearch/meilisearch-go"
)
func main() {
// MeiliSearch is typo-tolerant:
searchRes, err := client.Search("books").Search(meilisearch.SearchRequest{
Query: "harry pottre",
Limit: 10,
})
if err != nil {
fmt.Println(err)
os.Exit(1)
}
fmt.Println(searchRes.Hits)
}JSON output:
{
"hits": [{
"book_id": 4,
"title": "Harry Potter and the Half-Blood Prince"
}],
"offset": 0,
"limit": 10,
"processingTimeMs": 1,
"query": "harry pottre"
}All HTTP routes of MeiliSearch are accessible via methods in this SDK.
You can check out the API documentation.
// Create an index with a specific uid (uid must be unique)
resp, err := client.Indexes().Create(meilisearch.CreateIndexRequest{
UID: "books",
})
// Create an index with a primary key
resp, err := client.Indexes().Create(meilisearch.CreateIndexRequest{
UID: "books",
PrimaryKey: "book_id",
})list, err := client.Indexes().List()index, err := client.Indexes().Get("books")// Get one document
var document map[int]interface{}
err := client.Documents("books").Get("123", &doc)
// Get documents by batch
var list []map[int]interface{}
err = client.Documents("books").List(ListDocumentsRequest{
Offset: 0,
Limit: 10,
}, &list)documents := []map[string]interface{}{
{BookID: 90, Title: "Madame Bovary"},
}
upd_res, err := client.Documents("books").AddOrUpdate(documents)Response:
{
"updateId": 1
}With this updateId you can track your operation update.
// Delete one document
updateRes, err = client.Documents("books").Delete("123")
// Delete several documents
updateRes, err = client.Documents("books").Deletes([]string{"123", "456"})
// Delete all documents /!\
updateRes, err = client.Documents("books").DeleteAllDocuments()// Get one update status
// Parameter: the updateId got after an asynchronous request (e.g. documents addition)
update, err := client.Updates("books").Get(1)
// Get all update satus
list, err := client.Updates("books").List()resp, err := client.Search(indexUID).Search(meilisearch.SearchRequest{
Query: "prince",
Limit: 10,
}){
"hits": [
{
"book_id": 456,
"title": "Le Petit Prince"
},
{
"book_id": 4,
"title": "Harry Potter and the Half-Blood Prince"
}
],
"offset": 0,
"limit": 20,
"processingTimeMs": 13,
"query": "prince"
}All the supported options are described in this documentation section.
resp, err := client.Search(indexUID).Search(meilisearch.SearchRequest{
Query: "harry pottre",
AttributesToHighlight: []string{"*"},
}){
"hits": [
{
"book_id": 456,
"title": "Le Petit Prince",
"_formatted": {
"book_id": 456,
"title": "Le Petit <em>Prince</em>"
}
}
],
"offset": 0,
"limit": 1,
"processingTimeMs": 0,
"query": "prince"
}If you want to contribute, this section describes the steps to follow.
Thank you for your interest in a MeiliSearch tool!
Follow the official tutorial
$ go get -v -t -d ./...Each PR should pass the tests and the linter to be accepted.
# Tests
$ ./run_tests.sh
# Install golint
$ go get -u golang.org/x/lint/golint
# Use golint
$ golint
# Use gofmt
$ gofmt -w ./..This module works for MeiliSearch v0.9.x.
MeiliSearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent