11个稳定版本 (3个主要版本)

5.0.4+20240111 2024年3月5日
3.1.0+20211028 2022年4月26日
3.0.0+20211028 2022年3月8日
2.0.4+20210322 2021年4月14日
1.0.10+20190617 2019年7月6日

#2529 in Web编程

MIT 许可证

625KB
8K SLoC

datafusion1-beta1命令行界面(CLI)允许您从终端舒适地使用Google Data Fusion服务的几乎所有功能。

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

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

有关Data Fusion API的所有其他信息,请参阅官方文档网站

安装和源代码

使用cargo安装命令行界面

cargo install google-datafusion1_beta1-cli

github上查找源代码。

用法

本文档是根据20240111修订版本的Data Fusion API生成的。CLI版本为5.0.4。

datafusion1-beta1 [options]
        projects
                locations-get <name> [-p <v>]... [-o <out>]
                locations-instances-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-delete <name> [-p <v>]... [-o <out>]
                locations-instances-dns-peerings-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-dns-peerings-delete <name> [-p <v>]... [-o <out>]
                locations-instances-dns-peerings-list <parent> [-p <v>]... [-o <out>]
                locations-instances-get <name> [-p <v>]... [-o <out>]
                locations-instances-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-instances-list <parent> [-p <v>]... [-o <out>]
                locations-instances-namespaces-get-iam-policy <resource> [-p <v>]... [-o <out>]
                locations-instances-namespaces-list <parent> [-p <v>]... [-o <out>]
                locations-instances-namespaces-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-namespaces-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-restart <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-instances-upgrade <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-operations-cancel <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-operations-delete <name> [-p <v>]... [-o <out>]
                locations-operations-get <name> [-p <v>]... [-o <out>]
                locations-operations-list <name> [-p <v>]... [-o <out>]
                locations-remove-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-versions-list <parent> [-p <v>]... [-o <out>]
  datafusion1-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文件中,文件名以datafusion1-beta1-开头。您可以使用--config-dir标志在每个调用上更改用于存储配置的目录。

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

身份验证

大多数API都需要用户对请求进行身份验证。如果是这样,则作用域确定授予的权限集。这些权限的粒度通常不超过只读完全访问

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

第一次使用范围时,会提示用户授权。根据CLI的说明授权或拒绝。

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

要撤销授予的认证,请参阅官方文档

应用程序密钥

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

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

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

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

调试

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

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

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

依赖关系

~20–31MB
~582K SLoC