快速入门：使用 Spanner Omni CLI

本文档介绍了如何使用 Spanner Omni 命令行界面 (CLI) 与 Spanner Omni 部署进行交互并管理该部署。Spanner Omni CLI 提供用于执行常见管理任务的命令，并包含用于查询数据库的交互式 SQL shell。

准备工作

在使用 Spanner Omni CLI 之前，请确保您满足以下要求：

  1. 已设置并运行 Spanner Omni 部署。
  2. 运行 Spanner Omni CLI 的机器具有对 Spanner Omni 部署的负载平衡器或部署中至少一个服务器的网络访问权限。

第 1 步：下载并安装 Spanner Omni CLI

  1. 从 spanner-omni Cloud Storage 存储桶下载 Spanner Omni CLI。

    前往 Spanner Omni 代码桶

  2. 解压缩 tar 文件。

    tar -xvf CLI_TAR_FILE

    这会在 google/spanner/bin 目录中安装名为 spanner 的 Spanner Omni CLI 二进制文件。

    如需运行 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 shell 会话

Spanner Omni CLI 包含一个用于运行查询的交互式 SQL shell。通过使用 --database 标志为特定数据库启动 shell，您可以运行 SQL 命令，而无需为每个查询指定数据库或端点。

如需启动 SQL shell，请运行以下命令：

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

shell 启动后，您会看到 sql> 提示：

spanner-cli>

如需退出 shell，请输入 exit。