RuntimeConfig
Defined in: runtime-config.ts:17
Methods
Section titled “Methods”get(key): Promise<string | undefined>;Defined in: runtime-config.ts:45
Read a configuration entry.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key | string |
Returns
Section titled “Returns”Promise<string | undefined>
the entry value, or undefined if not set and no default exists
on the server.
getAll()
Section titled “getAll()”getAll(prefix?): Promise<Record<string, string>>;Defined in: runtime-config.ts:61
Return all configuration entries currently set on the session.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
prefix? | string | Optional key prefix filter (e.g. "spark.sql"). |
Returns
Section titled “Returns”Promise<Record<string, string>>
isModifiable()
Section titled “isModifiable()”isModifiable(key): Promise<boolean>;Defined in: runtime-config.ts:78
Return whether a configuration entry can be modified on the running session, or whether it is a static (server-bound) setting.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key | string |
Returns
Section titled “Returns”Promise<boolean>
set(key, value): Promise<void>;Defined in: runtime-config.ts:32
Set a Spark configuration entry.
Parameters
Section titled “Parameters”| Parameter | Type | Description |
|---|---|---|
key | string | Configuration key (e.g. "spark.sql.shuffle.partitions") |
value | string | Value as a string. Numbers and booleans must be stringified. |
Returns
Section titled “Returns”Promise<void>
unset()
Section titled “unset()”unset(key): Promise<void>;Defined in: runtime-config.ts:52
Remove a configuration entry.
Parameters
Section titled “Parameters”| Parameter | Type |
|---|---|
key | string |
Returns
Section titled “Returns”Promise<void>