MCP Tools Reference: cloud-sql

ツール: create_instance

Cloud SQL インスタンスの作成を開始します。

  • ツールは長時間実行オペレーションを返します。get_operation ツールを使用して、オペレーションが完了するまでステータスをポーリングします。
  • インスタンスの作成オペレーションには数分かかることがあります。コマンドライン ツールを使用して 30 秒間一時停止してから、ステータスを再確認します。
  • create_instance ツールを使用してインスタンスを作成したら、create_user ツールを使用して、現在プロジェクトにログインしているユーザーの IAM ユーザー アカウントを作成できます。
  • data_api_access の値はデフォルトでは ALLOW_DATA_API に設定されています。この設定では、execute_sql ツールと executeSql API を使用して SQL ステートメントを実行できます。

特に指定しない限り、新しく作成されたインスタンスは開発環境のデフォルトのインスタンス構成を使用します。

開発環境のインスタンスのデフォルト構成は次のとおりです。

{
          "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"}]
        }
        

本番環境のインスタンスには、次の構成をおすすめします。

{
          "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"}]
        }
        

SQL Server には次のインスタンス構成が推奨されます。

{
          "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"}]
        }
        

次のサンプルは、curl を使用して create_instance MCP ツールを呼び出す方法を示しています。

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

入力スキーマ

MCP のインスタンス挿入リクエスト。

SqlInstancesInsertMcpRequest

JSON 表現
{
  "project": string,
  "name": string,
  "databaseVersion": string,
  "region": string,
  "edition": string,
  "tier": string,
  "dataDiskSizeGb": string,
  "availabilityType": string,
  "tags": {
    string: string,
    ...
  },
  "dataCacheEnabled": boolean,
  "enableGoogleMlIntegration": boolean
}
フィールド
project

string

必須。新たに作成された Cloud SQL インスタンスが属するプロジェクトのプロジェクト ID。

name

string

必須。Cloud SQL インスタンスの名前。プロジェクト ID は含みません。

databaseVersion

string

省略可。データベース エンジンの種類とバージョン。デフォルト値は POSTGRES_18 です。

MySQL の場合は MYSQL_8_4MYSQL_8_0MYSQL_5_7 など、Postgres の場合は POSTGRES_18POSTGRES_17POSTGRES_16 など、SQL Server の場合は SQLSERVER_2022_STANDARD、SQLSERVER_2022_EXPRESS、SQLSERVER_2022_ENTERPRISE などになります。

region

string

省略可。Cloud SQL インスタンスの地理的リージョン。たとえば、us-central1europe-west1asia-east1 です。

指定しない場合、デフォルト値は us-central1 です。

edition

string

省略可。インスタンスのエディション。ENTERPRISE または ENTERPRISE_PLUS を指定できます。指定しない場合: - Postgres と Mysql の場合、デフォルト値は ENTERPRISE_PLUS です。- SQL Server の場合、デフォルト値は ENTERPRISE です。

tier

string

省略可。このインスタンスの階層(またはマシンタイプ)。

指定しない場合: - ENTERPRISE_PLUS エディションの場合、デフォルトの階層は db-perf-optimized-N-2 で、2 個の vCPU と 16 GB の RAM が提供されます。- ENTERPRISE エディションの場合、デフォルトの階層は db-custom-2-3840 で、2 個の vCPU と 3.75 GB の RAM が提供されます。

ENTERPRISE_PLUS エディションでは、N2 マシンシリーズを使用する必要があります。ENTERPRISE エディションでは、カスタム マシンタイプ名に db-custom-{CPUs}-{Memory} という形式を使用できます。

dataDiskSizeGb

string (Int64Value format)

省略可。データディスクのサイズ(GB)。デフォルト値は 100 です。

availabilityType

string

省略可。可用性タイプ。可能な値: * ZONAL: インスタンスは 1 つのゾーンからのみデータを提供します。そのゾーンが停止するとデータにアクセスできなくなる可能性があります。これはデフォルト値です。* REGIONAL: インスタンスはリージョン内の複数のゾーンからデータを提供できます(可用性が高い)。

tags

map (key: string, value: string)

省略可。入力専用。このインスタンスにバインドされているタグキーとタグ値。マップ内の各アイテムは "<tag-key-namespaced-name>" : "<tag-value-short-name>" として表す必要があります。

たとえば、単一のリソースに次のタグを設定できます。

  "environment": "prod",

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }

dataCacheEnabled

boolean

省略可。インスタンスでデータ キャッシュが有効になっているかどうか。

enableGoogleMlIntegration

boolean

省略可。このパラメータを true に設定すると、Cloud SQL インスタンスを Vertex AI に接続して、リアルタイム予測と分析情報のリクエストを AI に渡すことができます。デフォルト値は false です。これは、Cloud SQL for MySQL インスタンスと Cloud SQL for PostgreSQL インスタンスにのみ適用されます。

