Documentation ΒΆ
Index ΒΆ
- Constants
- Variables
- func GetQualifiedVersion() (qualifiedVersion string)
- func IsValidUUID(uuid string) bool
- func VersionErrorHintMessage(err error, req *internalRequest) error
- type CancelTasksQuery
- type Client
- func (c *Client) CancelTasks(param *CancelTasksQuery) (resp *TaskInfo, err error)
- func (c *Client) CreateDump() (resp *TaskInfo, err error)
- func (c *Client) CreateIndex(config *IndexConfig) (resp *TaskInfo, err error)
- func (c *Client) CreateKey(request *Key) (resp *Key, err error)
- func (c *Client) DeleteIndex(uid string) (resp *TaskInfo, err error)
- func (c *Client) DeleteKey(keyOrUID string) (resp bool, err error)
- func (c *Client) DeleteTasks(param *DeleteTasksQuery) (resp *TaskInfo, err error)
- func (c *Client) GenerateTenantToken(APIKeyUID string, SearchRules map[string]interface{}, ...) (resp string, err error)
- func (c *Client) GetIndex(uid string) (resp *Index, err error)
- func (c *Client) GetIndexes(param *IndexesQuery) (resp *IndexesResults, err error)
- func (c *Client) GetKey(identifier string) (resp *Key, err error)
- func (c *Client) GetKeys(param *KeysQuery) (resp *KeysResults, err error)
- func (c *Client) GetRawIndex(uid string) (resp map[string]interface{}, err error)
- func (c *Client) GetRawIndexes(param *IndexesQuery) (resp map[string]interface{}, err error)
- func (c *Client) GetStats() (resp *Stats, err error)
- func (c *Client) GetTask(taskUID int64) (resp *Task, err error)
- func (c *Client) GetTasks(param *TasksQuery) (resp *TaskResult, err error)
- func (c *Client) GetVersion() (resp *Version, err error)
- func (c *Client) Health() (resp *Health, err error)
- func (c *Client) Index(uid string) *Index
- func (c *Client) IsHealthy() bool
- func (v Client) MarshalEasyJSON(w *jwriter.Writer)
- func (v Client) MarshalJSON() ([]byte, error)
- func (c *Client) MultiSearch(queries *MultiSearchRequest) (*MultiSearchResponse, error)
- func (c *Client) SwapIndexes(param []SwapIndexesParams) (resp *TaskInfo, err error)
- func (v *Client) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *Client) UnmarshalJSON(data []byte) error
- func (c *Client) UpdateKey(keyOrUID string, request *Key) (resp *Key, err error)
- func (c *Client) Version() (resp *Version, err error)
- func (c *Client) WaitForTask(taskUID int64, options ...WaitParams) (*Task, error)
- type ClientConfig
- type ClientInterface
- type CreateIndexRequest
- type CsvDocumentsQuery
- type DeleteTasksQuery
- type Details
- type DocumentQuery
- type DocumentsQuery
- type DocumentsResult
- type Embedder
- type ErrCode
- type Error
- type Faceting
- type Health
- type Index
- func (i Index) AddDocuments(documentsPtr interface{}, primaryKey ...string) (resp *TaskInfo, err error)
- func (i Index) AddDocumentsCsv(documents []byte, options *CsvDocumentsQuery) (resp *TaskInfo, err error)
- func (i Index) AddDocumentsCsvFromReader(documents io.Reader, options *CsvDocumentsQuery) (resp *TaskInfo, err error)
- func (i Index) AddDocumentsCsvFromReaderInBatches(documents io.Reader, batchSize int, options *CsvDocumentsQuery) (resp []TaskInfo, err error)
- func (i Index) AddDocumentsCsvInBatches(documents []byte, batchSize int, options *CsvDocumentsQuery) (resp []TaskInfo, err error)
- func (i Index) AddDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []TaskInfo, err error)
- func (i Index) AddDocumentsNdjson(documents []byte, primaryKey ...string) (resp *TaskInfo, err error)
- func (i Index) AddDocumentsNdjsonFromReader(documents io.Reader, primaryKey ...string) (resp *TaskInfo, err error)
- func (i Index) AddDocumentsNdjsonFromReaderInBatches(documents io.Reader, batchSize int, primaryKey ...string) (resp []TaskInfo, err error)
- func (i Index) AddDocumentsNdjsonInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []TaskInfo, err error)
- func (i Index) Delete(uid string) (ok bool, err error)
- func (i Index) DeleteAllDocuments() (resp *TaskInfo, err error)
- func (i Index) DeleteDocument(identifier string) (resp *TaskInfo, err error)
- func (i Index) DeleteDocuments(identifier []string) (resp *TaskInfo, err error)
- func (i Index) DeleteDocumentsByFilter(filter interface{}) (resp *TaskInfo, err error)
- func (i *Index) FetchInfo() (resp *Index, err error)
- func (i Index) FetchPrimaryKey() (resp *string, err error)
- func (i Index) GetDisplayedAttributes() (resp *[]string, err error)
- func (i Index) GetDistinctAttribute() (resp *string, err error)
- func (i Index) GetDocument(identifier string, request *DocumentQuery, documentPtr interface{}) error
- func (i Index) GetDocuments(request *DocumentsQuery, resp *DocumentsResult) error
- func (i Index) GetEmbedders() (resp map[string]Embedder, err error)
- func (i Index) GetFaceting() (resp *Faceting, err error)
- func (i Index) GetFilterableAttributes() (resp *[]string, err error)
- func (i Index) GetPagination() (resp *Pagination, err error)
- func (i Index) GetRankingRules() (resp *[]string, err error)
- func (i Index) GetSearchableAttributes() (resp *[]string, err error)
- func (i Index) GetSettings() (resp *Settings, err error)
- func (i Index) GetSortableAttributes() (resp *[]string, err error)
- func (i Index) GetStats() (resp *StatsIndex, err error)
- func (i Index) GetStopWords() (resp *[]string, err error)
- func (i Index) GetSynonyms() (resp *map[string][]string, err error)
- func (i Index) GetTask(taskUID int64) (resp *Task, err error)
- func (i Index) GetTasks(param *TasksQuery) (resp *TaskResult, err error)
- func (i Index) GetTypoTolerance() (resp *TypoTolerance, err error)
- func (v Index) MarshalEasyJSON(w *jwriter.Writer)
- func (v Index) MarshalJSON() ([]byte, error)
- func (i Index) ResetDisplayedAttributes() (resp *TaskInfo, err error)
- func (i Index) ResetDistinctAttribute() (resp *TaskInfo, err error)
- func (i Index) ResetEmbedders() (resp *TaskInfo, err error)
- func (i Index) ResetFaceting() (resp *TaskInfo, err error)
- func (i Index) ResetFilterableAttributes() (resp *TaskInfo, err error)
- func (i Index) ResetPagination() (resp *TaskInfo, err error)
- func (i Index) ResetRankingRules() (resp *TaskInfo, err error)
- func (i Index) ResetSearchableAttributes() (resp *TaskInfo, err error)
- func (i Index) ResetSettings() (resp *TaskInfo, err error)
- func (i Index) ResetSortableAttributes() (resp *TaskInfo, err error)
- func (i Index) ResetStopWords() (resp *TaskInfo, err error)
- func (i Index) ResetSynonyms() (resp *TaskInfo, err error)
- func (i Index) ResetTypoTolerance() (resp *TaskInfo, err error)
- func (i Index) Search(query string, request *SearchRequest) (*SearchResponse, error)
- func (i Index) SearchRaw(query string, request *SearchRequest) (*json.RawMessage, error)
- func (v *Index) UnmarshalEasyJSON(l *jlexer.Lexer)
- func (v *Index) UnmarshalJSON(data []byte) error
- func (i Index) UpdateDisplayedAttributes(request *[]string) (resp *TaskInfo, err error)
- func (i Index) UpdateDistinctAttribute(request string) (resp *TaskInfo, err error)
- func (i Index) UpdateDocuments(documentsPtr interface{}, primaryKey ...string) (resp *TaskInfo, err error)
- func (i Index) UpdateDocumentsCsv(documents []byte, options *CsvDocumentsQuery) (resp *TaskInfo, err error)
- func (i Index) UpdateDocumentsCsvFromReader(documents io.Reader, options *CsvDocumentsQuery) (resp *TaskInfo, err error)
- func (i Index) UpdateDocumentsCsvFromReaderInBatches(documents io.Reader, batchSize int, options *CsvDocumentsQuery) (resp []TaskInfo, err error)
- func (i Index) UpdateDocumentsCsvInBatches(documents []byte, batchSize int, options *CsvDocumentsQuery) (resp []TaskInfo, err error)
- func (i Index) UpdateDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []TaskInfo, err error)
- func (i Index) UpdateDocumentsNdjson(documents []byte, primaryKey ...string) (resp *TaskInfo, err error)
- func (i Index) UpdateDocumentsNdjsonFromReader(documents io.Reader, primaryKey ...string) (resp *TaskInfo, err error)
- func (i Index) UpdateDocumentsNdjsonInBatches(documents []byte, batchsize int, primaryKey ...string) (resp []TaskInfo, err error)
- func (i Index) UpdateEmbedders(request map[string]Embedder) (resp *TaskInfo, err error)
- func (i Index) UpdateFaceting(request *Faceting) (resp *TaskInfo, err error)
- func (i Index) UpdateFilterableAttributes(request *[]string) (resp *TaskInfo, err error)
- func (i *Index) UpdateIndex(primaryKey string) (resp *TaskInfo, err error)
- func (i Index) UpdatePagination(request *Pagination) (resp *TaskInfo, err error)
- func (i Index) UpdateRankingRules(request *[]string) (resp *TaskInfo, err error)
- func (i Index) UpdateSearchableAttributes(request *[]string) (resp *TaskInfo, err error)
- func (i Index) UpdateSettings(request *Settings) (resp *TaskInfo, err error)
- func (i Index) UpdateSortableAttributes(request *[]string) (resp *TaskInfo, err error)
- func (i Index) UpdateStopWords(request *[]string) (resp *TaskInfo, err error)
- func (i Index) UpdateSynonyms(request *map[string][]string) (resp *TaskInfo, err error)
- func (i Index) UpdateTypoTolerance(request *TypoTolerance) (resp *TaskInfo, err error)
- func (i Index) WaitForTask(taskUID int64, options ...WaitParams) (*Task, error)
- type IndexConfig
- type IndexInterface
- type IndexesQuery
- type IndexesResults
- type Key
- type KeyParsed
- type KeyUpdate
- type KeysQuery
- type KeysResults
- type MinWordSizeForTypos
- type MultiSearchRequest
- type MultiSearchResponse
- type Pagination
- type RawType
- type SearchRequest
- type SearchRequestHybrid
- type SearchResponse
- type Settings
- type Stats
- type StatsIndex
- type SwapIndexesParams
- type Task
- type TaskInfo
- type TaskResult
- type TaskStatus
- type TaskType
- type TasksQuery
- type TenantTokenClaims
- type TenantTokenOptions
- type TypoTolerance
- type Unknown
- type UpdateIndexRequest
- type Version
- type WaitParams
Constants ΒΆ
const (
DefaultLimit int64 = 20
)
This constant contains the default values assigned by Meilisearch to the limit in search parameters
Documentation: https://www.meilisearch.com/docs/reference/api/search#search-parameters
const VERSION = "0.26.3"
Variables ΒΆ
var ErrNoSearchRequest = errors.New("no search request provided")
Functions ΒΆ
func GetQualifiedVersion ΒΆ
func GetQualifiedVersion() (qualifiedVersion string)
func IsValidUUID ΒΆ
func VersionErrorHintMessage ΒΆ
Added a hint to the error message if it may come from a version incompatibility with Meilisearch
Types ΒΆ
type CancelTasksQuery ΒΆ
type CancelTasksQuery struct { UIDS []int64 IndexUIDS []string Statuses []TaskStatus Types []TaskType BeforeEnqueuedAt time.Time AfterEnqueuedAt time.Time BeforeStartedAt time.Time AfterStartedAt time.Time }
CancelTasksQuery is a list of filter available to send as query parameters
func (CancelTasksQuery) MarshalEasyJSON ΒΆ
func (v CancelTasksQuery) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (CancelTasksQuery) MarshalJSON ΒΆ
func (v CancelTasksQuery) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*CancelTasksQuery) UnmarshalEasyJSON ΒΆ
func (v *CancelTasksQuery) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*CancelTasksQuery) UnmarshalJSON ΒΆ
func (v *CancelTasksQuery) 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) CancelTasks ΒΆ
func (c *Client) CancelTasks(param *CancelTasksQuery) (resp *TaskInfo, err error)
func (*Client) CreateDump ΒΆ
func (*Client) CreateIndex ΒΆ
func (c *Client) CreateIndex(config *IndexConfig) (resp *TaskInfo, err error)
func (*Client) DeleteTasks ΒΆ
func (c *Client) DeleteTasks(param *DeleteTasksQuery) (resp *TaskInfo, err error)
func (*Client) GenerateTenantToken ΒΆ
func (c *Client) GenerateTenantToken(APIKeyUID string, 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) GetIndexes ΒΆ
func (c *Client) GetIndexes(param *IndexesQuery) (resp *IndexesResults, err error)
func (*Client) GetRawIndex ΒΆ
func (*Client) GetRawIndexes ΒΆ
func (c *Client) GetRawIndexes(param *IndexesQuery) (resp map[string]interface{}, err error)
func (*Client) GetTasks ΒΆ
func (c *Client) GetTasks(param *TasksQuery) (resp *TaskResult, err error)
func (*Client) GetVersion ΒΆ
func (Client) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Client) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Client) MultiSearch ΒΆ
func (c *Client) MultiSearch(queries *MultiSearchRequest) (*MultiSearchResponse, error)
func (*Client) SwapIndexes ΒΆ
func (c *Client) SwapIndexes(param []SwapIndexesParams) (resp *TaskInfo, err error)
func (*Client) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Client) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
func (*Client) WaitForTask ΒΆ
func (c *Client) WaitForTask(taskUID int64, 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 ΒΆ
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) GetIndexes(param *IndexesQuery) (resp *IndexesResults, err error) GetRawIndexes(param *IndexesQuery) (resp map[string]interface{}, err error) CreateIndex(config *IndexConfig) (resp *TaskInfo, err error) DeleteIndex(uid string) (resp *TaskInfo, err error) CreateKey(request *Key) (resp *Key, err error) MultiSearch(queries *MultiSearchRequest) (*MultiSearchResponse, error) GetKey(identifier string) (resp *Key, err error) GetKeys(param *KeysQuery) (resp *KeysResults, err error) UpdateKey(keyOrUID string, request *Key) (resp *Key, err error) DeleteKey(keyOrUID string) (resp bool, err error) GetStats() (resp *Stats, err error) CreateDump() (resp *TaskInfo, err error) Version() (*Version, error) GetVersion() (resp *Version, err error) Health() (*Health, error) IsHealthy() bool GetTask(taskUID int64) (resp *Task, err error) GetTasks(param *TasksQuery) (resp *TaskResult, err error) CancelTasks(param *CancelTasksQuery) (resp *TaskInfo, err error) DeleteTasks(param *DeleteTasksQuery) (resp *TaskInfo, err error) SwapIndexes(param []SwapIndexesParams) (resp *TaskInfo, err error) WaitForTask(taskUID int64, options ...WaitParams) (*Task, error) GenerateTenantToken(APIKeyUID string, 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 ΒΆ
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 CsvDocumentsQuery ΒΆ
type CsvDocumentsQuery struct { PrimaryKey string `json:"primaryKey,omitempty"` CsvDelimiter string `json:"csvDelimiter,omitempty"` }
func (CsvDocumentsQuery) MarshalEasyJSON ΒΆ
func (v CsvDocumentsQuery) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (CsvDocumentsQuery) MarshalJSON ΒΆ
func (v CsvDocumentsQuery) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*CsvDocumentsQuery) UnmarshalEasyJSON ΒΆ
func (v *CsvDocumentsQuery) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*CsvDocumentsQuery) UnmarshalJSON ΒΆ
func (v *CsvDocumentsQuery) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type DeleteTasksQuery ΒΆ
type DeleteTasksQuery struct { UIDS []int64 IndexUIDS []string Statuses []TaskStatus Types []TaskType CanceledBy []int64 BeforeEnqueuedAt time.Time AfterEnqueuedAt time.Time BeforeStartedAt time.Time AfterStartedAt time.Time BeforeFinishedAt time.Time AfterFinishedAt time.Time }
DeleteTasksQuery is a list of filter available to send as query parameters
func (DeleteTasksQuery) MarshalEasyJSON ΒΆ
func (v DeleteTasksQuery) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (DeleteTasksQuery) MarshalJSON ΒΆ
func (v DeleteTasksQuery) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*DeleteTasksQuery) UnmarshalEasyJSON ΒΆ
func (v *DeleteTasksQuery) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*DeleteTasksQuery) UnmarshalJSON ΒΆ
func (v *DeleteTasksQuery) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type Details ΒΆ
type Details struct { ReceivedDocuments int64 `json:"receivedDocuments,omitempty"` IndexedDocuments int64 `json:"indexedDocuments,omitempty"` DeletedDocuments int64 `json:"deletedDocuments,omitempty"` PrimaryKey string `json:"primaryKey,omitempty"` ProvidedIds int64 `json:"providedIds,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"` TypoTolerance *TypoTolerance `json:"typoTolerance,omitempty"` Pagination *Pagination `json:"pagination,omitempty"` Faceting *Faceting `json:"faceting,omitempty"` MatchedTasks int64 `json:"matchedTasks,omitempty"` CanceledTasks int64 `json:"canceledTasks,omitempty"` DeletedTasks int64 `json:"deletedTasks,omitempty"` OriginalFilter string `json:"originalFilter,omitempty"` Swaps []SwapIndexesParams `json:"swaps,omitempty"` DumpUid string `json:"dumpUid,omitempty"` }
func (Details) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Details) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Details) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Details) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type DocumentQuery ΒΆ
type DocumentQuery struct {
Fields []string `json:"fields,omitempty"`
}
DocumentQuery is the request body get one documents method
func (DocumentQuery) MarshalEasyJSON ΒΆ
func (v DocumentQuery) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (DocumentQuery) MarshalJSON ΒΆ
func (v DocumentQuery) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*DocumentQuery) UnmarshalEasyJSON ΒΆ
func (v *DocumentQuery) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*DocumentQuery) UnmarshalJSON ΒΆ
func (v *DocumentQuery) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type DocumentsQuery ΒΆ
type DocumentsQuery struct { Offset int64 `json:"offset,omitempty"` Limit int64 `json:"limit,omitempty"` Fields []string `json:"fields,omitempty"` Filter interface{} `json:"filter,omitempty"` }
DocumentsQuery is the request body for list documents method
func (DocumentsQuery) MarshalEasyJSON ΒΆ
func (v DocumentsQuery) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (DocumentsQuery) MarshalJSON ΒΆ
func (v DocumentsQuery) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*DocumentsQuery) UnmarshalEasyJSON ΒΆ
func (v *DocumentsQuery) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*DocumentsQuery) UnmarshalJSON ΒΆ
func (v *DocumentsQuery) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type DocumentsResult ΒΆ
type DocumentsResult struct { Results []map[string]interface{} `json:"results"` Limit int64 `json:"limit"` Offset int64 `json:"offset"` Total int64 `json:"total"` }
func (DocumentsResult) MarshalEasyJSON ΒΆ
func (v DocumentsResult) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (DocumentsResult) MarshalJSON ΒΆ
func (v DocumentsResult) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*DocumentsResult) UnmarshalEasyJSON ΒΆ
func (v *DocumentsResult) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*DocumentsResult) UnmarshalJSON ΒΆ
func (v *DocumentsResult) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type Embedder ΒΆ
type Embedder struct { Source string `json:"source"` ApiKey string `json:"apiKey,omitempty"` Model string `json:"model,omitempty"` Dimensions int `json:"dimensions,omitempty"` DocumentTemplate string `json:"documentTemplate,omitempty"` }
func (Embedder) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Embedder) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Embedder) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Embedder) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
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)
type Faceting ΒΆ
type Faceting struct {
MaxValuesPerFacet int64 `json:"maxValuesPerFacet"`
}
Faceting is the type that represents the faceting setting in Meilisearch
func (Faceting) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Faceting) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Faceting) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Faceting) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type Health ΒΆ
type Health struct {
Status string `json:"status"`
}
Health is the request body for set Meilisearch health
func (Health) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Health) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Health) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Health) UnmarshalJSON ΒΆ
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 (Index) AddDocumentsCsv ΒΆ
func (i Index) AddDocumentsCsv(documents []byte, options *CsvDocumentsQuery) (resp *TaskInfo, err error)
func (Index) AddDocumentsCsvFromReader ΒΆ
func (Index) AddDocumentsCsvFromReaderInBatches ΒΆ
func (Index) AddDocumentsCsvInBatches ΒΆ
func (Index) AddDocumentsInBatches ΒΆ
func (Index) AddDocumentsNdjson ΒΆ
func (Index) AddDocumentsNdjsonFromReader ΒΆ
func (Index) AddDocumentsNdjsonFromReaderInBatches ΒΆ
func (Index) AddDocumentsNdjsonInBatches ΒΆ
func (Index) DeleteAllDocuments ΒΆ
func (Index) DeleteDocument ΒΆ
func (Index) DeleteDocuments ΒΆ
func (Index) DeleteDocumentsByFilter ΒΆ
func (Index) FetchPrimaryKey ΒΆ
func (Index) GetDisplayedAttributes ΒΆ
func (Index) GetDistinctAttribute ΒΆ
func (Index) GetDocument ΒΆ
func (i Index) GetDocument(identifier string, request *DocumentQuery, documentPtr interface{}) error
func (Index) GetDocuments ΒΆ
func (i Index) GetDocuments(request *DocumentsQuery, resp *DocumentsResult) error
func (Index) GetFaceting ΒΆ
func (Index) GetFilterableAttributes ΒΆ
func (Index) GetPagination ΒΆ
func (i Index) GetPagination() (resp *Pagination, err error)
func (Index) GetRankingRules ΒΆ
func (Index) GetSearchableAttributes ΒΆ
func (Index) GetSettings ΒΆ
func (Index) GetSortableAttributes ΒΆ
func (Index) GetStats ΒΆ
func (i Index) GetStats() (resp *StatsIndex, err error)
func (Index) GetStopWords ΒΆ
func (Index) GetTasks ΒΆ
func (i Index) GetTasks(param *TasksQuery) (resp *TaskResult, err error)
func (Index) GetTypoTolerance ΒΆ
func (i Index) GetTypoTolerance() (resp *TypoTolerance, err error)
func (Index) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Index) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (Index) ResetDisplayedAttributes ΒΆ
func (Index) ResetDistinctAttribute ΒΆ
func (Index) ResetEmbedders ΒΆ
func (Index) ResetFaceting ΒΆ
func (Index) ResetFilterableAttributes ΒΆ
func (Index) ResetPagination ΒΆ
func (Index) ResetRankingRules ΒΆ
func (Index) ResetSearchableAttributes ΒΆ
func (Index) ResetSettings ΒΆ
func (Index) ResetSortableAttributes ΒΆ
func (Index) ResetStopWords ΒΆ
func (Index) ResetSynonyms ΒΆ
func (Index) ResetTypoTolerance ΒΆ
func (Index) Search ΒΆ
func (i Index) Search(query string, request *SearchRequest) (*SearchResponse, error)
func (Index) SearchRaw ΒΆ
func (i Index) SearchRaw(query string, request *SearchRequest) (*json.RawMessage, error)
func (*Index) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Index) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
func (Index) UpdateDisplayedAttributes ΒΆ
func (Index) UpdateDistinctAttribute ΒΆ
func (Index) UpdateDocuments ΒΆ
func (Index) UpdateDocumentsCsv ΒΆ
func (i Index) UpdateDocumentsCsv(documents []byte, options *CsvDocumentsQuery) (resp *TaskInfo, err error)
func (Index) UpdateDocumentsCsvFromReader ΒΆ
func (Index) UpdateDocumentsCsvFromReaderInBatches ΒΆ
func (Index) UpdateDocumentsCsvInBatches ΒΆ
func (Index) UpdateDocumentsInBatches ΒΆ
func (Index) UpdateDocumentsNdjson ΒΆ
func (Index) UpdateDocumentsNdjsonFromReader ΒΆ
func (Index) UpdateDocumentsNdjsonInBatches ΒΆ
func (Index) UpdateEmbedders ΒΆ
func (Index) UpdateFaceting ΒΆ
func (Index) UpdateFilterableAttributes ΒΆ
func (*Index) UpdateIndex ΒΆ
func (Index) UpdatePagination ΒΆ
func (i Index) UpdatePagination(request *Pagination) (resp *TaskInfo, err error)
func (Index) UpdateRankingRules ΒΆ
func (Index) UpdateSearchableAttributes ΒΆ
func (Index) UpdateSettings ΒΆ
func (Index) UpdateSortableAttributes ΒΆ
func (Index) UpdateStopWords ΒΆ
func (Index) UpdateSynonyms ΒΆ
func (Index) UpdateTypoTolerance ΒΆ
func (i Index) UpdateTypoTolerance(request *TypoTolerance) (resp *TaskInfo, err error)
func (Index) WaitForTask ΒΆ
func (i Index) WaitForTask(taskUID int64, 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 ΒΆ
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 *TaskInfo, err error) Delete(uid string) (ok bool, err error) GetStats() (resp *StatsIndex, err error) AddDocuments(documentsPtr interface{}, primaryKey ...string) (resp *TaskInfo, err error) AddDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []TaskInfo, err error) AddDocumentsCsv(documents []byte, options *CsvDocumentsQuery) (resp *TaskInfo, err error) AddDocumentsCsvInBatches(documents []byte, batchSize int, options *CsvDocumentsQuery) (resp []TaskInfo, err error) AddDocumentsNdjson(documents []byte, primaryKey ...string) (resp *TaskInfo, err error) AddDocumentsNdjsonInBatches(documents []byte, batchSize int, primaryKey ...string) (resp []TaskInfo, err error) UpdateDocuments(documentsPtr interface{}, primaryKey ...string) (resp *TaskInfo, err error) UpdateDocumentsInBatches(documentsPtr interface{}, batchSize int, primaryKey ...string) (resp []TaskInfo, err error) UpdateDocumentsCsv(documents []byte, options *CsvDocumentsQuery) (resp *TaskInfo, err error) UpdateDocumentsCsvInBatches(documents []byte, batchsize int, options *CsvDocumentsQuery) (resp []TaskInfo, err error) UpdateDocumentsNdjson(documents []byte, primaryKey ...string) (resp *TaskInfo, err error) UpdateDocumentsNdjsonInBatches(documents []byte, batchsize int, primaryKey ...string) (resp []TaskInfo, err error) GetDocument(uid string, request *DocumentQuery, documentPtr interface{}) error GetDocuments(param *DocumentsQuery, resp *DocumentsResult) error DeleteDocument(uid string) (resp *TaskInfo, err error) DeleteDocuments(uid []string) (resp *TaskInfo, err error) DeleteDocumentsByFilter(filter interface{}) (resp *TaskInfo, err error) DeleteAllDocuments() (resp *TaskInfo, err error) Search(query string, request *SearchRequest) (*SearchResponse, error) SearchRaw(query string, request *SearchRequest) (*json.RawMessage, error) GetTask(taskUID int64) (resp *Task, err error) GetTasks(param *TasksQuery) (resp *TaskResult, err error) GetSettings() (resp *Settings, err error) UpdateSettings(request *Settings) (resp *TaskInfo, err error) ResetSettings() (resp *TaskInfo, err error) GetRankingRules() (resp *[]string, err error) UpdateRankingRules(request *[]string) (resp *TaskInfo, err error) ResetRankingRules() (resp *TaskInfo, err error) GetDistinctAttribute() (resp *string, err error) UpdateDistinctAttribute(request string) (resp *TaskInfo, err error) ResetDistinctAttribute() (resp *TaskInfo, err error) GetSearchableAttributes() (resp *[]string, err error) UpdateSearchableAttributes(request *[]string) (resp *TaskInfo, err error) ResetSearchableAttributes() (resp *TaskInfo, err error) GetDisplayedAttributes() (resp *[]string, err error) UpdateDisplayedAttributes(request *[]string) (resp *TaskInfo, err error) ResetDisplayedAttributes() (resp *TaskInfo, err error) GetStopWords() (resp *[]string, err error) UpdateStopWords(request *[]string) (resp *TaskInfo, err error) ResetStopWords() (resp *TaskInfo, err error) GetSynonyms() (resp *map[string][]string, err error) UpdateSynonyms(request *map[string][]string) (resp *TaskInfo, err error) ResetSynonyms() (resp *TaskInfo, err error) GetFilterableAttributes() (resp *[]string, err error) UpdateFilterableAttributes(request *[]string) (resp *TaskInfo, err error) ResetFilterableAttributes() (resp *TaskInfo, err error) WaitForTask(taskUID int64, options ...WaitParams) (*Task, error) }
type IndexesQuery ΒΆ
func (IndexesQuery) MarshalEasyJSON ΒΆ
func (v IndexesQuery) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (IndexesQuery) MarshalJSON ΒΆ
func (v IndexesQuery) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*IndexesQuery) UnmarshalEasyJSON ΒΆ
func (v *IndexesQuery) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*IndexesQuery) UnmarshalJSON ΒΆ
func (v *IndexesQuery) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type IndexesResults ΒΆ
type IndexesResults struct { Results []Index `json:"results"` Offset int64 `json:"offset"` Limit int64 `json:"limit"` Total int64 `json:"total"` }
Return of multiple indexes is wrap in a IndexesResults
func (IndexesResults) MarshalEasyJSON ΒΆ
func (v IndexesResults) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (IndexesResults) MarshalJSON ΒΆ
func (v IndexesResults) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*IndexesResults) UnmarshalEasyJSON ΒΆ
func (v *IndexesResults) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*IndexesResults) UnmarshalJSON ΒΆ
func (v *IndexesResults) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type Key ΒΆ
type Key struct { Name string `json:"name"` Description string `json:"description"` Key string `json:"key,omitempty"` UID string `json:"uid,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://www.meilisearch.com/docs/learn/security/master_api_keys#protecting-a-meilisearch-instance
func (Key) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Key) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Key) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Key) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type KeyParsed ΒΆ
type KeyParsed struct { Name string `json:"name"` Description string `json:"description"` UID string `json:"uid,omitempty"` Actions []string `json:"actions,omitempty"` Indexes []string `json:"indexes,omitempty"` ExpiresAt *string `json:"expiresAt"` }
This structure is used to send the exact ISO-8601 time format managed by Meilisearch
func (KeyParsed) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (KeyParsed) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*KeyParsed) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*KeyParsed) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type KeyUpdate ΒΆ
type KeyUpdate struct { Name string `json:"name,omitempty"` Description string `json:"description,omitempty"` }
This structure is used to update a Key
func (KeyUpdate) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (KeyUpdate) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*KeyUpdate) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*KeyUpdate) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type KeysQuery ΒΆ
func (KeysQuery) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (KeysQuery) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*KeysQuery) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*KeysQuery) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type KeysResults ΒΆ
type KeysResults struct { Results []Key `json:"results"` Offset int64 `json:"offset"` Limit int64 `json:"limit"` Total int64 `json:"total"` }
Return of multiple keys is wrap in a KeysResults
func (KeysResults) MarshalEasyJSON ΒΆ
func (v KeysResults) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (KeysResults) MarshalJSON ΒΆ
func (v KeysResults) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*KeysResults) UnmarshalEasyJSON ΒΆ
func (v *KeysResults) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*KeysResults) UnmarshalJSON ΒΆ
func (v *KeysResults) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type MinWordSizeForTypos ΒΆ
type MinWordSizeForTypos struct { OneTypo int64 `json:"oneTypo,omitempty"` TwoTypos int64 `json:"twoTypos,omitempty"` }
MinWordSizeForTypos is the type that represents the minWordSizeForTypos setting in the typo tolerance setting in Meilisearch
func (MinWordSizeForTypos) MarshalEasyJSON ΒΆ
func (v MinWordSizeForTypos) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (MinWordSizeForTypos) MarshalJSON ΒΆ
func (v MinWordSizeForTypos) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*MinWordSizeForTypos) UnmarshalEasyJSON ΒΆ
func (v *MinWordSizeForTypos) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*MinWordSizeForTypos) UnmarshalJSON ΒΆ
func (v *MinWordSizeForTypos) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type MultiSearchRequest ΒΆ
type MultiSearchRequest struct {
Queries []SearchRequest `json:"queries"`
}
func (MultiSearchRequest) MarshalEasyJSON ΒΆ
func (v MultiSearchRequest) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (MultiSearchRequest) MarshalJSON ΒΆ
func (v MultiSearchRequest) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*MultiSearchRequest) UnmarshalEasyJSON ΒΆ
func (v *MultiSearchRequest) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*MultiSearchRequest) UnmarshalJSON ΒΆ
func (v *MultiSearchRequest) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type MultiSearchResponse ΒΆ
type MultiSearchResponse struct {
Results []SearchResponse `json:"results"`
}
func (MultiSearchResponse) MarshalEasyJSON ΒΆ
func (v MultiSearchResponse) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (MultiSearchResponse) MarshalJSON ΒΆ
func (v MultiSearchResponse) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*MultiSearchResponse) UnmarshalEasyJSON ΒΆ
func (v *MultiSearchResponse) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*MultiSearchResponse) UnmarshalJSON ΒΆ
func (v *MultiSearchResponse) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type Pagination ΒΆ
type Pagination struct {
MaxTotalHits int64 `json:"maxTotalHits"`
}
Pagination is the type that represents the pagination setting in Meilisearch
func (Pagination) MarshalEasyJSON ΒΆ
func (v Pagination) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (Pagination) MarshalJSON ΒΆ
func (v Pagination) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*Pagination) UnmarshalEasyJSON ΒΆ
func (v *Pagination) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Pagination) UnmarshalJSON ΒΆ
func (v *Pagination) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type RawType ΒΆ
type RawType []byte
RawType is an alias for raw byte[]
func (RawType) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*RawType) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type SearchRequest ΒΆ
type SearchRequest struct { Offset int64 Limit int64 AttributesToRetrieve []string AttributesToSearchOn []string AttributesToCrop []string CropLength int64 CropMarker string AttributesToHighlight []string HighlightPreTag string HighlightPostTag string MatchingStrategy string Filter interface{} ShowMatchesPosition bool ShowRankingScore bool ShowRankingScoreDetails bool Facets []string PlaceholderSearch bool Sort []string Vector []float32 HitsPerPage int64 Page int64 IndexUID string Query string Hybrid *SearchRequestHybrid }
SearchRequest is the request url param needed for a search query. This struct will be converted to url param before sent.
Documentation: https://www.meilisearch.com/docs/reference/api/search#search-parameters
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 SearchRequestHybrid ΒΆ
func (SearchRequestHybrid) MarshalEasyJSON ΒΆ
func (v SearchRequestHybrid) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (SearchRequestHybrid) MarshalJSON ΒΆ
func (v SearchRequestHybrid) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*SearchRequestHybrid) UnmarshalEasyJSON ΒΆ
func (v *SearchRequestHybrid) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*SearchRequestHybrid) UnmarshalJSON ΒΆ
func (v *SearchRequestHybrid) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type SearchResponse ΒΆ
type SearchResponse struct { Hits []interface{} `json:"hits"` EstimatedTotalHits int64 `json:"estimatedTotalHits,omitempty"` Offset int64 `json:"offset,omitempty"` Limit int64 `json:"limit,omitempty"` ProcessingTimeMs int64 `json:"processingTimeMs"` Query string `json:"query"` FacetDistribution interface{} `json:"facetDistribution,omitempty"` TotalHits int64 `json:"totalHits,omitempty"` HitsPerPage int64 `json:"hitsPerPage,omitempty"` Page int64 `json:"page,omitempty"` TotalPages int64 `json:"totalPages,omitempty"` FacetStats interface{} `json:"facetStats,omitempty"` IndexUID string `json:"indexUid,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"` TypoTolerance *TypoTolerance `json:"typoTolerance,omitempty"` Pagination *Pagination `json:"pagination,omitempty"` Faceting *Faceting `json:"faceting,omitempty"` Embedders map[string]Embedder `json:"embedders,omitempty"` }
Settings is the type that represents the settings in Meilisearch
func (Settings) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Settings) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Settings) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Settings) UnmarshalJSON ΒΆ
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 ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Stats) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Stats) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Stats) UnmarshalJSON ΒΆ
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 SwapIndexesParams ΒΆ
type SwapIndexesParams struct {
Indexes []string `json:"indexes"`
}
func (SwapIndexesParams) MarshalEasyJSON ΒΆ
func (v SwapIndexesParams) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (SwapIndexesParams) MarshalJSON ΒΆ
func (v SwapIndexesParams) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*SwapIndexesParams) UnmarshalEasyJSON ΒΆ
func (v *SwapIndexesParams) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*SwapIndexesParams) UnmarshalJSON ΒΆ
func (v *SwapIndexesParams) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type Task ΒΆ
type Task struct { Status TaskStatus `json:"status"` UID int64 `json:"uid,omitempty"` TaskUID int64 `json:"taskUid,omitempty"` IndexUID string `json:"indexUid"` Type TaskType `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"` CanceledBy int64 `json:"canceledBy,omitempty"` }
Task indicates information about a task resource
Documentation: https://www.meilisearch.com/docs/learn/advanced/asynchronous_operations
func (Task) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Task) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Task) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Task) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type TaskInfo ΒΆ
type TaskInfo struct { Status TaskStatus `json:"status"` TaskUID int64 `json:"taskUid"` IndexUID string `json:"indexUid"` Type TaskType `json:"type"` EnqueuedAt time.Time `json:"enqueuedAt"` }
TaskInfo indicates information regarding a task returned by an asynchronous method
Documentation: https://www.meilisearch.com/docs/reference/api/tasks#tasks
func (TaskInfo) MarshalEasyJSON ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (TaskInfo) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*TaskInfo) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*TaskInfo) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface
type TaskResult ΒΆ
type TaskResult struct { Results []Task `json:"results"` Limit int64 `json:"limit"` From int64 `json:"from"` Next int64 `json:"next"` Total int64 `json:"total"` }
Return of multiple tasks is wrap in a TaskResult
func (TaskResult) MarshalEasyJSON ΒΆ
func (v TaskResult) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (TaskResult) MarshalJSON ΒΆ
func (v TaskResult) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*TaskResult) UnmarshalEasyJSON ΒΆ
func (v *TaskResult) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*TaskResult) UnmarshalJSON ΒΆ
func (v *TaskResult) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type TaskStatus ΒΆ
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" // TaskStatusCanceled the task was canceled TaskStatusCanceled TaskStatus = "canceled" )
type TaskType ΒΆ
type TaskType string
TaskType is the type of a task
const ( // TaskTypeIndexCreation represents an index creation TaskTypeIndexCreation TaskType = "indexCreation" // TaskTypeIndexUpdate represents an index update TaskTypeIndexUpdate TaskType = "indexUpdate" // TaskTypeIndexDeletion represents an index deletion TaskTypeIndexDeletion TaskType = "indexDeletion" // TaskTypeIndexSwap represents an index swap TaskTypeIndexSwap TaskType = "indexSwap" // TaskTypeDocumentAdditionOrUpdate represents a document addition or update in an index TaskTypeDocumentAdditionOrUpdate TaskType = "documentAdditionOrUpdate" // TaskTypeDocumentDeletion represents a document deletion from an index TaskTypeDocumentDeletion TaskType = "documentDeletion" // TaskTypeSettingsUpdate represents a settings update TaskTypeSettingsUpdate TaskType = "settingsUpdate" // TaskTypeDumpCreation represents a dump creation TaskTypeDumpCreation TaskType = "dumpCreation" // TaskTypeTaskCancelation represents a task cancelation TaskTypeTaskCancelation TaskType = "taskCancelation" // TaskTypeTaskDeletion represents a task deletion TaskTypeTaskDeletion TaskType = "taskDeletion" // TaskTypeSnapshotCreation represents a snapshot creation TaskTypeSnapshotCreation TaskType = "snapshotCreation" )
type TasksQuery ΒΆ
type TasksQuery struct { UIDS []int64 Limit int64 From int64 IndexUIDS []string Statuses []TaskStatus Types []TaskType CanceledBy []int64 BeforeEnqueuedAt time.Time AfterEnqueuedAt time.Time BeforeStartedAt time.Time AfterStartedAt time.Time BeforeFinishedAt time.Time AfterFinishedAt time.Time }
TasksQuery is a list of filter available to send as query parameters
func (TasksQuery) MarshalEasyJSON ΒΆ
func (v TasksQuery) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (TasksQuery) MarshalJSON ΒΆ
func (v TasksQuery) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*TasksQuery) UnmarshalEasyJSON ΒΆ
func (v *TasksQuery) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*TasksQuery) UnmarshalJSON ΒΆ
func (v *TasksQuery) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type TenantTokenClaims ΒΆ
type TenantTokenClaims struct { APIKeyUID string `json:"apiKeyUid"` SearchRules interface{} `json:"searchRules"` jwt.RegisteredClaims }
Custom Claims structure to create a Tenant Token
func (TenantTokenClaims) MarshalEasyJSON ΒΆ
func (v TenantTokenClaims) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (TenantTokenClaims) MarshalJSON ΒΆ
func (v TenantTokenClaims) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*TenantTokenClaims) UnmarshalEasyJSON ΒΆ
func (v *TenantTokenClaims) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*TenantTokenClaims) UnmarshalJSON ΒΆ
func (v *TenantTokenClaims) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type TenantTokenOptions ΒΆ
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 ΒΆ
func (v TenantTokenOptions) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (TenantTokenOptions) MarshalJSON ΒΆ
func (v TenantTokenOptions) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*TenantTokenOptions) UnmarshalEasyJSON ΒΆ
func (v *TenantTokenOptions) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*TenantTokenOptions) UnmarshalJSON ΒΆ
func (v *TenantTokenOptions) UnmarshalJSON(data []byte) error
UnmarshalJSON supports json.Unmarshaler interface
type TypoTolerance ΒΆ
type TypoTolerance struct { Enabled bool `json:"enabled,omitempty"` MinWordSizeForTypos MinWordSizeForTypos `json:"minWordSizeForTypos,omitempty"` DisableOnWords []string `json:"disableOnWords,omitempty"` DisableOnAttributes []string `json:"disableOnAttributes,omitempty"` }
TypoTolerance is the type that represents the typo tolerance setting in Meilisearch
func (TypoTolerance) MarshalEasyJSON ΒΆ
func (v TypoTolerance) MarshalEasyJSON(w *jwriter.Writer)
MarshalEasyJSON supports easyjson.Marshaler interface
func (TypoTolerance) MarshalJSON ΒΆ
func (v TypoTolerance) MarshalJSON() ([]byte, error)
MarshalJSON supports json.Marshaler interface
func (*TypoTolerance) UnmarshalEasyJSON ΒΆ
func (v *TypoTolerance) UnmarshalEasyJSON(l *jlexer.Lexer)
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*TypoTolerance) UnmarshalJSON ΒΆ
func (v *TypoTolerance) 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 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 ΒΆ
MarshalEasyJSON supports easyjson.Marshaler interface
func (Version) MarshalJSON ΒΆ
MarshalJSON supports json.Marshaler interface
func (*Version) UnmarshalEasyJSON ΒΆ
UnmarshalEasyJSON supports easyjson.Unmarshaler interface
func (*Version) UnmarshalJSON ΒΆ
UnmarshalJSON supports json.Unmarshaler interface