Visualiza etiquetas

En esta página, se explica cómo visualizar las etiquetas de los recursos de BigQuery.

Descripción general

Puedes ver etiquetas de las siguientes maneras:

  • Con Cloud Console o la IU web clásica de BigQuery
  • Con el comando bq show de la herramienta de línea de comandos
  • Con una llamada a los métodos datasets.gettables.get de la API
  • Con las bibliotecas cliente

Debido a que las vistas se tratan como recursos de tabla, debes usar el método tables.get para obtener información de etiquetas de las vistas y las tablas.

Permisos necesarios

Los permisos necesarios para ver las etiquetas dependen del tipo de recurso al que accedas.

Permisos del conjunto de datos

Como mínimo, para obtener información sobre un conjunto de datos, debes tener permisos bigquery.datasets.get. Las siguientes funciones predefinidas de Cloud IAM incluyen los permisos bigquery.datasets.get:

  • bigquery.user
  • bigquery.metadataViewer
  • bigquery.dataViewer
  • bigquery.dataOwner
  • bigquery.dataEditor
  • bigquery.admin

Además, si un usuario tiene permisos bigquery.datasets.create, se le otorga el acceso bigquery.dataOwner cuando crea un conjunto de datos. El acceso bigquery.dataOwner brinda al usuario la capacidad de obtener información sobre un conjunto de datos.

Para obtener más información sobre las funciones de Cloud IAM y los permisos en BigQuery, consulta Funciones y permisos predefinidos.

Permisos de tabla y vista

Como mínimo, para obtener información sobre las tablas o vistas, debes tener permisos bigquery.tables.get. Todas las funciones predefinidas de Cloud IAM incluyen permisos bigquery.tables.get, excepto bigquery.user y bigquery.jobUser.

Además, si un usuario tiene permisos bigquery.datasets.create, cuando cree un conjunto de datos, se le otorgará el acceso bigquery.dataOwner a este. El acceso bigquery.dataOwner brinda al usuario la capacidad de obtener información sobre tablas y vistas en un conjunto de datos.

Para obtener más información sobre las funciones de Cloud IAM y los permisos en BigQuery, consulta Funciones y permisos predefinidos.

Permisos de trabajo

Como mínimo, para obtener datos y metadatos del trabajo, debes tener permisos bigquery.jobs.get. La siguiente función predefinida de Cloud IAM incluye permisos bigquery.jobs.get:

  • bigquery.admin

Si otorgas a una cuenta la función de bigquery.admin, el usuario podrá visualizar todos los datos de trabajos del proyecto sin importar quién haya enviado los trabajos.

A las siguientes funciones se les otorgan permisos bigquery.jobs.get para trabajos autocreados. Estos usuarios solo pueden ver los datos de los trabajos que envían:

  • bigquery.user
  • bigquery.jobUser

Para obtener más información sobre las funciones y los permisos de Cloud IAM en BigQuery, consulta Controla el acceso a los conjuntos de datos.

Visualiza etiquetas de conjunto de datos, tabla y vista

Sigue estos pasos para visualizar etiquetas de un recurso:

Console

  1. En Cloud Console, selecciona un conjunto de datos, tabla o vista. Las etiquetas de trabajo no se pueden visualizar en Cloud Console.

  2. En el caso de los conjuntos de datos, la página de detalles de conjuntos de datos se abre de forma automática. Para las tablas y vistas, haz clic en Details (Detalles) a fin de abrir la página de detalles. La información de la etiqueta aparece en la tabla de información del recurso.

    Detalles de la tabla

IU clásica

  1. En la IU web, selecciona un conjunto de datos, tabla o vista. Las etiquetas de trabajo no se pueden ver en la IU web clásica.

  2. En el caso de los conjuntos de datos, la página de detalles de conjuntos de datos se abre de forma automática. Para las tablas y vistas, haz clic en Detalles a fin de abrir la página de detalles. La información de la etiqueta aparece en la tabla de información del recurso.

CLI

Usa el comando bq show con el ID del recurso. La marca --format se puede usar para controlar el resultado. Si el recurso está en un proyecto que no es el predeterminado, debes agregar el ID del proyecto al comando con el siguiente formato: [PROJECT_ID]:[DATASET]. A fin de facilitar la lectura, puedes configurar la marca --format en pretty para controlar el resultado.

bq show --format=pretty [RESOURCE_ID]

Donde [RESOURCE_ID] es un conjunto de datos válido, tabla, vista o ID de trabajo.

Ejemplos:

Ingresa el siguiente comando a fin de mostrar etiquetas para mydataset en tu proyecto predeterminado.

bq show --format=pretty mydataset

El resultado se verá de la siguiente manera:

+-----------------+--------------------------------------------------------+---------------------+
|  Last modified  |                          ACLs                          |       Labels        |
+-----------------+--------------------------------------------------------+---------------------+
| 11 Jul 19:34:34 | Owners:                                                | department:shipping |
|                 |   projectOwners,                                       |                     |
|                 | Writers:                                               |                     |
|                 |   projectWriters                                       |                     |
|                 | Readers:                                               |                     |
|                 |   projectReaders                                       |                     |
+-----------------+--------------------------------------------------------+---------------------+

