Couchbase

Mit dem Couchbase-Connector können Sie eine Verbindung zu einer Couchbase-Datenbankinstanz herstellen und die unterstützten Datenbankvorgänge ausführen.

Hinweise

Führen Sie vor der Verwendung des Couchbase-Connectors die folgenden Aufgaben aus:

• In Ihrem Google Cloud-Projekt:
  • Gewähren Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin.
  • Weisen Sie dem Dienstkonto, das Sie für den Connector verwenden möchten, die folgenden IAM-Rollen zu:
    • roles/secretmanager.viewer
    • roles/secretmanager.secretAccessor

    Ein Dienstkonto ist eine spezielle Art von Google-Konto, das einen nicht menschlichen Nutzer repräsentiert. Es muss authentifiziert und autorisiert werden, um Zugriff auf Daten in Google APIs zu erhalten. Wenn Sie kein Dienstkonto haben, müssen Sie eins erstellen. Weitere Informationen finden Sie unter Dienstkonto erstellen.

  • Aktivieren Sie die folgenden Dienste:
    • secretmanager.googleapis.com (Secret Manager API)
    • connectors.googleapis.com (Connectors API)

    Informationen zum Aktivieren von Diensten finden Sie unter Dienste aktivieren.

  Wenn diese Dienste oder Berechtigungen für Ihr Projekt zuvor nicht aktiviert wurden, werden Sie aufgefordert, sie beim Konfigurieren des Connectors zu aktivieren.

Connector konfigurieren

Für die Konfiguration des Connectors müssen Sie eine Verbindung zu Ihrer Datenquelle (Backend-System) erstellen. Eine Verbindung ist für eine Datenquelle spezifisch. Wenn Sie also viele Datenquellen haben, müssen Sie für jede Datenquelle eine separate Verbindung erstellen. So erstellen Sie eine Verbindung:

1. Rufen Sie in der Cloud Console die Seite Integration Connectors > Verbindungen auf und wählen Sie ein Google Cloud-Projekt aus oder erstellen Sie eines.

   Zur Seite „Verbindungen“

2. Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
3. Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
   1. Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.

      Eine Liste aller unterstützten Regionen finden Sie unter Standorte.

   2. Tippen Sie auf Weiter.
4. Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
   1. Connector: Wählen Sie Couchbase aus der Drop-down-Liste der verfügbaren Connectors aus.
   2. Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
   3. Geben Sie im Feld Verbindungsname einen Namen für die Verbindungsinstanz ein.

      Verbindungsnamen müssen die folgenden Kriterien erfüllen:

      • Verbindungsnamen können Buchstaben, Ziffern oder Bindestriche enthalten.
      • Buchstaben müssen Kleinbuchstaben sein.
      • Verbindungsnamen müssen mit einem Buchstaben beginnen und mit einem Buchstaben oder einer Ziffer enden.
      • Verbindungsnamen dürfen maximal 63 Zeichen haben.
   4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
   5. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
   6. Konfigurieren Sie optional die Einstellungen für den Verbindungsknoten:
      • Mindestanzahl von Knoten: Geben Sie die Mindestanzahl von Verbindungsknoten ein.
      • Maximale Anzahl von Knoten: Geben Sie die maximale Anzahl von Verbindungsknoten ein.

      Ein Knoten ist eine Einheit (oder ein Replikat) einer Verbindung, die Transaktionen verarbeitet. Zur Verarbeitung von mehr Transaktionen für eine Verbindung sind mehr Knoten erforderlich. Umgekehrt sind weniger Knoten erforderlich, um weniger Transaktionen zu verarbeiten. Informationen zu den Auswirkungen der Knoten auf Ihre Connector-Preise finden Sie unter Preise für Verbindungsknoten. Wenn Sie keine Werte eingeben, ist die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Knotenzahl auf 50 gesetzt.

   Hinweis: Sie können die Verbindungsknotenwerte nur anpassen, wenn Sie ein „Pay as you go”-Kunde sind.
   7. JSON-Parameter zulassen: Ermöglicht die Verwendung von JSON-Rohdaten in Parametern, wenn QueryPassthrough aktiviert ist.
   8. Analytics-Port: Der Port zum Herstellen einer Verbindung zum Couchbase Analytics-Endpunkt.
   9. Untergeordnetes Trennzeichen: Die Zeichen, die zum Angeben untergeordneter Tabellen verwendet werden.
   10. Cuchbase-Dienst: Bestimmt den Couchbase-Dienst, zu dem eine Verbindung hergestellt werden soll. Der Standardwert ist N1QL. Verfügbare Optionen sind N1QL und Analytics.
   11. RAM-Kontingent für Tabelle erstellen: Das standardmäßige RAM-Kontingent in Megabyte, das beim Einfügen von Buckets über die Syntax CREATE TABLE verwendet werden soll.
   12. Dataverse-Trennzeichen: Die Zeichen, die zur Bezeichnung von Analytics-Dataverses und Bereiche/Sammlungen verwendet werden.
   13. Flavor-Trennzeichen: Die Zeichen, die zum Kennzeichnen von Flavors verwendet werden.
   14. N1QL-Port: Der Port für die Verbindung zum Couchbase-N1QL-Endpunkt.
   15. Trennzeichen für Punkte: Die Zeichen, die zum Angeben der Hierarchie verwendet werden.
   16. Zeitlimit für Abfrageausführung: Setzt das serverseitige Zeitlimit für die Abfrage, das festlegt, wie lange Couchbase die Abfrage ausführt, bevor ein Zeitüberschreitungsfehler zurückgegeben wird.
   17. Strikter Vergleich: Passt an, wie genau Filter bei SQL-Eingabeabfragen in Couchbase-Abfragen übersetzt werden sollen. Dies kann auf eine durch Kommas getrennte Liste von Werten festgelegt werden, wobei jeder Wert einen der folgenden Werte haben kann: Datum, Zahl, boolescher Wert oder String.
   18. Langlebigkeit von Transaktionen: Gibt an, wie ein Dokument gespeichert werden muss, damit eine Transaktion erfolgreich ist. Gibt an, ob N1QL-Transaktionen beim Ausführen von Abfragen verwendet werden sollen.
   19. Transaktionszeitlimit: Setzt den Zeitraum, den eine Transaktion ausführen kann, bevor eine Zeitüberschreitung durch Couchbase erfolgt.
   20. Sammlungen für DDL verwenden: Gibt an, ob CREATE TABLE-Anweisungen Sammlungen anstelle von Flavors verwenden. Wird nur wirksam, wenn eine Verbindung zu Couchbase v7+ hergestellt wird und GenerateSchemaFiles auf OnCreate gesetzt ist.
   21. Transaktionen verwenden: Gibt an, ob beim Ausführen von Abfragen N1QL-Transaktionen verwendet werden sollen.
   22. JSON-Parameter validieren: Der Anbieter kann überprüfen, ob Stringparameter gültige JSON-Parameter sind, bevor die Abfrage an Couchbase gesendet wird.
   23. Proxy verwenden: Klicken Sie dieses Kästchen an, um einen Proxyserver für die Verbindung und die folgenden Werte zu konfigurieren:
   • Proxy-Authentifizierungsschema: Wählen Sie den Authentifizierungstyp für die Authentifizierung beim Proxyserver aus. Die folgenden Authentifizierungstypen werden unterstützt:
     • Standard: Basis-HTTP-Authentifizierung.
     • Digest: Digest-HTTP-Authentifizierung.
   • Proxy User: Ein Nutzername, der für die Authentifizierung beim Proxyserver verwendet wird.
   • Proxy-Passwort: Das Secret Manager-Secret des Nutzerpassworts.
   • Proxy-SSL-Typ: Der SSL-Typ, der beim Herstellen einer Verbindung zum Proxyserver verwendet werden soll. Die folgenden Authentifizierungstypen werden unterstützt:
     • Automatisch: Standardeinstellung. Wenn die URL eine HTTPS-URL ist, wird die Option „Tunnel“ verwendet. Wenn die URL eine HTTP-URL ist, wird die Option NEVER verwendet.
     • Immer: Für die Verbindung ist immer SSL aktiviert.
     • Nie: Die Verbindung ist nicht SSL-fähig.
     • Tunnel: Die Verbindung erfolgt über einen Tunneling-Proxy. Der Proxyserver öffnet eine Verbindung zum Remote-Host und der Traffic fließt über den Proxy hin und her.
   • Geben Sie im Abschnitt Proxyserver Details zum Proxyserver ein.
     1. Klicken Sie auf + Ziel hinzufügen.
     2. Wählen Sie einen Zieltyp aus.
        • Hostadresse: Geben Sie den Hostnamen oder die IP-Adresse des Ziels an.

          Wenn Sie eine private Verbindung zu Ihrem Back-End-System herstellen möchten, gehen Sie so vor:

          • Erstellen Sie einen PSC-Dienstanhang.
          • Erstellen Sie einen Endpunktanhang und geben Sie dann die Details des Endpunktanhangs in das Feld Hostadresse ein.
   24. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
   25. Tippen Sie auf Weiter.
5. Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
   1. Destination Type: Wählen Sie einen Destination Type aus.
      • Wählen Sie aus der Liste Hostadresse aus, um den Hostnamen oder die IP-Adresse für das Ziel anzugeben.
      • Wenn Sie eine private Verbindung zu Ihren Back-End-Systemen herstellen möchten, wählen Sie Endpunktanhang aus der Liste und dann den erforderlichen Endpunktanhang aus der Liste Endpunktanhang aus.
        Hinweis: Informationen zum Erstellen eines Endpunktanhangs finden Sie unter PSC-Dienstanhang und Endpunktanhang. Nachdem Sie den Endpunktanhang erstellt haben, wird er in der Liste Endpunktanhang angezeigt.

      Wenn Sie eine öffentliche Verbindung zu Ihren Back-End-Systemen mit zusätzlicher Sicherheit herstellen möchten, können Sie statische ausgehende IP-Adressen für Ihre Verbindungen konfigurieren und dann Ihre Firewallregeln so konfigurieren, dass nur bestimmte statische IP-Adressen auf die Zulassungsliste gesetzt werden.

      Wenn Sie weitere Ziele eingeben möchten, klicken Sie auf + ZIEL HINZUFÜGEN.

   2. Tippen Sie auf Weiter.
6. Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
   1. Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.

      Die folgenden Authentifizierungstypen werden von der Couchbase-Verbindung unterstützt:

      • Nutzername und Passwort

   Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

   2. Tippen Sie auf Weiter.
7. Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
8. Klicken Sie auf Erstellen.

Authentifizierung konfigurieren

Geben Sie die Details basierend auf der zu verwendenden Authentifizierung ein.

• Nutzername und Passwort
  • Nutzername: Nutzername für den Connector
  • Passwort: Secret Manager-Secret mit dem Passwort, das mit dem Connector verknüpft ist.
  • UseSSL Dieses Feld legt fest, ob SSL aktiviert ist.
  • SSLServerCert SSLServerCert für Couchbase-Connector
  • Auth-Schema: Auth-Schema für Couchbase-Connector
  • Verbindungsmodus: Bestimmt, wie eine Verbindung zum Couchbase-Server hergestellt wird. Muss entweder Direct oder Cloud sein. Für Cloud ist SSL obligatorisch. Weitere Informationen finden Sie unter Verbindungen mit TLS sichern.
  • DNS-Server: Bestimmt, welcher DNS-Server beim Abrufen von Couchbase-Cloud-Informationen verwendet werden soll. Beispiel: 8.8.8.8.

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.

Hinweis: Sie können die Entitäten, Vorgänge und Aktionen eines Connectors in der Connectors-Aufgabe aufrufen.

• 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:
  • Auflisten
  • 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 Entitätsvorgänge unterstützt, werden solche nicht unterstützten Vorgänge nicht in der Liste Operations 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 umfasst 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.

