data-quality gruppo di comandi

Annotazioni

Queste informazioni si applicano all'interfaccia della riga di comando di Databricks versione 0.205 e successive. L'interfaccia della riga di comando di Databricks è disponibile in anteprima pubblica.

L'uso della CLI di Databricks è soggetto alla Licenza di Databricks e all'Informativa sulla privacy di Databricks, incluse eventuali disposizioni sui dati di utilizzo.

Il data-quality gruppo di comandi all'interno dell'interfaccia della riga di comando di Databricks contiene comandi per gestire la qualità dei dati degli oggetti del catalogo Unity. Vedere Monitoraggio della qualità dei dati.

databricks data-quality cancel-refresh

Annullare un aggiornamento di Monitoraggio qualità dei dati. Attualmente supportato solo per la tabella object_type. La chiamata deve essere effettuata nella stessa area di lavoro in cui è stato creato il monitoraggio.

Il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre della tabella.
  2. USE_CATALOG nel catalogo padre della tabella e GESTISCI e USE_SCHEMA nello schema padre della tabella.
  3. USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA sullo schema padre della tabella e su MANAGE nella tabella.
databricks data-quality cancel-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID [flags]

Arguments

OBJECT_TYPE

    Tipo dell'oggetto monitorato. Può essere uno dei seguenti: schema o table.

OBJECT_ID

    UUID dell'oggetto richiesta. È schema_id per lo schema e table_id per la tabella.

    Trovare da schema_id : (1) Il schema_id della risorsa Schemi. (2) In Esplora cataloghi → selezionare lo schema → passare alla scheda Dettagli → campo ID schema.

    Trovare da table_id : (1) Il table_id della risorsa Tabelle. (2) In Esplora cataloghi → selezionare la tabella → passare alla scheda Dettagli → campo ID tabella.

REFRESH_ID

    ID univoco dell'operazione di aggiornamento.

Options

Flag globali

Esempi

Nell'esempio seguente viene annullata un'operazione di aggiornamento:

databricks data-quality cancel-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 refresh-12345

databricks data-quality create-monitor

Creare un monitoraggio della qualità dei dati in un oggetto Catalogo Unity. Il chiamante deve fornire anomaly_detection_config sia per un monitoraggio dello schema che data_profiling_config per un monitoraggio tabelle.

Per la tabella object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA nello schema padre della tabella e SELECT nella tabella.
  2. USE_CATALOG nel catalogo padre della tabella, gestisci e USE_SCHEMA sullo schema padre della tabella e SELECT sulla tabella.
  3. USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA sullo schema padre della tabella e su MANAGE e SELECT sulla tabella.

Gli asset dell'area di lavoro, ad esempio il dashboard, verranno creati nell'area di lavoro in cui è stata effettuata questa chiamata.

Per lo schema object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre dello schema.
  2. USE_CATALOG nel catalogo padre dello schema e GESTISCI e USE_SCHEMA nello schema.
databricks data-quality create-monitor OBJECT_TYPE OBJECT_ID [flags]

Arguments

OBJECT_TYPE

    Tipo dell'oggetto monitorato. Può essere uno dei seguenti: schema o table.

OBJECT_ID

    UUID dell'oggetto richiesta. È schema_id per lo schema e table_id per la tabella.

    Trovare da schema_id : (1) Il schema_id della risorsa Schemi. (2) In Esplora cataloghi → selezionare lo schema → passare alla scheda Dettagli → campo ID schema.

    Trovare da table_id : (1) Il table_id della risorsa Tabelle. (2) In Esplora cataloghi → selezionare la tabella → passare alla scheda Dettagli → campo ID tabella.

Options

--json JSON

    La stringa JSON inline o @path nel file JSON con il corpo della richiesta

Flag globali

Esempi

Nell'esempio seguente viene creato un monitoraggio qualità dei dati per una tabella:

databricks data-quality create-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json '{"data_profiling_config": {"enabled": true}}'

L'esempio seguente crea un monitoraggio usando un file JSON:

databricks data-quality create-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json @monitor-config.json

databricks data-quality create-refresh

Creare un aggiornamento. La chiamata deve essere effettuata nella stessa area di lavoro in cui è stato creato il monitoraggio.

Il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre della tabella.
  2. USE_CATALOG nel catalogo padre della tabella e GESTISCI e USE_SCHEMA nello schema padre della tabella.
  3. USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA sullo schema padre della tabella e su MANAGE nella tabella.
databricks data-quality create-refresh OBJECT_TYPE OBJECT_ID [flags]

Arguments

OBJECT_TYPE

    Tipo dell'oggetto monitorato. Può essere uno dei seguenti: schema o table.

OBJECT_ID

    UUID dell'oggetto richiesta. È schema_id per lo schema e table_id per la tabella.

    Trovare da schema_id : (1) Il schema_id della risorsa Schemi. (2) In Esplora cataloghi → selezionare lo schema → passare alla scheda Dettagli → campo ID schema.

    Trovare da table_id : (1) Il table_id della risorsa Tabelle. (2) In Esplora cataloghi → selezionare la tabella → passare alla scheda Dettagli → campo ID tabella.

