Die AlloyDB Language Connectors sind Bibliotheken, die das Herstellen sicherer Verbindungen zu Ihrem Cluster vereinfachen. Verwenden Sie dazu Folgendes:
- Automatisierte mTLS-Verbindungen
- Unterstützung der Autorisierung auf Grundlage der Identitäts- und Zugriffsverwaltung (Identity and Access Management, IAM)
- Automatisierte IAM-Authentifizierung
AlloyDB Language Connectors können keinen Netzwerkpfad zu einem AlloyDB-Cluster bereitstellen, wenn noch kein solcher vorhanden ist.
Weitere Informationen zu AlloyDB Language Connectors finden Sie unter AlloyDB Language Connectors – Übersicht.
Auf dieser Seite werden die folgenden AlloyDB-Sprachconnectors erläutert:
- Der AlloyDB-Java-Connector
- Der AlloyDB Go-Connector
- Der AlloyDB-Python-Connector
Hinweise
Aktivieren Sie die AlloyDB Admin API.
Erstellen Sie eine AlloyDB-Instanz und konfigurieren Sie den Standardnutzer.
Weitere Informationen zum Erstellen einer Instanz finden Sie unter Primäre Instanz erstellen.
Weitere Informationen zu Nutzerrollen finden Sie unter Vordefinierte AlloyDB-IAM-Rollen.
Konfigurieren Sie die folgenden Rollen und Berechtigungen, die zum Herstellen einer Verbindung zu einer AlloyDB-Instanz erforderlich sind:
roles/alloydb.client
roles/serviceusage.serviceUsageConsumer
Weitere Informationen zu den erforderlichen Rollen und Berechtigungen finden Sie unter IAM-Authentifizierung verwalten.
AlloyDB Language Connectors installieren
Java
Der AlloyDB-Java-Connector ist eine Bibliothek, die IAM-basierte Autorisierung und Verschlüsselung bietet, wenn eine Verbindung zu einer AlloyDB-Instanz hergestellt wird. Wenn Sie Spring Boot verwenden, lesen Sie den Spring Boot AlloyDB-Starter.
Installation
Wenn Sie Maven verwenden, können Sie den AlloyDB Java Connector installieren, indem Sie Folgendes in die pom.xml
Ihres Projekts einfügen:
<!-- Add the connector with the latest version -->
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>alloydb-jdbc-connector</artifactId>
<version>0.4.0</version>
</dependency>
<!-- Add the driver with the latest version -->
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>46.6.0<</version>
</dependency>
<!-- Add HikariCP with the latest version -->
<dependency>
<groupId>com.zaxxer</groupId>
<artifactId>HikariCP</artifactId>
<version>5.1.0</version>
</dependency>
Für Gradle können Sie den AlloyDB-Java-Connector installieren, indem Sie Folgendes in die gradle.build
Ihres Projekts einfügen:
// Add connector with the latest version
implementation group: 'com.google.cloud.alloydb', name: 'alloydb-jdbc-connector', version: '0.4.0'
// Add driver with the latest version
implementation group: 'org.postgresql', name: 'postgresql', version: '46.6.0'
// Add HikariCP with the latest version
implementation group: 'com.zaxxer', name: 'HikariCP', version: '5.1.0'
Python (pg8000)
Der AlloyDB-Python-Connector ist eine Bibliothek, die neben einem Datenbanktreiber verwendet werden kann, um Nutzern mit ausreichenden Berechtigungen die Verbindung zu einer AlloyDB-Datenbank zu ermöglichen, ohne dass sie manuell IPs zulassen müssen.
Installation
Sie können die AlloyDB Python Connector-Bibliothek mit pip install
installieren.
Wenn Sie pg8000 verwenden, führen Sie den folgenden Befehl aus:
pip install "google-cloud-alloydb-connector[pg8000]" sqlalchemy
Python (asyncpg)
Der AlloyDB-Python-Connector ist eine Bibliothek, die neben einem Datenbanktreiber verwendet werden kann, um Nutzern mit ausreichenden Berechtigungen die Verbindung zu einer AlloyDB-Datenbank zu ermöglichen, ohne dass sie manuell IPs zulassen müssen.
Installation
Sie können die AlloyDB Python Connector-Bibliothek mit pip install
installieren.
Wenn Sie asyncpg verwenden, führen Sie den folgenden Befehl aus:
Für asyncpg:
pip install "google-cloud-alloydb-connector[asyncpg]" "sqlalchemy[asyncio]"
Weitere Informationen zur Verwendung asynchroner Treiber finden Sie unter Async Driver Usage.
Go (pgx)
Der AlloyDB Go-Connector ist ein AlloyDB-Connector, der für die Verwendung mit der Go-Sprache entwickelt wurde.
Installation
Sie können den AlloyDB Go-Connector mit go get
installieren.
Wenn Sie pgx verwenden, führen Sie den folgenden Befehl aus:
go get github.com/jackc/pgx/v5
go get cloud.google.com/go/alloydbconn
Go (database/sql)
Der AlloyDB Go-Connector ist ein AlloyDB-Connector, der für die Verwendung mit der Go-Sprache entwickelt wurde.
Installation
Sie können den AlloyDB Go-Connector mit go get
installieren.
Wenn Sie database/sql verwenden, führen Sie den folgenden Befehl aus:
go get cloud.google.com/go/alloydbconn
AlloyDB Language Connectors konfigurieren
Java
Wenn Sie den AlloyDB Java-Connector verwenden möchten, um eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen, konfigurieren Sie ihn mit den folgenden Schritten.
Wenn Sie dieses Snippet im Kontext einer Webanwendung verwenden möchten, rufen Sie die README-Datei auf GitHub auf.
Öffentliche IP-Adresse verwenden
Wenn Sie eine öffentliche IP-Adresse verwenden, um eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen, fügen Sie Folgendes ein:
config.addDataSourceProperty("alloydbIpType", "PUBLIC");
Private Service Connect verwenden
Wenn Sie Private Service Connect verwenden, um eine Verbindung zu Ihrer AlloyDB-Instanz herzustellen, müssen Sie Folgendes angeben:
config.addDataSourceProperty("alloydbIpType", "PSC");
Automatische IAM-Authentifizierung
Standardmäßig verwenden AlloyDB-Sprach-Connectors die integrierte Authentifizierung. Sie können die automatische IAM-Authentifizierung mit dem AlloyDB Java-Connector verwenden. So aktivieren Sie die Funktion:
config.addDataSourceProperty("alloydbEnableIAMAuth", "true");
Python (pg8000)
Wenn Sie pg8000
verwenden, gehen Sie so vor, um den AlloyDB Python-Connector zu konfigurieren und damit eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen.
Wenn Sie dieses Snippet im Kontext einer Webanwendung verwenden möchten, rufen Sie die README-Datei auf GitHub auf.
Öffentliche IP-Adresse verwenden
Wenn Sie eine öffentliche IP-Adresse verwenden, um eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen, ersetzen Sie Ihre Verbindungsfunktion durch Folgendes:
def getconn() -> pg8000.dbapi.Connection:
conn: pg8000.dbapi.Connection = connector.connect(
inst_uri,
"pg8000",
user=user,
password=password,
db=db,
# use ip_type to specify public IP
ip_type=IPTypes.PUBLIC,
)
return conn
Private Service Connect verwenden
Wenn Sie Private Service Connect verwenden, um eine Verbindung zu Ihrer AlloyDB-Instanz herzustellen, müssen Sie Folgendes angeben:
def getconn() -> pg8000.dbapi.Connection:
conn: pg8000.dbapi.Connection = connector.connect(
inst_uri,
"pg8000",
user=user,
password=password,
db=db,
# use ip_type to specify PSC
ip_type=IPTypes.PSC,
)
return conn
Automatische IAM-Authentifizierung
Standardmäßig verwenden AlloyDB-Sprach-Connectors die integrierte Authentifizierung. Sie können die automatische IAM-Authentifizierung mit dem AlloyDB Python Connector verwenden. Ersetzen Sie Ihre Verbindungsfunktion durch Folgendes, um die Funktion zu aktivieren:
def getconn() -> pg8000.dbapi.Connection:
conn: pg8000.dbapi.Connection = connector.connect(
inst_uri,
"pg8000",
user=user,
password=password,
db=db,
# use enable_iam_auth to enable IAM authentication
enable_iam_auth=True,
)
return conn
Python (asyncpg)
Wenn Sie async
verwenden, gehen Sie so vor, um den AlloyDB Python-Connector zu konfigurieren und damit eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen.
Wenn Sie dieses Snippet im Kontext einer Webanwendung verwenden möchten, rufen Sie die README-Datei auf GitHub auf.
Öffentliche IP-Adresse verwenden
Wenn Sie eine öffentliche IP-Adresse verwenden, um eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen, ersetzen Sie Ihre Verbindungsfunktion durch die folgende:
async def getconn() -> asyncpg.Connection:
conn: asyncpg.Connection = await connector.connect(
inst_uri,
"asyncpg",
user=user,
password=password,
db=db,
# use ip_type to specify public IP
ip_type=IPTypes.PUBLIC,
)
return conn
Private Service Connect verwenden
Wenn Sie Private Service Connect verwenden, um eine Verbindung zu Ihrer AlloyDB-Instanz herzustellen, müssen Sie Folgendes angeben:
async def getconn() -> asyncpg.Connection:
conn: asyncpg.Connection = await connector.connect(
inst_uri,
"asyncpg",
user=user,
password=password,
db=db,
# use ip_type to specify PSC
ip_type=IPTypes.PSC,
)
return conn
Automatische IAM-Authentifizierung
Standardmäßig verwenden AlloyDB-Sprach-Connectors die integrierte Authentifizierung. Sie können die automatische IAM-Authentifizierung mit dem AlloyDB Python Connector verwenden. Ersetzen Sie Ihre Verbindungsfunktion durch Folgendes, um sie zu aktivieren:
async def getconn() -> asyncpg.Connection:
conn: asyncpg.Connection = await connector.connect(
inst_uri,
"asyncpg",
user=user,
password=password,
db=db,
# use enable_iam_auth to enable IAM authentication
enable_iam_auth=True,
)
return conn
Go (pgx)
Wenn Sie den AlloyDB Go Connector verwenden möchten, um eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen, konfigurieren Sie den Connector mit den folgenden Schritten, sofern Sie pgx
verwenden.
Wenn Sie dieses Snippet im Kontext einer Webanwendung verwenden möchten, rufen Sie die README-Datei auf GitHub auf.
Öffentliche IP-Adresse verwenden
Wenn Sie eine öffentliche IP-Adresse verwenden, um eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen, ersetzen Sie die Funktion d.Dial
durch Folgendes:
d.Dial(ctx, instURI, alloydbconn.WithPublicIP())
Private Service Connect verwenden
Wenn Sie Private Service Connect verwenden, um eine Verbindung zu Ihrer AlloyDB-Instanz herzustellen, müssen Sie Folgendes angeben:
d.Dial(ctx, instURI, alloydbconn.WithPSC())
Automatische IAM-Authentifizierung
Standardmäßig verwenden AlloyDB-Sprach-Connectors die integrierte Authentifizierung.
Sie können die automatische IAM-Authentifizierung mit dem AlloyDB Go Connector verwenden. Ersetzen Sie zum Aktivieren die Funktion alloydbconn.NewDialer
durch Folgendes:
d, err := alloydbconn.NewDialer(ctx, alloydbconn.WithIAMAuthN())
Integrierte Telemetrie deaktivieren
Mit der Option WithOptOutOfBuiltInTelemetry
wird der Export interner Messwerte deaktiviert.
Standardmäßig werden die internen Vorgänge des Dialers unter dem Systemmesswert-Präfix alloydb.googleapis.com
erfasst. Mithilfe dieser Messwerte kann AlloyDB die Leistung verbessern und Probleme mit der Clientverbindung erkennen. Diese Option ist nützlich für Anwendungen, die in Umgebungen ausgeführt werden, in denen der Export von ausgehenden Messwerten eingeschränkt ist. Wenn Sie diese Telemetrie deaktivieren möchten, geben Sie beim Initialisieren eines Dialers die folgende Option an:
d.Dial(ctx, instURI, alloydbconn.WithOptOutOfBuiltInTelemetry())
Go (database/sql)
Wenn Sie den AlloyDB Go-Connector verwenden möchten, um eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen, konfigurieren Sie den Connector mit den folgenden Schritten, falls Sie database/sql
verwenden.
Wenn Sie dieses Snippet im Kontext einer Webanwendung verwenden möchten, rufen Sie die README-Datei auf GitHub auf.
Öffentliche IP-Adresse verwenden
Wenn Sie eine öffentliche IP-Adresse verwenden, um eine Verbindung zu Ihrem AlloyDB-Cluster herzustellen, ersetzen Sie die Funktion RegisterDriver
durch Folgendes:
cleanup, err := pgxv5.RegisterDriver(
"alloydb",
alloydbconn.WithDefaultDialOptions(alloydbconn.WithPublicIP())
)
Private Service Connect verwenden
Wenn Sie Private Service Connect verwenden, um eine Verbindung zu Ihrer AlloyDB-Instanz herzustellen, müssen Sie Folgendes angeben:
cleanup, err := pgxv5.RegisterDriver(
"alloydb",
alloydbconn.WithDefaultDialOptions(alloydbconn.WithPSC())
)
Automatische IAM-Authentifizierung
Standardmäßig verwenden AlloyDB-Sprach-Connectors die integrierte Authentifizierung.
Sie können die automatische IAM-Authentifizierung mit dem AlloyDB Go Connector verwenden. Ersetzen Sie zum Aktivieren Ihre RegisterDriver
-Funktion durch Folgendes:
cleanup, err := pgxv5.RegisterDriver(
"alloydb",
alloydbconn.WithIAMAuthN()
)
Integrierte Telemetrie deaktivieren
Mit der Option WithOptOutOfBuiltInTelemetry
wird der Export interner Messwerte deaktiviert.
Standardmäßig werden die internen Vorgänge des Dialers unter dem Systemmesswert-Präfix alloydb.googleapis.com
erfasst. Mithilfe dieser Messwerte kann AlloyDB die Leistung verbessern und Probleme mit der Clientverbindung erkennen. Diese Option ist nützlich für Anwendungen, die in Umgebungen ausgeführt werden, in denen der Export von ausgehenden Messwerten eingeschränkt ist. Wenn Sie diese Telemetrie deaktivieren möchten, geben Sie beim Initialisieren eines Dialers die folgende Option an:
cleanup, err := pgxv5.RegisterDriver(
"alloydb",
alloydbconn.WithOptOutOfBuiltInTelemetry(),
)