MCP Tools Reference: cloud-sql

Tool: create_instance

Leitet die Erstellung einer Cloud SQL-Instanz ein.

  • Das Tool gibt einen Vorgang mit langer Ausführungszeit zurück. Verwenden Sie das Tool get_operation, um den Status abzufragen, bis der Vorgang abgeschlossen ist.
  • Das Erstellen der Instanz kann einige Minuten dauern. Verwenden Sie ein Befehlszeilentool, um 30 Sekunden zu pausieren, bevor Sie den Status noch einmal prüfen.
  • Nachdem Sie mit dem Tool create_instance eine Instanz erstellt haben, können Sie mit dem Tool create_user ein IAM-Nutzerkonto für den Nutzer erstellen, der derzeit im Projekt angemeldet ist.
  • Der Wert von data_api_access ist standardmäßig auf ALLOW_DATA_API festgelegt. Mit dieser Einstellung können Sie SQL-Anweisungen mit dem execute_sql-Tool und der executeSql API ausführen.

Sofern nicht anders angegeben, verwendet eine neu erstellte Instanz die Standardkonfiguration einer Entwicklungsumgebung.

Im Folgenden sehen Sie die Standardkonfiguration für eine Instanz in einer Entwicklungsumgebung:

{
          "tier": "db-perf-optimized-N-2",
          "data_disk_size_gb": 100,
          "region": "us-central1",
          "database_version": "POSTGRES_18",
          "edition": "ENTERPRISE_PLUS",
          "availability_type": "ZONAL",
          "tags": [{"environment": "dev"}]
        }
        

Die folgende Konfiguration wird für eine Instanz in einer Produktionsumgebung empfohlen:

{
          "tier": "db-perf-optimized-N-8",
          "data_disk_size_gb": 250,
          "region": "us-central1",
          "database_version": "POSTGRES_18",
          "edition": "ENTERPRISE_PLUS",
          "availability_type": "REGIONAL",
          "tags": [{"environment": "prod"}]
        }
        

Die folgende Instanzkonfiguration wird für SQL Server empfohlen:

{
          "tier": "db-perf-optimized-N-8",
          "data_disk_size_gb": 250,
          "region": "us-central1",
          "database_version": "SQLSERVER_2022_STANDARD",
          "edition": "ENTERPRISE_PLUS",
          "availability_type": "REGIONAL",
          "tags": [{"environment": "prod"}]
        }
        

Im folgenden Beispiel wird gezeigt, wie Sie mit curl das MCP-Tool create_instance aufrufen.

Curl-Anfrage
                  
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": "create_instance",
    "arguments": {
      // provide these details according to the tool's MCP specification
    }
  },
  "jsonrpc": "2.0",
  "id": 1
}'
                

Eingabeschema

Anfrage zum Einfügen von Instanzen für MCP.

SqlInstancesInsertMcpRequest

JSON-Darstellung
{
  "project": string,
  "name": string,
  "databaseVersion": string,
  "region": string,
  "edition": string,
  "tier": string,
  "dataDiskSizeGb": string,
  "availabilityType": string,
  "tags": {
    string: string,
    ...
  },
  "dataCacheEnabled": boolean,
  "enableGoogleMlIntegration": boolean
}
Felder
project

string

Erforderlich. Projekt-ID des Projekts, zu dem die neu erstellten Cloud SQL-Instanzen gehören sollen.

name

string

Erforderlich. Name der Cloud SQL-Instanz. Die Projekt-ID ist darin nicht enthalten.

databaseVersion

string

Optional. Der Typ und die Version der Datenbank-Engine. Der Standardwert ist POSTGRES_18.

Für MySQL kann es MYSQL_8_4, MYSQL_8_0, MYSQL_5_7 usw. sein. Für PostgreSQL kann es POSTGRES_18, POSTGRES_17, POSTGRES_16 usw. sein. Für SQL Server kann es SQLSERVER_2022_STANDARD, SQLSERVER_2022_EXPRESS, SQLSERVER_2022_ENTERPRISE usw. sein.

region

string

Optional. Die geografische Region der Cloud SQL-Instanz. Zum Beispiel: us-central1, europe-west1 und asia-east1.

Wenn keine Angabe erfolgt, beträgt der Standardwert us-central1.

