Udostępnij przez


quality-monitors grupa poleceń

Note

Te informacje dotyczą interfejsu wiersza polecenia usługi Databricks w wersji 0.205 lub nowszej. Interfejs CLI Databricks jest w publicznej wersji testowej.

Korzystanie z interfejsu wiersza polecenia usługi Databricks podlega licencjom usługi Databricks i powiadomieniom o ochronie prywatności usługi Databricks, w tym wszelkim przepisom dotyczącym danych użycia.

Grupa quality-monitors poleceń w interfejsie wiersza polecenia usługi Databricks zawiera polecenia służące do tworzenia, edytowania i usuwania monitorów jakości. Monitor oblicza i monitoruje metryki jakości danych lub modelu dla tabeli w czasie. Generuje tabele metryk i pulpit nawigacyjny, za pomocą którego można monitorować kondycję tabeli i ustawiać alerty. Zobacz Profilowanie danych.

tworzenie monitorów jakości usługi databricks

Utwórz nowy monitor dla określonej tabeli.

Obiekt wywołujący musi:

  1. być właścicielem wykazu nadrzędnego tabeli, mieć USE_SCHEMA w schemacie nadrzędnym tabeli i mieć SELECT dostęp do tabeli
  2. musi znajdować USE_CATALOG się w wykazie nadrzędnym tabeli, być właścicielem schematu nadrzędnego tabeli i mieć SELECT dostęp do tabeli.
  3. mają następujące uprawnienia:
    • USE_CATALOG w katalogu nadrzędnym tabeli
    • USE_SCHEMA w schemacie nadrzędnym tabeli
    • być właścicielem tabeli.

Zasoby obszaru roboczego, takie jak pulpit nawigacyjny, zostaną utworzone w obszarze roboczym, w którym zostało wykonane to wywołanie.

databricks quality-monitors create TABLE_NAME ASSETS_DIR OUTPUT_SCHEMA_NAME [flags]

Arguments

TABLE_NAME

    Pełna nazwa tabeli.

ASSETS_DIR

    Katalog do przechowywania zasobów monitorowania (np. pulpit nawigacyjny, tabele metryk).

OUTPUT_SCHEMA_NAME

    Schemat, w którym są tworzone tabele metryk wyjściowych.

Opcje

--baseline-table-name string

    Nazwa tabeli bazowej, z której są obliczane metryki dryfu.

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania.

--skip-builtin-dashboard

    Czy pominąć tworzenie domyślnego pulpitu nawigacyjnego podsumowującego metryki jakości danych.

--warehouse-id string

    Opcjonalny argument określający magazyn na potrzeby tworzenia pulpitu nawigacyjnego.

Flagi globalne

Examples

Poniższy przykład tworzy monitor jakości dla tabeli:

databricks quality-monitors create main.my_schema.my_table /monitoring/assets main.monitoring_schema

usuwanie monitorów jakości w Databricks

Usuń monitor dla określonej tabeli.

Obiekt wywołujący musi:

  1. być właścicielem wykazu nadrzędnego tabeli
  2. musi mieć USE_CATALOG w katalogu nadrzędnym tabeli i być właścicielem nadrzędnego schematu tabeli
  3. mają następujące uprawnienia:
    • USE_CATALOG w katalogu nadrzędnym tabeli
    • USE_SCHEMA w schemacie nadrzędnym tabeli
    • być właścicielem tabeli.

Ponadto połączenie należy wykonać z obszaru roboczego, w którym utworzono monitor.

Należy pamiętać, że tabele metryk i pulpit nawigacyjny nie zostaną usunięte w ramach tego wywołania; te zasoby muszą zostać ręcznie wyczyszczone (w razie potrzeby).

databricks quality-monitors delete TABLE_NAME [flags]

Arguments

TABLE_NAME

    Pełna nazwa tabeli.

Opcje

Flagi globalne

Examples

Poniższy przykład usuwa monitor jakości:

databricks quality-monitors delete main.my_schema.my_table

pobieranie monitorów jakości usługi databricks

Pobierz monitor dla określonej tabeli.

Obiekt wywołujący musi:

  1. być właścicielem wykazu nadrzędnego tabeli
  2. Musisz mieć USE_CATALOG w katalogu nadrzędnym tabeli i być właścicielem schematu nadrzędnego tabeli.
  3. mają następujące uprawnienia:
    • USE_CATALOG w katalogu nadrzędnym tabeli
    • USE_SCHEMA w schemacie nadrzędnym tabeli
    • SELECT uprawnienia na stole.

Zwrócone informacje obejmują wartości konfiguracji, a także informacje o zasobach utworzonych przez monitor. Niektóre informacje (np. pulpit nawigacyjny) mogą być odfiltrowane, jeśli obiekt wywołujący znajduje się w innym obszarze roboczym niż miejsce utworzenia monitora.

databricks quality-monitors get TABLE_NAME [flags]

Arguments

TABLE_NAME

    Pełna nazwa tabeli.

Opcje

Flagi globalne

Examples

Poniższy przykład pobiera informacje o monitorze jakości:

databricks quality-monitors get main.my_schema.my_table

Databricks monitory jakości odświeżanie

Uzyskaj informacje o określonym odświeżeniu monitora przy użyciu podanego identyfikatora odświeżania.

Obiekt wywołujący musi:

  1. być właścicielem wykazu nadrzędnego tabeli
  2. musi mieć USE_CATALOG w katalogu nadrzędnym tabeli i być właścicielem nadrzędnego schematu tabeli
  3. mają następujące uprawnienia:
    • USE_CATALOG w katalogu nadrzędnym tabeli
    • USE_SCHEMA w schemacie nadrzędnym tabeli
    • SELECT uprawnienia na stole.

