class
Meilisearch::Crystal::Documents
- Meilisearch::Crystal::Documents
- Meilisearch::Crystal::API
- Reference
- Object
Overview
Index document ingestion, retrieval, and deletion operations.
Defined in:
meilisearch/crystal/documents.crInstance Method Summary
- #delete(uid : String, id : String | Int32 | Int64) : TaskResult
- #delete(uid : String, ids : Enumerable) : TaskResult
- #delete(uid : String, *, filter : String) : TaskResult
- #delete_all(uid : String) : TaskResult
- #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)
- #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
- #upsert(uid : String, documents : Array, primary_key : String | Nil = nil) : TaskResult
- #upsert(uid : String, documents : Enumerable, primary_key : String | Nil = nil) : TaskResult
- #upsert!(uid : String, documents, primary_key : String | Nil = nil, timeout : Time::Span | Nil = nil, poll_interval : Time::Span = 100.milliseconds) : BasicTask
- #upsert_patch(uid : String, documents : Array, primary_key : String | Nil = nil) : TaskResult
- #upsert_patch(uid : String, documents : Enumerable, primary_key : String | Nil = nil) : TaskResult
- #upsert_patch!(uid : String, documents, primary_key : String | Nil = nil, timeout : Time::Span | Nil = nil, poll_interval : Time::Span = 100.milliseconds) : BasicTask
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 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)
#
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
#
def upsert!(uid : String, documents, primary_key : String | Nil = nil, timeout : Time::Span | Nil = nil, poll_interval : Time::Span = 100.milliseconds) : BasicTask
#
def upsert_patch(uid : String, documents : Enumerable, primary_key : String | Nil = nil) : TaskResult
#