Skip to content

enums

etl_craft.core.enums

The closed value sets of the Engine DB schema and craft-connector.yml.

Each enum's values are exactly what the Engine DB stores or the configuration file accepts, so members compare equal to the raw strings read from either.

TERMINAL_STATUSES module-attribute

TERMINAL_STATUSES = frozenset({RunStatus.SUCCESS, RunStatus.FAILED, RunStatus.SKIPPED, RunStatus.CANCELLED})

Statuses of a task that has finished its attempt.

SETTLED_STATUSES module-attribute

SETTLED_STATUSES = frozenset({RunStatus.SUCCESS, RunStatus.SKIPPED})

Statuses a task never leaves within its run; a retry does not run it again.

NOT_RETRYABLE_STATUSES module-attribute

NOT_RETRYABLE_STATUSES = frozenset({RunStatus.SUCCESS, RunStatus.SKIPPED, RunStatus.IN_PROGRESS})

Statuses that keep a task out of the ready set; FAILED and never-run tasks are retried.

FINISHED_RUN_STATUSES module-attribute

FINISHED_RUN_STATUSES = TERMINAL_STATUSES

Statuses of a pipeline run that has ended, a run skipped on purpose included.

MARKABLE_STATUSES module-attribute

MARKABLE_STATUSES = (RunStatus.SUCCESS, RunStatus.FAILED, RunStatus.SKIPPED)

The statuses mark sets on a task or a run.

RunStatus

Bases: StrEnum

Status of a pipeline run, a task run or a business-rule run.

CANCELLED ends a run an operator cancelled, and the tasks it stopped.

InterventionAction

Bases: StrEnum

What an operator did to a run, as AUD_RUN_INTERVENTIONS.ACTION records it.

SlaStatus

Bases: StrEnum

Whether a pipeline run finished within its SLA.

RefreshType

Bases: StrEnum

How a pipeline loads its data.

DependencyType

Bases: StrEnum

The upstream outcome a task or pipeline dependency waits for.

Handler

Bases: StrEnum

The handler that runs a task.

RunCondition

Bases: StrEnum

How many of a task's dependencies must be satisfied; a NULL condition means ALL.

OffsetType

Bases: StrEnum

The type of an incremental load's offset value.

SqlAction

Bases: StrEnum

The write a SQL task's SELECT is wrapped in; the engine owns every write.

EmailFlavour

Bases: StrEnum

The outcome an email alert reports.

Mode

Bases: StrEnum

Who schedules the tasks: the engine itself, or an external orchestrator.

GatePolicy

Bases: StrEnum

What a local run does with its dependencies on other pipelines: Dependency_gates.

enforce checks them and skips what they do not allow; warn checks them and runs anyway, recording the bypass; off does not check them, recording that too.

AuthMode

Bases: StrEnum

How a connection authenticates.

TableFormat

Bases: StrEnum

The table format the warehouse writes; native is the default.

CloningScope

Bases: StrEnum

Which Engine DB tables a clone copies.

EmailTransport

Bases: StrEnum

How the mail handler delivers a message.

TlsMode

Bases: StrEnum

How an SMTP session starts TLS.

enum_value

enum_value(enum: type[E], value: str, error: EtlCraftError) -> E

Read a case-insensitive enum value or raise the caller's domain diagnostic.