Redshift

El conector de Redshift te permite realizar operaciones de inserción, eliminación, actualización y lectura en la base de datos de Redshift.

Antes de empezar

Antes de usar el conector de Redshift, haz lo siguiente:

  • En tu proyecto de Google Cloud:
    • Asegúrate de que la conectividad de red esté configurada. Para obtener información sobre los patrones de red, consulta Conectividad de red.
    • Concede el rol de gestión de identidades y accesos roles/connectors.admin al usuario que configure el conector.
    • Concede los siguientes roles de gestión de identidades y accesos a la cuenta de servicio que quieras usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo especial de cuenta de Google diseñada para representar a un usuario no humano que necesita autenticarse y disponer de autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crearla. El conector y la cuenta de servicio deben pertenecer al mismo proyecto. Para obtener más información, consulta el artículo Crear una cuenta de servicio.

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

      Para saber cómo habilitar servicios, consulta Habilitar servicios.

    Si estos servicios o permisos no se han habilitado en tu proyecto anteriormente, se te pedirá que los habilites al configurar el conector.

Configurar el conector

Una conexión es específica de una fuente de datos. Esto significa que, si tiene muchas fuentes de datos, debe crear una conexión independiente para cada una de ellas. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Integration Connectors > Connections (Conectores de integración > Conexiones) y, a continuación, selecciona o crea un proyecto de Google Cloud.

    Ve a la página Conexiones.

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

      Para ver la lista de todas las regiones admitidas, consulta Ubicaciones.

    2. Haz clic en SIGUIENTE.
  4. En la sección Detalles de la conexión, haz lo siguiente:
    1. Conector: selecciona Redshift en la lista desplegable de conectores disponibles.
    2. Versión del conector: seleccione la versión del conector en la lista desplegable de versiones disponibles.
    3. En el campo Connection Name (Nombre de conexión), introduce un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir los siguientes criterios:

      • Los nombres de conexión pueden contener letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de conexión deben empezar por una letra y terminar por una letra o un número.
      • Los nombres de conexión no pueden tener más de 49 caracteres.
    4. Si quiere, puede introducir una Descripción para la instancia de conexión.
    5. También puedes habilitar Registro en la nube y, a continuación, seleccionar un nivel de registro. De forma predeterminada, el nivel de registro es Error.
    6. Cuenta de servicio: selecciona una cuenta de servicio que tenga los roles necesarios.
    7. Si quieres, configura los ajustes del nodo de conexión:

      • Número mínimo de nodos: introduce el número mínimo de nodos de conexión.
      • Número máximo de nodos: introduce el número máximo de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se necesitan más nodos para procesar más transacciones en una conexión y, a la inversa, se necesitan menos nodos para procesar menos transacciones. Para saber cómo influyen los nodos en el precio de tu conector, consulta la sección Precios de los nodos de conexión. Si no introduces ningún valor, de forma predeterminada, el número mínimo de nodos se establece en 2 (para mejorar la disponibilidad) y el máximo en 50.

    8. Base de datos: el nombre de la base de datos de Amazon Redshift.
    9. Creación automática: especifica "true" para crear un usuario de base de datos con el nombre especificado en User si no existe al conectarse con las credenciales de gestión de identidades y accesos. Consulta AuthScheme .
    10. Grupos de la base de datos: lista delimitada por comas de los nombres de uno o varios grupos de la base de datos a los que se une el usuario de la base de datos en la sesión actual al conectarse con credenciales de gestión de identidades y accesos. Consulta AuthScheme .
    11. BrowsableSchemas esta propiedad restringe los esquemas de los que se informa a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
    12. Esquemas ignorados: filtro de restricción de visibilidad que se usa para ocultar la lista de esquemas mediante consultas de metadatos. Por ejemplo, 'information_schema, pg_catalog'. En los nombres de los esquemas se distingue entre mayúsculas y minúsculas.
    13. Include Table Types: si se define como true, el proveedor consultará los tipos de tablas y vistas individuales.
    14. Eliminar nulos: si se define, los caracteres nulos se eliminan de los valores de caracteres en operaciones masivas.
    15. Visibilidad: restricciones de visibilidad que se usan para filtrar los metadatos expuestos de las tablas con privilegios concedidos al usuario actual. Por ejemplo, el filtro "SELECT,INSERT" restringe la visibilidad de los metadatos solo a las tablas a las que puede acceder el usuario actual para las operaciones SELECT e INSERT. Los valores de privilegio admitidos son SELECT, INSERT, UPDATE, DELETE y REFERENCES.
    16. (Opcional) En la sección Configuración avanzada, marca la casilla Usar proxy para configurar un servidor proxy para la conexión y define los siguientes valores:
      • Esquema de autenticación de proxy: selecciona el tipo de autenticación para autenticarte con el servidor proxy. Se admiten los siguientes tipos de autenticación:
        • Básica: autenticación HTTP básica.
        • Digest: autenticación HTTP Digest.
      • Usuario proxy: nombre de usuario que se usará para autenticar el servidor proxy.
      • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
      • Tipo de SSL de proxy: el tipo de SSL que se debe usar al conectarse al servidor proxy. Se admiten los siguientes tipos de autenticación:
        • Automático: es el ajuste predeterminado. Si la URL es una URL HTTPS, se usa la opción Tunnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
        • Siempre: la conexión siempre tiene habilitado SSL.
        • Nunca: la conexión no tiene habilitado el protocolo SSL.
        • Túnel: la conexión se realiza a través de un proxy de tunelización. 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 Servidor proxy, introduce los detalles del servidor proxy.
        1. Haga clic en + Añadir destino.
        2. Selecciona un Tipo de destino.
          • Dirección de host: especifica el nombre de host o la dirección IP del destino.

            Si quieres establecer una conexión privada con tu sistema backend, haz lo siguiente:

    17. También puedes hacer clic en + AÑADIR ETIQUETA para añadir una etiqueta a la conexión en forma de par clave-valor.
    18. Haz clic en SIGUIENTE.
  5. En la sección Destinations (Destinos), introduce los detalles del host remoto (sistema backend) al que quieras conectarte.
    1. Tipo de destino: selecciona un Tipo de destino.
      • Para especificar el nombre de host o la dirección IP de destino, selecciona Dirección de host y introduce la dirección en el campo Host 1.
      • Para establecer una conexión privada, selecciona Endpoint attachment (Endpoint adjunto) y elige el adjunto que quieras de la lista Endpoint Attachment (Endpoint adjunto).

      Si quieres establecer una conexión pública con tus sistemas backend con seguridad adicional, puedes configurar direcciones IP de salida estáticas para tus conexiones y, a continuación, configurar las reglas de tu cortafuegos para que solo se permitan las direcciones IP estáticas específicas.

      Para introducir más destinos, haga clic en +AÑADIR DESTINO.

    2. Haz clic en SIGUIENTE.
  6. En la sección Autenticación, introduce los detalles de autenticación.
    1. Seleccione un Tipo de autenticación e introduzca los detalles pertinentes.

      La conexión de Redshift admite los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña
    2. Para saber cómo configurar estos tipos de autenticación, consulta Configurar la autenticación.

    3. Haz clic en SIGUIENTE.
  7. Revisar: revisa los detalles de la conexión y la autenticación.
  8. Haz clic en Crear.

Configurar la autenticación

Introduce los detalles en función de la autenticación que quieras usar.

  • Nombre de usuario y contraseña
    • Nombre de usuario: nombre de usuario del conector.
    • Contraseña: secreto de Secret Manager que contiene la contraseña asociada al conector.

Ejemplos de configuración de conexiones

En esta sección se indican los valores de ejemplo de los distintos campos que se configuran al crear la conexión de Redshift.

Tipo de conexión de autenticación básica

En la siguiente tabla se indican los valores de ejemplo de los distintos campos que se configuran al crear la conexión de Redshift.

Campo Valor de muestra
Región us-central1
Conector Conector de Redshift
Versión del conector 1
Nombre del conector google-cloud-redshiftdb-basicauth-conn
Cuenta de servicio SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Base de datos dev
BrowsableSchemas public,test
Grupos de Db N/A
Eliminar nulos
Visibilidad SELECT,INSERT
Número mínimo de nodos 02
Número máximo de nodos 50
Dirección del host redshift-cluster-xxx-integration.HOST_NAME.us-east-1.redshift.amazonaws.com
Autenticación Contraseña de usuario
Nombre de usuario NOMBRE DE USUARIO
Contraseña CONTRASEÑA
Versión 1

Entidades, operaciones y acciones

Todos los conectores de integración 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 te muestra como entidades, operaciones y acciones.

  • Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

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

  • Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

  • Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Limitaciones del sistema

El conector Redshift puede procesar 3 transacciones por segundo, por nodo, y limita las transacciones que superen este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para mejorar la disponibilidad) a una conexión.

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

Ejemplos de acciones

Ejemplo: buscar el valor mayor

En este ejemplo se muestra cómo ejecutar una función definida por el usuario. La función find_greater de este ejemplo compara dos números enteros y devuelve el que es mayor.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Seleccione la acción find_greater y, a continuación, haga clic en Hecho.
  3. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:
    {
    "$1": 1.0,
    "$2": 5.0
    }
  4. Si la ejecución de la acción se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
    "bignum": 5.0
    }]

Ejemplos de operaciones de entidades

