Couchbase

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:
  • Lista
  • 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 de 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. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro 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 é compatível com a execução das 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 oferece a ação Executar consulta personalizada.

  Para criar uma consulta salva, siga estas etapas:

  1. Siga as instruções detalhadas para adicionar uma tarefa de conectores.
  2. Quando você 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 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.

        É 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=?

     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.

Ações

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

Ação AddDocument

Essa ação adiciona documentos no Couchbase.

Parâmetros de entrada da ação AddDocument

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

Essa ação retorna o status 200 (OK) se for bem-sucedida.

Para ver um exemplo de como configurar a ação AddDocument, consulte Exemplos de ações.

Ação CreateCollection

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

Parâmetros de entrada da ação CreateCollection

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

Essa ação retorna o status 200 (OK) se for bem-sucedida.

Para ver um exemplo de como configurar a ação CreateCollection, consulte Exemplos de ações.

Ação DeleteCollection

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

Parâmetros de entrada da ação DeleteCollection

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

Essa ação retorna o status 200 (OK) se for bem-sucedida.

Para ver um exemplo de como configurar a ação DeleteCollection, consulte Exemplos de ações.

Ação CreateScope

Essa ação cria um escopo em um bucket existente.

Parâmetros de entrada da ação CreateScope

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

Essa ação retorna o status 200 (OK) se for bem-sucedida.

Para ver um exemplo de como configurar a ação CreateScope, consulte Exemplos de ações.

Ação DeleteScope

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

Parâmetros de entrada da ação DeleteScope

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

Essa ação retorna o status 200 (OK) se for bem-sucedida.

Para ver um exemplo de como configurar a ação DeleteScope, consulte Exemplos de ações.

Ação ListIndices

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

Parâmetros de entrada da ação ListIndices

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

Essa ação retorna o status 200 (OK) se for bem-sucedida.

Para ver um exemplo de como configurar a ação ListIndices, consulte Exemplos de ações.

Ação ManageIndices

Essa ação cria ou exclui um índice em um bucket.

Parâmetros de entrada da ação ManageIndices

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

Essa ação retorna o status 200 (OK) se for bem-sucedida.

Para ver um exemplo de como configurar a ação ManageIndices, consulte Exemplos de ações.

Ação ExecuteCustomQuery

Essa ação permite executar uma consulta personalizada.

Para criar uma consulta salva, siga estas etapas:

1. Siga as instruções detalhadas para adicionar uma tarefa de conectores.
2. Quando você 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 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.

      É 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=?

   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 vai retornar o status 200 (OK) com um corpo de resposta que tem os resultados da consulta.

Exemplos de ações

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

Exemplo: adicionar um documento

Este exemplo adiciona um documento a um bucket do Couchbase.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação AddDocument e clique em Concluído.
3. Na seção Entrada da tarefa 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 a este:

[{
"RowsAffected": "1"
}]

Exemplo: criar uma coleção

Este exemplo cria uma coleção.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateCollection e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "bucket": "CouchbaseTestBucket",
   "scope": "TestScope",
   "name": "CollectionFromGoogleCloud"
   }

Este exemplo cria uma coleção em 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,
"scope": null,
"uid": null,
"collection": null,
"collections.uid": null,
"maxTTL": null,
"history": null
}]

Exemplo: excluir uma coleção

Este exemplo exclui uma coleção.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeleteCollection e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "bucket": "CouchbaseTestBucket",
   "scope": "TestScope",
   "name": "CollectionFromGoogleCloud"
   }

Este exemplo exclui uma coleção em 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

Este exemplo cria um escopo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação CreateScope e clique em Concluído.
3. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "bucket": "CouchbaseTestBucket",
   "name": "ScopeFromGoogleCloud"
   }

Este exemplo cria um escopo 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

Este exemplo exclui um escopo.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação DeleteScope e clique em Concluído.
3. Na seção Entrada da tarefa 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: listar índices

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

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ListIndices e clique em Concluído.
3. Na seção Entrada da tarefa 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.

1. Na caixa de diálogo Configure connector task, clique em Actions.
2. Selecione a ação ManageIndices e clique em Concluído.
3. Na seção Entrada da tarefa 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ções de entidade

Nesta seção, mostramos como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os registros

Este exemplo lista todos os registros na entidade TestCollection.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione TestCollection na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Se quiser, na seção Entrada de tarefa da tarefa Conectores, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Sempre especifique o valor da cláusula de filtro entre aspas simples (').

Exemplo: receber um registro de uma entidade

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

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione TestCollection na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Conectores, 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.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione TestCollection na lista Entity.
3. Selecione a operação Update e clique em Concluído.
4. Na seção Entrada da tarefa da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:

   {
   "COL_TEXT": "CouchBase Update"
   }

5. Clique em entityId e digite 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.

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