data-quality Befehlsgruppe

Hinweis

Diese Informationen gelten für Databricks CLI-Versionen 0.205 und höher. Die Databricks CLI befindet sich in der öffentlichen Vorschau.

Die Verwendung von Databricks CLI unterliegt der Datenbricks-Lizenz - und Databricks-Datenschutzerklärung, einschließlich der Bestimmungen zu Nutzungsdaten.

Die data-quality Befehlsgruppe in der Databricks CLI enthält Befehle zum Verwalten der Datenqualität von Unity Catalog-Objekten. Siehe Datenqualitätsüberwachung.

databricks data-quality cancel-refresh

Abbrechen einer Datenqualitätsüberwachungsaktualisierung. Derzeit nur für die Tabelle object_type unterstützt. Der Anruf muss im selben Arbeitsbereich erfolgen wie der Ort, an dem der Monitor erstellt wurde.

Der Aufrufer muss über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog der Tabelle.
  2. USE_CATALOG im übergeordneten Katalog der Tabelle sowie VERWALTEN und USE_SCHEMA im übergeordneten Schema der Tabelle.
  3. USE_CATALOG im übergeordneten Katalog der Tabelle, USE_SCHEMA im übergeordneten Schema der Tabelle und VERWALTEN in der Tabelle.
databricks data-quality cancel-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID [flags]

Argumente

OBJECT_TYPE

    Der Typ des überwachten Objekts. Dies kann eine der folgenden Sein: schema oder table.

OBJECT_ID

    Die UUID des Anforderungsobjekts. Sie ist schema_id für das Schema und table_id für die Tabelle vorgesehen.

    Suchen Sie die schema_id Aus beiden: (1) Die schema_id der Schemas-Ressource. (2) Wählen Sie im Katalog-Explorer → das Schema aus, → zur Registerkarte "Details" → feld "Schema-ID" wechseln.

    Suchen Sie die table_id aus einer der folgenden Elemente: (1) Die table_id der Tabellenressource. (2) Wählen Sie im Katalog-Explorer → die Tabelle aus, → zur Registerkarte "Details" → feld "Tabellen-ID" wechseln.

REFRESH_ID

    Eindeutige ID des Aktualisierungsvorgangs.

Options

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird ein Aktualisierungsvorgang abgebrochen:

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

databricks data-quality create-monitor

Erstellen Sie einen Datenqualitätsmonitor für ein Unity Catalog-Objekt. Der Aufrufer muss entweder anomaly_detection_config einen Schemamonitor oder data_profiling_config einen Tabellenmonitor bereitstellen.

Für die Tabelle object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog der Tabelle, USE_SCHEMA im übergeordneten Schema der Tabelle und SELECT in der Tabelle.
  2. USE_CATALOG im übergeordneten Katalog der Tabelle, VERWALTEN und USE_SCHEMA im übergeordneten Schema der Tabelle und SELECT in der Tabelle.
  3. USE_CATALOG im übergeordneten Katalog der Tabelle , USE_SCHEMA im übergeordneten Schema der Tabelle und VERWALTEN und SELECT in der Tabelle.

Arbeitsbereichsressourcen, z. B. das Dashboard, werden im Arbeitsbereich erstellt, in dem dieser Aufruf getätigt wurde.

Für das Schema object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog des Schemas.
  2. USE_CATALOG im übergeordneten Katalog des Schemas und VERWALTEN und USE_SCHEMA im Schema.
databricks data-quality create-monitor OBJECT_TYPE OBJECT_ID [flags]

Argumente

OBJECT_TYPE

    Der Typ des überwachten Objekts. Dies kann eine der folgenden Sein: schema oder table.

OBJECT_ID

    Die UUID des Anforderungsobjekts. Sie ist schema_id für das Schema und table_id für die Tabelle vorgesehen.

    Suchen Sie die schema_id Aus beiden: (1) Die schema_id der Schemas-Ressource. (2) Wählen Sie im Katalog-Explorer → das Schema aus, → zur Registerkarte "Details" → feld "Schema-ID" wechseln.

    Suchen Sie die table_id aus einer der folgenden Elemente: (1) Die table_id der Tabellenressource. (2) Wählen Sie im Katalog-Explorer → die Tabelle aus, → zur Registerkarte "Details" → feld "Tabellen-ID" wechseln.

Options

