meilisearch

package module
v0.17.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 23, 2022 License: MIT Imports: 20 Imported by: 0

README

MeiliSearch-Go

MeiliSearch Go

MeiliSearch | Documentation | Slack | Roadmap | Website | FAQ

GitHub Workflow Status Test License Bors enabled

⚡ The MeiliSearch API client written for Golang

MeiliSearch Go is the MeiliSearch API client for Go developers.

MeiliSearch is an open-source search engine. Discover what MeiliSearch is!

Table of Contents

📖 Documentation

See our Documentation or our API References.

🔧 Installation

With go get in command line:

go get github.com/meilisearch/meilisearch-go

Run MeiliSearch

There are many easy ways to download and run a MeiliSearch instance.

For example, using the curl command in your Terminal:

# Install MeiliSearch
curl -L https://install.meilisearch.com | sh

# Launch MeiliSearch
./meilisearch --master-key=masterKey

NB: you can also download MeiliSearch from Homebrew or APT or even run it using Docker.

🚀 Getting Started

Add documents 
package main

import (
	"fmt"
	"os"

	"github.com/meilisearch/meilisearch-go"
)

func main() {
	client := meilisearch.NewClient(meilisearch.ClientConfig{
                Host: "http://127.0.0.1:7700",
                APIKey: "masterKey",
        })
	// An index is where the documents are stored.
	index := client.Index("movies")

	// If the index 'movies' does not exist, MeiliSearch creates it when you first add the documents.
	documents := []map[string]interface{}{
        { "id": 1, "title": "Carol", "genres": []string{"Romance", "Drama"} },
        { "id": 2, "title": "Wonder Woman", "genres": []string{"Action", "Adventure"} },
        { "id": 3, "title": "Life of Pi", "genres": []string{"Adventure", "Drama"} },
        { "id": 4, "title": "Mad Max: Fury Road", "genres": []string{"Adventure", "Science Fiction"} },
        { "id": 5, "title": "Moana", "genres": []string{"Fantasy", "Action"} },
        { "id": 6, "title": "Philadelphia", "genres": []string{"Drama"} },
	}
	update, err := index.AddDocuments(documents)
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	fmt.Println(update.UpdateID)
}

With the updateId, you can check the status (enqueued, processing, processed or failed) of your documents addition using the update endpoint.

package main

import (
    "fmt"
    "os"

    "github.com/meilisearch/meilisearch-go"
)

func main() {
    // MeiliSearch is typo-tolerant:
    searchRes, err := client.Index("movies").Search("philoudelphia",
        &meilisearch.SearchRequest{
            Limit: 10,
        })
    if err != nil {
        fmt.Println(err)
        os.Exit(1)
    }

    fmt.Println(searchRes.Hits)
}

JSON output:

{
  "hits": [{
    "id": 6,
    "title": "Philadelphia",
    "genres": ["Drama"]
  }],
  "offset": 0,
  "limit": 10,
  "processingTimeMs": 1,
  "query": "philoudelphia"
}

All the supported options are described in the search parameters section of the documentation.

func main() {
    searchRes, err := client.Index("movies").Search("wonder",
        &meilisearch.SearchRequest{
            AttributesToHighlight: []string{"*"},
        })
    if err != nil {
        fmt.Println(err)
        os.Exit(1)
    }

    fmt.Println(searchRes.Hits)
}

JSON output:

{
    "hits": [
        {
            "id": 2,
            "title": "Wonder Woman",
            "genres": ["Action", "Adventure"],
            "_formatted": {
                "id": 2,
                "title": "<em>Wonder</em> Woman"
            }
        }
    ],
    "offset": 0,
    "limit": 20,
    "processingTimeMs": 0,
    "query": "wonder"
}
Custom Search With Filters

If you want to enable filtering, you must add your attributes to the filterableAttributes index setting.

updateId, err := index.UpdateFilterableAttributes(&[]string{"id", "genres"})

You only need to perform this operation once.

Note that MeiliSearch will rebuild your index whenever you update filterableAttributes. Depending on the size of your dataset, this might take time. You can track the process using the update status.

Then, you can perform the search:

searchRes, err := index.Search("wonder",
    &meilisearch.SearchRequest{
        Filter: "id > 1 AND genres = Action",
    })

