prefect.settings.models.server.services

Classes

ServicesBaseSetting ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L11" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Methods:

settings_customise_sources ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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.

ServerServicesCancellationCleanupSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L18" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the cancellation cleanup service

ServerServicesDBVacuumSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L87" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the database vacuum service

Methods:

enabled_vacuum_types ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L105" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

enabled_vacuum_types(self) -> set[str]

Resolve enabled to a concrete set of vacuum type strings.

Handles legacy boolean values:

• True → {"events", "flow_runs", "orphans"}
• False → {"events"} (preserves old default)
• None → set()

Enabling flow_runs implies orphans to preserve the flow run vacuum's historical orphan-cleanup behavior.

ServerServicesEventPersisterSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L165" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the event persister service

ServerServicesEventLoggerSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L230" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the event logger service

ServerServicesForemanSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L250" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the foreman service

ServerServicesLateRunsSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L331" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the late runs service

ServerServicesSchedulerSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L375" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the scheduler service

ServerServicesPauseExpirationsSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L507" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the pause expiration service

ServerServicesRepossessorSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L543" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the repossessor service

ServerServicesCleanupReconcilerSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L563" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the cleanup reconciler service.

ServerServicesTaskRunRecorderSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L590" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the task run recorder service

ServerServicesTriggersSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L628" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling the triggers service

ServerServicesSettings ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/models/server/services.py#L680" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

Settings for controlling server services

Methods:

settings_customise_sources ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L33" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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 ^{<a href="https://github.com/PrefectHQ/prefect/blob/main/src/prefect/settings/base.py#L124" target="_blank"><Icon icon="github" style="width: 14px; height: 14px;" /></a>}

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.