Ingresa el siguiente comando a fin de mostrar etiquetas para mydataset.mytable. mydataset está en myotherproject, no en tu proyecto predeterminado.

bq show --format=pretty myotherproject:mydataset.mytable

En el caso de una tabla agrupada en clústeres, el aspecto del resultado será el siguiente:

+-----------------+------------------------------+------------+-------------+-----------------+------------------------------------------------+------------------+---------+
|  Last modified  |            Schema            | Total Rows | Total Bytes |   Expiration    |               Time Partitioning                | Clustered Fields | Labels  |
+-----------------+------------------------------+------------+-------------+-----------------+------------------------------------------------+------------------+---------+
| 25 Jun 19:28:14 | |- timestamp: timestamp      | 0          | 0           | 25 Jul 19:28:14 | DAY (field: timestamp, expirationMs: 86400000) | customer_id      | org:dev |
|                 | |- customer_id: string       |            |             |                 |                                                |                  |         |
|                 | |- transaction_amount: float |            |             |                 |                                                |                  |         |
+-----------------+------------------------------+------------+-------------+-----------------+------------------------------------------------+------------------+---------+

API

Realiza una llamada al método datasets.get o al método tables.get. En la respuesta, se incluyen todas las etiquetas asociadas con ese recurso.

Como alternativa, puedes usar datasets.list para visualizar las etiquetas de varios conjuntos de datos o tables.list para visualizar las etiquetas de varias tablas y vistas.

Debido a que las vistas se tratan como recursos de tabla, debes usar los métodos tables.gettables.list a fin de visualizar la información de etiquetas para las vistas y las tablas.

Go

Antes de probar esta muestra, sigue las instrucciones de configuración para Go que se encuentran en la Guía de inicio rápido: Usa bibliotecas cliente. A fin de obtener más información, consulta la documentación de referencia de la API de BigQuery para Go.

import (
	"context"
	"fmt"
	"io"

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

// printDatasetLabels retrieves label metadata from a dataset and prints it to an io.Writer.
func printDatasetLabels(w io.Writer, projectID, datasetID string) error {
	// projectID := "my-project-id"
	// datasetID := "mydataset"
	ctx := context.Background()

	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}

	meta, err := client.Dataset(datasetID).Metadata(ctx)
	if err != nil {
		return err
	}
	fmt.Fprintf(w, "Dataset %s labels:\n", datasetID)
	if len(meta.Labels) == 0 {
		fmt.Fprintln(w, "Dataset has no labels defined.")
		return nil
	}
	for k, v := range meta.Labels {
		fmt.Fprintf(w, "\t%s:%s\n", k, v)
	}
	return nil
}

Python

Antes de probar esta muestra, sigue las instrucciones de configuración para Python que se encuentran en la Guía de inicio rápido: Usa bibliotecas cliente. Si deseas obtener más información, consulta la documentación de referencia de la API de BigQuery para Python.

# TODO(developer): Import the client library.
# from google.cloud import bigquery

# TODO(developer): Construct a BigQuery client object.
# client = bigquery.Client()

# TODO(developer): Set dataset_id to the ID of the dataset to fetch.
# dataset_id = "your-project.your_dataset"

dataset = client.get_dataset(dataset_id)  # Make an API request.

# View dataset labels.
print("Dataset ID: {}".format(dataset_id))
print("Labels:")
if dataset.labels:
    for label, value in dataset.labels.items():
        print("\t{}: {}".format(label, value))
else:
    print("\tDataset has no labels defined.")

Visualiza etiquetas de trabajo

Después de enviar un trabajo, las etiquetas del trabajo no aparecen en Cloud Console o en la IU web clásica de BigQuery. Para ver las etiquetas de un trabajo, ejecuta el comando bq show -j [JOB_ID] o usa la API o las bibliotecas cliente.

Console

No puedes ver las etiquetas de trabajos con Cloud Console.

IU clásica

No puedes ver las etiquetas de trabajos con la IU web clásica de BigQuery.

CLI

Para ver las etiquetas de un trabajo de consulta con la herramienta de línea de comandos de bq, ingresa el comando bq show -j con el ID de tarea del trabajo de consulta. La marca --format se puede usar para controlar el resultado. Por ejemplo, si tu trabajo de consulta tiene el ID de tarea bqjob_r1234d57f78901_000023746d4q12_1, ingresa el siguiente comando:

bq show -j --format=pretty bqjob_r1234d57f78901_000023746d4q12_1

El resultado debe tener el siguiente aspecto:

+----------+---------+-----------------+----------+-------------------+-----------------+--------------+----------------------+
| Job Type |  State  |   Start Time    | Duration |    User Email     | Bytes Processed | Bytes Billed |        Labels        |
+----------+---------+-----------------+----------+-------------------+-----------------+--------------+----------------------+
| query    | SUCCESS | 03 Dec 15:00:41 | 0:00:00  | email@example.com | 255             | 10485760     | department:shipping  |
|          |         |                 |          |                   |                 |              | costcenter:logistics |
+----------+---------+-----------------+----------+-------------------+-----------------+--------------+----------------------+

API

Realiza una llamada al método jobs.get. En la respuesta, se incluyen todas las etiquetas asociadas con ese recurso.

Pasos siguientes