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

Returns

Detached tuning records. Returned values cannot mutate the runtime.

Cost

One bounded query and one owner visit per returned definition.

Fields

IDTypeUnitsRequiredDescription
change_policyenumerationnoneyesWhen a committed change becomes effective.
current_valueunsigned-integernoneyesCurrent tuning value.
default_valueunsigned-integernoneyesDefault tuning value.
maximum_valueunsigned-integernoneyesHighest accepted tuning value.
minimum_valueunsigned-integernoneyesLowest accepted tuning value.
revisionunsigned-integernoneyesCurrent tuning-owner revision.
scopeenumerationnoneyesRuntime scope affected by the value.
tuning_idstringnoneyesRegistered tuning identity.
unitsstringnoneyesUnit used by the tuning value.

Errors

Examples

local result = world.query("developer.tuning.values", {page_size = 1, filters = {tuning_id = "simulation.time-scale-basis-points"}})

API history

Related symbols

Project references