Hinweis : Allen Entitäten und Aktionen ist ein Schema zugeordnet. Ein Aktionsschema enthält beispielsweise Parameterdetails wie die Parameternamen und den entsprechenden Datentyp. Das Schema (Metadaten) für Entitäten und Aktionen wird von der Verbindung zur Laufzeit aus Ihrem Back-End abgerufen. Wenn das Schema aktualisiert wurde, werden diese Aktualisierungen nicht automatisch in Ihren bestehenden Verbindungen berücksichtigt. Sie müssen das Schema manuell aktualisieren. Öffnen Sie zum Aktualisieren des Schemas für eine Verbindung die Seite Verbindungsdetails der Verbindung und klicken Sie dann auf Verbindungsschema aktualisieren.

Aktionen

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

• Benutzerdefinierte gespeicherte Prozeduren und Funktionen: Wenn in Ihrem Back-End gespeicherte Prozeduren und Funktionen vorhanden sind, sind diese in der Spalte Actions des Dialogfelds Configure connector task aufgeführt.
• Benutzerdefinierte SQL-Abfragen: Um benutzerdefinierte SQL-Abfragen auszuführen, bietet der Connector die Aktion Benutzerdefinierte Abfrage ausführen an.

  So erstellen Sie eine benutzerdefinierte Abfrage:

  1. Folgen Sie der detaillierten Anleitung zum Hinzufügen einer Connectors-Aufgabe.
  2. Wählen Sie beim Konfigurieren der Connector-Aufgabe als Typ 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 Bereich Task Input und führen Sie dann die folgenden Schritte aus:
     1. Geben Sie im Feld Zeitüberschreitung nach die Anzahl der Sekunden ein, die bis zur Ausführung der Abfrage gewartet werden soll.

        Standardwert: 180 Sekunden.

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

        Standardwert: 25.

     3. Klicken Sie auf Benutzerdefiniertes Skript bearbeiten, um die benutzerdefinierte Abfrage zu aktualisieren. Das Dialogfeld Skripteditor wird geöffnet.

        

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

        Sie können in einer SQL-Anweisung ein Fragezeichen (?) 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 in der Spalte LastName angegebenen Werten entsprechen:

        SELECT * FROM Employees where LastName=?

        Hinweis:Anweisungen in der Datenbearbeitungssprache (Data Manipulation Language, Datenbearbeitungssprache) und Data Definition Language (DDL) werden unterstützt.
     5. Wenn Sie in Ihrer SQL-Abfrage Fragezeichen verwendet haben, müssen Sie den Parameter hinzufügen, indem Sie bei jedem Fragezeichen auf + Parameternamen hinzufügen klicken. Beim Ausführen der Integration ersetzen diese Parameter die Fragezeichen (?) in der SQL-Abfrage nacheinander. 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 + Suchparameter hinzufügen.

Systembeschränkungen

Der Couchbase-Connector kann 25 Transaktionen pro Sekunde und Knoten verarbeiten und alle Transaktionen über dieses Limit hinaus drosseln. Standardmäßig weist Integration Connectors einer Verbindung 2 Knoten (zur besseren Verfügbarkeit) zu.

Informationen zu den für Integration Connectors geltenden Limits finden Sie unter Beschränkungen.

Hinweis: Die Anzahl der Integration Connectors-Knoten wird je nach Ihrer Nutzung automatisch skaliert. Wenn Sie jedoch Kapazität für große Volumes reservieren möchten, ohne auf das Autoscaling zu warten, können Sie den Mindestknotenwert für eine Verbindung anpassen. Es sind mehr Knoten erforderlich, um mehr Transaktionen für eine Verbindung zu verarbeiten. Umgekehrt sind weniger Knoten erforderlich, wenn über eine Verbindung weniger Transaktionen verarbeitet werden. So konfigurieren Sie die Knotenwerte:

• Wenn Sie „Pay as you go“-Kunde sind, konfigurieren Sie den minimalen und maximalen Knotenwert auf der Seite „Verbindung bearbeiten“.
• Wenn Sie abobasiert sind, wenden Sie sich an den Support.

Die maximale Anzahl von Transaktionen, die ein Knoten verarbeiten kann, hängt von verschiedenen Faktoren ab. Bevor Sie die Mindestanzahl von Knoten für einen besseren Durchsatz anpassen, sollten Sie daher prüfen, ob Ihre Back-End-Systeme optimal für die Verarbeitung des erforderlichen Traffics eingerichtet sind.

Aktionen

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

Hinweis:Die Ergebnisse aller Aktionen sind nach der Einbindung als JSON-Antwort im Antwortparameter connectorOutputPayload der Aufgabe Connectors verfügbar.

Aktion „AddDocument“

Durch diese Aktion werden der Couchbase Dokumente hinzugefügt.

Eingabeparameter der AddDocument-Aktion

Parametername	Datentyp	Erforderlich	Beschreibung
BucketName	String	Yes	Der Bucket, in den das Dokument eingefügt werden soll.
SourceTable	Objekt	Nein	Der Name der temporären Tabelle mit den Spalten „ID“ und „Dokument“. Erforderlich, wenn keine ID angegeben ist.
ID	String	Nein	Der Primärschlüssel, unter dem das Dokument eingefügt werden soll. Erforderlich, wenn keine SourceTable angegeben ist.
Dokument	String	Nein	Der JSON-Text des einzufügenden Dokuments. Erforderlich, wenn keine SourceTable angegeben ist.

Ausgabeparameter der Aktion „AddDocument“

Bei erfolgreicher Aktion wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion AddDocument finden Sie unter Aktionsbeispiele.

CreateCollection-Aktion

Durch diese Aktion wird eine Sammlung in einem vorhandenen Bereich erstellt.

Eingabeparameter der CreateCollection-Aktion

Parametername	Datentyp	Erforderlich	Beschreibung
Bucket	String	Yes	Der Name des Buckets, der die Sammlung enthält.
Bereich	String	Yes	Der Name des Bereichs, der die Sammlung enthält.
Name	String	Yes	Der Name der zu erstellenden Sammlung.

Ausgabeparameter der Aktion CreateCollection

Bei erfolgreicher Aktion wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion CreateCollection finden Sie unter Aktionsbeispiele.

DeleteCollection-Aktion

Durch diese Aktion wird eine Sammlung in einem vorhandenen Bereich gelöscht.

Eingabeparameter der DeleteCollection-Aktion

Parametername	Datentyp	Erforderlich	Beschreibung
Bucket	String	Wahr	Der Name des Buckets, der die Sammlung enthält.
Bereich	String	Wahr	Der Name des Bereichs, der die Sammlung enthält.
Name	String	Wahr	Der Name der zu löschenden Sammlung.

Ausgabeparameter der DeleteCollection-Aktion

Bei erfolgreicher Aktion wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion DeleteCollection finden Sie unter Aktionsbeispiele.

CreateScope-Aktion

Durch diese Aktion wird ein Bereich in einem vorhandenen Bucket erstellt.

Eingabeparameter der CreateScope-Aktion

Parametername	Datentyp	Erforderlich	Beschreibung
Bucket	String	Yes	Der Name des Buckets, der den Bereich enthält
Name	String	Yes	Der Name des zu erstellenden Bereichs.

Ausgabeparameter der CreateScope-Aktion

Bei erfolgreicher Aktion wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion CreateScope finden Sie unter Aktionsbeispiele.

DeleteScope-Aktion

Durch diese Aktion werden ein Bereich und alle zugehörigen Sammlungen gelöscht.

Eingabeparameter der DeleteScope-Aktion

Parametername	Datentyp	Erforderlich	Beschreibung
Bucket	String	Yes	Der Name des Buckets, der den Bereich enthält.
Name	String	Yes	Der Name des zu löschenden Bereichs.

Ausgabeparameter der DeleteScope-Aktion

