Esta página foi traduzida pela API Cloud Translation.

Oracle DB (versão 2)

Com o conector do Oracle DB, é possível se conectar a uma instância do Oracle Database (versão 11.2 ou mais recente) e executar as operações de banco de dados compatíveis.

Antes de começar

Antes de usar o conector do Oracle DB, 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/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:

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"
Clique em + Criar novo para abrir a página Criar conexão.
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.
Na seção Detalhes da conexão, faça o seguinte:
1. Conector: selecione Oracle DB na lista suspensa de conectores disponíveis.
2. Versão do conector: selecione a versão 2 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. Opcionalmente, selecione Ativar o Cloud Logging para ativá-lo.
6. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
7. 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.
8. ServiceName: o nome do serviço do banco de dados Oracle.
9. DataSource: nome do Oracle Net Services, Connect Descriptor (também conhecido como TNS Connect String) ou uma nomenclatura de conexão fácil que identifica o banco de dados ao qual se conectar.
10. Opcionalmente, selecione Incluir sinônimos.
11. Tempo limite da conexão abandonada: digite o valor do tempo limite (em segundos) que especifica por quanto tempo uma conexão emprestada pode permanecer sem uso antes de ser considerada abandonada.
12. Tempo limite de conexão inativa: digite o valor do tempo limite de conexão (em segundos).
13. Tempo máximo de reutilização da conexão: insira o tempo de reutilização da conexão (em segundos).
14. Tempo limite de conexão TTL: digite o tempo máximo (em segundos) que a conexão pode permanecer em uso.
15. Esquemas navegáveis: insira os nomes de esquemas separados por vírgulas que serão usados ao buscar entidades e ações. Por exemplo, schemaA, schemaB, schemaC.
16. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
17. Clique em PRÓXIMA.
Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
1. Tipo de destino: selecione um Tipo de destino.
  - Selecione Endereço do host na lista para especificar o nome do host ou o endereço IP do destino.
  - Se você quiser estabelecer uma conexão particular com seus sistemas de back-end, selecione Anexo do endpoint na lista e escolha o anexo de endpoint necessário na lista Anexo do endpoint.
    Observação : para entender como criar um anexo de endpoint, consulte o anexo de serviço do PSC e o anexo de endpoint. Depois que você criar o anexo de endpoint, ele ficará visível na lista Anexo do endpoint.
  Se você quiser 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, em seguida, configure as regras de firewall para colocar na lista de permissões apenas os endereços IP estáticos específicos.
  
  Para inserir outros destinos, clique em +ADICIONAR DESTINO.
2. Clique em PRÓXIMA.
Na seção Autenticação, insira os detalhes da autenticação.
1. Selecione um Tipo de autenticação e insira os detalhes relevantes.
  Os seguintes tipos de autenticação são compatíveis com a conexão do Oracle DB:
  - Nome de usuário e senha
2. Clique em PRÓXIMA.
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: nome de usuário da conta da Oracle usada para autenticação
- Senha: o Secret Manager que contém a senha associada ao nome de usuário da conta da Oracle.

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:
- List
- Receber
- Criação
- Atualizar
- Excluir
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.

Limitações do sistema

O conector do Oracle DB pode processar no máximo 70 transações por segundo e por nó e limitar as transações acima desse limite. Por padrão, o Integration Connectors aloca dois nós para melhor disponibilidade para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Observação:o número de nós do Integration Connectors será escalonado automaticamente de maneira dinâmica com base no seu uso. No entanto, se você quiser reservar capacidade para grandes volumes sem esperar pelo escalonamento automático, ajuste o valor mínimo do nó para uma conexão. Mais nós são necessários para processar mais transações para uma conexão. Por outro lado, menos nós são necessários se uma conexão processa menos transações. Para configurar os valores do nó, faça o seguinte:

Se você for um cliente com pagamento por utilização, configure o valor mínimo e máximo do nó na página de edição de conexão.
Se você for um cliente com base em assinatura, entre em contato com o suporte.

O número máximo de transações que um nó pode processar depende de vários fatores. Portanto, antes de ajustar os nós mínimos para melhorar a capacidade, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

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

Ações

