spanner1 命令行界面（CLI）允许您从终端舒适地使用Google Spanner服务的多数功能。

默认情况下，所有输出都打印到标准输出，但可以通过设置标志将其重定向到文件，而不考虑shell的能力。错误将打印到标准错误，并导致程序退出代码非零。

如果请求数据结构，则这些结构将作为格式化打印的JSON返回，以便作为其他工具的输入。

有关Spanner API的所有其他信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面：

cargo install google-spanner1-cli

在github上找到源代码。

用法

此文档是根据修订版 20190613 中的Spanner API生成的。CLI版本为 1.0.12。

spanner1 [options]
        projects
                instance-configs-get <name> [-p <v>]... [-o <out>]
                instance-configs-list <parent> [-p <v>]... [-o <out>]
                instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-drop-database <database> [-p <v>]... [-o <out>]
                instances-databases-get <name> [-p <v>]... [-o <out>]
                instances-databases-get-ddl <database> [-p <v>]... [-o <out>]
                instances-databases-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-list <parent> [-p <v>]... [-o <out>]
                instances-databases-operations-cancel <name> [-p <v>]... [-o <out>]
                instances-databases-operations-delete <name> [-p <v>]... [-o <out>]
                instances-databases-operations-get <name> [-p <v>]... [-o <out>]
                instances-databases-operations-list <name> [-p <v>]... [-o <out>]
                instances-databases-sessions-begin-transaction <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-commit <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-create <database> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-delete <name> [-p <v>]... [-o <out>]
                instances-databases-sessions-execute-batch-dml <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-execute-sql <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-execute-streaming-sql <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-get <name> [-p <v>]... [-o <out>]
                instances-databases-sessions-list <database> [-p <v>]... [-o <out>]
                instances-databases-sessions-partition-query <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-partition-read <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-read <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-rollback <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-sessions-streaming-read <session> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-databases-update-ddl <database> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-delete <name> [-p <v>]... [-o <out>]
                instances-get <name> [-p <v>]... [-o <out>]
                instances-get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-list <parent> [-p <v>]... [-o <out>]
                instances-operations-cancel <name> [-p <v>]... [-o <out>]
                instances-operations-delete <name> [-p <v>]... [-o <out>]
                instances-operations-get <name> [-p <v>]... [-o <out>]
                instances-operations-list <name> [-p <v>]... [-o <out>]
                instances-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                instances-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
  spanner1 --help

Configuration:
  [--scope <url>]...
            Specify the authentication a method should be executed in. Each scope
            requires the user to grant this application permission to use it.
            If unset, it defaults to the shortest scope url for a particular method.
  --config-dir <folder>
            A directory into which we will store our persistent data. Defaults to
            a user-writable directory that we will create during the first invocation.
            [default: ~/.google-service-cli]
  --debug
            Output all server communication to standard error. `tx` and `rx` are placed
            into the same stream.
  --debug-auth
            Output all communication related to authentication to standard error. `tx`
            and `rx` are placed into the same stream.

配置

程序将所有持久数据存储在 ~/.google-service-cli 目录下的 JSON 文件中，文件名以 spanner1- 开头。您可以使用 --config-dir 标志在每个调用上更改用于存储配置的目录。

以下段落中提供了有关各种类型持久数据的更多信息。

身份验证

大多数API需要用户对任何请求进行身份验证。如果是这种情况，则 作用域 确定了授予的权限集。这些权限的粒度通常不超过 只读 或 完全访问。

如果没有设置，系统将自动选择最小的可行作用域，例如，当调用只读方法时，它只会请求只读作用域。您可以使用 --scope 标志直接指定作用域。所有适用的作用域都在相应方法的CLI文档中进行了说明。

第一次使用作用域时，会要求用户授权。按照CLI提供的指示授权或拒绝。

如果用户已验证作用域，相关信息均将以JSON格式存储在配置目录中，例如：~/.google-service-cli/spanner1-token-<scope-hash>.json。无需手动管理这些令牌。

要撤销授权，请参阅官方文档。

应用程序密钥

为了允许任何应用程序使用Google服务，它需要通过Google开发者控制台进行注册。应用程序可能使用的API将逐个启用。大多数API可以免费使用，并设有每日配额。

为了在不强制用户注册自己的应用程序的情况下，更方便地使用CLI，CLI自带了一个默认的应用程序密钥，并相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。

您可以通过将您的自己的密钥文件放在此位置来解决这个问题：~/.google-service-cli/spanner1-secret.json，前提是已为它启用了所需的spanner API。这样的密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON下载，并直接使用。

有关如何设置Google项目和启用API的更多信息，请参阅官方文档。

调试

尽管CLI会尽力提供可用的错误信息，但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端-服务器通信直接输出到标准错误来完成的。

使用--debug标志会将所有客户端-服务器通信打印到标准错误，而使用--debug-auth标志会将所有与身份验证相关的通信打印到标准错误。如果设置了--debug标志，错误结果将被调试打印，可能提供有关当前问题的更多信息。