prefect.server.services.base

Classes

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

Methods:

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

all_services(cls) -> Sequence[type[Self]]

Get list of all service classes

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

enabled(cls) -> bool

Whether the service is enabled

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

enabled_services(cls) -> list[type[Self]]

Get list of enabled service classes

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

environment_variable_name(cls) -> str

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

run_services(cls) -> NoReturn

Run enabled services until cancelled.

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

running(cls) -> AsyncGenerator[None, None]

A context manager that runs enabled services on entry and stops them on exit.

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

service_settings(cls) -> ServicesBaseSetting

The Prefect setting that controls whether the service is enabled

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

start(self) -> NoReturn

Start running the service, which may run indefinitely

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

stop(self) -> None

Stop the service

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

A marker class for services that should run even when running an ephemeral server

Methods:

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

all_services(cls) -> Sequence[type[Self]]

Get list of all service classes

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

enabled(cls) -> bool

Whether the service is enabled

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

enabled_services(cls) -> list[type[Self]]

Get list of enabled service classes

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

environment_variable_name(cls) -> str

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

run_services(cls) -> NoReturn

Run enabled services until cancelled.

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

running(cls) -> AsyncGenerator[None, None]

A context manager that runs enabled services on entry and stops them on exit.

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

service_settings(cls) -> ServicesBaseSetting

The Prefect setting that controls whether the service is enabled

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

start(self) -> NoReturn

Start running the service, which may run indefinitely

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

stop(self) -> None

Stop the service

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

A marker class for services that should run when running a webserver

Methods:

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

all_services(cls) -> Sequence[type[Self]]

Get list of all service classes

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

enabled(cls) -> bool

Whether the service is enabled

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

enabled_services(cls) -> list[type[Self]]

Get list of enabled service classes

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

environment_variable_name(cls) -> str

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

run_services(cls) -> NoReturn

Run enabled services until cancelled.

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

running(cls) -> AsyncGenerator[None, None]

A context manager that runs enabled services on entry and stops them on exit.

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

service_settings(cls) -> ServicesBaseSetting

The Prefect setting that controls whether the service is enabled

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

start(self) -> NoReturn

Start running the service, which may run indefinitely

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

stop(self) -> None

Stop the service