Bei erfolgreicher Aktion wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion DeleteScope finden Sie unter Aktionsbeispiele.

Aktion „ListIndices“

Dadurch werden alle in Couchbase verfügbaren Indizes aufgelistet.

Eingabeparameter der Aktion „ListIndices“

–

Ausgabeparameter der Aktion ListIndices

Bei erfolgreicher Aktion wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion ListIndices finden Sie unter Aktionsbeispiele.

Aktion „ManageIndices“

Durch diese Aktion wird ein Index in einem Bucket erstellt oder gelöscht.

Eingabeparameter der Aktion „ManageIndices“

Parametername	Datentyp	Erforderlich	Beschreibung
BucketName	String	Yes	Der Ziel-Bucket, aus dem der Index erstellt oder gelöscht werden soll.
ScopeName	Objekt	Nein	Der Zielbereich, aus dem der Index erstellt oder gelöscht werden soll (Couchbase Version 7 und höher)
CollectionName	String	Nein	Die Zielsammlung, aus der der Index erstellt oder gelöscht werden soll (Couchbase Version 7 und höher)
Vorgang	String	Yes	Gibt an, welche Aktion für den Index ausgeführt werden soll. Kann „Erstellen“ oder „Ablegen“ sein.
Ausdrücke	String	Nein	Eine Liste von Ausdrücken oder Funktionen, codiert als JSON, auf der der Index basiert. Mindestens ein Wert ist erforderlich, wenn „IsPrimary“ auf „false“ gesetzt und die Aktion „Create“ (Erstellen) ist.
Name	String	Nein	Der Name des zu erstellenden oder zu löschenden Index, erforderlich, wenn „IsPrimary“ auf „false“ gesetzt ist.
IsPrimary	String	Nein	Gibt an, ob der Index ein Primärindex sein soll.Der Standardwert ist „true“.
Filter	String	Nein	Eine als JSON codierte Liste von Filtern, die auf den Index angewendet werden sollen.
IndexType	String	Nein	Der zu erstellende Indextyp, kann GSI oder View sein. Er wird nur verwendet, wenn die Aktion "Erstellen" lautet. Der Standardwert ist GSI.
ViewName	String	Nein	Eingestellt, nur aus Kompatibilitätsgründen enthalten. Tut nichts.
Knoten	String	Nein	Eine als JSON codierte Liste von Knoten, die den Index enthalten sollen, muss den Port enthalten. Wird nur verwendet, wenn die Aktion „Erstellen“ ist.
NumReplica	String	Nein	Die Anzahl der Replikate, die unter den Indexknoten im Cluster erstellt werden sollen.

Ausgabeparameter der Aktion ManageIndices

Bei erfolgreicher Aktion wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion ManageIndices finden Sie unter Aktionsbeispiele.

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. Wählen Sie beim Konfigurieren der Connector-Aufgabe als Typ 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 Bereich Task Input und führen Sie dann die folgenden Schritte aus:
   1. Geben Sie im Feld Zeitüberschreitung nach die Anzahl der Sekunden ein, die bis zur Ausführung der Abfrage gewartet werden soll.

      Standardwert: 180 Sekunden.

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

      Standardwert: 25.

   3. Klicken Sie auf Benutzerdefiniertes Skript bearbeiten, um die benutzerdefinierte Abfrage zu aktualisieren. Das Dialogfeld Skripteditor wird geöffnet.

      

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

      Sie können in einer SQL-Anweisung ein Fragezeichen (?) 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 in der Spalte LastName angegebenen Werten entsprechen:

      SELECT * FROM Employees where LastName=?

      Hinweis:Anweisungen in der Datenbearbeitungssprache (Data Manipulation Language, Datenbearbeitungssprache) und Data Definition Language (DDL) werden unterstützt.
   5. Wenn Sie in Ihrer SQL-Abfrage Fragezeichen verwendet haben, müssen Sie den Parameter hinzufügen, indem Sie bei jedem Fragezeichen auf + Parameternamen hinzufügen klicken. Beim Ausführen der Integration ersetzen diese Parameter die Fragezeichen (?) in der SQL-Abfrage nacheinander. 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 + Suchparameter hinzufügen.

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

Aktionsbeispiele

In diesem Abschnitt wird beschrieben, wie Sie einige 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 Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe AddDocument einen Wert, der in etwa so aussieht:

[{
"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 Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

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

In diesem Beispiel wird eine Sammlung unter der TestScope erstellt. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe CreateCollection einen Wert, der in etwa so aussieht:

[{
"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 Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden 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 der Aufgabe CreateCollection einen Wert ähnlich dem folgenden:

[{
"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 Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

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

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

[{
"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 Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

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

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

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

Beispiel – Indexe auflisten

In diesem Beispiel werden alle in Couchbase verfügbaren Indizes aufgelistet.

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 Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

   {
   }

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe ListIndices einen Wert, der in etwa so aussieht:

[{
"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 Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

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

Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe ManageIndices einen Wert ähnlich dem folgenden:

[{
"Success": "true"
}]

Beispiele für Entitätsvorgänge

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

Beispiel – Alle Einträge 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ähle TestCollection aus der Entity-Liste aus.
3. Wählen Sie den Vorgang List aus und klicken Sie dann auf Fertig.
4. Optional können Sie im Bereich Aufgabeneingabe der Aufgabe Connectors die Ergebnisse 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 von der Entität TestCollection abgerufen.

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

   Hier ist 120 eine eindeutige Eintrags-ID in der Entität TestCollection.

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ähle TestCollection aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann in das Feld Default Value einen Wert wie den folgenden ein:

   {
   "COL_TEXT": "CouchBase Update"
   }

5. Klicken Sie auf entityId und geben Sie im Feld Default Value (Standardwert) 120 ein.

   Ist die Integration erfolgreich, hat das Feld connectorOutputPayload der Connector-Aufgabe einen Wert ähnlich dem folgenden:

   [{
   "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ähle TestCollection aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Delete aus und klicken Sie auf Fertig.
4. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf entityId und geben Sie im Feld Default Value (Standardwert) 20 ein.

Hinweis: Wenn Ihre Entität einen zusammengesetzten Primärschlüssel hat, können Sie eine Filterklausel angeben.

Bekannte Probleme

Der create-Vorgang wird für Entitäten nicht unterstützt.

Verbindungen mit Terraform erstellen

Sie können mit der Terraform-Ressource eine neue Verbindung erstellen.

Informationen zum Anwenden oder Entfernen einer Terraform-Konfiguration finden Sie unter Grundlegende Terraform-Befehle.

Eine Beispiel-Terraform-Vorlage zum Erstellen von Verbindungen finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mithilfe von Terraform erstellen, müssen Sie die folgenden Variablen in der Terraform-Konfigurationsdatei festlegen:

Parametername	Datentyp	Erforderlich	Beschreibung
allow_jsonparameters	BOOLEAN	Falsch	Ermöglicht die Verwendung von JSON-Rohdaten in Parametern, wenn QueryPassthrough aktiviert ist.
analytics_port	STRING	Falsch	Der Port für die Verbindung zum Couchbase Analytics-Endpunkt.
child_separator	STRING	Falsch	Das Zeichen oder die Zeichen, die zur Kennzeichnung untergeordneter Tabellen verwendet werden.
couchbase_service	ENUM	Falsch	Legt den Couchbase-Dienst fest, zu dem eine Verbindung hergestellt werden soll. Der Standardwert ist N1QL. Verfügbare Optionen sind N1QL und Analytics. Unterstützte Werte: N1QL, Analytics
create_table_ram_quota	STRING	Falsch	Das Standard-RAM-Kontingent in Megabyte, das beim Einfügen von Buckets über die Syntax CREATE TABLE verwendet wird.
dataverse_separator	STRING	Falsch	Das oder die Zeichen, das bzw. die zur Kennzeichnung von Analytics-Dataverses und -Bereichen/-Sammlungen verwendet werden.
flavor_separator	STRING	Falsch	Das Zeichen oder die Zeichen, das bzw. die zur Kennzeichnung von Geschmacksrichtungen verwendet werden.
n1_qlport	STRING	Falsch	Der Port für die Verbindung zum Couchbase N1QL-Endpunkt.
periods_separator	STRING	Falsch	Zeichen, mit dem/denen die Hierarchie gekennzeichnet wird.
query_execution_timeout	STRING	Falsch	Damit wird die serverseitige Zeitüberschreitung für die Abfrage festgelegt. Diese bestimmt, wie lange Couchbase die Abfrage ausführt, bevor ein Zeitüberschreitungsfehler zurückgegeben wird.
strict_comparison	STRING	Falsch	Passt an, wie genau Filter aus SQL-Eingabeabfragen in Couchbase-Abfragen übersetzt werden sollen. Dies kann auf eine durch Kommas getrennte Liste von Werten festgelegt werden, wobei jeder Wert einen der folgenden Werte haben kann: Datum, Zahl, boolescher Wert oder String.
transaction_durability	STRING	Falsch	Gibt an, wie ein Dokument gespeichert werden muss, damit eine Transaktion erfolgreich ist. Gibt an, ob N1QL-Transaktionen beim Ausführen von Abfragen verwendet werden sollen.
transaction_timeout	STRING	Falsch	Damit wird festgelegt, wie lange eine Transaktion ausgeführt werden kann, bevor von Couchbase eine Zeitüberschreitung auftritt.
use_collections_for_ddl	BOOLEAN	Falsch	Gibt an, ob CREATE TABLE-Anweisungen Sammlungen anstelle von Flavors verwenden. Wird nur wirksam, wenn eine Verbindung zu Couchbase v7+ hergestellt wird und GenerateSchemaFiles auf OnCreate gesetzt ist.
use_transactions	STRING	Falsch	Gibt an, ob N1QL-Transaktionen beim Ausführen von Abfragen verwendet werden sollen.
validate_jsonparameters	BOOLEAN	Falsch	Ermöglicht dem Anbieter, vor dem Senden der Abfrage an Couchbase zu prüfen, ob Stringparameter gültig sind.
proxy_enabled	BOOLEAN	Falsch	Wählen Sie dieses Kontrollkästchen aus, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme	ENUM	Falsch	Der für die Authentifizierung beim ProxyServer-Proxy zu verwendende Authentifizierungstyp. Unterstützte Werte: BASIC, DIGEST, NONE
proxy_user	STRING	Falsch	Ein Nutzername, der für die Authentifizierung beim ProxyServer-Proxy verwendet werden soll.
proxy_password	SECRET	Falsch	Ein Passwort, das zur Authentifizierung beim ProxyServer-Proxy verwendet wird.
proxy_ssltype	ENUM	Falsch	Der SSL-Typ, der beim Herstellen einer Verbindung zum ProxyServer-Proxy verwendet werden soll. Unterstützte Werte sind: AUTO, ALWAYS, NEVER, TUNNEL
Ausführlichkeit	STRING	Falsch	Ausführlichkeitsstufe für Verbindung: zwischen 1 und 5. Bei einem höheren Ausführlichkeitsgrad werden alle Kommunikationsdetails (Anfrage-, Antwort- und SSL-Zertifikate) protokolliert.

Couchbase-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie in Apigee Integration und Application Integration verfügbar. Sie können die Verbindung in einer Integration über die Connectors-Aufgabe verwenden.

• Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in der Apigee-Integration finden Sie unter Connectors-Aufgabe.
• Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Application Integration finden Sie unter Connectors.

Hilfe von der Google Cloud-Community erhalten

Sie können Ihre Fragen und Anregungen zu diesem Connector in der Google Cloud-Community unter Cloud-Foren posten.

Nächste Schritte

• Informationen zum Anhalten und Fortsetzen einer Verbindung
• Informationen zum Überwachen der Connector-Nutzung
• Weitere Informationen zum Aufrufen von Connector-Logs