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는 데이터베이스 역할 또는 사용자 생성, 작은 스키마 업데이트와 같은 작고 빠른 관리 문을 실행하는 데 적합합니다. 데이터 API를 사용하여 PostgreSQL 확장 프로그램을 사용 설정할 수도 있습니다.

시작하기 전에

인스턴스에서 SQL 문을 실행하려면 다음을 수행하세요.

IAM 데이터베이스 인증을 위해 인스턴스를 구성합니다.
인스턴스에 IAM 사용자 또는 서비스 계정을 추가하고 SQL 문을 실행하는 데 필요한 역할 또는 권한을 계정에 부여합니다.

필요한 역할 또는 권한

기본적으로 다음 역할 중 하나가 있는 사용자 또는 서비스 계정에는 Cloud SQL 인스턴스에서 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 커스텀 역할에서 지원됩니다.

Data API 사용 설정 또는 사용 중지

Data API를 사용하려면 각 인스턴스에 대해 사용 설정해야 합니다. 언제든지 Data API를 사용 중지할 수 있습니다.

콘솔

Google Cloud 콘솔에서 Cloud SQL 인스턴스 페이지로 이동합니다.

Cloud SQL 인스턴스로 이동
인스턴스의 개요 페이지를 열려면 인스턴스 이름을 클릭합니다.
SQL 탐색 메뉴에서 연결을 선택합니다.
네트워킹 탭을 클릭합니다.
데이터 API 허용 체크박스를 선택합니다.
저장을 클릭합니다.

gcloud

인스턴스에서 데이터 API 액세스를 사용 설정하려면 --data-api-access=ALLOW_DATA_API 플래그와 함께 gcloud sql instances patch 명령어를 사용합니다.

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

데이터 API 액세스를 사용 중지하려면 --data-api-access=DISALLOW_DATA_API 플래그를 사용합니다.

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

INSTANCE_NAME을 Data API를 사용 설정하거나 사용 중지할 인스턴스의 이름으로 바꿉니다.

SQL 문 실행

gcloud CLI 또는 REST API를 사용하여 Cloud SQL 인스턴스의 데이터베이스에 대해 SQL 문을 실행할 수 있습니다.

gcloud

gcloud CLI를 사용하여 인스턴스의 데이터베이스에 대해 SQL 문을 실행하려면 gcloud sql instances execute-sql 명령어를 사용합니다.

gcloud sql instances execute-sql INSTANCE_NAME \
--database=DATABASE_NAME \
--sql=SQL_STATEMENT \
--partial_result_mode=PARTIAL_RESULT_MODE

다음을 바꿉니다.

INSTANCE_NAME: 인스턴스 이름입니다.
DATABASE_NAME: 인스턴스 내 데이터베이스의 이름입니다.
SQL_STATEMENT: 실행할 SQL 문입니다. 명령문에 공백이나 셸 특수문자가 포함되어 있으면 따옴표로 묶어야 합니다.
PARTIAL_RESULT_MODE: 선택사항입니다. 결과가 불완전한 경우 응답 방법을 제어합니다. ALLOW_PARTIAL_RESULT, FAIL_PARTIAL_RESULT, PARTIAL_RESULT_MODE_UNSPECIFIED일 수 있습니다. 잘림 동작 수정을 참고하세요.

필요한 경우 --project=PROJECT_ID 플래그를 포함할 수도 있습니다.

Terraform

Terraform의 Data API를 사용하여 인스턴스에 수동으로 연결하지 않고도 데이터베이스, 테이블, 확장 프로그램, 사용자, 권한 부여와 같은 데이터베이스 내 리소스를 프로비저닝할 수 있습니다. Terraform에서 SQL 스크립트를 실행하려면 google_sql_provision_script Terraform 리소스를 사용합니다.

resource "google_sql_database_instance" "instance" {
  name             = "my-instance"
  database_version = "POSTGRES_17"

  settings {
    tier            = "db-perf-optimized-N-2"
    data_api_access = "ALLOW_DATA_API"  # This allows the use of Data API.
    database_flags {
      name  = "cloudsql.iam_authentication"
      value = "on"
    }
  }
}

/*
 * Create a database user for your account and grant roles so it has privilege to
 * access the database. Set the type to CLOUD_IAM_USER for huamn account or
 * CLOUD_IAM_SERVICE_ACCOUNT for service account. If a service account is used
 * and the instance is Postgres, trim the ".gserviceaccount.com"
 * suffix to avoid exceeding the username length limit.
*/
resource "google_sql_user" "iam_user" {
  name     = "account-used-to-apply-this-config@example.com"
  instance = google_sql_database_instance.instance.name
  type     = "CLOUD_IAM_USER"

  # Roles granted to the user. Smaller roles are preferred, if exist.
  database_roles = ["cloudsqlsuperuser"]
}

resource "google_sql_database" "database" {
  name     = "my-database"
  instance = google_sql_database_instance.instance.name
}

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"

  # The identity account used to apply your Terraform config must exist as an
  # IAM user or IAM service account in the instance. Terraform connects to the
  # instance via IAM database authentication to execute the script.
  depends_on = [google_sql_user.iam_user]
}

변경사항 적용

Google Cloud 프로젝트에 Terraform 구성을 적용하려면 다음 섹션의 단계를 완료하세요.

Cloud Shell 준비

