WorkspaceContainer Interface
A WorkspaceContainer is a type of CloudContainer 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.
@note Not every WorkspaceContainer is associated with a CloudContainer - WorkspaceContainers may also be loaded from the local file system.
In this case, cloudContainer will be undefined.
@see getContainer and getContainerAsync to load a container.
Methods
| Name | Description | |
|---|---|---|
| getWorkspaceDb(props?: WorkspaceDbProps): WorkspaceDb | Obtain a WorkspaceDb satisfying the name and version criteria specified by props. |
|
| resolveDbFileName(props: WorkspaceDbProps): string | Find the fully-qualified name of a WorkspaceDb satisfying the name and version criteria specified by props. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| cloudContainer Readonly | CloudSqlite.CloudContainer | undefined | Cloud container for this WorkspaceContainer, or undefined if this is a local WorkspaceContainer. |
|
| fromProps Readonly | WorkspaceContainerProps | Properties supplied when this container was loaded | |
| workspace Readonly | Workspace | The workspace into which this container was loaded. |
Defined in
Last Updated: 14 November, 2024