prefect server

prefect server [OPTIONS] COMMAND [ARGS]...
Start a Prefect server instance and interact with the database

prefect server start

prefect server start [OPTIONS]
Start a Prefect server instance

Options

--host
--port
--keep-alive-timeout
--log-level
--scheduler
--analytics-on
--late-runs
--ui
--no-services
Only run the webserver API and UI
--background
Run the server in the background

prefect server stop

prefect server stop [OPTIONS]
Stop a Prefect server instance running in the background

prefect server database

prefect server database [OPTIONS] COMMAND [ARGS]...
Interact with the database.

prefect server database reset

prefect server database reset [OPTIONS]
Drop and recreate all Prefect database tables

Options

--yes

prefect server database upgrade

prefect server database upgrade [OPTIONS]
Upgrade the Prefect database

Options

--yes
-r
The revision to pass to alembic upgrade. If not provided, runs all migrations.
--dry-run
Flag to show what migrations would be made without applying them. Will emit sql statements to stdout.

prefect server database downgrade

prefect server database downgrade [OPTIONS]
Downgrade the Prefect database

Options

--yes
-r
The revision to pass to alembic downgrade. If not provided, downgrades to the most recent revision. Use ‘base’ to run all migrations.
--dry-run
Flag to show what migrations would be made without applying them. Will emit sql statements to stdout.

prefect server database revision

prefect server database revision [OPTIONS]
Create a new migration for the Prefect database

Options

--message
A message to describe the migration.
--autogenerate

prefect server database stamp

prefect server database stamp [OPTIONS] REVISION
Stamp the revision table with the given revision; don’t run any migrations

Arguments

REVISION
string
required
[required]

prefect server services

prefect server services [OPTIONS] COMMAND [ARGS]...
Interact with server loop services.

prefect server services manager

prefect server services manager [OPTIONS]
This is an internal entrypoint used by prefect server services start --background. Users do not call this directly.We do everything in sync so that the child won’t exit until the user kills it.

prefect server services list-services

prefect server services list-services [OPTIONS]
List all available services and their status.

prefect server services ls

prefect server services ls [OPTIONS]
List all available services and their status.

prefect server services start-services

prefect server services start-services [OPTIONS]
Start all enabled Prefect services in one process.

Options

--background
Run the services in the background

prefect server services start

prefect server services start [OPTIONS]
Start all enabled Prefect services in one process.

Options

--background
Run the services in the background

prefect server services stop-services

prefect server services stop-services [OPTIONS]
Stop any background Prefect services that were started.

prefect server services stop

prefect server services stop [OPTIONS]
Stop any background Prefect services that were started.