{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action","Adventure"]
    }
  ],
  "offset": 0,
  "limit": 20,
  "nbHits": 1,
  "processingTimeMs": 0,
  "query": "wonder"
}

🤖 Compatibility with MeiliSearch

This package only guarantees the compatibility with the version v0.24.0 of MeiliSearch.

💡 Learn More

The following sections may interest you:

⚙️ Development Workflow and Contributing

Any new contribution is more than welcome in this project!

If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!

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.

Documentation

Index

Constants

View Source 
const (
	DefaultLimit int64 = 20
)

This constant contains the default values assigned by meilisearch to the limit in search parameters

Documentation: https://docs.meilisearch.com/reference/features/search_parameters.html

Variables

This section is empty.

Functions

This section is empty.

Types

type AsyncUpdateID 

type AsyncUpdateID struct {
	UpdateID int64 `json:"updateId"`
}

AsyncUpdateID is returned for asynchronous method

Documentation: https://docs.meilisearch.com/learn/advanced/asynchronous_updates.html

func (AsyncUpdateID) MarshalEasyJSON 

func (v AsyncUpdateID) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (AsyncUpdateID) MarshalJSON 

func (v AsyncUpdateID) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*AsyncUpdateID) UnmarshalEasyJSON 

func (v *AsyncUpdateID) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*AsyncUpdateID) UnmarshalJSON 

func (v *AsyncUpdateID) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client is a structure that give you the power for interacting with an high-level api with meilisearch.

func NewClient 

func NewClient(config ClientConfig) *Client

NewClient creates Meilisearch with default fasthttp.Client

func NewFastHTTPCustomClient 

func NewFastHTTPCustomClient(config ClientConfig, client *fasthttp.Client) *Client

NewFastHTTPCustomClient creates Meilisearch with custom fasthttp.Client

func (*Client) CreateDump 

func (c *Client) CreateDump() (resp *Dump, err error)

func (*Client) CreateIndex 

func (c *Client) CreateIndex(config *IndexConfig) (resp *Index, err error)

func (*Client) DeleteIndex 

func (c *Client) DeleteIndex(uid string) (ok bool, err error)

func (*Client) DeleteIndexIfExists 

func (c *Client) DeleteIndexIfExists(uid string) (ok bool, err error)

func (*Client) GetAllIndexes 

func (c *Client) GetAllIndexes() (resp []*Index, err error)

func (*Client) GetAllRawIndexes 

func (c *Client) GetAllRawIndexes() (resp []map[string]interface{}, err error)

func (*Client) GetAllStats 

func (c *Client) GetAllStats() (resp *Stats, err error)

func (*Client) GetDumpStatus 

func (c *Client) GetDumpStatus(dumpUID string) (resp *Dump, err error)

func (*Client) GetIndex 

func (c *Client) GetIndex(uid string) (resp *Index, err error)

func (*Client) GetKeys 

func (c *Client) GetKeys() (resp *Keys, err error)

func (*Client) GetOrCreateIndex 

func (c *Client) GetOrCreateIndex(config *IndexConfig) (resp *Index, err error)

func (*Client) GetRawIndex 

func (c *Client) GetRawIndex(uid string) (resp map[string]interface{}, err error)

func (*Client) GetVersion 

func (c *Client) GetVersion() (resp *Version, err error)

func (*Client) Health 

func (c *Client) Health() (resp *Health, err error)

func (*Client) Index 

func (c *Client) Index(uid string) *Index

func (*Client) IsHealthy 

func (c *Client) IsHealthy() bool

func (Client) MarshalEasyJSON 

func (v Client) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Client) MarshalJSON 

func (v Client) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Client) UnmarshalEasyJSON 

func (v *Client) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Client) UnmarshalJSON 

func (v *Client) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (*Client) Version 

func (c *Client) Version() (resp *Version, err error)

type ClientConfig 

type ClientConfig struct {

	// Host is the host of your meilisearch database
	// Example: 'http://localhost:7700'
	Host string

	// APIKey is optional
	APIKey string

	// Timeout is optional
	Timeout time.Duration
}

ClientConfig configure the Client

type ClientInterface 

