Authoring Go Sdk Tasks

作者 astronomercbe1141f547b無授權條款451 個星標收錄於 2026年10月8日更新於 2026年10月8日儲存庫今天更新

Writes Airflow task logic in Go using the Airflow Go SDK. Use when the user wants to implement Airflow tasks in Go, asks about `BundleProvider`/`RegisterDags`, the `bundlev1` Registry/Dag interfaces, registering Go tasks (`AddTask`/`AddTaskWithName`), dependency injection by parameter type (`context.Context`, `sdk.TIRunContext`, `*slog.Logger`, `sdk.Client`), or reading connections/variables/XComs from Go. This skill covers the Go-specific native API; the shared Python-stub pattern and conceptual model live in authoring-language-sdk-tasks. For building/packing/shipping the bundle see deploying-go-sdk-bundles; for coordinator config see configuring-airflow-language-sdks.

AI 產生的概覽

指導使用 Airflow Go SDK 以 Go 撰寫 Airflow 工作邏輯,涵蓋 bundle、工作註冊與相依性注入。

功能
說明如何將 Airflow 工作實作為註冊於 bundle 中的編譯式 Go 函式,使用 bundlev1 的 BundleProvider、Registry 與 Dag 介面。文件介紹透過 AddTask 與 AddTaskWithName 註冊工作、依參數型別進行相依性注入、用於變數、連線與 XCom 的 sdk.Client 介面,以及執行階段內容存取器。也列出 Go 特有的注意事項,例如與 Python stub 的 ID 對應和佇列路由。
適用情境
適用於以 Go 實作 Airflow 工作,或詢問 BundleProvider、RegisterDags、bundlev1 介面、Go 工作註冊、依參數型別注入,以及從 Go 讀取連線、變數與 XCom 的情境。它假定讀者已了解共用的語言 SDK 模型,並另外指向該內容。
執行需求
需要 Airflow Go SDK 模組 github.com/apache/airflow/go-sdk 以及 Go 1.24 或更新版本。該 SDK 被描述為實驗性、尚未達到正式環境可用。僅為說明文件,不隨附指令碼。

Authoring Go SDK Tasks

The Airflow Go SDK implements the language-SDK model for Go: your DAG stays in Python, and each task is a compiled Go function registered inside a bundle (a single native executable). This skill covers the Go-specific native API. The shared model (the Python @task.stub pattern, ID matching, the XCom-as-JSON contract) lives in authoring-language-sdk-tasks; read that first if you are new to language SDKs.

Experimental. The Go SDK is under active development and not production-ready. Module path github.com/apache/airflow/go-sdk (Go 1.24+). APIs may change.

Related skills: authoring-language-sdk-tasks (shared Python stub + concepts), deploying-go-sdk-bundles (build, pack, and ship the bundle), configuring-airflow-language-sdks (route the queue to the Go coordinator).


Recap: the Python side

A Go task is paired with a Python stub that carries no logic; it declares the task, its queue, and the dependency graph. IDs must match the Go registration exactly, and queue= routes the task to the Go runtime. Full rules are in authoring-language-sdk-tasks; the minimal shape:

python
from airflow.sdk import dag, task
@task.stub(queue="golang")def extract(): ...
@task.stub(queue="golang")def transform(): ...
@dag()def simple_dag():    extract() >> transform()
simple_dag()

The queue value ("golang" here) is an arbitrary label that must match the queue routed to the Go coordinator (queue_to_coordinator). See configuring-airflow-language-sdks.


The bundle entry point

A bundle implements bundlev1.BundleProvider: report its version and register your DAGs and tasks. main is one line; bundlev1server.Serve wires the bundle to the Airflow runtime for you.

go
package main
import (	"log"
	v1 "github.com/apache/airflow/go-sdk/bundle/bundlev1"	"github.com/apache/airflow/go-sdk/bundle/bundlev1/bundlev1server")
type myBundle struct{}
var _ v1.BundleProvider = (*myBundle)(nil)
func (m *myBundle) GetBundleVersion() v1.BundleInfo {	return v1.BundleInfo{Name: bundleName, Version: &bundleVersion}}
func (m *myBundle) RegisterDags(dagbag v1.Registry) error {	simpleDag := dagbag.AddDag("simple_dag")      // dag_id must match the Python @dag name	simpleDag.AddTask(extract)                    // task_id is the function name; must match the stub	simpleDag.AddTaskWithName("transform", transform) // or set the task_id explicitly	return nil}
func main() {	if err := bundlev1server.Serve(&myBundle{}); err != nil {		log.Fatal(err)	}}

AddTask(fn) derives the task_id from the Go function's name; use AddTaskWithName("<task_id>", fn) when that name can't match the Python stub (an unexported, renamed, or reused function). RegisterDags is the single source of truth for task identity: the bundle's manifest (used by the packer and by the coordinator) is generated by running it, never hand-written.


Task functions: dependency injection by parameter type

A task is an ordinary Go function. The runtime inspects its signature and injects arguments by type; declare only what you need.

Parameter typeInjected value
context.ContextTask context for cancellation. Always available.
sdk.TIRunContextRicher context (embeds context.Context) exposing TaskInstance() and DagRun(). See Runtime context.
*slog.LoggerLogger wired to the Airflow task log.
sdk.ClientFull Airflow model access: Variables, Connections, XComs.
sdk.VariableClient / sdk.ConnectionClient / sdk.XComClientA narrower slice of sdk.Client. Prefer the narrowest you need; it documents intent and is trivial to fake in tests.

The optional return signature is (result, error): a non-nil result is pushed as the task's return_value XCom; a non-nil error fails the task (which triggers the stub's retry policy). Returning only error, or nothing, is also valid.

