Guía de inicio rápido para usar la CLI de Spanner Omni

En este documento, se muestra cómo usar la interfaz de línea de comandos (CLI) de Spanner Omni para interactuar con una implementación de Spanner Omni y administrarla. La CLI de Spanner Omni proporciona comandos para tareas administrativas comunes y, además, incluye un shell de SQL interactivo para consultar tu base de datos.

Antes de comenzar

Antes de usar la CLI de Spanner Omni, asegúrate de cumplir con los siguientes requisitos:

  1. Se configuró y se está ejecutando una implementación de Spanner Omni.
  2. La máquina que ejecuta la CLI de Spanner Omni tiene acceso a la red del balanceador de cargas de la implementación de Spanner Omni o a, al menos, uno de los servidores de la implementación.

Paso 1: Descarga e instala la CLI de Spanner Omni

  1. Descarga la CLI de Spanner Omni desde el bucket de Cloud Storage spanner-omni.

    Ir al bucket de Spanner Omni

  2. Extrae el archivo tar.

    tar -xvf CLI_TAR_FILE

    Esto instala el archivo binario de la CLI de Spanner Omni, llamado spanner, en el directorio google/spanner/bin.

    Para ejecutar el comando spanner, agrega el directorio google/spanner/bin a tu variable de entorno PATH o usa la ruta de acceso completa al objeto binario en los siguientes pasos.

Paso 2: Conéctate a tu implementación

De forma predeterminada, la CLI de Spanner Omni intenta conectarse a localhost:15000. Para conectarte a tu implementación específica, usa la marca --deployment-endpoint.

Por ejemplo, el siguiente comando enumera las zonas de tu implementación:

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

Paso 3: Ejecuta comandos comunes

A continuación, se muestran algunos comandos administrativos comunes que puedes ejecutar con la CLI de Spanner Omni.

Obtener ayuda

Para ver una lista de los comandos y las marcas globales disponibles, ejecuta el siguiente comando:

spanner --help

Crea una base de datos

Para crear una base de datos nueva en tu implementación, ejecuta el siguiente comando:

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

Enumera todas las bases de datos

Para enumerar todas las bases de datos de tu implementación, ejecuta el siguiente comando:

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

Paso 4: Inicia una sesión interactiva de shell de SQL

La CLI de Spanner Omni incluye una shell interactiva de SQL para ejecutar consultas. Si inicias el shell para una base de datos específica con la marca --database, puedes ejecutar comandos de SQL sin necesidad de especificar la base de datos o el endpoint para cada consulta.

Para iniciar el shell de SQL, ejecuta el siguiente comando:

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

Después de que se inicie la shell, verás el símbolo del sistema sql>:

spanner-cli>

Para salir de la shell, escribe exit.