@spec activate(WeaviateEx.Client.t(), collection_name(), tenant_names()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

Activate tenant (set to HOT status).

Examples

{:ok, _} = Tenants.activate(client, "Article", "TenantA")
{:ok, _} = Tenants.activate(client, "Article", ["TenantA", "TenantB"])

Returns

• {:ok, [map()]} - Updated tenants
• {:error, Error.t()} - Error if update fails

@spec batch_size() :: pos_integer()

Returns the batch size used for batch operations.

Examples

100 = Tenants.batch_size()

@spec batch_update(WeaviateEx.Client.t(), collection_name(), [map()]) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

Updates tenants in batches of 100 (matching Python client behavior).

This is useful for updating large numbers of tenants efficiently without overwhelming the server with a single large request.

Examples

tenants = [
  %{name: "tenant1", activity_status: :hot},
  %{name: "tenant2", activity_status: :cold}
]
{:ok, results} = Tenants.batch_update(client, "Article", tenants)

Returns

• {:ok, [map()]} - All updated tenants combined
• {:error, Error.t()} - Error from first failed batch

@spec count(WeaviateEx.Client.t(), collection_name()) ::
  {:ok, integer()} | {:error, WeaviateEx.Error.t()}

Count total tenants for a collection.

Examples

{:ok, 5} = Tenants.count(client, "Article")

Returns

• {:ok, integer()} - Number of tenants
• {:error, Error.t()} - Error if request fails

@spec create(WeaviateEx.Client.t(), collection_name(), tenant_names(), opts()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

Create one or more tenants.

Examples

{:ok, _} = Tenants.create(client, "Article", "TenantA")
{:ok, _} = Tenants.create(client, "Article", ["TenantA", "TenantB"])
{:ok, _} = Tenants.create(client, "Article", "TenantA", activity_status: :cold)

Returns

• {:ok, [map()]} - Created tenants
• {:error, Error.t()} - Error if creation fails

@spec deactivate(WeaviateEx.Client.t(), collection_name(), tenant_names()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

Deactivate tenant (set to COLD status).

Examples

{:ok, _} = Tenants.deactivate(client, "Article", "TenantA")

Returns

• {:ok, [map()]} - Updated tenants
• {:error, Error.t()} - Error if update fails

@spec delete(WeaviateEx.Client.t(), collection_name(), tenant_names()) ::
  {:ok, map()} | {:error, WeaviateEx.Error.t()}

Delete one or more tenants.

Examples

{:ok, _} = Tenants.delete(client, "Article", "TenantA")
{:ok, _} = Tenants.delete(client, "Article", ["TenantA", "TenantB"])

Returns

• {:ok, map()} - Empty map on success
• {:error, Error.t()} - Error if deletion fails

@spec ensure_active(WeaviateEx.Client.t(), collection_name(), tenant_name()) ::
  :ok | {:error, WeaviateEx.Error.t()}

Ensures a tenant exists and is active (HOT).

Creates the tenant if it doesn't exist (when auto-creation is not enabled). Activates the tenant if it's not HOT.

Examples

:ok = Tenants.ensure_active(client, "Articles", "tenant1")

Returns

• :ok - Tenant is now active
• {:error, Error.t()} - Error if operation fails

@spec exists?(WeaviateEx.Client.t(), collection_name(), tenant_name()) ::
  {:ok, boolean()}

Check if tenant exists.

Examples

{:ok, true} = Tenants.exists?(client, "Article", "TenantA")
{:ok, false} = Tenants.exists?(client, "Article", "NonExistent")

Returns

• {:ok, boolean()} - True if exists, false otherwise

@spec freeze(WeaviateEx.Client.t(), collection_name(), tenant_names()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

Freeze tenant (set to FROZEN status).

Frozen tenants have their data persisted but are not loaded into memory. This is more aggressive than COLD status.

Examples

{:ok, _} = Tenants.freeze(client, "Article", "TenantA")
{:ok, _} = Tenants.freeze(client, "Article", ["TenantA", "TenantB"])

Returns

• {:ok, [map()]} - Updated tenants
• {:error, Error.t()} - Error if update fails

@spec get(WeaviateEx.Client.t(), collection_name(), tenant_name()) ::
  {:ok, map()} | {:error, WeaviateEx.Error.t()}

Get specific tenant information.

Uses gRPC when available for optimal performance, falls back to HTTP otherwise.

Examples

{:ok, tenant} = Tenants.get(client, "Article", "TenantA")

Returns

• {:ok, map()} - Tenant information
• {:error, Error.t()} - Error if not found

@spec list(WeaviateEx.Client.t(), collection_name()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

List all tenants for a collection.

Uses gRPC when available for optimal performance, falls back to HTTP otherwise.

Examples

{:ok, tenants} = Tenants.list(client, "Article")

Returns

• {:ok, [map()]} - List of tenants
• {:error, Error.t()} - Error if request fails

@spec list_active(WeaviateEx.Client.t(), collection_name()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

List only active (HOT) tenants.

Examples

{:ok, active_tenants} = Tenants.list_active(client, "Article")

Returns

• {:ok, [map()]} - List of active tenants
• {:error, Error.t()} - Error if request fails

@spec list_inactive(WeaviateEx.Client.t(), collection_name()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

List only inactive (COLD/FROZEN) tenants.

Examples

{:ok, inactive_tenants} = Tenants.list_inactive(client, "Article")

Returns

• {:ok, [map()]} - List of inactive tenants
• {:error, Error.t()} - Error if request fails

@spec offload(WeaviateEx.Client.t(), collection_name(), tenant_names()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

Offload tenant (set to OFFLOADED status).

Offloaded tenants are moved to cold storage. This is the most aggressive deactivation option and may take longer to reactivate.

Examples

{:ok, _} = Tenants.offload(client, "Article", "TenantA")
{:ok, _} = Tenants.offload(client, "Article", ["TenantA", "TenantB"])

Returns

• {:ok, [map()]} - Updated tenants
• {:error, Error.t()} - Error if update fails

@spec update(WeaviateEx.Client.t(), collection_name(), tenant_names(), opts()) ::
  {:ok, [map()]} | {:error, WeaviateEx.Error.t()}

Update tenant(s) activity status.

Examples

{:ok, _} = Tenants.update(client, "Article", "TenantA", activity_status: :cold)
{:ok, _} = Tenants.update(client, "Article", ["TenantA", "TenantB"], activity_status: :hot)

Returns

• {:ok, [map()]} - Updated tenants
• {:error, Error.t()} - Error if update fails

@spec update_many(WeaviateEx.Client.t(), collection_name(), [map()], keyword()) ::
  :ok | {:error, WeaviateEx.Error.t()}

Updates multiple tenants' status in a single batch.

Batches updates into groups of 100 (Weaviate limit). This is an alias for batch_update/3 with additional options support.

Examples

# Activate multiple tenants
Tenants.update_many(client, "Articles", [
  %{name: "tenant1", status: :hot},
  %{name: "tenant2", status: :hot}
])

# Deactivate tenants
Tenants.update_many(client, "Articles", [
  %{name: "tenant1", status: :cold}
])

# With custom batch size
Tenants.update_many(client, "Articles", updates, batch_size: 50)

Returns

• :ok - All updates succeeded
• {:error, Error.t()} - Error from first failed batch