meili

package
v0.1.21 Latest Latest
Warning

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

Go to latest
Published: Dec 19, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

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

Client Meilisearch client wrapper

func NewMeilisearch

func NewMeilisearch(host, apiKey string) *Client

NewMeilisearch creates new Meilisearch client

func (*Client) AddDocuments

func (c *Client) AddDocuments(index string, documents any, primaryKey ...string) error

AddDocuments adds documents to Meilisearch

func (*Client) AddDocumentsInBatches

func (c *Client) AddDocumentsInBatches(index string, documents any, batchSize int, primaryKey ...string) error

AddDocumentsInBatches adds documents in batches to Meilisearch

func (*Client) CreateIndex

func (c *Client) CreateIndex(config *meilisearch.IndexConfig) (*meilisearch.TaskInfo, error)

CreateIndex creates a new index in Meilisearch

func (*Client) DeleteAllDocuments

func (c *Client) DeleteAllDocuments(index string) error

DeleteAllDocuments deletes all documents from an index

func (*Client) DeleteDocument

func (c *Client) DeleteDocument(index, documentID string) error

DeleteDocument deletes a single document from Meilisearch

func (*Client) DeleteDocuments

func (c *Client) DeleteDocuments(index string, documentIDs ...string) error

DeleteDocuments deletes multiple documents from Meilisearch

func (*Client) DeleteDocumentsByFilter

func (c *Client) DeleteDocumentsByFilter(index string, filter any) error

DeleteDocumentsByFilter deletes documents by filter

func (*Client) DeleteIndex

func (c *Client) DeleteIndex(indexUID string) (*meilisearch.TaskInfo, error)

DeleteIndex deletes an index from Meilisearch

func (*Client) GetClient

func (c *Client) GetClient() meilisearch.ServiceManager

GetClient returns the underlying meilisearch client

func (*Client) GetDocument

func (c *Client) GetDocument(index, documentID string, request *meilisearch.DocumentQuery, documentPtr any) error

GetDocument gets a single document from Meilisearch

func (*Client) GetDocuments

func (c *Client) GetDocuments(index string, request *meilisearch.DocumentsQuery) (*meilisearch.DocumentsResult, error)

GetDocuments gets multiple documents from Meilisearch

func (*Client) GetIndex

func (c *Client) GetIndex(indexUID string) (*meilisearch.IndexResult, error)

GetIndex gets a specific index from Meilisearch

func (*Client) GetIndexStats

func (c *Client) GetIndexStats(indexUID string) (*meilisearch.StatsIndex, error)

GetIndexStats gets stats for a specific index

func (*Client) GetIndexes

func (c *Client) GetIndexes(query *meilisearch.IndexesQuery) (*meilisearch.IndexesResults, error)

GetIndexes gets all indexes from Meilisearch

func (*Client) GetSettings

func (c *Client) GetSettings(indexUID string) (*meilisearch.Settings, error)

GetSettings gets index settings

func (*Client) GetStats

func (c *Client) GetStats() (*meilisearch.Stats, error)

GetStats gets global stats

func (*Client) GetTask

func (c *Client) GetTask(taskUID int64) (*meilisearch.Task, error)

GetTask gets task information

func (*Client) GetTasks

func (c *Client) GetTasks(param *meilisearch.TasksQuery) (*meilisearch.TaskResult, error)

GetTasks gets multiple tasks

func (*Client) GetVersion

func (c *Client) GetVersion() (*meilisearch.Version, error)

GetVersion gets Meilisearch version

func (*Client) Health

func (c *Client) Health() (*meilisearch.Health, error)

Health checks if Meilisearch is healthy

func (*Client) IndexDocuments

func (c *Client) IndexDocuments(index string, documents any, primaryKey ...string) error

IndexDocuments indexes documents to Meilisearch (alias for AddDocuments)

func (*Client) IsHealthy

func (c *Client) IsHealthy() bool

IsHealthy checks if Meilisearch is healthy (convenience method)

func (*Client) ListIndexes

func (c *Client) ListIndexes(query *meilisearch.IndexesQuery) (*meilisearch.IndexesResults, error)

ListIndexes is an alias for GetIndexes for consistency with official SDK

func (*Client) MultiSearch

MultiSearch performs multi-index search

func (*Client) MultiSearchWithContext

func (c *Client) MultiSearchWithContext(ctx context.Context, queries *meilisearch.MultiSearchRequest) (*meilisearch.MultiSearchResponse, error)

MultiSearchWithContext performs multi-index search with context

func (*Client) ResetSettings

func (c *Client) ResetSettings(indexUID string) (*meilisearch.TaskInfo, error)

ResetSettings resets index settings to default

func (*Client) Search

func (c *Client) Search(index, query string, options *meilisearch.SearchRequest) (*meilisearch.SearchResponse, error)

Search searches from Meilisearch

func (*Client) SearchWithContext

func (c *Client) SearchWithContext(ctx context.Context, index, query string, options *meilisearch.SearchRequest) (*meilisearch.SearchResponse, error)

SearchWithContext performs search with context

func (*Client) UpdateDocuments

func (c *Client) UpdateDocuments(index string, documents any, primaryKey ...string) error

UpdateDocuments updates documents in Meilisearch

func (*Client) UpdateDocumentsInBatches

func (c *Client) UpdateDocumentsInBatches(index string, documents any, batchSize int, primaryKey ...string) error

UpdateDocumentsInBatches updates documents in batches in Meilisearch

func (*Client) UpdateIndex

func (c *Client) UpdateIndex(indexUID, primaryKey string) (*meilisearch.TaskInfo, error)

UpdateIndex updates an index in Meilisearch

func (*Client) UpdateSettings

func (c *Client) UpdateSettings(indexUID string, settings *meilisearch.Settings) (*meilisearch.TaskInfo, error)

UpdateSettings updates index settings

func (*Client) WaitForTask

func (c *Client) WaitForTask(taskUID int64) (*meilisearch.Task, error)

WaitForTask waits for a task to complete

func (*Client) WaitForTaskWithInterval

func (c *Client) WaitForTaskWithInterval(taskUID int64, interval time.Duration) (*meilisearch.Task, error)

WaitForTaskWithInterval waits for a task to complete with custom interval

type SearchParams

type SearchParams = meilisearch.SearchRequest

SearchParams is an alias for meilisearch.SearchRequest type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL