Google は AI 技術を使用して、コンテンツをご希望の言語に翻訳しています。AI 翻訳には誤りが含まれる場合があります。

Cloud SQL Data API を使用して SQL ステートメントを実行する

MySQL | PostgreSQL | SQL Server

このページでは、Data API を使用して Cloud SQL インスタンスのデータベースに対して SQL ステートメントを実行する方法について説明します。Data API を使用すると、Cloud SQL Admin API と gcloud CLI を使用して、Data API アクセスを有効にしたインスタンスで SQL ステートメントを実行できます。

パブリック IP アドレス、プライベートサービスアクセス、または Private Service Connect を使用するインスタンスで Data API を使用できます。Data API は、データ操作言語（DML）、データ定義言語（DDL）、データクエリ言語（DQL）など、すべてのタイプの SQL ステートメントをサポートしています。Data API は、データベースのロールやユーザーの作成、スキーマの小規模な更新など、小規模で迅速な管理ステートメントの実行に適しています。

始める前に

インスタンスで SQL ステートメントを実行する前に、次の手順を行います。

データベースユーザーを構成する

Data API は、SQL ステートメントを実行するためにデータベースユーザーとして認証する必要があります。

パスワードを使用して組み込みユーザーとして認証するには、次の操作を行います。

空でないパスワードを使用してユーザーアカウントを作成します。デフォルトユーザー sqlserver を使用することもできます。
SQL ステートメントを実行するために必要なロールまたは権限をアカウントに付与します。ユーザーが sqlserver でない場合は、ユーザーに db_owner ロールを付与します。
Secret Manager を使用して、パスワードを保存するリージョンシークレットを作成します。セキュリティのため、Data API は API リクエストでパスワードではなくシークレットのリソース名を要求します。リージョンシークレットは、Cloud SQL インスタンスと同じリージョンに保存する必要があります。Secret Manager のグローバルエンドポイントを使用して作成されたシークレットは、同じリージョンに保存されていても対象外です。
Data API の呼び出し元に roles/secretmanager.secretAccessor を付与します。ベストプラクティスとして、ユーザーが特定のシークレットにアクセスできるが、プロジェクト内の他のシークレットにはアクセスできないように IAM 条件を定義します。

必要なロールまたは権限

Data API の呼び出しに使用されるユーザーアカウントまたはサービスアカウントには、SQL ステートメントを実行する権限（cloudsql.instances.executesql）が必要です。この権限は、次のいずれかの事前定義ロールに含まれています。

Cloud SQL Admin（roles/cloudsql.admin）
Cloud SQL Instance User（roles/cloudsql.instanceUser）
Cloud SQL Studio User（roles/cloudsql.studioUser）

また、cloudsql.instances.executesql 権限を持つユーザーまたはサービスアカウントの IAM カスタムロールを定義することもできます。この権限は、IAM カスタムロールでサポートされています。

Secret Manager シークレットを使用して認証を行う場合、ユーザーまたはサービスアカウントにはシークレットにアクセスする権限（secretmanager.versions.access）も必要です。この権限は、次のいずれかの事前定義ロールに含まれています。

Secret Manager Secret Accessor（roles/secretmanager.secretAccessor）
Secret Manager Admin（roles/secretmanager.admin）

Data API を有効または無効にする

Data API を使用するには、インスタンスごとに有効にする必要があります。Data API はいつでも無効にできます。

コンソール

Google Cloud コンソールで、Cloud SQL の [インスタンス] ページに移動します。

Cloud SQL の [インスタンス] に移動
インスタンスの [概要] ページを開くには、インスタンス名をクリックします。
SQL ナビゲーションメニューから [接続] を選択します。
[ネットワーキング] タブをクリックします。
[Allow Data API] チェックボックスをオンにします。
[保存] をクリックします。

gcloud

インスタンスで Data API アクセスを有効にするには、--data-api-access=ALLOW_DATA_API フラグを指定して gcloud sql instances patch コマンドを使用します。

gcloud sql instances patch INSTANCE_NAME --data-api-access=ALLOW_DATA_API

Data API アクセスを無効にするには、--data-api-access=DISALLOW_DATA_API フラグを使用します。

gcloud sql instances patch INSTANCE_NAME --data-api-access=DISALLOW_DATA_API

INSTANCE_NAME は、Data API を有効または無効にするインスタンスの名前に置き換えます。

REST

インスタンスで Data API アクセスを有効にするには、instances.patch エンドポイントに PATCH リクエストを送信します。

PATCH https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME

リクエストの本文には、ALLOW_DATA_API に設定された dataApiAccess フィールドが含まれている必要があります。

{
  "dataApiAccess": "ALLOW_DATA_API"
}

Data API アクセスを無効にするには、dataApiAccess を DISALLOW_DATA_API に設定します。

SQL ステートメントを実行する

