bigquerydatatransfer1 命令行界面（CLI）允许您在终端中舒适地使用Google BigQuery数据传输服务的大部分功能。

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

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

关于BigQuery数据传输API的其他所有信息都可以在官方文档网站找到。

安装和源代码

使用cargo安装命令行界面

cargo install google-bigquerydatatransfer1-cli

在GitHub上找到源代码。

用法

本文档是根据修订版 20240227 的BigQuery数据传输API生成的。CLI版本为 5.0.4。

bigquerydatatransfer1 [options]
        projects
                data-sources-check-valid-creds <name> (-r <kv>)... [-p <v>]... [-o <out>]
                data-sources-get <name> [-p <v>]... [-o <out>]
                data-sources-list <parent> [-p <v>]... [-o <out>]
                enroll-data-sources <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-data-sources-check-valid-creds <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-data-sources-get <name> [-p <v>]... [-o <out>]
                locations-data-sources-list <parent> [-p <v>]... [-o <out>]
                locations-enroll-data-sources <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get <name> [-p <v>]... [-o <out>]
                locations-list <name> [-p <v>]... [-o <out>]
                locations-transfer-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-transfer-configs-delete <name> [-p <v>]... [-o <out>]
                locations-transfer-configs-get <name> [-p <v>]... [-o <out>]
                locations-transfer-configs-list <parent> [-p <v>]... [-o <out>]
                locations-transfer-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-transfer-configs-runs-delete <name> [-p <v>]... [-o <out>]
                locations-transfer-configs-runs-get <name> [-p <v>]... [-o <out>]
                locations-transfer-configs-runs-list <parent> [-p <v>]... [-o <out>]
                locations-transfer-configs-runs-transfer-logs-list <parent> [-p <v>]... [-o <out>]
                locations-transfer-configs-schedule-runs <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-transfer-configs-start-manual-runs <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-unenroll-data-sources <name> (-r <kv>)... [-p <v>]... [-o <out>]
                transfer-configs-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                transfer-configs-delete <name> [-p <v>]... [-o <out>]
                transfer-configs-get <name> [-p <v>]... [-o <out>]
                transfer-configs-list <parent> [-p <v>]... [-o <out>]
                transfer-configs-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                transfer-configs-runs-delete <name> [-p <v>]... [-o <out>]
                transfer-configs-runs-get <name> [-p <v>]... [-o <out>]
                transfer-configs-runs-list <parent> [-p <v>]... [-o <out>]
                transfer-configs-runs-transfer-logs-list <parent> [-p <v>]... [-o <out>]
                transfer-configs-schedule-runs <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                transfer-configs-start-manual-runs <parent> (-r <kv>)... [-p <v>]... [-o <out>]
  bigquerydatatransfer1 --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 文件中，文件名以 bigquerydatatransfer1- 前缀开始。您可以使用 --config-dir 标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用范围时，系统会要求用户授权。按照CLI提供的说明授权权限，或拒绝授权。

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

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

应用程序密钥

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

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

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

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

调试

尽管CLI尽可能提供可用的错误消息，但有时可能希望知道导致特定问题确切的原因。这是通过允许所有客户端-服务器通信直接输出到标准错误完成的。

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

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