Neo4j

Entidades, operaciones y acciones

Todos los conectores de integración proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se te muestra como entidades, operaciones y acciones.

• Entidad: una entidad se puede considerar como un objeto o un conjunto de propiedades en la aplicación o el servicio conectados. La definición de una entidad varía de un conector a otro. Por ejemplo, en un conector de base de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; y en un conector de sistema de mensajería, las colas son las entidades.

  Sin embargo, es posible que un conector no admita o no tenga ninguna entidad. En ese caso, la lista Entities estará vacía.

• Operación: una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:
  • Mostrar
  • Obtener
  • Crear
  • Actualizar
  • Eliminar

  Al seleccionar una entidad de la lista disponible, se genera una lista de operaciones disponibles para la entidad. Para ver una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea Connectors. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, esas operaciones no admitidas no se mostrarán en la lista Operations.

• Acción: una acción es una función de primera clase que se pone a disposición de la integración a través de la interfaz del conector. Una acción te permite hacer cambios en una o varias entidades y varía de un conector a otro. Normalmente, una acción tendrá algunos parámetros de entrada y un parámetro de salida. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección se enumeran las acciones que admite el conector. Para saber cómo configurar las acciones, consulta los ejemplos de acciones.

Acción ExecuteCustomQuery

Esta acción te permite ejecutar una consulta personalizada.

Para crear una consulta personalizada, sigue estos pasos:

1. Sigue las instrucciones detalladas para añadir una tarea de conectores.
2. Cuando configure la tarea del conector, en el tipo de acción que quiera realizar, seleccione Acciones.
3. En la lista Acción, selecciona Ejecutar consulta personalizada y, a continuación, haz clic en Hecho.

   

4. Despliega la sección Entrada de la tarea y, a continuación, haz lo siguiente:
   1. En el campo Tiempo de espera tras, introduce el número de segundos que deben transcurrir hasta que se ejecute la consulta.

      Valor predeterminado: 180 segundos.

   2. En el campo Número máximo de filas, introduzca el número máximo de filas que se devolverán de la base de datos.

      Valor predeterminado: 25.

   3. Para actualizar la consulta personalizada, haz clic en Editar secuencia de comandos personalizada. Se abrirá el cuadro de diálogo Editor de secuencias de comandos.

      

   4. En el cuadro de diálogo Editor de secuencias de comandos, introduce la consulta de SQL y haz clic en Guardar.

      Puedes usar un signo de interrogación (?) en una instrucción SQL para representar un único parámetro que debe especificarse en la lista de parámetros de la consulta. Por ejemplo, la siguiente consulta SQL selecciona todas las filas de la tabla Employees que coinciden con los valores especificados en la columna LastName:

      SELECT * FROM Employees where LastName=?

   5. Si has usado signos de interrogación en tu consulta SQL, debes añadir el parámetro haciendo clic en + Añadir nombre de parámetro por cada signo de interrogación. Durante la ejecución de la integración, estos parámetros sustituyen secuencialmente los signos de interrogación (?) de la consulta de SQL. Por ejemplo, si has añadido tres signos de interrogación (?), debes añadir tres parámetros en orden de secuencia.

      

      Para añadir parámetros de consulta, siga estos pasos:

      1. En la lista Tipo, seleccione el tipo de datos del parámetro.
      2. En el campo Valor, introduzca el valor del parámetro.
      3. Para añadir varios parámetros, haga clic en + Añadir parámetro de consulta.

   La acción Ejecutar consulta personalizada no admite variables de matriz.

Si se ejecuta correctamente, esta acción devuelve el estado 200 (OK) con un cuerpo de respuesta que contiene los resultados de la consulta.

Ejemplos de acciones

En esta sección se describe cómo realizar algunas de las acciones de este conector.

Ejemplo: crear un nodo

En este ejemplo se muestra cómo crear un nodo.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection, and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Execute Custom Query devuelve una carga útil en blanco [ ].

