Skip to content

Config API

arcticdb.config.get_config_int

get_config_int(label: str) -> int | None

Get configured value, returns None if not set.

arcticdb.config.set_config_int

set_config_int(label: str, value: int) -> None

Set configured value.

arcticdb.config.set_log_level

set_log_level(
    default_level: str = DEFAULT_LOG_LEVEL,
    specific_log_levels: Optional[Dict[str, str]] = None,
    console_output: bool = True,
    file_output_path: Optional[str] = None,
)

Set log levels, overwriting any existing config.

PARAMETER DESCRIPTION
default_level

Default log level for all the loggers unless overriden with specific_log_levels. Valid values are "TRACE" (most verbose), "DEBUG", "INFO", "WARN", "ERROR", "CRITICAL", "OFF" (no logging).

TYPE: str DEFAULT: DEFAULT_LOG_LEVEL

specific_log_levels

Optional overrides for specific logger(s). The possible logger names can be found in arcticdb.log.logger_by_name.keys() (subject to change).

TYPE: Optional[Dict[str, str]] DEFAULT: None

console_output

Boolean indicating whether to output logs to the terminal.

TYPE: bool DEFAULT: True

file_output_path

If None, logs will not be written to a file. Otherwise, this value should be set to the path of a file to which logging output will be written.

TYPE: Optional[str] DEFAULT: None