edition

string

Optional. Die Version der Instanz kann ENTERPRISE oder ENTERPRISE_PLUS sein. Wenn nichts angegeben ist: – Für Postgres und MySQL ist der Standardwert ENTERPRISE_PLUS. – Bei SQL Server ist der Standardwert ENTERPRISE.

tier

string

Optional. Die Stufe oder der Maschinentyp für diese Instanz.

Wenn nichts angegeben ist: – Für die ENTERPRISE_PLUS-Version ist die Standardstufe db-perf-optimized-N-2, die Ihnen 2 vCPUs und 16 GB RAM bietet. – Für die ENTERPRISE-Version ist die Standardstufe db-custom-2-3840, die Ihnen 2 vCPUs und 3, 75 GB RAM bietet.

Für die ENTERPRISE_PLUS-Version muss die N2-Maschinenserie verwendet werden. In der ENTERPRISE-Version können benutzerdefinierte Maschinentypnamen das folgende Format haben: db-custom-{CPUs}-{Memory}.

dataDiskSizeGb

string (Int64Value format)

Optional. Größe des Datenlaufwerks in GB. Der Standardwert ist 100.

availabilityType

string

Optional. Verfügbarkeitstyp Mögliche Werte: * ZONAL: Die Instanz stellt Daten aus nur einer Zone bereit. Ausfälle in dieser Zone wirken sich auf die Datenverfügbarkeit aus. Dies ist der Standardwert. * REGIONAL: Die Instanz kann Daten aus mehreren Zonen in einer Region bereitstellen (hohe Verfügbarkeit).

tags

map (key: string, value: string)

Optional. Nur Eingabe. Tag-Schlüssel und Tag-Werte, die an diese Instanz gebunden sind. Jedes Element in der Karte muss so dargestellt werden: "<tag-key-namespaced-name>" : "<tag-value-short-name>".

Eine einzelne Ressource kann beispielsweise die folgenden Tags haben:

  "environment": "prod",

Ein Objekt, das eine Liste von "key": value-Paaren enthält. Beispiel: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

dataCacheEnabled

boolean

Optional. Gibt an, ob der Datencache für die Instanz aktiviert ist.

enableGoogleMlIntegration

boolean

Optional. Wenn dieser Parameter auf „true“ gesetzt ist, können Cloud SQL-Instanzen eine Verbindung zu Vertex AI herstellen, um Anfragen für Echtzeitvorhersagen und Statistiken an die KI zu übergeben. Der Standardwert ist „false“. Dies gilt nur für Cloud SQL for MySQL- und Cloud SQL for PostgreSQL-Instanzen.

Int64Value

JSON-Darstellung
{
  "value": string
}
Felder
value

string (int64 format)

Der int64-Wert.

TagsEntry

JSON-Darstellung
{
  "key": string,
  "value": string
}
Felder
key

string

value

string

BoolValue

JSON-Darstellung
{
  "value": boolean
}
Felder
value

boolean

Der boolesche Wert.

Ausgabeschema

Eine Vorgangsressource. Bei erfolgreichen Vorgängen, die eine Vorgangsressource zurückgeben, werden in der Ressource nur die für den Vorgang relevanten Felder ausgefüllt.

Vorgang

JSON-Darstellung
{
  "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)
  }
}
Felder
kind

string

Dies ist immer sql#operation.

targetLink

string

status

enum (SqlOperationStatus)

Der Status eines Vorgangs.

user

string

Die E-Mail-Adresse des Nutzers, der diesen Vorgang initiiert hat.

insertTime

string (Timestamp format)

Die Zeit, zu der dieser Vorgang in der UTC-Zeitzone im RFC 3339-Format in die Warteschlange gestellt wurde, z. B. 2012-11-15T16:19:00.094Z.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

startTime

string (Timestamp format)

Die Uhrzeit, zu der dieser Vorgang tatsächlich in der UTC-Zeitzone im RFC 3339-Format gestartet wurde, z. B. 2012-11-15T16:19:00.094Z.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

endTime

string (Timestamp format)

Die Uhrzeit, zu der dieser Vorgang in der UTC-Zeitzone im RFC 3339-Format abgeschlossen wurde, z. B. 2012-11-15T16:19:00.094Z.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

