EditableSettingsCloudContainer Interface
A CloudSqliteContainer opened for editing settings by a SettingsEditor. You can create new SettingsDbs or new versions of existing SettingsDbs inside it. Before actually making any changes to the container's contents, you must first obtain an exclusive write lock on it via acquireWriteLock. Only one user can hold the write lock at any given time. When you have finished making changes, you can use releaseWriteLock to publish your changes, or abandonChanges to discard them.
@note Settings containers are separate from workspace containers, providing independent write locks. Editing settings does not block workspace resource editing, and vice versa.
Extends
Methods
| Name | Description | |
|---|---|---|
| abandonChanges(): void | Abandon any changes made to the container and release the write lock. | |
| acquireWriteLock(user: string): void | Acquire the write lock on the container. | |
| createDb(args: CreateSettingsDbArgs): Promise<EditableSettingsDb> | Create a new, empty SettingsDb. | |
| createNewSettingsDbVersion(args: CreateNewSettingsDbVersionArgs): Promise<SettingsDbVersionResult> | Create a copy of an existing SettingsDb in this container with a new WorkspaceDbVersion. | |
| getEditableDb(props?: SettingsDbProps): EditableSettingsDb | Get an editable SettingsDb to add, delete, or update settings within a newly created version of a SettingsDb. | |
| releaseWriteLock(): void | Release the write lock on the container. |
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. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| cloudProps Readonly | undefined | WorkspaceContainerProps | Get the cloud properties of this container. |
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: 19 March, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.