MCP Tools Reference: cloud-sql

כלי: import_data

ייבוא נתונים למכונה של Cloud SQL.

אם הקובץ לא מתחיל ב-gs://, ההנחה היא שהקובץ מאוחסן באופן מקומי. אם הקובץ מקומי, צריך להעלות אותו ל-Cloud Storage לפני שאפשר לבצע את הקריאה בפועל של import_data. כדי להעלות את הקובץ ל-Cloud Storage, אפשר להשתמש בפקודות gcloud או gsutil.

לפני שמעלים את הקובץ ל-Cloud Storage, כדאי לחשוב אם רוצים להשתמש בקטגוריית אחסון קיימת או ליצור קטגוריית אחסון חדשה בפרויקט שצוין.

אחרי שהקובץ מועלה ל-Cloud Storage, לחשבון השירות של המופע צריכות להיות הרשאות מספיקות כדי לקרוא את הקובץ שהועלה מהקטגוריה של Cloud Storage.

כדי לעשות זאת:

  1. משתמשים בכלי get_instance כדי לקבל את כתובת האימייל של חשבון השירות של המופע. מפלט הכלי, מקבלים את הערך של השדה serviceAccountEmailAddress.
  2. מקצים לחשבון השירות של המכונה את התפקיד storage.objectAdmin בקטגוריה של Cloud Storage שצוינה. משתמשים בפקודה כמו gcloud storage buckets add-iam-policy-binding או בבקשה ל-Cloud Storage API. יכול להיות שיעברו שתיים עד שבע דקות או יותר עד שהתפקיד יינתן וההרשאות יועברו לחשבון השירות ב-Cloud Storage. אם נתקלתם בשגיאת הרשאות אחרי עדכון מדיניות IAM, כדאי להמתין כמה דקות ולנסות שוב.

אחרי שתקבלו הרשאות, תוכלו לייבא את הנתונים. מומלץ להשאיר את הפרמטרים האופציונליים ריקים ולהשתמש בברירות המחדל של המערכת. בדרך כלל אפשר לזהות את סוג הקובץ לפי הסיומת שלו. לדוגמה, אם הקובץ הוא קובץ SQL, .sql או .csv לקובץ CSV.

הדוגמה הבאה היא של SQL importContext ל-MySQL.

{
          "uri": "gs://sample-gcs-bucket/sample-file.sql",
          "kind": "sql#importContext",
          "fileType": "SQL"
        }

לא קיים פרמטר database עבור MySQL, כי שם מסד הנתונים אמור להופיע בקובץ ה-SQL. צריך לציין רק URI אחד. אין שדות חובה אחרים מלבד importContext.

ב-PostgreSQL, השדה database הוא חובה. הדוגמה הבאה היא של קובץ PostgreSQL importContext עם השדה database שצוין.

{
          "uri": "gs://sample-gcs-bucket/sample-file.sql",
          "kind": "sql#importContext",
          "fileType": "SQL",
          "database": "sample-db"
        }

הכלי import_data מחזיר פעולה ממושכת. משתמשים בכלי get_operation כדי לבצע דגימה של הסטטוס שלה עד שהפעולה מסתיימת.

בדוגמה הבאה אפשר לראות איך משתמשים ב-curl כדי להפעיל את כלי ה-MCP‏ import_data.

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

סכימת הקלט

בקשה לייבוא מופע.

SqlInstancesImportRequest

ייצוג ב-JSON 
{
  "instance": string,
  "project": string,
  "body": {
    object (InstancesImportRequest)
  }
}
שדות
instance

string

מזהה המכונה של Cloud SQL. הפרטים האלה לא כוללים את מזהה הפרויקט.
project

string

מזהה הפרויקט שמכיל את המופע.
body

object (InstancesImportRequest)

InstancesImportRequest

ייצוג ב-JSON 
{
  "importContext": {
    object (ImportContext)
  }
}
שדות
importContext

object (ImportContext)

מכיל פרטים על פעולת הייבוא.

ImportContext

ייצוג ב-JSON 
{
  "uri": string,
  "database": string,
  "kind": string,
  "fileType": enum (SqlFileType),
  "csvImportOptions": {
    object (SqlCsvImportOptions)
  },
  "importUser": string,
  "bakImportOptions": {
    object (SqlBakImportOptions)
  },
  "sqlImportOptions": {
    object (SqlImportOptions)
  },
  "tdeImportOptions": {
    object (SqlTdeImportOptions)
  }
}
שדות
uri

string

הנתיב לקובץ הייבוא ב-Cloud Storage, בפורמט gs://bucketName/fileName. יש תמיכה בקובצי gzip דחוסים (‎.gz) כשהערך של fileType הוא SQL. למופע צריכות להיות הרשאות כתיבה לקטגוריה והרשאות קריאה לקובץ.
database

