bigquery2 命令行界面（CLI）允许您从终端舒适地使用Google bigquery服务的几乎所有功能。

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

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

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

安装和源代码

使用cargo安装命令行界面：

cargo install google-bigquery2-cli

在GitHub上找到源代码。

用法

此文档是从修订版20220222的bigquery API生成的。CLI版本为3.1.0。

bigquery2 [options]
        datasets
                delete <project-id> <dataset-id> [-p <v>]...
                get <project-id> <dataset-id> [-p <v>]... [-o <out>]
                insert <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project-id> [-p <v>]... [-o <out>]
                patch <project-id> <dataset-id> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project-id> <dataset-id> (-r <kv>)... [-p <v>]... [-o <out>]
        jobs
                cancel <project-id> <job-id> [-p <v>]... [-o <out>]
                delete <project-id> <job-id> [-p <v>]...
                get <project-id> <job-id> [-p <v>]... [-o <out>]
                get-query-results <project-id> <job-id> [-p <v>]... [-o <out>]
                insert <project-id> (-r <kv>)... (-u simple -f <file> [-m <mime>]) [-p <v>]... [-o <out>]
                list <project-id> [-p <v>]... [-o <out>]
                query <project-id> (-r <kv>)... [-p <v>]... [-o <out>]
        models
                delete <project-id> <dataset-id> <model-id> [-p <v>]...
                get <project-id> <dataset-id> <model-id> [-p <v>]... [-o <out>]
                list <project-id> <dataset-id> [-p <v>]... [-o <out>]
                patch <project-id> <dataset-id> <model-id> (-r <kv>)... [-p <v>]... [-o <out>]
        projects
                get-service-account <project-id> [-p <v>]... [-o <out>]
                list [-p <v>]... [-o <out>]
        routines
                delete <project-id> <dataset-id> <routine-id> [-p <v>]...
                get <project-id> <dataset-id> <routine-id> [-p <v>]... [-o <out>]
                insert <project-id> <dataset-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project-id> <dataset-id> [-p <v>]... [-o <out>]
                update <project-id> <dataset-id> <routine-id> (-r <kv>)... [-p <v>]... [-o <out>]
        row-access-policies
                get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project-id> <dataset-id> <table-id> [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
        tabledata
                insert-all <project-id> <dataset-id> <table-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project-id> <dataset-id> <table-id> [-p <v>]... [-o <out>]
        tables
                delete <project-id> <dataset-id> <table-id> [-p <v>]...
                get <project-id> <dataset-id> <table-id> [-p <v>]... [-o <out>]
                get-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                insert <project-id> <dataset-id> (-r <kv>)... [-p <v>]... [-o <out>]
                list <project-id> <dataset-id> [-p <v>]... [-o <out>]
                patch <project-id> <dataset-id> <table-id> (-r <kv>)... [-p <v>]... [-o <out>]
                set-iam-policy <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                test-iam-permissions <resource> (-r <kv>)... [-p <v>]... [-o <out>]
                update <project-id> <dataset-id> <table-id> (-r <kv>)... [-p <v>]... [-o <out>]
  bigquery2 --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文件中，以bigquery2-开头。您可以使用--config-dir标志在每个调用的基础上更改用于存储配置的目录。

有关各种类型持久数据的更多信息将在以下段落中给出。

身份验证

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

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

第一次使用作用域时，系统会要求用户授权。按照CLI提供的说明授权权限或拒绝。

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

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

应用程序密钥

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

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

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

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

调试

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

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

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