Kurzanleitung: Spanner Omni-Befehlszeile verwenden

In diesem Dokument wird beschrieben, wie Sie die Spanner Omni-Befehlszeilenschnittstelle (CLI) verwenden, um mit einer Spanner Omni-Bereitstellung zu interagieren und sie zu verwalten. Die Spanner Omni-Befehlszeile bietet Befehle für gängige Verwaltungsaufgaben und enthält eine interaktive SQL-Shell zum Abfragen Ihrer Datenbank.

Hinweis

Bevor Sie die Spanner Omni-CLI verwenden können, müssen Sie die folgenden Anforderungen erfüllen:

  1. Eine Spanner Omni-Bereitstellung ist eingerichtet und wird ausgeführt.
  2. Der Computer, auf dem die Spanner Omni-Befehlszeile ausgeführt wird, hat Netzwerkzugriff auf den Load-Balancer der Spanner Omni-Bereitstellung oder auf mindestens einen der Server in der Bereitstellung.

Schritt 1: Spanner Omni-CLI herunterladen und installieren

  1. Laden Sie die Spanner Omni CLI aus dem Cloud Storage-Bucket spanner-omni herunter.

    Spanner Omni-Bucket aufrufen

  2. Extrahieren Sie die TAR-Datei.

    tar -xvf CLI_TAR_FILE
    

    Dadurch wird die Spanner Omni CLI-Binärdatei mit dem Namen spanner im Verzeichnis google/spanner/bin installiert.

    Damit Sie den Befehl spanner ausführen können, fügen Sie das Verzeichnis google/spanner/bin der Umgebungsvariable PATH hinzu oder verwenden Sie in den folgenden Schritten den vollständigen Pfad zum Binärprogramm.

Schritt 2: Verbindung zu Ihrer Bereitstellung herstellen

Standardmäßig versucht die Spanner Omni CLI, eine Verbindung zu localhost:15000 herzustellen. Verwenden Sie das Flag --deployment-endpoint, um eine Verbindung zu Ihrer spezifischen Bereitstellung herzustellen.

Mit dem folgenden Befehl werden beispielsweise die Zonen in Ihrer Bereitstellung aufgelistet:

spanner deployment zones list \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Schritt 3: Häufig verwendete Befehle ausführen

Nachfolgend finden Sie einige allgemeine Verwaltungsbefehle, die Sie mit der Spanner Omni CLI ausführen können.

Hilfe

Wenn Sie eine Liste der verfügbaren Befehle und globalen Flags aufrufen möchten, führen Sie Folgendes aus:

spanner --help

Datenbank erstellen

Führen Sie den folgenden Befehl aus, um eine neue Datenbank in Ihrem Deployment zu erstellen:

spanner databases create DATABASE_NAME \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Alle Datenbanken auflisten

Führen Sie folgenden Befehl aus, um alle Datenbanken in Ihrer Bereitstellung aufzulisten:

spanner databases list \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Schritt 4: Interaktive SQL-Shell-Sitzung starten

Die Spanner Omni CLI enthält eine interaktive SQL-Shell zum Ausführen von Abfragen. Wenn Sie die Shell für eine bestimmte Datenbank mit dem Flag --database starten, können Sie SQL-Befehle ausführen, ohne die Datenbank oder den Endpunkt für jede Abfrage angeben zu müssen.

Führen Sie Folgendes aus, um die SQL-Shell zu starten:

spanner sql --database=DATABASE_NAME \
    --deployment-endpoint=LOAD_BALANCER_IP_OR_SERVER_IP:PORT

Nach dem Start der Shell wird die Eingabeaufforderung sql> angezeigt:

spanner-cli>

Geben Sie exit ein, um die Shell zu beenden.