Manage tenant states & temperature

Storage resources are grouped into tiers. Each tier has different performance characteristics and costs:

The pricing difference between Hot and Cold tiers is significant. Cloud storage is several orders of magnitude cheaper than RAM.

In multi-tenant collections, you can change tenant states (Active, Inactive, Offloaded) to move data between storage tiers. This allows granular trade-offs between cost, resource availability, and readiness.

There are three tenant states: Active, Inactive and Offloaded.

An Active tenant is available for queries and CRUD operations. Depending on the vector index type it uses either hot or warm resources.

The tenant's object data and inverted index are stored on disk, using warm resources.

An Inactive tenant is not available for queries nor CRUD operations.

The tenant's object data, vector index and inverted index are stored on disk, using warm resources. This can lower Weaviate's memory requirements compared to active tenants that use hot resources.

Since the tenant is stored locally, inactive tenants can be activated quickly.

An offloaded tenant is not available for queries or CRUD operations.

The tenant's object data, vector index and inverted index are stored on the cloud, using cold resources. Since the tenant is stored remotely, there is a delay when activating an offloaded tenant.

To activate an INACTIVE tenant from disk, or to onload and activate an OFFLOADED tenant from cloud, call:

from weaviate.classes.tenants import Tenant, TenantActivityStatusmulti_collection = client.collections.use("MultiTenancyCollection")multi_collection.tenants.update(tenants=[    Tenant(        name="tenantA",        activity_status=TenantActivityStatus.ACTIVE    )])

const multiCollection = client.collections.use(collectionName)await multiCollection.tenants.update({  name: 'tenantA',  activityStatus: 'ACTIVE'})

String tenantName = "tenantA";
CollectionHandle<Map<String, Object>> collection =
    client.collections.use(collectionName);
collection.tenants.activate(tenantName);

string[] tenantName = ["tenantA"];
await collection.Tenants.Activate(tenantName);

To deactivate an ACTIVE tenant, or to onload an OFFLOADED tenant from cloud (without activating it), call:

from weaviate.classes.tenants import Tenant, TenantActivityStatusmulti_collection = client.collections.use("MultiTenancyCollection")multi_collection.tenants.update(tenants=[    Tenant(        name="tenantA",        activity_status=TenantActivityStatus.INACTIVE    )])

const multiCollection = client.collections.use(collectionName)await multiCollection.tenants.update({  name: 'tenantA',  activityStatus: 'INACTIVE'})

String tenantName = "tenantA";
CollectionHandle<Map<String, Object>> collection =
    client.collections.use(collectionName);
collection.tenants.deactivate(tenantName);

string[] tenantName = ["tenantA"];
await collection.Tenants.Deactivate(tenantName);

To offload an ACTIVE or INACTIVE tenant to cloud, call:

from weaviate.classes.tenants import Tenant, TenantActivityStatusmulti_collection = client.collections.use("MultiTenancyCollection")multi_collection.tenants.update(tenants=[    Tenant(        name="tenantA",        activity_status=TenantActivityStatus.OFFLOADED    )])

const multiCollection = client.collections.use(collectionName)await multiCollection.tenants.update({  name: 'tenantA',  activityStatus: 'OFFLOADED'})

String tenantName = "tenantA";
CollectionHandle<Map<String, Object>> collection =
    client.collections.use(collectionName);
collection.tenants.offload(tenantName);

await collection.Tenants.Offload(new[] { "tenantA" });

Enable this to automatically activate INACTIVE or OFFLOADED tenants if a search, read, update, or delete operation is performed on them.

from weaviate.classes.config import Configuremulti_collection = client.collections.create(    name="CollectionWithAutoTenantActivation",    multi_tenancy_config=Configure.multi_tenancy(        enabled=True,        auto_tenant_activation=True  # Enable automatic tenant activation    ))

const result = await client.collections.create({  name: 'CollectionWithAutoTenantActivation',  multiTenancy: weaviate.configure.multiTenancy({    enabled: true,    autoTenantActivation: true  })})

client.collections.create("MultiTenancyCollection",
    col -> col.multiTenancy(mt -> mt.autoTenantActivation(true)));

await client.Collections.Create(
    new CollectionCreateParams
    {
        Name = "MultiTenancyCollection",
        MultiTenancyConfig = new MultiTenancyConfig
        {
            Enabled = true,
            AutoTenantActivation = true,
        },
    }
);

Have a question or feedback? Here's how to reach us.