Como atualizar propriedades de visualização

Neste documento, descrevemos como atualizar os metadados ou as propriedades de visualização. Depois de criar uma visualização, é possível atualizar as propriedades a seguir:

• consulta SQL
• tempo de expiração
• descrição
• rótulos

Permissões necessárias

Para atualizar uma visualização, é preciso ter, no mínimo, as permissões bigquery.tables.update e bigquery.tables.get. Se você for atualizar a consulta SQL da visualização, precisará ter também permissões para consultar as tabelas referenciadas pela consulta.

Os papéis predefinidos do Cloud IAM a seguir incluem as permissões bigquery.tables.update e bigquery.tables.get:

• bigquery.dataEditor
• bigquery.dataOwner
• bigquery.admin

Além disso, quando um usuário com permissões bigquery.datasets.create cria um conjunto de dados, recebe o acesso bigquery.dataOwner a ele. Com o acesso bigquery.dataOwner, o usuário consegue atualizar tabelas e visualizações no conjunto de dados.

Para mais informações sobre os papéis e as permissões do Cloud IAM no BigQuery, consulte Papéis e permissões predefinidos.

Como atualizar a consulta SQL de uma visualização

Para atualizar a consulta SQL usada para definir uma visualização:

• Use o Console do GCP ou a IU da Web clássica do BigQuery.
• Use o comando bq update da ferramenta de linha de comando.
• Chame o método de API tables.patch.
• Use bibliotecas de cliente.

É possível alterar o dialeto SQL legado para o padrão por meio da CLI ou da API. No entanto, não é possível atualizar uma visualização de SQL legado para SQL padrão no Console do GCP ou na IU da Web clássica do BigQuery.

Para atualizar a consulta SQL de uma visualização:

Console

1. No painel Recursos, expanda o projeto e o conjunto de dados e selecione a visualização.

2. Clique na guia Detalhes.

   

3. Acima da caixa Consulta, clique no botão Editar consulta. Clique em Abrir na caixa de diálogo exibida.

   

4. Edite a consulta SQL na caixa Editor de consultas e clique em Salvar visualização.

   

5. Verifique se todos os campos estão corretos na caixa de diálogo Salvar visualização e clique em Salvar.

IU clássica

1. Selecione a visualização.

2. No painel Ver detalhes, clique em Detalhes.

3. Abaixo da caixa Consulta, clique em Editar consulta.

4. Edite a consulta SQL na caixa Consulta e clique em Salvar visualização.

   

CLI

Emita o comando bq update com a sinalização --view. Para usar o SQL padrão ou atualizar o dialeto de consulta de SQL legado para padrão, inclua a sinalização --use_legacy_sql e a defina como false.

Há recursos de função externos que são definidos pelo usuário. Se a consulta fizer referência a esses recursos e eles estiverem armazenados no Google Cloud Storage ou em arquivos locais, use a sinalização --view_udf_resource para especificá-los. A sinalização --view_udf_resource não será demonstrada neste momento. Para mais informações sobre o uso de UDFs, consulte Funções definidas pelo usuário do SQL padrão.

Se você estiver atualizando uma visualização em um projeto diferente do padrão, adicione o código do projeto ao nome do conjunto de dados no formato a seguir: project_id:dataset.

bq update \
--use_legacy_sql=false \
--view_udf_resource=path_to_file \
--view='query' \
project_id:dataset.view

Em que:

• path_to_file é o URI ou caminho do sistema de arquivos local para um arquivo de código a ser carregado e avaliado imediatamente como recurso de função definido pelo usuário usado pela visualização. Repita a sinalização para especificar vários arquivos;
• query é uma consulta SQL padrão válida;
• project_id é o código do projeto;
• dataset é um conjunto de dados que contém a visualização;
• view é o nome da visualização que você quer atualizar.

Exemplos:

Digite o comando a seguir para atualizar a consulta SQL de uma visualização chamada myview em mydataset. mydataset está no projeto padrão. A consulta de exemplo usada para atualizar a visualização consulta dados do conjunto de dados público USA Name Data.

bq update \
--use_legacy_sql=false \
--view \
'SELECT
  name,
  number
FROM
  `bigquery-public-data.usa_names.usa_1910_current`
WHERE
  gender = "M"
ORDER BY
  number DESC' \
mydataset.myview

Digite o comando a seguir para atualizar a consulta SQL de uma visualização chamada myview em mydataset. mydataset está em myotherproject, e não no projeto padrão. A consulta de exemplo usada para atualizar a visualização consulta dados do conjunto de dados público USA Name Data.

bq update \
--use_legacy_sql=false \
--view \
'SELECT
  name,
  number
FROM
  `bigquery-public-data.usa_names.usa_1910_current`
WHERE
  gender = "M"
ORDER BY
  number DESC' \
myotherproject:mydataset.myview

API

Para atualizar uma visualização, chame o método tables.patch com um recurso de tabela contendo uma propriedade view atualizada. Como tables.update substitui todo o recurso da tabela, o método tables.patch é recomendado.

Go

Antes de testar este exemplo, siga as instruções de configuração do Go no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery Go.

Ver no GitHub Feedback

// To run this sample, you will need to create (or reuse) a context and
// an instance of the bigquery client.  For example:
// import "cloud.google.com/go/bigquery"
// ctx := context.Background()
// client, err := bigquery.NewClient(ctx, "your-project-id")
view := client.Dataset(datasetID).Table(viewID)
meta, err := view.Metadata(ctx)
if err != nil {
	return err
}

newMeta := bigquery.TableMetadataToUpdate{
	// This example updates a view into the shakespeare dataset to exclude works named after kings.
	ViewQuery: "SELECT word, word_count, corpus, corpus_date FROM `bigquery-public-data.samples.shakespeare` WHERE corpus NOT LIKE '%king%'",
}

if _, err := view.Update(ctx, newMeta, meta.ETag); err != nil {
	return err
}

Python

Antes de testar esta amostra, siga as instruções de configuração do Python no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery Python.

Ver no GitHub Feedback

# from google.cloud import bigquery
# client = bigquery.Client()
# project = 'my-project'
# source_dataset_id = 'my_source_dataset'
# source_table_id = 'us_states'
# shared_dataset_ref = client.dataset('my_shared_dataset')

# This example shows how to update a shared view of a source table of
# US States. The view's query will be updated to contain only states with
# names starting with 'M'.
view_ref = shared_dataset_ref.table("my_shared_view")
view = bigquery.Table(view_ref)
sql_template = 'SELECT name, post_abbr FROM `{}.{}.{}` WHERE name LIKE "M%"'
view.view_query = sql_template.format(project, source_dataset_id, source_table_id)
view = client.update_table(view, ["view_query"])  # API request

Como atualizar o prazo de validade de uma visualização

É possível configurar o tempo de expiração padrão da tabela no nível do conjunto de dados (o que afeta tanto as tabelas quanto as visualizações) ou definir o tempo de expiração de uma visualização quando ela é criada. Caso você faça isso durante a criação da visualização, a expiração padrão da tabela do conjunto de dados será ignorada. Se você não definir uma validade padrão de tabela no nível do conjunto de dados nem a validade durante a criação da visualização, a visualização nunca expirará e será necessário excluí-la manualmente.

É possível atualizar o prazo de validade de uma visualização a qualquer momento após criá-la. Para fazer isso:

• Use a IU da Web clássica do BigQuery.
  • No momento, não é possível modificar os prazos de validade de visualizações no Console do GCP.
• Use o comando bq update da CLI.
• Chame o método de API tables.patch.
• Use bibliotecas de cliente.

Observação: se você definir um prazo de validade expirado, a visualização será excluída imediatamente.

Para atualizar o prazo de validade de uma visualização:

Console

1. No painel de navegação, selecione a visualização.

2. Na página de detalhes da visualização, clique na guia Detalhes.

3. À direita de Informações da visualização, clique no ícone de edição (lápis).

4. Na caixa de diálogo Informações da visualização, em Validade da visualização, clique em Especificar data.

5. No seletor de data, insira a data e a hora de validade e clique em Ok.

6. Clique em Atualizar. O prazo de validade atualizado é exibido na seção Informações da visualização.

DDL

Com as instruções da linguagem de definição de dados (DDL, na sigla em inglês), é possível criar e modificar tabelas e visualizações usando a sintaxe de consulta do SQL padrão.

Saiba mais sobre Como usar as instruções de Linguagem de definição de dados.

Beta

Este produto ou recurso está em um estado de pré-lançamento e pode ser alterado ou ter suporte limitado. Para mais informações, consulte Estágios de lançamento do produto.

Para usar uma instrução DDL no Console do GCP:

1. Clique em Escrever nova consulta.

2. Digite a instrução DDL na área de texto do Editor de consultas.

   ALTER VIEW mydataset.myview
   SET OPTIONS (
   -- Sets view expiration to timestamp 2025-02-03 12:34:56 in the America/Los Angeles time zone
   expiration_timestamp=TIMESTAMP("2025-02-03 12:34:56", "America/Los Angeles")
   );
   

