6个稳定版本
5.0.4+20240303 | 2024年3月5日 |
---|---|
3.1.0+20220304 | 2022年4月26日 |
3.0.0+20220304 | 2022年3月8日 |
2.0.4+20210329 | 2021年4月15日 |
#930 在 数据库接口
每月106次
225KB
3K SLoC
该firebasedatabase1-beta
命令行界面(CLI)允许您从终端舒适地使用Google Firebase实时数据库(服务)的大部分功能。
默认情况下,所有输出都打印到标准输出,但可以设置标志将其直接定向到文件,而不受shell能力的限制。错误将打印到标准错误,并导致程序的退出代码非零。
如果请求数据结构,则这些结构将作为格式化的JSON返回,以便作为其他工具的输入。
有关Firebase实时数据库API的所有其他信息,请参阅官方文档站点。
安装和源代码
使用cargo安装命令行界面
cargo install google-firebasedatabase1_beta-cli
在GitHub上找到源代码。
用法
此文档是从Firebase实时数据库 API的20240303修订版生成的。CLI的版本为5.0.4。
firebasedatabase1-beta [options]
projects
locations-instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
locations-instances-delete <name> [-p <v>]... [-o <out>]
locations-instances-disable <name> (-r <kv>)... [-p <v>]... [-o <out>]
locations-instances-get <name> [-p <v>]... [-o <out>]
locations-instances-list <parent> [-p <v>]... [-o <out>]
locations-instances-reenable <name> (-r <kv>)... [-p <v>]... [-o <out>]
locations-instances-undelete <name> (-r <kv>)... [-p <v>]... [-o <out>]
firebasedatabase1-beta --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文件中,文件名以firebasedatabase1-beta-
开头。您可以使用--config-dir
标志在每个调用的基础上更改用于存储配置的目录。
以下段落提供了有关各种类型持久数据的更多信息。
身份验证
大多数API需要用户对任何请求进行身份验证。如果是这样,则范围确定授予的权限集合。这些的粒度通常不超过只读或完全访问。
如果没有设置,系统将自动选择最小可行范围,例如,在调用只读方法时,它将只请求只读范围。您可以使用--scope
标志直接指定范围。所有适用的范围均在相应方法的CLI文档中记录。
第一次使用作用域时,会要求用户授权。按照CLI提供的说明授权或拒绝。
如果用户已认证作用域,相应的信息将作为JSON存储在配置目录中,例如:~/.google-service-cli/firebasedatabase1-beta-token-<scope-hash>.json
。无需手动管理这些令牌。
要撤销授权认证,请参阅官方文档。
应用程序密钥
为了允许任何应用程序使用Google服务,它需要使用Google开发者控制台进行注册。然后逐个启用应用程序可能使用的API。大多数API可以免费使用,并设有每日配额。
为了在不强制用户注册自己的应用程序的情况下更舒适地使用CLI,CLI自带了一个默认的应用程序密钥,并相应地进行了配置。这也意味着全球范围内的重用可能会耗尽每日配额。
您可以通过将您自己的密钥文件放在此位置来解决这个问题:~/.google-service-cli/firebasedatabase1-beta-secret.json
,假设已为它启用了所需的firebasedatabase API。此类密钥文件可以从Google开发者控制台在APIs & auth -> Credentials -> Download JSON处下载并直接使用。
有关如何设置Google项目和启用API的更多信息,请参阅官方文档。
调试
尽管CLI尽力提供可用的错误消息,但有时可能希望了解导致特定问题的确切原因。这是通过允许所有客户端-服务器通信直接输出到标准错误原样来完成的。
使用--debug
标志将错误以Debug
表示形式打印到标准错误。
您可以考虑将标准错误重定向到文件,以便于使用,例如:firebasedatabase1-beta --debug <resource> <method> [options] 2>debug.txt
。
依赖项
~20–32MB
~584K SLoC