--json JSON

    Die Inline-JSON-Zeichenfolge oder der @path zur JSON-Datei mit dem Anforderungstext

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird ein Datenqualitätsmonitor für eine Tabelle erstellt:

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

Im folgenden Beispiel wird ein Monitor mithilfe einer JSON-Datei erstellt:

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

databricks data-quality create-refresh

Erstellen Sie eine Aktualisierung. Der Anruf muss im selben Arbeitsbereich erfolgen wie der Ort, an dem der Monitor erstellt wurde.

Der Aufrufer muss über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog der Tabelle.
  2. USE_CATALOG im übergeordneten Katalog der Tabelle sowie VERWALTEN und USE_SCHEMA im übergeordneten Schema der Tabelle.
  3. USE_CATALOG im übergeordneten Katalog der Tabelle, USE_SCHEMA im übergeordneten Schema der Tabelle und VERWALTEN in der Tabelle.
databricks data-quality create-refresh OBJECT_TYPE OBJECT_ID [flags]

Argumente

OBJECT_TYPE

    Der Typ des überwachten Objekts. Dies kann eine der folgenden Sein: schema oder table.

OBJECT_ID

    Die UUID des Anforderungsobjekts. Sie ist schema_id für das Schema und table_id für die Tabelle vorgesehen.

    Suchen Sie die schema_id Aus beiden: (1) Die schema_id der Schemas-Ressource. (2) Wählen Sie im Katalog-Explorer → das Schema aus, → zur Registerkarte "Details" → feld "Schema-ID" wechseln.

    Suchen Sie die table_id aus einer der folgenden Elemente: (1) Die table_id der Tabellenressource. (2) Wählen Sie im Katalog-Explorer → die Tabelle aus, → zur Registerkarte "Details" → feld "Tabellen-ID" wechseln.

Options

--json JSON

    Die Inline-JSON-Zeichenfolge oder der @path zur JSON-Datei mit dem Anforderungstext

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird eine Aktualisierung für einen Tabellenmonitor erstellt:

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

Im folgenden Beispiel wird eine Aktualisierung mit JSON erstellt:

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

databricks data-quality delete-monitor

Löschen eines Datenqualitätsmonitors für das Unity Catalog-Objekt.

Für die Tabelle object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog der Tabelle.
  2. USE_CATALOG im übergeordneten Katalog der Tabelle sowie VERWALTEN und USE_SCHEMA im übergeordneten Schema der Tabelle.
  3. USE_CATALOG im übergeordneten Katalog der Tabelle, USE_SCHEMA im übergeordneten Schema der Tabelle und VERWALTEN in der Tabelle.

Von Bedeutung

Die Metriktabellen und das Dashboard werden im Rahmen dieses Aufrufs nicht gelöscht. diese Ressourcen müssen manuell bereinigt werden (falls gewünscht).

Für das Schema object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog des Schemas.
  2. USE_CATALOG im übergeordneten Katalog des Schemas und VERWALTEN und USE_SCHEMA im Schema.
databricks data-quality delete-monitor OBJECT_TYPE OBJECT_ID [flags]

Argumente

OBJECT_TYPE

    Der Typ des überwachten Objekts. Dies kann eine der folgenden Sein: schema oder table.

OBJECT_ID

    Die UUID des Anforderungsobjekts. Sie ist schema_id für das Schema und table_id für die Tabelle vorgesehen.

    Suchen Sie die schema_id Aus beiden: (1) Die schema_id der Schemas-Ressource. (2) Wählen Sie im Katalog-Explorer → das Schema aus, → zur Registerkarte "Details" → feld "Schema-ID" wechseln.

    Suchen Sie die table_id aus einer der folgenden Elemente: (1) Die table_id der Tabellenressource. (2) Wählen Sie im Katalog-Explorer → die Tabelle aus, → zur Registerkarte "Details" → feld "Tabellen-ID" wechseln.

Options

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird ein Datenqualitätsmonitor gelöscht:

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

databricks data-quality get-monitor

Lesen eines Datenqualitätsmonitors für ein Unity Catalog-Objekt.

Für die Tabelle object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog der Tabelle.
  2. USE_CATALOG im übergeordneten Katalog der Tabelle sowie VERWALTEN und USE_SCHEMA im übergeordneten Schema der Tabelle.
  3. USE_CATALOG im übergeordneten Katalog der Tabelle, USE_SCHEMA im übergeordneten Schema der Tabelle und SELECT in der Tabelle.