3. Clique em Executar consulta.

IU clássica

1. No painel de navegação, selecione a visualização.

2. Na página Ver detalhes, clique em Detalhes.

3. Em Tempo de expiração, clique em Editar.

4. Na caixa de diálogo Atualizar expiração, selecione Em e insira o tempo de expiração em dias.

5. Clique em OK. O tempo de expiração atualizado é exibido na página Detalhes.

   

CLI

Emita o comando bq update com a sinalização --expiration. Se você estiver atualizando uma visualização em um projeto diferente do padrão, adicione o código do projeto ao nome do conjunto de dados no formato a seguir: project_id:dataset.

bq update \
--expiration integer \
project_id:dataset.view

Em que:

• integer é a vida útil padrão (em segundos) da tabela. O valor mínimo é de 3.600 segundos (uma hora). O prazo de validade é calculado como a hora atual mais o valor inteiro;
• project_id é o código do projeto;
• dataset é o nome do conjunto de dados que contém a visualização que você está atualizando;
• view é o nome da visualização que você está atualizando.

Exemplos:

Digite o comando a seguir para atualizar o tempo de expiração de myview em mydataset como cinco dias (43.200 segundos). mydataset está no projeto padrão.

bq update --expiration 432000 mydataset.myview

Digite o comando a seguir para atualizar o tempo de expiração de myview em mydataset como cinco dias (43.200 segundos). mydataset está em myotherproject, e não no projeto padrão.

bq update --expiration 432000 myotherproject:mydataset.myview

API

Chame o método tables.patch e use a propriedade expirationTime no recurso de tabela. Como tables.update substitui todo o recurso da tabela, o método tables.patch é recomendado. Quando você usa a API REST, a validade da visualização é expressa em milissegundos.

Go

Antes de testar este exemplo, siga as instruções de configuração do Go no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery Go.

Ver no GitHub Feedback

// To run this sample, you will need to create (or reuse) a context and
// an instance of the bigquery client.  For example:
// import "cloud.google.com/go/bigquery"
// ctx := context.Background()
// client, err := bigquery.NewClient(ctx, "your-project-id")
tableRef := client.Dataset(datasetID).Table(tableID)
meta, err := tableRef.Metadata(ctx)
if err != nil {
	return err
}
update := bigquery.TableMetadataToUpdate{
	ExpirationTime: time.Now().Add(time.Duration(5*24) * time.Hour), // table expiration in 5 days.
}
if _, err = tableRef.Update(ctx, update, meta.ETag); err != nil {
	return err
}

Python

A atualização da expiração de uma visualização é o mesmo processo de atualizar a expiração de uma tabela.

Antes de testar esta amostra, siga as instruções de configuração do Python no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery Python.

Ver no GitHub Feedback

import datetime
import pytz

# from google.cloud import bigquery
# client = bigquery.Client()
# table_ref = client.dataset('my_dataset').table('my_table')
# table = client.get_table(table_ref)  # API request

assert table.expires is None

# set table to expire 5 days from now
expiration = datetime.datetime.now(pytz.utc) + datetime.timedelta(days=5)
table.expires = expiration
table = client.update_table(table, ["expires"])  # API request

# expiration is stored in milliseconds
margin = datetime.timedelta(microseconds=1000)
assert expiration - margin <= table.expires <= expiration + margin

Como atualizar a descrição de uma visualização

É possível atualizar a descrição de uma visualização. Para fazer isso:

• Use o Console do GCP ou a IU da Web clássica do BigQuery.
• Use o comando bq update da CLI.
• Chame o método de API tables.patch.
• Use bibliotecas de cliente.

Para atualizar a descrição de uma visualização:

Console

Não é possível adicionar uma descrição ao criar uma visualização usando a IU da Web do BigQuery. Depois que a visualização for criada, será possível adicionar uma descrição na página Detalhes.

1. Na lista Recursos, selecione sua visualização.

2. Clique na guia Detalhes.

   

3. Clique no ícone de lápis ao lado de Descrição.

   

4. Insira uma descrição na caixa de diálogo. Clique em Atualizar para salvar a nova descrição.

DDL

Com as instruções da linguagem de definição de dados (DDL, na sigla em inglês), é possível criar e modificar tabelas e visualizações usando a sintaxe de consulta do SQL padrão.

