Apache CouchDB

Mit dem Apache CouchDB-Connector können Sie Vorgänge zum Einfügen, Löschen, Aktualisieren und Lesen in einer CouchDB-Datenbank ausführen.

Hinweis

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

  • In Ihrem Google Cloud-Projekt:
    • Prüfen Sie, ob eine Netzwerkverbindung eingerichtet ist. Informationen zu Netzwerkmustern finden Sie unter Netzwerkkonnektivität.
    • 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

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 Apache CouchDB 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 49 Zeichen haben.
    4. Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
    5. Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf Error festgelegt.
    6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
    7. Konfigurieren Sie optional die Verbindungsknoteneinstellungen:

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

    8. Flexibles Schema: Setzen Sie FlexibleSchema auf „true”, um in der Ergebnismenge nach zusätzlichen Metadaten zu suchen. Andernfalls bleiben die Metadaten gleich.
    9. Optional: Wählen Sie im Abschnitt Erweiterte Einstellungen das Kästchen Proxy verwenden aus, um einen Proxyserver für die Verbindung zu konfigurieren, und konfigurieren Sie die folgenden Werte:
      • 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-Nutzer: Ein Nutzername, der für die 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 Tunnel-Option verwendet. Wenn die URL eine HTTP-URL ist, wird die Option „NIE“ 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 öffnet eine Verbindung zum Remote-Host und der Traffic wird über den Proxy hin- und hergeleitet.
      • 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 Backend-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.
    10. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    11. 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.
      • Wenn Sie den Zielhostnamen oder die Ziel-IP-Adresse angeben möchten, wählen Sie Hostadresse aus und geben Sie die Adresse in das Feld Host 1 ein.
      • Wenn Sie eine private Verbindung herstellen möchten, wählen Sie Endpunktanhang aus und wählen Sie den erforderlichen Anhang aus der Liste Endpunktanhang aus.

      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 Apache CouchDB-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.

Beispiele für Verbindungskonfigurationen

In diesem Abschnitt werden die Beispielwerte für die verschiedenen Felder aufgeführt, die Sie beim Erstellen der Apcache CouchDB-Verbindung konfigurieren.

Sie benötigen eine Administratorrolle, um sich bei Apache CouchDB zu authentifizieren.

Informationen zu Apache CouchDB finden Sie unter Schnellstart mit Apache CouchDB. Weitere Informationen zur Apache CouchDB-Plattform finden Sie unter Apache CouchDB-Plattform – Übersicht. Informationen zur SSL-Konfiguration von Apache CouchDB finden Sie unter Apache CouchDB 3.5.2. und How Do I Configure SSL (HTTPS) in Apache CouchDB?.

Verbindungstyp für die Basisauthentifizierung

Feldname Details
Standort us-central1
Connector Apache CouchDB
Connector-Version 1
Verbindungsname couchdb-vm-connection
Cloud Logging aktivieren Ja
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Listenansichten Ja
Flexibles Schema Ja
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Zieltyp(Server) Hostadresse
Hostadresse http://198.51.100.0
Nutzername NUTZERNAME
Passwort PASSWORT
Secret-Version 1

Typ der Proxyverbindung

Feldname Details
Standort us-central1
Connector Apache CouchDB
Connector-Version 1
Verbindungsname couchdb-proxy-conn
Cloud Logging aktivieren Ja
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Listenansichten Nein
Flexibles Schema Nein
Proxy Proxy verwenden
Proxy-Authentifizierungsschema Benachrichtigung
Proxy-Nutzer PROXY_USER
Proxy-Passwort PROXY_PASSWORD
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Zieltyp(Server) Hostadresse
Hostadresse http://198.51.100.0
Nutzername NUTZERNAME
Passwort PASSWORT
Secret-Version 1

Verbindungstyp „SSL-Verbindung (unsicher)“

Feldname Details
Standort us-central1
Connector Apache CouchDB
Connector-Version 1
Verbindungsname couchdb-ssl-conn
Cloud Logging aktivieren Ja
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Listenansichten Nein
Flexibles Schema Nein
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Trust Store (Vertrauensmodell auswählen) Unsichere Verbindung
Zieltyp(Server) Hostadresse
Hostadresse http://198.51.100.0
Nutzername NUTZERNAME
Passwort PASSWORT
Secret-Version 1

Verbindungstyp „SSL-Verbindung (privat)“

Feldname Details
Standort us-central1
Connector Apache CouchDB
Connector-Version 1
Verbindungsname couchdb-proxy-conn
Cloud Logging aktivieren Ja
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Listenansichten Nein
Flexibles Schema Nein
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Trust Store (Vertrauensmodell auswählen) Privat
Benutzerdefinierter Trust Store Selbst signiertes Zertifikat.
Secret-Version 1
Zieltyp(Server) Hostadresse
Hostadresse https://198.51.100.0
Nutzername NUTZERNAME
Passwort PASSWORT
Secret-Version 1

Verbindungstyp „JWT-Authentifizierung“

Feldname Details
Standort us-central1
Connector Apache CouchDB
Connector-Version 1
Verbindungsname couchdb-vm-jwt-conn
Cloud Logging aktivieren Ja
Dienstkonto SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Listenansichten Nein
Flexibles Schema Nein
Proxy Nein
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Zieltyp(Server) Hostadresse
Hostadresse http://203.0.113.0
JWT-Betreff Admin
JWT-Algorithmus HS256
JWT-Schlüsseltyp Symmetrisch
JWT-Schlüssel JWT_KEY
Secret-Version 1

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

Systembeschränkungen

Der Apache CouchDB-Connector kann maximal 5 Transaktionen pro Sekunde und Knoten verarbeiten. Alle Transaktionen, die dieses Limit überschreiten, werden gedrosselt. Standardmäßig werden für eine Verbindung zwei Knoten (für eine bessere Verfügbarkeit) zugewiesen.

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

Beispiele für Entitätsvorgänge

Beispiel: Alle Kundendatensätze auflisten

In diesem Beispiel werden alle Kundendatensätze in der Customer-Einheit aufgeführt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Customer aus der Liste Entity aus.
  3. Wählen Sie den Vorgang LIST aus und klicken Sie auf Fertig.
  4. Optional können Sie Werte in filterClause eingeben, um das Ergebnisset zu filtern.

Beispiel: Kundendatensatz abrufen

In diesem Beispiel wird ein bestimmter Kundendatensatz aus der Customers-Entität abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Customers 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 cust-2 in das Feld Standardwert ein.

    Dabei ist cust-2 der Primärschlüsselwert der Entität Customers.

Beispiel: Kunden hinzufügen

In diesem Beispiel wird ein Kundendatensatz in der Customers-Entität erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Customers aus der Liste Entity aus.
  3. Wählen Sie den Vorgang Create 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: 
    {
"name": "John",
"_id": "cust-3"
}

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

    {
"_id": cust-3
}

Beispiel: Kundendatensatz aktualisieren

In diesem Beispiel wird der angegebene Kundendatensatz in der Customers-Entität aktualisiert.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Customers 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 das Feld Default Value ein: 
    {
      "name": "Jason",
    }
  5. Klicken Sie auf entityId und geben Sie dann cust-5 in das Feld Standardwert ein.

    Anstelle der entityId können Sie auch die filterClause auf cust-5 festlegen.

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

    {
"_id": cust-5
}

Beispiel: Kundendatensatz löschen

In diesem Beispiel wird der angegebene Kundendatensatz aus der Customers-Entität gelöscht.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wählen Sie Customers 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 cust-6 in das Feld Standardwert ein.

Verbindungen mit Terraform erstellen

Sie können die Terraform-Ressource verwenden, um eine neue Verbindung zu erstellen.

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

Ein Beispiel für eine Terraform-Vorlage zum Erstellen einer Verbindung finden Sie hier.

Wenn Sie diese Verbindung mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:

Parametername Datentyp Erforderlich Beschreibung
flexible_schema BOOLEAN Falsch Setzen Sie FlexibleSchema auf „true”, um in der Ergebnismenge nach zusätzlichen Metadaten zu suchen. Andernfalls bleiben die Metadaten gleich.
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 für die 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: AUTO, ALWAYS, NEVER, TUNNEL

Apache CouchDB-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 in einer Integration über die Aufgabe „Connectors“ verwenden.

  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe in Apigee Integration finden Sie unter Connectors-Aufgabe.
  • Informationen zum Erstellen und Verwenden der Connectors-Aufgabe 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