gcloud CLI または REST API を使用して、Cloud SQL インスタンスのデータベースに対して SQL ステートメントを実行できます。

パスワードを使用して認証する

パスワードが Cloud SQL インスタンスと同じリージョンで Secret Manager のリージョンシークレットとして保存されている場合、組み込みのパスワード認証を使用して SQL ステートメントを実行できます。

gcloud

gcloud CLI を使用してインスタンスのデータベースに対して SQL ステートメントを実行するには、gcloud sql instances execute-sql コマンドを使用します。

gcloud sql instances execute-sql INSTANCE_NAME \
--database=DATABASE_NAME \
--sql=SQL_STATEMENT \
--user=USER \
--password-secret-version=PASSWORD_SECRET_VERSION \
--partial-result-mode=PARTIAL_RESULT_MODE

次のように置き換えます。

INSTANCE_NAME: インスタンスの名前。
DATABASE_NAME: インスタンス内のデータベースの名前。
SQL_STATEMENT: 実行する SQL ステートメント。ステートメントにスペースまたはシェル特殊文字が含まれている場合は、引用符で囲む必要があります。
USER: 認証するデータベースユーザー。
PASSWORD_SECRET_VERSION: データベースユーザーのパスワードを保持する Secret Manager シークレットのリソース名。シークレットはリージョンシークレットであり、Cloud SQL インスタンスと同じリージョンに保存する必要があります。リソース名の形式は projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version} です。
PARTIAL_RESULT_MODE: 省略可。結果が不完全な場合の対応方法を制御します。ALLOW_PARTIAL_RESULT、FAIL_PARTIAL_RESULT、PARTIAL_RESULT_MODE_UNSPECIFIED のいずれかです。切り捨て動作の変更をご覧ください。

Terraform

Terraform で Data API を使用すると、インスタンスに手動で接続しなくても、データベース、テーブル、拡張機能、ユーザー、権限付与などのデータベース内リソースをプロビジョニングできます。Terraform で SQL スクリプトを実行するには、 google_sql_provision_script Terraform リソースを使用します。

resource "google_sql_user" "built_in_user" {
  name     = "tf-user"
  host     = "%"  # Don't set this field for PostgreSQL and SQL Server.
  instance = google_sql_database_instance.instance.name
  password = "changeme"
  type     = "BUILT_IN"
}

# Create a regional secret. Global secrets are not supported even if
# located in one region only.
resource "google_secret_manager_regional_secret" "secret" {
  secret_id = "db-password"

  # Use the same region as the Cloud SQL instance.
  location = "us-central1"
}

resource "google_secret_manager_regional_secret_version" "secret_version" {
  secret = google_secret_manager_regional_secret.secret.id
  secret_data = "changeme"
}

resource "google_sql_provision_script" "script" {
  # You can inline the script or import from a file like script  = file("${path.module}/script.sql")
  # When modified, the whole script will be executed again. It's recommended to
  # make the script idempotent with patterns like create if not exists ... or
  # if not exists (select ...) then ... end if.
  script  = "CREATE TABLE IF NOT EXISTS table1 ( col VARCHAR(16) NOT NULL );"

  instance = google_sql_database_instance.instance.name
  database = google_sql_database.database.name
  description = "sql script to create tables"
  user = google_sql_user.built_in_user.name

  # The location should be the same as the Cloud SQL instance's location.
  password_secret_version = "projects/my-project/locations/us-central1/secrets/db-password/versions/latest"

  # The built-in database user and password secret version must be created
  # first. Cloud SQL will retrieve password from Secret Manager
  # and connect to this user account to execute your script.
  depends_on = [
    google_sql_user.built_in_user,
    google_secret_manager_regional_secret_version.secret_version
  ]
}

変更を適用する

Google Cloud プロジェクトで Terraform 構成を適用するには、次のセクションの手順を完了します。

Cloud Shell を準備する

Cloud Shell を起動します。
Terraform 構成を適用するデフォルトの Google Cloud プロジェクトを設定します。

このコマンドは、プロジェクトごとに 1 回だけ実行する必要があります。これは任意のディレクトリで実行できます。
```
export GOOGLE_CLOUD_PROJECT=PROJECT_ID
```
Terraform 構成ファイルに明示的な値を設定すると、環境変数がオーバーライドされます。

ディレクトリを準備する

Terraform 構成ファイルには独自のディレクトリ（ルートモジュールとも呼ばれます）が必要です。

Cloud Shell で、ディレクトリを作成し、そのディレクトリ内に新しいファイルを作成します。ファイル名の拡張子は .tf にする必要があります（例: main.tf）。このチュートリアルでは、このファイルを main.tf とします。
```
mkdir DIRECTORY && cd DIRECTORY && touch main.tf
```
チュートリアルを使用している場合は、各セクションまたはステップのサンプルコードをコピーできます。

新しく作成した main.tf にサンプルコードをコピーします。

必要に応じて、GitHub からコードをコピーします。Terraform スニペットがエンドツーエンドのソリューションの一部である場合は、この方法をおすすめします。
環境に適用するサンプルパラメータを確認し、変更します。
変更を保存します。
Terraform を初期化します。これは、ディレクトリごとに 1 回だけ行います。
```
terraform init
```
最新バージョンの Google プロバイダを使用する場合は、-upgrade オプションを使用します。
```
terraform init -upgrade
```

変更を適用する

構成を確認して、Terraform が作成または更新するリソースが想定どおりであることを確認します。
```
terraform plan
```
必要に応じて構成を修正します。
次のコマンドを実行します。プロンプトで「yes」と入力して、Terraform 構成を適用します。
```
terraform apply
```
Terraform に「Apply complete!」というメッセージが表示されるまで待ちます。
Google Cloud プロジェクトを開いて結果を表示します。 Google Cloud コンソールの UI でリソースに移動して、Terraform によって作成または更新されたことを確認します。

変更を削除する

google_sql_provision_script リソースを削除しても、作成されたデータベース内リソースは削除されません。削除するには、drop ... if exists などのステートメントをスクリプトに明示的に追加し、変更を適用します。

REST

REST API を使用してインスタンスのデータベースに対して SQL ステートメントを実行するには、executeSql エンドポイントに POST リクエストを送信します。

POST https://sqladmin.googleapis.com/sql/v1beta4/projects/PROJECT_ID/instances/INSTANCE_NAME/executeSql

リクエストの本文には、データベース名と SQL ステートメントを含める必要があります。

{
  "database": "DATABASE_NAME",
  "sqlStatement": "SQL_STATEMENT",
  "user": "USER",
  "passwordSecretVersion": "PASSWORD_SECRET_VERSION",
  "partialResultMode": "PARTIAL_RESULT_MODE"
}

次のように置き換えます。

PROJECT_ID: プロジェクト ID。
INSTANCE_NAME: インスタンスの名前。
DATABASE_NAME: インスタンス内のデータベースの名前。
SQL_STATEMENT: 実行する SQL ステートメント。
USER: 認証するデータベースユーザー。
PASSWORD_SECRET_VERSION: データベースユーザーのパスワードを保持する Secret Manager シークレットのリソース名。シークレットはリージョンシークレットであり、Cloud SQL インスタンスと同じリージョンに保存する必要があります。リソース名の形式は projects/{project}/locations/{location}/secrets/{secret}/versions/{secret_version} です。
PARTIAL_RESULT_MODE: 省略可。結果が 10 MB を超えた場合に API がどのように応答するかを制御します。FAIL_PARTIAL_RESULT、ALLOW_PARTIAL_RESULT、PARTIAL_RESULT_MODE_UNSPECIFIED のいずれかです。切り捨て動作の変更をご覧ください。

切り捨ての動作を変更する

SQL の実行時に大きな結果を処理する方法を制御するには、リクエストに "partialResultMode" フィールドを含めます。このフィールドでは次の値を指定できます。

FAIL_PARTIAL_RESULT: デフォルト。結果が 10 MB を超える場合、または結果の一部しか取得できない場合は、エラーをスローします。結果を返さないでください。
ALLOW_PARTIAL_RESULT: 結果が 10 MB を超える場合、またはエラーにより部分的な結果しか取得できない場合は、切り捨てられた結果を返し、partial_result を true に設定します。エラーをスローしない。
PARTIAL_RESULT_MODE_UNSPECIFIED: 未指定モード。事実上 FAIL_PARTIAL_RESULT と同じです。

監査クエリ

リクエストで applicationName フィールドを設定すると、アプリケーション名を追跡できます。データベースは、セッション統計情報（たとえば、テーブル sys.dm_exec_sessions）でアプリケーション名を追跡します。

Query Insights を使用すると、クエリに関する詳細情報を追跡し、パフォーマンスの問題を分析できます。

SQL Server データベース監査を使用して、セキュリティまたはコンプライアンスの目的でクエリをログに記録することもできます。

制限事項