Saiba mais sobre Como usar as instruções de Linguagem de definição de dados.

Beta

Este produto ou recurso está em um estado de pré-lançamento e pode ser alterado ou ter suporte limitado. Para mais informações, consulte Estágios de lançamento do produto.

Para usar uma instrução DDL no Console do GCP:

1. Clique em Escrever nova consulta.

2. Digite a instrução DDL na área de texto do Editor de consultas.

    ALTER VIEW mydataset.myview
    SET OPTIONS (
      description="Description of myview"
    );
    

3. Clique em Executar consulta.

IU clássica

1. No painel de navegação, selecione a visualização.

2. Na página Ver detalhes, clique em Detalhes.

3. Na seção Descrição, clique em Descrever esta visualização para abrir a caixa de descrição.

4. Insira uma descrição na caixa. Quando você clica fora da caixa, o texto é salvo.

   

CLI

Emita o comando bq update com a sinalização --description. Se você estiver atualizando uma visualização em um projeto diferente do padrão, adicione o código do projeto ao nome do conjunto de dados no seguinte formato: [PROJECT_ID]:[DATASET].

bq update \
--description "description" \
project_id:dataset.view

Em que:

• description é o texto que descreve a visualização entre aspas;
• project_id é o código do projeto;
• dataset é o nome do conjunto de dados que contém a visualização que você está atualizando;
• view é o nome da visualização que você está atualizando.

Exemplos:

Digite o comando a seguir para alterar a descrição de myview em mydataset para "Descrição de myview". mydataset está no projeto padrão.

bq update --description "Description of myview" mydataset.myview

Digite o comando a seguir para alterar a descrição de myview em mydataset para "Descrição de myview". mydataset está no myotherproject, e não no projeto padrão.

bq update \
--description "Description of myview" \
myotherproject:mydataset.myview

API

Chame o método tables.patch e use a propriedade description para atualizar a descrição da visualização no recurso de tabela. Como tables.update substitui todo o recurso da tabela, o método tables.patch é recomendado.

Go

Antes de testar este exemplo, siga as instruções de configuração do Go no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery Go.

Ver no GitHub Feedback

// To run this sample, you will need to create (or reuse) a context and
// an instance of the bigquery client.  For example:
// import "cloud.google.com/go/bigquery"
// ctx := context.Background()
// client, err := bigquery.NewClient(ctx, "your-project-id")
tableRef := client.Dataset(datasetID).Table(tableID)
meta, err := tableRef.Metadata(ctx)
if err != nil {
	return err
}
update := bigquery.TableMetadataToUpdate{
	Description: "Updated description.",
}
if _, err = tableRef.Update(ctx, update, meta.ETag); err != nil {
	return err
}

Java

A atualização da descrição de uma visualização é o mesmo processo de atualizar a descrição de uma tabela.

Antes de testar esta amostra, siga as instruções de configuração do Java no Início rápido do BigQuery: Como usar bibliotecas de cliente. Para saber mais informações, consulte a documentação de referência da API BigQuery Java.

Ver no GitHub Feedback

// String datasetName = "my_dataset_name";
// String tableName = "my_table_name";
// String newDescription = "new_description";

Table beforeTable = bigquery.getTable(datasetName, tableName);
TableInfo tableInfo = beforeTable.toBuilder()
    .setDescription(newDescription)
    .build();
Table afterTable = bigquery.update(tableInfo);

Python

A atualização da descrição de uma visualização é o mesmo processo de atualizar a descrição de uma tabela.

Antes de testar esta amostra, siga as instruções de configuração do Python no Guia de início rápido do BigQuery: como usar bibliotecas de cliente. Para mais informações, consulte a documentação de referência da API BigQuery Python.

Ver no GitHub Feedback

# from google.cloud import bigquery
# client = bigquery.Client()
# table_ref = client.dataset('my_dataset').table('my_table')
# table = client.get_table(table_ref)  # API request

assert table.description == "Original description."
table.description = "Updated description."

table = client.update_table(table, ["description"])  # API request

assert table.description == "Updated description."

A seguir

• Para mais informações sobre como gerenciar, copiar e excluir visualizações, consulte Como gerenciar visualizações.
• Para informações sobre a criação de visualizações, consulte Como criar visualizações.
• Para informações sobre a criação de uma visualização autorizada, consulte Como criar visualizações autorizadas.
• Para informações sobre a listagem de visualizações, consulte Como listar visualizações.
• Para mais informações sobre como receber metadados de visualizações, consulte Como receber informações sobre visualizações.