Com o conector Oracle DB, é possível executar procedimentos armazenados, funções e consultas SQL personalizadas no formato compatível com o banco de dados Oracle. Para executar consultas SQL personalizadas, o conector fornece a ação Executar consulta personalizada.

Para criar uma consulta personalizada, siga estas etapas:

Siga as instruções detalhadas para adicionar uma tarefa de conectores.
Ao configurar a tarefa do conector, selecione Ações no tipo de ação que será realizada.
Na lista Ação, selecione Executar consulta personalizada e clique em Concluído.
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.
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=?
```
  Observação:há suporte para as instruções da linguagem de manipulação de dados (DML) e da linguagem de definição de dados (DDL).
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.
  
  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.

Para entender como usar a ação de consulta personalizada, consulte os Exemplos de ação.

Exemplos de ação

Esta seção descreve como executar algumas das ações neste conector.

Exemplo: executar um grupo por consulta

Na caixa de diálogo Configurar tarefa do conector, selecione Ações.
Selecione a ação Executar consulta personalizada e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em Editar consulta personalizada. A caixa de diálogo Consulta personalizada é aberta.
Na caixa de diálogo Consulta personalizada, insira a consulta SQL abaixo e clique em Salvar:
```
      Select E.EMPLOYEE_ID, E.EMPLOYEE_NAME, E.CITY
      FROM EMPLOYEES E
      LEFT JOIN EMPLOYEE_DEPARTMENT ED ON E.EMPLOYEE_ID=ED.ID 
      WHERE E.EMPLOYEE_NAME = 'John'
      GROUP BY E.CITY,E.EMPLOYEE_ID,E.EMPLOYEE_NAME
    
```
Neste exemplo, selecionamos os registros de funcionários das tabelas EMPLOYEES e EMPLOYEE_DEPARTMENT. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá o conjunto de resultados da consulta.

Exemplo: executar uma consulta parametrizada

Na caixa de diálogo Configurar tarefa do conector, selecione Ações.
Selecione a ação Executar consulta personalizada e clique em Concluído.
Na seção Entrada de tarefa de Conectores, defina os seguintes valores para o campo:
1. Tempo limite após:10
2. Número máximo de linhas: 3
Clique em + Adicionar nome do parâmetro para inserir os seguintes valores:
1. Tipo: VARCHAR
2. Valor: John
Clique em Editar consulta personalizada. A caixa de diálogo Consulta personalizada é aberta.

Na caixa de diálogo Consulta personalizada, insira a consulta SQL abaixo e clique em Salvar:

  Select C.ID,C.NAME,C.CITY,C.O_DATE,E.EMPLOYEE_ID 
  FROM customqueries C,Employees E 
  WHERE C.ID=E.Employee_id and C.NAME=?

Este exemplo seleciona registros de funcionários em que o nome do funcionário é John. Observe que o nome do funcionário é parametrizado. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

[{
"NAME": "John",
"O_DATE": "2023-06-01 00:00:00.0",
"EMPLOYEE_ID": 1.0
}, {
"NAME": "John",
"O_DATE": "2021-07-01 00:00:00.0",
"EMPLOYEE_ID": 3.0
}, {
"NAME": "John",
"O_DATE": "2022-09-01 00:00:00.0",
"EMPLOYEE_ID": 4.0
}]

Exemplo: inserir um registro usando um valor de sequência

Na caixa de diálogo Configurar tarefa do conector, selecione Ações.
Selecione a ação Executar consulta personalizada e clique em Concluído.
Na caixa de diálogo Consulta personalizada, insira a consulta SQL abaixo e clique em Salvar:
```
  INSERT INTO AUTHOR(id,title) VALUES(author_table_id_seq.NEXTVAL,'Sample_book_title')
```

Este exemplo insere um registro na tabela AUTHOR usando um objeto de sequência author_table_id_seq atual. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

[{
}]

Exemplo: executar uma consulta com uma função agregada

Na caixa de diálogo Configurar tarefa do conector, selecione Ações.
Selecione a ação Executar consulta personalizada e clique em Concluído.
Na caixa de diálogo Consulta personalizada, insira a consulta SQL abaixo e clique em Salvar:
```
  SELECT SUM(SALARY) as Total FROM EMPLOYEES
  
