CockroachDB

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

Exemple : Trouver la valeur la plus élevée

Cet exemple montre comment exécuter une fonction définie par l'utilisateur. Dans cet exemple, la fonction find_greater compare deux entiers et renvoie l'entier le plus élevé.

1. Dans la boîte de dialogue Configure connector task, cliquez sur Actions.
2. Sélectionnez l'action find_greater, 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 :

   {
   "$1": 1.0,
   "$2": 5.0
   }

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

[{
"bignum": 5.0
}]

Exemples d'opérations d'entité

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

Exemple : Lister tous les enregistrements Employees

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Employees dans la liste Entity.
3. Sélectionnez l'opération List, puis cliquez sur OK.
4. Dans la section Entrée de la tâche de la tâche Connecteurs, vous pouvez définir la filterClause en fonction des exigences du client.

La valeur de la clause de filtre doit toujours être transmise entre guillemets simples (') dans ce format.
Elle permet de filtrer les enregistrements en fonction de n'importe quelle colonne.

Vous pouvez effectuer l'opération List sur les entités suivantes :

"Cockroach_Datatypes", "Accounts", "SpatialData", "UNICODE", "LANGUAGES" et "View_Cockroach"

Exemple : Récupérer un enregistrement Employees

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Employees dans la liste Entity.
3. Sélectionnez l'opération Get, puis cliquez sur OK.
4. Définissez l'ID d'entité sur 5, qui est la clé à transmettre. Pour définir l'ID d'entité, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez 5 dans le champ Valeur d'entrée et choisissez "EntityId" comme variable locale.

   La valeur de l'ID d'entité doit être transmise directement. Ici, "5" est la valeur de clé primaire unique qui doit être transmise.

   Dans certains cas, la transmission d'un seul ID d'entité peut générer une erreur, car il y aura deux clés composites.
   Dans ce cas, vous pouvez utiliser la clause de filtre et transmettre la valeur EmployeeId='5'.

Vous pouvez effectuer l'opération List sur les entités suivantes :

Cockroach_Datatypes, Accounts, SpatialData, UNICODE et LANGUAGES

Exemple : Supprimer un enregistrement Employees

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Employees dans la liste Entity.
3. Sélectionnez l'opération Delete, puis cliquez sur OK.
4. Définissez l'ID d'entité sur 2, qui est la clé à transmettre. Pour définir l'ID d'entité, dans la section Data Mapper de la tâche Mappage de données, cliquez sur Ouvrir l'éditeur de mappage de données, puis saisissez 2 dans le champ Valeur d'entrée et choisissez "EntityId" comme variable locale.

   Si l'entité comporte deux clés métier ou clés primaires composites, vous pouvez définir la filterClause sur EmployeeId='2' au lieu de spécifier l'entityId.

Vous pouvez effectuer l'opération Delete sur les entités suivantes :

Cockroach_Datatypes, Accounts, SpatialData, UNICODE et LANGUAGES

Exemple : Créer un enregistrement Employees

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Employees dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload" comme variable locale.

   {
     "id": 100.0,
     "gender": "Male",
     "firstname": "Charlie",
     "lastname": "Cruz",
     "designation": "Tester",
     "dept": "IT"
   }
   

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

   {
     "id": 100.0,
     "gender": "Male",
     "firstname": "Charlie",
     "lastname": "Cruz",
     "designation": "Tester",
     "dept": "IT"
     }
     

Exemple : Créer un enregistrement Cockroach_Datatypes

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Cockroach_Datatypes" dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload" comme variable locale.

   {
     "col_int": 8.0,
     "col_date": "2016-03-26",
     "col_inet": "190.0.0.0",
     "col_collate": "Cruz",
     "col_string": "Charlie",
     "col_timestamp": "1992-10-05 12:12:12",
     "col_float": 12.12,
     "col_decimal": 10.1,
     "col_json": "{\"type\": \"account creation\", \"username\": \"harvestboy93\"}",
     "col_bool": true,
     "col_interval": "1 year 2 mons 3 days 04:05:06",
     "col_array": "{sky,road,car}",
     "col_uuid": "63616665-6630-3064-6465-616462656562",
     "col_time": "05:41:39",
     "col_bytes": "abc",
     "col_bit": "1",
     "col_name": "Charlie",
     "col_character": "A",
     "col_tsvector": "ts",
     "col_tsquery": "normal",
     "col_oid": "11",
     "col_bytea": "01100001"
   }
   

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

   {
     "col_int": 8.0,
     "col_date": "2016-03-26",
     "col_inet": "190.0.0.0",
     "col_collate": "Cruz",
     "col_string": "Charlie",
     "col_timestamp": "1992-10-05 12:12:12",
     "col_float": 12.12,
     "col_decimal": 10.1,
     "col_json": "{\"type\": \"account creation\", \"username\": \"harvestboy93\"}",
     "col_bool": true,
     "col_interval": "1 year 2 mons 3 days 04:05:06",
     "col_array": "{sky,road,car}",
     "col_uuid": "63616665-6630-3064-6465-616462656562",
     "col_time": "05:41:39",
     "col_bytes": "abc",
     "col_bit": "1",
     "col_name": "Charlie",
     "col_character": "A",
     "col_tsvector": "ts",
     "col_tsquery": "normal",
     "col_oid": "11",
     "col_bytea": "01100001"
     }
     

Exemple : Créer un enregistrement LANGUAGES

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez LANGUAGES dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload" comme variable locale.

   {
     "id": 5.0,
     "hinditext": "नमस्ते",
     "englishtest": "Namaste",
     "arabictext": "مرحبا",
     "germantext": "Günther"
   } 
   

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

   {
   "id": 6.0,
   "hinditext": "नमस्ते",
   "englishtest": "Namaste",
   "arabictext": "مرحبا",
   "germantext": "Günther"
   }
   

Exemple : Créer un enregistrement UNICODE

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez UNICODE dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload" comme variable locale.

   {
     "id": 2.0,
     "unicodedata": "Unicode データ型はグローバル化されたデータの保存に使用されます",
     "test": "UnicodeTest"
   }
   

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

{
"id": 2.0,
"unicodedata": "Unicode データ型はグローバル化されたデータの保存に使用されます",
"test": "UnicodeTest"
}

Exemple : Créer un enregistrement SpatialData

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez SpatialData dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload" comme variable locale.

   {
     "id": 10.0,
     "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164548"
   }
   

   Cet exemple crée les enregistrements SpatialData. Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche SpatialData aura une valeur semblable à la suivante :

   {
   "id": 10.0,
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164548"
   }
   

Exemple : Créer un enregistrement Accounts

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Accounts dans la liste Entity.
3. Sélectionnez l'opération Create, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload" comme variable locale.

   {
     "balance": 2000.0,
     "status": "open",
     "id": 7.0
   }
   

   Cet exemple crée les enregistrements SpatialData. Si l'intégration aboutit, le paramètre de réponse connectorOutputPayload de la tâche SpatialData aura une valeur semblable à la suivante :

   {
   "balance": 2000.0,
   "status": "open",
   "id": 7.0
   }
   

Exemple : Mettre à jour un enregistrement Employees

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez "Employees" dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

    {
     "dept": "Comp",
     "designation": "QA"
   }
   

5. Définissez l'ID d'entité dans Data Mapper sur l'entité Employees. Pour définir l'ID d'entité, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 1.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   }
   

Exemple : Mettre à jour un enregistrement LANGUAGES

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez LANGUAGES dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

    {
     "englishtest": "UpdateTest_TEST"
   }
   

5. Définissez l'ID d'entité dans Data Mapper sur l'entité Arrays. Pour définir l'ID d'entité, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 1.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   }
   

Exemple : Mettre à jour un enregistrement UNICODE

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez UNICODE dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

    {
     "unicodedata": "ータ型はグロ",
     "test": "UpdateTest"
   }
   

5. Définissez l'ID d'entité dans Data Mapper sur l'entité ObjectType. Pour définir l'ID d'entité, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 3.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   }
   

Exemple : Mettre à jour un enregistrement SpatialData

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Spatialdata dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   {
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164543"
   } 
   

5. Définissez l'ID d'entité dans Data Mapper sur l'entité TableType. Pour définir l'ID d'entité, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur id= 1.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "id": 1,
   "data": "01020000000500000070CE88D2DE3453C075029A081B164540984C158C4AEA52C0DC68006F81B4444009F9A067B36252C02DB29DEFA7864440FA7E6ABC747B52C0D122DBF97EDA444070CE88D2DE3453C075029A081B164543"
   }
   

