获取视图相关信息

本文档介绍了如何在 BigQuery 中获取关于视图的信息或元数据。

您可以通过以下方式获取视图元数据：

使用控制台
使用 bq 命令行工具的 bq show 命令
调用 tables.get API 方法
使用客户端库
查询 INFORMATION_SCHEMA 视图（Beta 版）

准备工作

授予为用户提供执行本文档中的每个任务所需权限的 Identity and Access Management (IAM) 角色。

所需权限

如需获取有关视图的信息，您需要拥有 bigquery.tables.get IAM 权限。

以下每个预定义 IAM 角色都包含获取视图相关信息所需的权限：

roles/bigquery.metadataViewer
roles/bigquery.dataViewer
roles/bigquery.dataOwner
roles/bigquery.dataEditor
roles/bigquery.admin

此外，如果您拥有 bigquery.datasets.create 权限，则可以获取在自己创建的数据集中的视图相关信息。

如需详细了解 BigQuery 中的 IAM 角色和权限，请参阅预定义的角色和权限。

获取视图信息

获取视图相关信息的过程与获取表相关信息的过程相同。

如需获取有关视图的信息，请执行如下操作：

控制台

展开您的数据集。
点击视图名称。
点击详细信息。详细信息标签页显示了视图的说明、视图信息和定义视图的 SQL 查询。

bq

发出 bq show 命令。--format 标志可用于控制输出。如果您要获取非默认项目中的视图信息，请按以下格式将相应项目 ID 添加到数据集中：[PROJECT_ID]:[DATASET]。

bq show \
--format=prettyjson \
project_id:dataset.view

其中：

project_id 是项目 ID。
dataset 是数据集的名称。
view 是视图名称。

示例：

输入以下命令，显示默认项目中数据集 mydataset 内 myview 视图的相关信息。

bq show --format=prettyjson mydataset.myview

输入以下命令，显示 myotherproject 中数据集 mydataset 中 myview 视图的相关信息。

bq show --format=prettyjson myotherproject:mydataset.myview

API

调用 tables.get 方法并提供所有相关参数。

Go

尝试此示例之前，请按照《BigQuery 快速入门：使用客户端库》中的 Go 设置说明进行操作。如需了解详情，请参阅 BigQuery Go API 参考文档。

在 GitHub 上查看反馈

import (
	"context"
	"fmt"
	"io"

	"cloud.google.com/go/bigquery"
)

// getView demonstrates fetching the metadata from a BigQuery logical view and printing it to an io.Writer.
func getView(w io.Writer, projectID, datasetID, viewID string) error {
	// projectID := "my-project-id"
	// datasetID := "mydataset"
	// viewID := "myview"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}
	defer client.Close()

	view := client.Dataset(datasetID).Table(viewID)
	meta, err := view.Metadata(ctx)
	if err != nil {
		return err
	}
	fmt.Fprintf(w, "View %s, query: %s\n", view.FullyQualifiedName(), meta.ViewQuery)
	return nil
}

Java

试用此示例之前，请按照《BigQuery 快速入门：使用客户端库》中的 Java 设置说明进行操作。如需了解详情，请参阅 BigQuery Java API 参考文档。

在 GitHub 上查看反馈

import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Table;
import com.google.cloud.bigquery.TableId;

// Sample to get a view
public class GetView {

  public static void main(String[] args) {
    // TODO(developer): Replace these variables before running the sample.
    String datasetName = "MY_DATASET_NAME";
    String viewName = "MY_VIEW_NAME";
    getView(datasetName, viewName);
  }

  public static void getView(String datasetName, String viewName) {
    try {
      // Initialize client that will be used to send requests. This client only needs to be created
      // once, and can be reused for multiple requests.
      BigQuery bigquery = BigQueryOptions.getDefaultInstance().getService();

      TableId tableId = TableId.of(datasetName, viewName);
      Table view = bigquery.getTable(tableId);
      System.out.println("View retrieved successfully" + view.getDescription());
    } catch (BigQueryException e) {
      System.out.println("View not retrieved. \n" + e.toString());
    }
  }
}

Node.js

尝试此示例之前，请按照《BigQuery 快速入门：使用客户端库》中的 Node.js 设置说明进行操作。如需了解详情，请参阅 BigQuery Node.js API 参考文档。

在 GitHub 上查看反馈

// Import the Google Cloud client library
const {BigQuery} = require('@google-cloud/bigquery');
const bigquery = new BigQuery();

async function getView() {
  // Retrieves view properties.

  /**
   * TODO(developer): Uncomment the following lines before running the sample
   */
  // const datasetId = "my_dataset";
  // const tableId = "my_view";

  // Retrieve view
  const dataset = bigquery.dataset(datasetId);
  const [view] = await dataset.table(tableId).get();

  const fullTableId = view.metadata.id;
  const viewQuery = view.metadata.view.query;

  // Display view properties
  console.log(`View at ${fullTableId}`);
  console.log(`View query: ${viewQuery}`);
}
getView();