Cloud Shell을 실행합니다.
Terraform 구성을 적용할 기본 Google Cloud 프로젝트를 설정합니다.

이 명령어는 프로젝트당 한 번만 실행하면 되며 어떤 디렉터리에서도 실행할 수 있습니다.
```
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을 초기화합니다. 이 작업은 디렉터리당 한 번만 수행하면 됩니다.
```
terraform init
```
원하는 경우 최신 Google 공급업체 버전을 사용하려면 -upgrade 옵션을 포함합니다.
```
terraform init -upgrade
```

변경사항 적용

구성을 검토하고 Terraform에서 만들거나 업데이트할 리소스가 예상과 일치하는지 확인합니다.
```
terraform plan
```
필요에 따라 구성을 수정합니다.
다음 명령어를 실행하고 프롬프트에 yes를 입력하여 Terraform 구성을 적용합니다.
```
terraform apply
```
Terraform에 '적용 완료' 메시지가 표시될 때까지 기다립니다.
결과를 보려면 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",
  "partialResultMode": "PARTIAL_RESULT_MODE"
  "autoIamAuthn": true
}

다음을 바꿉니다.

PROJECT_ID: 프로젝트 ID입니다.
INSTANCE_NAME: 인스턴스 이름입니다.
DATABASE_NAME: 인스턴스 내 데이터베이스의 이름입니다.
SQL_STATEMENT: 실행할 SQL 문입니다.
PARTIAL_RESULT_MODE: 선택사항입니다. 결과가 10MB를 초과할 때 API가 응답하는 방식을 제어합니다. FAIL_PARTIAL_RESULT 또는 ALLOW_PARTIAL_RESULT일 수 있습니다. 잘림 동작 수정을 참고하세요.

잘림 동작 수정

SQL을 실행할 때 결과가 처리되는 방식을 제어할 수 있습니다.

요청에 "partialResultMode" 필드를 포함합니다. 이 필드는 다음 값을 허용합니다.
- FAIL_PARTIAL_RESULT: 결과가 10MB를 초과하거나 일부 결과만 가져올 수 있는 경우 오류를 발생시킵니다. 결과를 반환하지 않습니다.
- ALLOW_PARTIAL_RESULT: 결과가 10MB를 초과하거나 오류로 인해 부분 결과만 검색할 수 있는 경우 잘린 결과를 반환하고 partial_result을 true로 설정합니다. 오류를 발생시키지 않습니다.

제한사항

대답의 크기 제한은 10MB입니다. partialResultMode가 ALLOW_PARTIAL_RESULT로 설정된 경우 이 크기를 초과하는 결과는 잘립니다. 그렇지 않으면 오류가 발생합니다.
요청은 0.5MB로 제한됩니다.
실행 중인 PostgreSQL용 Cloud SQL 인스턴스에 대해서만 SQL 문을 실행할 수 있습니다.
Cloud SQL은 외부 서버 복제를 위해 설정된 인스턴스에서 Data API 사용을 지원하지 않습니다.
30초를 초과하는 요청은 취소됩니다. SET STATEMENT_TIMEOUT을 사용하여 더 긴 문 제한 시간을 설정하는 것은 지원되지 않습니다.
Cloud SQL은 각 사용자의 인스턴스당 동시 executeSql 요청 수를 10개로 제한합니다. 이 한도에 도달하면 후속 요청이 '이 인스턴스에서 동시에 실행할 수 있는 쿼리는 최대 10개입니다. 나중에 다시 시도하세요.' 또는 '최대 동시 읽기 수 10에 도달했습니다.'
각 응답에는 최대 10개의 데이터베이스 메시지 또는 경고가 포함될 수 있습니다.
문 구문 또는 실행 오류가 있으면 결과가 반환되지 않습니다.
메모리를 많이 사용하는 문은 메모리 부족 오류를 일으킬 수 있습니다. 이러한 오류를 방지하는 방법에 관한 자세한 내용은 메모리 사용량 관리 권장사항을 참고하세요. 메모리 사용량이 높은 상태로 실행되는 데이터베이스 인스턴스는 성능 문제, 중단 또는 데이터베이스 다운타임을 일으키는 경우가 많습니다.
인스턴스에서 특정 유지관리 작업이 진행 중인 경우 데이터 무결성을 위해 데이터 API가 일시적으로 차단될 수 있습니다. 이 문제가 발생하면 나중에 다시 시도하세요.
Data API는 아직 데이터 상주를 보장하지 않습니다. 특정 Assured Workloads 프로젝트와 constraints/sql.restrictNoncompliantResourceCreation가 수동으로 적용된 프로젝트의 경우 '특정 Assured Workloads 제어 패키지 폴더의 인스턴스에 지원되지 않음' 오류와 함께 요청이 실패합니다.

Cloud SQL Data API를 사용하여 SQL 문 실행 컬렉션을 사용해 정리하기 내 환경설정을 기준으로 콘텐츠를 저장하고 분류하세요.

시작하기 전에

필요한 역할 또는 권한

Data API 사용 설정 또는 사용 중지

콘솔

gcloud

SQL 문 실행

gcloud

Terraform

변경사항 적용

Cloud Shell 준비

디렉터리 준비

변경사항 적용

변경사항 삭제

REST

잘림 동작 수정

제한사항

Cloud SQL Data API를 사용하여 SQL 문 실행