CockroachDB

Mit dem CockroachDB-Connector können Sie Einfügungs-, Löschungs-, Aktualisierungs- und Lesevorgänge in einer CockroachDB-Datenbank ausführen.

Hinweise

Führen Sie die folgenden Aufgaben aus, bevor Sie den CockroachDB-Connector verwenden:

  • In Ihrem Google Cloud-Projekt:
    • Weisen Sie dem Nutzer die IAM-Rolle roles/connectors.admin zu. Connector konfigurieren.
    • 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.

Weitere Informationen zum Erstellen eines serverlosen Clusters und zum Verwenden aller Parameter der erstellten Anwendung finden Sie unter CockroachDB-Serverless-Cluster auf Cockroachlabs erstellen.

Informationen zum Erstellen eines selbst signierten Zertifikats finden Sie unter Cockroach-Zertifikat.

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 CockroachDB 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. Aktivieren Sie optional Cloud Logging. und wählen Sie dann eine Logebene aus. 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.

    8. Datenbank: Der Name der Cockroach-Datenbank.
    9. Vorbereitete Anweisung zulassen: Ermöglicht die Vorbereitung einer Abfrageanweisung vor ihrer Ausführung.
    10. Result Set Metadata abrufen: Dieses Feld legt fest, ob der Anbieter detaillierte Informationen zu Ergebnissatzspalten vom Server erhält.
    11. UseSSL: Dieses Feld legt fest, ob SSL aktiviert ist.
    12. SSLServerCert: Dieses Feld legt fest, ob SSL aktiviert ist.
    13. Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
    14. 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 Backend-Systemen herstellen möchten, wählen Sie in der Liste Endpunktanhang und dann den erforderlichen Endpunktanhang 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 CockroachDB-Verbindung unterstützt:

      • Nutzername und Passwort
    2. Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.

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

In diesem Abschnitt finden Sie Beispielwerte für die verschiedenen Felder, die Sie beim Erstellen der CockroachDB-Verbindung konfigurieren.

CockroachDB – Verbindungstyp für die Basisauthentifizierung

Feldname Details
Standort us-central1
Connector CockroachDB
Connector-Version 1
Verbindungsname cockroach-db-cloud-conn
Cloud Logging aktivieren Ja
Dienstkonto SERVICE_ACCOUNT_NAME@serviceaccount
SSL Ja
SSLServerCert cockroach-db-ssl-cert
SecretVersion 1
Datenbank TestGCP
Prepared Statement zulassen Ja
Metadaten des Ergebnissatzes abrufen Ja
Ausführlichkeit 5
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Zieltyp(Server) Hostadresse
Hostadresse googlecloud-bcone-cluster-13792.5xj.cockroachlabs.cloud. Dies ist der Name des CockroachDB-Cloud-Clusters.
Port 26257
Nutzername Nutzername
Passwort Passwort
Secret-Version 1

CockroachDB – PSC-Verbindungstyp

Feldname Details
Standort us-central1
Connector CockroachDB
Connector-Version 1
Verbindungsname cockroach-db-cloud-conn-psc
Cloud Logging aktivieren Ja
Dienstkonto SERVICE_ACCOUNT_NAME@serviceaccount
SSL Ja
SSLServerCert gcp-bcone-crdb-hosted-node-crt
SecretVersion 1
Datenbank Bank
Vorbereitete Anweisung zulassen Nein
Metadaten des Ergebnissatzes abrufen Nein
Ausführlichkeit 5
Mindestanzahl von Knoten 2
Maximale Anzahl von Knoten 50
Zieltyp(Server) Hostadresse
Hostadresse 192.0.2.0/24 (dies sollte der Endpunktanhang sein, der auf der Grundlage der Server-IP erstellt wurde, auf der die Cockroach-Datenbankinstanz gehostet wird)
Port 26257
Nutzername Nutzername
Passwort Passwort
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. 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.

Systembeschränkungen

Der CockroachDB-Connector kann eine Transaktion pro Sekunde verarbeiten, pro Knoten, und throttles Transaktionen über diesen Grenzwert 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.

Beispiele für Entitätsvorgänge

Beispiel: Listeneinträge einer Entität auflisten

In diesem Beispiel werden die Datensätze der Entität Users aufgelistet.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Users aus der Entity-Liste aus.
  3. Wählen Sie den Vorgang List aus und klicken Sie auf Fertig.
  4. Im Bereich Task Input der Aufgabe Connectors können Sie filterClause ein.

    Wenn Sie die Filterklausel beispielsweise auf employeeCode='5100' and startDate='2010-01-01 00:00:00' festlegen, werden nur die Datensätze aufgeführt, deren Mitarbeitercode 5100 und deren Startdatum 01.01.2010 00:00:00 ist.

