MCP Tools Reference: dataform.googleapis.com

כלי: get_compilation_result

שליפת תוצאת הידור אחת של Dataform.

ערך הפרמטר name צריך להיות בפורמט projects/{project_id}/locations/{location}/repositories/{repository}/compilationResults/{compilation_result}.

בדוגמת הקוד הבאה מוצג שימוש בפקודה curl כדי להפעיל את הכלי get_compilation_result MCP.

בקשת Curl 
curl --location 'https://dataform.googleapis.com/mcp' \
--header 'content-type: application/json' \
--header 'accept: application/json, text/event-stream' \
--data '{
  "method": "tools/call",
  "params": {
    "name": "get_compilation_result",
    "arguments": {
      // Provide these details according to the MCP tool specification.
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'

סכימת הקלט

GetCompilationResult הזמנה לצ'אט.

GetCompilationResultRequest

ייצוג JSON 
{
  "name": string
}
שדות
name

string

חובה. השם של תוצאת ההידור.

סכימת הפלט

מייצג את התוצאה של הידור פרויקט Dataform.

CompilationResult

ייצוג JSON 
{
  "name": string,
  "codeCompilationConfig": {
    object (CodeCompilationConfig)
  },
  "resolvedGitCommitSha": string,
  "dataformCoreVersion": string,
  "compilationErrors": [
    {
      object (CompilationError)
    }
  ],
  "dataEncryptionState": {
    object (DataEncryptionState)
  },
  "createTime": string,
  "privateResourceMetadata": {
    object (PrivateResourceMetadata)
  },
  "gcsRepositorySnapshotMetadata": {
    object (GcsRepositorySnapshotMetadata)
  },

  // Union field source can be only one of the following:
  "gitCommitish": string,
  "workspace": string,
  "releaseConfig": string
  // End of list of possible types for union field source.

  // Union field _internal_metadata can be only one of the following:
  "internalMetadata": string
  // End of list of possible types for union field _internal_metadata.
}
שדות
name

string

פלט בלבד. השם של תוצאת ההידור.
codeCompilationConfig

object (CodeCompilationConfig)

אי אפשר לשנות. אם השדה הזה מוגדר, השדות של code_compilation_config מבטלים את הגדרות הקומפילציה שמוגדרות כברירת מחדל בקובץ dataform.json.
resolvedGitCommitSha

string

פלט בלבד. ה-SHA של הקוד שעבר קומפילציה ב-Git, אחרי שכל ההפניות נפתרו. לא מוגדר לתוצאות קומפילציה שהמקור שלהן הוא סביבת עבודה.
dataformCoreVersion

string

פלט בלבד. הגרסה של @dataform/core ששימשה להידור.
compilationErrors[]

object (CompilationError)

פלט בלבד. שגיאות שנתקלו בהן במהלך קומפילציה של פרויקט.
dataEncryptionState

object (DataEncryptionState)

פלט בלבד. ההגדרה הזו מוגדרת רק אם במאגר יש מפתח KMS.
createTime

string (Timestamp format)

פלט בלבד. חותמת הזמן שבה נוצרה תוצאת ההידור.

הפונקציה משתמשת ב-RFC 3339, והפלט שנוצר תמיד יהיה בפורמט Z עם 0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים, לא רק ב-Z. דוגמאות: "2014-10-02T15:01:23Z", ‏ "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
privateResourceMetadata

object (PrivateResourceMetadata)

פלט בלבד. מטא-נתונים שמציינים אם המשאב הזה הוא ברמת המשתמש. המשאב CompilationResult הוא user_scoped רק אם הוא מגיע ממרחב עבודה.
gcsRepositorySnapshotMetadata

object (GcsRepositorySnapshotMetadata)

פלט בלבד. מטא-נתונים על תמונת המצב של המאגר שמשמשת מחברות מתוזמנות.
שדה איחוד source. המקור של תוצאת ההידור. הערך source יכול להיות רק אחד מהבאים:
gitCommitish

string

אי אפשר לשנות. שם הקומיט/התג/הענף ב-Git שבו צריך לבצע קומפילציה של המאגר. הוא חייב להיות קיים במאגר המרוחק. דוגמאות: – SHA של קומיט: 12ade345 – תג: tag1 – שם של ענף: branch1
workspace

string

אי אפשר לשנות. השם של סביבת העבודה שרוצים לקמפל. חייב להיות בפורמט projects/*/locations/*/repositories/*/workspaces/*.
releaseConfig

string

אי אפשר לשנות. השם של הגדרת המוצר שרוצים לקמפל. חייב להיות בפורמט projects/*/locations/*/repositories/*/releaseConfigs/*.

שדה איחוד _internal_metadata.

הערך _internal_metadata יכול להיות רק אחד מהבאים:
internalMetadata

string

פלט בלבד. כל פרטי המטא-נתונים שמשמשים באופן פנימי להצגת המשאב. לדוגמה: חותמות זמן, דגלים, שדות סטטוס וכו'. הפורמט של השדה הזה הוא מחרוזת JSON.

CodeCompilationConfig

ייצוג JSON 
{
  "defaultDatabase": string,
  "defaultSchema": string,
  "defaultLocation": string,
  "assertionSchema": string,
  "vars": {
    string: string,
    ...
  },
  "databaseSuffix": string,
  "schemaSuffix": string,
  "tablePrefix": string,
  "builtinAssertionNamePrefix": string,
  "defaultNotebookRuntimeOptions": {
    object (NotebookRuntimeOptions)
  },
  "pipelineConfig": {
    object (PipelineConfig)
  }
}
שדות
defaultDatabase

string

זה שינוי אופציונלי. מסד הנתונים שמוגדר כברירת מחדל (מזהה הפרויקט ב-Google Cloud).
defaultSchema

string

זה שינוי אופציונלי. סכימת ברירת המחדל (מזהה מערך הנתונים ב-BigQuery).
defaultLocation

string

זה שינוי אופציונלי. מיקום ברירת המחדל ב-BigQuery שבו ייעשה שימוש. ברירת המחדל היא "US". רשימה מלאה של המיקומים זמינה במסמכי BigQuery: https://cloud.google.com/bigquery/docs/locations.
assertionSchema

string

זה שינוי אופציונלי. סכימת ברירת המחדל (מזהה מערך הנתונים ב-BigQuery) לאסרטיבים.
vars

map (key: string, value: string)

זה שינוי אופציונלי. משתנים שהוגדרו על ידי המשתמש וזמינים לקוד הפרויקט במהלך ההידור.

אובייקט שמכיל רשימה של "key": value זוגות. לדוגמה: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
databaseSuffix

string

זה שינוי אופציונלי. הסיומת שצריך לצרף לכל השמות של מסדי הנתונים (מזהה פרויקט בענן של Google).
schemaSuffix

string

זה שינוי אופציונלי. הסיומת שצריך להוסיף לכל השמות של הסכימות (מזהה מערך הנתונים ב-BigQuery).
tablePrefix

string

זה שינוי אופציונלי. הקידומת שצריך להוסיף לפני כל שמות הטבלאות.
builtinAssertionNamePrefix

string

זה שינוי אופציונלי. הקידומת שתוצמד לשמות של טענות מובנות.
defaultNotebookRuntimeOptions

object (NotebookRuntimeOptions)

זה שינוי אופציונלי. אפשרויות ברירת המחדל להפעלה של מחברת.
pipelineConfig

object (PipelineConfig)

זה שינוי אופציונלי. אפשרויות צינור עיבוד הנתונים שמגדירות את סוג צינור עיבוד הנתונים והנתיב שלו במאגר Git.

VarsEntry

ייצוג JSON 
{
  "key": string,
  "value": string
}
שדות
key

string
value

string

NotebookRuntimeOptions

ייצוג JSON 
{
  "aiPlatformNotebookRuntimeTemplate": string,

  // Union field execution_sink can be only one of the following:
  "gcsOutputBucket": string
  // End of list of possible types for union field execution_sink.

  // Union field repository_snapshot_storage can be only one of the following:
  "gcsRepositorySnapshotDestination": {
    object (GcsRepositorySnapshotDestination)
  }
  // End of list of possible types for union field repository_snapshot_storage.
}
שדות
aiPlatformNotebookRuntimeTemplate

string

זה שינוי אופציונלי. שם המשאב של תבנית זמן הריצה של Colab, שממנה נוצר זמן ריצה להפעלת קובץ ה-notebook. אם לא מציינים, נוצרת סביבת זמן ריצה עם המפרטים שמוגדרים כברירת מחדל ב-Colab.
שדה איחוד execution_sink. המיקום שבו מאחסנים את תוצאת ההרצה של ה-notebook. הערך execution_sink יכול להיות רק אחד מהבאים:
gcsOutputBucket

string

זה שינוי אופציונלי. המיקום ב-Google Cloud Storage שאליו יועלו התוצאות. פורמט: gs://bucket-name
שדה איחוד repository_snapshot_storage. יעד הצילום של קבצי המאגר שיהיו זמינים לגישה לקריאה בלבד בסביבת זמן ריצה של מחברת repository_snapshot_storage יכול להיות רק אחד מהבאים:
gcsRepositorySnapshotDestination

object (GcsRepositorySnapshotDestination)

זה שינוי אופציונלי. יעד Google Cloud Storage להעלאת התמונה. אם לא מציינים URI, ברירת המחדל היא gcs_output_bucket שצוין. פורמט: gs://bucket-name/path/

GcsRepositorySnapshotDestination

ייצוג JSON 
{
  "repositorySnapshotUri": string
}
שדות
repositorySnapshotUri

string

זה שינוי אופציונלי. יעד ב-Google Cloud Storage להעלאת תמונת המצב של המאגר. פורמט: gs://bucket-name/path/

PipelineConfig

ייצוג JSON 
{
  "pipelineType": enum (PipelineType),
  "path": string
}
שדות
pipelineType

enum (PipelineType)

חובה. סוג צינור העיבוד.
path

string

חובה. הנתיב היחסי במאגר Git שבו מוגדר צינור הנתונים. לדוגמה, בצינור Dataform, זהו הנתיב לתיקייה שבה נמצאים workflow_settings.yaml או dataform.json.

CompilationError

ייצוג JSON 
{
  "message": string,
  "stack": string,
  "path": string,
  "actionTarget": {
    object (Target)
  }
}
שדות
message

string

פלט בלבד. ההודעה ברמה העליונה של השגיאה.
stack

string

פלט בלבד. דוח הקריסות המלא של השגיאה.
path

string

פלט בלבד. הנתיב של הקובץ שבו אירעה השגיאה, אם הוא זמין, ביחס לשורש הפרויקט.
actionTarget

object (Target)

פלט בלבד. המזהה של הפעולה שבה התרחשה השגיאה הזו, אם הוא זמין.

יעד

ייצוג JSON 
{
  "database": string,
  "schema": string,
  "name": string
}
שדות
database

string

זה שינוי אופציונלי. מסד הנתונים של הפעולה (מזהה הפרויקט ב-Google Cloud) .
schema

string

זה שינוי אופציונלי. הסכימה של הפעולה (מזהה מערך הנתונים ב-BigQuery), בתוך database.
name

string

זה שינוי אופציונלי. שם הפעולה, בתוך database ו-schema.

DataEncryptionState

ייצוג JSON 
{
  "kmsKeyVersionName": string
}
שדות
kmsKeyVersionName

string

חובה. שם גרסת מפתח ה-KMS שבאמצעותה מוצפנים נתונים של משאב.

חותמת הזמן

ייצוג JSON 
{
  "seconds": string,
  "nanos": integer
}
שדות
seconds

string (int64 format)

מייצג את השניות של זמן UTC מאז ראשית זמן יוניקס (Unix epoch) ‏1970-01-01T00:00:00Z. הערך חייב להיות בין ‎-62135596800 ל-‎253402300799, כולל (שמתאים לטווח 0001-01-01T00:00:00Z עד 9999-12-31T23:59:59Z).
nanos

integer

שבריר לא שלילי של שנייה ברזולוציית ננו-שנייה. השדה הזה מייצג את החלק של משך הזמן בננו-שניות, ולא מהווה חלופה לשניות. ערכי שניות שליליים עם שברים עדיין צריכים לכלול ערכי ננו-שניות לא שליליים שסופרים קדימה בזמן. הערך חייב להיות בין 0 ל-999,999,999, כולל.

PrivateResourceMetadata

ייצוג JSON 
{
  "userScoped": boolean
}
שדות
userScoped

boolean

פלט בלבד. אם הערך הוא true, המשאב הזה הוא ברמת המשתמש, כלומר הוא סביבת עבודה או שהוא נוצר מסביבת עבודה.

GcsRepositorySnapshotMetadata

ייצוג JSON 
{
  "repositorySnapshotUri": string,
  "crc32cChecksum": string,
  "generation": string
}
שדות
repositorySnapshotUri

string

פלט בלבד. ‫Google Cloud Storage URI של תמונת המצב של המאגר.
crc32cChecksum

string

פלט בלבד. סיכום הביקורת (checksum) של תמונת המצב של המאגר, בקידוד base64 עם סדר בייטים big-endian.
generation

string (int64 format)

פלט בלבד. מספר הדור של האובייקט ב-Cloud Storage. מידע נוסף מופיע כאן: https://cloud.google.com/storage/docs/metadata#generation-number.

PipelineType

סוג צינור העיבוד. יכול להיות שנרחיב את התקופה הזו בעתיד. במקרה של UNSPECIFIED, השגיאה תופעל.

טיפוסים בני מנייה (enum)
PIPELINE_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
DATAFORM פייפליין רגיל של Dataform.
SQL נכס של קובץ SQL יחיד.
NOTEBOOK נכס של קובץ יחיד של מחברת.

הערות על כלים

הערות על כלים נשלחות ללקוחות MCP כדי לתאר את הסיכון הבסיסי של כלי נתון. רוב הלקוחות מתייחסים לרמזים האלה כאל רמזים לא מהימנים, אבל אפשר להשתמש בהם כדי להחליט מתי לשלוח למשתמש הנחיה לאישור.

בנוסף למחרוזת הכותרת, מוגדרים הרמזים הבוליאניים הבאים:

  • ‫readOnlyHint: אם הערך הוא true, הכלי לא משנה את הסביבה שלו. ברירת מחדל: false.
  • ‫destructiveHint: אם הערך הוא True, הכלי יכול לבצע פעולות הרסניות. אם הערך הוא false, הכלי יכול לבצע רק פעולות של הוספה. ברירת מחדל: true.
  • ‫idempotentHint: אם הערך הוא true, קריאה חוזרת לכלי עם אותם ארגומנטים לא תשפיע על הסביבה שלו. ברירת מחדל: false.
  • ‫openWorldHint: אם הערך הוא true, הכלי יכול ליצור אינטראקציה עם 'עולם פתוח' של ישויות חיצוניות. אם הערך הוא false, הכלי יכול ליצור אינטראקציה רק עם ישויות פנימיות. לדוגמה, כלי לחיפוש באינטרנט יהיה עולם פתוח, אבל כלי לזיכרון לא יהיה עולם פתוח.

רמז הרסני: ❌ | רמז אידמפוטנטי: ✅ | רמז לקריאה בלבד: ✅ | רמז לעולם פתוח: ❌