Ejemplo: actualizar un nodo

En este ejemplo se muestra cómo actualizar un nodo.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

Si la acción se realiza correctamente, el valor del parámetro connectorOutputPayload de la respuesta Execute Custom Query de la tarea será similar al siguiente:

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

Ejemplo: eliminar un nodo

En este ejemplo se muestra cómo eliminar un nodo.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Execute Custom Query devuelve una carga útil en blanco [ ].

Ejemplo: crear una relación

En este ejemplo se muestra cómo crear una relación.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Execute Custom Query devuelve una carga útil en blanco [ ].

Ejemplo: actualizar una relación

En este ejemplo se muestra cómo actualizar una relación.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el 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

Si la acción se realiza correctamente, el valor del parámetro connectorOutputPayload de la respuesta Execute Custom Query de la tarea será similar al siguiente:

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

Ejemplo: eliminar una relación

En este ejemplo se muestra cómo eliminar una relación.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Execute Custom Query devuelve una carga útil en blanco [ ].

Ejemplo: actualizar una etiqueta de nodo

En este ejemplo se muestra cómo actualizar una etiqueta de nodo.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

Si la acción se realiza correctamente, el valor del parámetro connectorOutputPayload de la respuesta Execute Custom Query de la tarea será similar al siguiente:

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

Ejemplo: actualizar el tipo de relación

En este ejemplo se muestra cómo actualizar un tipo de relación.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

Si la acción se realiza correctamente, el valor del parámetro connectorOutputPayload de la respuesta Execute Custom Query de la tarea será similar al siguiente:

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

Ejemplo: Crear un tipo de datos

En este ejemplo se muestra cómo crear un tipo de datos.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el 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")})

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Execute Custom Query devuelve una carga útil en blanco [ ].

Ejemplo: actualizar un tipo de datos

En este ejemplo se muestra cómo actualizar un tipo de datos.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

Si la acción se realiza correctamente, el valor del parámetro connectorOutputPayload de la respuesta Execute Custom Query de la tarea será similar al siguiente:

[{ "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\"}" }]

Ejemplo: eliminar un tipo de datos

En este ejemplo se muestra cómo eliminar un tipo de datos.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

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

En este ejemplo se muestra cómo eliminar un tipo de datos. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Execute Custom Query devuelve una carga útil en blanco [ ].

Ejemplo: Obtener el recuento de nodos

En este ejemplo se muestra cómo obtener el número de nodos.

1. En el cuadro de diálogo Configure Connector, selecciona Region, Connection and Actions.
2. Selecciona Execute Custom Query en las acciones y, a continuación, haz clic en Hecho.
3. En la sección Entrada de tarea de Conector, haz clic en Edit Custom Script y, a continuación, introduce un valor similar al siguiente en el campo Custom Query:

   MATCH ()  
   RETURN count(*) AS numNodes

Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea Execute Custom Query proporciona la carga útil, que es similar a la siguiente:

[{
  "numNodes": 6267.0
}]

Ejemplos de operaciones de entidades

En esta sección se muestra cómo realizar algunas de las operaciones de entidad en este conector.

Ejemplo: enumerar todos los idiomas

En este ejemplo se muestra cómo enumerar todos los idiomas.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona multilanguage_table en la lista Entity.
3. Selecciona la operación List y, a continuación, haz clic en Hecho.
4. En la sección Asignador de datos, haz clic en Abrir editor de asignación de datos y, ahí, puedes definir el filterClause según tus necesidades.

Ejemplo: obtener un idioma

En este ejemplo se muestra cómo obtener un idioma.

1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
2. Selecciona multilanguage_table en la lista Entity.
3. Selecciona la operación Get y, a continuación, haz clic en Hecho.
4. Define el ID de entidad como Get single Language. Para definir el ID de entidad, en la sección Asignador de datos, haga clic en Abrir editor de asignación de datos y, a continuación, introduzca 58.0 en el campo Valor de entrada y elija entityId como variable local.