error

object (OperationErrors)

Wenn bei der Verarbeitung dieses Vorgangs Fehler aufgetreten sind, wird dieses Feld ausgefüllt.

apiWarning

object (ApiWarning)

Eine Admin API-Warnmeldung.

operationType

enum (SqlOperationType)

Der Typ des Vorgangs. Gültige Werte sind: * CREATE * DELETE * UPDATE * RESTART * IMPORT * EXPORT * BACKUP_VOLUME * RESTORE_VOLUME * CREATE_USER * DELETE_USER * CREATE_DATABASE * DELETE_DATABASE

importContext

object (ImportContext)

Der Kontext für den Importvorgang, falls zutreffend.

exportContext

object (ExportContext)

Der Kontext für den Exportvorgang, falls zutreffend.

backupContext

object (BackupContext)

Der Kontext für den Sicherungsvorgang, falls zutreffend.

preCheckMajorVersionUpgradeContext

object (PreCheckMajorVersionUpgradeContext)

Dieses Feld wird nur ausgefüllt, wenn „operation_type“ auf PRE_CHECK_MAJOR_VERSION_UPGRADE festgelegt ist. Die Nachricht „PreCheckMajorVersionUpgradeContext“ selbst enthält die Details für diese Vorabprüfung, z. B. die Zieldatenbankversion für das Upgrade und die Ergebnisse der Prüfung (einschließlich aller gefundenen Warnungen oder Fehler).

name

string

Eine Kennung, die den Vorgang eindeutig identifiziert. Mit dieser Kennung können Sie die Operations-Ressource mit Informationen zum Vorgang abrufen.

targetId

string

Name der Ressource, für die dieser Vorgang ausgeführt wird.

selfLink

string

Der URI dieser Ressource.

targetProject

string

Die Projekt-ID der Zielinstanz, die mit diesem Vorgang verknüpft ist.

acquireSsrsLeaseContext

object (AcquireSsrsLeaseContext)

Der Kontext für den Vorgang zum Erwerben einer SSRS-Freigabe, falls zutreffend.

subOperationType

object (SqlSubOperationType)

Optional. Der untergeordnete Vorgang basierend auf dem Vorgangstyp.

Zeitstempel

JSON-Darstellung
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Stellt Sekunden der UTC-Zeit seit Unix-Epoche 1970-01-01T00:00:00Z dar. Muss einschließlich zwischen -62135596800 und 253402300799 liegen (entspricht 0001-01-01T00:00:00Z bis 9999-12-31T23:59:59Z).

nanos

integer

Nicht negative Sekundenbruchteile Nanosekunden-Auflösung. Dieses Feld enthält den Nanosekundenanteil der Dauer und ist keine Alternative zu Sekunden. Negative Sekundenwerte mit Bruchteilen müssen weiterhin nicht negative Nano-Werte haben, die zeitlich vorwärts gezählt werden. Muss zwischen 0 und 999.999.999 liegen (einschließlich).

OperationErrors

JSON-Darstellung
{
  "kind": string,
  "errors": [
    {
      object (OperationError)
    }
  ]
}
Felder
kind

string

Dies ist immer sql#operationErrors.

errors[]

object (OperationError)

Die Liste der Fehler, die bei der Verarbeitung dieses Vorgangs aufgetreten sind.

OperationError

JSON-Darstellung
{
  "kind": string,
  "code": string,
  "message": string
}
Felder
kind

string

Dies ist immer sql#operationError.

code

string

Identifiziert den spezifischen Fehler, der aufgetreten ist.

message

string

Zusätzliche Informationen zum aufgetretenen Fehler.

ApiWarning

JSON-Darstellung
{
  "code": enum (SqlApiWarningCode),
  "message": string,
  "region": string
}
Felder
code

enum (SqlApiWarningCode)

Code zur eindeutigen Identifizierung des Warnungstyps.

message

string

Warnmeldung.

region

string

Der Name der Region für die Warnung REGION_UNREACHABLE.

ImportContext