Für das Schema object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog des Schemas.
  2. USE_CATALOG im übergeordneten Katalog des Schemas und USE_SCHEMA im Schema.

Die zurückgegebenen Informationen umfassen Konfigurationswerte für die Entität und die übergeordnete Entität sowie Informationen zu Objekten, die vom Monitor erstellt wurden. Einige Informationen (z. B. Dashboard) können herausgefiltert werden, wenn sich der Anrufer in einem anderen Arbeitsbereich befindet als der Ort, an dem der Monitor erstellt wurde.

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

Argumente

OBJECT_TYPE

    Der Typ des überwachten Objekts. Dies kann eine der folgenden Sein: schema oder table.

OBJECT_ID

    Die UUID des Anforderungsobjekts. Sie ist schema_id für das Schema und table_id für die Tabelle vorgesehen.

    Suchen Sie die schema_id Aus beiden: (1) Die schema_id der Schemas-Ressource. (2) Wählen Sie im Katalog-Explorer → das Schema aus, → zur Registerkarte "Details" → feld "Schema-ID" wechseln.

    Suchen Sie die table_id aus einer der folgenden Elemente: (1) Die table_id der Tabellenressource. (2) Wählen Sie im Katalog-Explorer → die Tabelle aus, → zur Registerkarte "Details" → feld "Tabellen-ID" wechseln.

Options

Globale Kennzeichnungen

Beispiele

Das folgende Beispiel ruft Informationen zu einem Datenqualitätsmonitor ab:

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

databricks data-quality get-refresh

Abrufen von Aktualisierungsinformationen zur Datenqualitätsüberwachung. Der Anruf muss im selben Arbeitsbereich erfolgen wie der Ort, an dem der Monitor erstellt wurde.

Für die Tabelle object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog der Tabelle.
  2. USE_CATALOG im übergeordneten Katalog der Tabelle sowie VERWALTEN und USE_SCHEMA im übergeordneten Schema der Tabelle.
  3. USE_CATALOG im übergeordneten Katalog der Tabelle, USE_SCHEMA im übergeordneten Schema der Tabelle und SELECT in der Tabelle.

Für das Schema object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog des Schemas.
  2. USE_CATALOG im übergeordneten Katalog des Schemas und USE_SCHEMA im Schema.
databricks data-quality get-refresh OBJECT_TYPE OBJECT_ID REFRESH_ID [flags]

Argumente

OBJECT_TYPE

    Der Typ des überwachten Objekts. Dies kann eine der folgenden Sein: schema oder table.

OBJECT_ID

    Die UUID des Anforderungsobjekts. Sie ist schema_id für das Schema und table_id für die Tabelle vorgesehen.

    Suchen Sie die schema_id Aus beiden: (1) Die schema_id der Schemas-Ressource. (2) Wählen Sie im Katalog-Explorer → das Schema aus, → zur Registerkarte "Details" → feld "Schema-ID" wechseln.

    Suchen Sie die table_id aus einer der folgenden Elemente: (1) Die table_id der Tabellenressource. (2) Wählen Sie im Katalog-Explorer → die Tabelle aus, → zur Registerkarte "Details" → feld "Tabellen-ID" wechseln.

REFRESH_ID

    Eindeutige ID des Aktualisierungsvorgangs.

Options

Globale Kennzeichnungen

Beispiele

Das folgende Beispiel ruft Informationen zu einer Aktualisierung ab:

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

databricks data-quality list-refresh

Aktualisierungen der Datenqualitätsüberwachung auflisten. Der Anruf muss im selben Arbeitsbereich erfolgen wie der Ort, an dem der Monitor erstellt wurde.

Für die Tabelle object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog der Tabelle.
  2. USE_CATALOG im übergeordneten Katalog der Tabelle sowie VERWALTEN und USE_SCHEMA im übergeordneten Schema der Tabelle.
  3. USE_CATALOG im übergeordneten Katalog der Tabelle, USE_SCHEMA im übergeordneten Schema der Tabelle und SELECT in der Tabelle.

Für das Schema object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog des Schemas.
  2. USE_CATALOG im übergeordneten Katalog des Schemas und USE_SCHEMA im Schema.
databricks data-quality list-refresh OBJECT_TYPE OBJECT_ID [flags]

Argumente

OBJECT_TYPE

    Der Typ des überwachten Objekts. Dies kann eine der folgenden Sein: schema oder table.

