Skip to main content

prefect server

Start a Prefect server instance and interact with the database.

prefect server database

Interact with the database.

prefect server database reset

Drop and recreate all Prefect database tables.

Options

Skip confirmation.

prefect server database upgrade

Upgrade the Prefect database.

Options

Skip confirmation.
Alembic revision (default: head).
Show migrations without applying.

prefect server database downgrade

Downgrade the Prefect database.

Options

Skip confirmation.
Alembic revision (default: -1).
Show migrations without applying.

prefect server database revision

Create a new migration for the Prefect database.

Options

Migration message.
Auto-generate from models.

prefect server database stamp

Stamp the revision table with the given revision; don’t run any migrations.

Arguments

string
required

prefect server services

Interact with server loop services.

prefect server services ls

List all available services and their status.

Options

Specify an output format. Currently supports: json

prefect server services list

List all available services and their status.

Options

Specify an output format. Currently supports: json

prefect server services start

Start all enabled Prefect services in one process.

Options

Run the services in the background.

prefect server services enable

Start all enabled Prefect services in one process.

Options

Run the services in the background.

prefect server services stop

Stop any background Prefect services that were started.

prefect server services disable

Stop any background Prefect services that were started.

prefect server services manager

Internal entrypoint for background services.

prefect server start

Start a Prefect server instance.

Options

Server host address. [from PREFECT_SERVER_API_HOST]
Server port. [from PREFECT_SERVER_API_PORT]
Keep-alive timeout seconds. [from PREFECT_SERVER_API_KEEPALIVE_TIMEOUT]
Server logging level. [from PREFECT_SERVER_LOGGING_LEVEL]
Enable scheduler. [from PREFECT_SERVER_SERVICES_SCHEDULER_ENABLED]
Toggle analytics. [from PREFECT_SERVER_ANALYTICS_ENABLED]
Enable late runs. [from PREFECT_SERVER_SERVICES_LATE_RUNS_ENABLED]
Enable the UI. [from PREFECT_SERVER_UI_ENABLED]
Only run the webserver API and UI.
Run in the background.
Number of worker processes.

prefect server status

Check the status of the Prefect server.

Options

Wait for the server to become available before returning.
Maximum number of seconds to wait when using —wait. A value of 0 means wait indefinitely.
Specify an output format. Currently supports: json

prefect server stop

Stop a Prefect server instance running in the background.