Visualizzazioni autorizzate

Questo documento descrive come creare viste autorizzate in BigQuery.

Puoi creare una vista autorizzata in BigQuery mediante:

  • Su Google Cloud Console.
  • Utilizzando il comando bq update.
  • Chiamata al metodo API tables.patch.
  • Utilizzo delle librerie client.

Panoramica

Una visualizzazione autorizzata ti consente di condividere i risultati delle query con utenti e gruppi specifici senza concedere loro l'accesso ai dati di origine sottostanti. Puoi anche utilizzare la query SQL view's per limitare le colonne (campi) su cui gli utenti possono eseguire query.

Quando crei una vista autorizzata in un altro set di dati, sia il set di dati di origine che il set di dati di visualizzazione autorizzato devono trovarsi nella stessa località a livello di area geografica.

Per un tutorial sulla creazione di una vista autorizzata, consulta Creare una vista autorizzata.

Per informazioni sull'autorizzazione di tutte le viste in un set di dati, anziché sull'autorizzazione di singole viste, consulta Autorizzati set di dati.

Prima di iniziare

Concedi ruoli IAM (Identity and Access Management) che consentono agli utenti le autorizzazioni necessarie per eseguire ogni attività in questo documento.

Autorizzazioni obbligatorie

Per creare o aggiornare una vista autorizzata, devi disporre delle autorizzazioni per il set di dati che la contiene e per il set di dati che fornisce accesso alla vista.

Autorizzazioni per il set di dati che contiene la vista

Le viste sono trattate come risorse di tabella in BigQuery, pertanto la creazione di una vista richiede le stesse autorizzazioni della creazione di una tabella. Devi disporre anche delle autorizzazioni per eseguire query su qualsiasi tabella a cui fa riferimento la query SQL di view.

Per creare una vista, devi disporre dell'autorizzazione IAM bigquery.tables.create.

Ciascuno dei seguenti ruoli IAM predefiniti include le autorizzazioni necessarie per creare una vista:

  • roles/bigquery.dataEditor
  • roles/bigquery.dataOwner
  • roles/bigquery.admin

Inoltre, se disponi dell'autorizzazione bigquery.datasets.create, puoi creare viste nei set di dati che crei. Per creare una vista per i dati di cui non sei proprietario, devi disporre dell'autorizzazione bigquery.jobs.create per la tabella.

Per ulteriori informazioni su ruoli e autorizzazioni IAM in BigQuery, consulta la sezione Ruoli e autorizzazioni predefiniti.

Autorizzazioni sul set di dati che fornisce accesso alla vista

Per aggiornare le proprietà del set di dati, devi disporre delle seguenti autorizzazioni IAM:

  • bigquery.datasets.update
  • bigquery.datasets.get

Ciascuno dei seguenti ruoli IAM predefiniti include le autorizzazioni necessarie per aggiornare le proprietà del set di dati:

  • roles/bigquery.dataOwner
  • roles/bigquery.admin

Inoltre, se disponi dell'autorizzazione bigquery.datasets.create, puoi aggiornare le proprietà dei set di dati che crei.

Per ulteriori informazioni su ruoli e autorizzazioni IAM in BigQuery, consulta la sezione Ruoli e autorizzazioni predefiniti.

Autorizzare una vista

Per concedere una visualizzazione dell'accesso a un set di dati:

console

  1. Nel riquadro Explorer, espandi il progetto e seleziona un set di dati.

  2. Espandi l'opzione Azioni e fai clic su Apri.

  3. Nel riquadro dei dettagli, fai clic su Condividi set di dati.

  4. Nel riquadro Autorizzazioni set di dati, seleziona la scheda Viste autorizzate.

  5. Nella sezione Condividi visualizzazione autorizzata:

    • In Seleziona progetto, verifica il nome del progetto. Se la vista appartiene a un altro progetto, selezionala.
    • Per Seleziona set di dati, scegli il set di dati che contiene la vista.
    • Per Seleziona vista, seleziona la vista che vuoi autorizzare.
  6. Fai clic su Aggiungi, quindi su Fine.

bq

  1. Scrivere le informazioni del set di dati esistente (inclusi i controlli di accesso) in un file JSON utilizzando il comando bq show. Se il set di dati si trova in un progetto diverso da quello predefinito, aggiungi l'ID progetto al nome del set di dati nel seguente formato: project_id:dataset.

    bq show \
    --format=prettyjson \
    project_id:dataset > path_to_file
    

    Dove:

    • project_id è l'ID progetto.
    • dataset è il nome del tuo set di dati.
    • path_to_file è il percorso del file JSON sulla tua macchina locale.

    Esempi:

    Inserisci il comando seguente per scrivere i controlli di accesso per mydataset in un file JSON. mydataset è nel tuo progetto predefinito.

    bq show --format=prettyjson mydataset > /tmp/mydataset.json
    

    Inserisci il comando seguente per scrivere i controlli di accesso per mydataset in un file JSON. mydataset si trova a myotherproject.

    bq show --format=prettyjson \
    myotherproject:mydataset > /tmp/mydataset.json
    
  2. Aggiungi la visualizzazione autorizzata alla sezione "accesso" del file JSON.

    Ad esempio, la sezione dell'accesso al file JSON di un set di dati sarebbe simile alla seguente:

    {
     "access": [
      {
       "role": "READER",
       "specialGroup": "projectReaders"
      },
      {
       "role": "WRITER",
       "specialGroup": "projectWriters"
      },
      {
       "role": "OWNER",
       "specialGroup": "projectOwners"
      }
      {
       "role": "READER",
       "specialGroup": "allAuthenticatedUsers"
      }
      {
       "role": "READER",
       "domain": "[DOMAIN_NAME]"
      }
      {
       "role": "WRITER",
       "userByEmail": "[USER_EMAIL]"
      }
      {
       "role": "READER",
       "groupByEmail": "[GROUP_EMAIL]"
      },
      {
       "view":{
       "datasetId": "[DATASET_NAME]",
       "projectId": "[PROJECT_NAME]",
       "tableId": "[VIEW_NAME]"
       }
      }
     ],
    }
    

  3. Una volta completate le modifiche, utilizza il comando bq update e includi il file JSON utilizzando il flag --source. Se il set di dati si trova in un progetto diverso da quello predefinito, aggiungi l'ID progetto al nome del set di dati nel seguente formato: project_id:dataset.

    bq update \
    --source path_to_file \
    project_id:dataset
    

    Dove:

    • path_to_file è il percorso del file JSON sulla tua macchina locale.
    • project_id è l'ID progetto.
    • dataset è il nome del tuo set di dati.

    Esempi:

    Inserisci il comando seguente per aggiornare i controlli di accesso per mydataset. mydataset è nel tuo progetto predefinito.

     bq update --source /tmp/mydataset.json mydataset
    

    Inserisci il comando seguente per aggiornare i controlli di accesso per mydataset. mydataset si trova a myotherproject.

     bq update --source /tmp/mydataset.json myotherproject:mydataset
    
  4. Per verificare le modifiche al controllo di accesso, inserisci di nuovo il comando show senza scrivere le informazioni in un file.

    bq show --format=prettyjson [DATASET]
    

    o

    bq show --format=prettyjson [PROJECT_ID]:[DATASET]
    

API

Chiama la datasets.patch e utilizza la proprietà access per aggiornare i controlli di accesso. Per ulteriori informazioni, consulta la sezione Set di dati.

Poiché il metodo datasets.update sostituisce l'intera risorsa del set di dati, datasets.patch è il metodo preferito per aggiornare i controlli di accesso.

Go

Prima di provare questo esempio, segui le istruzioni per la configurazione di Go nella guida rapida di BigQuery che utilizza le librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API BigQuery Go.

import (
	"context"
	"fmt"

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

// updateViewDelegated demonstrates the setup of an authorized view, which allows access to a view's results
// without the caller having direct access to the underlying source data.
func updateViewDelegated(projectID, srcDatasetID, viewDatasetID, viewID string) error {
	// projectID := "my-project-id"
	// srcDatasetID := "sourcedata"
	// viewDatasetID := "views"
	// viewID := "myview"
	ctx := context.Background()
	client, err := bigquery.NewClient(ctx, projectID)
	if err != nil {
		return fmt.Errorf("bigquery.NewClient: %v", err)
	}
	defer client.Close()

	srcDataset := client.Dataset(srcDatasetID)
	viewDataset := client.Dataset(viewDatasetID)
	view := viewDataset.Table(viewID)

	// First, we'll add a group to the ACL for the dataset containing the view.  This will allow users within
	// that group to query the view, but they must have direct access to any tables referenced by the view.
	vMeta, err := viewDataset.Metadata(ctx)
	if err != nil {
		return err
	}
	vUpdateMeta := bigquery.DatasetMetadataToUpdate{
		Access: append(vMeta.Access, &bigquery.AccessEntry{
			Role:       bigquery.ReaderRole,
			EntityType: bigquery.GroupEmailEntity,
			Entity:     "example-analyst-group@google.com",
		}),
	}
	if _, err := viewDataset.Update(ctx, vUpdateMeta, vMeta.ETag); err != nil {
		return err
	}

	// Now, we'll authorize a specific view against a source dataset, delegating access enforcement.
	// Once this has been completed, members of the group previously added to the view dataset's ACL
	// no longer require access to the source dataset to successfully query the view.
	srcMeta, err := srcDataset.Metadata(ctx)
	if err != nil {
		return err
	}
	srcUpdateMeta := bigquery.DatasetMetadataToUpdate{
		Access: append(srcMeta.Access, &bigquery.AccessEntry{
			EntityType: bigquery.ViewEntity,
			View:       view,
		}),
	}
	if _, err := srcDataset.Update(ctx, srcUpdateMeta, srcMeta.ETag); err != nil {
		return err
	}
	return nil
}

Java

Prima di provare questo esempio, segui le istruzioni di configurazione di Java nella Guida di BigQuery per l'utilizzo delle librerie client. Per ulteriori informazioni, consulta la documentazione di riferimento dell'API Java di BigQuery.

import com.google.cloud.bigquery.Acl;
import com.google.cloud.bigquery.BigQuery;
import com.google.cloud.bigquery.BigQueryException;
import com.google.cloud.bigquery.BigQueryOptions;
import com.google.cloud.bigquery.Dataset;
import com.google.cloud.bigquery.DatasetId;
import com.google.cloud.bigquery.Table;
import java.util.ArrayList;
import java.util.List;

// Sample to grant view access on dataset
public class GrantViewAccess {

  public static void runGrantViewAccess() {
    // TODO(developer): Replace these variables before running the sample.
    String srcDatasetId = "MY_DATASET_ID";
    String viewDatasetId = "MY_VIEW_DATASET_ID";
    String viewId = "MY_VIEW_ID";
    grantViewAccess(srcDatasetId, viewDatasetId, viewId);
  }

  public static void grantViewAccess(String srcDatasetId, String viewDatasetId, String viewId) {
    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();

      Dataset srcDataset = bigquery.getDataset(DatasetId.of(srcDatasetId));
      Dataset viewDataset = bigquery.getDataset(DatasetId.of(viewDatasetId));
      Table view = viewDataset.get(viewId);

      // First, we'll add a group to the ACL for the dataset containing the view. This will allow
      // users within that group to query the view, but they must have direct access to any tables
      // referenced by the view.
      List<Acl> viewAcl = new ArrayList<>();
      viewAcl.addAll(viewDataset.getAcl());
      viewAcl.add(Acl.of(new Acl.Group("example-analyst-group@google.com"), Acl.Role.READER));
      viewDataset.toBuilder().setAcl(viewAcl).build().update();

      // Now, we'll authorize a specific view against a source dataset, delegating access
      // enforcement. Once this has been completed, members of the group previously added to the
      // view dataset's ACL no longer require access to the source dataset to successfully query the
      // view
      List<Acl> srcAcl = new ArrayList<>();
      srcAcl.addAll(srcDataset.getAcl());
      srcAcl.add(Acl.of(new Acl.View(view.getTableId())));
      srcDataset.toBuilder().setAcl(srcAcl).build().update();
      System.out.println("Grant view access successfully");
    } catch (BigQueryException e) {
      System.out.println("Grant view access was not success. \n" + e.toString());
    }
  }
}

Python

Prima di provare questo esempio, segui le istruzioni di configurazione di Python nella guida rapida di BigQuery che utilizza le librerie client. Per maggiori informazioni, consulta la documentazione di riferimento dell'API Python BigQuery.

from google.cloud import bigquery

client = bigquery.Client()

# To use a view, the analyst requires ACLs to both the view and the source
# table. Create an authorized view to allow an analyst to use a view
# without direct access permissions to the source table.
view_dataset_id = "my-project.my_view_dataset"
# Make an API request to get the view dataset ACLs.
view_dataset = client.get_dataset(view_dataset_id)

analyst_group_email = "data_analysts@example.com"
access_entries = view_dataset.access_entries
access_entries.append(
    bigquery.AccessEntry("READER", "groupByEmail", analyst_group_email)
)
view_dataset.access_entries = access_entries

# Make an API request to update the ACLs property of the view dataset.
view_dataset = client.update_dataset(view_dataset, ["access_entries"])
print(f"Access to view: {view_dataset.access_entries}")

# Group members of "data_analysts@example.com" now have access to the view,
# but they require access to the source table to use it. To remove this
# restriction, authorize the view to access the source dataset.
source_dataset_id = "my-project.my_source_dataset"
# Make an API request to set the source dataset ACLs.
source_dataset = client.get_dataset(source_dataset_id)

view_reference = {
    "projectId": "my-project",
    "datasetId": "my_view_dataset",
    "tableId": "my_authorized_view",
}
access_entries = source_dataset.access_entries
access_entries.append(bigquery.AccessEntry(None, "view", view_reference))
source_dataset.access_entries = access_entries

# Make an API request to update the ACLs property of the source dataset.
source_dataset = client.update_dataset(source_dataset, ["access_entries"])
print(f"Access to source: {source_dataset.access_entries}")

Applicare l'accesso a livello di riga con una vista

Le viste possono essere utilizzate per limitare l'accesso a determinate colonne (campi). Se vuoi limitare l'accesso a singole righe della tabella, non devi creare viste distinte per ogni utente o gruppo. Puoi invece utilizzare la funzione SESSION_USER() per restituire l'indirizzo email dell'utente corrente.

Per mostrare righe diverse a utenti differenti, aggiungi un altro campo alla tabella che contenga l'utente autorizzato a visualizzare la riga. A questo punto, crea una vista che utilizzi la funzione SESSION_USER(). Nel seguente esempio, i nomi utente vengono memorizzati nel campo allowed_viewer:

SELECT
  COLUMN_1,
  COLUMN_2
FROM
  `dataset.view`
WHERE
  allowed_viewer = SESSION_USER()

La limitazione di questo approccio consiste nel fatto che puoi concedere l'accesso a un solo utente alla volta. Puoi aggirare questo limite rendendo allowed_viewerun campo ripetuto. Questo approccio ti consente di fornire un elenco di utenti per ogni riga. Tuttavia, anche se utilizzi un campo ripetuto, per archiviare i nomi utente nella tabella devi comunque monitorare manualmente i singoli utenti che hanno accesso a ogni riga.

Compila invece il campo allowed_viewer con i nomi dei gruppi e crea una tabella separata che mappa i gruppi agli utenti. La tabella che mappa i gruppi agli utenti avrebbe uno schema che memorizza i nomi e i nomi utente dei gruppi. Ad esempio: {group:string, user_name:string}. Questo approccio ti consente di gestire le informazioni sugli utenti e sui gruppi separatamente dalla tabella che contiene i dati.

Se la tabella di mappatura è denominata private.access_control, la query SQL utilizzata per creare la vista autorizzata sarebbe:

SELECT
  c.customer,
  c.id
FROM
  `private.customers` c
INNER JOIN (
  SELECT
    group
  FROM
    `private.access_control`
  WHERE
    SESSION_USER() = user_name) g
ON
  c.allowed_group = g.group

Passaggi successivi