airflow.providers.microsoft.azure.hooks.synapse¶

屬性¶

憑據

異常¶

AzureSynapsePipelineRunException

表示管道執行失敗的異常。

類¶

`AzureSynapseSparkBatchRunStatus`	Azure Synapse Spark 作業操作狀態。
`AzureSynapseHook`	用於與 Azure Synapse 互動的 Hook。
`AzureSynapsePipelineRunStatus`	Azure Synapse 管道操作狀態。
`BaseAzureSynapseHook`	使用連線 ID 建立與 Azure Synapse 的會話和連線的基礎 hook 類。
`AzureSynapsePipelineHook`	用於與 Azure Synapse Pipeline 互動的 Hook。

模組內容¶

airflow.providers.microsoft.azure.hooks.synapse.Credentials[source]¶

class airflow.providers.microsoft.azure.hooks.synapse.AzureSynapseSparkBatchRunStatus[source]¶

Azure Synapse Spark 作業操作狀態。

NOT_STARTED = 'not_started'[source]¶

STARTING = 'starting'[source]¶

RUNNING = 'running'[source]¶

IDLE = 'idle'[source]¶

BUSY = 'busy'[source]¶

SHUTTING_DOWN = 'shutting_down'[source]¶

ERROR = 'error'[source]¶

DEAD = 'dead'[source]¶

KILLED = 'killed'[source]¶

SUCCESS = 'success'[source]¶

TERMINAL_STATUSES[source]¶

class airflow.providers.microsoft.azure.hooks.synapse.AzureSynapseHook(azure_synapse_conn_id=default_conn_name, spark_pool='')[source]¶

基類: airflow.hooks.base.BaseHook

用於與 Azure Synapse 互動的 Hook。

引數：:

azure_synapse_conn_id (str) – Azure Synapse 連線 ID。。
spark_pool (str) – 用於提交作業的 Apache Spark 池

conn_type: str = 'azure_synapse'[source]¶

conn_name_attr: str = 'azure_synapse_conn_id'[source]¶

default_conn_name: str = 'azure_synapse_default'[source]¶

hook_name: str = 'Azure Synapse'[source]¶

classmethod get_connection_form_widgets()[source]¶

返回要新增到連線表單的連線小部件。

classmethod get_ui_field_behaviour()[source]¶

返回自定義欄位行為。

job_id: int | None = None[source]¶

conn_id = 'azure_synapse_default'[source]¶

spark_pool = ''[source]¶

get_conn()[source]¶

返回此 Hook 的連線。

run_spark_job(payload)[source]¶

在 Apache Spark 池中執行作業。

引數：:: payload (azure.synapse.spark.models.SparkBatchJobOptions) – Livy 相容的負載，表示使用者要提交的 Spark 作業。

get_job_run_status()[source]¶: 獲取作業執行狀態。

wait_for_job_run_status(job_id, expected_statuses, check_interval=60, timeout=60 * 60 * 24 * 7)[source]¶

等待作業執行達到預期狀態。

引數：:

job_id (int | None) – 作業執行識別符號。
expected_statuses (str | set[str]) – 用於檢查作業運行當前狀態的期望狀態。
check_interval (int) – 檢查作業執行狀態的間隔時間（秒）。
timeout (int) – 等待作業達到終止狀態或預期狀態的超時時間（秒）。

cancel_job_run(job_id)[source]¶

取消 Spark 作業執行。

引數：:: job_id (int) – Synapse Spark 作業識別符號。

class airflow.providers.microsoft.azure.hooks.synapse.AzureSynapsePipelineRunStatus[source]¶

Azure Synapse 管道操作狀態。

QUEUED = 'Queued'[source]¶

IN_PROGRESS = 'InProgress'[source]¶

SUCCEEDED = 'Succeeded'[source]¶

FAILED = 'Failed'[source]¶

CANCELING = 'Canceling'[source]¶

CANCELLED = 'Cancelled'[source]¶

TERMINAL_STATUSES[source]¶

INTERMEDIATE_STATES[source]¶

FAILURE_STATES[source]¶

exception airflow.providers.microsoft.azure.hooks.synapse.AzureSynapsePipelineRunException[source]¶

基類: airflow.exceptions.AirflowException

表示管道執行失敗的異常。

class airflow.providers.microsoft.azure.hooks.synapse.BaseAzureSynapseHook(azure_synapse_conn_id=default_conn_name, **kwargs)[source]¶

基類: airflow.hooks.base.BaseHook

使用連線 ID 建立與 Azure Synapse 的會話和連線的基礎 hook 類。

引數：:: azure_synapse_conn_id (str) – Azure Synapse 連線 ID。。

conn_type: str = 'azure_synapse'[source]¶

conn_name_attr: str ='azure_synapse_conn_id'[source]¶

default_conn_name: str ='azure_synapse_default'[source]¶

hook_name: str ='Azure Synapse'[source]¶

classmethod get_connection_form_widgets()[source]¶

返回要新增到連線表單的連線小部件。

返回要新增到連線表單的連線小部件。

返回自定義欄位行為。

conn_id ='azure_synapse_default'[source]¶

class airflow.providers.microsoft.azure.hooks.synapse.AzureSynapsePipelineHook(azure_synapse_workspace_dev_endpoint, azure_synapse_conn_id=default_conn_name, **kwargs)[source]¶

基類: BaseAzureSynapseHook

用於與 Azure Synapse Pipeline 互動的 Hook。

引數：:

azure_synapse_conn_id (str) – Azure Synapse 連線 ID。。
azure_synapse_workspace_dev_endpoint (str) – Azure Synapse Workspace 開發端點。

default_conn_name: str ='azure_synapse_connection'[source]¶

azure_synapse_workspace_dev_endpoint[source]¶

get_conn()[source]¶

返回此 Hook 的連線。

run_pipeline(pipeline_name, **config)[source]¶

執行 Synapse 管道。

引數：:

pipeline_name (str) – 管道名稱。
config (Any) – Synapse Artifact Client 的額外引數。

返回：:

管道執行 ID。

返回型別：:

azure.synapse.artifacts.models.CreateRunResponse

get_pipeline_run(run_id)[source]¶

獲取管道執行。

引數：:: run_id (str) – 管道執行識別符號。
返回：:: 管道執行。
返回型別：:: azure.synapse.artifacts.models.PipelineRun

get_pipeline_run_status(run_id)[source]¶

獲取管道執行的當前狀態。

引數：:: run_id (str) – 管道執行識別符號。
返回：:: 管道執行的狀態。
返回型別：:: str

refresh_conn()[source]¶

wait_for_pipeline_run_status(run_id, expected_statuses, check_interval=60, timeout=60 * 60 * 24 * 7)[source]¶

等待管道執行達到預期狀態。

引數：:

run_id (str) – 管道執行識別符號。
expected_statuses (str | set[str]) – 要與管道執行的當前狀態進行對照檢查的期望狀態。
check_interval (int) – 檢查管道執行狀態的間隔時間（秒）。
timeout (int) – 等待管道達到終止狀態或期望狀態的超時時間（秒）。

返回：:

一個布林值，指示管道執行是否已達到 expected_status。

返回型別：:

bool

cancel_run_pipeline(run_id)[source]¶

取消管道執行。

引數：:: run_id (str) – 管道執行識別符號。