string

מסד הנתונים שאליו רוצים לייבא. אם הערך של fileType הוא SQL, השדה הזה נדרש רק אם קובץ הייבוא לא מציין מסד נתונים, והוא מוחלף על ידי כל הגדרה של מסד נתונים בקובץ הייבוא. בפעולות ייבוא מקביליות של מופע שלם, מסד הנתונים מוחלף בשם מסד הנתונים שמאוחסן בשם של ספריית המשנה. אם הערך של fileType הוא CSV, צריך לציין מסד נתונים אחד.
kind

string

הערך הזה תמיד יהיה sql#importContext.
fileType

enum (SqlFileType)

סוג הקובץ של ה-URI שצוין.`SQL: The file contains SQL statements. \CSV`: הקובץ מכיל נתוני CSV.
csvImportOptions

object (SqlCsvImportOptions)

אפשרויות לייבוא נתונים כקובץ CSV.
importUser

string

המשתמש ב-PostgreSQL עבור פעולת הייבוא הזו. מכונות PostgreSQL בלבד.
bakImportOptions

object (SqlBakImportOptions)

ייבוא פרמטרים שספציפיים לקובצי ‎ .BAK של SQL Server
sqlImportOptions

object (SqlImportOptions)

זה שינוי אופציונלי. אפשרויות לייבוא נתונים מהצהרות SQL.
tdeImportOptions

object (SqlTdeImportOptions)

זה שינוי אופציונלי. ייבוא פרמטרים שספציפיים לאישורי TDE של SQL Server

SqlCsvImportOptions

