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 문을 실행하려면 다음 단계를 따르세요.

데이터베이스 사용자 구성

데이터 API는 SQL 문을 실행하기 위해 데이터베이스 사용자로 인증해야 합니다.

비밀번호를 사용하여 기본 제공 사용자로 인증하려면 다음 단계를 따르세요.

비밀번호가 비어 있지 않은 사용자 계정을 만듭니다. 기본 사용자 sqlserver를 사용할 수도 있습니다.
SQL 문을 실행할 수 있도록 계정에 필요한 역할 또는 권한을 부여합니다. 사용자가 sqlserver이 아닌 경우 사용자에게 db_owner 역할을 부여합니다.
Secret Manager를 사용하여 비밀번호를 저장할 리전 보안 비밀을 만듭니다. 보안을 위해 Data API는 API 요청에서 비밀번호 대신 보안 비밀의 리소스 이름을 요청합니다. 리전별 보안 비밀은 Cloud SQL 인스턴스와 동일한 리전에 저장해야 합니다. Secret Manager의 전역 엔드포인트를 사용하여 만든 보안 비밀은 동일한 리전에 저장되어 있더라도 지원되지 않습니다.
데이터 API 호출자에게 roles/secretmanager.secretAccessor 부여 권장사항으로 사용자가 특정 보안 비밀에 액세스할 수 있지만 프로젝트의 다른 보안 비밀에는 액세스할 수 없도록 IAM 조건을 정의하세요.

필요한 역할 또는 권한

데이터 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 탐색 메뉴에서 연결을 선택합니다.
네트워킹 탭을 클릭합니다.
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

데이터 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 프로젝트를 설정합니다.

이 명령어는 프로젝트당 한 번만 실행하면 되며 어떤 디렉터리에서도 실행할 수 있습니다.
```
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",
  "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: 선택사항입니다. 결과가 10MB를 초과할 때 API가 응답하는 방식을 제어합니다. FAIL_PARTIAL_RESULT, ALLOW_PARTIAL_RESULT 또는 PARTIAL_RESULT_MODE_UNSPECIFIED일 수 있습니다. 잘림 동작 수정을 참고하세요.

잘림 동작 수정

요청에 "partialResultMode" 필드를 포함하여 SQL을 실행할 때 결과가 처리되는 방식을 제어할 수 있습니다. 이 필드는 다음 값을 허용합니다.

FAIL_PARTIAL_RESULT: 기본값입니다. 결과가 10MB를 초과하거나 일부 결과만 검색할 수 있는 경우 오류를 발생시킵니다. 결과를 반환하지 않습니다.
ALLOW_PARTIAL_RESULT: 결과가 10MB를 초과하거나 오류로 인해 일부 결과만 가져올 수 있는 경우 잘린 결과를 반환하고 partial_result을 true로 설정합니다. 오류를 발생시키지 않습니다.
PARTIAL_RESULT_MODE_UNSPECIFIED: 지정되지 않은 모드로, 사실상 FAIL_PARTIAL_RESULT과 동일합니다.

감사 쿼리

요청에서 applicationName 필드를 설정하여 애플리케이션 이름을 추적할 수 있습니다. 데이터베이스는 세션 통계에서 애플리케이션 이름을 추적합니다(예: sys.dm_exec_sessions 테이블).

쿼리 통계를 사용하여 쿼리에 관한 자세한 정보를 추적하고 성능 문제를 분석할 수 있습니다.

SQL Server 데이터베이스 감사를 사용하여 보안 또는 규정 준수 목적으로 쿼리를 로깅할 수도 있습니다.

제한사항

대답의 크기 제한은 10MB입니다. partialResultMode가 ALLOW_PARTIAL_RESULT로 설정된 경우 이 크기를 초과하는 결과는 잘립니다. 그렇지 않으면 오류가 발생합니다.
요청은 0.5MB로 제한됩니다.
실행 중인 SQL Server용 Cloud SQL 인스턴스에 대해서만 SQL 문을 실행할 수 있습니다.
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)는 총 메모리가 10GB 미만인 인스턴스의 경우 5개 쿼리이고, 총 메모리가 10GB 이상인 인스턴스의 경우 10개 쿼리입니다.
각 응답에는 최대 10개의 데이터베이스 메시지 또는 경고가 포함될 수 있습니다.
문 구문 또는 실행 오류가 있으면 결과가 반환되지 않습니다.
데이터 API는 비밀번호가 비어 있는 기본 제공 사용자로 인증할 수 없습니다.
인스턴스에서 특정 유지관리 작업이 진행 중인 경우 데이터 무결성을 위해 Data API가 일시적으로 차단될 수 있습니다. 이 문제가 발생하면 나중에 다시 시도해 보세요.

GO 명령어는 지원되지 않습니다. 이 명령어는 Microsoft SQL Server 유틸리티에서 사용되며 문 배치가 종료되어 SQL Server로 전송할 수 있음을 나타냅니다.
쿼리에 바이너리 열이 포함된 경우 Data API에서 이를 표시할 수 없습니다. 대신 바이너리 값을 문자열로 변환합니다.

예를 들어, 다음으로
```
SELECT my_binary_column from my_table2;
```
다음 코드로 교체합니다.
```
SELECT CONVERT(NVARCHAR(4000), my_binary_column, 1) from my_table2;
```
여러 쿼리를 실행하는 중에 쿼리 중 하나가 실패하면 처음 발생한 오류가 반환됩니다. 오류 발생 이전 배치에 있는 일부 문은 성공적으로 실행되었을 수 있습니다. transaction 문으로 여러 쿼리를 래핑하여 이 문제를 방지할 수 있습니다.
```
BEGIN TRANSACTION
    YOUR_SQL_STATEMENTS
COMMIT;
```
다음을 바꿉니다.
- YOUR_SQL_STATEMENTS: 이 쿼리의 일부로 실행할 문

SQL 스크립트와 실행 응답은 클라이언트와 대상 인스턴스 위치 간의 중간 위치를 통과할 수 있습니다. 이러한 이유로 특정 Assured Workloads 프로젝트와 constraints/sql.restrictNoncompliantResourceCreation가 수동으로 적용된 프로젝트의 경우 요청이 '특정 Assured Workloads 제어 패키지 폴더의 인스턴스에 지원되지 않음' 오류와 함께 실패합니다.

문제 해결

이 섹션에는 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" }}`	데이터 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 문 실행