SettingsDb Interface
A CloudSQLite database dedicated to storing settings as key-value pairs. Unlike a general-purpose WorkspaceDb,
a SettingsDb restricts its API surface to settings-only operations, providing a focused interface
for reading settings by name.
Internally, all settings are stored in a single JSON blob. Each setting is a named entry in a SettingsContainer.
A SettingsDb resides in a CloudSqliteContainer and can be published to the cloud. Once published,
the SettingsDb becomes immutable; however, multiple versions may be created to allow settings to evolve over time.
Methods
| Name | Description | |
|---|---|---|
| close(): void | Close the underlying database. | |
| getSetting<T extends JSONSchemaType>(settingName: string): undefined | T | Return a copy of the value of the setting named settingName, or undefined if not found. |
|
| getSettings(): SettingsContainer | Return a deep copy of all settings stored in this SettingsDb as a SettingsContainer. | |
| open(): void | Open the underlying database for querying. |
Properties
| Name | Type | Description | |
|---|---|---|---|
| container Readonly | CloudSqliteContainer | The CloudSqliteContainer in which this database resides. | |
| dbName Readonly | string | The base name of this SettingsDb, without version. | |
| isOpen Readonly | boolean | Whether the underlying database is currently open. | |
| manifest Readonly | SettingsDbManifest | The manifest describing the contents of this SettingsDb. | |
| priority Readonly | number | The priority assigned to dictionaries loaded from this SettingsDb. | |
| version Readonly | string | The resolved semver version of this SettingsDb. |
Defined in
Last Updated: 19 March, 2026
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.