aggiungi 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à nel documento. Tutte le autorizzazioni necessarie 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 quando viene creato utilizzando il comando bq mk
dello strumento a riga di comando bq o chiamando il metodo dell'API datasets.insert
. Attualmente, non puoi aggiungere un'etichetta a un set di dati quando viene creato utilizzando
la console Google Cloud.
Questa pagina illustra come aggiungere un'etichetta a un set di dati dopo la sua creazione. Per saperne di più sull'aggiunta di un'etichetta quando crei un set di dati, consulta Creazione di un set di dati.
È possibile aggiungere un'etichetta dopo aver creato 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 - Chiamare il metodo API
datasets.patch
- Utilizzo delle librerie client
Quando aggiungi un'etichetta a un set di dati, questa non si propaga alle risorse all'interno del set di dati. Le etichette del 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 dell'archiviazione, ma non nei dati di fatturazione relativi al job.
Per maggiori dettagli sul formato di un'etichetta, consulta Requisiti per le etichette.
Ruoli IAM richiesti
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.
Questo ruolo predefinito contiene l'autorizzazione bigquery.datasets.update
, necessaria per aggiungere un'etichetta a un set di dati esistente.
Potresti anche essere in grado di ottenere questa autorizzazione con i ruoli personalizzati o altri ruoli predefiniti.
Per ulteriori informazioni su ruoli e autorizzazioni IAM in BigQuery, consulta Autorizzazioni e ruoli 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 qualsiasi etichetta esistente nel set di dati. L'esempio seguente imposta un'etichetta nel set di dati mydataset
:
Nella console Google Cloud, vai alla pagina BigQuery.
Nell'Editor query, inserisci la seguente istruzione:
ALTER SCHEMA mydataset SET OPTIONS ( labels = [('sensitivity', 'high')]);
Fai clic su
Esegui.
Per ulteriori informazioni su come eseguire le query, consulta Eseguire una query interattiva.
bq
Per aggiungere un'etichetta a un set di dati esistente, invia il comando bq update
con il flag set_label
. Ripeti il flag per aggiungere più etichette.
Se il set di dati si trova in un progetto diverso da quello predefinito, aggiungi l'ID 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 da 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 caratteri internazionali.PROJECT_ID
: il tuo ID progetto.DATASET
: il set di dati che stai etichettando.
Esempi:
Per aggiungere un'etichetta ai reparti di monitoraggio, inserisci il comando bq update
e specifica department
come chiave di etichetta. Ad esempio, per aggiungere un'etichetta
department:shipping
a mydataset
nel tuo 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
.
Go
Prima di provare questo esempio, segui le istruzioni di configurazione di Go disponibili nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Go.
Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, 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 di Java disponibili nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Java.
Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per le librerie client.
Node.js
Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js disponibili nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Node.js.
Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per le librerie client.
Python
Prima di provare questo esempio, segui le istruzioni di configurazione di Python disponibili nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Python.
Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per le librerie client.
Aggiunta di etichette a tabelle e viste
Un'etichetta può essere aggiunta a una tabella o a una vista quando viene creata da:
- Utilizzo del comando
bq mk
dello strumento a riga di comando bq - Chiamare il metodo API
tables.insert
Questa pagina illustra come aggiungere un'etichetta a una tabella o visualizzazione esistente. Per scoprire di più sull'aggiunta di un'etichetta quando crei una tabella o una visualizzazione, consulta Creazione di una tabella o Creazione di una vista.
Per aggiungere un'etichetta dopo aver creato una tabella o una visualizzazione:
- Utilizzo della console Google Cloud
- Utilizzo del comando
bq update
dello strumento a riga di comando bq - Chiamare il metodo API
tables.patch
- Utilizzo delle librerie client
Poiché le viste vengono trattate come risorse di una tabella, puoi utilizzare il metodo tables.patch
per modificare sia le viste che le tabelle.
Ruoli IAM richiesti
Per ottenere le autorizzazioni necessarie per aggiungere un'etichetta a una tabella o 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.
Questo ruolo predefinito contiene le autorizzazioni necessarie per aggiungere un'etichetta a una tabella o visualizzazione esistente. Per visualizzare le autorizzazioni esatte necessarie, espandi la sezione Autorizzazioni richieste:
Autorizzazioni obbligatorie
Per aggiungere un'etichetta a una tabella o visualizzazione esistente, sono necessarie le seguenti autorizzazioni:
-
bigquery.tables.update
-
bigquery.tables.get
Potresti anche essere in grado di ottenere queste autorizzazioni con i ruoli personalizzati o altri ruoli predefiniti.
Per ulteriori informazioni su ruoli e autorizzazioni IAM in BigQuery, consulta Autorizzazioni e ruoli predefiniti.
Aggiungere un'etichetta a una tabella o una visualizzazione
Per aggiungere un'etichetta a una tabella o visualizzazione 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 usata una sola volta per ogni set di dati, ma puoi usare 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 impostarle in una vista esistente. L'impostazione delle etichette sovrascrive qualsiasi etichetta esistente nella tabella o nella visualizzazione. L'esempio seguente imposta due etichette
nella tabella mytable
:
Nella console Google Cloud, vai alla pagina BigQuery.
Nell'Editor 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 le query, consulta Eseguire una query interattiva.
bq
Per aggiungere un'etichetta a una tabella o vista esistente, invia il comando bq update
con il flag set_label
. Per aggiungere più etichette, ripeti il flag.
Se la tabella o la visualizzazione 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 da 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 caratteri internazionali.PROJECT_ID
: il tuo ID progetto.DATASET
: il set di dati contenente la tabella o la vista che stai etichettando.TABLE_OR_VIEW
: nome della tabella o della visualizzazione che stai etichettando.
Esempi:
Per aggiungere un'etichetta di tabella che monitori i reparti, inserisci il comando bq update
e specifica department
come chiave di etichetta. Ad esempio, per aggiungere un'etichetta
department:shipping
a mytable
nel tuo progetto predefinito, inserisci:
bq update --set_label department:shipping mydataset.mytable
Per aggiungere un'etichetta di visualizzazione che monitori i reparti, inserisci il comando bq update
e specifica department
come chiave di etichetta. Ad esempio, per aggiungere un'etichetta
department:shipping
a myview
nel tuo progetto predefinito, inserisci:
bq update --set_label department:shipping mydataset.myview
Per aggiungere più etichette a una tabella o una visualizzazione, ripeti il flag set_label
e specifica una chiave univoca per ogni etichetta. Ad esempio, per aggiungere un'etichetta
department:shipping
ed un'etichetta cost_center:logistics
a mytable
nel tuo 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 vista esistente, chiama il metodo
tables.patch
e compila la proprietà labels
per la
risorsa di tabella.
Poiché le viste vengono trattate come risorse di una tabella, puoi utilizzare il metodo tables.patch
per modificare sia le viste che le tabelle.
Poiché il metodo tables.update
sostituisce l'intera risorsa del set di dati, è preferibile il metodo tables.patch
.
Go
Prima di provare questo esempio, segui le istruzioni di configurazione di Go disponibili nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Go.
Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, 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 di Java disponibili nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Java.
Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per le librerie client.
Node.js
Prima di provare questo esempio, segui le istruzioni di configurazione di Node.js disponibili nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Node.js.
Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, consulta Configurare l'autenticazione per le librerie client.
Python
Prima di provare questo esempio, segui le istruzioni di configurazione di Python disponibili nella guida rapida di BigQuery sull'utilizzo delle librerie client. Per saperne di più, consulta la documentazione di riferimento dell'API BigQuery Python.
Per eseguire l'autenticazione in BigQuery, configura Credenziali predefinite dell'applicazione. Per maggiori informazioni, 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 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 etichette o aggiornarle su job in attesa, in esecuzione o completati.
Quando aggiungi un'etichetta a un job, questa viene inclusa nei dati di fatturazione.
Ruoli IAM richiesti
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.
Questo ruolo predefinito contiene l'autorizzazione bigquery.jobs.create
, necessaria per aggiungere un'etichetta a un job.
Potresti anche essere in grado di ottenere questa autorizzazione con i ruoli personalizzati o altri ruoli predefiniti.
Per ulteriori informazioni su ruoli e autorizzazioni IAM in BigQuery, consulta Autorizzazioni e ruoli 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, invia il comando bq query
con
il flag --label
. Per aggiungere più etichette, ripeti il flag. 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 da 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 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
ed 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.
Associa 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 della sessione utilizzando query con istruzioni multiple 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 che l'etichetta deve assegnare a tutte le query future nella sessione. 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 i caratteri internazionali sono consentiti.
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 query a una sessione ed eseguito query all'interno della sessione, puoi raccogliere audit log per le query con quell'etichetta. Per ulteriori informazioni, consulta Riferimento agli audit log per BigQuery.
Aggiunta di un'etichetta senza valore
Un'etichetta con una chiave con un valore vuoto a volte viene chiamata tag. Non deve essere confusa con una risorsa tag. Per scoprire di più, consulta la sezione Etichette e tag. Puoi creare una nuova etichetta senza valore oppure rimuovere un valore da una chiave di etichetta esistente.
Le etichette senza valori possono essere utili in situazioni in cui stai etichettando una risorsa, ma non hai bisogno del formato chiave-valore. Ad esempio, se una tabella contiene dati di test utilizzati da più gruppi, come quelli di supporto o di sviluppo, puoi aggiungere un'etichetta test_data
alla tabella per identificarla.
Per aggiungere un'etichetta senza valore:
Console
Nella console Google Cloud, seleziona la risorsa appropriata (un set di dati, una tabella o una vista).
Per i set di dati, la pagina dei dettagli del set di dati viene aperta automaticamente. 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.
- Per salvare le modifiche, fai clic su Aggiorna.
SQL
Per aggiungere un'etichetta senza valore, utilizza
l'istruzione DDL ALTER TABLE SET OPTIONS
:
Nella console Google Cloud, vai alla pagina BigQuery.
Nell'Editor query, inserisci la seguente istruzione:
ALTER TABLE mydataset.mytable SET OPTIONS ( labels=[("key1", ""), ("key2", "")]);
Fai clic su
Esegui.
Per ulteriori informazioni su come eseguire le query, consulta Eseguire una query interattiva.
bq
Per aggiungere un'etichetta senza valore a una risorsa esistente, utilizza il comando bq update
con il flag set_label
. Specifica la chiave, seguita da due punti, ma non specificare il valore.
bq update --set_label KEY: RESOURCE_ID
Sostituisci quanto segue:
KEY:
: la chiave di etichetta che vuoi utilizzare.RESOURCE_ID
: nome valido di un set di dati, di una tabella o di una 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 comando seguente per creare un'etichetta test_data
per mydataset.mytable
. mydataset
è nel tuo progetto predefinito.
bq update --set_label test_data: mydataset
API
Chiama il metodo datasets.patch
o il metodo tables.patch
e aggiungi etichette con il valore impostato sulla stringa vuota (""
) nella risorsa del set di dati o nella risorsa della tabella.
Puoi rimuovere i valori dalle etichette esistenti sostituendo i valori con la stringa vuota.
Poiché le viste vengono trattate come risorse di una tabella, puoi utilizzare il metodo tables.patch
per modificare sia le viste che le tabelle. Inoltre, poiché il metodo tables.update
sostituisce l'intera risorsa del set di dati, è preferibile il metodo tables.patch
.
Passaggi successivi
- Scopri come visualizzare le etichette nelle risorse BigQuery.
- Scopri come aggiornare le etichette nelle risorse BigQuery.
- Scopri come filtrare le risorse utilizzando le etichette.
- Scopri come eliminare le etichette sulle risorse BigQuery.
- Scopri di più sull'utilizzo delle etichette nella documentazione di Resource Manager.