prefect.server.database.interface

Classes

DBSingleton

Ensures that only one database interface is created per unique key

PrefectDBInterface

An interface for backend-specific SqlAlchemy actions and ORM models. The REST API can be configured to run against different databases in order maintain performance at different scales. This interface integrates database- and dialect- specific configuration into a unified interface that the orchestration engine runs against. Methods:

dialect

dialect(self) -> type[sa.engine.Dialect]

Base

Base(self) -> type[orm_models.Base]
Base class for orm models

Flow

Flow(self) -> type[orm_models.Flow]
A flow orm model

FlowRun

FlowRun(self) -> type[orm_models.FlowRun]
A flow run orm model

FlowRunState

FlowRunState(self) -> type[orm_models.FlowRunState]
A flow run state orm model

TaskRun

TaskRun(self) -> type[orm_models.TaskRun]
A task run orm model

TaskRunState

TaskRunState(self) -> type[orm_models.TaskRunState]
A task run state orm model

Artifact

Artifact(self) -> type[orm_models.Artifact]
An artifact orm model

ArtifactCollection

ArtifactCollection(self) -> type[orm_models.ArtifactCollection]
An artifact collection orm model

TaskRunStateCache

TaskRunStateCache(self) -> type[orm_models.TaskRunStateCache]
A task run state cache orm model

Deployment

Deployment(self) -> type[orm_models.Deployment]
A deployment orm model

DeploymentSchedule

DeploymentSchedule(self) -> type[orm_models.DeploymentSchedule]
A deployment schedule orm model

SavedSearch

SavedSearch(self) -> type[orm_models.SavedSearch]
A saved search orm model

WorkPool

WorkPool(self) -> type[orm_models.WorkPool]
A work pool orm model

Worker

Worker(self) -> type[orm_models.Worker]
A worker process orm model

Log

Log(self) -> type[orm_models.Log]
A log orm model

ConcurrencyLimit

ConcurrencyLimit(self) -> type[orm_models.ConcurrencyLimit]
A concurrency model

ConcurrencyLimitV2

ConcurrencyLimitV2(self) -> type[orm_models.ConcurrencyLimitV2]
A v2 concurrency model

CsrfToken

CsrfToken(self) -> type[orm_models.CsrfToken]
A csrf token model

WorkQueue

WorkQueue(self) -> type[orm_models.WorkQueue]
A work queue model

Agent

Agent(self) -> type[orm_models.Agent]
An agent model

BlockType

BlockType(self) -> type[orm_models.BlockType]
A block type model

BlockSchema

BlockSchema(self) -> type[orm_models.BlockSchema]
A block schema model

BlockSchemaReference

BlockSchemaReference(self) -> type[orm_models.BlockSchemaReference]
A block schema reference model

BlockDocument

BlockDocument(self) -> type[orm_models.BlockDocument]
A block document model

BlockDocumentReference

BlockDocumentReference(self) -> type[orm_models.BlockDocumentReference]
A block document reference model

Configuration

Configuration(self) -> type[orm_models.Configuration]
An configuration model

Variable

Variable(self) -> type[orm_models.Variable]
A variable model

FlowRunInput

FlowRunInput(self) -> type[orm_models.FlowRunInput]
A flow run input model

Automation

Automation(self) -> type[orm_models.Automation]
An automation model

AutomationBucket

AutomationBucket(self) -> type[orm_models.AutomationBucket]
An automation bucket model

AutomationRelatedResource

AutomationRelatedResource(self) -> type[orm_models.AutomationRelatedResource]
An automation related resource model

CompositeTriggerChildFiring

CompositeTriggerChildFiring(self) -> type[orm_models.CompositeTriggerChildFiring]
A model capturing a composite trigger’s child firing

AutomationEventFollower

AutomationEventFollower(self) -> type[orm_models.AutomationEventFollower]
A model capturing one event following another event

Event

Event(self) -> type[orm_models.Event]
An event model

EventResource

EventResource(self) -> type[orm_models.EventResource]
An event resource model