query · developer.tuning
Runtime tuning values
Returns registered runtime tuning definitions and their current detached values.
developer.tuning.values(filters?, cursor?, page_size?) -> query-page
- Stable ID
developer.tuning.values- Owner
- app.runtime-tuning
- Authority
- read_only
- Timing
- immediate
- Availability
- active-session
- Side effects
- none
- Determinism
- stable owner order at the current committed tick
- Introduced
- 1.0.0
Usage
Read registered tuning definitions, ranges, units, current values, and the owner revision. Filter by tuning_id when preparing a revision-checked change.
Parameters
- filters: optional tuning_id string.
- cursor: continuation cursor.
- page_size: bounded record limit.
Returns
Detached tuning records. Returned values cannot mutate the runtime.
Cost
One bounded query and one owner visit per returned definition.
Fields
| ID | Type | Units | Required | Description |
|---|---|---|---|---|
change_policy | enumeration | none | yes | When a committed change becomes effective. |
current_value | unsigned-integer | none | yes | Current tuning value. |
default_value | unsigned-integer | none | yes | Default tuning value. |
maximum_value | unsigned-integer | none | yes | Highest accepted tuning value. |
minimum_value | unsigned-integer | none | yes | Lowest accepted tuning value. |
revision | unsigned-integer | none | yes | Current tuning-owner revision. |
scope | enumeration | none | yes | Runtime scope affected by the value. |
tuning_id | string | none | yes | Registered tuning identity. |
units | string | none | yes | Unit used by the tuning value. |
Errors
error.capability-unavailableerror.invalid-queryerror.query-budget-exhaustederror.query-contract-violation
Examples
local result = world.query("developer.tuning.values", {page_size = 1, filters = {tuning_id = "simulation.time-scale-basis-points"}})
API history
- 1.1.0: Runtime tuning inspection query added.