go
func extract(ctx sdk.TIRunContext, client sdk.Client, log *slog.Logger) (any, error) {	conn, err := client.GetConnection(ctx, "test_http")	if err != nil {		return nil, err	}	log.Info("connected", "host", conn.Host)	return map[string]any{"go_version": runtime.Version()}, nil}
func transform(ctx sdk.TIRunContext, client sdk.VariableClient) error {	val, err := client.GetVariable(ctx, "my_variable")	if err != nil {		return err // VariableNotFound (a sentinel error) if absent	}	_ = val	return nil}

The sdk.Client surface

CallReturnsNotes
GetVariable(ctx, key)(string, error)VariableNotFound if absent.
UnmarshalJSONVariable(ctx, key, &ptr)errorDecode a JSON variable into a struct/pointer.
GetConnection(ctx, connID)(Connection, error)ConnectionNotFound if absent.
GetXCom(ctx, dagID, runID, taskID, mapIndex, key, value)(any, error)XComNotFound only if the key is absent; a stored null returns (nil, nil).
PushXCom(ctx, ti, key, value)errorRarely needed; a returned value is pushed for you.

Connection exposes ID, Type, Host, Port (int), Login *string, Password *string (nil when unset, distinct from empty), Path (schema), Extra map[string]any, plus GetURI(). Not-found cases return the sentinels sdk.VariableNotFound, sdk.ConnectionNotFound, sdk.XComNotFound.

To read an upstream task's result, call GetXCom explicitly, taking the dag_id/run_id/task_id you need from the runtime context (below).


Runtime context

Declare an sdk.TIRunContext parameter to read metadata about the task instance and its DAG run. It is an interface that embeds context.Context, so it is usable anywhere a context.Context is expected.

go
func extract(ctx sdk.TIRunContext, log *slog.Logger) error {	ti, dagRun := ctx.TaskInstance(), ctx.DagRun()	log.Info("running",		"task_id", ti.TaskID,		"run_id", dagRun.RunID,		"logical_date", dagRun.LogicalDate)	return nil}
  • TaskInstance(): DagID, RunID, TaskID, MapIndex *int (nil when unmapped), TryNumber.
  • DagRun(): DagID, RunID, and the *time.Time timestamps LogicalDate, DataIntervalStart, DataIntervalEnd (nil when not sent).

The accessors are populated from the task's startup details before the body runs. Because TIRunContext embeds context.Context, pass it straight to client calls and cancellation checks (ctx.Done()); declare it as your context parameter by default. In tests, build the argument with sdk.NewTIRunContext(ctx, ti, dagRun) (it panics on a nil ctx).


Go-specific pitfalls

  • IDs must match the Python stub (dag_id from AddDag, task_id from the registered function name), and the stub's queue= must route to the Go coordinator, or the task is never delivered.
  • RegisterDags is authoritative. Do not hand-write the manifest; the packer generates it by running RegisterDags.
  • Ask for the narrowest client interface you need (sdk.VariableClient over sdk.Client) for clearer intent and easier fakes.
  • A non-nil error return fails the task and applies the stub's retries; a recovered panic is also a failure.
  • See authoring-language-sdk-tasks for the language-agnostic pitfalls (one process per task instance, set queue and retries on the stub).

Related Skills

  • authoring-language-sdk-tasks: Shared Python-stub pattern and concepts (read first).
  • deploying-go-sdk-bundles: Build and pack the bundle with go tool airflow-go-pack, then deploy it for the coordinator.
  • configuring-airflow-language-sdks: Route the queue to the Go coordinator (ExecutableCoordinator).
  • authoring-dags: General Airflow DAG authoring.

來源與署名

來源:astronomer/agents位於skills/authoring-go-sdk-tasks提交cbe1141

授權條款: 無授權條款

內容歸原作者所有。SourceWeft 從公開儲存庫中收錄這些內容。

檢舉或申請下架