Couchbase

O conector do Couchbase permite que você se conecte a uma instância de banco de dados do Couchbase e execute as operações compatíveis.

Antes de começar

Antes de usar o conector do Couchbase, faça o seguinte:

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.
Acesse 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 Couchbase 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. Permitir parâmetros JSON: permite que o JSON bruto seja usado nos parâmetros quando o QueryPassthrough estiver ativado.
8. Porta do Google Analytics: a porta para se conectar ao endpoint do Google Analytics do Couchbase.
9. Separador filho: os caracteres usados para indicar tabelas filhas.
10. Serviço do Couchbase: determina o serviço do Couchbase ao qual se conectar. O padrão é N1QL. As opções disponíveis são N1QL e Analytics.
11. Criar cota de RAM da tabela: a cota de RAM padrão, em megabytes, para usar ao inserir buckets por meio da sintaxe CREATE TABLE.
12. Separador de dados: o caractere ou os caracteres usados para indicar diversas informações e escopos/coleções do Google Analytics.
13. Separador de sabor: o caractere ou caracteres usados para indicar variações.
14. Porta N1QL: a porta para se conectar ao endpoint Couchbase N1QL.
15. Separador de períodos: o caractere ou os caracteres usados para indicar a hierarquia.
16. Tempo limite de execução de consulta: define o tempo limite do lado do servidor para a consulta, que determina quanto tempo o Couchbase executará a consulta antes de retornar um erro de tempo limite.
17. Comparação estrita: ajusta a precisão da conversão de filtros em consultas de entrada SQL em consultas do Couchbase. É possível usar uma lista de valores separados por vírgulas, em que cada valor pode ser: data, número, booleano ou string.
18. Durabilidade da transação: especifica como um documento precisa ser armazenado para que uma transação seja bem-sucedida. Especifica se serão usadas transações N1QL ao executar consultas.
19. Tempo limite da transação: define o tempo que uma transação pode ser executada antes de expirar para o Couchbase.
20. Usar coleções para DDL: se quiser que as instruções CREATE TABLE usem coleções em vez de variações. Só tem efeito quando você se conecta ao Couchbase v7+ e o GenerateSchemaFiles está definido como OnCreate.
21. Usar transações: especifica se é necessário usar transações N1QL ao executar consultas.
22. Validar parâmetros JSON: permite que o provedor verifique se os parâmetros da string são JSON válidos antes de enviar a consulta para o Couchbase.
23. Usar proxy: marque esta caixa de seleção para configurar um servidor proxy para a conexão e defina os seguintes valores:
24. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
25. 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.
  1. No campo Endereço do host, especifique o nome do host ou o endereço IP do destino.
    1. Se você quiser estabelecer uma conexão privada com seus sistemas de back-end, siga estas etapas:
      1. Crie um anexo do serviço PSC.
      2. Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
    2. 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.
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 oferecem suporte à conexão do Couchbase:
  - 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 para o conector
- Senha: a senha do Secret Manager que contém a senha associada ao conector.
- UseSSL: este campo define se o SSL está ativado.
- SSLServerCert: SSLServerCert para o conector Couchbase
- Esquema de autenticação: esquema de autenticação do conector do Couchbase.
- Modo de conexão: determina como se conectar ao servidor Couchbase. Precisa ser Direct ou Cloud. Para Cloud, o SSL é obrigatório. Para mais informações, consulte Conexões seguras com TLS.
- Servidor DNS: determina qual servidor DNS usar ao recuperar as informações do Couchbase Cloud. Por exemplo, 8.8.8.8.

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
- Criar
- 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 oferecer suporte a nenhuma das operações da entidade, essas operações não serã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. 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 é compatível com as seguintes ações:

Procedimentos e funções 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. Depois de configurar a tarefa do conector, selecione Ações no tipo de ação que você quer realizar.
3. Na lista Ação, selecione Executar consulta personalizada e clique em Concluído.
4. Expanda a seção Entrada de tarefas e faça o seguinte:
  1. 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.
  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 consulta personalizada. 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.
    É 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 coluna LastName:
```
SELECT * FROM Employees where LastName=?
```
    Observação:há suporte para as instruções de linguagem de manipulação de dados (DML) e de 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 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:
    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.

Limitações do sistema

O conector do Couchbase pode processar 25 transações por segundo, por nó, e limitar todas 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.

Observação:o número de nós dos conectores de integração será escalonado automaticamente 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. São necessários mais nós para processar mais transações para uma conexão. Por outro lado, menos nós serão necessários se uma conexão processar menos transações. Para configurar os valores do nó, faça o seguinte:

Se você for um cliente de 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ê é um cliente de 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 de processamento, verifique se os sistemas de back-end estão configurados de maneira ideal para lidar com o tráfego necessário.

Ações

Nesta seção, listamos as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ação.

Observação:os resultados de todas as ações vão estar disponíveis como uma resposta JSON no parâmetro de resposta connectorOutputPayload da tarefa Connectors depois que você executar a integração.

Ação AddDocument

Essa ação adiciona documentos na base de sofá.

Parâmetros de entrada da ação AddDocument

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
BucketName	String	Sim	O bucket no qual inserir o documento.
SourceTable	Objeto	Não	O nome da tabela temporária que contém as colunas "ID" e "Document". Obrigatório se nenhum ID for especificado.
ID	String	Não	A chave primária em que o documento será inserido. Obrigatório se nenhuma SourceTable for especificada.
Documento	String	Não	O texto JSON do documento a ser inserido. Obrigatório se a SourceTable não for especificada.

Parâmetros de saída da ação AddDocument

Esta ação retornará o status 200 (OK) se a ação for bem-sucedida.

Por exemplo, sobre como configurar a ação AddDocument, consulte Exemplos de ação.

Ação CreateCollection

Esta ação cria uma coleção em um escopo atual.

Parâmetros de entrada da ação CreateCollection

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Bucket	String	Sim	Nome do bucket que contém a coleção.
Escopo	String	Sim	O nome do escopo que contém a coleção.
Nome	String	Sim	Nome da coleção a ser criada.

Parâmetros de saída da ação CreateCollection

Esta ação retornará o status 200 (OK) se a ação for bem-sucedida.

Por exemplo, sobre como configurar a ação CreateCollection, consulte Exemplos de ação.

Ação DeleteCollection

Esta ação exclui uma coleção em um escopo atual.

Parâmetros de entrada da ação DeleteCollection

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Bucket	string	Verdadeiro	Nome do bucket que contém a coleção.
Escopo	String	Verdadeiro	O nome do escopo que contém a coleção.
Nome	string	Verdadeiro	Nome da coleção a ser excluída.

Parâmetros de saída da ação DeleteCollection

Esta ação retornará o status 200 (OK) se a ação for bem-sucedida.

Por exemplo, sobre como configurar a ação DeleteCollection, consulte Exemplos de ação.

Ação CreateScope

Esta ação cria um escopo em um bucket atual.

Parâmetros de entrada da ação CreateScope

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Bucket	String	Sim	O nome do bucket que contém o escopo
Nome	String	Sim	O nome do escopo a ser criado.

Parâmetros de saída da ação CreateScope

Esta ação retornará o status 200 (OK) se a ação for bem-sucedida.

Por exemplo, sobre como configurar a ação CreateScope, consulte Exemplos de ação.

Ação DeleteScope

Esta ação exclui um escopo e todas as coleções dele.

Parâmetros de entrada da ação DeleteScope

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
Bucket	String	Sim	O nome do bucket que contém o escopo.
Nome	String	Sim	O nome do escopo a ser excluído.

Parâmetros de saída da ação DeleteScope

Esta ação retornará o status 200 (OK) se a ação for bem-sucedida.

Por exemplo, sobre como configurar a ação DeleteScope, consulte Exemplos de ação.

Ação ListIndices

Esta ação lista todos os índices disponíveis no Couchbase.

Parâmetros de entrada da ação ListIndices

N/A

Parâmetros de saída da ação ListIndices

Esta ação retornará o status 200 (OK) se a ação for bem-sucedida.

Para um exemplo sobre como configurar a ação ListIndices, consulte Exemplos de ação.

Ação ManageIndices

Esta ação cria ou descarta um índice em um bucket.

Parâmetros de entrada da ação ManageIndices

Nome do parâmetro	Tipo de dados	Obrigatório	Descrição
BucketName	String	Sim	O bucket de destino do qual criar ou remover o índice.
ScopeName	objeto	Não	O escopo de destino do qual criar ou descartar o índice (Couchbase versão 7 e mais recentes)
CollectionName	String	Não	O conjunto de destino do qual criar ou remover o índice (Couchbase versão 7 e posteriores)
Ação	String	Sim	Especifica qual ação executar no índice pode ser Create ou Drop.
Expressões	String	Não	Uma lista de expressões ou funções, codificadas como JSON, na qual o índice será baseado. Pelo menos um deles é necessário quando IsPrimary está definido como falso e a ação é Create.
Nome	String	Não	O nome do índice a ser criado ou descartado, obrigatório se IsPrimary estiver definido como falso.
IsPrimary	String	Não	Especifica se o índice precisa ser um índice primário.O valor padrão é verdadeiro.
Filtros	String	Não	Uma lista de filtros, codificados como JSON, para aplicar ao índice.
IndexType	String	Não	O tipo de índice a ser criado, que pode ser GSI ou View, usado apenas se a ação for Create. O valor padrão é GSI.
ViewName	String	Não	Obsoleto e incluído apenas para compatibilidade. Não faz nada.
Nós	String	Não	Uma lista, codificada como JSON, de nós para conter o índice, precisa conter a porta. Usado somente se a ação for "Criar".
NumReplica	String	Não	Quantas réplicas são criadas entre os nós de índice no cluster.

Parâmetros de saída da ação ManageIndices

Esta ação retornará o status 200 (OK) se a ação for bem-sucedida.

Para um exemplo sobre como configurar a ação ManageIndices, consulte Exemplos de ação.

Ação ExecuteCustomQuery

Essa ação permite executar uma consulta personalizada.

Para criar uma consulta personalizada, siga estas etapas:

Siga as instruções detalhadas para adicionar uma tarefa de conectores.
Depois de 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:
1. 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.
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 consulta personalizada. 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.
  É 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 coluna LastName:
```
SELECT * FROM Employees where LastName=?
```
  Observação:há suporte para as instruções de linguagem de manipulação de dados (DML) e de 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 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:
  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.

Se a execução for bem-sucedida, essa ação retornará o status 200 (OK) com um corpo de resposta que tenha os resultados da consulta.

Exemplos de ação

Nesta seção, descrevemos como executar algumas das ações nesse conector.

Exemplo: adicionar um documento

Este exemplo adiciona um documento a um bucket do Couchbase.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação AddDocument e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"Document": "{\"ID\":10,\"Name\":\"TestDoc\"}",
"BucketName": "CouchbaseTestBucket",
"ID": "Test"
}
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa AddDocument terá um valor semelhante ao seguinte:

[{
"RowsAffected": "1"
}]

Exemplo: criar uma coleção

Neste exemplo, uma coleção é criada.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação CreateCollection e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"bucket": "CouchbaseTestBucket",
"scope": "TestScope",
"name": "CollectionFromGoogleCloud"
}
```

Neste exemplo, uma coleção é criada no TestScope. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateCollection terá um valor semelhante ao seguinte:

[{
"Success": true,
"scope": null,
"uid": null,
"collection": null,
"collections.uid": null,
"maxTTL": null,
"history": null
}]

Exemplo: excluir uma coleção

Neste exemplo, uma coleção é excluída.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação DeleteCollection e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"bucket": "CouchbaseTestBucket",
"scope": "TestScope",
"name": "CollectionFromGoogleCloud"
}
```

Neste exemplo, uma coleção é excluída no TestScope. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateCollection terá um valor semelhante a este:

[{
"Success": true,
"uid": "12"
}]

Exemplo: criar um escopo

Neste exemplo, criamos um escopo.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação CreateScope e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"bucket": "CouchbaseTestBucket",
"name": "ScopeFromGoogleCloud"
}
```

Neste exemplo, um escopo é criado em CouchbaseTestBucket. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateScope terá um valor semelhante a este:

[{
"Success": true,
"name": null,
"uid": null,
"collections": null,
"collections.name": null,
"collections.uid": null,
"collections.maxTTL": null,
"collections.history": null
}]

Exemplo: excluir um escopo

Neste exemplo, um escopo é excluído.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação DeleteScope e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"bucket": "CouchbaseTestBucket",
"name": "ScopeFromGoogleCloud"
}
```

Este exemplo exclui o escopo ScopeFromGoogleCloud. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeleteScope terá um valor semelhante a este:

[{
"Success": true,
"uid": "10"
}]

Exemplo: índices de lista

Este exemplo lista todos os índices disponíveis no Couchbase.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação ListIndices e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
}
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ListIndices terá um valor semelhante a este:

[{
"id": "3d8a78cd2e302ac2",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": null,
"scope_id": null,
"keyspace_id": "CouchbaseTestBucket",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "test",
"state": "online",
"using": "gsi"
}, {
"id": "d6ce8c103b97a00d",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "CouchBaseDatatypes",
"index_key": "",
"condition": null,
"is_primary": "true",
"name": "#primary",
"state": "online",
"using": "gsi"
},
{
"id": "58c25aef49dd32b3",
"datastore_id": "http://127.0.0.1:8091",
"namespace_id": "default",
"bucket_id": "CouchbaseTestBucket",
"scope_id": "TestScope",
"keyspace_id": "TestCollection",
"index_key": "",
"condition": null,
"is_primary": "false",
"name": "SearchIndexTest_1",
"state": "online",
"using": "fts"
}]

Exemplo: gerenciar índices

Este exemplo exclui um índice no bucket especificado.