ייצוג ב-JSON 
{
  "table": string,
  "columns": [
    string
  ],
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
שדות
table

string

הטבלה שאליה מייבאים את נתוני ה-CSV.
columns[]

string

העמודות שאליהן יובאו נתוני ה-CSV. אם לא מציינים עמודות, כל העמודות בטבלת מסד הנתונים נטענות עם נתוני ה-CSV.
escapeCharacter

string

מציין את התו שצריך להופיע לפני תו נתונים שצריך להוסיף לו תו בריחה.
quoteCharacter

string

מציין את תו המירכאות שבו צריך להשתמש כשמצטטים ערך נתונים.
fieldsTerminatedBy

string

מציינת את התו שמפריד בין העמודות בכל שורה בקובץ.
linesTerminatedBy

string

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

SqlBakImportOptions

ייצוג ב-JSON 
{
  "encryptionOptions": {
    object (EncryptionOptions)
  },
  "striped": boolean,
  "noRecovery": boolean,
  "recoveryOnly": boolean,
  "bakType": enum (BakType),
  "stopAt": string,
  "stopAtMark": string
}
שדות
encryptionOptions

object (EncryptionOptions)
striped

boolean

האם קבוצת הגיבוי שמשוחזרת היא מסוג striped. ההגדרה חלה רק על Cloud SQL ל-SQL Server.
noRecovery

boolean

האם ייבוא הגיבוי ישחזר את מסד הנתונים עם האפשרות NORECOVERY. ההגדרה חלה רק על Cloud SQL ל-SQL Server.
recoveryOnly

boolean

האם בקשת הייבוא של הגיבוי תעביר את מסד הנתונים למצב אונליין בלי להוריד את תוכן ה-Bak. אפשר להגדיר רק אחד מהערכים no_recovery ו-recovery_only כ-true, אחרת תוחזר שגיאה. ההגדרה חלה רק על Cloud SQL ל-SQL Server.
bakType

enum (BakType)

סוג התוכן של קובץ ה-bak, ‏ FULL או DIFF
stopAt

string (Timestamp format)

זה שינוי אופציונלי. חותמת הזמן שבה הייבוא אמור להסתיים. חותמת הזמן הזו היא בפורמט RFC 3339 (לדוגמה, 2023-10-01T16:19:00.094). השדה הזה מקביל למילת המפתח STOPAT והוא רלוונטי רק ל-Cloud SQL ל-SQL Server.

הפורמט הוא 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".
stopAtMark

string

זה שינוי אופציונלי. העסקה המסומנת שבה הייבוא אמור להיפסק. השדה הזה מקביל למילת המפתח STOPATMARK והוא חל רק על Cloud SQL ל-SQL Server.

EncryptionOptions

ייצוג ב-JSON 
{
  "certPath": string,
  "pvkPath": string,
  "pvkPassword": string,
  "keepEncrypted": boolean
}
שדות
certPath

string

הנתיב לאישור (‎.cer) ב-Cloud Storage, בפורמט gs://bucketName/fileName. למופע צריכות להיות הרשאות כתיבה לקטגוריה והרשאות קריאה לקובץ.
pvkPath

string

הנתיב למפתח הפרטי של האישור (‎.pvk) ב-Cloud Storage, בפורמט gs://bucketName/fileName. למופע צריכות להיות הרשאות כתיבה לקטגוריה והרשאות קריאה לקובץ.
pvkPassword

string

הסיסמה שמצפינה את המפתח הפרטי
keepEncrypted

boolean

זה שינוי אופציונלי. האם הקובץ המיובא נשאר מוצפן.

BoolValue

ייצוג ב-JSON 
{
  "value": boolean
}
שדות
value

boolean

הערך הבוליאני.

חותמת הזמן

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

string (int64 format)

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

integer

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

SqlImportOptions

ייצוג ב-JSON 
{
  "threads": integer,
  "parallel": boolean,
  "postgresImportOptions": {
    object (PostgresImportOptions)
  }
}
שדות
threads

integer

זה שינוי אופציונלי. מספר השרשורים שבהם יש להשתמש לייבוא מקביל.
parallel

boolean

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

object (PostgresImportOptions)

זה שינוי אופציונלי. אפשרויות לייבוא ממופע של Cloud SQL ל-PostgreSQL.

Int32Value

ייצוג ב-JSON 
{
  "value": integer
}
שדות
value

integer

הערך int32.

PostgresImportOptions

ייצוג ב-JSON 
{
  "clean": boolean,
  "ifExists": boolean
}
שדות
clean

boolean

זה שינוי אופציונלי. הדגל ‎--clean לכלי השירות pg_restore. הדגל הזה רלוונטי רק אם הפעלתם ב-Cloud SQL ייבוא מקביל של קבצים.
ifExists

boolean

זה שינוי אופציונלי. הדגל ‎--if-exists לכלי pg_restore. הדגל הזה רלוונטי רק אם הפעלתם ב-Cloud SQL ייבוא מקביל של קבצים.

SqlTdeImportOptions

ייצוג ב-JSON 
{
  "certificatePath": string,
  "privateKeyPath": string,
  "privateKeyPassword": string,
  "name": string
}
שדות
certificatePath

string

חובה. הנתיב למפתח הציבורי של אישור TDE בפורמט gs://bucketName/fileName. למופע צריכה להיות הרשאת קריאה לקובץ. רלוונטי רק למופעי SQL Server.
privateKeyPath

string

חובה. הנתיב למפתח הפרטי של אישור ה-TDE בפורמט gs://bucketName/fileName. למופע צריכה להיות הרשאת קריאה לקובץ. רלוונטי רק למופעי SQL Server.
privateKeyPassword

string

חובה. הסיסמה שמצפינה את המפתח הפרטי.
name

string

חובה. שם האישור. רלוונטי רק למופעי SQL Server.

סכימת פלט

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

פעולה

ייצוג ב-JSON 
{
  "kind": string,
  "targetLink": string,
  "status": enum (SqlOperationStatus),
  "user": string,
  "insertTime": string,
  "startTime": string,
  "endTime": string,
  "error": {
    object (OperationErrors)
  },
  "apiWarning": {
    object (ApiWarning)
  },
  "operationType": enum (SqlOperationType),
  "importContext": {
    object (ImportContext)
  },
  "exportContext": {
    object (ExportContext)
  },
  "backupContext": {
    object (BackupContext)
  },
  "preCheckMajorVersionUpgradeContext": {
    object (PreCheckMajorVersionUpgradeContext)
  },
  "name": string,
  "targetId": string,
  "selfLink": string,
  "targetProject": string,
  "acquireSsrsLeaseContext": {
    object (AcquireSsrsLeaseContext)
  },
  "subOperationType": {
    object (SqlSubOperationType)
  }
}
שדות
kind

string

הערך הזה תמיד יהיה sql#operation.
targetLink

string
status

enum (SqlOperationStatus)

הסטטוס של פעולה.
user

string

כתובת האימייל של המשתמש שהפעיל את הפעולה הזו.
insertTime

string (Timestamp format)

השעה שבה הפעולה הזו נוספה לתור, לפי שעון UTC, בפורמט RFC 3339. לדוגמה: 2012-11-15T16:19:00.094Z.

הפורמט הוא 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".
startTime

string (Timestamp format)

השעה שבה הפעולה הזו התחילה בפועל באזור הזמן UTC בפורמט RFC 3339, לדוגמה 2012-11-15T16:19:00.094Z.

הפורמט הוא 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".
endTime

string (Timestamp format)

השעה שבה הפעולה הזו הסתיימה לפי שעון UTC, בפורמט RFC 3339. לדוגמה: 2012-11-15T16:19:00.094Z.

הפורמט הוא 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".
error

object (OperationErrors)

אם אירעו שגיאות במהלך עיבוד הפעולה הזו, השדה הזה יאוכלס.
apiWarning

object (ApiWarning)

הודעת אזהרה של Admin API.
operationType

enum (SqlOperationType)

סוג הפעולה. הערכים התקפים הם: * CREATE * DELETE * UPDATE * RESTART * IMPORT * EXPORT * BACKUP_VOLUME * RESTORE_VOLUME * CREATE_USER * DELETE_USER * CREATE_DATABASE * DELETE_DATABASE
importContext

object (ImportContext)

ההקשר של פעולת הייבוא, אם רלוונטי.
exportContext

object (ExportContext)

ההקשר של פעולת הייצוא, אם רלוונטי.
backupContext

object (BackupContext)

ההקשר של פעולת הגיבוי, אם רלוונטי.
preCheckMajorVersionUpgradeContext

object (PreCheckMajorVersionUpgradeContext)

השדה הזה מאוכלס רק כשערך operation_type הוא PRE_CHECK_MAJOR_VERSION_UPGRADE. ההודעה PreCheckMajorVersionUpgradeContext עצמה מכילה את הפרטים של הבדיקה המוקדמת, כמו גרסת מסד הנתונים של היעד לשדרוג והתוצאות של הבדיקה (כולל אזהרות או שגיאות שנמצאו).
name

string

מזהה שמזהה באופן ייחודי את הפעולה. אפשר להשתמש במזהה הזה כדי לאחזר את משאב הפעולות שמכיל מידע על הפעולה.
targetId

string

שם המשאב שבו הפעולה הזו מופעלת.
selfLink

string

ה-URI של מקור המידע הזה.
targetProject

string

מזהה הפרויקט של מופע היעד שקשור לפעולה הזו.
acquireSsrsLeaseContext

object (AcquireSsrsLeaseContext)

ההקשר של פעולת השגת חכירה של SSRS, אם רלוונטי.
subOperationType

object (SqlSubOperationType)

זה שינוי אופציונלי. פעולת המשנה על סמך סוג הפעולה.

חותמת הזמן

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

string (int64 format)

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

integer

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

OperationErrors

ייצוג ב-JSON 
{
  "kind": string,
  "errors": [
    {
      object (OperationError)
    }
  ]
}
שדות
kind

string

הערך הזה תמיד יהיה sql#operationErrors.
errors[]

object (OperationError)

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

OperationError

ייצוג ב-JSON 
{
  "kind": string,
  "code": string,
  "message": string
}
שדות
kind

string

הערך הזה תמיד יהיה sql#operationError.
code

string

מזהה את השגיאה הספציפית שאירעה.
message

string

מידע נוסף על השגיאה שנתקלתם בה.

ApiWarning

ייצוג ב-JSON 
{
  "code": enum (SqlApiWarningCode),
  "message": string,
  "region": string
}
שדות
code

enum (SqlApiWarningCode)

קוד שמזהה באופן ייחודי את סוג האזהרה.
message

string

הודעת האזהרה.
region

string

שם האזור שמופיע באזהרה REGION_UNREACHABLE.

ImportContext

ייצוג ב-JSON 
{
  "uri": string,
  "database": string,
  "kind": string,
  "fileType": enum (SqlFileType),
  "csvImportOptions": {
    object (SqlCsvImportOptions)
  },
  "importUser": string,
  "bakImportOptions": {
    object (SqlBakImportOptions)
  },
  "sqlImportOptions": {
    object (SqlImportOptions)
  },
  "tdeImportOptions": {
    object (SqlTdeImportOptions)
  }
}
שדות
uri

string

הנתיב לקובץ הייבוא ב-Cloud Storage, בפורמט gs://bucketName/fileName. יש תמיכה בקובצי gzip דחוסים (‎.gz) כשהערך של fileType הוא SQL. למופע צריכות להיות הרשאות כתיבה לקטגוריה והרשאות קריאה לקובץ.
database

string

מסד הנתונים שאליו רוצים לייבא. אם הערך של fileType הוא SQL, השדה הזה נדרש רק אם קובץ הייבוא לא מציין מסד נתונים, והוא מוחלף על ידי כל הגדרה של מסד נתונים בקובץ הייבוא. בפעולות ייבוא מקביליות של מופע שלם, מסד הנתונים מוחלף בשם מסד הנתונים שמאוחסן בשם של ספריית המשנה. אם הערך של fileType הוא CSV, צריך לציין מסד נתונים אחד.
kind

string

הערך הזה תמיד יהיה sql#importContext.
fileType

enum (SqlFileType)

סוג הקובץ של ה-URI שצוין.`SQL: The file contains SQL statements. \CSV`: הקובץ מכיל נתוני CSV.
csvImportOptions

object (SqlCsvImportOptions)

אפשרויות לייבוא נתונים כקובץ CSV.
importUser

string

המשתמש ב-PostgreSQL עבור פעולת הייבוא הזו. מכונות PostgreSQL בלבד.
bakImportOptions

object (SqlBakImportOptions)

ייבוא פרמטרים שספציפיים לקובצי ‎ .BAK של SQL Server
sqlImportOptions

object (SqlImportOptions)

זה שינוי אופציונלי. אפשרויות לייבוא נתונים מהצהרות SQL.
tdeImportOptions

object (SqlTdeImportOptions)

זה שינוי אופציונלי. ייבוא פרמטרים שספציפיים לאישורי TDE של SQL Server

SqlCsvImportOptions

ייצוג ב-JSON 
{
  "table": string,
  "columns": [
    string
  ],
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
שדות
table

string

הטבלה שאליה מייבאים את נתוני ה-CSV.
columns[]

string

העמודות שאליהן יובאו נתוני ה-CSV. אם לא מציינים עמודות, כל העמודות בטבלת מסד הנתונים נטענות עם נתוני ה-CSV.
escapeCharacter

string

מציין את התו שצריך להופיע לפני תו נתונים שצריך להוסיף לו תו בריחה.
quoteCharacter

string

מציין את תו המירכאות שבו צריך להשתמש כשמצטטים ערך נתונים.
fieldsTerminatedBy

string

מציינת את התו שמפריד בין העמודות בכל שורה בקובץ.
linesTerminatedBy

string

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

SqlBakImportOptions

ייצוג ב-JSON 
{
  "encryptionOptions": {
    object (EncryptionOptions)
  },
  "striped": boolean,
  "noRecovery": boolean,
  "recoveryOnly": boolean,
  "bakType": enum (BakType),
  "stopAt": string,
  "stopAtMark": string
}
שדות
encryptionOptions

object (EncryptionOptions)
striped

boolean

האם קבוצת הגיבוי שמשוחזרת היא מסוג striped. ההגדרה חלה רק על Cloud SQL ל-SQL Server.
noRecovery

boolean

האם ייבוא הגיבוי ישחזר את מסד הנתונים עם האפשרות NORECOVERY. ההגדרה חלה רק על Cloud SQL ל-SQL Server.
recoveryOnly

boolean

האם בקשת הייבוא של הגיבוי תעביר את מסד הנתונים למצב אונליין בלי להוריד את תוכן ה-Bak. אפשר להגדיר רק אחד מהערכים no_recovery ו-recovery_only כ-true, אחרת תוחזר שגיאה. ההגדרה חלה רק על Cloud SQL ל-SQL Server.
bakType

enum (BakType)

סוג התוכן של קובץ ה-bak, ‏ FULL או DIFF
stopAt

string (Timestamp format)

זה שינוי אופציונלי. חותמת הזמן שבה הייבוא אמור להסתיים. חותמת הזמן הזו היא בפורמט RFC 3339 (לדוגמה, 2023-10-01T16:19:00.094). השדה הזה מקביל למילת המפתח STOPAT והוא רלוונטי רק ל-Cloud SQL ל-SQL Server.

הפורמט הוא 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".
stopAtMark

string

זה שינוי אופציונלי. העסקה המסומנת שבה הייבוא אמור להיפסק. השדה הזה מקביל למילת המפתח STOPATMARK והוא חל רק על Cloud SQL ל-SQL Server.

EncryptionOptions

ייצוג ב-JSON 
{
  "certPath": string,
  "pvkPath": string,
  "pvkPassword": string,
  "keepEncrypted": boolean
}
שדות
certPath

string

הנתיב לאישור (‎.cer) ב-Cloud Storage, בפורמט gs://bucketName/fileName. למופע צריכות להיות הרשאות כתיבה לקטגוריה והרשאות קריאה לקובץ.
pvkPath

string

הנתיב למפתח הפרטי של האישור (‎.pvk) ב-Cloud Storage, בפורמט gs://bucketName/fileName. למופע צריכות להיות הרשאות כתיבה לקטגוריה והרשאות קריאה לקובץ.
pvkPassword

string

הסיסמה שמצפינה את המפתח הפרטי
keepEncrypted

boolean

זה שינוי אופציונלי. האם הקובץ המיובא נשאר מוצפן.

BoolValue

ייצוג ב-JSON 
{
  "value": boolean
}
שדות
value

boolean

הערך הבוליאני.

SqlImportOptions

ייצוג ב-JSON 
{
  "threads": integer,
  "parallel": boolean,
  "postgresImportOptions": {
    object (PostgresImportOptions)
  }
}
שדות
threads

integer

זה שינוי אופציונלי. מספר השרשורים שבהם יש להשתמש לייבוא מקביל.
parallel

boolean

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

object (PostgresImportOptions)

זה שינוי אופציונלי. אפשרויות לייבוא ממופע של Cloud SQL ל-PostgreSQL.

Int32Value

ייצוג ב-JSON 
{
  "value": integer
}
שדות
value

integer

הערך int32.

PostgresImportOptions

ייצוג ב-JSON 
{
  "clean": boolean,
  "ifExists": boolean
}
שדות
clean

boolean

זה שינוי אופציונלי. הדגל ‎--clean לכלי השירות pg_restore. הדגל הזה רלוונטי רק אם הפעלתם ב-Cloud SQL ייבוא מקביל של קבצים.
ifExists

boolean

זה שינוי אופציונלי. הדגל ‎--if-exists לכלי pg_restore. הדגל הזה רלוונטי רק אם הפעלתם ב-Cloud SQL ייבוא מקביל של קבצים.

SqlTdeImportOptions

ייצוג ב-JSON 
{
  "certificatePath": string,
  "privateKeyPath": string,
  "privateKeyPassword": string,
  "name": string
}
שדות
certificatePath

string

חובה. הנתיב למפתח הציבורי של אישור TDE בפורמט gs://bucketName/fileName. למופע צריכה להיות הרשאת קריאה לקובץ. רלוונטי רק למופעי SQL Server.
privateKeyPath

string

חובה. הנתיב למפתח הפרטי של אישור ה-TDE בפורמט gs://bucketName/fileName. למופע צריכה להיות הרשאת קריאה לקובץ. רלוונטי רק למופעי SQL Server.
privateKeyPassword

string

חובה. הסיסמה שמצפינה את המפתח הפרטי.
name

string

חובה. שם האישור. רלוונטי רק למופעי SQL Server.

ExportContext

ייצוג ב-JSON 
{
  "uri": string,
  "databases": [
    string
  ],
  "kind": string,
  "sqlExportOptions": {
    object (SqlExportOptions)
  },
  "csvExportOptions": {
    object (SqlCsvExportOptions)
  },
  "fileType": enum (SqlFileType),
  "offload": boolean,
  "bakExportOptions": {
    object (SqlBakExportOptions)
  },
  "tdeExportOptions": {
    object (SqlTdeExportOptions)
  }
}
שדות
uri

string

הנתיב לקובץ ב-Google Cloud Storage שבו יישמר הייצוא. ה-URI הוא בפורמט gs://bucketName/fileName. אם הקובץ כבר קיים, הבקשה תצליח אבל הפעולה תיכשל. אם fileType הוא SQL ושם הקובץ מסתיים ב-‎ .gz, התוכן דחוס.
databases[]

string

מסדי הנתונים שרוצים לייצא. ‫
MySQL instances: אם הערך של fileType הוא SQL ולא צוין מסד נתונים, כל מסדי הנתונים מיוצאים, למעט מסד הנתונים של המערכת mysql. אם הערך של fileType הוא CSV, אפשר לציין מסד נתונים אחד באמצעות המאפיין הזה או באמצעות המאפיין csvExportOptions.selectQuery, שמקבל קדימות על פני המאפיין הזה.
PostgreSQL instances: אם לא מציינים מסד נתונים לפי שם, כל מסדי הנתונים של המשתמשים במופע מיוצאים. המספר הזה לא כולל מסדי נתונים של מערכות ומסדי נתונים של Cloud SQL שמשמשים לניהול פעולות פנימיות. אפשר לייצא את כל מסדי הנתונים של המשתמשים רק בייצוא מקביל בפורמט של ספרייה. אם הערך של fileType הוא CSV, מסד הנתונים הזה צריך להיות זהה לזה שצוין במאפיין csvExportOptions.selectQuery.
SQL Server instances: צריך לציין מסד נתונים אחד לייצוא, והערך של fileType חייב להיות BAK.
kind

string

הערך הזה תמיד יהיה sql#exportContext.
sqlExportOptions

object (SqlExportOptions)

אפשרויות לייצוא נתונים כהצהרות SQL.
csvExportOptions

object (SqlCsvExportOptions)

אפשרויות לייצוא נתונים כקובץ CSV. רק מקרים של MySQL ו-PostgreSQL.
fileType

enum (SqlFileType)

סוג הקובץ של ה-URI שצוין.
offload

boolean

האם לבצע ייצוא בלי שרת (serverless).
bakExportOptions

object (SqlBakExportOptions)

אפשרויות לייצוא נתונים כקבצי BAK.
tdeExportOptions

object (SqlTdeExportOptions)

זה שינוי אופציונלי. פרמטרים של ייצוא שספציפיים לאישורים של SQL Server TDE

SqlExportOptions

ייצוג ב-JSON 
{
  "tables": [
    string
  ],
  "schemaOnly": boolean,
  "mysqlExportOptions": {
    object (MysqlExportOptions)
  },
  "threads": integer,
  "parallel": boolean,
  "postgresExportOptions": {
    object (PostgresExportOptions)
  }
}
שדות
tables[]

string

טבלאות לייצוא, או טבלאות שיוצאו, ממסד הנתונים שצוין. אם מציינים טבלאות, צריך לציין מסד נתונים אחד בלבד. במקרים של מופעי PostgreSQL, אפשר לציין רק טבלה אחת.
schemaOnly

boolean

ייצוא של סכימות בלבד.
mysqlExportOptions

object (MysqlExportOptions)
threads

integer

זה שינוי אופציונלי. מספר השרשורים שבהם יש להשתמש לייצוא מקביל.
parallel

boolean

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

object (PostgresExportOptions)

זה שינוי אופציונלי. אפשרויות לייצוא ממכונת Cloud SQL ל-PostgreSQL.

MysqlExportOptions

ייצוג ב-JSON 
{
  "masterData": integer
}
שדות
masterData

integer

אפשרות לכלול הצהרת SQL שנדרשת להגדרת השכפול. אם הערך מוגדר ל-1, קובץ ה-dump כולל הצהרה של CHANGE MASTER TO עם הקואורדינטות של יומן הרישום הבינארי, וההגדרה ‎--set-gtid-purged מוגדרת ל-ON. אם ההגדרה היא 2, המשפט CHANGE MASTER TO נכתב כהערת SQL ואין לו השפעה. אם מגדירים ערך כלשהו שאינו 1, האפשרות ‎--set-gtid-purged מוגדרת כ-OFF.

PostgresExportOptions

ייצוג ב-JSON 
{
  "clean": boolean,
  "ifExists": boolean
}
שדות
clean

boolean

זה שינוי אופציונלי. משתמשים באפשרות הזו כדי לכלול DROP

<object>

הצהרות SQL. אפשר להשתמש בהצהרות האלה כדי למחוק אובייקטים של מסד נתונים לפני שמריצים את פעולת הייבוא.
ifExists

boolean

זה שינוי אופציונלי. אפשרות לכלול הצהרת SQL של IF EXISTS בכל הצהרת DROP שנוצרת על ידי clean.

SqlCsvExportOptions

ייצוג ב-JSON 
{
  "selectQuery": string,
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
שדות
selectQuery

string

שאילתת הבחירה שמשמשת לחילוץ הנתונים.
escapeCharacter

string

מציין את התו שצריך להופיע לפני תו נתונים שצריך להוסיף לו תו בריחה.
quoteCharacter

string

מציין את תו המירכאות שבו צריך להשתמש כשמצטטים ערך נתונים.
fieldsTerminatedBy

string

מציינת את התו שמפריד בין העמודות בכל שורה בקובץ.
linesTerminatedBy

string

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

SqlBakExportOptions

ייצוג ב-JSON 
{
  "striped": boolean,
  "stripeCount": integer,
  "bakType": enum (BakType),
  "copyOnly": boolean,
  "differentialBase": boolean,
  "exportLogStartTime": string,
  "exportLogEndTime": string
}
שדות
striped

boolean

האם הייצוא צריך להיות מפוספס.
stripeCount

integer

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

enum (BakType)

הסוג של קובץ ה-bak הזה יהיה export, ‏ FULL או DIFF, רק ב-SQL Server
copyOnly
(deprecated)

boolean

הוצא משימוש: התכונה copy_only הוצאה משימוש. במקום זאת, אפשר להשתמש ב-differential_base
differentialBase

boolean

האם אפשר להשתמש בגיבוי כגיבוי דיפרנציאלי של עותק בלבד. אי אפשר להשתמש בגיבוי כגיבוי דיפרנציאלי
exportLogStartTime

string (Timestamp format)

זה שינוי אופציונלי. חותמת הזמן של תחילת התקופה שיומן העסקאות ייכלל בייצוא. פורמט RFC 3339 (לדוגמה, 2023-10-01T16:19:00.094) לפי שעון UTC. אם לא מציינים את התאריך, כל היומנים הזמינים מתחילת תקופת השמירה ייכללו. ההגדרה הזו חלה רק על Cloud SQL ל-SQL Server.

הפורמט הוא 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".
exportLogEndTime

string (Timestamp format)

זה שינוי אופציונלי. חותמת הזמן של הסיום שבה יומן העסקאות ייכלל בפעולת הייצוא. פורמט RFC 3339 (לדוגמה, 2023-10-01T16:19:00.094) לפי שעון UTC. אם לא מציינים את הפרמטר הזה, כל היומנים הזמינים עד השעה הנוכחית ייכללו. ההגדרה הזו חלה רק על Cloud SQL ל-SQL Server.

הפורמט הוא 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".

SqlTdeExportOptions

ייצוג ב-JSON 
{
  "certificatePath": string,
  "privateKeyPath": string,
  "privateKeyPassword": string,
  "name": string
}
שדות
certificatePath

string

חובה. הנתיב למפתח הציבורי של אישור TDE בפורמט gs://bucketName/fileName. למופע צריכה להיות גישת כתיבה לקטגוריה. רלוונטי רק למופעי SQL Server.
privateKeyPath

string

חובה. הנתיב למפתח הפרטי של אישור ה-TDE בפורמט gs://bucketName/fileName. למכונה צריכה להיות הרשאת כתיבה למיקום. רלוונטי רק למופעי SQL Server.
privateKeyPassword

string

חובה. הסיסמה שמצפינה את המפתח הפרטי.
name

string

חובה. שם האישור. רלוונטי רק למופעי SQL Server.

BackupContext

ייצוג ב-JSON 
{
  "backupId": string,
  "kind": string,
  "name": string
}
שדות
backupId

string (int64 format)

המזהה של הגיבוי.
kind

string

הערך הזה תמיד יהיה sql#backupContext.
name

string

שם הגיבוי. פורמט: projects/{project}/backups/{backup}

PreCheckMajorVersionUpgradeContext

ייצוג ב-JSON 
{
  "targetDatabaseVersion": enum (SqlDatabaseVersion),
  "preCheckResponse": [
    {
      object (PreCheckResponse)
    }
  ],
  "kind": string
}
שדות
targetDatabaseVersion

enum (SqlDatabaseVersion)

חובה. גרסת מסד הנתונים שאליה רוצים לשדרג.
preCheckResponse[]

object (PreCheckResponse)

פלט בלבד. התשובות שמתקבלות מהפעולה של בדיקה מוקדמת.
kind

string

זה שינוי אופציונלי. הערך הזה תמיד יהיה sql#preCheckMajorVersionUpgradeContext.

PreCheckResponse

ייצוג ב-JSON 
{
  "actionsRequired": [
    string
  ],

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

  // Union field _message_type can be only one of the following:
  "messageType": enum (MessageType)
  // End of list of possible types for union field _message_type.
}
שדות
actionsRequired[]

string

הפעולות שהמשתמש צריך לבצע. אפשר להשתמש בפקודה 'חזרה' לכמה פעולות.

שדה איחוד _message.

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

string

ההודעה שתוצג למשתמש.

שדה איחוד _message_type.

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

enum (MessageType)

סוג ההודעה: מידע, אזהרה או שגיאה.

AcquireSsrsLeaseContext

ייצוג ב-JSON 
{

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

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

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

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

שדה איחוד _setup_login.

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

string

שם המשתמש שישמש להתחברות לצורך ההגדרה כדי להתחבר לשרת מסד הנתונים להגדרת SSRS.

שדה איחוד _service_login.

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

string

שם המשתמש שישמש להתחברות לשירות כדי להתחבר למסד הנתונים של הדוחות לצורך הגדרת SSRS.

שדה איחוד _report_database.

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

string

מסד הנתונים של הדוחות שבו יש להשתמש להגדרת SSRS.

שדה איחוד _duration.

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

string (Duration format)

נדרש משך חכירה להגדרת SSRS.

משך זמן בשניות עם עד תשע ספרות אחרי הנקודה העשרונית, שמסתיים ב-'s'. דוגמה: "3.5s".

משך הזמן

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

string (int64 format)

השניות החתומות של טווח הזמן. הערך חייב להיות בין ‎-315,576,000,000 לבין ‎+315,576,000,000, כולל. הערה: הגבולות האלה מחושבים לפי: 60 שניות/דקה * 60 דקות/שעה * 24 שעות/יום * 365.25 ימים/שנה * 10,000 שנים
nanos

integer

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

SqlSubOperationType

ייצוג ב-JSON 
{

  // Union field sub_operation_details can be only one of the following:
  "maintenanceType": enum (SqlMaintenanceType)
  // End of list of possible types for union field sub_operation_details.
}
שדות
שדה איחוד sub_operation_details. פרטים של פעולות משנה שמתאימים לסוג הפעולה. הערך sub_operation_details יכול להיות רק אחד מהבאים:
maintenanceType

enum (SqlMaintenanceType)

סוג התחזוקה שיבוצע במכונה.

הערות על כלי

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