WorkspaceContainer Interface
A CloudSqliteContainer that holds one or more WorkspaceDbs. Normally a WorkspaceContainer will hold (many versions of) a single WorkspaceDb. Each version of a WorkspaceDb is treated as immutable after it is created and is stored in the WorkspaceContainer indefinitely. That means that older versions of the WorkspaceDb may continue to be used, for example by archived projects. For programmers familiar with NPM, this is conceptually similar and versioning follows the same rules as NPM using Semantic Versioning.
@note It is possible to store more than one WorkspaceDb in the same WorkspaceContainer, but access rights are administered per WorkspaceContainer. That is, if a user has rights to access a WorkspaceContainer, that right applies to all WorkspaceDbs in the WorkspaceContainer.
@see getContainer and getContainerAsync to load a container.
Extends
Methods
| Name | Description | |
|---|---|---|
| getWorkspaceDb(props?: WorkspaceDbProps): WorkspaceDb | Obtain a WorkspaceDb satisfying the name and version criteria specified by props. |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| resolveDbFileName(props: WorkspaceDbProps): string Inherited | CloudSqliteContainer | Find the fully-qualified name of a database satisfying the name and version criteria specified by props. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| cloudContainer Readonly Inherited | CloudSqlite.CloudContainer | undefined | CloudSqliteContainer | Cloud container for this container, or undefined if this is a local container. |
| fromProps Readonly Inherited | WorkspaceContainerProps | CloudSqliteContainer | Properties supplied when this container was loaded |
| workspace Readonly Inherited | Workspace | CloudSqliteContainer | The workspace into which this container was loaded. |
Defined in
Last Updated: 28 March, 2026