Python

尝试此示例之前，请按照《BigQuery 快速入门：使用客户端库》中的 Python 设置说明进行操作。如需了解详情，请参阅 BigQuery Python API 参考文档。

在 GitHub 上查看反馈

from google.cloud import bigquery

client = bigquery.Client()

view_id = "my-project.my_dataset.my_view"
# Make an API request to get the table resource.
view = client.get_table(view_id)

# Display view properties
print(f"Retrieved {view.table_type}: {str(view.reference)}")
print(f"View Query:\n{view.view_query}")

`INFORMATION_SCHEMA`（Beta 版）

INFORMATION_SCHEMA 是一系列视图，可让您访问数据集、例程、表、视图、作业、预留和流式数据的相关元数据。

`VIEWS` 视图

当您查询 INFORMATION_SCHEMA.VIEWS 视图时，数据集中的每个视图都会有一行对应的查询结果。

INFORMATION_SCHEMA.VIEWS 视图具有如下架构：

列名	数据类型	值
`TABLE_CATALOG`	`STRING`	包含数据集的项目的名称
`TABLE_SCHEMA`	`STRING`	包含视图的数据集的名称（也称为数据集 `id`）
`TABLE_NAME`	`STRING`	视图的名称（也称为表 `id`）
`VIEW_DEFINITION`	`STRING`	定义视图的 SQL 查询
`CHECK_OPTION`	`STRING`	返回的值始终为 `NULL`
`USE_STANDARD_SQL`	`STRING`	如果视图是使用标准 SQL 查询创建的，则为 `YES`；如果 `useLegacySql` 设置为 `true`，则为 `NO`

示例

示例 1：

以下示例从 INFORMATION_SCHEMA.VIEWS 视图中检索 check_option（该列留待将来使用）以外的所有列。系统会返回默认项目 myproject 中 mydataset 的所有视图的元数据。

如需对非默认项目运行查询，请按 `project_id`.dataset.INFORMATION_SCHEMA.view 格式将相应的项目 ID 添加到数据集，例如 `myproject`.mydataset.INFORMATION_SCHEMA.VIEWS。

SELECT
  * EXCEPT (check_option)
FROM
  mydataset.INFORMATION_SCHEMA.VIEWS;

结果类似于以下内容：

  +----------------+---------------+---------------+---------------------------------------------------------------------+------------------+
  | table_catalog  | table_schema  |  table_name   |                        view_definition                              | use_standard_sql |
  +----------------+---------------+---------------+---------------------------------------------------------------------+------------------+
  | myproject      | mydataset     | myview        | SELECT column1, column2 FROM [myproject:mydataset.mytable] LIMIT 10 | NO               |
  +----------------+---------------+---------------+---------------------------------------------------------------------+------------------+

请注意，结果显示此视图是使用旧版 SQL 查询创建的。

示例 2：

以下示例检索用于在默认项目 myproject 的 mydataset 数据集中定义 myview 视图的 SQL 查询和查询语法。

如需对非默认项目运行查询，请按 `project_id`.dataset.INFORMATION_SCHEMA.view 格式将相应的项目 ID 添加到数据集，例如 `myproject`.mydataset.INFORMATION_SCHEMA.VIEWS。

SELECT
  table_name, view_definition, use_standard_sql
FROM
  mydataset.INFORMATION_SCHEMA.VIEWS
WHERE
  table_name = 'myview';

结果类似于以下内容：

  +---------------+---------------------------------------------------------------+------------------+
  |  table_name   |                        view_definition                        | use_standard_sql |
  +---------------+---------------------------------------------------------------+------------------+
  | myview        | SELECT column1, column2, column3 FROM mydataset.mytable       | YES              |
  +---------------+---------------------------------------------------------------+------------------+

请注意，结果显示此视图是使用标准 SQL 查询创建的。

视图安全性

如需控制对 BigQuery 中视图的访问权限，请参阅控制对视图的访问权限。

后续步骤

如需了解如何创建视图，请参阅创建视图。
如需了解如何创建已获授权的视图，请参阅创建已获授权的视图。
如需了解如何列出视图，请参阅列出视图。
如需了解如何更新视图，请参阅更新视图。
如需详细了解如何管理视图，请参阅管理视图。
如需查看 INFORMATION_SCHEMA 的概览，请转到 BigQuery INFORMATION_SCHEMA 简介。

获取视图相关信息

准备工作

所需权限

获取视图信息

控制台

bq

API

Go

Java

Node.js

Python

INFORMATION_SCHEMA（Beta 版）

VIEWS 视图

示例

示例 1：

示例 2：

视图安全性

后续步骤

`INFORMATION_SCHEMA`（Beta 版）

`VIEWS` 视图