Couchbase

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

Ce connecteur est compatible avec l'exécution des actions suivantes :

• Fonctions et procédures stockées définies par l'utilisateur. Si votre backend contient des fonctions et des procédures stockées, elles sont listées dans la colonne Actions de la boîte de dialogue Configure connector task.
• Requêtes SQL personnalisées. Pour exécuter des requêtes SQL personnalisées, le connecteur fournit l'action 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.

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 AddDocument

Cette action permet d'ajouter des documents dans Couchbase.

Paramètres d'entrée de l'action AddDocument

Paramètres de sortie de l'action AddDocument

Si cette action aboutit, elle renvoie l'état 200 (OK).

Pour savoir comment configurer l'action AddDocument, consultez Exemples d'actions.

Action CreateCollection

Cette action crée une collection dans un champ d'application existant.

Paramètres d'entrée de l'action CreateCollection

Paramètres de sortie de l'action CreateCollection

Si cette action aboutit, elle renvoie l'état 200 (OK).

Pour savoir comment configurer l'action CreateCollection, consultez Exemples d'actions.

Action DeleteCollection

Cette action supprime une collection dans un champ d'application existant.

Paramètres d'entrée de l'action DeleteCollection

Paramètres de sortie de l'action DeleteCollection

Si cette action aboutit, elle renvoie l'état 200 (OK).

Pour savoir comment configurer l'action DeleteCollection, consultez Exemples d'actions.

Action CreateScope

Cette action crée un champ d'application dans un bucket existant.

Paramètres d'entrée de l'action CreateScope

Paramètres de sortie de l'action CreateScope

Si cette action aboutit, elle renvoie l'état 200 (OK).

Pour savoir comment configurer l'action CreateScope, consultez Exemples d'actions.

Action DeleteScope

Cette action supprime un champ d'application et toutes ses collections.

Paramètres d'entrée de l'action DeleteScope

Paramètres de sortie de l'action DeleteScope

Si cette action aboutit, elle renvoie l'état 200 (OK).

Pour savoir comment configurer l'action DeleteScope, consultez Exemples d'actions.

Action ListIndices

Cette action liste tous les index disponibles dans Couchbase.

Paramètres d'entrée de l'action ListIndices

Paramètres de sortie de l'action ListIndices

Si cette action aboutit, elle renvoie l'état 200 (OK).

Pour savoir comment configurer l'action ListIndices, consultez Exemples d'actions.

Action ManageIndices

Cette action crée ou supprime un index dans un bucket.

Paramètres d'entrée de l'action ManageIndices

Paramètres de sortie de l'action ManageIndices

Si cette action aboutit, elle renvoie l'état 200 (OK).

Pour savoir comment configurer l'action ManageIndices, 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 : Ajouter un document

Cet exemple ajoute un document dans un bucket Couchbase.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action AddDocument, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "Document": "{\"ID\":10,\"Name\":\"TestDoc\"}",
   "BucketName": "CouchbaseTestBucket",
   "ID": "Test"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche AddDocument aura une valeur semblable à la suivante :

[{
"RowsAffected": "1"
}]

Exemple : Créer une collection

Cet exemple crée une collection.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CreateCollection, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Cet exemple crée une collection sous TestScope. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CreateCollection aura une valeur semblable à la suivante :

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

Exemple : Supprimer une collection

Cet exemple supprime une collection.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DeleteCollection, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Cet exemple supprime une collection sous TestScope. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CreateCollection aura une valeur semblable à la suivante :

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

Exemple : Créer un champ d'application

Cet exemple crée un champ d'application.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action CreateScope, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Cet exemple crée un champ d'application sous CouchbaseTestBucket. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche CreateScope aura une valeur semblable à la suivante :

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

Exemple : Supprimer un niveau d'accès

Cet exemple supprime un champ d'application.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action DeleteScope, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

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

Cet exemple supprime le champ d'application ScopeFromGoogleCloud. Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche DeleteScope aura une valeur semblable à la suivante :

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

Exemple : Lister les index

Cet exemple liste tous les index disponibles dans Couchbase.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action ListIndices, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche ListIndices aura une valeur semblable à la suivante :

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

Exemple : Gérer les index

Cet exemple supprime un index dans le bucket spécifié.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action ManageIndices, puis cliquez sur OK.
3. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "BucketName": "CouchbaseTestBucket",
   "Action": "DROP",
   "Name": "CouchBaseTestIndex"
   }

Si l'action aboutit, le paramètre de réponse connectorOutputPayload de la tâche ManageIndices aura une valeur semblable à la suivante :

[{
"Success": "true"
}]

Exemples d'opérations d'entité

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

Exemple : Lister tous les enregistrements

Cet exemple liste tous les enregistrements de l'entité TestCollection.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez TestCollection dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. (Facultatif) Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez filtrer votre ensemble de résultats en spécifiant une clause de filtre. Indiquez toujours la valeur de la clause de filtre entre guillemets simples (').

Exemple : Récupérer un enregistrement à partir d'une entité

Cet exemple récupère un enregistrement ayant l'ID spécifié à partir de l'entité TestCollection.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez TestCollection dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur EntityId, puis saisissez 120 dans le champ Valeur par défaut.

   Ici, 120 est un ID d'enregistrement unique dans l'entité TestCollection.

Exemple : Mettre à jour un enregistrement dans une entité

Cet exemple met à jour un enregistrement dans l'entité TestCollection.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez TestCollection dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur connectorInputPayload, puis saisissez une valeur semblable à la suivante dans le champ Default Value :

   {
   "COL_TEXT": "CouchBase Update"
   }

5. Cliquez sur entityId, puis saisissez 120 dans le champ Valeur par défaut.

   Si l'intégration aboutit, le champ connectorOutputPayload de la tâche "Connecteurs" aura une valeur semblable à la suivante :

   [{
   "Document.Id": "120"
   }]

Exemple : Supprimer un enregistrement d'une entité

Cet exemple supprime l'enregistrement ayant l'ID spécifié dans l'entité TestCollection.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez TestCollection dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, cliquez sur entityId, puis saisissez 20 dans le champ Valeur par défaut.