Ponadto połączenie należy wykonać z obszaru roboczego, w którym utworzono monitor.

databricks quality-monitors get-refresh TABLE_NAME REFRESH_ID [flags]

Arguments

TABLE_NAME

    Pełna nazwa tabeli.

REFRESH_ID

    Identyfikator odświeżania.

Opcje

Flagi globalne

Examples

Poniższy przykład uzyskuje informacje na temat określonej aktualizacji.

databricks quality-monitors get-refresh main.my_schema.my_table 12345

Databricks jakość-monitorów lista-odświeżeń

Wyświetl listę historii najnowszych odświeżeń (do 25) dla tej tabeli.

Obiekt wywołujący musi:

  1. być właścicielem wykazu nadrzędnego tabeli
  2. musi mieć USE_CATALOG w katalogu nadrzędnym tabeli i być właścicielem nadrzędnego schematu tabeli
  3. mają następujące uprawnienia:
    • USE_CATALOG w katalogu nadrzędnym tabeli
    • USE_SCHEMA w schemacie nadrzędnym tabeli
    • SELECT uprawnienia na stole.

Ponadto połączenie należy wykonać z obszaru roboczego, w którym utworzono monitor.

databricks quality-monitors list-refreshes TABLE_NAME [flags]

Arguments

TABLE_NAME

    Pełna nazwa tabeli.

Opcje

Flagi globalne

Examples

Poniższy przykład zawiera listę odświeżeń monitora jakości:

databricks quality-monitors list-refreshes main.my_schema.my_table

databricks quality-monitors odświeżenie uruchomienia

Dodaj do kolejki odświeżenie metryki na monitorze dla określonej tabeli. Proces odświeżania zostanie wykonany w tle.

Obiekt wywołujący musi:

  1. być właścicielem wykazu nadrzędnego tabeli
  2. musi mieć USE_CATALOG w katalogu nadrzędnym tabeli i być właścicielem nadrzędnego schematu tabeli
  3. mają następujące uprawnienia:
    • USE_CATALOG w katalogu nadrzędnym tabeli
    • USE_SCHEMA w schemacie nadrzędnym tabeli
    • zostać właścicielem tabeli

Ponadto połączenie należy wykonać z obszaru roboczego, w którym utworzono monitor.

databricks quality-monitors run-refresh TABLE_NAME [flags]

Arguments

TABLE_NAME

    Pełna nazwa tabeli.

Opcje

Flagi globalne

Examples

Poniższy przykład ustawia w kolejce odświeżenie monitora jakości:

databricks quality-monitors run-refresh main.my_schema.my_table

aktualizacja monitorów jakości w Databricks

Zaktualizuj monitor dla określonej tabeli.

Obiekt wywołujący musi:

  1. być właścicielem wykazu nadrzędnego tabeli
  2. musi mieć USE_CATALOG w katalogu nadrzędnym tabeli i być właścicielem nadrzędnego schematu tabeli
  3. mają następujące uprawnienia:
    • USE_CATALOG w katalogu nadrzędnym tabeli
    • USE_SCHEMA w schemacie nadrzędnym tabeli
    • być właścicielem tabeli.

Ponadto należy wykonać wywołanie z obszaru roboczego, w którym został utworzony monitor, a obiekt wywołujący musi być oryginalnym twórcą monitora.

Niektórych pól konfiguracji, takich jak identyfikatory zasobów wyjściowych, nie można zaktualizować.

databricks quality-monitors update TABLE_NAME OUTPUT_SCHEMA_NAME [flags]

Arguments

TABLE_NAME

    Pełna nazwa tabeli.

OUTPUT_SCHEMA_NAME

    Schemat, w którym są tworzone tabele metryk wyjściowych.

Opcje

--baseline-table-name string

    Nazwa tabeli bazowej, z której są obliczane metryki dryfu.

--dashboard-id string

    Identyfikator panelu, który wizualizuje obliczeniowe metryki.

--json JSON

    Wbudowany ciąg JSON lub @path do pliku JSON z treścią żądania.

Flagi globalne

Examples

Poniższy przykład aktualizuje monitor jakości:

databricks quality-monitors update main.my_schema.my_table main.monitoring_schema

Poniższy przykład aktualizuje monitor jakości przy użyciu nowej tabeli odniesienia:

databricks quality-monitors update main.my_schema.my_table main.monitoring_schema --baseline-table-name main.my_schema.new_baseline

Flagi globalne

--debug

  Czy włączyć logowanie debugowe.

-h lub --help

    Wyświetl pomoc dla Databricks CLI lub dla powiązanej grupy poleceń czy pojedynczego polecenia.

--log-file struna

    Ciąg reprezentujący plik do zapisywania dzienników wyjściowych. Jeśli ta flaga nie zostanie określona, wartością domyślną jest zapisywanie dzienników wyjściowych w programie stderr.

--log-format formatowanie

    Format typu logu text lub json. Wartość domyślna to text.

--log-level struna

    Ciąg reprezentujący poziom formatu zapisu dziennika. Jeśli nie zostanie określony, poziom formatu dziennika jest wyłączony.

-o, --output typ

    Typ danych wyjściowych polecenia: text lub json. Wartość domyślna to text.

-p, --profile struna

    Nazwa profilu pliku ~/.databrickscfg, którego użyć do uruchomienia polecenia. Jeśli ta flaga nie zostanie określona, zostanie użyty profil o nazwie DEFAULT .

--progress-format formatowanie

    Format wyświetlania dzienników postępu: default, , appendinplacelubjson

-t, --target struna

    Jeśli ma to zastosowanie, docelowy obiekt pakietu do użycia