DbConfig

class q2_sdk.hq.models.db_config.db_config.DbConfig(name, default, description=None, required=True)

Bases: Generic[T], JsonSerializable

Written to database during q2 install or q2 update_installed

Parameters:

• name (str) – Key written to the database

• default (TypeVar(T)) – Suggested value to write to the database (can be overridden at install time). May be another DbConfig or a DbConfigList to represent nested configuration.

• description (Optional[str]) – Helpful text to guide implementer

• required (bool) – If True, will raise errors at runtime when unset. Consider using False when DbConfigs are added to an already deployed extension

property resolved_default

Returns the default value with any nested DbConfig or DbConfigList instances recursively resolved into plain dicts, suitable for use as a config dict entry.

to_json()

Json representation of class.

When default is a DbConfigList or DbConfig, the full detail (name, default, description, required) is preserved for nested configs. For plain scalar/dict defaults the value is returned as-is.

is_valid(value)

Meant to be overridden. Verifies value is a valid input