Guia de início rápido sobre o uso da CLI do Spanner Omni

Neste documento, mostramos como usar a interface de linha de comando (CLI) do Spanner Omni para interagir com uma implantação do Spanner Omni e gerenciá-la. A CLI do Spanner Omni fornece comandos para tarefas administrativas comuns e inclui um shell SQL interativo para consultar seu banco de dados.

Antes de começar

Antes de usar a CLI do Spanner Omni, verifique se você atende aos seguintes requisitos:

  1. Uma implantação do Spanner Omni está configurada e em execução.
  2. A máquina que executa a CLI do Spanner Omni tem acesso à rede do balanceador de carga da implantação do Spanner Omni ou a pelo menos um dos servidores na implantação.

Etapa 1: fazer o download e instalar a CLI do Spanner Omni

  1. Faça o download da CLI do Spanner Omni no bucket do Cloud Storage spanner-omni.

    Acessar o bucket do Spanner Omni

  2. Extraia o arquivo .tar.

    tar -xvf CLI_TAR_FILE
    

    Isso instala o binário da CLI do Spanner Omni, chamado spanner, no diretório google/spanner/bin.

    Para executar o comando spanner, adicione o diretório google/spanner/bin à variável de ambiente PATH ou use o caminho completo para o binário nas etapas a seguir.

Etapa 2: conectar à implantação

Por padrão, a CLI do Spanner Omni tenta se conectar a localhost:15000. Para se conectar à sua implantação específica, use a flag --deployment-endpoint.

Por exemplo, o comando a seguir lista as zonas na sua implantação:

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

Etapa 3: executar comandos comuns

Confira a seguir alguns comandos administrativos comuns que podem ser executados com a CLI do Spanner Omni.

Precisa de ajuda?

Para ver uma lista de comandos e flags globais disponíveis, execute:

spanner --help

Criar um banco de dados

Para criar um banco de dados na sua implantação, execute:

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

Listar todos os bancos de dados

Para listar todos os bancos de dados na sua implantação, execute:

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

Etapa 4: iniciar uma sessão interativa do shell SQL

A CLI do Spanner Omni inclui um shell SQL interativo para executar consultas. Ao iniciar o shell para um banco de dados específico com a flag --database, é possível executar comandos SQL sem precisar especificar o banco de dados ou o endpoint para cada consulta.

Para iniciar o shell SQL, execute:

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

Depois que o shell for iniciado, você verá o prompt sql>:

spanner-cli>

Para sair do shell, digite exit.