DbCloudContainerInfo Interface

Frontend-safe, serializable subset of cloud-hosted database container properties. Contains only identification and configuration fields suitable for display in user interfaces, without backend-only operational fields like access tokens, lock timeouts, or sync behavior.

Properties

Name Type Description
alias Readonly string | undefined An alias for the container.  
baseUri Readonly string The base URI for the container's cloud storage.  
containerId Readonly string The unique identifier of the container.  
dbName Readonly string | undefined The name of the database within the container.  
description Readonly string | undefined A user-friendly description of the container's contents.  
isPublic Readonly boolean | undefined Whether the container is public (does not require authorization).  
storageType Readonly "azure" | "google" The type of cloud storage provider.  
version Readonly string | undefined The range of acceptable versions of the database (semver range, e.g., ">=1.2.0 <2.0.0").  
writeable Readonly boolean | undefined Whether the container is allowed to request a write lock.  

Defined in

Last Updated: 25 March, 2026