该 datastore1-beta3 命令行界面（CLI）允许您从终端舒适地使用Google数据存储服务的大部分功能。

默认情况下，所有输出都打印到标准输出，但可以设置标志将其直接重定向到文件，而无需依赖shell的功能。错误将打印到标准错误，并导致程序退出代码非零。

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-datastore1_beta3-cli

在GitHub上找到源代码。

用法

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

datastore1-beta3 [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>]
                lookup <project-id> (-r <kv>)... [-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-beta3 --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目录中存储所有持久数据，该目录中的文件以datastore1-beta3-为前缀。您可以使用--config-dir标志在每次调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息，请参阅以下段落。

身份验证

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

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

第一次使用范围时，系统会询问用户权限。根据CLI的指示授权或拒绝权限。

如果用户验证了某个范围，相关信息将以JSON格式存储在配置目录中，例如~/.google-service-cli/datastore1-beta3-token-<scope-hash>.json。不需要手动管理这些令牌。

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

应用程序密钥

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

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

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

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

调试

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

--debug标志将以Debug表示形式将错误打印到标准错误。

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