meilisearch

package module
v0.19.0 Latest Latest
Warning

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

 Go to latest Published: Mar 14, 2022 License: MIT Imports: 21 Imported by: 254

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"} },
	}
	task, err := index.AddDocuments(documents)
	if err != nil {
		fmt.Println(err)
		os.Exit(1)
	}

	fmt.Println(task.taskID)
}

With the taskID, you can check the status (enqueued, processing, succeeded or failed) of your documents addition using the task 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.

task, 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 task 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.26.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 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 added in v0.13.1 

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

NewFastHTTPCustomClient creates Meilisearch with custom fasthttp.Client

func (*Client) CreateDump added in v0.15.0 

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

func (*Client) CreateIndex added in v0.15.0 

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

func (*Client) CreateKey added in v0.18.0 

func (c *Client) CreateKey(request *Key) (resp *Key, err error)

func (*Client) DeleteIndex added in v0.15.0 

func (c *Client) DeleteIndex(uid string) (resp *Task, err error)

func (*Client) DeleteKey added in v0.18.0 

func (c *Client) DeleteKey(identifier string) (resp bool, err error)

func (*Client) GenerateTenantToken added in v0.19.0 

func (c *Client) GenerateTenantToken(SearchRules map[string]interface{}, Options *TenantTokenOptions) (resp string, err error)

Generate a JWT token for the use of multitenancy

SearchRules parameters is mandatory and should contains the rules to be enforced at search time for all or specific accessible indexes for the signing API Key. ExpiresAt options is a time.Time when the key will expire. Note that if an ExpiresAt value is included it should be in UTC time. ApiKey options is the API key parent of the token. If you leave it empty the client API Key will be used.

func (*Client) GetAllIndexes added in v0.15.0 

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

func (*Client) GetAllRawIndexes added in v0.16.2 

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

func (*Client) GetAllStats added in v0.15.0 

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

func (*Client) GetDumpStatus added in v0.15.0 

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

func (*Client) GetIndex added in v0.15.0 

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

func (*Client) GetKey added in v0.18.0 

func (c *Client) GetKey(identifier string) (resp *Key, err error)

func (*Client) GetKeys added in v0.15.0 

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

func (*Client) GetRawIndex added in v0.17.0 

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

func (*Client) GetTask added in v0.18.0 

func (c *Client) GetTask(taskID int64) (resp *Task, err error)

func (*Client) GetTasks added in v0.18.0 

func (c *Client) GetTasks() (resp *ResultTask, err error)

func (*Client) GetVersion added in v0.15.0 

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

func (*Client) Health 

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

func (*Client) Index added in v0.15.0 

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

func (*Client) IsHealthy added in v0.15.0 

func (c *Client) IsHealthy() bool

func (Client) MarshalEasyJSON added in v0.15.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Client) MarshalJSON added in v0.15.0 

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

MarshalJSON supports json.Marshaler interface

func (*Client) UnmarshalEasyJSON added in v0.15.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Client) UnmarshalJSON added in v0.15.0 

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

UnmarshalJSON supports json.Unmarshaler interface

func (*Client) UpdateKey added in v0.18.0 

func (c *Client) UpdateKey(identifier string, request *Key) (resp *Key, err error)

func (*Client) Version 

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

func (*Client) WaitForTask added in v0.18.0 

func (c *Client) WaitForTask(task *Task, options ...WaitParams) (*Task, error)

WaitForTask waits for a task to be processed

The function will check by regular interval provided in parameter interval the TaskStatus. If no ctx and interval are provided WaitForTask will check each 50ms the status of a task.

type ClientConfig added in v0.15.0 

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 added in v0.13.1 

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 *Task, err error)
	DeleteIndex(uid string) (resp *Task, err error)
	CreateKey(request *Key) (resp *Key, err error)
	GetKey(identifier string) (resp *Key, err error)
	GetKeys() (resp *ResultKey, err error)
	UpdateKey(identifier string, request *Key) (resp *Key, err error)
	DeleteKey(identifier string) (resp bool, 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
	GetTask(taskID int64) (resp *Task, err error)
	GetTasks() (resp *ResultTask, err error)
	WaitForTask(task *Task, options ...WaitParams) (*Task, error)
	GenerateTenantToken(searchRules map[string]interface{}, options *TenantTokenOptions) (resp string, err error)
}

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 added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (CreateIndexRequest) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*CreateIndexRequest) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*CreateIndexRequest) UnmarshalJSON added in v0.13.1 

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

UnmarshalJSON supports json.Unmarshaler interface

type Details added in v0.18.0 

