Couchbase

Entitäten, Vorgänge und Aktionen

Alle Integration Connectors bieten eine Abstraktionsebene für die Objekte der verbundenen Anwendung. Sie können nur über diese Abstraktion auf die Objekte einer Anwendung zugreifen. Die Abstraktion wird Ihnen als Entitäten, Vorgänge und Aktionen zur Verfügung gestellt.

• Entität: Eine Entität kann als Objekt oder Sammlung von Attributen in der verbundenen Anwendung oder im verbundenen Dienst verstanden werden. Die Definition einer Entität unterscheidet sich von Connector zu Connector. Beispiel: In einem Datenbank-Connector sind Tabellen die Entitäten, in einem Dateiserver-Connector sind Ordner die Entitäten und in einem Nachrichtensystem-Connector sind Warteschlangen die Entitäten.

  Es ist jedoch möglich, dass ein Connector keine Entitäten unterstützt oder keine Entitäten enthält. In diesem Fall ist die Liste Entities leer.

• Vorgang: Ein Vorgang ist die Aktivität, die Sie für eine Entität ausführen können. Sie können einen der folgenden Vorgänge für eine Entität ausführen:
  • Liste
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Wenn ein Connector jedoch keine der Entitätsvorgänge unterstützt, werden diese nicht unterstützten Vorgänge nicht in der Operations-Liste aufgeführt.

• Aktion: Eine Aktion ist eine Funktion erster Klasse, die über die Connector-Benutzeroberfläche für die Integration verfügbar gemacht wird. Mit einer Aktion können Sie Änderungen an einer oder mehreren Entitäten vornehmen, die von Connector zu Connector unterschiedlich sind. Normalerweise hat eine Aktion einige Eingabeparameter und einen Ausgabeparameter. Es ist jedoch möglich, dass ein Connector keine Aktionen unterstützt. In diesem Fall ist die Actions-Liste leer.

Aktionen

Dieser Connector unterstützt die Ausführung der folgenden Aktionen:

• Benutzerdefinierte gespeicherte Prozeduren und Funktionen: Wenn Sie gespeicherte Prozeduren und Funktionen in Ihrem Backend haben, werden diese im Dialogfeld Configure connector task in der Spalte Actions aufgeführt.
• Benutzerdefinierte SQL-Abfragen: Zum Ausführen benutzerdefinierter SQL-Abfragen bietet der Connector die Aktion Benutzerdefinierte Abfrage ausführen.

  So erstellen Sie eine benutzerdefinierte Abfrage:

  1. Folgen Sie der detaillierten Anleitung zum Hinzufügen einer Connectors-Aufgabe.
  2. Wenn Sie die Connector-Aufgabe konfigurieren, wählen Sie unter „Art der auszuführenden Aktion“ die Option Aktionen aus.
  3. Wählen Sie in der Liste Aktion die Option Benutzerdefinierte Abfrage ausführen aus und klicken Sie dann auf Fertig.

     

  4. Maximieren Sie den Abschnitt Aufgabeneingabe und gehen Sie dann so vor:
     1. Geben Sie im Feld Zeitlimit nach die Anzahl der Sekunden ein, die gewartet werden soll, bis die Abfrage ausgeführt wird.

        Standardwert: 180 Sekunden.

     2. Geben Sie im Feld Maximale Zeilenanzahl die maximale Anzahl der Zeilen ein, die aus der Datenbank zurückgegeben werden sollen.

        Standardwert: 25.

     3. Wenn Sie die benutzerdefinierte Abfrage aktualisieren möchten, klicken Sie auf Benutzerdefiniertes Skript bearbeiten. Das Dialogfeld Skripteditor wird geöffnet.

        

     4. Geben Sie im Dialogfeld Skripteditor die SQL-Abfrage ein und klicken Sie auf Speichern.

        Sie können ein Fragezeichen (?) in einer SQL-Anweisung verwenden, um einen einzelnen Parameter darzustellen, der in der Liste der Abfrageparameter angegeben werden muss. Mit der folgenden SQL-Abfrage werden beispielsweise alle Zeilen aus der Tabelle Employees ausgewählt, die den für die Spalte LastName angegebenen Werten entsprechen:

        SELECT * FROM Employees where LastName=?

     5. Wenn Sie Fragezeichen in Ihrer SQL-Abfrage verwendet haben, müssen Sie den Parameter hinzufügen, indem Sie für jedes Fragezeichen auf + Parameternamen hinzufügen klicken. Bei der Ausführung der Integration werden diese Parameter sequenziell durch die Fragezeichen (?) in der SQL-Abfrage ersetzt. Wenn Sie beispielsweise drei Fragezeichen (?) hinzugefügt haben, müssen Sie drei Parameter in der richtigen Reihenfolge hinzufügen.

        

        So fügen Sie Abfrageparameter hinzu:

        1. Wählen Sie in der Liste Typ den Datentyp des Parameters aus.
        2. Geben Sie im Feld Wert den Wert des Parameters ein.
        3. Wenn Sie mehrere Parameter hinzufügen möchten, klicken Sie auf + Abfrageparameter hinzufügen.

