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 una shell de SQL interactiva 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. Una implementación de Spanner Omni está configurada y en ejecución.
  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 del 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 objeto binario de la CLI de Spanner Omni, llamado spanner, en el google/spanner/bin directorio.

    Para ejecutar el comando spanner, agrega el directorio google/spanner/bin a tu PATH variable de entorno, 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

Los siguientes son 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 lo siguiente:

spanner --help

Crea una base de datos

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

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 lo siguiente:

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

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

La CLI de Spanner Omni incluye una shell de SQL interactiva para ejecutar consultas. Si inicias la 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 extremo para cada consulta.

Para iniciar la shell de SQL, ejecuta lo siguiente:

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

Después de que se inicia la shell, verás el mensaje sql>:

spanner-cli>

Para salir de la shell, escribe exit.