type Details struct {
	ReceivedDocuments    int                 `json:"receivedDocuments,omitempty"`
	IndexedDocuments     int                 `json:"indexedDocuments,omitempty"`
	DeletedDocuments     int                 `json:"deletedDocuments,omitempty"`
	PrimaryKey           string              `json:"primaryKey,omitempty"`
	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"`
}

func (Details) MarshalEasyJSON added in v0.18.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Details) MarshalJSON added in v0.18.0 

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

MarshalJSON supports json.Marshaler interface

func (*Details) UnmarshalEasyJSON added in v0.18.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Details) UnmarshalJSON added in v0.18.0 

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

UnmarshalJSON supports json.Unmarshaler interface

type DocumentsRequest added in v0.15.0 

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 added in v0.15.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (DocumentsRequest) MarshalJSON added in v0.15.0 

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

MarshalJSON supports json.Marshaler interface

func (*DocumentsRequest) UnmarshalEasyJSON added in v0.15.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*DocumentsRequest) UnmarshalJSON added in v0.15.0 

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

UnmarshalJSON supports json.Unmarshaler interface

type Dump added in v0.14.1 

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 added in v0.14.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Dump) MarshalJSON added in v0.14.1 

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

MarshalJSON supports json.Marshaler interface

func (*Dump) UnmarshalEasyJSON added in v0.14.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Dump) UnmarshalJSON added in v0.14.1 

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

UnmarshalJSON supports json.Unmarshaler interface

type DumpStatus added in v0.17.0 

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 added in v0.13.1 

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

Health is the request body for set Meilisearch health

func (Health) MarshalEasyJSON added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Health) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*Health) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Health) UnmarshalJSON added in v0.13.1 

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 added in v0.15.0 

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

func (Index) AddDocumentsCsv added in v0.18.0 

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

func (Index) AddDocumentsCsvFromReader added in v0.18.0 

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

func (Index) AddDocumentsCsvFromReaderInBatches added in v0.18.0 

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

func (Index) AddDocumentsCsvInBatches added in v0.18.0 

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

func (Index) AddDocumentsInBatches added in v0.17.0 

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

func (Index) AddDocumentsNdjson added in v0.18.0 

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

func (Index) AddDocumentsNdjsonFromReader added in v0.18.0 

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

func (Index) AddDocumentsNdjsonFromReaderInBatches added in v0.18.0 

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

func (Index) AddDocumentsNdjsonInBatches added in v0.18.0 

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

func (Index) Delete added in v0.15.0 

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

func (Index) DeleteAllDocuments added in v0.15.0 

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

func (Index) DeleteDocument added in v0.15.0 

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

func (Index) DeleteDocuments added in v0.15.0 

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

func (Index) FetchInfo added in v0.15.0 

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

func (Index) FetchPrimaryKey added in v0.15.0 

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

func (Index) GetDisplayedAttributes added in v0.15.0 

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

func (Index) GetDistinctAttribute added in v0.15.0 

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

func (Index) GetDocument added in v0.15.0 

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

func (Index) GetDocuments added in v0.15.0 

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

func (Index) GetFilterableAttributes added in v0.16.0 

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

func (Index) GetRankingRules added in v0.15.0 

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

func (Index) GetSearchableAttributes added in v0.15.0 

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

func (Index) GetSettings added in v0.15.0 

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

func (Index) GetSortableAttributes added in v0.16.1 

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

func (Index) GetStats added in v0.15.0 

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

func (Index) GetStopWords added in v0.15.0 

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

func (Index) GetSynonyms added in v0.15.0 

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

func (Index) GetTask added in v0.18.0 

func (i Index) GetTask(taskID int64) (resp *Task, err error)

func (Index) GetTasks added in v0.18.0 

func (i Index) GetTasks() (resp *ResultTask, err error)

func (Index) MarshalEasyJSON added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Index) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (Index) ResetDisplayedAttributes added in v0.15.0 

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

func (Index) ResetDistinctAttribute added in v0.15.0 

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

func (Index) ResetFilterableAttributes added in v0.16.0 

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

func (Index) ResetRankingRules added in v0.15.0 

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

func (Index) ResetSearchableAttributes added in v0.15.0 

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

func (Index) ResetSettings added in v0.15.0 

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

func (Index) ResetSortableAttributes added in v0.16.1 

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

func (Index) ResetStopWords added in v0.15.0 

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

func (Index) ResetSynonyms added in v0.15.0 

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

func (Index) Search added in v0.15.0 

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

func (*Index) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Index) UnmarshalJSON added in v0.13.1 

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

UnmarshalJSON supports json.Unmarshaler interface

func (Index) UpdateDisplayedAttributes added in v0.15.0 

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

func (Index) UpdateDistinctAttribute added in v0.15.0 

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

func (Index) UpdateDocuments added in v0.15.0 

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

