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 vor der Verwendung des CockroachDB-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.
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 selbstsignierten Zertifikats finden Sie unter Cockroach cert.
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:
- 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.
- Klicken Sie auf + NEU ERSTELLEN, um die Seite Verbindung erstellen zu öffnen.
- Wählen Sie im Abschnitt Standort den Standort für die Verbindung aus.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
Eine Liste aller unterstützten Regionen finden Sie unter Standorte.
- Tippen Sie auf Weiter.
- Region: Wählen Sie einen Standort aus der Drop-down-Liste aus.
- Führen Sie im Abschnitt Verbindungsdetails folgende Schritte aus:
- Connector: Wählen Sie CockroachDB aus der Drop-down-Liste der verfügbaren Connectors aus.
- Connector-Version: Wählen Sie die Connector-Version aus der Drop-down-Liste der verfügbaren Versionen aus.
- 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.
- Geben Sie optional unter Beschreibung eine Beschreibung für die Verbindungsinstanz ein.
- Optional können Sie Cloud Logging aktivieren und dann eine Logebene auswählen. Die Logebene ist standardmäßig auf
Error
festgelegt. - Dienstkonto: Wählen Sie ein Dienstkonto, das über die erforderlichen Rollen verfügt.
- Optional: Konfigurieren Sie 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.
- Datenbank: Der Name der Cockroach-Datenbank.
- Vorbereitete Anweisung zulassen: Ermöglicht die Vorbereitung einer Abfrageanweisung vor ihrer Ausführung.
- Result Set Metadata abrufen: Dieses Feld legt fest, ob der Anbieter detaillierte Informationen zu Ergebnissatzspalten vom Server erhält.
- UseSSL: Dieses Feld legt fest, ob SSL aktiviert ist.
- SSLServerCert: Dieses Feld legt fest, ob SSL aktiviert ist.
- Klicken Sie optional auf + LABEL HINZUFÜGEN, um der Verbindung ein Label in Form eines Schlüssel/Wert-Paars hinzuzufügen.
- Tippen Sie auf Weiter.
- Geben Sie im Abschnitt Ziele die Details zum Remote-Host (Backend-System) ein, zu dem Sie eine Verbindung herstellen möchten.
- Zieltyp: Wählen Sie einen Zieltyp aus.
- Wählen Sie in der Liste Hostadresse aus, um den Hostnamen oder die IP-Adresse des Ziels 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.
- Tippen Sie auf Weiter.
- Zieltyp: Wählen Sie einen Zieltyp aus.
-
Geben Sie im Abschnitt Authentifizierung die Authentifizierungsdetails ein.
- 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
- Tippen Sie auf WEITER.
Informationen zum Konfigurieren dieser Authentifizierungstypen finden Sie unter Authentifizierung konfigurieren.
- Wählen Sie einen Authentifizierungstyp aus und geben Sie die relevanten Details ein.
- Überprüfen: Prüfen Sie Ihre Verbindungs- und Authentifizierungsdetails.
- 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 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ührlichkeitsstufe | 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 |
Prepared Statement zulassen | Nein |
Metadaten des Ergebnissatzes abrufen | Nein |
Ausführlichkeitsstufe | 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 basierend auf der Server-IP-Adresse 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. Wenn ein Connector jedoch keinen der Entitätsvorgänge unterstützt, werden diese 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 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.
Systemeinschränkungen
Der CockroachDB-Connector kann pro Knoten eine Transaktion pro Sekunde verarbeiten und drosselt alle Transaktionen, die dieses Limit überschreiten. Standardmäßig werden für eine Verbindung zwei Knoten (für eine bessere Verfügbarkeit) zugewiesen.
Informationen zu den Limits für Integration Connectors finden Sie unter Limits.
Beispiele für Entitätsvorgänge
Beispiel: Listeneinträge einer Entität auflisten
In diesem Beispiel werden die Einträge der Entität Users
aufgelistet.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die OptionUsers
aus. - Wählen Sie den Vorgang
List
aus und klicken Sie auf Fertig. - Im Bereich Aufgabeneingabe der Aufgabe Connectors können Sie die filterClause nach Bedarf festlegen.
Wenn Sie beispielsweise die Filterklausel 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 aus dem Users
-Objekt abgerufen.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die OptionUser
aus. - Wählen Sie den Vorgang
Get
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann
103032
in das Feld Standardwert ein.Hier ist
103032
der Primärschlüsselwert der EntitätUsers
.
Beispiel: Datensatz aus einer Entität löschen
In diesem Beispiel wird ein Eintrag aus der Entität Users
gelöscht.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die OptionUsers
aus. - Wählen Sie den Vorgang
Delete
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann
113132
in das Feld Standardwert ein.Wenn die Entität zusammengesetzte Primärschlüssel hat, können Sie anstelle der entityId auch die filterClause festlegen. Beispiel:
employeeCode='5100' and startDate='2010-01-01 00:00:00'
Beispiel: Datensatz in einer Entität erstellen
In diesem Beispiel wird ein Eintrag in der Users
-Entität erstellt.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die OptionUsers
aus. - Wählen Sie den Vorgang
Create
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "employeeCode": "5100", "startDate": "2010-01-01 00:00:00.0", "country": "US" }
Wenn die Integration erfolgreich war, enthält das Feld connectorOutputPayload
der Connector-Aufgabe die Antwort des Erstellungsvorgangs.
Beispiel: Datensatz in einer Entität aktualisieren
In diesem Beispiel wird ein Datensatz in der Entität Users
aktualisiert.
- Klicken Sie im Dialogfeld
Configure connector task
aufEntities
. - Wählen Sie in der Liste
Entity
die OptionUsers
aus. - Wählen Sie den Vorgang
Update
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "country": "IN" }
- Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf entityId und geben Sie dann
113132
in das Feld Standardwert ein.Wenn die Entität zusammengesetzte Primärschlüssel hat, können Sie anstelle der entityId auch die filterClause festlegen. Beispiel:
employeeCode='5100' and startDate='2010-01-01 00:00:00'
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. Informationen zum Konfigurieren der Aktionen finden Sie unter Beispiele für Aktionen.
Aktion „ExecuteCustomQuery“
Mit dieser Aktion können Sie eine benutzerdefinierte Abfrage ausführen.
So erstellen Sie eine benutzerdefinierte Abfrage:
- Folgen Sie der detaillierten Anleitung zum Hinzufügen einer Connectors-Aufgabe.
- Wählen Sie beim Konfigurieren der Connector-Aufgabe als Aktionstyp Aktionen aus.
- Wählen Sie in der Liste Aktion die Option Benutzerdefinierte Abfrage ausführen aus und klicken Sie dann auf Fertig.
- Maximieren Sie den Bereich Aufgabeneingabe und gehen Sie so vor:
- Geben Sie in das Feld Zeitlimit nach die Anzahl der Sekunden ein, die gewartet werden soll, bis die Abfrage ausgeführt wird.
Standardwert:
180
Sekunden. - Geben Sie im Feld Maximale Zeilenanzahl die maximale Anzahl von Zeilen ein, die aus der Datenbank zurückgegeben werden sollen.
Standardwert:
25
. - Klicken Sie auf Benutzerdefiniertes Script bearbeiten, um die benutzerdefinierte Abfrage zu aktualisieren. Das Dialogfeld Skripteditor wird geöffnet.
- 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 mit den für die SpalteLastName
angegebenen Werten übereinstimmen:SELECT * FROM Employees where LastName=?
- Wenn Sie Fragezeichen in Ihrer SQL-Abfrage verwendet haben, müssen Sie den Parameter hinzufügen. Klicken Sie dazu für jedes Fragezeichen auf + Parameternamen hinzufügen. Bei der Ausführung der Integration ersetzen diese Parameter nacheinander die Fragezeichen (?) in der SQL-Abfrage. 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:
- Wählen Sie in der Liste Typ den Datentyp des Parameters aus.
- Geben Sie im Feld Wert den Wert des Parameters ein.
- Wenn Sie mehrere Parameter hinzufügen möchten, klicken Sie auf + Abfrageparameter hinzufügen.
- Geben Sie in das Feld Zeitlimit nach die Anzahl der Sekunden ein, die gewartet werden soll, bis die Abfrage ausgeführt wird.
Bei erfolgreicher Ausführung gibt diese Aktion den Status 200 (OK) mit einem Antworttext mit den Abfrageergebnissen zurück.
Beispiele für Aktionen
Beispiel: Größeren Wert ermitteln
In diesem Beispiel wird gezeigt, wie eine benutzerdefinierte Funktion ausgeführt wird. Die Funktion find_greater
in diesem Beispiel vergleicht zwei Ganzzahlen und gibt die größere zurück.
- Klicken Sie im Dialogfeld
Configure connector task
aufActions
. - Wählen Sie die Aktion
find_greater
aus und klicken Sie auf Fertig. - Klicken Sie im Bereich Aufgabeneingabe der Aufgabe Connectors auf
connectorInputPayload
und geben Sie dann einen Wert ähnlich dem folgenden in das FeldDefault Value
ein:{ "$1": 1.0, "$2": 5.0 }
Wenn die Aktion erfolgreich ausgeführt wurde, enthält das Feld connectorOutputPayload
der Connector-Aufgabe einen Wert, der in etwa so aussieht:
[{ "bignum": 5.0 }]
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.
Eine Beispiel-Terraform-Vorlage zum Erstellen einer Verbindung 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 | Dieses Feld legt fest, ob SSL aktiviert ist. |
ssl_server_cert | VERTRAULICH | Falsch | Dieses Feld legt fest, ob SSL aktiviert ist. |
Datenbank | STRING | Wahr | Der Name der Cockroach-Datenbank. |
allow_prepared_statement | BOOLEAN | Falsch | Ermöglicht die Vorbereitung einer Abfrageanweisung vor ihrer Ausführung. |
fetch_result_set_metadata | BOOLEAN | Falsch | Dieses Feld legt fest, ob der Anbieter detaillierte Informationen zu Ergebnissatzspalten vom Server erhält. |
CockroachDB-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 Connectors-Aufgabe in einer Integration 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
- Informationen zum Anhalten und Fortsetzen einer Verbindung
- Informationen zum Überwachen der Connector-Nutzung
- Weitere Informationen zum Ansehen von Connector-Logs