Int64Value

JSON 表現
{
  "value": string
}
フィールド
value

string (int64 format)

int64 値。

TagsEntry

JSON 表現
{
  "key": string,
  "value": string
}
フィールド
key

string

value

string

BoolValue

JSON 表現
{
  "value": boolean
}
フィールド
value

boolean

ブール値。

出力スキーマ

オペレーション リソース。オペレーション リソースを返すオペレーションを成功させるため、オペレーションに関連するフィールドのみがリソースに入力されます。

オペレーション

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)

このオペレーションをキューに格納した時刻を、RFC 3339 形式の UTC タイムゾーンで表します。例: 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)

このオペレーションが実際に開始された時刻を、RFC 3339 形式の UTC タイムゾーンで表します。例: 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)

このオペレーションが完了した時刻を、RFC 3339 形式の UTC タイムゾーンで表します。例: 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)

オペレーションの種類。有効な値は、CREATEDELETEUPDATERESTARTIMPORTEXPORTBACKUP_VOLUMERESTORE_VOLUMECREATE_USERDELETE_USERCREATE_DATABASEDELETE_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

このオペレーションに関連するターゲット インスタンスのプロジェクト ID。

acquireSsrsLeaseContext

object (AcquireSsrsLeaseContext)

SSRS リース取得オペレーションのコンテキスト(該当する場合)。

subOperationType

object (SqlSubOperationType)

省略可。オペレーション タイプに基づくサブオペレーション。

タイムスタンプ

JSON 表現
{
  "seconds": string,
  "nanos": integer
}
フィールド
seconds

string (int64 format)

UNIX エポック 1970-01-01T00:00:00Z からの UTC 時刻の秒数を表します。-62135596800~253402300799 の範囲(両端を含む)にする必要があります(これは 0001-01-01T00:00:00Z~9999-12-31T23:59:59Z に対応します)。

nanos

integer

ナノ秒分解能による、秒の負ではない小数以下部分。このフィールドは、秒の代替ではなく、期間のナノ秒部分です。小数以下を含む負の秒の値は、時間を前方にカウントする負ではない nanos 値を持つ必要があります。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)は、fileTypeSQL の場合にサポートされます。インスタンスには、バケットへの書き込み権限とファイルの読み取り権限が必要です。

database

string

インポートのターゲット データベース。fileTypeSQL の場合、このフィールドは、インポート ファイルでデータベースが指定されておらず、インポート ファイルのデータベース指定によってオーバーライドされる場合にのみ必要です。インスタンス全体の並列インポート オペレーションの場合、データベースはサブディレクトリ名に保存されているデータベース名でオーバーライドされます。fileTypeCSV の場合は、1 つのデータベースを指定する必要があります。

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)

SQL Server .BAK ファイル固有のインポート パラメータ

sqlImportOptions

object (SqlImportOptions)

省略可。SQL ステートメントからデータをインポートするためのオプション。

tdeImportOptions

object (SqlTdeImportOptions)

省略可。SQL Server TDE 証明書固有のインポート パラメータ

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

復元するバックアップ セットがストライプ化されているかどうか。Cloud SQL for SQL Server にのみ適用されます。

noRecovery

boolean

バックアップのインポートで NORECOVERY オプションを使用してデータベースを復元するかどうか。Cloud SQL for SQL Server にのみ適用されます。

recoveryOnly

boolean

バックアップ インポート リクエストで Bak コンテンツをダウンロードせずにデータベースをオンラインにするかどうか。no_recovery と recovery_only のいずれか 1 つのみを true にできます。それ以外の場合はエラーが返されます。Cloud SQL for SQL Server にのみ適用されます。

bakType

enum (BakType)

bak コンテンツのタイプ(FULL または DIFF)

stopAt

string (Timestamp format)

省略可。インポートを停止するタイムスタンプ。このタイムスタンプは RFC 3339 形式(例: 2023-10-01T16:19:00.094)です。このフィールドは STOPAT キーワードと同等で、Cloud SQL for 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 for SQL Server にのみ適用されます。

EncryptionOptions

JSON 表現
{
  "certPath": string,
  "pvkPath": string,
  "pvkPassword": string,
  "keepEncrypted": boolean
}
フィールド
certPath

string