JSON-Darstellung
{
  "uri": string,
  "database": string,
  "kind": string,
  "fileType": enum (SqlFileType),
  "csvImportOptions": {
    object (SqlCsvImportOptions)
  },
  "importUser": string,
  "bakImportOptions": {
    object (SqlBakImportOptions)
  },
  "sqlImportOptions": {
    object (SqlImportOptions)
  },
  "tdeImportOptions": {
    object (SqlTdeImportOptions)
  }
}
Felder
uri

string

Pfad zur Importdatei in Cloud Storage im Format gs://bucketName/fileName. Komprimierte gzip-Dateien (.gz) werden unterstützt, wenn fileType SQL ist. Die Instanz muss Schreibberechtigungen für den Bucket und Lesezugriff auf die Datei haben.

database

string

Die Zieldatenbank für den Import. Wenn fileType SQL ist, ist dieses Feld nur erforderlich, wenn in der Importdatei keine Datenbank angegeben ist. Es wird durch jede Datenbankangabe in der Importdatei überschrieben. Bei parallelen Importvorgängen für die gesamte Instanz wird die Datenbank durch den im Unterverzeichnisnamen gespeicherten Datenbanknamen überschrieben. Wenn fileType CSV ist, muss eine Datenbank angegeben werden.

kind

string

Dies ist immer sql#importContext.

fileType

enum (SqlFileType)

Der Dateityp für den angegebenen URI.`SQL: The file contains SQL statements. \CSV`: Die Datei enthält CSV-Daten.

csvImportOptions

object (SqlCsvImportOptions)

Optionen für den Import von Daten als CSV-Datei.

importUser

string

Der PostgreSQL-Nutzer für diesen Importvorgang. Nur PostgreSQL-Instanzen.

bakImportOptions

object (SqlBakImportOptions)

Importparameter für SQL Server-BAK-Dateien

sqlImportOptions

object (SqlImportOptions)

Optional. Optionen zum Importieren von Daten aus SQL-Anweisungen.

tdeImportOptions

object (SqlTdeImportOptions)

Optional. Importparameter für SQL Server-TDE-Zertifikate

SqlCsvImportOptions

