Ejecuta instrucciones de SQL con la API de Cloud SQL Data

MySQL   |  PostgreSQL   |  SQL Server

En esta página, se describe cómo ejecutar instrucciones SQL en bases de datos en instancias de Cloud SQL con la API de Data. Con la API de Data, usas la API de Cloud SQL Admin y la CLI de gcloud para ejecutar instrucciones SQL en cualquier instancia en la que hayas habilitado el acceso a la API de Data.

Puedes usar la API de Data con instancias que usan direcciones IP públicas, acceso privado a servicios o Private Service Connect. La API de Data admite todos los tipos de sentencias de SQL, incluidos el lenguaje de manipulación de datos (DML), el lenguaje de definición de datos (DDL) y el lenguaje de consulta de datos (DQL). La API de Data es útil para ejecutar sentencias administrativas pequeñas y rápidas, como crear roles o usuarios de bases de datos y realizar pequeñas actualizaciones de esquemas.

Antes de comenzar

Antes de ejecutar instrucciones de SQL en una instancia, haz lo siguiente:

• Configura la instancia para la autenticación de bases de datos de IAM.
• Agrega un usuario o una cuenta de servicio de IAM a la instancia y otórgale a la cuenta los roles o permisos necesarios para ejecutar instrucciones SQL.

Roles o permisos obligatorios

De forma predeterminada, las cuentas de servicio o usuario con uno de los siguientes roles tienen permiso para ejecutar instrucciones SQL en una instancia de Cloud SQL (cloudsql.instances.executesql):

• Cloud SQL Admin (roles/cloudsql.admin)
• Cloud SQL Instance User (roles/cloudsql.instanceUser)
• Cloud SQL Studio User (roles/cloudsql.studioUser)

También puedes definir un rol personalizado de IAM para la cuenta de servicio o usuario que incluya el permiso cloudsql.instances.executesql. Este permiso es compatible con los roles personalizados de IAM.

Habilita o inhabilita la API de Data

Para usar la API de datos, debes habilitarla para cada instancia. Puedes inhabilitar la API de Data en cualquier momento.

Console

1. En la consola de Google Cloud , ve a la página Instancias de Cloud SQL.

   Ir a Instancias de Cloud SQL

2. Para abrir la página de Descripción general de una instancia, haz clic en su nombre.
3. En el menú de navegación de SQL, selecciona Conexiones.
4. Haz clic en la pestaña Redes.
5. Selecciona la casilla de verificación Permitir Data API.
6. Haz clic en Guardar.

gcloud

Para habilitar el acceso a la API de datos en una instancia, usa el comando gcloud sql instances patch con la marca --data-api-access=ALLOW_DATA_API:

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

Para inhabilitar el acceso a la API de datos, usa la marca --data-api-access=DISALLOW_DATA_API:

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

Reemplaza INSTANCE_NAME por el nombre de la instancia en la que se habilitará o inhabilitará la API de Data.

Ejecuta una instrucción de SQL

Puedes ejecutar instrucciones SQL en las bases de datos de tu instancia de Cloud SQL con gcloud CLI o la API de REST.

gcloud

Para ejecutar una instrucción de SQL en una base de datos de una instancia con la CLI de gcloud, usa el comando gcloud sql instances execute-sql:

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

Realiza los siguientes reemplazos:

• INSTANCE_NAME: El nombre de la instancia.
• DATABASE_NAME: Es el nombre de la base de datos dentro de la instancia.
• SQL_STATEMENT: Es la instrucción de SQL que se ejecutará. Si la instrucción contiene espacios o caracteres especiales de shell, debe estar entre comillas.
• PARTIAL_RESULT_MODE: es opcional. Controla cómo responder cuando el resultado está incompleto. Puede ser ALLOW_PARTIAL_RESULT, FAIL_PARTIAL_RESULT o PARTIAL_RESULT_MODE_UNSPECIFIED. Consulta Cómo modificar el comportamiento de truncamiento.

También puedes incluir la marca --project=PROJECT_ID si es necesario.

