class Meilisearch::Crystal::Documents

Overview

Index document ingestion, retrieval, and deletion operations.

Defined in:

meilisearch/crystal/documents.cr

Instance Method Summary

Instance methods inherited from class Meilisearch::Crystal::API

client : Client client, http(*args, **options)
http(*args, **options, &)
http

Constructor methods inherited from class Meilisearch::Crystal::API

new(client : Client) new

Macros inherited from class Meilisearch::Crystal::API

pass(*methods) pass

Instance Method Detail

def delete(uid : String, id : String | Int32 | Int64) : TaskResult #

[View source]
def delete(uid : String, ids : Enumerable) : TaskResult #

[View source]
def delete(uid : String, *, filter : String) : TaskResult #

[View source]
def delete_all(uid : String) : TaskResult #

[View source]
def fetch(uid : String, offset : Int32 | Nil = nil, limit : Int32 | Nil = nil, fields : Enumerable(String) | Nil = nil, ids : Array(String) | Array(Int32) | Array(Int64) | Nil = nil, filter : String | Nil = nil, sort : Enumerable(String) | Nil = nil) : List(JSON::Any) #

[View source]
def fetch(uid : String, as type : T.class, offset : Int32 | Nil = nil, limit : Int32 | Nil = nil, fields : Enumerable(String) | Nil = nil, ids : Array(String) | Array(Int32) | Array(Int64) | Nil = nil, filter : String | Nil = nil, sort : Enumerable(String) | Nil = nil) : List(T) forall T #

[View source]
def upsert(uid : String, documents : Array, primary_key : String | Nil = nil) : TaskResult #

[View source]
def upsert(uid : String, documents : Enumerable, primary_key : String | Nil = nil) : TaskResult #

[View source]
def upsert!(uid : String, documents, primary_key : String | Nil = nil, timeout : Time::Span | Nil = nil, poll_interval : Time::Span = 100.milliseconds) : BasicTask #

[View source]
def upsert_patch(uid : String, documents : Array, primary_key : String | Nil = nil) : TaskResult #

[View source]
def upsert_patch(uid : String, documents : Enumerable, primary_key : String | Nil = nil) : TaskResult #

[View source]
def upsert_patch!(uid : String, documents, primary_key : String | Nil = nil, timeout : Time::Span | Nil = nil, poll_interval : Time::Span = 100.milliseconds) : BasicTask #

[View source]