bigqueryreservation1 命令行界面（CLI）允许您在终端中舒适地使用Google BigQuery预订服务的大部分功能。

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

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

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

安装和源代码

使用cargo安装命令行界面

cargo install google-bigqueryreservation1-cli

在GitHub上找到源代码。

用法

本文档是从修订版20240227的BigQuery预订API生成的。CLI版本为5.0.4。

bigqueryreservation1 [options]
        projects
                locations-capacity-commitments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-capacity-commitments-delete <name> [-p <v>]... [-o <out>]
                locations-capacity-commitments-get <name> [-p <v>]... [-o <out>]
                locations-capacity-commitments-list <parent> [-p <v>]... [-o <out>]
                locations-capacity-commitments-merge <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-capacity-commitments-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-capacity-commitments-split <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-get-bi-reservation <name> [-p <v>]... [-o <out>]
                locations-reservations-assignments-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-reservations-assignments-delete <name> [-p <v>]... [-o <out>]
                locations-reservations-assignments-list <parent> [-p <v>]... [-o <out>]
                locations-reservations-assignments-move <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-reservations-assignments-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-reservations-create <parent> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-reservations-delete <name> [-p <v>]... [-o <out>]
                locations-reservations-get <name> [-p <v>]... [-o <out>]
                locations-reservations-list <parent> [-p <v>]... [-o <out>]
                locations-reservations-patch <name> (-r <kv>)... [-p <v>]... [-o <out>]
                locations-search-all-assignments <parent> [-p <v>]... [-o <out>]
                locations-search-assignments <parent> [-p <v>]... [-o <out>]
                locations-update-bi-reservation <name> (-r <kv>)... [-p <v>]... [-o <out>]
  bigqueryreservation1 --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文件中，文件名以bigqueryreservation1-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

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

身份验证

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

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

首次使用作用域时，系统会要求用户授权。根据命令行界面提供的说明进行授权或拒绝。

如果用户已验证了作用域，相应的信息将被存储在配置目录中，以JSON格式，例如 ~/.google-service-cli/bigqueryreservation1-token-<scope-hash>.json。不需要对这些令牌进行手动管理。

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

应用程序密钥

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

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

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

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

调试

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

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

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