func (Index) UpdateDocumentsInBatches added in v0.17.0 

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

func (Index) UpdateFilterableAttributes added in v0.16.0 

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

func (Index) UpdateIndex added in v0.15.0 

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

func (Index) UpdateRankingRules added in v0.15.0 

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

func (Index) UpdateSearchableAttributes added in v0.15.0 

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

func (Index) UpdateSettings added in v0.15.0 

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

func (Index) UpdateSortableAttributes added in v0.16.1 

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

func (Index) UpdateStopWords added in v0.15.0 

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

func (Index) UpdateSynonyms added in v0.15.0 

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

func (Index) WaitForTask added in v0.18.0 

func (i Index) WaitForTask(task *Task, options ...WaitParams) (*Task, error)

WaitForTask waits for a task to be processed. The function will check by regular interval provided in parameter interval the TaskStatus. If no ctx and interval are provided WaitForTask will check each 50ms the status of a task.

type IndexConfig added in v0.15.0 

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 added in v0.15.0 

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

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

	GetTask(taskID int64) (resp *Task, err error)
	GetTasks() (resp *ResultTask, err error)

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

	WaitForTask(task *Task, options ...WaitParams) (*Task, error)
}

type Key added in v0.18.0 

type Key struct {
	Description string    `json:"description"`
	Key         string    `json:"key,omitempty"`
	Actions     []string  `json:"actions,omitempty"`
	Indexes     []string  `json:"indexes,omitempty"`
	CreatedAt   time.Time `json:"createdAt,omitempty"`
	UpdatedAt   time.Time `json:"updatedAt,omitempty"`
	ExpiresAt   time.Time `json:"expiresAt"`
}

Keys allow the user to connect to the Meilisearch instance

Documentation: https://docs.meilisearch.com/learn/advanced/security.html#protecting-a-meilisearch-instance

func (Key) MarshalEasyJSON added in v0.18.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Key) MarshalJSON added in v0.18.0 

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

MarshalJSON supports json.Marshaler interface

func (*Key) UnmarshalEasyJSON added in v0.18.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Key) UnmarshalJSON added in v0.18.0 

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

UnmarshalJSON supports json.Unmarshaler interface

type KeyParsed added in v0.18.0 

type KeyParsed struct {
	Description string    `json:"description"`
	Key         string    `json:"key,omitempty"`
	Actions     []string  `json:"actions,omitempty"`
	Indexes     []string  `json:"indexes,omitempty"`
	CreatedAt   time.Time `json:"createdAt,omitempty"`
	UpdatedAt   time.Time `json:"updatedAt,omitempty"`
	ExpiresAt   *string   `json:"expiresAt"`
}

This structure is used to send the exact ISO-8601 time format managed by Meilisearch

func (KeyParsed) MarshalEasyJSON added in v0.18.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (KeyParsed) MarshalJSON added in v0.18.0 

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

MarshalJSON supports json.Marshaler interface

func (*KeyParsed) UnmarshalEasyJSON added in v0.18.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*KeyParsed) UnmarshalJSON added in v0.18.0 

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

UnmarshalJSON supports json.Unmarshaler interface

type RawType added in v0.13.1 

type RawType []byte

RawType is an alias for raw byte[]

func (RawType) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*RawType) UnmarshalJSON added in v0.13.1 

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

UnmarshalJSON supports json.Unmarshaler interface

type ResultKey added in v0.18.0 

type ResultKey struct {
	Results []Key `json:"results"`
}

func (ResultKey) MarshalEasyJSON added in v0.18.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (ResultKey) MarshalJSON added in v0.18.0 

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

MarshalJSON supports json.Marshaler interface

func (*ResultKey) UnmarshalEasyJSON added in v0.18.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*ResultKey) UnmarshalJSON added in v0.18.0 

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

UnmarshalJSON supports json.Unmarshaler interface

type ResultTask added in v0.18.0 

type ResultTask struct {
	Results []Task `json:"results"`
}

func (ResultTask) MarshalEasyJSON added in v0.18.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (ResultTask) MarshalJSON added in v0.18.0 

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

MarshalJSON supports json.Marshaler interface

func (*ResultTask) UnmarshalEasyJSON added in v0.18.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*ResultTask) UnmarshalJSON added in v0.18.0 

func (v *ResultTask) 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 added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (SearchRequest) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*SearchRequest) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SearchRequest) UnmarshalJSON added in v0.13.1 

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 added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (SearchResponse) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*SearchResponse) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*SearchResponse) UnmarshalJSON added in v0.13.1 

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 added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Settings) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*Settings) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Settings) UnmarshalJSON added in v0.13.1 

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 added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Stats) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*Stats) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Stats) UnmarshalJSON added in v0.13.1 

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

