Feladatkörnyezet lekérése egy UDF-ben

A TaskContext PySpark API használatával környezeti információkat kaphat a Batch Unity Catalog Python UDF vagy PySpark UDF futtatásakor.

A kontextus információk, mint például a felhasználó identitása és a fürtcímkék, ellenőrizhetik a felhasználó identitását a külső szolgáltatásokhoz való hozzáférés érdekében.

Követelmények

• A TaskContext a Databricks Runtime 16.3-s és újabb verzióiban támogatott.

• A TaskContext a következő UDF-típusok esetében támogatott:

  • Batch Unity Katalógus Python függvények
  • Skaláris Python UDF-ek

Környezeti adatok lekérése a TaskContext használatával

Válasszon egy lapot a PySpark UDF-ekhez vagy a Batch Unity Catalog Python UDF-jeihez készült TaskContext-példák megtekintéséhez.

PySpark UDF

A következő PySpark UDF-példa a felhasználó környezetét nyomtatja ki:

@udf
def log_context():
  import json
  from pyspark.taskcontext import TaskContext
  tc = TaskContext.get()

  # Returns current user executing the UDF
  session_user = tc.getLocalProperty("user")

  # Returns cluster tags
  tags = dict(item.values() for item in json.loads(tc.getLocalProperty("spark.databricks.clusterUsageTags.clusterAllTags  ") or "[]"))

  # Returns current version details
  current_version = {
    "dbr_version": tc.getLocalProperty("spark.databricks.clusterUsageTags.sparkVersion"),
    "dbsql_version": tc.getLocalProperty("spark.databricks.clusterUsageTags.dbsqlVersion")
  }

  return {
    "user": session_user,
    "job_group_id": job_group_id,
    "tags": tags,
    "current_version": current_version
  }

Batch Unity Katalógus Python UDF

Az alábbi Batch Unity Catalog Python UDF-példa a felhasználó identitását kéri le, hogy egy AWS Lambda-függvényt hívjon meg szolgáltatási hitelesítő adatok használatával.

%sql
CREATE OR REPLACE FUNCTION main.test.call_lambda_func(data STRING, debug BOOLEAN) RETURNS STRING LANGUAGE PYTHON
PARAMETER STYLE PANDAS
HANDLER 'batchhandler'
CREDENTIALS (
  `batch-udf-service-creds-example-cred` DEFAULT
)
AS $$
import boto3
import json
import pandas as pd
import base64
from pyspark.taskcontext import TaskContext


def batchhandler(it):
  # Automatically picks up DEFAULT credential:
  session = boto3.Session()

  client = session.client("lambda", region_name="us-west-2")

  # Can propagate TaskContext information to lambda context:
  user_ctx = {"custom": {"user": TaskContext.get().getLocalProperty("user")}}

  for vals, is_debug in it:
    payload = json.dumps({"values": vals.to_list(), "is_debug": bool(is_debug[0])})

    res = client.invoke(
      FunctionName="HashValuesFunction",
      InvocationType="RequestResponse",
      ClientContext=base64.b64encode(json.dumps(user_ctx).encode("utf-8")).decode(
        "utf-8"
      ),
      Payload=payload,
    )

    response_payload = json.loads(res["Payload"].read().decode("utf-8"))
    if "errorMessage" in response_payload:
      raise Exception(str(response_payload))

    yield pd.Series(response_payload["values"])
$$;

Hívja meg az UDF-et, miután regisztrálták.

SELECT main.test.call_lambda_func(data, false)
FROM VALUES
('abc'),
('def')
AS t(data)

TaskContext tulajdonságai

A TaskContext.getLocalProperty() metódus a következő tulajdonságkulcsokkal rendelkezik:

Tulajdonságkulcs	Leírás	használati példa
user	A UDF-et jelenleg végrehajtó felhasználó	tc.getLocalProperty("user") ->"alice"
spark.jobGroup.id	A jelenlegi UDF-hez kapcsolódó Spark-feladatcsoport azonosítója	tc.getLocalProperty("spark.jobGroup.id") ->"jobGroup-92318"
spark.databricks.clusterUsageTags.clusterAllTags	A klaszter metaadatcímkéi kulcs-érték párokként vannak megjelenítve és formázva, mint egy JSON-szótár szövegábrázolása.	tc.getLocalProperty("spark.databricks.clusterUsageTags.clusterAllTags") ->[{"Department": "Finance"}]
spark.databricks.clusterUsageTags.region	Az a régió, ahol a munkaterület található	tc.getLocalProperty("spark.databricks.clusterUsageTags.region") ->"us-west-2"
accountId	Databricks-fiókazonosító a futó környezethez	tc.getLocalProperty("accountId") ->"1234567890123456"
orgId	Munkaterület azonosítója (a DBSQL-en nem érhető el)	tc.getLocalProperty("orgId") ->"987654321"
spark.databricks.clusterUsageTags.sparkVersion	Databricks Runtime a fürthöz használt verzió (a nem DBSQL-környezetekben)	tc.getLocalProperty("spark.databricks.clusterUsageTags.sparkVersion") ->"16.3"
spark.databricks.clusterUsageTags.dbsqlVersion	DBSQL-verzió (DBSQL-környezeteken)	tc.getLocalProperty("spark.databricks.clusterUsageTags.dbsqlVersion") ->"2024.35"