Aktionen

In diesem Abschnitt werden die vom Connector unterstützten Aktionen aufgeführt. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.

AddDocument-Aktion

Durch diese Aktion werden Dokumente in Couchbase hinzugefügt.

Eingabeparameter der AddDocument-Aktion

Ausgabeparameter der AddDocument-Aktion

Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) zurück.

Beispiele für die Konfiguration der AddDocument-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „CreateCollection“

Mit dieser Aktion wird eine Sammlung in einem vorhandenen Bereich erstellt.

Eingabeparameter der Aktion „CreateCollection“

Ausgabeparameter der Aktion „CreateCollection“

Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) zurück.

Beispiele für die Konfiguration der CreateCollection-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „DeleteCollection“

Mit dieser Aktion wird eine Sammlung in einem vorhandenen Bereich gelöscht.

Eingabeparameter der Aktion „DeleteCollection“

Ausgabeparameter der Aktion „DeleteCollection“

Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) zurück.

Beispiele für die Konfiguration der DeleteCollection-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „CreateScope“

Mit dieser Aktion wird ein Bereich in einem vorhandenen Bucket erstellt.

Eingabeparameter der Aktion „CreateScope“

Ausgabeparameter der Aktion „CreateScope“

Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) zurück.

Beispiele für die Konfiguration der CreateScope-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „DeleteScope“

Durch diese Aktion wird ein Bereich mit allen zugehörigen Sammlungen gelöscht.

Eingabeparameter der Aktion „DeleteScope“

Ausgabeparameter der Aktion „DeleteScope“

Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) zurück.

Beispiele für die Konfiguration der DeleteScope-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „ListIndices“

Mit dieser Aktion werden alle in Couchbase verfügbaren Indexe aufgeführt.

Eingabeparameter der ListIndices-Aktion

Ausgabeparameter der Aktion „ListIndices“

Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) zurück.

Beispiele für die Konfiguration der ListIndices-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „ManageIndices“

Mit dieser Aktion wird ein Index in einem Bucket erstellt oder gelöscht.

Eingabeparameter der ManageIndices-Aktion

Ausgabeparameter der ManageIndices-Aktion

Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) zurück.

Beispiele für die Konfiguration der ManageIndices-Aktion finden Sie unter Beispiele für Aktionen.

Aktion „ExecuteCustomQuery“

Mit dieser Aktion können Sie eine benutzerdefinierte Abfrage ausführen.

So erstellen Sie eine benutzerdefinierte Abfrage:

1. Folgen Sie der detaillierten Anleitung zum Hinzufügen einer Connectors-Aufgabe.
2. Wenn Sie die Connector-Aufgabe konfigurieren, wählen Sie unter „Art der auszuführenden Aktion“ die Option Aktionen aus.
3. Wählen Sie in der Liste Aktion die Option Benutzerdefinierte Abfrage ausführen aus und klicken Sie dann auf Fertig.

   

4. Maximieren Sie den Abschnitt Aufgabeneingabe und gehen Sie dann so vor:
   1. Geben Sie im Feld Zeitlimit nach die Anzahl der Sekunden ein, die gewartet werden soll, bis die Abfrage ausgeführt wird.

      Standardwert: 180 Sekunden.

   2. Geben Sie im Feld Maximale Zeilenanzahl die maximale Anzahl der Zeilen ein, die aus der Datenbank zurückgegeben werden sollen.

      Standardwert: 25.

   3. Wenn Sie die benutzerdefinierte Abfrage aktualisieren möchten, klicken Sie auf Benutzerdefiniertes Skript bearbeiten. Das Dialogfeld Skripteditor wird geöffnet.

      

   4. Geben Sie im Dialogfeld Skripteditor die SQL-Abfrage ein und klicken Sie auf Speichern.

      Sie können ein Fragezeichen (?) in einer SQL-Anweisung verwenden, um einen einzelnen Parameter darzustellen, der in der Liste der Abfrageparameter angegeben werden muss. Mit der folgenden SQL-Abfrage werden beispielsweise alle Zeilen aus der Tabelle Employees ausgewählt, die den für die Spalte LastName angegebenen Werten entsprechen:

      SELECT * FROM Employees where LastName=?

   5. Wenn Sie Fragezeichen in Ihrer SQL-Abfrage verwendet haben, müssen Sie den Parameter hinzufügen, indem Sie für jedes Fragezeichen auf + Parameternamen hinzufügen klicken. Bei der Ausführung der Integration werden diese Parameter sequenziell durch die Fragezeichen (?) in der SQL-Abfrage ersetzt. Wenn Sie beispielsweise drei Fragezeichen (?) hinzugefügt haben, müssen Sie drei Parameter in der richtigen Reihenfolge hinzufügen.

      

      So fügen Sie Abfrageparameter hinzu:

      1. Wählen Sie in der Liste Typ den Datentyp des Parameters aus.
      2. Geben Sie im Feld Wert den Wert des Parameters ein.
      3. Wenn Sie mehrere Parameter hinzufügen möchten, klicken Sie auf + Abfrageparameter hinzufügen.

Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) mit einem Antworttext zurück, der die Abfrageergebnisse enthält.