Cloud Storage 内の証明書(.cer)へのパス(gs://bucketName/fileName の形式で指定)。インスタンスには、バケットへの書き込み権限とファイルの読み取り権限が必要です。

pvkPath

string

Cloud Storage の証明書秘密鍵(.pvk)のパス(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 for PostgreSQL インスタンスからインポートするためのオプション。

Int32Value

JSON 表現
{
  "value": integer
}
フィールド
value

integer

int32 値。

PostgresImportOptions

JSON 表現
{
  "clean": boolean,
  "ifExists": boolean
}
フィールド
clean

boolean

省略可。pg_restore ユーティリティの --clean フラグ。このフラグは、Cloud SQL でファイルの並列インポートを有効にした場合にのみ適用されます。

ifExists

boolean

省略可。pg_restore ユーティリティの --if-exists フラグ。このフラグは、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 です。ファイルがすでに存在する場合、リクエストは成功しますが、オペレーションは失敗します。fileTypeSQL で、ファイル名の末尾が .gz の場合、コンテンツは圧縮されます。

databases[]

string

エクスポートされるデータベース。
MySQL instances: fileTypeSQL で、データベースが指定されていない場合、mysql システム データベースを除くすべてのデータベースがエクスポートされます。fileTypeCSV の場合、このプロパティを使用するか、csvExportOptions.selectQuery プロパティ(このプロパティより優先)を使用して 1 つのデータベースを指定できます。
PostgreSQL instances: データベースを名前で指定しない場合、インスタンス内のすべてのユーザー データベースがエクスポートされます。これには、内部オペレーションの管理に使用されるシステム データベースと Cloud SQL データベースは含まれません。すべてのユーザー データベースのエクスポートは、ディレクトリ形式の並列エクスポートでのみ使用できます。fileTypeCSV の場合、このデータベースは csvExportOptions.selectQuery プロパティで指定されたデータベースと一致する必要があります。
SQL Server instances: エクスポートするデータベースを 1 つ指定する必要があります。また、fileTypeBAK である必要があります。

kind

string

これは常に sql#exportContext です。

sqlExportOptions

object (SqlExportOptions)

データを SQL 文としてエクスポートするためのオプション。

csvExportOptions

object (SqlCsvExportOptions)

データを CSV としてエクスポートするためのオプション。MySQL インスタンスと PostgreSQL インスタンスのみ。

fileType

enum (SqlFileType)

指定した URI のファイルタイプ。

offload

boolean

サーバーレス エクスポートを実行するかどうか。

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

指定したデータベースからエクスポートするテーブルまたはエクスポートされたテーブル。テーブルを指定する場合は、データベースを 1 つだけ指定します。PostgreSQL インスタンスの場合、指定できるテーブルは 1 つのみです。

schemaOnly

boolean

スキーマのみをエクスポートします。

mysqlExportOptions

object (MysqlExportOptions)

threads

integer

省略可。並列エクスポートに使用するスレッドの数。

parallel

boolean

省略可。エクスポートを並行して行うかどうか。

postgresExportOptions

object (PostgresExportOptions)

省略可。Cloud SQL for PostgreSQL インスタンスからのエクスポート オプション。

MysqlExportOptions

JSON 表現
{
  "masterData": integer
}
フィールド
masterData

integer

レプリケーションの設定に必要な SQL ステートメントを含めるオプション。1 に設定すると、ダンプファイルにバイナリログ座標を含む 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

省略可。クリーンアップによって生成される各 DROP ステートメントに IF EXISTS SQL ステートメントを含めるオプション。

SqlCsvExportOptions

JSON 表現
{
  "selectQuery": string,
  "escapeCharacter": string,
  "quoteCharacter": string,
  "fieldsTerminatedBy": string,
  "linesTerminatedBy": string
}
フィールド
selectQuery

string

データを抽出するために使用する select クエリ。

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

バックアップを差分ベースとして使用できるかどうか。copy_only バックアップは差分ベースとして使用できません

exportLogStartTime

string (Timestamp format)

省略可。トランザクション ログがエクスポート オペレーションに含まれる開始タイムスタンプ。UTC の RFC 3339 形式(例: 2023-10-01T16:19:00.094)。省略すると、保持期間の開始時点から利用可能なすべてのログが含まれます。Cloud SQL for 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)

省略可。トランザクション ログがエクスポート オペレーションに含まれる終了タイムスタンプ。UTC の RFC 3339 形式(例: 2023-10-01T16:19:00.094)。省略すると、現在までのすべての利用可能なログが含まれます。Cloud SQL for 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

ユーザーが対応する必要があるアクション。複数のアクションに repeated を使用します。

共用体フィールド _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 で終わる小数 9 桁までの秒単位の期間。例: "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

期間のナノ秒分解能による、秒の符号付き小数以下部分。1 秒未満の期間は、0 の seconds フィールドと正または負の nanos フィールドで表されます。1 秒以上の期間の場合、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)

インスタンスで実行するメンテナンスのタイプ。

ツールのアノテーション

破壊的ヒント: ❌ | べき等ヒント: ❌ | 読み取り専用ヒント: ❌ | オープン ワールド ヒント: ❌