命令行界面 (CLI) datafusion1 允许从终端使用 Google Data Fusion 服务的多数功能。

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

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

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

安装和源代码

使用 cargo 安装命令行界面

cargo install google-datafusion1-cli

在 GitHub 上查找源代码。

用法

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

datafusion1 [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-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-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-versions-list <parent> [-p <v>]... [-o <out>]
  datafusion1 --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 目录中存储所有持久数据，该目录以 datafusion1- 前缀的 JSON 文件开头。您可以使用 --config-dir 标志在每次调用中更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，用户将被要求授权。按照 CLI 提供的说明授权权限或拒绝。

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

要撤销授予的验证，请参阅官方文档。

应用程序密钥

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

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

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

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

调试

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

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

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