API Reference › core-backend› Workspace › EditableSettingsDb

EditableSettingsDb Interface

An editable SettingsDb. This is used only by tools to allow administrators to create and modify SettingsDbs. For cloud-based SettingsDbs, the container's write token must be obtained via acquireWriteLock before the methods in this interface may be used. Normally, only admins will have write access. Only one admin at a time may be editing a settings container.

@note Unlike EditableWorkspaceDb, this interface only supports settings operations — no blob, file, or string resource methods.

Extends

Methods

Name Description
removeSetting(settingName: string): void Remove a single Setting by name.  
updateManifest(manifest: SettingsDbManifest): void Update the contents of the manifest in this SettingsDb.  
updateSetting(args: UpdateSettingArgs): void Add or update a single Setting by name.  
updateSettings(settings: SettingsContainer): void Replace all settings in this SettingsDb with the given container.  

Inherited methods

Name Inherited from Description
close(): void Inherited SettingsDb Close the underlying database.
getSetting<T extends JSONSchemaType>(settingName: string): undefined | T Inherited SettingsDb Return a copy of the value of the setting named settingName, or undefined if not found.
getSettings(): SettingsContainer Inherited SettingsDb Return a deep copy of all settings stored in this SettingsDb as a SettingsContainer.
open(): void Inherited SettingsDb Open the underlying database for querying.

Properties

Name Type Description
container Readonly EditableSettingsCloudContainer The CloudSqliteContainer in which this database resides.  

Inherited properties

Name Type Inherited from Description
dbName Readonly Inherited string SettingsDb The base name of this SettingsDb, without version.
isOpen Readonly Inherited boolean SettingsDb Whether the underlying database is currently open.
manifest Readonly Inherited SettingsDbManifest SettingsDb The manifest describing the contents of this SettingsDb.
priority Readonly Inherited number SettingsDb The priority assigned to dictionaries loaded from this SettingsDb.
version Readonly Inherited string SettingsDb The resolved semver version of this SettingsDb.

Defined in

Last Updated: 19 March, 2026