type ClientInterface interface {
	Index(uid string) *Index
	GetIndex(indexID string) (resp *Index, err error)
	GetRawIndex(uid string) (resp map[string]interface{}, err error)
	GetAllIndexes() (resp []*Index, err error)
	GetAllRawIndexes() (resp []map[string]interface{}, err error)
	CreateIndex(config *IndexConfig) (resp *Index, err error)
	GetOrCreateIndex(config *IndexConfig) (resp *Index, err error)
	DeleteIndex(uid string) (bool, error)
	DeleteIndexIfExists(uid string) (bool, error)
	GetKeys() (resp *Keys, err error)
	GetAllStats() (resp *Stats, err error)
	CreateDump() (resp *Dump, err error)
	GetDumpStatus(dumpUID string) (resp *Dump, err error)
	Version() (*Version, error)
	GetVersion() (resp *Version, err error)
	Health() (*Health, error)
	IsHealthy() bool
}

ClientInterface is interface for all Meilisearch client

type CreateIndexRequest 

type CreateIndexRequest struct {
	UID        string `json:"uid,omitempty"`
	PrimaryKey string `json:"primaryKey,omitempty"`
}

CreateIndexRequest is the request body for create index method

func (CreateIndexRequest) MarshalEasyJSON 

func (v CreateIndexRequest) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (CreateIndexRequest) MarshalJSON 

func (v CreateIndexRequest) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*CreateIndexRequest) UnmarshalEasyJSON 

func (v *CreateIndexRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CreateIndexRequest) UnmarshalJSON 

func (v *CreateIndexRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type DocumentsRequest 

type DocumentsRequest struct {
	Offset               int64    `json:"offset,omitempty"`
	Limit                int64    `json:"limit,omitempty"`
	AttributesToRetrieve []string `json:"attributesToRetrieve,omitempty"`
}

DocumentsRequest is the request body for list documents method

func (DocumentsRequest) MarshalEasyJSON 

func (v DocumentsRequest) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (DocumentsRequest) MarshalJSON 

func (v DocumentsRequest) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*DocumentsRequest) UnmarshalEasyJSON 

func (v *DocumentsRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*DocumentsRequest) UnmarshalJSON 

func (v *DocumentsRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Dump 

type Dump struct {
	UID        string     `json:"uid"`
	Status     DumpStatus `json:"status"`
	StartedAt  time.Time  `json:"startedAt"`
	FinishedAt time.Time  `json:"finishedAt"`
}

Dump indicate information about an dump

Documentation: https://docs.meilisearch.com/reference/api/dump.html

func (Dump) MarshalEasyJSON 

func (v Dump) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Dump) MarshalJSON 

func (v Dump) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Dump) UnmarshalEasyJSON 

func (v *Dump) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Dump) UnmarshalJSON 

func (v *Dump) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type DumpStatus 

type DumpStatus string

DumpStatus is the status of a dump. 

const (
	// DumpStatusInProgress means the server is processing the dump
	DumpStatusInProgress DumpStatus = "in_progress"
	// DumpStatusFailed means the server failed to create a dump
	DumpStatusFailed DumpStatus = "failed"
	// DumpStatusDone means the server completed the dump
	DumpStatusDone DumpStatus = "done"
)

type ErrCode 

type ErrCode int

ErrCode are all possible errors found during requests 

const (
	// ErrCodeUnknown default error code, undefined
	ErrCodeUnknown ErrCode = 0
	// ErrCodeMarshalRequest impossible to serialize request body
	ErrCodeMarshalRequest ErrCode = iota + 1
	// ErrCodeResponseUnmarshalBody impossible deserialize the response body
	ErrCodeResponseUnmarshalBody
	// MeilisearchApiError send by the Meilisearch api
	MeilisearchApiError
	// MeilisearchApiError send by the Meilisearch api
	MeilisearchApiErrorWithoutMessage
	// MeilisearchTimeoutError
	MeilisearchTimeoutError
	// MeilisearchCommunicationError impossible execute a request
	MeilisearchCommunicationError
)

type Error 