Exemple : Mettre à jour un enregistrement Accounts

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Accounts dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   {
   "balance": 1500.0,
   "status": "open"
   }
   

5. Définissez l'ID d'entité dans Data Mapper sur l'entité TableType. Pour définir l'ID d'entité, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur id= 1.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   "id": 1,
   "balance": 1500,
   "status": "open"
   }
   

Exemple : Mettre à jour un enregistrement Cockroach_Datatypes

1. Dans la boîte de dialogue Configure connector task, cliquez sur Entities.
2. Sélectionnez Cockroach_Datatypes dans la liste Entity.
3. Sélectionnez l'opération Update, puis cliquez sur OK.
4. Dans la section Data Mapper de la tâche Mappage de données, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   {
   "col_date": "2019-03-26",
   "col_collate": "Charlie",
   "col_string": "Cruz"
   }
   

5. Définissez l'ID d'entité dans Data Mapper sur l'entité TableType. Pour définir l'ID d'entité, cliquez sur Open Data Mapping Editor, puis saisissez une valeur semblable à la suivante dans le champ Input Value et choisissez "EntityId/ConnectorInputPayload/FilterClause" comme variable locale.

   Au lieu de spécifier l'entityId, vous pouvez définir la filterClause sur 2.

   L'exécution de cet exemple renvoie une réponse semblable à la suivante dans la variable de sortie connectorOutputPayload de la tâche "Connecteurs" :

   {
   }