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:
    • Weisen Sie dem Nutzer, der den Connector konfiguriert, die IAM-Rolle roles/connectors.admin zu.
    • 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 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, wird die Mindestanzahl von Knoten standardmäßig auf 2 (für eine bessere Verfügbarkeit) und die maximale Anzahl von Knoten auf 50 festgelegt.

    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 zur Authentifizierung beim Proxyserver verwendet werden soll.
      • 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: Die Verbindung ist immer SSL aktiviert.
        • Nie: Die Verbindung ist nicht SSL-fähig.
        • Tunnel: Die Verbindung erfolgt über einen Tunneling-Proxy. Der Proxyserver stellt eine Verbindung zum Remote-Host her und der Traffic fließt über den Proxy hin und her.
      • Geben Sie im Abschnitt Proxyserver die Details des Proxyservers 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. Zieltyp: Wählen Sie einen Zieltyp aus.
      1. Geben Sie im Feld Hostadresse den Hostnamen oder die IP-Adresse des Ziels ein.
        1. Wenn Sie eine private Verbindung zu Ihren Back-End-Systemen herstellen möchten, gehen Sie so vor:
          1. Erstellen Sie einen PSC-Dienstanhang.
          2. Erstellen Sie einen Endpunktanhang und geben Sie dann die Details des Endpunktanhangs in das Feld Hostadresse ein.
        2. 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 konfigurieren, um nur bestimmte statische IP-Adressen zuzulassen.

      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

      2. 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 Sichere Verbindungen mit TLS.
    • 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.

  • 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:

    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 keinen der 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. 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 in Ihrem Back-End Prozeduren und Funktionen gespeichert sind, werden diese in der Spalte Actions des Dialogfelds Configure connector task 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 Connector-Aufgabe.
    2. Wenn Sie die Connector-Aufgabe konfigurieren, wählen Sie als Aktionstyp 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 Aufgabeneingabe und gehen Sie so vor:
      1. Geben Sie im Feld Zeitlimit nach ein, wie viele Sekunden auf die Ausführung der Abfrage gewartet werden soll.

        Standardwert: 180 Sekunden.

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

        Standardwert: 25.

      3. Klicken Sie auf Benutzerdefinierte Abfrage 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=?

      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 Reihenfolge der 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.

Systemeinschränkungen

Der Couchbase-Connector kann 25 Transaktionen pro Sekunde und Knoten verarbeiten und Transaktionen über dieses Limit hinaus drosseln. Standardmäßig weisen Integration Connectors einer Verbindung zwei Knoten zu, um die Verfügbarkeit zu verbessern.

Informationen zu den Limits, die für Integration Connectors gelten, finden Sie hier.

Aktionen

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

Aktion „AddDocument“

Diese Aktion fügt Dokumente in der Couchbase hinzu.

Eingabeparameter der Aktion „AddDocument“

Parametername Datentyp Erforderlich Beschreibung
BucketName String Ja 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 wurde.
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 SourceTable nicht angegeben ist.

Ausgabeparameter der Aktion „AddDocument“

Wenn die Aktion erfolgreich ist, 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 Ja Der Name des Buckets, der die Sammlung enthält.
Geltungsbereich String Ja Der Name des Bereichs, der die Sammlung enthält.
Name String Ja Der Name der zu erstellenden Sammlung.

Ausgabeparameter der CreateCollection-Aktion

Wenn die Aktion erfolgreich ist, 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.
Geltungsbereich 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

Wenn die Aktion erfolgreich ist, 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 Ja Der Name des Buckets mit dem Bereich
Name String Ja Der Name des zu erstellenden Bereichs.

Ausgabeparameter der CreateScope-Aktion

Wenn die Aktion erfolgreich ist, 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 Ja Der Name des Buckets, der den Bereich enthält.
Name String Ja Der Name des zu löschenden Bereichs.

Ausgabeparameter der DeleteScope-Aktion

Wenn die Aktion erfolgreich ist, wird der Status 200 (OK) zurückgegeben.

Informationen zum Konfigurieren der Aktion DeleteScope finden Sie unter Aktionsbeispiele.

ListIndices-Aktion

Durch diese Aktion werden alle in Couchbase verfügbaren Indizes aufgelistet.

Eingabeparameter der ListIndices-Aktion

–

Ausgabeparameter der ListIndices-Aktion

Wenn die Aktion erfolgreich ist, 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 Ja 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)
Aktion String Ja Gibt an, welche Aktion für den Index ausgeführt werden soll: Erstellen oder Löschen.
Ausdrücke String Nein Eine Liste von Ausdrücken oder Funktionen, codiert im JSON-Format, auf denen der Index basiert. Wenn „IsPrimary“ auf „false“ gesetzt ist und die Aktion „Create“ lautet, ist mindestens eine erforderlich.
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ärer Index sein soll.Der Standardwert ist „true“.
Filter String Nein Eine Liste von Filtern, codiert als JSON, die auf den Index angewendet werden sollen.
IndexType String Nein Der zu erstellende Indextyp, z. B. „GSI“ oder „View“, wird nur verwendet, wenn die Aktion „Erstellen“ ist. Der Standardwert ist GSI.
ViewName String Nein Eingestellt, nur aus Kompatibilitätsgründen enthalten. Tut nichts.
Knoten String Nein Eine im JSON-Format codierte Liste mit Knoten, die den Index enthalten, 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

Wenn die Aktion erfolgreich ist, 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 Connector-Aufgabe.
  2. Wenn Sie die Connector-Aufgabe konfigurieren, wählen Sie als Aktionstyp 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 Aufgabeneingabe und gehen Sie so vor:
    1. Geben Sie im Feld Zeitlimit nach ein, wie viele Sekunden auf die Ausführung der Abfrage gewartet werden soll.

      Standardwert: 180 Sekunden.

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

      Standardwert: 25.

    3. Klicken Sie auf Benutzerdefinierte Abfrage 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=?

    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 Reihenfolge der 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 können.

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 in das Feld Default Value einen Wert ähnlich dem folgenden ein: 
    {
"Document": "{\"ID\":10,\"Name\":\"TestDoc\"}",
"BucketName": "CouchbaseTestBucket",
"ID": "Test"
}

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

    [{
"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 in das Feld Default Value einen Wert ähnlich dem folgenden ein: 
    {
"bucket": "CouchbaseTestBucket",
"scope": "TestScope",
"name": "CollectionFromGoogleCloud"
}

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

    [{
"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 einen Wert wie den folgenden in das Feld Default Value ein: 
    {
"bucket": "CouchbaseTestBucket",
"scope": "TestScope",
"name": "CollectionFromGoogleCloud"
}

    4. In diesem Beispiel wird eine Sammlung unter dem TestScope gelöscht. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe CreateCollection einen Wert wie dieser:

    [{
"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 einen Wert wie den folgenden in das Feld Default Value ein: 
    {
"bucket": "CouchbaseTestBucket",
"name": "ScopeFromGoogleCloud"
}

    4. In diesem Beispiel wird ein Bereich unter CouchbaseTestBucket erstellt. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe CreateScope einen Wert wie dieser:

    [{
"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 einen Wert wie den folgenden in das Feld Default Value ein: 
    {
"bucket": "CouchbaseTestBucket",
"name": "ScopeFromGoogleCloud"
}

    4. In diesem Beispiel wird der Bereich ScopeFromGoogleCloud gelöscht. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe DeleteScope einen Wert wie dieser:

    [{
"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 einen Wert wie den folgenden in das Feld Default Value ein: 
    {
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe ListIndices einen Wert wie der folgende:

    [{
"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 einen Wert wie den folgenden in das Feld Default Value ein: 
    {
"BucketName": "CouchbaseTestBucket",
"Action": "DROP",
"Name": "CouchBaseTestIndex"
}

    4. Wenn die Aktion erfolgreich ist, hat der Antwortparameter connectorOutputPayload der Aufgabe ManageIndices einen Wert wie dieser:

    [{
"Success": "true"
}]

Beispiele für Entitätsvorgang

In diesem Abschnitt wird beschrieben, 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 TestCollection-Entität 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 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 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 Entitäts-ID und geben Sie 120 in das Feld Standardwert ein.

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

Beispiel – Eintrag in einer Entität aktualisieren

In diesem Beispiel wird ein Eintrag 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 in das Feld Default Value einen Wert ähnlich dem folgenden ein: 
    {
"COL_TEXT": "CouchBase Update"
}
  5. Klicken Sie auf entityId und geben Sie 120 in das Feld Standardwert ein.

    Wenn die Integration erfolgreich ist, enthält das Feld connectorOutputPayload der Connector-Aufgabe einen Wert wie diesen:

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

Beispiel – Eintrag aus einer Entität löschen

In diesem Beispiel wird der Datensatz mit der angegebenen ID in der TestCollection-Entität 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 20 in das Feld Standardwert ein.

Bekannte Probleme

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

Mit Terraform Verbindungen erstellen

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

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

Ein Beispiel für eine Terraform-Vorlage zum Erstellen von Verbindungen finden Sie unter Beispielvorlage.

Wenn Sie diese Verbindung mit 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 zum Verbinden mit dem Couchbase-Analyseendpunkt.
child_separator STRING Falsch Das Zeichen, das oder die zur Kennzeichnung von untergeordneten Tabellen verwendet werden.
couchbase_service ENUM Falsch Bestimmt den Couchbase-Dienst, 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, mit denen Analytics-Datenverständnisse und -Bereiche/Sammlungen angegeben werden.
flavor_separator STRING Falsch Das oder die Zeichen, die zur Angabe von Geschmacksrichtungen verwendet werden.
n1_qlport STRING Falsch Der Port zum Verbinden mit dem Couchbase N1QL-Endpunkt.
periods_separator STRING Falsch Das Zeichen, das oder die zur Angabe der Hierarchie verwendet werden.
query_execution_timeout STRING Falsch Dadurch wird das serverseitige Zeitlimit für die Abfrage festgelegt, das 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 Dies legt die Zeitspanne fest, in der eine Transaktion ausgeführt werden kann, bevor sie von der Couchbase zu einer Zeitüberschreitung führt.
use_collections_for_ddl BOOLEAN Falsch Gibt an, ob davon ausgegangen werden soll, dass CREATE TABLE-Anweisungen Sammlungen anstelle von Geschmacksrichtungen 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, zu prüfen, ob Stringparameter gültig sind, bevor die Abfrage an die Couchbase gesendet wird.
proxy_enabled BOOLEAN Falsch Aktivieren Sie dieses Kästchen, um einen Proxyserver für die Verbindung zu konfigurieren.
proxy_auth_scheme ENUM Falsch Der Authentifizierungstyp, der zur Authentifizierung beim ProxyServer-Proxy verwendet werden soll. 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 werden soll.
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 die Verbindung (1–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 sowohl in Apigee Integration als auch in Application Integration verfügbar. Sie können die Verbindung über die Connector-Aufgabe in einer Integration verwenden.

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

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