Beispiele für Aktionen

In diesem Abschnitt wird beschrieben, wie Sie einige der Aktionen in diesem Connector ausführen.

Beispiel: Dokument hinzufügen

In diesem Beispiel wird ein Dokument in einem Couchbase-Bucket hinzugefügt.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion AddDocument aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

Wenn die Aktion erfolgreich ist, hat der connectorOutputPayload-Antwortparameter der AddDocument-Aufgabe einen Wert, der dem folgenden ähnelt:

[{
"RowsAffected": "1"
}]

Beispiel: Sammlung erstellen

In diesem Beispiel wird eine Sammlung erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CreateCollection aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

In diesem Beispiel wird eine Sammlung unter TestScope erstellt. Wenn die Aktion erfolgreich ist, hat der connectorOutputPayload-Antwortparameter der CreateCollection-Aufgabe einen Wert, der dem folgenden ähnelt:

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

Beispiel: Sammlung löschen

In diesem Beispiel wird eine Sammlung gelöscht.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion DeleteCollection aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

In diesem Beispiel wird eine Sammlung unter TestScope gelöscht. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des CreateCollection-Vorgangs einen Wert, der dem folgenden ähnelt:

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

Beispiel: Bereich erstellen

In diesem Beispiel wird ein Bereich erstellt.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion CreateScope aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

In diesem Beispiel wird ein Bereich unter CouchbaseTestBucket erstellt. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des CreateScope-Vorgangs einen Wert, der dem folgenden ähnelt:

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

Beispiel: Bereich löschen

In diesem Beispiel wird ein Bereich gelöscht.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion DeleteScope aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

In diesem Beispiel wird der Bereich ScopeFromGoogleCloud gelöscht. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des DeleteScope-Vorgangs einen Wert, der dem folgenden ähnelt:

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

Beispiel: Indexe auflisten

In diesem Beispiel werden alle in Couchbase verfügbaren Indexe aufgeführt.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion ListIndices aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des ListIndices-Vorgangs einen Wert ähnlich dem folgenden:

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

Beispiel – Indexe verwalten

In diesem Beispiel wird ein Index im angegebenen Bucket gelöscht.

1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
2. Wählen Sie die Aktion ManageIndices aus und klicken Sie auf Fertig.
3. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload des ManageIndices-Vorgangs einen Wert, der dem folgenden ähnelt:

[{
"Success": "true"
}]

Beispiele für Entitätsvorgänge

In diesem Abschnitt wird beschrieben, wie Sie einige Entitätsvorgänge in diesem Connector ausführen.

Beispiel: Alle Datensätze auflisten

In diesem Beispiel werden alle Datensätze in der Entität TestCollection aufgelistet.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie TestCollection aus der Liste Entity aus.
3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
4. Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors das Ergebnisset filtern, indem Sie eine Filterklausel angeben. Geben Sie den Wert der Filterklausel immer in einfachen Anführungszeichen (') an.

Beispiel: Datensatz aus einer Entität abrufen

In diesem Beispiel wird ein Datensatz mit der angegebenen ID aus der TestCollection-Entität abgerufen.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie TestCollection aus der Liste Entity aus.
3. Wählen Sie den Vorgang Get aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf EntityId und geben Sie dann 120 in das Feld Standardwert ein.

   Dabei ist 120 eine eindeutige Datensatz-ID in der TestCollection-Entität.

Beispiel: Datensatz in einer Entität aktualisieren

In diesem Beispiel wird ein Datensatz in der Entität TestCollection aktualisiert.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie TestCollection aus der Liste Entity aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in Feld Default Value ein:

   {
   "COL_TEXT": "CouchBase Update"
   }

5. Klicken Sie auf entityId und geben Sie dann 120 in das Feld Standardwert ein.

   Wenn die Integration erfolgreich ist, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert, der dem folgenden ähnelt:

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

Beispiel: Datensatz aus einer Entität löschen

In diesem Beispiel wird der Datensatz mit der angegebenen ID in der Entität TestCollection gelöscht.

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wählen Sie TestCollection aus der Liste Entity aus.
3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann 20 in das Feld Standardwert ein.