Skip to content

LocalSettingsYaml

LocalSettingsYaml

DQOps local settings that are stored in the $DQO_USER_HOME/.localsettings.dqosettings.yaml file in the user's DQOps home folder. The local settings contain the current DQOps Cloud API Key and other settings. The local settings take precedence over parameters passed when starting DQOps.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
api_version string
kind enum default_schedules
settings
default_notifications
rule
sensor
source
check
dashboards
default_checks
table
provider_sensor
file_index
spec LocalSettingsSpec

LocalSettingsSpec

Local settings specification.

The structure of this object is described below

 Property name   Description                       Data type   Enum values   Default value   Sample values 
editor_name Editor name spec (VSC, Eclipse, Intellij) string
editor_path Editor path on user's computer string
api_key Api key string
instance_signature_key DQOps instance signature key used to sign keys. This should be a Base64 encoded binary key at a 32 bytes length. string
time_zone Default IANA time zone name of the server. This time zone is used to convert the time of UTC timestamps values returned from databases to a uniform local date and time. The default value is the local time zone of the DQOps server instance. string