pub struct TenantManagement;Expand description
The FoundationDB API includes function to manage the set of tenants in a cluster.
Implementations§
source§impl TenantManagement
impl TenantManagement
sourcepub async fn create_tenant(
db: &Database,
tenant_name: &[u8],
) -> Result<(), FdbError>
pub async fn create_tenant( db: &Database, tenant_name: &[u8], ) -> Result<(), FdbError>
Creates a new tenant in the cluster using a transaction created on the specified Database.
his operation will first check whether the tenant exists, and if it does it will set the Result
to a tenant_already_exists error. Otherwise, it will attempt to create the tenant in a retry loop.
If the tenant is created concurrently by another transaction, this function may still return successfully.
sourcepub async fn get_tenant(
db: &Database,
tenant_name: &[u8],
) -> Result<Option<Result<TenantInfo, Error>>, FdbError>
pub async fn get_tenant( db: &Database, tenant_name: &[u8], ) -> Result<Option<Result<TenantInfo, Error>>, FdbError>
Get a tenant in the cluster using a transaction created on the specified Database.
sourcepub async fn delete_tenant(
db: &Database,
tenant_name: &[u8],
) -> Result<(), FdbError>
pub async fn delete_tenant( db: &Database, tenant_name: &[u8], ) -> Result<(), FdbError>
Deletes a tenant from the cluster using a transaction created on the specified Database.
This operation will first check whether the tenant exists, and if it does not it will set the
result to a tenant_not_found error. Otherwise, it will attempt to delete the tenant in a retry loop.
If the tenant is deleted concurrently by another transaction, this function may still return successfully.
sourcepub async fn list_tenant(
db: &Database,
begin: &[u8],
end: &[u8],
limit: Option<usize>,
) -> Result<Vec<Result<TenantInfo, Error>>, FdbError>
pub async fn list_tenant( db: &Database, begin: &[u8], end: &[u8], limit: Option<usize>, ) -> Result<Vec<Result<TenantInfo, Error>>, FdbError>
Lists all tenants in between the range specified. The number of tenants listed can be restricted. This is a convenience method that generates the begin and end ranges by packing two Tuples.