type Error struct {
	// Endpoint is the path of the request (host is not in)
	Endpoint string

	// Method is the HTTP verb of the request
	Method string

	// Function name used
	Function string

	// RequestToString is the raw request into string ('empty request' if not present)
	RequestToString string

	// RequestToString is the raw request into string ('empty response' if not present)
	ResponseToString string

	// Error info from Meilisearch api
	// Message is the raw request into string ('empty meilisearch message' if not present)
	MeilisearchApiError meilisearchApiError

	// StatusCode of the request
	StatusCode int

	// StatusCode expected by the endpoint to be considered as a success
	StatusCodeExpected []int

	// OriginError is the origin error that produce the current Error. It can be nil in case of a bad status code.
	OriginError error

	// ErrCode is the internal error code that represent the different step when executing a request that can produce
	// an error.
	ErrCode ErrCode
	// contains filtered or unexported fields
}

Error is the internal error structure that all exposed method use. So ALL errors returned by this library can be cast to this struct (as a pointer)

func (Error) Error 

func (e Error) Error() string

Error return a well human formatted message.

func (*Error) ErrorBody 

func (e *Error) ErrorBody(body []byte)

ErrorBody add a body to an error

func (*Error) WithErrCode 

func (e *Error) WithErrCode(err ErrCode, errs ...error) *Error

WithErrCode add an error code to an error

type Health 

type Health struct {
	Status string `json:"status"`
}

Health is the request body for set Meilisearch health

func (Health) MarshalEasyJSON 

func (v Health) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Health) MarshalJSON 

func (v Health) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Health) UnmarshalEasyJSON 

func (v *Health) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Health) UnmarshalJSON 

func (v *Health) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Index 

type Index struct {
	UID        string    `json:"uid"`
	CreatedAt  time.Time `json:"createdAt"`
	UpdatedAt  time.Time `json:"updatedAt"`
	PrimaryKey string    `json:"primaryKey,omitempty"`
	// contains filtered or unexported fields
}

Index is the type that represent an index in MeiliSearch

func (Index) AddDocuments 

func (i Index) AddDocuments(documentsPtr interface{}, primaryKey ...string) (resp *AsyncUpdateID, err error)

func (Index) AddDocumentsCsv 

func (i Index) AddDocumentsCsv(documents []byte, primaryKey ...string) (resp *AsyncUpdateID, err error)

func (Index) AddDocumentsCsvFromReader 

func (i Index) AddDocumentsCsvFromReader(documents io.Reader, primaryKey ...string) (resp *AsyncUpdateID, err error)

func (Index) AddDocumentsCsvFromReaderInBatches 

func (i Index) AddDocumentsCsvFromReaderInBatches(documents io.Reader, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)

func (Index) AddDocumentsCsvInBatches 

func (i Index) AddDocumentsCsvInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)

func (Index) AddDocumentsInBatches 

func (i Index) AddDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)

func (Index) AddDocumentsNdjson 

func (i Index) AddDocumentsNdjson(documents []byte, primaryKey ...string) (resp *AsyncUpdateID, err error)

func (Index) AddDocumentsNdjsonFromReader 

func (i Index) AddDocumentsNdjsonFromReader(documents io.Reader, primaryKey ...string) (resp *AsyncUpdateID, err error)

func (Index) AddDocumentsNdjsonFromReaderInBatches 

func (i Index) AddDocumentsNdjsonFromReaderInBatches(documents io.Reader, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)

func (Index) AddDocumentsNdjsonInBatches 

func (i Index) AddDocumentsNdjsonInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)

func (Index) DefaultWaitForPendingUpdate 

func (i Index) DefaultWaitForPendingUpdate(updateID *AsyncUpdateID) (UpdateStatus, error)

DefaultWaitForPendingUpdate checks each 50ms the status of a WaitForPendingUpdate. This is a default implementation of WaitForPendingUpdate.

func (Index) Delete 

func (i Index) Delete(uid string) (ok bool, err error)

func (Index) DeleteAllDocuments 

func (i Index) DeleteAllDocuments() (resp *AsyncUpdateID, err error)

func (Index) DeleteDocument 

func (i Index) DeleteDocument(identifier string) (resp *AsyncUpdateID, err error)

func (Index) DeleteDocuments 

func (i Index) DeleteDocuments(identifier []string) (resp *AsyncUpdateID, err error)

