EncodeBool encodes a bool in the format parseRaw expects.

EncodeDuration encodes a duration in the format parseRaw expects.

EncodeFloat encodes a bool in the format parseRaw expects.

EncodeInt encodes an int in the format parseRaw expects.

Keys returns a sorted string array with all the known keys.

Lookup returns a Setting by name along with its description.

MakeStateMachineSetting creates a StateMachineSetting.

NewUpdater makes an Updater.

NumRegisteredSettings returns the number of registered settings.

RedactedValue returns a string representation of the value for settings types the are not considered sensitive (numbers, bools, etc) or <redacted> for those with values could store sensitive things (i.e.

RegisterBoolSetting defines a new setting with type bool.

RegisterByteSizeSetting defines a new setting with type bytesize.

RegisterDurationSetting defines a new setting with type duration.

RegisterEnumSetting defines a new setting with type int.

RegisterFloatSetting defines a new setting with type float.

RegisterIntSetting defines a new setting with type int.

RegisterNonNegativeDurationSetting defines a new setting with type duration.

RegisterNonNegativeFloatSetting defines a new setting with type float.

RegisterNonNegativeIntSetting defines a new setting with type int.

RegisterPositiveIntSetting defines a new setting with type int.

RegisterPublicBoolSetting defines a new setting with type bool and makes it public.

RegisterPublicByteSizeSetting defines a new setting with type bytesize and makes it public.

RegisterPublicDurationSetting defines a new setting with type duration and makes it public.

RegisterPublicEnumSetting defines a new setting with type int and makes it public.

RegisterPublicIntSetting defines a new setting with type int and makes it public.

RegisterPublicNonNegativeDurationSetting defines a new setting with type duration and makes it public.

RegisterPublicNonNegativeDurationSettingWithMaximum defines a new setting with type duration, makes it public, and sets a maximum value.

RegisterPublicStringSetting defines a new setting with type string and makes it public.

RegisterPublicValidatedByteSizeSetting defines a new setting with type bytesize with a validation function and makes it public.

RegisterStateMachineSetting registers a StateMachineSetting.

RegisterStateMachineSettingImpl is like RegisterStateMachineSetting, but it takes a StateMachineSettingImpl.

RegisterStringSetting defines a new setting with type string.

RegisterValidatedByteSizeSetting defines a new setting with type bytesize with a validation function.

RegisterValidatedDurationSetting defines a new setting with type duration.

RegisterValidatedFloatSetting defines a new setting with type float.

RegisterValidatedIntSetting defines a new setting with type int with a validation function.

RegisterValidatedStringSetting defines a new setting with type string with a validation function.

SetCanonicalValuesContainer sets the Values container that will be refreshed at runtime -- ideally we should have no other *Values containers floating around, as they will be stale / lies.

TestingIsReportable is used in testing for reportability.

TestingSaveRegistry can be used in tests to save/restore the current contents of the registry.

TODO is usable at callsites that do not have *settings.Values available.

LookupForLocalAccess indicates that a setting is being retrieved for local processing within the cluster and all values should be accessible.

LookupForReporting indicates that a setting is being retrieved for reporting and sensitive values should be scrubbed.

MaxSettings is the maximum number of settings that the system supports.

Public indicates that a setting is documented, the range of possible values yields predictable results, and the CockroachDB team is there to assist if issues occur as a result of the customization.

Reserved - which is the default - indicates that a setting is not documented and the CockroachDB team has not developed internal experience about the impact of customizing it to other values.

ReadableTypes maps our short type identifiers to friendlier names.

TestOpaque can be passed to Values.Init when we are testing the settings infrastructure.

BoolSetting is the interface of a setting variable that will be updated automatically when the corresponding cluster-wide setting of type "bool" is updated.

ByteSizeSetting is the interface of a setting variable that will be updated automatically when the corresponding cluster-wide setting of type "bytesize" is updated.

DurationSetting is the interface of a setting variable that will be updated automatically when the corresponding cluster-wide setting of type "duration" is updated.

EnumSetting is a StringSetting that restricts the values to be one of the `enumValues`.

FloatSetting is the interface of a setting variable that will be updated automatically when the corresponding cluster-wide setting of type "float" is updated.

IntSetting is the interface of a setting variable that will be updated automatically when the corresponding cluster-wide setting of type "int" is updated.

MaskedSetting is a pseudo-variable constructed on-the-fly by Lookup when the actual setting is non-reportable.

A NoopUpdater ignores all updates.

A StateMachineSetting is a setting that keeps a state machine driven by user input.

StringSetting is the interface of a setting variable that will be updated automatically when the corresponding cluster-wide setting of type "string" is updated.

Values is a container that stores values for all registered settings.

Setting is a descriptor for each setting; once it is initialized, it is immutable.

StateMachineSettingImpl provides the setting-specific parts of a StateMachineSetting.

Updater is a helper for updating the in-memory settings.

WritableSetting is the exported interface of non-masked settings.

LookupPurpose indicates what is being done with the setting.

Visibility describes how a user should feel confident that they can customize the setting.