`prefect server`

command

prefect server [OPTIONS] COMMAND [ARGS]...

<Info> Start a Prefect server instance and interact with the database. </Info>

`prefect server database`

command

prefect server database [OPTIONS] COMMAND [ARGS]...

<Info> Interact with the database. </Info>

`prefect server database reset`

command

prefect server database reset [OPTIONS]

<Info> Drop and recreate all Prefect database tables. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--yes"> Skip confirmation. </ResponseField> </Accordion> </AccordionGroup>

`prefect server database upgrade`

command

prefect server database upgrade [OPTIONS]

<Info> Upgrade the Prefect database. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--yes"> Skip confirmation. </ResponseField> <ResponseField name="--revision"> Alembic revision (default: head). </ResponseField> <ResponseField name="--dry-run"> Show migrations without applying. </ResponseField> </Accordion> </AccordionGroup>

`prefect server database downgrade`

command

prefect server database downgrade [OPTIONS]

<Info> Downgrade the Prefect database. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--yes"> Skip confirmation. </ResponseField> <ResponseField name="--revision"> Alembic revision (default: -1). </ResponseField> <ResponseField name="--dry-run"> Show migrations without applying. </ResponseField> </Accordion> </AccordionGroup>

`prefect server database revision`

command

prefect server database revision [OPTIONS]

<Info> Create a new migration for the Prefect database. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--message"> Migration message. </ResponseField> <ResponseField name="--autogenerate"> Auto-generate from models. </ResponseField> </Accordion> </AccordionGroup>

`prefect server database stamp`

command

prefect server database stamp [OPTIONS] REVISION

<Info> Stamp the revision table with the given revision; don't run any migrations. </Info> <AccordionGroup> <Accordion title="Arguments" defaultOpen> <ResponseField name="REVISION" type="string" required> </ResponseField> </Accordion> </AccordionGroup>

`prefect server services`

command

prefect server services [OPTIONS] COMMAND [ARGS]...

<Info> Interact with server loop services. </Info>

`prefect server services ls`

command

prefect server services ls [OPTIONS]

<Info> List all available services and their status. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--output"> Specify an output format. Currently supports: json </ResponseField> </Accordion> </AccordionGroup>

`prefect server services list`

command

prefect server services list [OPTIONS]

`prefect server services start`

command

prefect server services start [OPTIONS]

<Info> Start all enabled Prefect services in one process. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--background"> Run the services in the background. </ResponseField> </Accordion> </AccordionGroup>

`prefect server services enable`

command

prefect server services enable [OPTIONS]

`prefect server services stop`

command

prefect server services stop [OPTIONS]

<Info> Stop any background Prefect services that were started. </Info>

`prefect server services disable`

command

prefect server services disable [OPTIONS]

<Info> Stop any background Prefect services that were started. </Info>

`prefect server services manager`

command

prefect server services manager [OPTIONS]

<Info> Internal entrypoint for background services. </Info>

`prefect server start`

command

prefect server start [OPTIONS]

<Info> Start a Prefect server instance. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--host"> Server host address. [from PREFECT_SERVER_API_HOST] </ResponseField> <ResponseField name="--port"> Server port. [from PREFECT_SERVER_API_PORT] </ResponseField> <ResponseField name="--keep-alive-timeout"> Keep-alive timeout seconds. [from PREFECT_SERVER_API_KEEPALIVE_TIMEOUT] </ResponseField> <ResponseField name="--log-level"> Server logging level. [from PREFECT_SERVER_LOGGING_LEVEL] </ResponseField> <ResponseField name="--scheduler"> Enable scheduler. [from PREFECT_SERVER_SERVICES_SCHEDULER_ENABLED] </ResponseField> <ResponseField name="--analytics-on"> Toggle analytics. [from PREFECT_SERVER_ANALYTICS_ENABLED] </ResponseField> <ResponseField name="--late-runs"> Enable late runs. [from PREFECT_SERVER_SERVICES_LATE_RUNS_ENABLED] </ResponseField> <ResponseField name="--ui"> Enable the UI. [from PREFECT_SERVER_UI_ENABLED] </ResponseField> <ResponseField name="--no-services"> Only run the webserver API and UI. </ResponseField> <ResponseField name="--background"> Run in the background. </ResponseField> <ResponseField name="--workers"> Number of worker processes. </ResponseField> </Accordion> </AccordionGroup>

`prefect server status`

command

prefect server status [OPTIONS]

<Info> Check the status of the Prefect server. </Info> <AccordionGroup> <Accordion title="Options" defaultOpen> <ResponseField name="--wait"> Wait for the server to become available before returning. </ResponseField> <ResponseField name="--timeout"> Maximum number of seconds to wait when using --wait. A value of 0 means wait indefinitely. </ResponseField> <ResponseField name="--output"> Specify an output format. Currently supports: json </ResponseField> </Accordion> </AccordionGroup>

`prefect server stop`

command

prefect server stop [OPTIONS]

<Info> Stop a Prefect server instance running in the background. </Info>