func (Index) DeleteIfExists 

func (i Index) DeleteIfExists(uid string) (ok bool, err error)

func (Index) FetchInfo 

func (i Index) FetchInfo() (resp *Index, err error)

func (Index) FetchPrimaryKey 

func (i Index) FetchPrimaryKey() (resp *string, err error)

func (Index) GetAllUpdateStatus 

func (i Index) GetAllUpdateStatus() (resp *[]Update, err error)

func (Index) GetDisplayedAttributes 

func (i Index) GetDisplayedAttributes() (resp *[]string, err error)

func (Index) GetDistinctAttribute 

func (i Index) GetDistinctAttribute() (resp *string, err error)

func (Index) GetDocument 

func (i Index) GetDocument(identifier string, documentPtr interface{}) error

func (Index) GetDocuments 

func (i Index) GetDocuments(request *DocumentsRequest, resp interface{}) error

func (Index) GetFilterableAttributes 

func (i Index) GetFilterableAttributes() (resp *[]string, err error)

func (Index) GetRankingRules 

func (i Index) GetRankingRules() (resp *[]string, err error)

func (Index) GetSearchableAttributes 

func (i Index) GetSearchableAttributes() (resp *[]string, err error)

func (Index) GetSettings 

func (i Index) GetSettings() (resp *Settings, err error)

func (Index) GetSortableAttributes 

func (i Index) GetSortableAttributes() (resp *[]string, err error)

func (Index) GetStats 

func (i Index) GetStats() (resp *StatsIndex, err error)

func (Index) GetStopWords 

func (i Index) GetStopWords() (resp *[]string, err error)

func (Index) GetSynonyms 

func (i Index) GetSynonyms() (resp *map[string][]string, err error)

func (Index) GetUpdateStatus 

func (i Index) GetUpdateStatus(updateID int64) (resp *Update, err error)

func (Index) MarshalEasyJSON 

func (v Index) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Index) MarshalJSON 

func (v Index) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (Index) ResetDisplayedAttributes 

func (i Index) ResetDisplayedAttributes() (resp *AsyncUpdateID, err error)

func (Index) ResetDistinctAttribute 

func (i Index) ResetDistinctAttribute() (resp *AsyncUpdateID, err error)

func (Index) ResetFilterableAttributes 

func (i Index) ResetFilterableAttributes() (resp *AsyncUpdateID, err error)

func (Index) ResetRankingRules 

func (i Index) ResetRankingRules() (resp *AsyncUpdateID, err error)

func (Index) ResetSearchableAttributes 

func (i Index) ResetSearchableAttributes() (resp *AsyncUpdateID, err error)

func (Index) ResetSettings 

func (i Index) ResetSettings() (resp *AsyncUpdateID, err error)

func (Index) ResetSortableAttributes 

func (i Index) ResetSortableAttributes() (resp *AsyncUpdateID, err error)

func (Index) ResetStopWords 

func (i Index) ResetStopWords() (resp *AsyncUpdateID, err error)

func (Index) ResetSynonyms 

func (i Index) ResetSynonyms() (resp *AsyncUpdateID, err error)

func (Index) Search 

func (i Index) Search(query string, request *SearchRequest) (*SearchResponse, error)

func (*Index) UnmarshalEasyJSON 

func (v *Index) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Index) UnmarshalJSON 

func (v *Index) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

func (Index) UpdateDisplayedAttributes 

func (i Index) UpdateDisplayedAttributes(request *[]string) (resp *AsyncUpdateID, err error)

func (Index) UpdateDistinctAttribute 

func (i Index) UpdateDistinctAttribute(request string) (resp *AsyncUpdateID, err error)

func (Index) UpdateDocuments 

func (i Index) UpdateDocuments(documentsPtr interface{}, primaryKey ...string) (resp *AsyncUpdateID, err error)

func (Index) UpdateDocumentsInBatches 

func (i Index) UpdateDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)

func (Index) UpdateFilterableAttributes 

func (i Index) UpdateFilterableAttributes(request *[]string) (resp *AsyncUpdateID, err error)

func (Index) UpdateIndex 

func (i Index) UpdateIndex(primaryKey string) (resp *Index, err error)

