`prefect.server.schemas.filters`

Schemas that define Prefect REST API filtering operations. Each filter schema includes logic for transforming itself into a SQL where clause.

Classes

`Operator`

Operators for combining filter criteria. Methods:

`auto`

auto() -> str

Exposes enum.auto() to avoid requiring a second import to use AutoEnum

`PrefectFilterBaseModel`

Base model for Prefect filters Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`model_validate_list`

model_validate_list(cls, obj: Any) -> list[Self]

`reset_fields`

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set. Returns:

A new instance of the model with the reset fields.

`PrefectOperatorFilterBaseModel`

Base model for Prefect filters that combines criteria with a user-provided operator Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowFilterId`

Filter by Flow.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowFilterDeployment`

Filter by flows by deployment Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowFilterName`

Filter by Flow.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowFilterTags`

Filter by Flow.tags. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowFilter`

Filter for flows. Only flows matching all criteria will be returned. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowRunFilterId`

Filter by FlowRun.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterName`

Filter by FlowRun.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterTags`

Filter by FlowRun.tags. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowRunFilterDeploymentId`

Filter by FlowRun.deployment_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowRunFilterWorkQueueName`

Filter by FlowRun.work_queue_name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowRunFilterStateType`

Filter by FlowRun.state_type. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterStateName`

Filter by FlowRun.state_name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterState`

Filter by FlowRun.state_type and FlowRun.state_name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowRunFilterFlowVersion`

Filter by FlowRun.flow_version. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterStartTime`

Filter by FlowRun.start_time. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterEndTime`

Filter by FlowRun.end_time. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterExpectedStartTime`

Filter by FlowRun.expected_start_time. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterNextScheduledStartTime`

Filter by FlowRun.next_scheduled_start_time. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilterParentFlowRunId`

Filter for subflows of a given flow run Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowRunFilterParentTaskRunId`

Filter by FlowRun.parent_task_run_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FlowRunFilterIdempotencyKey`

Filter by FlowRun.idempotency_key. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`FlowRunFilter`

Filter flow runs. Only flow runs matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`only_filters_on_id`

only_filters_on_id(self) -> bool

`TaskRunFilterFlowRunId`

Filter by TaskRun.flow_run_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`TaskRunFilterId`

Filter by TaskRun.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`TaskRunFilterName`

Filter by TaskRun.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`TaskRunFilterTags`

Filter by TaskRun.tags. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`TaskRunFilterStateType`

Filter by TaskRun.state_type. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`TaskRunFilterStateName`

Filter by TaskRun.state_name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`TaskRunFilterState`

Filter by TaskRun.type and TaskRun.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`TaskRunFilterSubFlowRuns`

Filter by TaskRun.subflow_run. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`TaskRunFilterStartTime`

Filter by TaskRun.start_time. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`TaskRunFilterExpectedStartTime`

Filter by TaskRun.expected_start_time. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`TaskRunFilter`

Filter task runs. Only task runs matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`DeploymentFilterId`

Filter by Deployment.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`DeploymentFilterName`

Filter by Deployment.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`DeploymentOrFlowNameFilter`

Filter by Deployment.name or Flow.name with a single input string for ilike filtering. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`DeploymentFilterPaused`

Filter by Deployment.paused. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`DeploymentFilterWorkQueueName`

Filter by Deployment.work_queue_name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`DeploymentFilterConcurrencyLimit`

DEPRECATED: Prefer Deployment.concurrency_limit_id over Deployment.concurrency_limit. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`DeploymentFilterTags`

Filter by Deployment.tags. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`DeploymentFilter`

Filter for deployments. Only deployments matching all criteria will be returned. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`DeploymentScheduleFilterActive`

Filter by DeploymentSchedule.active. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`DeploymentScheduleFilter`

Filter for deployments. Only deployments matching all criteria will be returned. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`LogFilterName`

Filter by Log.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`LogFilterLevel`

Filter by Log.level. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`LogFilterTimestamp`

Filter by Log.timestamp. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`LogFilterFlowRunId`

Filter by Log.flow_run_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`LogFilterTaskRunId`

Filter by Log.task_run_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`LogFilter`

Filter logs. Only logs matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`FilterSet`

A collection of filters for common objects Methods:

`model_validate_list`

model_validate_list(cls, obj: Any) -> list[Self]

`reset_fields`

reset_fields(self: Self) -> Self

Reset the fields of the model that are in the _reset_fields set. Returns:

A new instance of the model with the reset fields.

`BlockTypeFilterName`

Filter by BlockType.name Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockTypeFilterSlug`