Options

--json JSON

    La stringa JSON inline o @path nel file JSON con il corpo della richiesta

Flag globali

Esempi

Nell'esempio seguente viene creato un aggiornamento per un monitoraggio tabelle:

databricks data-quality create-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890

L'esempio seguente crea un aggiornamento usando JSON:

databricks data-quality create-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json '{}'

databricks data-quality delete-monitor

Eliminare un monitoraggio qualità dei dati nell'oggetto Catalogo unity.

Per la tabella object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre della tabella.
  2. USE_CATALOG nel catalogo padre della tabella e GESTISCI e USE_SCHEMA nello schema padre della tabella.
  3. USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA sullo schema padre della tabella e su MANAGE nella tabella.

Importante

Le tabelle delle metriche e il dashboard non verranno eliminati come parte di questa chiamata; tali asset devono essere puliti manualmente (se necessario).

Per lo schema object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre dello schema.
  2. USE_CATALOG nel catalogo padre dello schema e GESTISCI e USE_SCHEMA nello schema.
databricks data-quality delete-monitor OBJECT_TYPE OBJECT_ID [flags]

Arguments

OBJECT_TYPE

    Tipo dell'oggetto monitorato. Può essere uno dei seguenti: schema o table.

OBJECT_ID

    UUID dell'oggetto richiesta. È schema_id per lo schema e table_id per la tabella.

    Trovare da schema_id : (1) Il schema_id della risorsa Schemi. (2) In Esplora cataloghi → selezionare lo schema → passare alla scheda Dettagli → campo ID schema.

    Trovare da table_id : (1) Il table_id della risorsa Tabelle. (2) In Esplora cataloghi → selezionare la tabella → passare alla scheda Dettagli → campo ID tabella.

Options

Flag globali

Esempi

Nell'esempio seguente viene eliminato un monitoraggio qualità dei dati:

databricks data-quality delete-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890

databricks data-quality get-monitor

Leggere un monitoraggio della qualità dei dati in un oggetto Catalogo Unity.

Per la tabella object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre della tabella.
  2. USE_CATALOG nel catalogo padre della tabella e GESTISCI e USE_SCHEMA nello schema padre della tabella.
  3. USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA sullo schema padre della tabella e SELECT sulla tabella.

Per lo schema object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre dello schema.
  2. USE_CATALOG nel catalogo padre dello schema e USE_SCHEMA sullo schema.

Le informazioni restituite includono valori di configurazione per l'entità e l'entità padre, nonché informazioni sugli asset creati dal monitoraggio. Alcune informazioni ,ad esempio il dashboard, possono essere filtrate se il chiamante si trova in un'area di lavoro diversa da quella in cui è stato creato il monitoraggio.

databricks data-quality get-monitor OBJECT_TYPE OBJECT_ID [flags]

Arguments

OBJECT_TYPE

    Tipo dell'oggetto monitorato. Può essere uno dei seguenti: schema o table.

OBJECT_ID

    UUID dell'oggetto richiesta. È schema_id per lo schema e table_id per la tabella.

    Trovare da schema_id : (1) Il schema_id della risorsa Schemi. (2) In Esplora cataloghi → selezionare lo schema → passare alla scheda Dettagli → campo ID schema.

    Trovare da table_id : (1) Il table_id della risorsa Tabelle. (2) In Esplora cataloghi → selezionare la tabella → passare alla scheda Dettagli → campo ID tabella.

Options

Flag globali

Esempi

Nell'esempio seguente vengono recuperate informazioni su un monitoraggio qualità dei dati:

databricks data-quality get-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890

databricks data-quality get-refresh

Ottenere informazioni sull'aggiornamento del monitoraggio della qualità dei dati. La chiamata deve essere effettuata nella stessa area di lavoro in cui è stato creato il monitoraggio.

Per la tabella object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre della tabella.
  2. USE_CATALOG nel catalogo padre della tabella e GESTISCI e USE_SCHEMA nello schema padre della tabella.
  3. USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA sullo schema padre della tabella e SELECT sulla tabella.

Per lo schema object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre dello schema.
  2. USE_CATALOG nel catalogo padre dello schema e USE_SCHEMA sullo schema.
databricks data-quality get-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID [flags]

Arguments

OBJECT_TYPE

    Tipo dell'oggetto monitorato. Può essere uno dei seguenti: schema o table.

OBJECT_ID

    UUID dell'oggetto richiesta. È schema_id per lo schema e table_id per la tabella.

    Trovare da schema_id : (1) Il schema_id della risorsa Schemi. (2) In Esplora cataloghi → selezionare lo schema → passare alla scheda Dettagli → campo ID schema.

    Trovare da table_id : (1) Il table_id della risorsa Tabelle. (2) In Esplora cataloghi → selezionare la tabella → passare alla scheda Dettagli → campo ID tabella.

