Class SzConfigManager

Index

Constructors

Methods

createConfig createConfigFromId createConfigFromDefinition getConfigRegistry getDefaultConfigId registerConfig replaceDefaultConfigId setDefaultConfig setDefaultConfigId

Constructors

constructor

new SzConfigManager(): SzConfigManager
Returns SzConfigManager

Methods

createConfig

createConfig(): string
Creates a new configuration from the default template and exports it as JSON.

Returns string
- Defined in packages/sdk/index.d.ts:5
createConfig(): string
Creates a new configuration from the default template and exports it as JSON.

Returns string
Example: Create a template configuration
```
const configMgr = env.getConfigManager();
const configDef = configMgr.createConfig();
const config = JSON.parse(configDef);
console.log("Data sources:", config.G2_CONFIG.CFG_DSRC);
```
See
- init-default-config snippet
- register-data-sources snippet
- Defined in packages/sdk/sdk.d.ts:458

createConfigFromId

createConfigFromId(configId: number): string
Creates a configuration from a registered configuration ID and exports it as JSON.
Parameters
- configId: number
Returns string
- Defined in packages/sdk/index.d.ts:7

createConfigFromDefinition

createConfigFromDefinition(configDefinition: string): string
Creates a configuration from a JSON definition string and exports it as JSON.
Parameters
- configDefinition: string
Returns string
- Defined in packages/sdk/index.d.ts:9

getConfigRegistry

getConfigRegistry(): string
Gets information about all registered configuration versions as a JSON string.

Returns string
- Defined in packages/sdk/index.d.ts:11
getConfigRegistry(): string
Gets information about all registered configuration versions as a JSON string.

Returns string
Example: List all registered configurations
```
const configMgr = env.getConfigManager();
const registry = JSON.parse(configMgr.getConfigRegistry());
for (const cfg of registry.CONFIGS) {
  console.log(`Config ${cfg.CONFIG_ID}: ${cfg.CONFIG_COMMENTS}`);
}
```
See
register-data-sources snippet
- Defined in packages/sdk/sdk.d.ts:549

getDefaultConfigId

getDefaultConfigId(): number
Gets the currently active default configuration ID.

Returns number
- Defined in packages/sdk/index.d.ts:13
getDefaultConfigId(): number
Gets the currently active default configuration ID.

Returns number
Example: Get the current default config ID
```
const configMgr = env.getConfigManager();
const configId = configMgr.getDefaultConfigId();
console.log("Default config ID:", configId);
```
See
init-default-config snippet
- Defined in packages/sdk/sdk.d.ts:533

registerConfig

registerConfig(configDefinition: string, configComment?: string): number
Registers a new configuration version and returns the assigned configuration ID.
Parameters
- configDefinition: string
- OptionalconfigComment: string
Returns number
- Defined in packages/sdk/index.d.ts:15
registerConfig(configDefinition: string, configComment?: string): number
Registers a new configuration version and returns the assigned configuration ID.
Parameters
- configDefinition: string
- OptionalconfigComment: string
Returns number
Example: Register a config without activating it
```
const configMgr = env.getConfigManager();
const configDef = configMgr.createConfig();
const configId = configMgr.registerConfig(configDef, "staging config");
console.log("Registered config ID:", configId);
```
See
register-data-sources snippet
- Defined in packages/sdk/sdk.d.ts:489

replaceDefaultConfigId

replaceDefaultConfigId(
currentDefaultConfigId: number,
newDefaultConfigId: number,
): void
Atomically replaces the default configuration ID (optimistic locking).
Parameters
- currentDefaultConfigId: number
- newDefaultConfigId: number
Returns void
- Defined in packages/sdk/index.d.ts:17
replaceDefaultConfigId(
currentDefaultConfigId: number,
newDefaultConfigId: number,
): void
Atomically replaces the default configuration ID (optimistic locking).
Parameters
- currentDefaultConfigId: number
- newDefaultConfigId: number
Returns void
Example: Atomic config swap with conflict detection
```
const configMgr = env.getConfigManager();
const currentId = configMgr.getDefaultConfigId();
const configDef = configMgr.createConfig();
const newId = configMgr.registerConfig(configDef, "updated config");
configMgr.replaceDefaultConfigId(currentId, newId);
```
See
register-data-sources snippet
- Defined in packages/sdk/sdk.d.ts:519

setDefaultConfig

setDefaultConfig(configDefinition: string, configComment?: string): number
Registers and activates a configuration in one operation, returning the assigned ID.
Parameters
- configDefinition: string
- OptionalconfigComment: string
Returns number
- Defined in packages/sdk/index.d.ts:19
setDefaultConfig(configDefinition: string, configComment?: string): number
Registers and activates a configuration in one operation, returning the assigned ID.
Parameters
- configDefinition: string
- OptionalconfigComment: string
Returns number
Example: Register and activate a configuration
```
const configMgr = env.getConfigManager();
const configDef = configMgr.createConfig();
const configId = configMgr.setDefaultConfig(configDef, "initial config");
console.log("Active config ID:", configId);
```
See
- init-default-config snippet
- register-data-sources snippet
- Defined in packages/sdk/sdk.d.ts:474

setDefaultConfigId

setDefaultConfigId(configId: number): void
Sets the active configuration by ID.
Parameters
- configId: number
Returns void
- Defined in packages/sdk/index.d.ts:21
setDefaultConfigId(configId: number): void
Sets the active configuration by ID.
Parameters
- configId: number
Returns void
Example: Activate a previously registered config
```
const configMgr = env.getConfigManager();
configMgr.setDefaultConfigId(configId);
env.reinitialize(configId);
```
See
init-default-config snippet
- Defined in packages/sdk/sdk.d.ts:503

Class SzConfigManager

Index

Constructors

Methods

Constructors

constructor

Returns SzConfigManager

Methods

createConfig

Returns string

Returns string

Example: Create a template configuration

See

createConfigFromId

Parameters

Returns string

createConfigFromDefinition

Parameters

Returns string

getConfigRegistry

Returns string

Returns string

Example: List all registered configurations

See

getDefaultConfigId

Returns number

Returns number

Example: Get the current default config ID

See

registerConfig

Parameters

Returns number

Parameters

Returns number

Example: Register a config without activating it

See

replaceDefaultConfigId

Parameters

Returns void

Parameters

Returns void

Example: Atomic config swap with conflict detection

See

setDefaultConfig

Parameters

Returns number

Parameters

Returns number

Example: Register and activate a configuration

See

setDefaultConfigId

Parameters

Returns void

Parameters

Returns void

Example: Activate a previously registered config

See

Settings

On This Page