Aggiunta di etichette alle risorse
Questa pagina spiega come etichettare le risorse BigQuery.
Prima di iniziare
Concedi i ruoli IAM (Identity and Access Management) che concedono agli utenti le autorizzazioni necessarie per eseguire ogni attività in questo documento. Eventuali autorizzazioni richieste per eseguire un'attività sono elencate nella sezione "Ruoli IAM richiesti" dell'attività.
Aggiunta di etichette ai set di dati
Un'etichetta può essere aggiunta a un set di dati BigQuery al momento della creazione utilizzando il comando bq mk
dello strumento a riga di comando bq o chiamando il metodo API datasets.insert
. Al momento, non puoi aggiungere un'etichetta a un set di dati quando viene creato utilizzando la console Google Cloud.
Questa pagina spiega come aggiungere un'etichetta a un set di dati dopo la sua creazione. Per maggiori informazioni sull'aggiunta di un'etichetta durante la creazione di un set di dati, consulta Creare un set di dati.
Un'etichetta può essere aggiunta dopo la creazione di un set di dati:
- Utilizzo della console Google Cloud
- Utilizzo di istruzioni DDL SQL
- Utilizzo del comando
bq update
dello strumento a riga di comando bq - Chiamata del metodo dell'API
datasets.patch
- Utilizzo delle librerie client
Quando aggiungi un'etichetta a un set di dati, questa non viene propagata alle risorse all'interno del set di dati. Le etichette dei set di dati non vengono ereditate da tabelle o viste. Inoltre, quando aggiungi un'etichetta a un set di dati, questa viene inclusa nei dati di fatturazione dello spazio di archiviazione, ma non nei dati di fatturazione relativi al job.
Per ulteriori dettagli sul formato di un'etichetta, consulta Requisiti per le etichette.
Ruoli IAM obbligatori
Per ottenere l'autorizzazione necessaria per aggiungere un'etichetta a un set di dati esistente,
chiedi all'amministratore di concederti il ruolo IAM Editor dati BigQuery (roles/bigquery.dataEditor
).
Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.
Questo ruolo predefinito contiene l'autorizzazione
bigquery.datasets.update
necessaria per
aggiungere un'etichetta a un set di dati esistente.
Potresti anche ottenere questa autorizzazione con ruoli personalizzati o altri ruoli predefiniti.
Per ulteriori informazioni sui ruoli e sulle autorizzazioni IAM in BigQuery, consulta Ruoli e autorizzazioni predefiniti.
Aggiunta di un'etichetta a un set di dati
Per aggiungere un'etichetta a un set di dati dopo la sua creazione:
Console
Nella console Google Cloud, seleziona il set di dati.
Nella pagina dei dettagli del set di dati, fai clic sull'icona a forma di matita a destra di Etichette.
Nella finestra di dialogo Modifica etichette:
- Fai clic su Aggiungi etichetta.
- Inserisci la chiave e il valore. Per applicare altre etichette, fai clic su Aggiungi etichetta. Ogni chiave può essere utilizzata una sola volta per set di dati, ma puoi utilizzare la stessa chiave in set di dati diversi nello stesso progetto.
- Per aggiornare un'etichetta, modifica le chiavi o i valori esistenti.
- Per salvare le modifiche, fai clic su Aggiorna.
SQL
Utilizza l'istruzione DDL ALTER SCHEMA SET OPTIONS
per impostare le etichette su un set di dati esistente. L'impostazione delle etichette sovrascrive eventuali etichette esistenti nel set di dati. L'esempio seguente imposta un'etichetta sul set di dati mydataset
:
Nella console Google Cloud, vai alla pagina BigQuery.
Nell'editor di query, inserisci la seguente istruzione:
ALTER SCHEMA mydataset SET OPTIONS ( labels = [('sensitivity', 'high')]);
Fai clic su
Esegui.
Per ulteriori informazioni su come eseguire query, consulta Eseguire una query interattiva.
bq
Per aggiungere un'etichetta a un set di dati esistente, esegui il comando bq update
con il flag set_label
. Ripeti l'operazione per aggiungere più etichette.
Se il set di dati si trova in un progetto diverso da quello predefinito, aggiungi l'ID progetto al set di dati nel seguente formato:
PROJECT_ID:DATASET
.
bq update --set_label KEY:VALUE PROJECT_ID:DATASET
Sostituisci quanto segue:
KEY:VALUE
: una coppia chiave-valore per un'etichetta che vuoi aggiungere. La chiave deve essere univoca. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali.PROJECT_ID
: il tuo ID progetto.DATASET
: il set di dati che stai etichettando.
Esempi:
Per aggiungere un'etichetta per monitorare i reparti, inserisci il comando bq update
e
specifica department
come chiave dell'etichetta. Ad esempio, per aggiungere un'etichetta department:shipping
a mydataset
nel progetto predefinito, inserisci:
bq update --set_label department:shipping mydataset
Per aggiungere più etichette a un set di dati, ripeti il flag set_label
e specifica
una chiave univoca per ogni etichetta.Ad esempio, per aggiungere un'etichetta department:shipping
e un'etichetta cost_center:logistics
a mydataset
nel progetto predefinito, inserisci:
bq update \
--set_label department:shipping \
--set_label cost_center:logistics \
mydataset
API
Per aggiungere un'etichetta a un set di dati esistente, chiama il metodo
datasets.patch
e compila la proprietà labels
per la
risorsa set di dati.
Poiché il metodo datasets.update
sostituisce l'intera risorsa del set di dati, è preferibile il metodo datasets.patch
.
Vai
Prima di provare questo esempio, segui le istruzioni di configurazione Go riportate nella guida rapida all'utilizzo di BigQuery con le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Go.
Per autenticarti in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.
Java
Questo esempio utilizza la libreria client HTTP di Google per Java per inviare una richiesta all'API BigQuery.
Prima di provare questo esempio, segui le istruzioni di configurazione Java riportate nella guida rapida all'utilizzo di BigQuery con le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Java.
Per autenticarti in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.
Node.js
Prima di provare questo esempio, segui le istruzioni di configurazione Node.js riportate nella guida rapida all'utilizzo di BigQuery con le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Node.js.
Per autenticarti in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.
Python
Prima di provare questo esempio, segui le istruzioni di configurazione Python riportate nella guida rapida all'utilizzo di BigQuery con le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Python.
Per autenticarti in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.
Aggiunta di etichette a tabelle e visualizzazioni
Un'etichetta può essere aggiunta a una tabella o una visualizzazione al momento della creazione:
- Utilizzo del comando
bq mk
dello strumento a riga di comando bq - Chiamata del metodo dell'API
tables.insert
Questa pagina spiega come aggiungere un'etichetta a una tabella o una vista esistente. Per ulteriori informazioni sull'aggiunta di un'etichetta quando crei una tabella o una visualizzazione, consulta Creare una tabella o Creare una visualizzazione.
Un'etichetta può essere aggiunta dopo la creazione di una tabella o una vista:
- Utilizzo della console Google Cloud
- Utilizzo del comando
bq update
dello strumento a riga di comando bq - Chiamata del metodo dell'API
tables.patch
- Utilizzo delle librerie client
Poiché le visualizzazioni vengono trattate come risorse di tabelle, utilizza il tables.patch
metodo per modificare sia le visualizzazioni sia le tabelle.
Ruoli IAM obbligatori
Per ottenere le autorizzazioni necessarie per aggiungere un'etichetta a una tabella o una visualizzazione esistente,
chiedi all'amministratore di concederti il ruolo IAM Editor dati BigQuery (roles/bigquery.dataEditor
).
Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.
Questo ruolo predefinito contiene le autorizzazioni necessarie per aggiungere un'etichetta a una tabella o una vista esistente. Per visualizzare le autorizzazioni esatte richieste, espandi la sezione Autorizzazioni richieste:
Autorizzazioni obbligatorie
Per aggiungere un'etichetta a una tabella o una vista esistente, sono necessarie le seguenti autorizzazioni:
-
bigquery.tables.update
-
bigquery.tables.get
Potresti anche ottenere queste autorizzazioni con ruoli personalizzati o altri ruoli predefiniti.
Per ulteriori informazioni sui ruoli e sulle autorizzazioni IAM in BigQuery, consulta Ruoli e autorizzazioni predefiniti.
Aggiunta di un'etichetta a una tabella o una vista
Per aggiungere un'etichetta a una tabella o una vista esistente:
Console
Nella console Google Cloud, seleziona la tabella o la visualizzazione.
Fai clic sulla scheda Dettagli.
Fai clic sull'icona a forma di matita a destra di Etichette.
Nella finestra di dialogo Modifica etichette:
- Fai clic su Aggiungi etichetta.
- Inserisci la chiave e il valore per aggiungere un'etichetta. Per applicare altre etichette, fai clic su Aggiungi etichetta. Ogni chiave può essere utilizzata una sola volta per set di dati, ma puoi utilizzare la stessa chiave in set di dati diversi nello stesso progetto.
- Modifica le chiavi o i valori esistenti per aggiornare un'etichetta.
- Fai clic su Update (Aggiorna) per salvare le modifiche.
SQL
Utilizza l'istruzione DDL ALTER TABLE SET OPTIONS
per impostare le etichette in una tabella esistente o l'istruzione DDL ALTER VIEW SET OPTIONS
per impostare le etichette in una vista esistente. L'impostazione delle etichette sovrascrive eventuali etichette esistenti nella tabella o nella visualizzazione. L'esempio seguente imposta due etichette sulla tabella mytable
:
Nella console Google Cloud, vai alla pagina BigQuery.
Nell'editor di query, inserisci la seguente istruzione:
ALTER TABLE mydataset.mytable SET OPTIONS ( labels = [('department', 'shipping'), ('cost_center', 'logistics')]);
Fai clic su
Esegui.
Per ulteriori informazioni su come eseguire query, consulta Eseguire una query interattiva.
bq
Per aggiungere un'etichetta a una tabella o una visualizzazione esistente, esegui il comando bq update
con il flag set_label
. Per aggiungere più etichette, ripeti l'indicatore.
Se la tabella o la vista si trova in un progetto diverso da quello predefinito, aggiungi
l'ID progetto al set di dati nel seguente formato:
project_id:dataset
.
bq update \ --set_label KEY:VALUE \ PROJECT_ID:DATASET.TABLE_OR_VIEW
Sostituisci quanto segue:
KEY:VALUE
: una coppia chiave-valore per un'etichetta che vuoi aggiungere. La chiave deve essere univoca. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali.PROJECT_ID
: il tuo ID progetto.DATASET
: il set di dati che contiene la tabella o la vista che stai etichettando.TABLE_OR_VIEW
: il nome della tabella o della vista che stai etichettando.
Esempi:
Per aggiungere un'etichetta della tabella che monitora i reparti, inserisci il comando bq update
e specifica department
come chiave dell'etichetta. Ad esempio, per aggiungere un'etichetta department:shipping
a mytable
nel progetto predefinito, inserisci:
bq update --set_label department:shipping mydataset.mytable
Per aggiungere un'etichetta della visualizzazione che monitora i reparti, inserisci il comando bq update
e specifica department
come chiave dell'etichetta. Ad esempio, per aggiungere un'etichetta department:shipping
a myview
nel progetto predefinito, inserisci:
bq update --set_label department:shipping mydataset.myview
Per aggiungere più etichette a una tabella o una vista, ripeti il flag set_label
e
specifica una chiave univoca per ogni etichetta. Ad esempio, per aggiungere un'etichetta department:shipping
e un'etichetta cost_center:logistics
a mytable
nel progetto predefinito, inserisci:
bq update \
--set_label department:shipping \
--set_label cost_center:logistics \
mydataset.mytable
API
Per aggiungere un'etichetta a una tabella o una visualizzazione esistente, chiama il metodo
tables.patch
e compila la proprietà labels
per la
risorsa tabella.
Poiché le visualizzazioni vengono trattate come risorse di tabelle, utilizza il tables.patch
metodo per modificare sia le visualizzazioni sia le tabelle.
Poiché il metodo tables.update
sostituisce l'intera risorsa del set di dati, è preferibile il metodo tables.patch
.
Vai
Prima di provare questo esempio, segui le istruzioni di configurazione Go riportate nella guida rapida all'utilizzo di BigQuery con le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Go.
Per autenticarti in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.
Java
Questo esempio utilizza la libreria client HTTP di Google per Java per inviare una richiesta all'API BigQuery.
Prima di provare questo esempio, segui le istruzioni di configurazione Java riportate nella guida rapida all'utilizzo di BigQuery con le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Java.
Per autenticarti in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.
Node.js
Prima di provare questo esempio, segui le istruzioni di configurazione Node.js riportate nella guida rapida all'utilizzo di BigQuery con le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Node.js.
Per autenticarti in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.
Python
Prima di provare questo esempio, segui le istruzioni di configurazione Python riportate nella guida rapida all'utilizzo di BigQuery con le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Python.
Per autenticarti in BigQuery, configura le Credenziali predefinite dell'applicazione. Per saperne di più, consulta Configurare l'autenticazione per le librerie client.
Aggiunta di etichette ai job
Le etichette possono essere aggiunte ai job di query tramite la riga di comando utilizzando il flag --label
dello strumento a riga di comando bq. Lo strumento bq supporta l'aggiunta di etichette solo ai job di query.
Puoi anche aggiungere un'etichetta a un job quando viene inviato tramite l'API specificando la proprietà labels
nella configurazione del job quando chiami il metodo jobs.insert
. L'API può essere utilizzata per aggiungere etichette a qualsiasi tipo di job.
Non puoi aggiungere o aggiornare le etichette per i job in attesa, in esecuzione o completati.
Quando aggiungi un'etichetta a un job, questa viene inclusa nei dati di fatturazione.
Ruoli IAM obbligatori
Per ottenere l'autorizzazione necessaria per aggiungere un'etichetta a un job,
chiedi all'amministratore di concederti il ruolo IAM Utente BigQuery (roles/bigquery.user
).
Per saperne di più sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.
Questo ruolo predefinito contiene l'autorizzazione
bigquery.jobs.create
necessaria per
aggiungere un'etichetta a un job.
Potresti anche ottenere questa autorizzazione con ruoli personalizzati o altri ruoli predefiniti.
Per ulteriori informazioni sui ruoli e sulle autorizzazioni IAM in BigQuery, consulta Ruoli e autorizzazioni predefiniti.
Aggiunta di un'etichetta a un job
Per aggiungere un'etichetta a un job:
bq
Per aggiungere un'etichetta a un job di query, esegui il comando bq query
con il flag --label
. Per aggiungere più etichette, ripeti l'indicatore. Il flag --nouse_legacy_sql
indica che la query è in sintassi GoogleSQL.
bq query --label KEY:VALUE --nouse_legacy_sql 'QUERY'
Sostituisci quanto segue:
KEY:VALUE
: una coppia chiave-valore per un'etichetta che vuoi aggiungere al job di query. La chiave deve essere univoca. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti i caratteri internazionali. Per aggiungere più etichette a un job di query, ripeti il flag--label
e specifica una chiave univoca per ogni etichetta.QUERY
: una query GoogleSQL valida.
Esempi:
Per aggiungere un'etichetta a un job di query, inserisci:
bq query \
--label department:shipping \
--nouse_legacy_sql \
'SELECT
column1, column2
FROM
`mydataset.mytable`'
Per aggiungere più etichette a un job di query, ripeti il flag --label
e
specifica una chiave univoca per ogni etichetta. Ad esempio, per aggiungere un'etichetta department:shipping
e un'etichetta cost_center:logistics
a un job di query, inserisci:
bq query \
--label department:shipping \
--label cost_center:logistics \
--nouse_legacy_sql \
'SELECT
column1, column2
FROM
`mydataset.mytable`'
API
Per aggiungere un'etichetta a un job, chiama il metodo
jobs.insert
e compila la proprietà labels
per la
configurazione del job.
Puoi utilizzare l'API per aggiungere etichette a qualsiasi tipo di job.
Associare i job in una sessione a un'etichetta
Se esegui query in una sessione, puoi assegnare un'etichetta a tutti i job di query futuri nella sessione utilizzando le query con più istruzioni di BigQuery.
SQL
Imposta la variabile di sistema @@query_label
nella sessione eseguendo questa query:
SET @@query_label = "KEY:VALUE";
- KEY:VALUE: una coppia chiave-valore per l'etichetta da assegnare a tutte le query future nella sessione. Puoi anche aggiungere più coppie chiave-valore, separate da una virgola (ad es.
SET @@query_label = "key1:value1,key2:value2"
). La chiave deve essere univoca. Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8 e sono consentiti caratteri internazionali.
Esempio:
SET @@query_label = "cost_center:logistics";
API
Per aggiungere un'etichetta a un job di query in una sessione quando
esegui una query utilizzando una chiamata API, chiama il
metodo jobs.insert
e compila la proprietà query_label
per la
connectionProperties
configurazione del job.
Dopo aver associato un'etichetta di query a una sessione ed eseguito query all'interno della sessione, puoi raccogliere i log di controllo per le query con quell'etichetta. Per ulteriori informazioni, consulta il riferimento per i log di controllo di BigQuery.
Aggiunta di un'etichetta senza un valore
A volte un'etichetta con una chiave con un valore vuoto viene chiamata tag. Questo non deve essere confuso con una risorsa tag. Per maggiori informazioni, consulta Etichette e tag. Puoi creare una nuova etichetta senza valore oppure rimuovere un valore da una chiave dell'etichetta esistente.
Le etichette senza valori possono essere utili in situazioni in cui etichetti una risorsa, ma non hai bisogno del formato chiave-valore. Ad esempio, se una tabella contiene dati di test utilizzati da più gruppi, come l'assistenza o lo sviluppo, puoi aggiungere un'etichetta test_data
alla tabella per identificarla.
Per aggiungere un'etichetta senza un valore:
Console
Nella console Google Cloud, seleziona la risorsa appropriata (un set di dati, una tabella o una vista).
Per i set di dati, viene aperta automaticamente la pagina dei dettagli del set di dati. Per le tabelle e le visualizzazioni, fai clic su Dettagli per aprire la pagina dei dettagli.
Nella pagina dei dettagli, fai clic sull'icona a forma di matita a destra di Etichette.
Nella finestra di dialogo Modifica etichette:
- Fai clic su Aggiungi etichetta.
- Inserisci una nuova chiave e lascia vuoto il valore. Per applicare altre etichette, fai clic su Aggiungi etichetta e ripeti l'operazione.
- Per salvare le modifiche, fai clic su Aggiorna.
SQL
Per aggiungere un'etichetta senza un valore, utilizza l'istruzione DDL ALTER TABLE SET OPTIONS
:
Nella console Google Cloud, vai alla pagina BigQuery.
Nell'editor di query, inserisci la seguente istruzione:
ALTER TABLE mydataset.mytable SET OPTIONS ( labels=[("key1", ""), ("key2", "")]);
Fai clic su
Esegui.
Per ulteriori informazioni su come eseguire query, consulta Eseguire una query interattiva.
bq
Per aggiungere un'etichetta senza un valore a una risorsa esistente, utilizza il comando bq update
con il flag set_label
. Specifica la chiave, seguita da due punti, ma lascia il valore non specificato.
bq update --set_label KEY: RESOURCE_ID
Sostituisci quanto segue:
KEY:
: la chiave dell'etichetta che vuoi utilizzare.RESOURCE_ID
: un nome valido di set di dati, tabella o vista. Se la risorsa si trova in un progetto diverso da quello predefinito, aggiungi l'ID progetto nel seguente formato:PROJECT_ID:DATASET
.
Esempi:
Inserisci il seguente comando per creare un'etichetta test_data
per
mydataset.mytable
. mydataset
si trova nel tuo progetto predefinito.
bq update --set_label test_data: mydataset
API
Chiama il metodo datasets.patch
o il metodo tables.patch
e aggiungi le etichette con il valore impostato sulla stringa vuota (""
) nella
risorsa set di dati
o nella risorsa tabella.
Puoi rimuovere i valori dalle etichette esistenti sostituendoli con la stringa vuota.
Poiché le visualizzazioni vengono trattate come risorse di tabelle, utilizza il tables.patch
metodo per modificare sia le visualizzazioni sia le tabelle. Inoltre, poiché il metodo tables.update
sostituisce l'intera risorsa set di dati, il metodo tables.patch
è preferito.
Passaggi successivi
- Scopri come visualizzare le etichette nelle risorse BigQuery.
- Scopri come aggiornare le etichette sulle risorse BigQuery.
- Scopri come filtrare le risorse utilizzando le etichette.
- Scopri come eliminare le etichette nelle risorse BigQuery.
- Scopri di più sull'utilizzo delle etichette nella documentazione di Resource Manager.