`prefect.server.models.variables`

Functions

`emit_variable_created_event`

emit_variable_created_event(variable: orm_models.Variable) -> None

Emit an event when a variable is created.

`emit_variable_updated_event`

emit_variable_updated_event(variable: orm_models.Variable) -> None

Emit an event when a variable is updated.

`emit_variable_deleted_event`

emit_variable_deleted_event(variable: orm_models.Variable) -> None

Emit an event when a variable is deleted.

`create_variable`

create_variable(db: PrefectDBInterface, session: AsyncSession, variable: VariableCreate) -> orm_models.Variable

Create a variable Args:

session: async database session
variable: variable to create

Returns:

orm_models.Variable

`read_variable`

read_variable(db: PrefectDBInterface, session: AsyncSession, variable_id: UUID) -> Optional[orm_models.Variable]

Reads a variable by id.

`read_variable_by_name`

read_variable_by_name(db: PrefectDBInterface, session: AsyncSession, name: str) -> Optional[orm_models.Variable]

Reads a variable by name.

`read_variables`

read_variables(db: PrefectDBInterface, session: AsyncSession, variable_filter: Optional[filters.VariableFilter] = None, sort: sorting.VariableSort = sorting.VariableSort.NAME_ASC, offset: Optional[int] = None, limit: Optional[int] = None) -> Sequence[orm_models.Variable]

Read variables, applying filers.

`count_variables`

count_variables(db: PrefectDBInterface, session: AsyncSession, variable_filter: Optional[filters.VariableFilter] = None) -> int

Count variables, applying filters.

`update_variable`

update_variable(db: PrefectDBInterface, session: AsyncSession, variable_id: UUID, variable: VariableUpdate) -> bool

Updates a variable by id.

`update_variable_by_name`

update_variable_by_name(db: PrefectDBInterface, session: AsyncSession, name: str, variable: VariableUpdate) -> bool

Updates a variable by name.

`delete_variable`

delete_variable(db: PrefectDBInterface, session: AsyncSession, variable_id: UUID) -> bool

Delete a variable by id.

`delete_variable_by_name`

delete_variable_by_name(db: PrefectDBInterface, session: AsyncSession, name: str) -> bool

Delete a variable by name.

​prefect.server.models.variables

​Functions

​emit_variable_created_event

​emit_variable_updated_event

​emit_variable_deleted_event

​create_variable

​read_variable

​read_variable_by_name

​read_variables

​count_variables

​update_variable

​update_variable_by_name

​delete_variable

​delete_variable_by_name