func (Index) UpdateRankingRules 

func (i Index) UpdateRankingRules(request *[]string) (resp *AsyncUpdateID, err error)

func (Index) UpdateSearchableAttributes 

func (i Index) UpdateSearchableAttributes(request *[]string) (resp *AsyncUpdateID, err error)

func (Index) UpdateSettings 

func (i Index) UpdateSettings(request *Settings) (resp *AsyncUpdateID, err error)

func (Index) UpdateSortableAttributes 

func (i Index) UpdateSortableAttributes(request *[]string) (resp *AsyncUpdateID, err error)

func (Index) UpdateStopWords 

func (i Index) UpdateStopWords(request *[]string) (resp *AsyncUpdateID, err error)

func (Index) UpdateSynonyms 

func (i Index) UpdateSynonyms(request *map[string][]string) (resp *AsyncUpdateID, err error)

func (Index) WaitForPendingUpdate 

func (i Index) WaitForPendingUpdate(
	ctx context.Context,
	interval time.Duration,
	updateID *AsyncUpdateID) (UpdateStatus, error)

WaitForPendingUpdate waits for the end of an update. The function will check by regular interval provided in parameter interval the UpdateStatus. If it is not UpdateStatusEnqueued or the ctx cancelled we return the UpdateStatus.

type IndexConfig 

type IndexConfig struct {

	// Uid is the unique identifier of a given index.
	Uid string

	// PrimaryKey is optional
	PrimaryKey string
	// contains filtered or unexported fields
}

IndexConfig configure the Index

type IndexInterface 

type IndexInterface interface {
	FetchInfo() (resp *Index, err error)
	FetchPrimaryKey() (resp *string, err error)
	UpdateIndex(primaryKey string) (resp *Index, err error)
	Delete(uid string) (ok bool, err error)
	DeleteIfExists(uid string) (ok bool, err error)
	GetStats() (resp *StatsIndex, err error)

	AddDocuments(documentsPtr interface{}, primaryKey ...string) (resp *AsyncUpdateID, err error)
	AddDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)
	AddDocumentsCsv(documents []byte, primaryKey ...string) (resp *AsyncUpdateID, err error)
	AddDocumentsCsvInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)
	AddDocumentsNdjson(documents []byte, primaryKey ...string) (resp *AsyncUpdateID, err error)
	AddDocumentsNdjsonInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []AsyncUpdateID, err error)
	UpdateDocuments(documentsPtr interface{}, primaryKey ...string) (resp *AsyncUpdateID, err error)
	GetDocument(uid string, documentPtr interface{}) error
	GetDocuments(request *DocumentsRequest, resp interface{}) error
	DeleteDocument(uid string) (resp *AsyncUpdateID, err error)
	DeleteDocuments(uid []string) (resp *AsyncUpdateID, err error)
	DeleteAllDocuments() (resp *AsyncUpdateID, err error)
	Search(query string, request *SearchRequest) (*SearchResponse, error)

	GetUpdateStatus(updateID int64) (resp *Update, err error)
	GetAllUpdateStatus() (resp *[]Update, err error)

	GetSettings() (resp *Settings, err error)
	UpdateSettings(request *Settings) (resp *AsyncUpdateID, err error)
	ResetSettings() (resp *AsyncUpdateID, err error)
	GetRankingRules() (resp *[]string, err error)
	UpdateRankingRules(request *[]string) (resp *AsyncUpdateID, err error)
	ResetRankingRules() (resp *AsyncUpdateID, err error)
	GetDistinctAttribute() (resp *string, err error)
	UpdateDistinctAttribute(request string) (resp *AsyncUpdateID, err error)
	ResetDistinctAttribute() (resp *AsyncUpdateID, err error)
	GetSearchableAttributes() (resp *[]string, err error)
	UpdateSearchableAttributes(request *[]string) (resp *AsyncUpdateID, err error)
	ResetSearchableAttributes() (resp *AsyncUpdateID, err error)
	GetDisplayedAttributes() (resp *[]string, err error)
	UpdateDisplayedAttributes(request *[]string) (resp *AsyncUpdateID, err error)
	ResetDisplayedAttributes() (resp *AsyncUpdateID, err error)
	GetStopWords() (resp *[]string, err error)
	UpdateStopWords(request *[]string) (resp *AsyncUpdateID, err error)
	ResetStopWords() (resp *AsyncUpdateID, err error)
	GetSynonyms() (resp *map[string][]string, err error)
	UpdateSynonyms(request *map[string][]string) (resp *AsyncUpdateID, err error)
	ResetSynonyms() (resp *AsyncUpdateID, err error)
	GetFilterableAttributes() (resp *[]string, err error)
	UpdateFilterableAttributes(request *[]string) (resp *AsyncUpdateID, err error)
	ResetFilterableAttributes() (resp *AsyncUpdateID, err error)

	WaitForPendingUpdate(ctx context.Context, interval time.Duration, updateID *AsyncUpdateID) (UpdateStatus, error)
	DefaultWaitForPendingUpdate(updateID *AsyncUpdateID) (UpdateStatus, error)
}