Beispiel – Einzelnen Datensatz aus einer Entität abrufen

In diesem Beispiel wird ein Datensatz von der Entität Users abgerufen.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle User 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 103032 in das Feld Default Value (Standardwert) ein.

    Hier ist 103032 der Primärschlüssel der Entität Users.

Beispiel – Datensatz aus einer Entität löschen

In diesem Beispiel wird ein Datensatz aus der Entität Users gelöscht.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Users 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 dann 113132 in das Feld Default Value (Standardwert) ein.

    Wenn die Entität zusammengesetzte Primärschlüssel hat, anstatt die entityId anzugeben, können Sie alternativ Legen Sie filterClause fest. Beispiel: employeeCode='5100' and startDate='2010-01-01 00:00:00'

Beispiel – Datensatz in einer Entität erstellen

In diesem Beispiel wird ein Datensatz in der Entität Users erstellt.

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Users 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:
    {
    "employeeCode": "5100",
    "startDate": "2010-01-01 00:00:00.0",
    "country": "US"
    }
  5. Ist die Integration erfolgreich, wird im Feld connectorOutputPayload der Connector-Aufgabe erhalten Sie die Antwort des Erstellungsvorgangs.

Beispiel – Datensatz in einer Entität aktualisieren

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

  1. Klicken Sie im Dialogfeld Configure connector task auf Entities.
  2. Wähle Users aus der Entity-Liste 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:
    {
    "country": "IN"
    }
  5. Klicken Sie im Bereich Task Input der Aufgabe Connectors auf entityId und Geben Sie dann 113132 in das Feld Default Value (Standardwert) ein.

    Wenn die Entität zusammengesetzte Primärschlüssel hat, anstatt die entityId anzugeben, können Sie alternativ Legen Sie filterClause fest. Beispiel: employeeCode='5100' and startDate='2010-01-01 00:00:00'

  6. Wenn die Integration erfolgreich war, enthält das Feld connectorOutputPayload der Connector-Aufgabe die Antwort des Aktualisierungsvorgangs.

Aktionen

In diesem Abschnitt werden die vom Connector unterstützten Aktionen aufgeführt. Um zu verstehen, wie die siehe Beispiele für Aktionen.

Aktion „ExecuteCustomQuery“

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

So erstellen Sie eine benutzerdefinierte Abfrage:

  1. Folgen Sie der detaillierten Anleitung zum Hinzufügen einer Connectors-Aufgabe.
  2. 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.

    Abbildung, die die Aktion „execute-custom-query“ zeigt Bild mit Befehl „execute-custom-query-action“

  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.

      Bild mit benutzerdefinierter SQL-Abfrage Bild mit benutzerdefinierter SQL-Abfrage

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

      Sie können in einer SQL-Anweisung ein Fragezeichen (?) für einen einzelnen Parameter verwenden, 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 richtigen Reihenfolge hinzufügen.

      Bild mit Abfrageparameter hinzufügen Bild mit Abfrageparameter 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

Beispiel – Den größeren Wert finden

Dieses Beispiel zeigt, wie eine benutzerdefinierte Funktion ausgeführt wird. Das find_greater vergleicht zwei Ganzzahlen und gibt die Ganzzahl zurück, die größer ist.

  1. Klicken Sie im Dialogfeld Configure connector task auf Actions.
  2. Wählen Sie die Aktion find_greater aus und klicken Sie auf Fertig.
  3. 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:
    {
    "$1": 1.0,
    "$2": 5.0
    }
  4. Wenn die Aktion erfolgreich ausgeführt wurde, enthält das Feld connectorOutputPayload der Connector-Aufgabe einen Wert in etwa so:

    [{
    "bignum": 5.0
    }]

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 mit Terraform erstellen, müssen Sie die folgenden Variablen in Ihrer Terraform-Konfigurationsdatei festlegen:

Parametername Datentyp Erforderlich Beschreibung
use_ssl BOOLEAN Falsch In diesem Feld wird festgelegt, ob SSL aktiviert ist.
ssl_server_cert SECRET Falsch In diesem Feld wird festgelegt, ob SSL aktiviert ist.
Datenbank STRING Wahr Der Name der Cockroach-Datenbank.
allow_prepared_statement BOOLEAN Falsch Erlauben Sie die Vorbereitung einer Abfrageanweisung vor ihrer Ausführung.
fetch_result_set_metadata BOOLEAN Falsch Mit diesem Feld wird festgelegt, ob der Anbieter detaillierte Informationen zu Ergebnisspalten vom Server erhält.

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