Terraform

Puedes usar la API de Data en Terraform para aprovisionar recursos en la base de datos, como bases de datos, tablas, extensiones, usuarios y concesiones de privilegios, sin conectarte manualmente a la instancia. Para ejecutar una secuencia de comandos de SQL en Terraform, usa el recurso de Terraform google_sql_provision_script.

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

  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.
 */
resource "google_sql_user" "iam_user" {
  name     = "[e-mail]"
  instance = google_sql_database_instance.instance.name
  type     = "CLOUD_IAM_USER"

  # Roles granted to the user. Smaller roles are preferred, if exist.
  # This field doesn't support MySQL 5.6 and 5.7.
  database_roles = ["cloudsqlsuperuser"]
}

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 DATABASE pets;"
  instance = google_sql_database_instance.instance.name

  # Some of your queries may require a database. You can create and use a
  # database in the script or explicitly create and reference a database
  # like database = google_sql_database.database.name.

  description = "sql script to create DBs"

  # 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]
}

Aplique los cambios

Para aplicar tu configuración de Terraform en un proyecto de Google Cloud , completa los pasos de las siguientes secciones.

Prepara Cloud Shell

1. Inicia Cloud Shell

2. Establece el proyecto Google Cloud predeterminado en el que deseas aplicar tus configuraciones de Terraform.

   Solo necesitas ejecutar este comando una vez por proyecto y puedes ejecutarlo en cualquier directorio.

   export GOOGLE_CLOUD_PROJECT=PROJECT_ID

   Las variables de entorno se anulan si configuras valores explícitos en el archivo de configuración de Terraform.

Prepara el directorio

Cada archivo de configuración de Terraform debe tener su propio directorio (también llamado módulo raíz).

1. En Cloud Shell, crea un directorio y un archivo nuevo dentro de ese directorio. El nombre del archivo debe tener la extensión .tf, por ejemplo, main.tf. En este instructivo, el archivo se denomina main.tf.

   mkdir DIRECTORY && cd DIRECTORY && touch main.tf

2. Si sigues un instructivo, puedes copiar el código de muestra en cada sección o paso.

   Copia el código de muestra en el main.tf recién creado.

   De manera opcional, copia el código de GitHub. Esto se recomienda cuando el fragmento de Terraform es parte de una solución de extremo a extremo.

3. Revisa y modifica los parámetros de muestra que se aplicarán a tu entorno.
4. Guarda los cambios.
5. Inicializa Terraform. Solo debes hacerlo una vez por directorio.

   terraform init

   De manera opcional, incluye la opción -upgrade para usar la última versión del proveedor de Google:

   terraform init -upgrade

Aplica los cambios

1. Revisa la configuración y verifica que los recursos que creará o actualizará Terraform coincidan con tus expectativas:

   terraform plan

   Corrige la configuración según sea necesario.

2. Para aplicar la configuración de Terraform, ejecuta el siguiente comando y, luego, escribe yes cuando se te solicite:

   terraform apply

   Espera hasta que Terraform muestre el mensaje “¡Aplicación completa!”.

3. Abre tu proyecto Google Cloud para ver los resultados. En la consola de Google Cloud , navega a tus recursos en la IU para asegurarte de que Terraform los haya creado o actualizado.

Nota: Por lo general, las muestras de Terraform suponen que las APIs necesarias están habilitadas en tu proyecto de Google Cloud .

Borra los cambios

Si borras un recurso google_sql_provision_script, no se borrarán los recursos en la base de datos que creó. Para borrarlas, puedes agregar explícitamente instrucciones en la secuencia de comandos, como drop ... if exists, y, luego, aplicar los cambios.

REST

Para ejecutar una instrucción de SQL en una base de datos de una instancia con la API de REST, envía una solicitud POST al extremo executeSql:

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

El cuerpo de la solicitud debe contener el nombre de la base de datos y la instrucción de SQL:

{
  "database": "DATABASE_NAME",
  "sqlStatement": "SQL_STATEMENT",
  "partialResultMode": "PARTIAL_RESULT_MODE"
  "autoIamAuthn": true
}

Realiza los siguientes reemplazos:

• PROJECT_ID: el ID de tu proyecto
• INSTANCE_NAME: El nombre de la instancia.
• DATABASE_NAME: Es el nombre de la base de datos dentro de la instancia.
• SQL_STATEMENT: Es la instrucción de SQL que se ejecutará.
• PARTIAL_RESULT_MODE: es opcional. Controla cómo responde la API cuando el resultado supera los 10 MB. Puede ser FAIL_PARTIAL_RESULT o ALLOW_PARTIAL_RESULT. Consulta Cómo modificar el comportamiento de truncamiento.

Cómo modificar el comportamiento del truncamiento

Puedes controlar cómo se manejan los resultados grandes cuando se ejecuta SQL.

• Incluye el campo "partialResultMode" en la solicitud. Este campo acepta los siguientes valores:
  • FAIL_PARTIAL_RESULT: Genera un error si el resultado supera los 10 MB o si solo se puede recuperar un resultado parcial. No devuelve el resultado.
  • ALLOW_PARTIAL_RESULT: Devuelve un resultado truncado y establece partial_result como verdadero si el resultado supera los 10 MB o si solo se puede recuperar un resultado parcial debido a un error. No arroja un error.

Limitaciones

• El límite de tamaño para una respuesta es de 10 MB. Los resultados que superen este tamaño se truncarán si partialResultMode se establece en ALLOW_PARTIAL_RESULT. De lo contrario, se generará un error.
• Las solicitudes tienen un límite de 0.5 MB.
• Solo puedes ejecutar instrucciones SQL para las instancias de Cloud SQL para MySQL que se estén ejecutando.
• Cloud SQL no admite el uso de la API de Data con instancias configuradas para la replicación de servidores externos.
• Las solicitudes que tarden más de 30 segundos se cancelarán. No se admite establecer un tiempo de espera de la instrucción más alto con SET SESSION MAX_EXECUTION_TIME. En el caso de Cloud SQL para MySQL 5.6 y 5.7, el tiempo de espera de las declaraciones DDL de larga duración puede causar archivos o tablas huérfanos que no se pueden revertir de forma segura. Ten cuidado con las instrucciones como ALTER TABLE en tablas grandes.
• Cloud SQL limita la cantidad de solicitudes executeSql simultáneas a 10 por instancia para cada usuario. Si se alcanza este límite, las solicitudes posteriores fallarán con el mensaje "En esta instancia, se pueden ejecutar como máximo 10 consultas simultáneas. Inténtalo de nuevo más tarde" o "Se alcanzó el máximo de 10 lecturas simultáneas".
• Cada respuesta puede contener un máximo de 10 mensajes o advertencias de la base de datos.
• Si hay un error de sintaxis o de ejecución de la instrucción, no se devuelve ningún resultado.
• En el caso de Cloud SQL para MySQL, los avisos y las advertencias solo están disponibles para la última instrucción de una ejecución de varias instrucciones.
• Las instrucciones que consumen una gran cantidad de memoria pueden provocar errores de memoria insuficiente. Para obtener más información sobre cómo evitar estos errores, consulta Prácticas recomendadas para administrar el uso de memoria. Una instancia de base de datos que se ejecuta con una utilización de memoria alta suele causar problemas de rendimiento, atascos o, incluso, tiempo de inactividad de la base de datos.
• La API de Data se puede bloquear temporalmente por motivos de integridad de los datos cuando se realizan ciertas operaciones de mantenimiento en la instancia. Si esto sucede, vuelve a intentarlo más tarde.
• La API de Data aún no garantiza la residencia de datos. Las solicitudes fallarán con el error "no compatible con instancias en ciertas carpetas de paquetes de controles de Assured Workloads" para ciertos proyectos de Assured Workloads y para proyectos con constraints/sql.restrictNoncompliantResourceCreation aplicado manualmente.