type Keys 

type Keys struct {
	Public  string `json:"public,omitempty"`
	Private string `json:"private,omitempty"`
}

Keys allow the user to connect to the MeiliSearch instance

Documentation: https://docs.meilisearch.com/learn/advanced/asynchronous_updates.html

func (Keys) MarshalEasyJSON 

func (v Keys) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Keys) MarshalJSON 

func (v Keys) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Keys) UnmarshalEasyJSON 

func (v *Keys) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Keys) UnmarshalJSON 

func (v *Keys) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type RawType 

type RawType []byte

RawType is an alias for raw byte[]

func (RawType) MarshalJSON 

func (b RawType) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*RawType) UnmarshalJSON 

func (b *RawType) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SearchRequest 

type SearchRequest struct {
	Offset                int64
	Limit                 int64
	AttributesToRetrieve  []string
	AttributesToCrop      []string
	CropLength            int64
	AttributesToHighlight []string
	Filter                interface{}
	Matches               bool
	FacetsDistribution    []string
	PlaceholderSearch     bool
	Sort                  []string
}

SearchRequest is the request url param needed for a search query. This struct will be converted to url param before sent.

Documentation: https://docs.meilisearch.com/reference/features/search_parameters.html

func (SearchRequest) MarshalEasyJSON 

func (v SearchRequest) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SearchRequest) MarshalJSON 

func (v SearchRequest) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SearchRequest) UnmarshalEasyJSON 

func (v *SearchRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SearchRequest) UnmarshalJSON 

func (v *SearchRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type SearchResponse 

type SearchResponse struct {
	Hits                  []interface{} `json:"hits"`
	NbHits                int64         `json:"nbHits"`
	Offset                int64         `json:"offset"`
	Limit                 int64         `json:"limit"`
	ExhaustiveNbHits      bool          `json:"exhaustiveNbHits"`
	ProcessingTimeMs      int64         `json:"processingTimeMs"`
	Query                 string        `json:"query"`
	FacetsDistribution    interface{}   `json:"facetsDistribution,omitempty"`
	ExhaustiveFacetsCount interface{}   `json:"exhaustiveFacetsCount,omitempty"`
}

SearchResponse is the response body for search method

func (SearchResponse) MarshalEasyJSON 

func (v SearchResponse) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (SearchResponse) MarshalJSON 

func (v SearchResponse) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*SearchResponse) UnmarshalEasyJSON 

func (v *SearchResponse) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SearchResponse) UnmarshalJSON 

func (v *SearchResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Settings 

type Settings struct {
	RankingRules         []string            `json:"rankingRules,omitempty"`
	DistinctAttribute    *string             `json:"distinctAttribute,omitempty"`
	SearchableAttributes []string            `json:"searchableAttributes,omitempty"`
	DisplayedAttributes  []string            `json:"displayedAttributes,omitempty"`
	StopWords            []string            `json:"stopWords,omitempty"`
	Synonyms             map[string][]string `json:"synonyms,omitempty"`
	FilterableAttributes []string            `json:"filterableAttributes,omitempty"`
	SortableAttributes   []string            `json:"sortableAttributes,omitempty"`
}

Settings is the type that represents the settings in MeiliSearch

func (Settings) MarshalEasyJSON 

func (v Settings) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Settings) MarshalJSON 

