Neo4j

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 sem suporte 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 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

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

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ção

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

Exemplo: criar um nó

Este exemplo mostra como criar um novo nó.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection, and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Entrada da tarefa do Conector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Custom Query:

   CREATE (:Movie {title: 'Hey', release_year: 2010})

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query vai fornecer um payload em branco [ ].

Exemplo: atualizar um nó

Este exemplo mostra como atualizar um nó.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Task Input do Connector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Campo Custom Query:

   match(m:Movie{title: 'Inception'}) set m.release_year=2011 return m

Se a ação for bem-sucedida, o valor do parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query será semelhante ao seguinte:

[{ "m": "{\"release_year\":2011,\"title\":\"Inception\"}" }]

Exemplo: excluir um nó

Neste exemplo, mostramos como excluir um nó.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Entrada da tarefa do Conector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Custom Query:

   match(m:Movie{title: 'hey'}) delete m

Se a ação for bem-sucedida, o O parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query fornece um payload em branco [ ].

Exemplo: criar uma relação

Este exemplo mostra como criar um relacionamento.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Entrada da tarefa do Conector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Custom Query:

   CREATE(movie:Movie {title: 'bcon'}), (actor:Actor {name: 'leo'})
   CREATE(actor)-[:ACTED_IN]->(movie)

Se a ação for bem-sucedida, o O parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query fornece um payload em branco [ ].

Exemplo: atualizar um relacionamento

Este exemplo mostra como atualizar uma relação.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Task Input do Connector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Campo Custom Query:

   match(movie:Movie {title: 'demo'}), (actor:Actor {name: 'first'})
   match(actor)-[r:ACTED_IN]->(movie) set actor.name='second',r.year=2024 return actor,r,movie

Se a ação for bem-sucedida, o Execute Custom Query resposta da tarefa connectorOutputPayload é semelhante ao seguinte:

[{   "actor": "{\"name\":\"second\"}",   "r": "{\"year\":2024}",   "movie": "{\"title\":\"demo\"}" }]

Exemplo: excluir uma relação

Este exemplo mostra como excluir uma relação.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Entrada da tarefa do Conector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Custom Query:

   MATCH(movie:Movie {title: 'bcon44'}), (actor:Actor {name: 'jacky'})
   MATCH(actor)-[r:ACTED_IN]->(movie) delete r

Se a ação for bem-sucedida, o O parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query fornece um payload em branco [ ].

Exemplo: atualizar um rótulo de nó

Neste exemplo, mostramos como atualizar um rótulo de nó.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Task Input do Connector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Campo Custom Query:

   MATCH (n:Person) where id(n)=18 set n:Actor RETURN n

Se a ação for bem-sucedida, o valor do parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query será semelhante ao seguinte:

[{ "n": "{\"born\":1962,\"name\":\"Demi Moore\"}" }]

Exemplo: atualizar o tipo de relacionamento

Este exemplo mostra como atualizar um tipo de relação.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Task Input do Connector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Campo Custom Query:

   MATCH (n:Person) where id(n)=18 set n.born=1963 RETURN n

Se a ação for bem-sucedida, o Execute Custom Query resposta da tarefa connectorOutputPayload é semelhante ao seguinte:

[{ "n": "{\"born\":1963,\"name\":\"Demi Moore\"}" }]

Exemplo: criar um tipo de dados

Este exemplo mostra como criar um tipo de dados.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Entrada da tarefa do Conector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Custom Query:

   CREATE (:Product {unitPrice: 109.50,
   unitsInStock: 390,
   supplierID: "1",
   productID: "dumy-2",
   discontinued: false,
   quantityPerUnit: "10 boxes x 20 bags",
   productName: "productName-1",
   unitsOnOrder: 0,
   reorderLevel: 10,
   supplier: ["1"],
   expiry: Duration("P14DT18H12M"),
   categoryID: "1",
   updatedAt: DateTime("1984-11-11T12:31:14Z")})

Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query vai fornecer um payload em branco [ ].

Exemplo: atualizar um tipo de dados

Este exemplo mostra como atualizar um tipo de dados.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Task Input do Connector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Campo Custom Query:

   match(p:Product{productID: "dumy-1"}) set p.duration = Duration("P15DT19H12M"), p.updatedAt=DateTime("1984-11-12T12:31:14Z") return p

Se a ação for bem-sucedida, o valor do parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query será semelhante ao seguinte:

[{ "p": "{\"unitPrice\":109.5,
\"unitsInStock\":390,
\"supplierID\":\"1\",
\"productID\":\"dumy-1\",
\"discontinued\":false,
\"quantityPerUnit\":\"10 boxes x 20 bags\",
\"productName\":\"productName-1\",
\"unitsOnOrder\":0,
\"duration\":\"P15DT19H12M\",
\"reorderLevel\":10,
\"supplier\":[\"1\"],
\"expiry\":\"P14DT18H12M\",
\"categoryID\":\"1\",
\"updatedAt\":\"1984-11-12T12:31:14Z\"}" }, 
{ "p":"{\"unitPrice\":109.5,
\"unitsInStock\":390,
\"supplierID\":\"1\",
\"productID\":\"dumy-1\",
\"discontinued\":false,
\"quantityPerUnit\":\"10 boxes x 20 bags\",
\"productName\":\"productName-1\",
\"unitsOnOrder\":0,
\"duration\":\"P15DT19H12M\",
\"reorderLevel\":10,
\"supplier\":[\"1\"],
\"expiry\":\"P14DT18H12M\",
\"categoryID\":\"1\",
\"updatedAt\":\"1984-11-12T12:31:14Z\"}" }]

Exemplo: excluir um tipo de dados

Este exemplo mostra como excluir um tipo de dados.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Task Input do Connector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Campo Custom Query:

   match(p:Product{productID: "dumy-2"}) delete p

Neste exemplo, mostramos como excluir um tipo de dados. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query vai fornecer um payload em branco [ ].

Exemplo: conferir a contagem de nós

Este exemplo mostra como conferir a contagem de nós.

1. Na caixa de diálogo Configure Connector, selecione Region, Connection and Actions.
2. Selecione Execute Custom Query nas ações e clique em Concluído.
3. Na seção Entrada da tarefa do Conector, clique em Edit Custom Script e insira um valor semelhante ao seguinte no campo Custom Query:

   MATCH ()  
   RETURN count(*) AS numNodes

Se a ação for bem-sucedida, o O parâmetro de resposta connectorOutputPayload da tarefa Execute Custom Query fornece o payload semelhante a este:

[{
  "numNodes": 6267.0
}]

Exemplos de operações de entidade

Esta seção mostra como realizar algumas das operações de entidade neste conector.

Exemplo: listar todos os idiomas

Este exemplo mostra como listar todos os idiomas.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione multilanguage_table na lista Entity.
3. Selecione a operação List e clique em Concluído.
4. Na seção Mapeador de dados, clique em Abrir editor de mapeamento de dados. Nele, você pode definir a filterClause de acordo com sua necessidade.

Exemplo: acessar um idioma

Este exemplo mostra como conseguir um idioma.

1. Na caixa de diálogo Configure connector task, clique em Entities.
2. Selecione multilanguage_table na lista Entity.
3. Selecione a operação Get e clique em Concluído.
4. Defina o ID da entidade como "Get single Language". Para definir o ID da entidade, em Na seção Data Mapper, clique em Abrir editor de mapeamento de dados e Depois insira 58.0 no campo Valor de entrada e escolha entityId como variável local.