Skip to main content

​
prefect.settings.models.server.database

​
Functions

​
warn_on_database_password_value_without_usage 

warn_on_database_password_value_without_usage(settings: ServerDatabaseSettings) -> None
Validator for settings warning if the database password is set but not used.

​
Classes

​
SQLAlchemyTLSSettings

Settings for controlling SQLAlchemy mTLS context when using a PostgreSQL database. Methods:

​
settings_customise_sources 

settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
Define an order for Prefect settings sources. The order of the returned callables decides the priority of inputs; first item is the highest priority. See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources

​
to_environment_variables 

to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
Convert the settings object to a dictionary of environment variables.

​
SQLAlchemyConnectArgsSettings

Settings for controlling SQLAlchemy connection behavior; note that these settings only take effect when using a PostgreSQL database. Methods:

​
settings_customise_sources 

settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
Define an order for Prefect settings sources. The order of the returned callables decides the priority of inputs; first item is the highest priority. See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources

​
to_environment_variables 

to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
Convert the settings object to a dictionary of environment variables.

​
SQLAlchemySettings

Settings for controlling SQLAlchemy behavior; note that these settings only take effect when using a PostgreSQL database. Methods:

​
settings_customise_sources 

settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
Define an order for Prefect settings sources. The order of the returned callables decides the priority of inputs; first item is the highest priority. See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources

​
to_environment_variables 

to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
Convert the settings object to a dictionary of environment variables.

​
ServerDatabaseSettings

Settings for controlling server database behavior Methods:

​
emit_warnings 

emit_warnings(self) -> Self
More post-hoc validation of settings, including warnings for misconfigurations.

​
set_deprecated_sqlalchemy_settings_on_child_model_and_warn 

set_deprecated_sqlalchemy_settings_on_child_model_and_warn(cls, values: dict[str, Any]) -> dict[str, Any]
Set deprecated settings on the child model.

​
settings_customise_sources 

settings_customise_sources(cls, settings_cls: type[BaseSettings], init_settings: PydanticBaseSettingsSource, env_settings: PydanticBaseSettingsSource, dotenv_settings: PydanticBaseSettingsSource, file_secret_settings: PydanticBaseSettingsSource) -> tuple[PydanticBaseSettingsSource, ...]
Define an order for Prefect settings sources. The order of the returned callables decides the priority of inputs; first item is the highest priority. See https://docs.pydantic.dev/latest/concepts/pydantic_settings/#customise-settings-sources

​
to_environment_variables 

to_environment_variables(self, exclude_unset: bool = False, include_secrets: bool = True, include_aliases: bool = False) -> dict[str, str]
Convert the settings object to a dictionary of environment variables.