该 datastore1 命令行界面 (CLI) 允许您从终端舒适地使用Google数据存储服务的几乎所有功能。

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

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

有关数据存储API的所有其他信息，请参阅官方文档网站。

安装和源代码

使用cargo安装命令行界面

cargo install google-datastore1-cli

在GitHub上找到源代码。

用法

此文档是从修订版 20240226 的 datastore API生成的。CLI版本为 5.0.4。

datastore1 [options]
        projects
                allocate-ids <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                begin-transaction <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                commit <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                export <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                import <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                indexes-create <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                indexes-delete <project-id> <index-id> [-p <v>]... [-o <out>]
                indexes-get <project-id> <index-id> [-p <v>]... [-o <out>]
                indexes-list <project-id> [-p <v>]... [-o <out>]
                lookup <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                operations-cancel <name> [-p <v>]... [-o <out>]
                operations-delete <name> [-p <v>]... [-o <out>]
                operations-get <name> [-p <v>]... [-o <out>]
                operations-list <name> [-p <v>]... [-o <out>]
                reserve-ids <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                rollback <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                run-aggregation-query <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                run-query <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
  datastore1 --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]

配置

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

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

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。按照CLI的说明授予权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

尽管CLI尽力提供可用的错误信息，但有时可能需要知道导致特定问题确切原因。这通过允许所有客户端-服务器通信直接输出到标准错误来实现。

使用--debug标志将错误以Debug表示法打印到标准错误。

您可以考虑将标准错误重定向到文件以便于使用，例如datastore1 --debug <resource> <method> [options] 2>debug.txt。