Spanner Omni CLI を使用したクイックスタート

このドキュメントでは、Spanner Omni コマンドライン インターフェース(CLI)を使用して Spanner Omni デプロイメントを操作および管理する方法について説明します。Spanner Omni CLI には、一般的な管理タスクのコマンドが用意されており、データベースのクエリを実行するためのインタラクティブ SQL シェルが含まれています。

始める前に

Spanner Omni CLI を使用する前に、次の要件を満たしていることを確認してください。

  1. Spanner Omni デプロイメントが設定され、実行されている。
  2. Spanner Omni CLI を実行するマシンから、Spanner Omni デプロイメントのロードバランサまたはデプロイメント内の少なくとも 1 つのサーバーにネットワーク アクセスできる。

ステップ 1: Spanner Omni CLI をダウンロードしてインストールする

  1. spanner-omni Cloud Storage バケットから Spanner Omni CLI をダウンロードします。

    Spanner Omni バケットに移動

  2. tar ファイルを解凍します。

    tar -xvf CLI_TAR_FILE
    

    これにより、spanner という名前の Spanner Omni CLI バイナリが google/spanner/bin ディレクトリにインストールされます。

    spanner コマンドを実行するには、google/spanner/bin ディレクトリを PATH 環境変数に追加するか、次の手順でバイナリのフルパスを使用します。

ステップ 2: デプロイメントに接続する

デフォルトでは、Spanner Omni CLI は localhost:15000 への接続を試みます。特定のデプロイメントに接続するには、--deployment-endpoint フラグを使用します。

たとえば、次のコマンドはデプロイメント内のゾーンを一覧表示します。

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

ステップ 3: 一般的なコマンドを実行する

Spanner Omni CLI で実行できる一般的な管理コマンドは次のとおりです。

サポートが必要な場合

使用可能なコマンドとグローバル フラグの一覧を表示するには、次のコマンドを実行します。

spanner --help

データベースの作成

デプロイメントに新しいデータベースを作成するには、次のコマンドを実行します。

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

すべてのデータベースを一覧表示する

デプロイメント内のすべてのデータベースを一覧表示するには、次のコマンドを実行します。

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

ステップ 4: インタラクティブ SQL シェル セッションを開始する

Spanner Omni CLI には、クエリを実行するためのインタラクティブ SQL シェルが含まれています。--database フラグを使用して特定のデータベースのシェルを起動すると、クエリごとにデータベースまたはエンドポイントを指定しなくても SQL コマンドを実行できます。

SQL シェルを起動するには、次のコマンドを実行します。

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

シェルが起動すると、sql> プロンプトが表示されます。

spanner-cli>

シェルを終了するには、「exit」と入力します。