OBJECT_ID

    Die UUID des Anforderungsobjekts. Sie ist schema_id für das Schema und table_id für die Tabelle vorgesehen.

    Suchen Sie die schema_id Aus beiden: (1) Die schema_id der Schemas-Ressource. (2) Wählen Sie im Katalog-Explorer → das Schema aus, → zur Registerkarte "Details" → feld "Schema-ID" wechseln.

    Suchen Sie die table_id aus einer der folgenden Elemente: (1) Die table_id der Tabellenressource. (2) Wählen Sie im Katalog-Explorer → die Tabelle aus, → zur Registerkarte "Details" → feld "Tabellen-ID" wechseln.

Options

--page-size int

    Maximale Anzahl von Aktualisierungen, die pro Seite zurückgegeben werden sollen.

--page-token string

    Token zum Abrufen der nächsten Seite der Ergebnisse.

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel werden alle Aktualisierungen für einen Monitor aufgelistet:

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

Im folgenden Beispiel werden Aktualisierungen mit Paginierung aufgelistet:

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

databricks data-quality update-monitor

Aktualisieren sie einen Datenqualitätsmonitor für das Unity Catalog-Objekt.

Für die Tabelle object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog der Tabelle.
  2. USE_CATALOG im übergeordneten Katalog der Tabelle sowie VERWALTEN und USE_SCHEMA im übergeordneten Schema der Tabelle.
  3. USE_CATALOG im übergeordneten Katalog der Tabelle, USE_SCHEMA im übergeordneten Schema der Tabelle und VERWALTEN in der Tabelle.

Für das Schema object_type muss der Aufrufer über einen der folgenden Berechtigungssätze verfügen:

  1. VERWALTEN und USE_CATALOG im übergeordneten Katalog des Schemas.
  2. USE_CATALOG im übergeordneten Katalog des Schemas und VERWALTEN und USE_SCHEMA im Schema.
databricks data-quality update-monitor OBJECT_TYPE OBJECT_ID UPDATE_MASK OBJECT_TYPE OBJECT_ID [flags]

Argumente

OBJECT_TYPE

    Der Typ des überwachten Objekts. Dies kann eine der folgenden Sein: schema oder table.

OBJECT_ID

    Die UUID des Anforderungsobjekts. Sie ist schema_id für das Schema und table_id für die Tabelle vorgesehen.

UPDATE_MASK

    Das Feldformat, um anzugeben, welche Felder als durch Trennzeichen getrennte Liste aktualisiert werden sollen. Beispielwert: data_profiling_config.custom_metrics,data_profiling_config.schedule.quartz_cron_expression.

Options

--json JSON

    Die Inline-JSON-Zeichenfolge oder der @path zur JSON-Datei mit dem Anforderungstext

Globale Kennzeichnungen

Beispiele

Im folgenden Beispiel wird die Konfiguration eines Monitors aktualisiert:

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 * * ?"}}}'

Globale Kennzeichnungen

Globale Kennzeichnungen

--debug

  Gibt an, ob die Debugprotokollierung aktiviert werden soll.

-h oder --help

    Hilfe für die Databricks CLI oder die zugehörige Befehlsgruppe oder den zugehörigen Befehl anzeigen.

--log-file Schnur

    Eine Zeichenfolge, die die Datei darstellt, in die Ausgabeprotokolle geschrieben werden sollen. Wenn dieses Flag nicht angegeben ist, werden Ausgabeprotokolle standardmäßig in stderr geschrieben.

--log-format Format

    Der Protokollformattyp text oder json. Der Standardwert ist text.

--log-level Schnur

    Eine Zeichenfolge, die die Protokollformatebene darstellt. Wenn nicht angegeben, ist die Protokollformatebene deaktiviert.

-o, --output Typ

    Der Befehlsausgabetyp text oder json. Der Standardwert ist text.

-p, --profile Schnur

    Der Name des Profils in der ~/.databrickscfg Datei, das zum Ausführen des Befehls verwendet werden soll. Wenn dieses Flag nicht angegeben wird, wird, falls vorhanden, das Profil mit dem Namen DEFAULT verwendet.

--progress-format Format

    Das Format zum Anzeigen von Statusprotokollen: default, , append, inplaceoder json

-t, --target Schnur

    Falls zutreffend, das zu verwendende Bündelziel

  • Last updated on