module Meilisearch::Crystal

Overview

Index-scoped handle returned by Client#index(uid).

Binds an index uid to the client and will delegate to the Documents / Search / Settings resources (filled in as those resources land). For now it carries the binding and the metadata snapshot accessor.

Defined in:

meilisearch-crystal.cr
meilisearch/crystal/advanced.cr
meilisearch/crystal/api.cr
meilisearch/crystal/client.cr
meilisearch/crystal/config.cr
meilisearch/crystal/documents.cr
meilisearch/crystal/error.cr
meilisearch/crystal/exceptions.cr
meilisearch/crystal/index.cr
meilisearch/crystal/index_client.cr
meilisearch/crystal/indexes.cr
meilisearch/crystal/management.cr
meilisearch/crystal/resource.cr
meilisearch/crystal/search.cr
meilisearch/crystal/settings.cr
meilisearch/crystal/task.cr
meilisearch/crystal/tasks.cr
meilisearch/crystal/version.cr

Constant Summary

VERSION = {{ (`shards version \"/home/runner/work/meilisearch-crystal/meilisearch-crystal/src/meilisearch/crystal\"`).chomp.stringify }}

The shard version, read from shard.yml at compile time.

Class Method Summary

• .client : Client

  Lazily-built client from the configured defaults (or environment variables / library defaults when unset).

• .configure(&) : Configuration

  Yields the module-level settings; any subsequent .client call is rebuilt from the updated defaults.

• .settings

Class Method Detail