Filter by BlockType.slug Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockTypeFilter`

Filter BlockTypes Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockSchemaFilterBlockTypeId`

Filter by BlockSchema.block_type_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockSchemaFilterId`

Filter by BlockSchema.id Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockSchemaFilterCapabilities`

Filter by BlockSchema.capabilities Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockSchemaFilterVersion`

Filter by BlockSchema.capabilities Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockSchemaFilter`

Filter BlockSchemas Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`BlockDocumentFilterIsAnonymous`

Filter by BlockDocument.is_anonymous. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockDocumentFilterBlockTypeId`

Filter by BlockDocument.block_type_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockDocumentFilterId`

Filter by BlockDocument.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockDocumentFilterName`

Filter by BlockDocument.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`BlockDocumentFilter`

Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`WorkQueueFilterId`

Filter by WorkQueue.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`WorkQueueFilterName`

Filter by WorkQueue.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`WorkQueueFilter`

Filter work queues. Only work queues matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`WorkPoolFilterId`

Filter by WorkPool.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`WorkPoolFilterName`

Filter by WorkPool.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`WorkPoolFilterType`

Filter by WorkPool.type. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`WorkPoolFilter`

Filter work pools. Only work pools matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`WorkerFilterWorkPoolId`

Filter by Worker.worker_config_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`WorkerFilterStatus`

Filter by Worker.status. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`WorkerFilterLastHeartbeatTime`

Filter by Worker.last_heartbeat_time. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`WorkerFilter`

Filter by Worker.last_heartbeat_time. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`ArtifactFilterId`

Filter by Artifact.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactFilterKey`

Filter by Artifact.key. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactFilterFlowRunId`

Filter by Artifact.flow_run_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactFilterTaskRunId`

Filter by Artifact.task_run_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactFilterType`

Filter by Artifact.type. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactFilter`

Filter artifacts. Only artifacts matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`ArtifactCollectionFilterLatestId`

Filter by ArtifactCollection.latest_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactCollectionFilterKey`

Filter by ArtifactCollection.key. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactCollectionFilterFlowRunId`

Filter by ArtifactCollection.flow_run_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactCollectionFilterTaskRunId`

Filter by ArtifactCollection.task_run_id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactCollectionFilterType`

Filter by ArtifactCollection.type. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`ArtifactCollectionFilter`

Filter artifact collections. Only artifact collections matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`VariableFilterId`

Filter by Variable.id. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`VariableFilterName`

Filter by Variable.name. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

Generate SQL filter from provided filter parameters. If no filters parameters are available, return a TRUE filter.

`VariableFilterTags`

Filter by Variable.tags. Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

`VariableFilter`

Filter variables. Only variables matching all criteria will be returned Methods:

`as_sql_filter`

as_sql_filter(self, db: 'PrefectDBInterface') -> sa.ColumnElement[bool]

API Reference

​prefect.server.schemas.filters

​Classes

​Operator

​auto

​PrefectFilterBaseModel

​as_sql_filter

​model_validate_list

​reset_fields

​PrefectOperatorFilterBaseModel

​as_sql_filter

​as_sql_filter

​FlowFilterId

​as_sql_filter

​FlowFilterDeployment

​as_sql_filter

​FlowFilterName

​as_sql_filter

​FlowFilterTags

​as_sql_filter

​FlowFilter

​as_sql_filter

​FlowRunFilterId

​as_sql_filter

​FlowRunFilterName

