Cloud Spanner

Com o conector do Cloud Spanner, é possível executar operações de inserção, exclusão, atualização e leitura no banco de dados do Google Cloud Spanner.

Antes de começar

Antes de usar o conector do Cloud Spanner, realize as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/spanner.databaseUser

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acessar a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para acessar a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione Cloud Spanner na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 63 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    6. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    7. ID do projeto: o ID do projeto do Google Cloud em que a instância Spanner reside.
    8. Região do banco de dados: o nome da região em que a instância do Spanner está localizada.
    9. ID da instância: o ID da instância do Spanner a se conectar.
    10. Nome do banco de dados: o nome do banco de dados Spanner a se conectar.
    11. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    12. Clique em PRÓXIMA.
  5. Na seção Autenticação, insira os detalhes da autenticação.
    1. A conexão do Cloud Spanner não requer autenticação.
    2. Clique em PRÓXIMA.
  6. Revisão: revise os detalhes de conexão e autenticação.
  7. Clique em Criar.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não for compatível com nenhuma das operações da entidade, essas operações sem suporte não serão incluídas na lista de Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. Normalmente, uma ação tem alguns parâmetros de entrada e de saída. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Ações

Esse conector permite a execução das seguintes ações:

  • Funções e procedimentos armazenados definidos pelo usuário. Se você tiver procedimentos e funções armazenados no back-end, eles serão listados na coluna Actions da caixa de diálogo Configure connector task.
  • Consultas SQL personalizadas. Para executar consultas SQL personalizadas, o conector fornece a ação Executar consulta personalizada.

    Para criar uma consulta personalizada, siga estas etapas:

    1. Siga as instruções detalhadas para adicionar uma tarefa de conectores.
    2. Ao configurar a tarefa do conector, selecione Ações no tipo de ação que será realizada.
    3. Na lista Ação, selecione Executar consulta personalizada e clique em Concluído.

      imagem mostrando execute-custom-query-action imagem mostrando execute-custom-query-action

    4. Expanda a seção Task input e faça o seguinte:
      1. No campo Tempo limite após, insira o número de segundos de espera até a execução da consulta.

        Valor padrão: 180 segundos.

      2. No campo Número máximo de linhas, digite o número máximo de linhas a serem retornadas do banco de dados.

        Valor padrão: 25.

      3. Para atualizar a consulta personalizada, clique em Editar script personalizado. A caixa de diálogo Editor de script é aberta.

        imagem mostrando custom-sql-query imagem mostrando custom-sql-query

      4. Na caixa de diálogo Editor de script, insira a consulta SQL e clique em Salvar.

        Você pode usar um ponto de interrogação (?) em uma instrução SQL para representar um único parâmetro que deve ser especificado na lista de parâmetros de consulta. Por exemplo, a consulta SQL a seguir seleciona todas as linhas da tabela Employees que correspondem aos valores especificados para a coluna LastName:

        SELECT * FROM Employees where LastName=?

      5. Se você usou pontos de interrogação na consulta SQL, adicione o parâmetro clicando em + Adicionar nome do parâmetro em cada ponto de interrogação. Ao executar a integração, esses parâmetros substituem os pontos de interrogação (?) na consulta SQL sequencialmente. Por exemplo, se você adicionou três pontos de interrogação (?), adicione três parâmetros em ordem de sequência.

        imagem mostrando add-query-param imagem mostrando add-query-param

        Para adicionar parâmetros de consulta, faça o seguinte:

        1. Na lista Tipo, selecione o tipo de dados do parâmetro.
        2. No campo Valor, insira o valor do parâmetro.
        3. Para adicionar vários parâmetros, clique em + Adicionar parâmetro de consulta.

Tipos de dados compatíveis

Veja a seguir os tipos de dados compatíveis com este conector:

  • BIGINT
  • Binário
  • BIT
  • BOOLEAN
  • CHAR
  • DATE
  • DECIMAL
  • DOUBLE
  • FLOAT
  • INTEGER
  • LONGN VARCHAR
  • VARCHAR LONGO
  • NCHAR
  • NUMERIC
  • NVARCHAR
  • REAL
  • INTEGRIDADE PEQUENA
  • TEMPO
  • TIMESTAMP
  • TINY INT
  • VARBINARY
  • VARCHAR

Usar o Terraform para criar conexões

É possível usar o recurso do Terraform para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Para conferir um exemplo de modelo do Terraform para a criação de conexões, consulte Exemplo de modelo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
project_id STRING Verdadeiro O ID do projeto do Google Cloud em que a instância do Spanner reside.
database_region STRING Verdadeiro O nome da região em que a instância do Spanner reside.
instance_id STRING Verdadeiro O ID da instância do Spanner a ser conectada.
database_name STRING Verdadeiro O nome do banco de dados do Spanner para se conectar.
database_dialect ENUM Verdadeiro Especifique o tipo de dialeto do banco de dados do banco de dados do Spanner. Os valores aceitos são: GoogleStandardSQL, PostgreSQL

Usar a conexão do Cloud Spanner em uma integração

Depois que você cria a conexão, ela fica disponível na Apigee Integration e no Application Integration. É possível usar a conexão em uma integração por meio da tarefa "Conectores".

  • Para entender como criar e usar a tarefa "Conectores" na integração da Apigee, consulte a Tarefa "Conectores".
  • Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir