Neo4j

Entités, opérations et actions

Tous les connecteurs Integration Connectors fournissent une couche d'abstraction pour les objets de l'application connectée. Vous ne pouvez accéder aux objets d'une application que par le biais de cette abstraction. L'abstraction vous est présentée en tant qu'entités, opérations et actions.

• Entité : une entité peut être considérée comme un objet ou un ensemble de propriétés dans l'application ou le service connectés. La définition d'une entité diffère d'un connecteur à l'autre. Par exemple, dans un connecteur de base de données, les tables sont les entités, alors que dans un connecteur de serveur de fichiers, ce sont les dossiers, et dans un connecteur de système de messagerie, ce sont les files d'attente.

  Toutefois, il est possible qu'un connecteur n'accepte ou ne possède aucune entité. Dans ce cas, la liste Entities est vide.

• Opération : une opération est l'activité que vous pouvez effectuer sur une entité. Voici les opérations possibles :
  • List
  • Get
  • Create
  • Update
  • Delete

  Lorsque vous sélectionnez une entité dans la liste proposée, cela génère une liste d'opérations disponibles pour l'entité. Pour obtenir une description détaillée des opérations, consultez les opérations d'entité de la tâche "Connecteurs". Cependant, si un connecteur n'accepte pas l'une des opérations d'entité, cette opération non compatible ne figure pas dans la liste Operations.

• Action : une action est une fonction de première classe mise à la disposition de l'intégration par le biais de l'interface du connecteur. Une action vous permet de modifier une ou plusieurs entités, et varie d'un connecteur à l'autre. Normalement, une action comporte des paramètres d'entrée et un paramètre de sortie. Toutefois, il est possible qu'un connecteur n'accepte aucune action, auquel cas la liste Actions est vide.

Actions

Dans cette section, vous trouverez la liste des actions prises en charge par le connecteur. Pour savoir comment configurer les actions, consultez Exemples d'actions.

Action ExecuteCustomQuery

Cette action permet d'exécuter une requête personnalisée.

Pour créer une requête personnalisée, procédez comme suit :

1. Suivez les instructions détaillées pour ajouter une tâche "Connecteurs".
2. Lorsque vous configurez la tâche "Connecteurs", sélectionnez Actions dans le type d'action à effectuer.
3. Dans la liste Action, sélectionnez Exécuter une requête personnalisée, puis cliquez sur OK.

   

4. Développez la section Entrée de la tâche, puis procédez comme suit :
   1. Dans le champ Délai d'inactivité après, saisissez le nombre de secondes d'attente jusqu'à l'exécution de la requête.

      Valeur par défaut : 180 secondes.

   2. Dans le champ Nombre maximal de lignes, saisissez le nombre maximal de lignes à renvoyer à partir de la base de données.

      Valeur par défaut : 25

   3. Pour mettre à jour la requête personnalisée, cliquez sur Modifier le script personnalisé. La boîte de dialogue Éditeur de script s'ouvre.

      

   4. Dans la boîte de dialogue Éditeur de script, saisissez la requête SQL, puis cliquez sur Enregistrer.

      Vous pouvez utiliser un point d'interrogation (?) dans une instruction SQL pour représenter un seul paramètre devant être spécifié dans la liste des paramètres de requête. Par exemple, la requête SQL suivante sélectionne toutes les lignes de la table Employees correspondant aux valeurs spécifiées pour la colonne LastName :

      SELECT * FROM Employees where LastName=?

   5. Si vous avez utilisé des points d'interrogation dans votre requête SQL, vous devez ajouter le paramètre en cliquant sur + Ajouter un nom de paramètre pour chaque point d'interrogation. Lors de l'exécution de l'intégration, ces paramètres remplacent les points d'interrogation (?) de la requête SQL de manière séquentielle. Par exemple, si vous avez ajouté trois points d'interrogation (?), vous devez ajouter trois paramètres dans l'ordre de séquence.

      

      Pour ajouter des paramètres de requête, procédez comme suit :

      1. Dans la liste Type, sélectionnez le type de données du paramètre.
      2. Dans le champ Valeur, saisissez la valeur du paramètre.
      3. Pour ajouter plusieurs paramètres, cliquez sur + Ajouter un paramètre de requête.

Si cette action aboutit, elle renvoie l'état 200 (OK) avec un corps de réponse contenant les résultats de la requête.

Exemples d'actions

Cette section explique comment effectuer certaines actions dans ce connecteur.

Exemple : Créer un nœud

Cet exemple montre comment créer un nœud.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection, and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query renvoie une charge utile vide [ ].

Exemple : Mettre à jour un nœud

Cet exemple montre comment mettre à jour un nœud.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Si l'action aboutit, la valeur du paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query est semblable à la suivante :

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

Exemple : Supprimer un nœud

Cet exemple montre comment supprimer un nœud.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query renvoie une charge utile vide [ ].

Exemple : Créer une relation

Cet exemple montre comment créer une relation.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query renvoie une charge utile vide [ ].

Exemple : Mettre à jour une relation

Cet exemple montre comment mettre à jour une relation.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ 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 l'action aboutit, la valeur du paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query est semblable à la suivante :

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

Exemple : Supprimer une relation

Cet exemple montre comment supprimer une relation.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query renvoie une charge utile vide [ ].

Exemple : Mettre à jour le libellé d'un nœud

Cet exemple montre comment mettre à jour un libellé de nœud.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Si l'action aboutit, la valeur du paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query est semblable à la suivante :

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

Exemple : Mettre à jour le type de relation

Cet exemple montre comment mettre à jour un type de relation.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Si l'action aboutit, la valeur du paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query est semblable à la suivante :

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

Exemple : Créer un type de données

Cet exemple montre comment créer un type de données.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ 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 l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query renvoie une charge utile vide [ ].

Exemple : Mettre à jour un type de données

Cet exemple montre comment mettre à jour un type de données.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Si l'action aboutit, la valeur du paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query est semblable à la suivante :

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

Exemple : Supprimer un type de données

Cet exemple montre comment supprimer un type de données.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

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

Cet exemple montre comment supprimer un type de données. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query renvoie une charge utile vide [ ].

Exemple : Obtenir le nombre de nœuds

Cet exemple montre comment obtenir le nombre de nœuds.

1. Dans la boîte de dialogue Configure Connector, sélectionnez Region, Connection and Actions.
2. Sélectionnez Execute Custom Query dans les actions, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de Connecteur, cliquez sur Edit Custom Script, puis saisissez une valeur semblable à la suivante dans le champ Custom Query :

   MATCH ()  
   RETURN count(*) AS numNodes

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche Execute Custom Query fournit la charge utile, qui est semblable à ce qui suit :

[{
  "numNodes": 6267.0
}]

Exemples d'opérations d'entité

Cette section explique comment effectuer certaines opérations d'entité dans ce connecteur.

Exemple : Lister toutes les langues

Cet exemple montre comment lister toutes les langues.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "multilanguage_table" dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. Dans la section Data Mapper, cliquez sur Ouvrir l'éditeur de mappage de données, puis définissez filterClause selon vos besoins.

Exemple : Obtenir une langue

Cet exemple montre comment obtenir une langue.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "multilanguage_table" dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Définissez l'ID d'entité sur "Get single Language". Pour définir l'ID d'entité, dans la section Data Mapper, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez 58.0 dans le champ Valeur d'entrée et choisissez entityId comme variable locale.