レスポンスのサイズの上限は 10 MB です。partialResultMode が ALLOW_PARTIAL_RESULT に設定されている場合、このサイズを超える結果は切り捨てられます。それ以外の場合は、エラーがスローされます。
リクエストは 0.5 MB に制限されています。
SQL ステートメントは、実行中の Cloud SQL for SQL Server インスタンスに対してのみ実行できます。
Cloud SQL は、外部サーバーレプリケーション用に設定されたインスタンスでの Data API の使用をサポートしていません。
30 秒を超えるリクエストはキャンセルされます。SET LOCK_TIMEOUT を使用してステートメントタイムアウトを長く設定することはできません。
Cloud SQL は、過負荷を防ぐために、インスタンスあたりの同時 executeSql リクエストの数を制限します。上限に達すると、後続のリクエストは失敗し、次のいずれかのエラーが返されます。
- At most 'x' concurrent queries may be run on this instance. Try again later.
- Maximum concurrent reads 'x' reached.
上限（x）は、合計メモリが 10 GB 未満のインスタンスの場合は 5 クエリ、合計メモリが 10 GB 以上のインスタンスの場合は 10 クエリです。
各レスポンスには、最大 10 個のデータベースメッセージまたは警告を含めることができます。
ステートメントの構文エラーまたは実行エラーがある場合、結果は返されません。
Data API は、パスワードが空の組み込みユーザーとして認証できません。
インスタンスで特定のメンテナンスオペレーションが進行中の場合、データの完全性のために Data API が一時的にブロックされることがあります。その場合は、しばらくしてからもう一度お試しください。

GO コマンドはサポートされていません。このコマンドは、ステートメントのバッチが終了し、SQL Server に送信できるようになったことを示すために Microsoft SQL Server ユーティリティで使用されます。
クエリにバイナリ列が含まれている場合、Data API はその列を表示できません。その場合、バイナリ値を文字列に変換します。

たとえば、次のように置き換えます。
```
SELECT my_binary_column from my_table2;
```
次のように置き換えます。
```
SELECT CONVERT(NVARCHAR(4000), my_binary_column, 1) from my_table2;
```
複数のクエリを実行し、そのうちの 1 つが失敗した場合は、最初に発生したエラーが返されます。エラーが発生する前にバッチ内の一部のステートメントが正常に処理されている可能性があります。この問題を回避するには、複数のクエリを transaction ステートメントでラップします。
```
BEGIN TRANSACTION
    YOUR_SQL_STATEMENTS
COMMIT;
```
次のように置き換えます。
- YOUR_SQL_STATEMENTS: このクエリの一部として実行するステートメント

SQL スクリプトとその実行レスポンスは、クライアントとターゲットインスタンスのロケーション間の中間ロケーションを通過する可能性があります。このため、特定の Assured Workloads プロジェクトと constraints/sql.restrictNoncompliantResourceCreation が手動で適用されているプロジェクトでは、リクエストが失敗し、「not supported for instances in certain Assured Workloads control packages folders」というエラーが返されます。

トラブルシューティング

このセクションでは、Data API の使用に関連する問題と、その問題のトラブルシューティング手順について説明します。

問題	トラブルシューティング
`The instance doesn't allow using ExecuteSql to access this instance. You can allow it by patching the instance with {settings: { dataApiAccess: "ALLOW_DATA_API" }}`	Data API はデフォルトで無効になっています。この問題を解決するには、インスタンスで Data API を有効にします。
`Secret cannot be provided when auto_iam_authn is true.`	`auto_iam_authn` を `true` に設定すると、IAM を使用してデータベースに対する認証が行われます。この認証方法では、パスワードやシークレットは必要ありません。 IAM を使用して認証するをご覧ください。
`ExecuteSql API is not supported for instances in certain Assured Workloads control packages folders yet.`	SQL スクリプトとその実行レスポンスは、クライアントとターゲットインスタンスのロケーション間の中間ロケーションを通過する場合があります。このため、特定の Assured Workloads プロジェクトのインスタンスに対するリクエストは失敗します。プロジェクトが Assured Workloads に登録されておらず、`constraints/sql.restrictNoncompliantResourceCreation` が手動で適用されている場合は、組織の管理者に制約の削除を依頼してください。これにより、新しく作成されたインスタンスで問題が解決されます。
`The server principal USERNAME is not able to access the database DATABASE_NAME under the current security context.`	ユーザーがデータベースのメンバーではありません。`sqlserver` ユーザーとしてデータベースに接続し、新規ユーザーを追加してから、データベースの新規ユーザーに `db_owner` ロールを付与します。次に例を示します。 EXEC sp_adduser 'user'; EXEC sp_addrolemember 'db_owner', 'user'
`The database is currently unavailable.`	インスタンスが再起動中、メンテナンス中、または異常な状態である可能性があります。インスタンスのステータスを確認して、しばらくしてからもう一度お試しください。

Cloud SQL Data API を使用して SQL ステートメントを実行する コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。

始める前に

データベース ユーザーを構成する

必要なロールまたは権限

Data API を有効または無効にする

コンソール

gcloud

REST

SQL ステートメントを実行する

パスワードを使用して認証する

gcloud

Terraform

変更を適用する

Cloud Shell を準備する

ディレクトリを準備する

変更を適用する

変更を削除する

REST

切り捨ての動作を変更する

監査クエリ

制限事項

トラブルシューティング

Cloud SQL Data API を使用して SQL ステートメントを実行する

データベースユーザーを構成する