Na caixa de diálogo Configure connector task, clique em Actions.
Selecione a ação ManageIndices e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"BucketName": "CouchbaseTestBucket",
"Action": "DROP",
"Name": "CouchBaseTestIndex"
}
```

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa ManageIndices terá um valor semelhante a este:

[{
"Success": "true"
}]

Exemplos de operação de entidade

Esta seção mostra como executar algumas das operações da entidade no conector.

Exemplo: listar todos os registros

Neste exemplo, listamos todos os registros na entidade TestCollection.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione TestCollection na lista de Entity.
Selecione a operação List e clique em Concluído.
Como opção, na seção Task Input da tarefa Connectors, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (').

Exemplo: receber um registro de uma entidade

Este exemplo recebe um registro com o ID especificado da entidade TestCollection.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione TestCollection na lista de Entity.
Selecione a operação Get e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em EntityId e insira 120 no campo Valor padrão.
Aqui, 120 é um ID de registro exclusivo na entidade TestCollection.

Exemplo: atualizar um registro em uma entidade

Este exemplo atualiza um registro na entidade TestCollection.

Na caixa de diálogo Configure connector task, clique em Entities.
Selecione TestCollection na lista de Entity.
Selecione a operação Update e clique em Concluído.
Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
```
{
"COL_TEXT": "CouchBase Update"
}
```
Clique em entityId e, em seguida, insira 120 no campo Valor padrão.
Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:
```
[{
"Document.Id": "120"
}]
```

Exemplo: excluir um registro de uma entidade

Este exemplo exclui o registro com o ID especificado na entidade TestCollection.

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

Problemas conhecidos

A operação create em entidades não é compatível.

Usar o Terraform para criar conexões

Use o recurso do Terraform (em inglês) para criar uma nova conexão.

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

Confira um exemplo de modelo do Terraform para criar uma conexão em exemplo.

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
allow_jsonparameters	BOOLEAN	Falso	Permite que o JSON bruto seja usado em parâmetros quando QueryPassthrough está ativado.
analytics_port	STRING	Falso	A porta para se conectar ao endpoint do Couchbase Analytics.
child_separator	STRING	Falso	O caractere ou caracteres usados para denotar tabelas filhas.
couchbase_service	ENUM	Falso	Determina a que serviço do Couchbase será conectado. O padrão é N1QL. As opções disponíveis são N1QL e Analytics. Os valores aceitos são: N1QL, Analytics
create_table_ram_quota	STRING	Falso	A cota de RAM padrão, em megabytes, a ser usada ao inserir buckets pela sintaxe CREATE TABLE.
dataverse_separator	STRING	Falso	Os caracteres usados para denotar os dataversos e escopos/coleções do Google Analytics.
flavor_separator	STRING	Falso	O caractere ou caracteres usados para denotar sabores.
n1_qlport	STRING	Falso	A porta para se conectar ao endpoint do Couchbase N1QL.
periods_separator	STRING	Falso	O caractere ou caracteres usados para denotar a hierarquia.
query_execution_timeout	STRING	Falso	Isso define o tempo limite do lado do servidor para a consulta, que determina por quanto tempo o Couchbase vai executar a consulta antes de retornar um erro de tempo limite.
strict_comparison	STRING	Falso	Ajusta a precisão para traduzir filtros em consultas de entrada SQL para consultas do Couchbase. É possível usar uma lista de valores separados por vírgulas, em que cada valor pode ser: data, número, booleano ou string.
transaction_durability	STRING	Falso	Especifica como um documento precisa ser armazenado para que uma transação seja bem-sucedida. Especifica se serão usadas transações N1QL ao executar consultas.
transaction_timeout	STRING	Falso	Isso define o período de execução de uma transação antes que ela expire pelo Couchbase.
use_collections_for_ddl	BOOLEAN	Falso	Define se as instruções CREATE TABLE usam coleções em vez de variações. Só tem efeito quando você se conecta ao Couchbase v7+ e o GenerateSchemaFiles está definido como OnCreate.
use_transactions	STRING	Falso	Especifica se serão usadas transações N1QL ao executar consultas.
validate_jsonparameters	BOOLEAN	Falso	Permite que o provedor confirme se os parâmetros de string são JSON válidos antes de enviar a consulta para o Couchbase.
proxy_enabled	BOOLEAN	Falso	Marque essa 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 ProxyServer. Valores aceitos: BASIC, DIGEST, NONE
proxy_user	STRING	Falso	Um nome de usuário a ser usado para autenticação no proxy 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 do ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, SELECTED
nível de detalhes	STRING	Falso	O nível de detalhamento da conexão varia de 1 a 5. Um nível de detalhamento mais alto registra todos os detalhes da comunicação (solicitações,respostas e certificados SSL).

Usar a conexão do Couchbase em uma integração

Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use 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 Tarefa Conectores.
Para entender como criar e usar a tarefa de conectores na 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.
Entenda como visualizar os registros do conector.