Spanner lokal emulieren

Die gcloud CLI bietet einen lokalen Emulator im Speicher, mit dem Sie Ihre Anwendungen entwickeln und testen können. Da der Emulator die Daten nur zwischenspeichert, geht der gesamte Status, einschließlich Daten, Schema und Konfigurationen, beim Neustart verloren. Der Emulator bietet dieselben APIs wie der Spanner-Produktionsdienst und ist für lokale Entwicklung und Tests vorgesehen, nicht für die Produktionsbereitstellung.

Der Emulator unterstützt sowohl den GoogleSQL- als auch den PostgreSQL-Dialekt. Er unterstützt alle Sprachen der Clientbibliotheken. Sie können den Emulator auch mit der Google Cloud CLI und REST APIs verwenden.

Der Emulator ist auch als Open-Source-Projekt in GitHub verfügbar.

Beschränkungen und Unterschiede

Der Emulator unterstützt Folgendes nicht:

  • TLS/HTTPS, Authentifizierung, IAM, Berechtigungen und Rollen.
  • In den PLAN oder PROFILE Abfragemodi, ist der zurückgegebene Abfrageplan leer.
  • Die ANALYZE Anweisung. Der Emulator akzeptiert sie, ignoriert sie aber.
  • Alle Audit-Logging und Monitoring-Tools.
  • Schutz vor dem Löschen von Datenbanken. Der Emulator akzeptiert das Feld enable_drop_protection, ermöglicht aber das Löschen von Datenbanken, auch wenn diese Eigenschaft aktiviert ist.

Der Emulator unterscheidet sich außerdem folgendermaßen vom Spanner-Produktionsdienst:

  • Fehlermeldungen können sich zwischen dem Emulator und dem Produktionsdienst unterscheiden.
  • Leistung und Skalierbarkeit des Emulators sind nicht mit dem Produktionsdienst vergleichbar.
  • Lese-/Schreibvorgänge und Schemaänderungen sperren bis zu ihrem Abschluss die gesamte Datenbank für exklusiven Zugriff.
  • Der Emulator unterstützt partitionierte DML und partitionQuery, prüft aber nicht, ob Anweisungen partitionierbar sind. Dies bedeutet, dass eine Anweisung in partitionierter DML oder der partitionQuery im Emulator ausgeführt werden kann, aber im Produktionsdienst mit einem nicht partitionierbaren Fehler fehlschlägt.

Eine vollständige Liste der unterstützten, nicht unterstützten und teilweise unterstützten APIs und Funktionen finden Sie in der README -Datei in GitHub.

Optionen zum Ausführen des Emulators

Es gibt zwei gängige Möglichkeiten, den Emulator auszuführen:

Wählen Sie die für Ihre Anwendungsentwicklung und Ihren Workflow geeignete Methode.

Emulator mit der gcloud CLI ausführen

So führen Sie den Emulator mit der Google Cloud CLI aus:

  1. Installieren Sie die Komponente cloud-spanner-emulator:

    gcloud components install cloud-spanner-emulator

    Wenn die gcloud CLI bereits installiert ist, führen Sie den folgenden Befehl aus, um alle Komponenten zu aktualisieren:

    gcloud components update

  2. Starten Sie den Emulator:

    gcloud emulators spanner start

    Der Emulator verwendet zwei lokale Endpunkte:

    • localhost:9010 für gRPC-Anfragen
    • localhost:9020 für REST-Anfragen

Emulator mit Docker ausführen

So führen Sie den Emulator mit Docker aus:

  1. Installieren Sie Docker auf Ihrem System und machen Sie es im Systempfad verfügbar.

  2. Rufen Sie das aktuelle Emulator-Image ab:

    docker pull gcr.io/cloud-spanner-emulator/emulator

  3. Führen Sie den Emulator in Docker aus:

    docker run -p 9010:9010 -p 9020:9020 gcr.io/cloud-spanner-emulator/emulator

    Der Befehl führt den Emulator aus und ordnet die Ports im Container den entsprechenden Ports auf Ihrem lokalen Host zu. Der Emulator verwendet zwei lokale Endpunkte: localhost:9010 für gRPC-Anfragen und localhost:9020 für REST-Anfragen.

gcloud CLI für die Verwendung des Emulators konfigurieren

Wenn Sie den Emulator mit der gcloud CLI verwenden möchten, deaktivieren Sie die Authentifizierung und überschreiben Sie den Endpunkt. Erstellen Sie eine separate gcloud-CLI-Konfiguration, um schnell zwischen dem Emulator und dem Produktionsdienst zu wechseln.

  1. Erstellen und aktivieren Sie eine Emulatorkonfiguration:

    gcloud config configurations create emulator
gcloud config set auth/disable_credentials true
gcloud config set project your-project-id
gcloud config set api_endpoint_overrides/spanner http://localhost:9020/

  2. Nach der Konfiguration sendet die gcloud CLI Ihre Befehle an den Emulator und nicht an den Produktionsdienst. Prüfen Sie dies, indem Sie eine Instanz mit der Instanzkonfiguration des Emulators erstellen:

    gcloud spanner instances create test-instance \
  --config=emulator-config --description="Test Instance" --nodes=1

Konfigurationen wechseln

Führen Sie folgenden Befehl aus, um zwischen dem Emulator und Ihrer Standardkonfiguration zu wechseln:

# To switch to default (production) configuration:
gcloud config configurations activate default

# To switch back to emulator configuration:
gcloud config configurations activate emulator

Clientbibliotheken mit dem Emulator verwenden

Sie können unterstützte Versionen der Clientbibliotheken mit dem Emulator verwenden, indem Sie die SPANNER_EMULATOR_HOST Umgebungsvariable festlegen. Dazu gibt es mehrere Vorgehensweisen. Beispiel:

Linux/macOS

export SPANNER_EMULATOR_HOST=localhost:9010

Windows

set SPANNER_EMULATOR_HOST=localhost:9010

Oder mit gcloud env-init:

Linux/macOS

$(gcloud emulators spanner env-init)

Windows

gcloud emulators spanner env-init > set_vars.cmd && set_vars.cmd

Wenn Ihre Anwendung gestartet wird, sucht die Clientbibliothek automatisch nach SPANNER_EMULATOR_HOST und stellt eine Verbindung zum Emulator her, wenn er ausgeführt wird.

Wenn SPANNER_EMULATOR_HOST festgelegt ist, können Sie den Emulator testen. Folgen Sie dazu den Startleitfäden. Die Anleitung zur Projekterstellung, Authentifizierung und den Anmeldedaten können Sie jedoch ignorieren, da diese für die Verwendung des Emulators nicht benötigt werden.

Unterstützte Versionen

In der folgenden Tabelle sind die Versionen der Clientbibliotheken aufgeführt, die den Emulator unterstützen.

Clientbibliothek Mindestversion
C++ v0.9.x+
C# v3.1.0+
Go v1.5.0+
Java v1.51.0+
Node.js v4.5.0+
PHP v1.25.0+
Python v1.15.0+
Ruby v1.13.0+

Zusätzliche Anweisungen für C#

Geben Sie für die C#-Clientbibliothek die emulatordetection Option im Verbindungsstring an. Im Gegensatz zu den anderen Clientbibliotheken ignoriert C# standardmäßig die Umgebungsvariable SPANNER_EMULATOR_HOST. Das folgende Beispiel zeigt den Verbindungsstring:

var builder = new SpannerConnectionStringBuilder
{
    DataSource = $"projects/{projectId}/instances/{instanceId}/databases/{databaseId}",
    EmulatorDetection = "EmulatorOnly"
};