JSON-Darstellung
{
  "table": string,
  "columns": [
    string
  ],
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
Felder
table

string

Die Tabelle, in die CSV-Daten importiert werden.

columns[]

string

Die Spalten, in die CSV-Daten importiert werden. Wenn nicht angegeben, werden alle Spalten der Datenbanktabelle mit CSV-Daten geladen.

escapeCharacter

string

Gibt das Zeichen an, das vor einem Datenzeichen stehen muss, das maskiert werden soll.

quoteCharacter

string

Gibt das Anführungszeichen an, das verwendet werden soll, wenn ein Datenwert in Anführungszeichen gesetzt wird.

fieldsTerminatedBy

string

Gibt das Zeichen an, das Spalten in jeder Zeile der Datei trennt.

linesTerminatedBy

string

Damit werden Zeilen getrennt. Wenn eine Zeile nicht alle Felder enthält, werden die restlichen Spalten auf ihre Standardwerte gesetzt.

SqlBakImportOptions

JSON-Darstellung
{
  "encryptionOptions": {
    object (EncryptionOptions)
  },
  "striped": boolean,
  "noRecovery": boolean,
  "recoveryOnly": boolean,
  "bakType": enum (BakType),
  "stopAt": string,
  "stopAtMark": string
}
Felder
encryptionOptions

object (EncryptionOptions)

striped

boolean

Gibt an, ob der wiederherzustellende Sicherungssatz gestripped ist. Gilt nur für Cloud SQL for SQL Server.

noRecovery

boolean

Gibt an, ob beim Importieren der Sicherung die Datenbank mit der Option NORECOVERY wiederhergestellt wird. Gilt nur für Cloud SQL for SQL Server.

recoveryOnly

boolean

Gibt an, ob die Anfrage zum Importieren der Sicherung die Datenbank nur online schaltet, ohne BAK-Inhalte herunterzuladen. Nur einer der Werte „no_recovery“ und „recovery_only“ kann „true“ sein. Andernfalls wird ein Fehler zurückgegeben. Gilt nur für Cloud SQL for SQL Server.

bakType

enum (BakType)

Typ des BAK-Inhalts: FULL oder DIFF

stopAt

string (Timestamp format)

Optional. Der Zeitstempel, zu dem der Import beendet werden soll. Dieser Zeitstempel hat das Format RFC 3339 (z. B. 2023-10-01T16:19:00.094). Dieses Feld entspricht dem STOPAT-Schlüsselwort und gilt nur für Cloud SQL for SQL Server.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

stopAtMark

string

Optional. Die markierte Transaktion, an der der Import beendet werden soll. Dieses Feld entspricht dem Keyword STOPATMARK und gilt nur für Cloud SQL for SQL Server.

EncryptionOptions

JSON-Darstellung
{
  "certPath": string,
  "pvkPath": string,
  "pvkPassword": string,
  "keepEncrypted": boolean
}
Felder
certPath

string

Pfad zum Zertifikat (.cer) in Cloud Storage im Format gs://bucketName/fileName. Die Instanz muss Schreibberechtigungen für den Bucket und Lesezugriff auf die Datei haben.

pvkPath

string

Der Pfad zum privaten Schlüssel des Zertifikats (.pvk) in Cloud Storage im Format gs://bucketName/fileName. Die Instanz muss Schreibberechtigungen für den Bucket und Lesezugriff auf die Datei haben.

pvkPassword

string

Passwort, mit dem der private Schlüssel verschlüsselt wird

keepEncrypted

boolean

Optional. Gibt an, ob die importierte Datei verschlüsselt bleibt.

BoolValue

JSON-Darstellung
{
  "value": boolean
}
Felder
value

boolean

Der boolesche Wert.

SqlImportOptions

JSON-Darstellung
{
  "threads": integer,
  "parallel": boolean,
  "postgresImportOptions": {
    object (PostgresImportOptions)
  }
}
Felder
threads

integer

Optional. Die Anzahl der Threads, die für den parallelen Import verwendet werden sollen.

parallel

boolean

Optional. Gibt an, ob der Import parallel erfolgen soll.

postgresImportOptions

object (PostgresImportOptions)

Optional. Optionen für den Import aus einer Cloud SQL for PostgreSQL-Instanz.

Int32Value

JSON-Darstellung
{
  "value": integer
}
Felder
value

integer

Der int32-Wert.

PostgresImportOptions

JSON-Darstellung
{
  "clean": boolean,
  "ifExists": boolean
}
Felder
clean

boolean

Optional. Das Flag „--clean“ für das Dienstprogramm „pg_restore“. Dieses Flag gilt nur, wenn Sie Cloud SQL für den parallelen Import von Dateien aktiviert haben.

ifExists

boolean

Optional. Das Flag „--if-exists“ für das Dienstprogramm „pg_restore“. Dieses Flag gilt nur, wenn Sie Cloud SQL für den parallelen Import von Dateien aktiviert haben.

SqlTdeImportOptions

JSON-Darstellung
{
  "certificatePath": string,
  "privateKeyPath": string,
  "privateKeyPassword": string,
  "name": string
}
Felder
certificatePath

string

Erforderlich. Pfad zum öffentlichen Schlüssel des TDE-Zertifikats im Format gs://bucketName/fileName. Die Instanz muss Lesezugriff auf die Datei haben. Gilt nur für SQL Server-Instanzen.

privateKeyPath

string

Erforderlich. Pfad zum privaten Schlüssel des TDE-Zertifikats im Format gs://bucketName/fileName. Die Instanz muss Lesezugriff auf die Datei haben. Gilt nur für SQL Server-Instanzen.

privateKeyPassword

string

Erforderlich. Das Passwort, mit dem der private Schlüssel verschlüsselt wird.

name

string

Erforderlich. Name des Zertifikats. Gilt nur für SQL Server-Instanzen.

ExportContext

JSON-Darstellung
{
  "uri": string,
  "databases": [
    string
  ],
  "kind": string,
  "sqlExportOptions": {
    object (SqlExportOptions)
  },
  "csvExportOptions": {
    object (SqlCsvExportOptions)
  },
  "fileType": enum (SqlFileType),
  "offload": boolean,
  "bakExportOptions": {
    object (SqlBakExportOptions)
  },
  "tdeExportOptions": {
    object (SqlTdeExportOptions)
  }
}
Felder
uri

string

Der Pfad zur Datei in Google Cloud Storage, in der der Export gespeichert wird. Der URI hat das Format gs://bucketName/fileName. Wenn die Datei bereits vorhanden ist, ist die Anfrage erfolgreich, der Vorgang schlägt jedoch fehl. Wenn fileType SQL ist und der Dateiname mit „.gz“ endet, wird der Inhalt komprimiert.

databases[]

string

Zu exportierende Datenbanken.
MySQL instances: Wenn fileType SQL ist und keine Datenbank angegeben ist, werden alle Datenbanken mit Ausnahme der mysql-Systemdatenbank exportiert. Wenn fileType CSV ist, können Sie eine Datenbank angeben. Verwenden Sie dazu entweder diese Property oder die Property csvExportOptions.selectQuery, die Vorrang vor dieser Property hat.
PostgreSQL instances: Wenn Sie keine Datenbank nach Namen angeben, werden alle Nutzerdatenbanken in der Instanz exportiert. Ausgenommen sind Systemdatenbanken und Cloud SQL-Datenbanken, die zur Verwaltung interner Vorgänge verwendet werden. Der Export aller Nutzerdatenbanken ist nur für den parallel ausgeführten Export im Verzeichnisformat verfügbar. Wenn fileType CSV ist, muss diese Datenbank mit der in der Property csvExportOptions.selectQuery angegebenen Datenbank übereinstimmen.
SQL Server instances: Sie müssen eine zu exportierende Datenbank angeben und fileType muss BAK sein.

kind

string

Dies ist immer sql#exportContext.

sqlExportOptions

object (SqlExportOptions)

Optionen zum Exportieren von Daten als SQL-Anweisungen.

csvExportOptions

object (SqlCsvExportOptions)

Optionen zum Exportieren von Daten als CSV. Nur MySQL- und PostgreSQL-Instanzen.

fileType

enum (SqlFileType)

Der Dateityp für den angegebenen URI.

offload

boolean

Gibt an, ob ein serverloser Export durchgeführt werden soll.

bakExportOptions

object (SqlBakExportOptions)

Optionen zum Exportieren von Daten als BAK-Dateien

tdeExportOptions

object (SqlTdeExportOptions)

Optional. Exportparameter für SQL Server-TDE-Zertifikate

SqlExportOptions

JSON-Darstellung
{
  "tables": [
    string
  ],
  "schemaOnly": boolean,
  "mysqlExportOptions": {
    object (MysqlExportOptions)
  },
  "threads": integer,
  "parallel": boolean,
  "postgresExportOptions": {
    object (PostgresExportOptions)
  }
}
Felder
tables[]

string

Tabellen, die aus der angegebenen Datenbank exportiert werden sollen oder wurden. Wenn Sie Tabellen angeben, geben Sie nur eine Datenbank an. Bei PostgreSQL-Instanzen können Sie nur eine Tabelle angeben.

schemaOnly

boolean

Nur Schemas exportieren.

mysqlExportOptions

object (MysqlExportOptions)

threads

integer

Optional. Die Anzahl der Threads, die für den parallelen Export verwendet werden sollen.

parallel

boolean

Optional. Gibt an, ob der Export parallel erfolgen soll.

postgresExportOptions

object (PostgresExportOptions)

Optional. Optionen für den Export aus einer Cloud SQL for PostgreSQL-Instanz.

MysqlExportOptions

JSON-Darstellung
{
  "masterData": integer
}
Felder
masterData

integer

Option zum Einbeziehen der SQL-Anweisung, die zum Einrichten der Replikation erforderlich ist. Wenn 1 festgelegt ist, enthält die Dumpdatei eine CHANGE MASTER TO-Anweisung mit den Koordinaten des binären Logs und --set-gtid-purged ist auf ON gesetzt. Wenn dieser Wert auf 2 gesetzt ist, wird die CHANGE MASTER TO-Anweisung als SQL-Kommentar geschrieben und hat keine Auswirkungen. Wenn ein anderer Wert als 1 festgelegt ist, wird „--set-gtid-purged“ auf OFF gesetzt.

PostgresExportOptions

JSON-Darstellung
{
  "clean": boolean,
  "ifExists": boolean
}
Felder
clean

boolean

Optional. Mit dieser Option können Sie DROP einfügen.

<object>

SQL-Anweisungen. Mit diesen Anweisungen können Sie Datenbankobjekte löschen, bevor Sie den Importvorgang ausführen.

ifExists

boolean

Optional. Option zum Einfügen einer IF EXISTS-SQL-Anweisung in jede DROP-Anweisung, die von „clean“ generiert wird.

SqlCsvExportOptions

JSON-Darstellung
{
  "selectQuery": string,
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
Felder
selectQuery

string

Die SELECT-Abfrage, mit der die Daten extrahiert werden.

escapeCharacter

string

Gibt das Zeichen an, das vor einem Datenzeichen stehen muss, das maskiert werden soll.

quoteCharacter

string

Gibt das Anführungszeichen an, das verwendet werden soll, wenn ein Datenwert in Anführungszeichen gesetzt wird.

fieldsTerminatedBy

string

Gibt das Zeichen an, das Spalten in jeder Zeile der Datei trennt.

linesTerminatedBy

string

Damit werden Zeilen getrennt. Wenn eine Zeile nicht alle Felder enthält, werden die restlichen Spalten auf ihre Standardwerte gesetzt.

SqlBakExportOptions

JSON-Darstellung
{
  "striped": boolean,
  "stripeCount": integer,
  "bakType": enum (BakType),
  "copyOnly": boolean,
  "differentialBase": boolean,
  "exportLogStartTime": string,
  "exportLogEndTime": string
}
Felder
striped

boolean

Gibt an, ob der Export gestreift werden soll.

stripeCount

integer

Option zum Angeben der Anzahl der Stripes für den Export. Wenn das Feld leer ist und der Wert des gestreiften Felds „true“ ist, wird die Anzahl der Streifen automatisch ausgewählt.

bakType

enum (BakType)

Typ dieser BAK-Datei: EXPORT, FULL oder DIFF (nur SQL Server)

copyOnly
(deprecated)

boolean

Verworfen: copy_only wird nicht mehr unterstützt. Stattdessen „differential_base“ verwenden

differentialBase

boolean

Gibt an, ob das Backup als differenzielle Basis verwendet werden kann. „copy_only“-Backups können nicht als differenzielle Basis verwendet werden.

exportLogStartTime

string (Timestamp format)

Optional. Der Zeitstempel für den Beginn des Zeitraums, für den Transaktionsprotokolle in den Exportvorgang einbezogen werden. RFC 3339-Format (z. B. 2023-10-01T16:19:00.094) in UTC. Wenn diese Option nicht angegeben wird, werden alle verfügbaren Logs ab Beginn des Aufbewahrungszeitraums berücksichtigt. Wird nur auf Cloud SQL for SQL Server angewendet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

exportLogEndTime

string (Timestamp format)

Optional. Der End-Zeitstempel, bis zu dem das Transaktionslog in den Exportvorgang einbezogen wird. RFC 3339-Format (z. B. 2023-10-01T16:19:00.094) in UTC. Wenn dieser Parameter weggelassen wird, werden alle verfügbaren Logs bis zum aktuellen Zeitpunkt berücksichtigt. Wird nur auf Cloud SQL for SQL Server angewendet.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

SqlTdeExportOptions

JSON-Darstellung
{
  "certificatePath": string,
  "privateKeyPath": string,
  "privateKeyPassword": string,
  "name": string
}
Felder
certificatePath

string

Erforderlich. Pfad zum öffentlichen Schlüssel des TDE-Zertifikats im Format gs://bucketName/fileName. Die Instanz muss Schreibzugriff auf den Bucket haben. Gilt nur für SQL Server-Instanzen.

privateKeyPath

string

Erforderlich. Pfad zum privaten Schlüssel des TDE-Zertifikats im Format gs://bucketName/fileName. Die Instanz muss Schreibzugriff auf den Speicherort haben. Gilt nur für SQL Server-Instanzen.

privateKeyPassword

string

Erforderlich. Das Passwort, mit dem der private Schlüssel verschlüsselt wird.

name

string

Erforderlich. Name des Zertifikats. Gilt nur für SQL Server-Instanzen.

BackupContext

JSON-Darstellung
{
  "backupId": string,
  "kind": string,
  "name": string
}
Felder
backupId

string (int64 format)

Die Kennung der Sicherung.

kind

string

Dies ist immer sql#backupContext.

name

string

Der Name der Sicherung. Format: projects/{project}/backups/{backup}

PreCheckMajorVersionUpgradeContext

JSON-Darstellung
{
  "targetDatabaseVersion": enum (SqlDatabaseVersion),
  "preCheckResponse": [
    {
      object (PreCheckResponse)
    }
  ],
  "kind": string
}
Felder
targetDatabaseVersion

enum (SqlDatabaseVersion)

Erforderlich. Die Zieldatenbankversion für das Upgrade.

preCheckResponse[]

object (PreCheckResponse)

Nur Ausgabe. Die Antworten des Vorabprüfvorgangs.

kind

string

Optional. Dies ist immer sql#preCheckMajorVersionUpgradeContext.

PreCheckResponse

JSON-Darstellung
{
  "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.
}
Felder
actionsRequired[]

string

Die Aktionen, die der Nutzer ausführen muss. Verwenden Sie „Wiederholen“ für mehrere Aktionen.

Union-Feld _message.

Für _message ist nur einer der folgenden Werte zulässig:

message

string

Die Nachricht, die dem Nutzer angezeigt werden soll.

Union-Feld _message_type.

Für _message_type ist nur einer der folgenden Werte zulässig:

messageType

enum (MessageType)

Der Typ der Meldung, also ob es sich um eine Information, eine Warnung oder einen Fehler handelt.

AcquireSsrsLeaseContext

JSON-Darstellung
{

  // 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.
}
Felder

Union-Feld _setup_login.

Für _setup_login ist nur einer der folgenden Werte zulässig:

setupLogin

string

Der Nutzername, der als Einrichtungsanmeldung für die Verbindung zum Datenbankserver für die SSRS-Einrichtung verwendet werden soll.

Union-Feld _service_login.

Für _service_login ist nur einer der folgenden Werte zulässig:

serviceLogin

string

Der Nutzername, der als Dienstanmeldung für die Verbindung zur Berichtsdatenbank für die SSRS-Einrichtung verwendet werden soll.

Union-Feld _report_database.

Für _report_database ist nur einer der folgenden Werte zulässig:

reportDatabase

string

Die Berichtsdatenbank, die für die SSRS-Einrichtung verwendet werden soll.

Union-Feld _duration.

Für _duration ist nur einer der folgenden Werte zulässig:

duration

string (Duration format)

Die für die SSRS-Einrichtung erforderliche Leasedauer.

Die Dauer in Sekunden mit bis zu neun Nachkommastellen und am Ende mit „s“. Beispiel: "3.5s".

Dauer

JSON-Darstellung
{
  "seconds": string,
  "nanos": integer
}
Felder
seconds

string (int64 format)

Signierte Sekunden des Zeitraums. Muss zwischen -315.576.000.000 und +315.576.000.000 (einschließlich) liegen. Hinweis: Diese Grenzen werden so berechnet: 60 Sek./Min. × 60 Min./Std. × 24 Std./Tag × 365,25 Tage/Jahr × 10.000 Jahre

nanos

integer

Signierte Sekundenbruchteile mit Nanosekunden-Auflösung für den Zeitraum. Dauern von weniger als einer Sekunde werden mit dem Feld „0“ seconds und einem positiven oder negativen Feld nanos dargestellt. Bei Zeiträumen von einer Sekunde oder mehr muss ein Wert ungleich null für das Feld nanos dasselbe Vorzeichen wie das Feld seconds haben. Muss zwischen -999.999.999 und +999.999.999 liegen (einschließlich).

SqlSubOperationType

JSON-Darstellung
{

  // 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.
}
Felder
Union-Feld sub_operation_details. Details zum untergeordneten Vorgang, die dem Vorgangstyp entsprechen. Für sub_operation_details ist nur einer der folgenden Werte zulässig:
maintenanceType

enum (SqlMaintenanceType)

Die Art der Wartung, die für die Instanz durchgeführt werden soll.

Tool-Annotationen

Destruktiver Hinweis: ❌ | Idempotenter Hinweis: ❌ | Hinweis „Nur lesen“: ❌ | Hinweis „Offene Welt“: ❌