SQL Server

El conector de SQL Server te permite realizar operaciones de inserción, eliminación, actualización y lectura en una base de datos de SQL Server.

Versiones compatibles

Versiones de SQL Server: 2008, 2012, 2014, 2016, 2017, 2019 y 2022

Antes de comenzar

Antes de usar el conector de SQL Server, realiza las siguientes tareas:

• En tu proyecto de Google Cloud, haz lo siguiente:
  • Otorga el rol de IAM roles/connectors.admin al usuario. configurar el conector.
  • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

  • Habilita los siguientes servicios:
    • secretmanager.googleapis.com (API de Secret Manager)
    • connectors.googleapis.com (API de conectores)

    Para comprender cómo habilitar servicios, consulta Habilita servicios.

  Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

   Ir a la página Conexiones

2. Haz clic en + Crear nuevo para abrir la página Crear conexión.
3. En la sección Ubicación, elige la ubicación para la conexión.
   1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

   2. Haz clic en Siguiente.
4. En la sección Detalles de la conexión, completa lo siguiente:
   1. Conector: Selecciona SQL Server de la lista desplegable de conectores disponibles.
   2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
   3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de conexión no pueden superar los 49 caracteres.
   4. De manera opcional, ingresa una Descripción para la instancia de conexión.
   5. De manera opcional, habilita Cloud Logging y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
   6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
   7. De manera opcional, configura los parámetros de nodo de conexión:
      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

   Nota: Puedes personalizar los valores de los nodos de conexión solo si eres un cliente de pago por uso.
   8. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
   • Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
     • Básico: Autenticación HTTP básica.
     • Resumen: Autenticación de HTTP de resumen.
   • Usuario de proxy: Un nombre de usuario que se usará para autenticarse con el servidor proxy.
   • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
   • Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Se admiten los siguientes tipos de autenticación:
     • Automático: Configuración predeterminada. Si la URL es HTTPS, se usa la opción Túnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
     • Siempre: La conexión siempre está habilitada para SSL.
     • Nunca: La conexión no está habilitada para SSL.
     • Túnel: La conexión se realiza a través de un proxy de túnel. El servidor proxy abre una conexión con el host remoto y el tráfico fluye de un lado a otro a través del proxy.
   • En la sección Proxy Server, ingresa los detalles del servidor proxy.
     1. Haz clic en Agregar destino.
     2. Selecciona un Tipo de destino.
        • Dirección del host: Especifica el nombre de host o la dirección IP del destino.

          Si deseas establecer una conexión privada a tu sistema de backend, haz lo siguiente:

          • Crea un adjunto de servicio de PSC.
          • Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
   9. ApplicationIntent: La propiedad de la string de conexión del intent de la aplicación expresa la solicitud de la aplicación cliente para que se dirija a una versión de lectura y escritura o de solo lectura de una base de datos de grupos de disponibilidad. Para usar el enrutamiento de solo lectura, un cliente debe usar un intent de aplicación de solo lectura en la string de conexión cuando se conecte al objeto de escucha del grupo de disponibilidad. Sin el intent de aplicación de solo lectura, las conexiones al objeto de escucha del grupo de disponibilidad se dirigen a la base de datos en la réplica principal.
   10. ApplicationName: La propiedad de la string de conexión del nombre de la aplicación expresa el nombre de la aplicación cliente.
   11. Database: El nombre de la base de datos de SQL Server.
   12. Encrypt: Este campo configura si SSL está habilitado.
   13. De manera opcional, haz clic en + Agregar etiqueta para agregar una etiqueta a la conexión en forma de un par clave-valor.
   14. De manera opcional, si deseas usar SSL, selecciona Habilitar SSL. Se mostrarán los detalles de la configuración de SSL.
       1. Selecciona un tipo de almacén de confianza. Puede ser Público, Privado o Conexión no segura.
       2. Selecciona los certificados como se muestra en función de la selección del almacén de confianza.
       3. Si usas mTLS, selecciona los certificados del almacén de claves en la sección Almacén de claves.
       Nota:

       • Todos tus certificados deben ser certificados X.509 y deben estar en formato PEM (correo con privacidad mejorada).
       • No puedes seleccionar un certificado directamente cuando configuras SSL. Debes almacenar todos tus certificados y claves privadas como un Secret de Secret Manager y, luego, seleccionar el Secret necesario durante la configuración de SSL.
   15. Haz clic en Siguiente.
5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
   1. Tipo de destino: Selecciona un Tipo de destino.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si deseas establecer una conexión privada a tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el archivo adjunto de extremo requerido en la lista Adjunto de extremo.
        Nota: Para comprender cómo crear un adjunto de extremo, consulta Adjunto de servicio de PSC y Adjunto de extremo. Después de crear el archivo adjunto del extremo, este aparecerá en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir en la lista de entidades permitidas solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +Agregar destino.

   2. Haz clic en Siguiente.
6. En la sección Autenticación, ingresa los detalles de autenticación.
   1. Selecciona un Tipo de autenticación y, luego, ingresa los detalles relevantes.

      La conexión de SQL Server admite los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña

   Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

   2. Haz clic en Siguiente.
7. Revisa: Revisa tus detalles de conexión y autenticación.
8. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

• Nombre de usuario y contraseña
  • Username: Nombre de usuario para el conector
  • Password: El Secret de Secret Manager que contiene la contraseña asociada con el conector.
  • Esquema de autenticación: El esquema que se usa para la autenticación

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

Nota: Puedes ver las entidades, operaciones y acciones de un conector en la tarea de conectores.

• Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

• Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Lista
  • Obtén
  • Crear
  • Actualizar
  • Borrar

  Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones operaciones no aparecen en la lista Operations.

• Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y una parámetro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Nota: Todas las entidades y acciones tendrán un esquema asociado. Por ejemplo, un esquema de acción tendrá los detalles de los parámetros, como los nombres de los parámetros y su tipo de datos correspondiente. La conexión recupera el esquema (metadatos) de las entidades y las acciones durante el tiempo de ejecución desde tu backend. Si hay actualizaciones en el esquema, estas no se reflejarán automáticamente en tus conexiones existentes. Debes actualizar el esquema de forma manual. Para actualizar el esquema de una conexión, abre la página Detalles de la conexión de la conexión y, luego, haz clic en Actualizar esquema de conexión.

Limitaciones del sistema

El conector de SQL Server puede procesar un máximo de 90 transacciones por segundo por nodo y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) por una conexión.

Para obtener información sobre los límites aplicables a Integration Connectors, consulta Límites.

Nota: La cantidad de nodos de Integration Connectors se ajustará automáticamente de forma dinámica según tu uso. Sin embargo, si deseas reservar capacidad para grandes volúmenes sin mientras esperas el ajuste de escala automático, puedes ajustar el valor mínimo de nodo para una conexión. Más se requieren nodos para procesar más transacciones para una conexión. Por el contrario, se requieren menos nodos si una conexión procesa menos transacciones. Para configurar los valores del nodo, haz lo siguiente:

• Si eres cliente de pago por uso, configura el valor mínimo y máximo de los nodos en la página de edición de la conexión.
• Si eres un cliente basado en suscripciones, comunícate con el equipo de asistencia.

La cantidad máxima de transacciones que un nodo puede controlar dependen de varios factores. Antes de ajustar la cantidad mínima de nodos para mejorar la capacidad de procesamiento, te recomendamos verificar si tus sistemas de backend están configurados de manera óptima para manejar el tráfico requerido.

Tipos de datos admitidos

A continuación, se indican los tipos de datos admitidos para este conector:

• BIGINT
• BINARY
• BIT
• BOOLEAN
• CHAR
• DATE
• DECIMAL
• DOUBLE
• FLOAT
• INTEGER
• LONGN VARCHAR
• LONG VARCHAR
• NCHAR
• NUMERIC
• NVARCHAR
• REAL
• SMALLINT
• TIME
• TIMESTAMP
• TINY INT
• VARBINARY
• VARCHAR

Acciones

Este conector admite la ejecución de las siguientes acciones:

• Procedimientos y funciones almacenados y definidos por el usuario. Si tienes algún procedimiento y función almacenados en tu backend, estos aparecerán en la columna Actions del diálogo Configure connector task.
• Consultas de SQL personalizadas. Para ejecutar consultas de SQL personalizadas, el conector proporciona la acción Ejecutar consulta personalizada.

  Para crear una consulta personalizada, sigue estos pasos:

  1. Sigue las instrucciones detalladas para agregar una tarea de conectores.
  2. Cuando configures la tarea del conector, en el tipo de acción que deseas realizar, selecciona Acciones.
  3. En la lista Acción, selecciona Ejecutar consulta personalizada y, luego, haz clic en Listo.

     

  4. Expande la sección Task input y, luego, haz lo siguiente:
     1. En el campo Tiempo de espera después, ingresa la cantidad de segundos que se debe esperar hasta que se ejecute la consulta.

        Valor predeterminado: 180 segundos.

     2. En el campo Cantidad máxima de filas, ingresa la cantidad máxima de filas que se mostrarán en la base de datos.

        Valor predeterminado: 25.

     3. Para actualizar la consulta personalizada, haz clic en Edit Custom Script (Editar secuencia de comandos personalizada). Se abrirá el diálogo Editor de secuencia de comandos.

        

     4. En el diálogo Editor de secuencia de comandos, ingresa la consulta en SQL y haz clic en Guardar.

        Puedes usar un signo de interrogación (?) en una instrucción de SQL para representar un parámetro único que debe especificarse en la lista de parámetros de consulta. Por ejemplo, la siguiente consulta de SQL selecciona todas las filas de la tabla Employees que coinciden con los valores especificados para la columna LastName:

        SELECT * FROM Employees where LastName=?

        Nota: Se admiten las declaraciones de lenguaje de manipulación de datos (DML) y lenguaje de definición de datos (DDL).
     5. Si usaste signos de interrogación en tu consulta en SQL, debes agregar el parámetro. Para ello, haz clic en + Agregar nombre del parámetro en cada signo de interrogación. Mientras se ejecuta la integración, estos parámetros reemplazan los signos de interrogación (?) en la consulta SQL de forma secuencial. Por ejemplo, si agregaste tres signos de interrogación (?), debes agregar tres parámetros en orden de secuencia.

        

        Para agregar parámetros de consulta, haz lo siguiente:

        1. En la lista Tipo, selecciona el tipo de datos del parámetro.
        2. En el campo Valor, ingresa el valor del parámetro.
        3. Para agregar varios parámetros, haz clic en + Agregar parámetro de consulta.

Usa Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de Terraform de muestra para crear conexiones, consulta la plantilla de muestra.

Cuando creas esta conexión con Terraform, debes configurar las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro	Tipo de datos	Obligatorio	Descripción
application_intent	STRING	Falso	La propiedad de la cadena de conexión del intent de la aplicación expresa la solicitud de la aplicación cliente para que se dirija a una versión de lectura y escritura o de solo lectura de una base de datos de grupos de disponibilidad. Para usar el enrutamiento de solo lectura, un cliente debe usar un intent de aplicación de solo lectura en la string de conexión cuando se conecte al objeto de escucha del grupo de disponibilidad. Sin el intent de aplicación de solo lectura, las conexiones al objeto de escucha del grupo de disponibilidad se dirigen a la base de datos en la réplica principal.
application_name	STRING	Falso	La propiedad de la cadena de conexión del nombre de la aplicación expresa el nombre de la aplicación cliente.
base de datos	STRING	Falso	Es el nombre de la base de datos de SQL Server.
encriptar	BOOLEAN	Falso	Este campo configura si SSL está habilitado.
enable_logging	ENUM	Falso	Habilita la verbosidad de los registros durante una conexión seleccionando un nivel entre 1 (menos detallado) y 5 (más detallado). Esta función puede ayudar a solucionar problemas relacionados con mensajes de error o algún otro comportamiento inesperado. Sin embargo, ten en cuenta que esta opción registrará todos los detalles de las comunicaciones entre el conector y el backend, incluidas las solicitudes, las respuestas y los certificados SSL. Por lo tanto, no se recomienda usar esta función en un entorno de producción en vivo. Los valores admitidos son: 1, 2, 3, 4, 5.
proxy_enabled	BOOLEAN	Falso	Selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión.
proxy_auth_scheme	ENUM	Falso	El tipo de autenticación que se utiliza para autenticarse en el proxy ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE.
proxy_user	STRING	Falso	Es un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password	SECRET	Falso	Una contraseña que se usará para autenticarse en el proxy ProxyServer.
proxy_ssltype	ENUM	Falso	Es el tipo de SSL que se usará para conectarse al proxy de ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.

Usa la conexión de SQL Server en una integración

Después de crear la conexión, estará disponible en la integración de Apigee y en la integración de aplicaciones. Puedes usar la conexión en una integración a través de la tarea Connectors.

• Para comprender cómo crear y usar la tarea Connectors en la integración de Apigee, consulta Tarea Connectors.
• Para comprender cómo crear y usar la tarea Connectors en la integración de aplicaciones, consulta Tarea Connectors.

Consulta también el instructivo Realiza operaciones CRUD en una base de datos de MySQL en la que se muestra cómo crear una conexión de MySQL y cómo usarla en una integración para realizar operaciones de lectura y escritura.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?

• Obtén información para suspender y reanudar una conexión.
• Aprende a supervisar el uso del conector.
• Aprende a ver los registros del conector.