​as_sql_filter

​FlowRunFilterTags

​as_sql_filter

​FlowRunFilterDeploymentId

​as_sql_filter

​FlowRunFilterWorkQueueName

​as_sql_filter

​FlowRunFilterStateType

​as_sql_filter

​FlowRunFilterStateName

​as_sql_filter

​FlowRunFilterState

​as_sql_filter

​FlowRunFilterFlowVersion

​as_sql_filter

​FlowRunFilterStartTime

​as_sql_filter

​FlowRunFilterEndTime

​as_sql_filter

​FlowRunFilterExpectedStartTime

​as_sql_filter

​FlowRunFilterNextScheduledStartTime

​as_sql_filter

​FlowRunFilterParentFlowRunId

​as_sql_filter

​FlowRunFilterParentTaskRunId

​as_sql_filter

​FlowRunFilterIdempotencyKey

​as_sql_filter

​FlowRunFilter

​as_sql_filter

​only_filters_on_id

​TaskRunFilterFlowRunId

​as_sql_filter

​TaskRunFilterId

​as_sql_filter

​TaskRunFilterName

​as_sql_filter

​TaskRunFilterTags

​as_sql_filter

​TaskRunFilterStateType

​as_sql_filter

​TaskRunFilterStateName

​as_sql_filter

​TaskRunFilterState

​as_sql_filter

​TaskRunFilterSubFlowRuns

​as_sql_filter

​TaskRunFilterStartTime

​as_sql_filter

​TaskRunFilterExpectedStartTime

​as_sql_filter

​TaskRunFilter

​as_sql_filter

​DeploymentFilterId

`prefect.server.schemas.filters`

Classes

`Operator`

`auto`

`PrefectFilterBaseModel`

`as_sql_filter`

`model_validate_list`

`reset_fields`

`PrefectOperatorFilterBaseModel`

`as_sql_filter`

`as_sql_filter`

`FlowFilterId`

`as_sql_filter`

`FlowFilterDeployment`

`as_sql_filter`

`FlowFilterName`

`as_sql_filter`

`FlowFilterTags`

`as_sql_filter`

`FlowFilter`

`as_sql_filter`

`FlowRunFilterId`

`as_sql_filter`

`FlowRunFilterName`

`as_sql_filter`

`FlowRunFilterTags`

`as_sql_filter`

`FlowRunFilterDeploymentId`

`as_sql_filter`

`FlowRunFilterWorkQueueName`

`as_sql_filter`

`FlowRunFilterStateType`

`as_sql_filter`

`FlowRunFilterStateName`

`as_sql_filter`

`FlowRunFilterState`

`as_sql_filter`

`FlowRunFilterFlowVersion`

`as_sql_filter`

`FlowRunFilterStartTime`

`as_sql_filter`

`FlowRunFilterEndTime`

`as_sql_filter`

`FlowRunFilterExpectedStartTime`

`as_sql_filter`

`FlowRunFilterNextScheduledStartTime`

`as_sql_filter`

`FlowRunFilterParentFlowRunId`

`as_sql_filter`

`FlowRunFilterParentTaskRunId`

`as_sql_filter`

`FlowRunFilterIdempotencyKey`

`as_sql_filter`

`FlowRunFilter`

`as_sql_filter`

`only_filters_on_id`

`TaskRunFilterFlowRunId`

`as_sql_filter`

`TaskRunFilterId`

`as_sql_filter`

`TaskRunFilterName`

`as_sql_filter`

`TaskRunFilterTags`

`as_sql_filter`

`TaskRunFilterStateType`

`as_sql_filter`

`TaskRunFilterStateName`

`as_sql_filter`

`TaskRunFilterState`

`as_sql_filter`

`TaskRunFilterSubFlowRuns`

`as_sql_filter`

`TaskRunFilterStartTime`

`as_sql_filter`

`TaskRunFilterExpectedStartTime`

`as_sql_filter`

`TaskRunFilter`

`as_sql_filter`

`DeploymentFilterId`

`as_sql_filter`