```

Neste exemplo, calculamos o valor agregado de salários na tabela EMPLOYEES. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

[{
"TOTAL": 13000.0
}]

Exemplo: criar uma nova tabela

Na caixa de diálogo Configurar tarefa do conector, selecione Ações.
Selecione a ação Executar consulta personalizada e clique em Concluído.

Na caixa de diálogo Consulta personalizada, insira a consulta SQL abaixo e clique em Salvar:

    CREATE TABLE TEST1 (ID INT, NAME VARCHAR(40),DEPT VARCHAR(20),CITY VARCHAR(10))

Este exemplo cria a tabela TEST1. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:

[{
}]

Exemplos de operações de entidade

Exemplo: listar todos os funcionários

Este exemplo lista todos os funcionários na entidade Employee.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Employee na lista Entity.
Selecione a operação List e clique em Concluído.
Opcionalmente, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro.

Exemplo: acessar detalhes do funcionário

Este exemplo recebe os detalhes do funcionário cujo ID é 45, da entidade Employee.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Employee na lista Entity.
Selecione a operação Get e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em IdEntidade e insira 45 no campo Valor padrão.
Aqui, 45 é o valor da chave primária da entidade Employee.

Exemplo: criar um registro de funcionário

Neste exemplo, adicionamos um novo registro de funcionário à entidade Employee.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Employee na lista Entity.
Selecione a operação Create e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"EMPLOYEE_ID": 69.0,
"EMPLOYEE_NAME": "John",
"CITY": "Bangalore"
}
```
Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:
```
 {
"ROWID": "AAAoU0AABAAAc3hAAF"
}
```

Exemplo: atualizar um registro de funcionário

Este exemplo atualiza o registro do funcionário com o ID 69 na entidade Employee.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Employee na lista Entity.
Selecione a operação Update e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"EMPLOYEE_NAME": "John",
"CITY": "Mumbai"
}
```
Clique em entityId e insira 69 no campo Valor padrão.
Como alternativa, em vez de especificar o entityId, você também pode definir filterOverride como 69.

Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante ao seguinte:
```
{
}
```

Exemplo: excluir um registro de funcionário

Este exemplo exclui o registro do funcionário cujo ID é 35 na entidade Employee.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione Employee na lista Entity.
Selecione a operação Delete e clique em Concluído.
Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e digite 35 no campo Valor padrão.

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
service_name	STRING	Falso	O nome do serviço do banco de dados Oracle.
data_source	STRING	Falso	Nome do Oracle Net Services, descritor do Connect (também conhecido como string TNS Connect) ou uma nomenclatura de conexão fácil que identifica o banco de dados ao qual se conectar.
include_synonyms	BOOLEAN	Falso	Consultar metadados de sinônimos e disponibilizá-los como entidades. Definir a propriedade como falsa pode aumentar o desempenho dos metadados.
abandoned_connection_timeout	INTEGER	Falso	O tempo limite da conexão abandonada (em segundos) determina quanto tempo uma conexão pedida pode permanecer sem uso antes de ser considerada como abandonada e recuperada pelo pool de conexões.
inactive_connection_timeout	INTEGER	Falso	O tempo limite de conexão inativa (em segundos) determina quanto tempo uma conexão disponível permanece no pool de conexões antes de ser removida.
max_connection_reuse_time	INTEGER	Falso	O tempo máximo de reutilização da conexão (em segundos) especifica o tempo máximo que qualquer conexão pode ser reutilizada. Depois disso, o pool remove e encerra uma conexão.
ttl_connection_timeout	INTEGER	Falso	Tempo máximo (em segundos) que uma conexão pode permanecer em uso.
browsable_schemas	STRING	Falso	Esquemas separados por vírgula (por exemplo, SchemaA, SchemaB) a serem usados ao buscar entidades e ações para a conexão. Usa o esquema do usuário por padrão

Usar a conexão do Oracle DB 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

Entenda como suspender e retomar uma conexão.
Entenda como monitorar o uso do conector.
Saiba como acessar os registros do conector.