REFRESH_ID

    ID univoco dell'operazione di aggiornamento.

Options

Flag globali

Esempi

Nell'esempio seguente vengono recuperate informazioni su un aggiornamento:

databricks data-quality get-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 refresh-12345

databricks data-quality list-refresh

Elencare gli aggiornamenti di Monitoraggio qualità dei dati. La chiamata deve essere effettuata nella stessa area di lavoro in cui è stato creato il monitoraggio.

Per la tabella object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre della tabella.
  2. USE_CATALOG nel catalogo padre della tabella e GESTISCI e USE_SCHEMA nello schema padre della tabella.
  3. USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA sullo schema padre della tabella e SELECT sulla tabella.

Per lo schema object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre dello schema.
  2. USE_CATALOG nel catalogo padre dello schema e USE_SCHEMA sullo schema.
databricks data-quality list-refresh OBJECT_TYPE OBJECT_ID [flags]

Arguments

OBJECT_TYPE

    Tipo dell'oggetto monitorato. Può essere uno dei seguenti: schema o table.

OBJECT_ID

    UUID dell'oggetto richiesta. È schema_id per lo schema e table_id per la tabella.

    Trovare da schema_id : (1) Il schema_id della risorsa Schemi. (2) In Esplora cataloghi → selezionare lo schema → passare alla scheda Dettagli → campo ID schema.

    Trovare da table_id : (1) Il table_id della risorsa Tabelle. (2) In Esplora cataloghi → selezionare la tabella → passare alla scheda Dettagli → campo ID tabella.

Options

--page-size int

    Numero massimo di aggiornamenti da restituire per pagina.

--page-token string

    Token per recuperare la pagina successiva dei risultati.

Flag globali

Esempi

Nell'esempio seguente vengono elencati tutti gli aggiornamenti per un monitoraggio:

databricks data-quality list-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890

L'esempio seguente elenca gli aggiornamenti con la paginazione:

databricks data-quality list-refresh table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --page-size 10

databricks data-quality update-monitor

Aggiornare un monitoraggio data quality nell'oggetto Catalogo unity.

Per la tabella object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre della tabella.
  2. USE_CATALOG nel catalogo padre della tabella e GESTISCI e USE_SCHEMA nello schema padre della tabella.
  3. USE_CATALOG nel catalogo padre della tabella, USE_SCHEMA sullo schema padre della tabella e su MANAGE nella tabella.

Per lo schema object_type, il chiamante deve disporre di uno dei set di autorizzazioni seguenti:

  1. GESTIRE e USE_CATALOG nel catalogo padre dello schema.
  2. USE_CATALOG nel catalogo padre dello schema e GESTISCI e USE_SCHEMA nello schema.
databricks data-quality update-monitor OBJECT_TYPE OBJECT_ID UPDATE_MASK OBJECT_TYPE OBJECT_ID [flags]

Arguments

OBJECT_TYPE

    Tipo dell'oggetto monitorato. Può essere uno dei seguenti: schema o table.

OBJECT_ID

    UUID dell'oggetto richiesta. È schema_id per lo schema e table_id per la tabella.

UPDATE_MASK

    Maschera di campo per specificare i campi da aggiornare come elenco delimitato da virgole. Valore di esempio: data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression.

Options

--json JSON

    La stringa JSON inline o @path nel file JSON con il corpo della richiesta

Flag globali

Esempi

L'esempio seguente aggiorna la configurazione di un monitoraggio:

databricks data-quality update-monitor table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 "data_profiling_config.schedule.quartz_cron_expression" table a1b2c3d4-e5f6-7890-a1b2-c3d4e5f67890 --json '{"data_profiling_config": {"schedule": {"quartz_cron_expression": "0 0 12 * * ?"}}}'

Flag globali

Bandiere globali

--debug

  Indica se abilitare la registrazione di debug.

-h oppure --help

    Mostra la guida per il Databricks CLI, il gruppo di comandi correlato o il comando correlato.

--log-file stringa

    Stringa che rappresenta il file in cui scrivere i log di output. Se questo flag non viene specificato, l'impostazione predefinita prevede la scrittura dei log di output su stderr.

--log-format formato

    Tipo di formato del log, text o json. Il valore predefinito è text.

--log-level stringa

    Stringa che rappresenta il livello di formato del log. Se non specificato, il livello di formato del log è disabilitato.

tipo

    Tipo di output del comando, text o json. Il valore predefinito è text.

-p, --profile stringa

    Nome del profilo nel ~/.databrickscfg file da usare per eseguire il comando . Se questo flag non viene specificato, se esiste, viene usato il profilo denominato DEFAULT .

--progress-format formato

    Formato per visualizzare i log di stato: default, append, inplaceo json

-t, --target stringa

    Se applicabile, la destinazione del bundle da utilizzare