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

이 페이지에서는 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 문을 실행하려면 다음을 수행하세요.

필요한 역할 또는 권한

기본적으로 다음 역할 중 하나가 있는 사용자 또는 서비스 계정에는 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 사용 설정 또는 사용 중지

데이터 API를 사용하려면 각 인스턴스에 대해 사용 설정해야 합니다. 언제든지 Data 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=DENY_DATA_API 플래그를 사용합니다.

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

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

SQL 문 실행

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

gcloud

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

gcloud beta 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 플래그를 포함할 수도 있습니다.

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

다음을 바꿉니다.

  • 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개의 데이터베이스 메시지 또는 경고가 포함될 수 있습니다.
  • 문 구문 또는 실행 오류가 있으면 결과가 반환되지 않습니다.
  • 메모리를 많이 사용하는 문은 메모리 부족 오류를 일으킬 수 있습니다. 이러한 오류를 방지하는 방법에 관한 자세한 내용은 메모리 사용량 관리 권장사항을 참고하세요. 메모리 사용량이 높은 상태로 실행되는 데이터베이스 인스턴스는 성능 문제, 중단 또는 데이터베이스 다운타임을 일으키는 경우가 많습니다.