firestore1-beta1命令行界面（CLI）允许您从终端舒适地使用Google Firestore服务的几乎所有功能。

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

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

有关Firestore API的更多信息，请参阅官方文档站点。

安装和源代码

使用cargo安装命令行界面：

cargo install google-firestore1_beta1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版Firestore API 20220221 生成的。CLI的版本是3.1.0。

firestore1-beta1 [options]
        projects
                databases-documents-batch-get <database> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-batch-write <database> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-begin-transaction <database> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-commit <database> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-create-document <parent> <collection-id> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-delete <name> [-p <v>]... [-o <out>]
                databases-documents-get <name> [-p <v>]... [-o <out>]
                databases-documents-list <parent> <collection-id> [-p <v>]... [-o <out>]
                databases-documents-list-collection-ids <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-listen <database> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-partition-query <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-rollback <database> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-run-query <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-documents-write <database> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-export-documents <name> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-import-documents <name> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-indexes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-indexes-delete <name> [-p <v>]... [-o <out>]
                databases-indexes-get <name> [-p <v>]... [-o <out>]
                databases-indexes-list <parent> [-p <v>]... [-o <out>]
  firestore1-beta1 --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文件中，这些文件以firestore1-beta1-开头。您可以通过在每次调用时使用--config-dir标志来更改用于存储配置的目录。

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

身份验证

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

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

第一次使用范围时，用户会被要求授权。根据 CLI 的指示授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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