MySQL
O conector do MySQL permite inserir, ler, atualizar e excluir linhas em um banco de dados do MySQL.
Versões compatíveis
Versões do MySQL 5.0 a 8.0
Antes de começar
Antes de usar o conector do MySQL, realize as seguintes tarefas:
- No seu projeto do Google Cloud, faça o seguinte:
- Conceda a função IAM roles/connectors.admin ao usuário que está configurando o conector.
- Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
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:
- Clique em + CRIAR NOVO para abrir a página Criar conexão.
- Na seção Local, escolha o local da conexão.
- Na lista Região, selecione a região em que você quer criar a conexão.
Para conferir a lista de todas as regiões com suporte, consulte Locais.
- Clique em Próxima.
- Na lista Região, selecione a região em que você quer criar a conexão.
- Na seção Detalhes da conexão, insira os seguintes detalhes:
- Na lista Conector, selecione MySQL (pré-lançamento).
- Na lista Versão do conector, selecione a versão.
- 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:
- Use letras, números ou hifens.
- As letras precisam ser minúsculas.
- Os nomes precisam começar com uma letra e terminar com uma letra ou um número.
- Os nomes não podem ter mais de 49 caracteres.
- Opcional: no campo Descrição, adicione uma descrição da instância de conexão.
- Opcional: ative o Cloud Logging.
- Na lista Conta de serviço, selecione uma conta que tenha os papéis necessários.
- No campo Nome do banco de dados, insira o nome do banco de dados MySQL.
- 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.
- Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
-
Esquema de autenticação de proxy: selecione o tipo de autenticação para autenticar com o servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
- Básico: autenticação HTTP básica.
- Resumo: autenticação HTTP de resumo.
- Usuário proxy: um nome de usuário a ser usado para autenticar com o servidor proxy.
- Senha de proxy: a chave secreta do Secret Manager da senha do usuário.
-
Tipo de SSL de proxy: o tipo de SSL a ser usado para se conectar ao servidor proxy. Há compatibilidade com os seguintes tipos de autenticação:
- Automático: configuração padrão. Se o URL for HTTPS, a opção Túnel será usada. Se o URL for HTTP, a opção NUNCA será usada.
- Sempre: a conexão será sempre com SSL ativado.
- Nunca: a conexão não está com SSL ativado.
- Túnel: a conexão é feita por um proxy de encapsulamento. O servidor proxy abre uma conexão com o host remoto e o tráfego flui de ida e volta pelo proxy.
- Na seção Servidor proxy, insira os detalhes do servidor proxy.
- Clique em + Adicionar destino.
- Selecione um Tipo de destino.
- Endereço do host: especifique o nome do host ou o endereço IP do destino.
Se quiser estabelecer uma conexão privada com seu sistema de back-end, faça o seguinte:
- Crie um anexo do serviço PSC.
- Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
- Endereço do host: especifique o nome do host ou o endereço IP do destino.
- Opcional: para adicionar um rótulo à conexão, clique em + Adicionar rótulo.
- Clique em Próxima.
- Na seção Destinos, insira detalhes do host remoto (sistema de back-end) a que você quer se conectar.
- Na lista Tipo de destino, selecione um endereço de host.
- Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
- Para estabelecer uma conexão particular com seus sistemas de back-end, Selecione Anexo de endpoint na lista e depois selecione o anexo de endpoint necessário. na lista Endpoint Attachment.
Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.
Para inserir outros destinos, clique em + Adicionar destino.
- Clique em Próxima.
- Na lista Tipo de destino, selecione um endereço de host.
- Na seção Autenticação, é possível fornecer as credenciais:
- No campo Nome de usuário, digite o nome de usuário do MySQL para a conexão.
- No campo Senha, insira o secret do Secret Manager
que contém a senha associada ao nome de usuário do MySQL.
- Se você tiver criado um secret anteriormente e não estiver disponível na lista, selecione Inserir secret manualmente. Na caixa de diálogo Adicionar um secret por ID do recurso, copie e cole o ID do recurso do Gerenciador de secrets.
- Para usar a versão mais recente, copie e cole o ID do recurso do secret pai, no formato:
"projects/project-number/secrets/secret-name"
- Para selecionar uma versão específica, copie e cole o código do recurso para essa versão específica, no formato
"projects/project-number/secrets/secret-name/versions/1"
Para adicionar o secret, clique em Adicionar secret.
- Para usar a versão mais recente, copie e cole o ID do recurso do secret pai, no formato:
- Se você não tiver criado um secret para uso com o MySQL, clique em Criar
novo secret. Na caixa de diálogo Criar secret, insira os seguintes detalhes:
- No campo Nome, insira o nome do secret.
- No campo Valor do secret, insira o conteúdo do secret ou faça upload de um arquivo que o contenha.
- Clique em Criar secret.
- Se você tiver criado um secret anteriormente e não estiver disponível na lista, selecione Inserir secret manualmente. Na caixa de diálogo Adicionar um secret por ID do recurso, copie e cole o ID do recurso do Gerenciador de secrets.
- Na lista Versão do secret, selecione a versão do secret Senha na lista de versões disponíveis no menu suspenso.
- Clique em Próxima.
- Na seção Revisão, revise os detalhes de conexão e autenticação.
- Clique em Criar.
Configurar a autenticação
Digite os detalhes com base na autenticação que você quer usar.
-
Nome de usuário e senha
- Nome de usuário: o nome de usuário do MySQL a ser usado para a conexão.
- Senha: o Secret do Secret Manager que contém a senha associada ao nome de usuário do MySQL.
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 oferecer suporte a nenhuma das operações da entidade, como as operações não estão listadas na lista
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,
. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista
Actions
estará vazia.
Limitações do sistema
O conector do MySQL pode processar 10 transações por segundo, por nó, e throttles as transações além desse limite. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.
Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.
Tipos de dados compatíveis
Confira a seguir os tipos de dados compatíveis com esse conector:
- BIGINT
- Binário
- BIT
- BOOLEAN
- CHAR
- DATE
- DECIMAL
- DOUBLE
- FLOAT
- INTEGER
- LONGN VARCHAR
- LONG VARCHAR
- NCHAR
- NUMERIC
- NVARCHAR
- REAL
- INTEGRIDADE PEQUENA
- TIME
- TIMESTAMP
- TINY INT
- VARBINARY
- VARCHAR
Usar o Terraform para criar conexões
Use 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 criação de conexão, 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 |
---|---|---|---|
database_name | STRING | Verdadeiro | O nome do banco de dados Mysql ao qual se conectar. |
proxy_enabled | BOOLEAN | Falso | Marque esta caixa de seleção para configurar um servidor proxy para a conexão. |
proxy_auth_scheme | ENUM | Falso | O tipo de autenticação a ser usado para autenticar o proxy do ProxyServer. Os valores aceitos são: BASIC, DIGEST, NONE |
proxy_user | STRING | Falso | Um nome de usuário a ser usado para autenticar o proxy do ProxyServer. |
proxy_password | SECRET | Falso | Uma senha a ser usada para autenticação no proxy ProxyServer. |
proxy_ssltype | ENUM | Falso | O tipo de SSL a ser usado na conexão com o proxy ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, TUNNEL |
Ações
Esse conector oferece suporte à 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álogoConfigure connector task
. - Consultas SQL personalizadas. Para executar consultas SQL personalizadas, o conector fornece a ação Executar consulta personalizada.
Para criar uma consulta salva, siga estas etapas:
- Siga as instruções detalhadas para adicionar uma tarefa de conectores.
- Quando você configurar a tarefa do conector, selecione Ações no tipo de ação que você quer realizar.
- Na lista Ação, selecione Executar consulta personalizada e clique em Concluído.
- Expanda a seção Entrada de tarefas e faça o seguinte:
- No campo Tempo limite após, digite o número de segundos de espera até que a consulta seja executada.
Valor padrão:
180
segundos - 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
. - Para atualizar a consulta personalizada, clique em Editar script personalizado. A caixa de diálogo Editor de script é aberta.
- Na caixa de diálogo Editor de script, insira a consulta SQL e clique em Salvar.
É possível usar um ponto de interrogação (?) em uma instrução SQL para representar um único parâmetro que precisa ser especificado na lista de parâmetros de consulta. Por exemplo, a seguinte consulta SQL seleciona todas as linhas da tabela
Employees
que correspondem aos valores especificados na colunaLastName
:SELECT * FROM Employees where LastName=?
- Se você usou pontos de interrogação na consulta SQL, adicione o parâmetro clicando em + Adicionar nome do parâmetro para 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ê tiver adicionado três pontos de interrogação (?), deverá adicionar três parâmetros em ordem de sequência.
Para adicionar parâmetros de consulta, faça o seguinte:
- Na lista Tipo, selecione o tipo de dados do parâmetro.
- No campo Valor, insira o valor do parâmetro.
- Para adicionar vários parâmetros, clique em + Adicionar parâmetro de consulta.
- No campo Tempo limite após, digite o número de segundos de espera até que a consulta seja executada.
Exemplos de ação
Exemplo: encontrar o maior valor
Este exemplo mostra como executar uma função definida pelo usuário. O find_greater
neste exemplo, compara dois números inteiros e retorna o número inteiro que é maior.
- Na caixa de diálogo
Configure connector task
, clique emActions
. - Selecione a ação
find_greater
e clique em Concluído. - Na seção Entrada da tarefa da tarefa Connectors, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campoDefault Value
:{ "$1": 1.0, "$2": 5.0 }
Se a execução da ação for bem-sucedida, o campo connectorOutputPayload
da tarefa do conector terá um valor semelhante a este:
[{ "bignum": 5.0 }]
Exemplos de operações de entidade
Exemplo: listar registros de uma entidade
Este exemplo lista os registros da entidade Users
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
Users
na listaEntity
. - Selecione a operação
List
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, você pode definir o
filterClause de acordo com sua exigência.
Por exemplo, definir a cláusula de filtro como
employeeCode='5100' and startDate='2010-01-01 00:00:00'
lista apenas os registros com employeeCode 5100 e startDate 2010-01-01 00:00:00.
Exemplo: extrair um único registro de uma entidade
Este exemplo busca um registro da entidade Users
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
User
na listaEntity
. - Selecione a operação
Get
e clique em Concluído. - Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e
digite
103032
no campo Valor padrão.Aqui,
103032
é o valor da chave primária da entidadeUsers
.
Exemplo: excluir um registro de uma entidade
Este exemplo exclui um registro da entidade Users
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
Users
na listaEntity
. - Selecione a operação
Delete
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em entityId e
e insira
113132
no campo Valor padrão.Como alternativa, se a entidade tiver chaves primárias compostas em vez de especificar o entityId, você poderá definir a filterClause. Por exemplo,
employeeCode='5100' and startDate='2010-01-01 00:00:00'
.
Exemplo: criar um registro em uma entidade
Este exemplo cria um registro na entidade Users
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
Users
na listaEntity
. - Selecione a operação
Create
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "employeeCode": "5100", "startDate": "2010-01-01 00:00:00.0", "country": "US" }
Se a integração for bem-sucedida, o campo connectorOutputPayload
da tarefa do conector vai
ter a resposta da operação de criação.
Exemplo: atualizar um registro em uma entidade
Este exemplo atualiza um registro na entidade Users
.
- Na caixa de diálogo
Configure connector task
, clique emEntities
. - Selecione
Users
na listaEntity
. - Selecione a operação
Update
e clique em Concluído. - Na seção Entrada de tarefa da tarefa Conectores, clique em
connectorInputPayload
e insira um valor semelhante ao seguinte no campo CampoDefault Value
:{ "country": "IN" }
- Na seção Entrada da tarefa da tarefa Connectors, clique em entityId e
digite
113132
no campo Valor padrão.Como alternativa, se a entidade tiver chaves primárias compostas em vez de especificar o entityId, você poderá definir a filterClause. Por exemplo,
employeeCode='5100' and startDate='2010-01-01 00:00:00'
.
Se a integração for bem-sucedida, o campo connectorOutputPayload
da tarefa do conector terá
a resposta da operação de atualização.
Usar a conexão do MySQL em uma integração
Depois de criar a conexão, ela fica disponível na integração da Apigee e na integração do aplicativo. É possível usar a conexão em uma integração pela tarefa de conectores.
- Para entender como criar e usar a tarefa "Connectors" na integração da Apigee, consulte Tarefa Connectors.
- Para entender como criar e usar a tarefa Conectores no Application Integration, consulte Tarefa Conectores.
Consulte também o tutorial Executar operações CRUD em um banco de dados MySQL, que mostra como criar uma conexão MySQL e usá-la em uma integração para executar operações de leitura e gravação.
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
- Entenda como suspender e retomar uma conexão.
- Entenda como monitorar o uso do conector.
- Saiba como acessar os registros do conector.