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:
  • 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 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 63 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. Standardmäßig ist die Logebene auf Error festgelegt.
   6. Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
   7. 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.
   8. Flexibles Schema: Setzen Sie FlexibleSchema auf „true”, um in der Ergebnismenge nach zusätzlichen Metadaten zu suchen. Andernfalls bleiben die Metadaten gleich.
   9. Proxy verwenden: Klicken Sie dieses Kästchen an, um einen Proxyserver für die Verbindung 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 User: 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 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: Für die Verbindung ist SSL nicht aktiviert.
     • 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.
   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.
      • 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 Backend-Systemen herstellen möchten, wählen Sie in der Liste Endpunktanhang 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 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

   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.

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:
  • Liste
  • Abrufen
  • Erstellen
  • Aktualisieren
  • Löschen

  Durch Auswahl einer Entität aus der verfügbaren Liste wird eine Liste der Vorgänge generiert, die für die Entität verfügbar sind. Eine detaillierte Beschreibung der Vorgänge finden Sie in den Entitätsvorgängen der Connectors-Aufgabe. Unterstützt ein Connector jedoch keine Entitätsvorgänge, Vorgänge sind 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 eine Ausgabe . 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 zugewiesen. Ein Aktionsschema hat beispielsweise folgende Parameterdetails: den Parameter und den zugehörigen Datentyp. Das Schema (Metadaten) für Entitäten und Aktionen wird von der Verbindung unter aus Ihrem Back-End. Wenn es Aktualisierungen am Schema gibt, werden diese nicht automatisch in Ihren vorhandenen Verbindungen berücksichtigt. Sie müssen das Schema manuell aktualisieren. Aktualisieren das Schema für eine Verbindung. Öffnen Sie dazu die Seite Verbindungsdetails der Verbindung und klicken Sie auf Verbindungsschema aktualisieren

Systembeschränkungen

Der Apache CouchDB-Connector kann maximal fünf Transaktionen pro Sekunde verarbeiten. pro Knoten, und throttles beliebige Transaktionen über dieses Limit hinaus. Standardmäßig weist Integration Connectors einer Verbindung 2 Knoten zu (für bessere Verfügbarkeit).

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

Hinweis: Die Anzahl der Integration Connectors-Knoten wird dynamisch automatisch skaliert. basierend auf Ihrer Nutzung. Wenn Sie jedoch Kapazitäten für große Volumes reservieren möchten, wenn Sie auf das Autoscaling warten, können Sie den minimalen Knotenwert für eine Verbindung anpassen. Mehr Knoten sind 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:

• Konfigurieren Sie als „Pay as you go“-Kunde den minimalen und maximalen Knotenwert auf der Seite „Verbindung bearbeiten“.
• Wenn Sie ein Abo haben, wenden Sie sich bitte 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 prüfen, ob Ihre Back-End-Systeme optimal für die Verarbeitung des erforderlichen Traffics eingerichtet sind.

Beispiele für Entitätsvorgänge

Beispiel – Alle Kundendatensätze auflisten

In diesem Beispiel werden alle Kundendatensätze in der Entität Customer aufgelistet.

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

Beispiel – Kundendatensatz abrufen

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

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

   Hier ist cust-2 der Primärschlüssel der Entität Customers.

Beispiel – Kunden hinzufügen

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

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Customers aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Create aus und klicken Sie auf Fertig.
4. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:

   {
   "name": "John",
   "_id": "cust-3"
   }

   Ist die Integration erfolgreich, enthält das Feld connectorOutputPayload der Connector-Aufgabe , der in etwa so aussieht:

   {
   "_id": cust-3
   }

Beispiel: Kundeneintrag aktualisieren

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

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Customers aus der Entity-Liste aus.
3. Wählen Sie den Vorgang Update aus und klicken Sie auf Fertig.
4. Klicken Sie im Abschnitt Task Input der Aufgabe Connectors auf connectorInputPayload und geben Sie dann einen Wert ähnlich dem folgenden in das Feld Feld Default Value:

   {
         "name": "Jason",
       }
       

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

   Statt die entityId anzugeben, können Sie auch die filterClause auf cust-5.

   Ist die Integration erfolgreich, enthält das Feld connectorOutputPayload der Connector-Aufgabe , der in etwa so aussieht:

   {
   "_id": cust-5
   }
       

Beispiel – Kundendatensatz löschen

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

1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
2. Wähle Customers aus der Entity-Liste 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

Mit dem Terraform-Code Ressource, um eine neue Verbindung zu 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 in der Terraform-Konfigurationsdatei die folgenden Variablen festlegen:

Parametername	Datentyp	Erforderlich	Beschreibung
flexible_schema	BOOLEAN	Falsch	Legen Sie FlexibleSchema auf "true" fest, um im Abfrageergebnissatz nach zusätzlichen Metadaten zu suchen. Andernfalls bleiben die Metadaten gleich.
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	VERTRAULICH	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: AUTO, ALWAYS, NEVER, TUNNEL

Apache CouchDB-Verbindung in einer Integration verwenden

Nachdem Sie die Verbindung erstellt haben, ist sie in beiden Apigee-Integration und Anwendungsintegration Sie können die Verbindung über die Connectors-Aufgabe in einer Integration.

• 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 Tasks für 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