firestore1 命令行界面 (CLI) 允许您从终端舒适地使用 Google Firestore 服务的大部分功能。

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

如果请求数据结构，这些数据结构将以美观打印的 JSON 格式返回，作为其他工具的输入非常有用。

关于 Firestore API 的其他一切都可以在 官方文档网站 找到。

安装和源代码

使用 cargo 安装命令行界面

cargo install google-firestore1-cli

在 GitHub 上 查找源代码。

用法

此文档是从修订版 Firestore API 20220221 生成的。CLI 版本为 3.1.0。

firestore1 [options]
        projects
                databases-collection-groups-fields-get <name> [-p <v>]... [-o <out>]
                databases-collection-groups-fields-list <parent> [-p <v>]... [-o <out>]
                databases-collection-groups-fields-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-collection-groups-indexes-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-collection-groups-indexes-delete <name> [-p <v>]... [-o <out>]
                databases-collection-groups-indexes-get <name> [-p <v>]... [-o <out>]
                databases-collection-groups-indexes-list <parent> [-p <v>]... [-o <out>]
                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-get <name> [-p <v>]... [-o <out>]
                databases-import-documents <name> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-list <parent> [-p <v>]... [-o <out>]
                databases-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                databases-operations-delete <name> [-p <v>]... [-o <out>]
                databases-operations-get <name> [-p <v>]... [-o <out>]
                databases-operations-list <name> [-p <v>]... [-o <out>]
                databases-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
  firestore1 --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 开头。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会请求用户授权。根据命令行界面（CLI）的指示进行授权或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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