UnmarshalJSON supports json.Unmarshaler interface

type StatsIndex added in v0.9.1 

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 added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (StatsIndex) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*StatsIndex) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*StatsIndex) UnmarshalJSON added in v0.13.1 

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

UnmarshalJSON supports json.Unmarshaler interface

type Task added in v0.18.0 

type Task struct {
	Status     TaskStatus          `json:"status"`
	UID        int64               `json:"uid"`
	IndexUID   string              `json:"indexUid"`
	Type       string              `json:"type"`
	Error      meilisearchApiError `json:"error,omitempty"`
	Duration   string              `json:"duration,omitempty"`
	EnqueuedAt time.Time           `json:"enqueuedAt"`
	StartedAt  time.Time           `json:"startedAt,omitempty"`
	FinishedAt time.Time           `json:"finishedAt,omitempty"`
	Details    Details             `json:"details,omitempty"`
}

Task indicate information about a task is returned for asynchronous method

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

func (Task) MarshalEasyJSON added in v0.18.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Task) MarshalJSON added in v0.18.0 

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

MarshalJSON supports json.Marshaler interface

func (*Task) UnmarshalEasyJSON added in v0.18.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Task) UnmarshalJSON added in v0.18.0 

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

UnmarshalJSON supports json.Unmarshaler interface

type TaskStatus added in v0.18.0 

type TaskStatus string

TaskStatus is the status of a task. 

const (
	// TaskStatusUnknown is the default TaskStatus, should not exist
	TaskStatusUnknown TaskStatus = "unknown"
	// TaskStatusEnqueued the task request has been received and will be processed soon
	TaskStatusEnqueued TaskStatus = "enqueued"
	// TaskStatusProcessing the task is being processed
	TaskStatusProcessing TaskStatus = "processing"
	// TaskStatusSucceeded the task has been successfully processed
	TaskStatusSucceeded TaskStatus = "succeeded"
	// TaskStatusFailed a failure occurred when processing the task, no changes were made to the database
	TaskStatusFailed TaskStatus = "failed"
)

type TenantTokenClaims added in v0.19.0 

type TenantTokenClaims struct {
	APIKeyPrefix string      `json:"apiKeyPrefix"`
	SearchRules  interface{} `json:"searchRules"`
	jwt.StandardClaims
}

Custom Claims structure to create a Tenant Token

func (TenantTokenClaims) MarshalEasyJSON added in v0.19.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (TenantTokenClaims) MarshalJSON added in v0.19.0 

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

MarshalJSON supports json.Marshaler interface

func (*TenantTokenClaims) UnmarshalEasyJSON added in v0.19.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*TenantTokenClaims) UnmarshalJSON added in v0.19.0 

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

UnmarshalJSON supports json.Unmarshaler interface

type TenantTokenOptions added in v0.19.0 

type TenantTokenOptions struct {
	APIKey    string
	ExpiresAt time.Time
}

Information to create a tenant token

ExpiresAt is a time.Time when the key will expire. Note that if an ExpiresAt value is included it should be in UTC time. ApiKey is the API key parent of the token.

func (TenantTokenOptions) MarshalEasyJSON added in v0.19.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (TenantTokenOptions) MarshalJSON added in v0.19.0 

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

MarshalJSON supports json.Marshaler interface

func (*TenantTokenOptions) UnmarshalEasyJSON added in v0.19.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*TenantTokenOptions) UnmarshalJSON added in v0.19.0 

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

UnmarshalJSON supports json.Unmarshaler interface

type Unknown 

type Unknown map[string]interface{}

Unknown is unknown json type

type UpdateIndexRequest added in v0.15.0 

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

UpdateIndexRequest is the request body for update Index primary key

func (UpdateIndexRequest) MarshalEasyJSON added in v0.15.0 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (UpdateIndexRequest) MarshalJSON added in v0.15.0 

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

MarshalJSON supports json.Marshaler interface

func (*UpdateIndexRequest) UnmarshalEasyJSON added in v0.15.0 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*UpdateIndexRequest) UnmarshalJSON added in v0.15.0 

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

UnmarshalJSON supports json.Unmarshaler interface

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 added in v0.13.1 

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

MarshalEasyJSON supports easyjson.Marshaler interface

func (Version) MarshalJSON added in v0.13.1 

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

MarshalJSON supports json.Marshaler interface

func (*Version) UnmarshalEasyJSON added in v0.13.1 

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

UnmarshalEasyJSON supports easyjson.Unmarshaler interface

func (*Version) UnmarshalJSON added in v0.13.1 

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

UnmarshalJSON supports json.Unmarshaler interface

type WaitParams added in v0.19.0 

type WaitParams struct {
	Context  context.Context
	Interval time.Duration
}

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.