Ejemplo: listar los registros de una entidad

En este ejemplo se muestran los registros de la entidad Users.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Users en la lista Entity.
  3. Selecciona la operación List y, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, puede definir el filterClause según sus necesidades.

    Por ejemplo, si se define la cláusula de filtro como employeeCode='5100' and startDate='2010-01-01 00:00:00', solo se mostrarán los registros cuyo valor de employeeCode sea 5100 y cuyo valor de startDate sea 2010-01-01 00:00:00.

Ejemplo: Obtener un solo registro de una entidad

En este ejemplo, se obtiene un registro de la entidad Users.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona User en la lista Entity.
  3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 103032 en el campo Valor predeterminado.

    En este caso, 103032 es el valor de clave principal de la entidad Users.

Ejemplo: eliminar un registro de una entidad

En este ejemplo se elimina un registro de la entidad Users.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Users en la lista Entity.
  3. Selecciona la operación Delete y, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 113132 en el campo Valor predeterminado.

    Si la entidad tiene claves primarias compuestas en lugar de especificar el entityId, puedes definir el filterClause. Por ejemplo, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

Ejemplo: Crear un registro en una entidad

En este ejemplo, se crea un registro en la entidad Users.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Users en la lista Entity.
  3. Selecciona la operación Create y, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:
    {
    "employeeCode": "5100",
    "startDate": "2010-01-01 00:00:00.0",
    "country": "US"
    }
  5. Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá la respuesta de la operación de creación.

Ejemplo: actualizar un registro de una entidad

En este ejemplo se actualiza un registro de la entidad Users.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Users en la lista Entity.
  3. Selecciona la operación Update y, a continuación, haz clic en Hecho.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en connectorInputPayload y, a continuación, introduce un valor similar al siguiente en el campo Default Value:
    {
    "country": "IN"
    }
  5. En la sección Entrada de tarea de la tarea Conectores, haga clic en entityId y, a continuación, introduzca 113132 en el campo Valor predeterminado.

    Si la entidad tiene claves primarias compuestas en lugar de especificar el entityId, puedes definir el filterClause. Por ejemplo, employeeCode='5100' and startDate='2010-01-01 00:00:00'.

  6. Si la integración se realiza correctamente, el campo connectorOutputPayload de la tarea del conector tendrá la respuesta de la operación de actualización.

Crear conexiones con Terraform

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

Para saber cómo aplicar o quitar una configuración de Terraform, consulta Comandos básicos de Terraform.

Para ver una plantilla de Terraform de ejemplo para crear una conexión, consulta la plantilla de ejemplo.

Cuando crees esta conexión con Terraform, debes definir las siguientes variables en el archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Obligatorio Descripción
base de datos STRING Verdadero Nombre de la base de datos de Amazon Redshift.
browsable_schemas STRING Falso Esta propiedad restringe los esquemas registrados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
db_groups STRING Falso Lista delimitada por comas de los nombres de uno o varios grupos de bases de datos a los que se une el usuario de la base de datos en la sesión actual al conectarse con credenciales de gestión de identidades y accesos. Consulta AuthScheme .
ignored_schemas STRING Falso Filtro de restricción de visibilidad que se usa para ocultar la lista de esquemas mediante consultas de metadatos. Por ejemplo, 'information_schema, pg_catalog'. En los nombres de los esquemas se distingue entre mayúsculas y minúsculas.
include_table_types BOOLEAN Falso Si se le asigna el valor true, el proveedor consultará los tipos de tablas y vistas individuales.
strip_out_nulls BOOLEAN Falso Cuando se establece, los caracteres nulos se eliminan de los valores de caracteres en operaciones masivas.
visibility STRING Falso Restricciones de visibilidad usadas para filtrar los metadatos expuestos de las tablas a las que se han concedido privilegios al usuario actual. Por ejemplo, el filtro "SELECT,INSERT" restringe la visibilidad de los metadatos solo a las tablas a las que puede acceder el usuario actual para las operaciones SELECT e INSERT. Los valores de privilegio admitidos son SELECT, INSERT, UPDATE, DELETE y REFERENCES.

Usar la conexión de Redshift en una integración

Una vez que hayas creado la conexión, estará disponible tanto en Apigee Integration como en Application Integration. Puedes usar la conexión en una integración a través de la tarea Conectores.

  • Para saber cómo crear y usar la tarea Conectores en la integración de Apigee, consulta Tarea Conectores.
  • Para saber cómo crear y usar la tarea Conectores en Application Integration, consulta Tarea Conectores.

Obtener ayuda de la comunidad de Google Cloud

Puedes publicar tus preguntas y hablar sobre este conector en la comunidad de Google Cloud, en los foros de Cloud.

Siguientes pasos