func (v Settings) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Settings) UnmarshalEasyJSON 

func (v *Settings) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Settings) UnmarshalJSON 

func (v *Settings) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Stats 

type Stats struct {
	DatabaseSize int64                 `json:"databaseSize"`
	LastUpdate   time.Time             `json:"lastUpdate"`
	Indexes      map[string]StatsIndex `json:"indexes"`
}

Stats is the type that represent all stats

func (Stats) MarshalEasyJSON 

func (v Stats) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Stats) MarshalJSON 

func (v Stats) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Stats) UnmarshalEasyJSON 

func (v *Stats) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Stats) UnmarshalJSON 

func (v *Stats) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type StatsIndex 

type StatsIndex struct {
	NumberOfDocuments int64            `json:"numberOfDocuments"`
	IsIndexing        bool             `json:"isIndexing"`
	FieldDistribution map[string]int64 `json:"fieldDistribution"`
}

StatsIndex is the type that represent the stats of an index in MeiliSearch

func (StatsIndex) MarshalEasyJSON 

func (v StatsIndex) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (StatsIndex) MarshalJSON 

func (v StatsIndex) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*StatsIndex) UnmarshalEasyJSON 

func (v *StatsIndex) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*StatsIndex) UnmarshalJSON 

func (v *StatsIndex) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type Unknown 

type Unknown map[string]interface{}

Unknown is unknown json type

type Update 

type Update struct {
	Status      UpdateStatus `json:"status"`
	UpdateID    int64        `json:"updateId"`
	Type        Unknown      `json:"type"`
	Error       string       `json:"error"`
	EnqueuedAt  time.Time    `json:"enqueuedAt"`
	ProcessedAt time.Time    `json:"processedAt"`
}

Update indicate information about an update

func (Update) MarshalEasyJSON 

func (v Update) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Update) MarshalJSON 

func (v Update) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Update) UnmarshalEasyJSON 

func (v *Update) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Update) UnmarshalJSON 

func (v *Update) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type UpdateIndexRequest 

type UpdateIndexRequest struct {
	PrimaryKey string `json:"primaryKey"`
}

UpdateIndexRequest is the request body for update Index primary key

func (UpdateIndexRequest) MarshalEasyJSON 

func (v UpdateIndexRequest) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (UpdateIndexRequest) MarshalJSON 

func (v UpdateIndexRequest) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*UpdateIndexRequest) UnmarshalEasyJSON 

func (v *UpdateIndexRequest) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*UpdateIndexRequest) UnmarshalJSON 

func (v *UpdateIndexRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

type UpdateStatus 

type UpdateStatus string

UpdateStatus is the status of an update. 

const (
	// UpdateStatusUnknown is the default UpdateStatus, should not exist
	UpdateStatusUnknown UpdateStatus = "unknown"
	// UpdateStatusEnqueued means the server know the update but didn't handle it yet
	UpdateStatusEnqueued UpdateStatus = "enqueued"
	// UpdateStatusProcessing means the server is processing the update and all went well
	UpdateStatusProcessing UpdateStatus = "processing"
	// UpdateStatusProcessed means the server has processed the update and all went well
	UpdateStatusProcessed UpdateStatus = "processed"
	// UpdateStatusFailed means the server has processed the update and an error has been reported
	UpdateStatusFailed UpdateStatus = "failed"
)

type Version 

type Version struct {
	CommitSha  string `json:"commitSha"`
	CommitDate string `json:"commitDate"`
	PkgVersion string `json:"pkgVersion"`
}

Version is the type that represents the versions in MeiliSearch

func (Version) MarshalEasyJSON 

func (v Version) MarshalEasyJSON(w *jwriter.Writer)

MarshalEasyJSON supports easyjson.Marshaler interface

func (Version) MarshalJSON 

func (v Version) MarshalJSON() ([]byte, error)

MarshalJSON supports json.Marshaler interface

func (*Version) UnmarshalEasyJSON 

func (v *Version) UnmarshalEasyJSON(l *jlexer.Lexer)

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Version) UnmarshalJSON 

func (v *Version) UnmarshalJSON(data []byte) error

UnmarshalJSON supports json.Unmarshaler interface

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.