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