Sdílet prostřednictvím


quality-monitors skupina příkazů

Note

Tyto informace platí pro Databricks CLI verze 0.205 a vyšší. Rozhraní příkazového řádku Databricks je ve veřejné ukázce.

Použití rozhraní příkazového řádku Databricks podléhá licenci Databricks a oznámení o ochraně osobních údajů Databricks, včetně všech ustanovení o využití.

Skupina quality-monitors příkazů v rozhraní příkazového řádku Databricks obsahuje příkazy pro vytváření, úpravy a odstraňování monitorování kvality. Monitor počítá a monitoruje metriky kvality dat nebo modelů pro tabulku v průběhu času. Generuje tabulky metrik a řídicí panel, který můžete použít k monitorování stavu tabulky a nastavení upozornění. Podívejte se na Profilace dat.

Vytvoření monitorů kvality databricks

Vytvořte nový monitor pro zadanou tabulku.

Volající musí buďto:

  1. být vlastníkem nadřazeného katalogu tabulky, mít USE_SCHEMA na nadřazeném schématu tabulky a mít SELECT přístup k tabulce
  2. mít USE_CATALOG v nadřazeném katalogu tabulky, být vlastníkem nadřazeného schématu a mít SELECT přístup k tabulce.
  3. mají následující oprávnění:
    • USE_CATALOG v nadřazeném katalogu tabulky
    • USE_SCHEMA na nadřazeném schématu tabulky
    • být vlastníkem tabulky.

Prostředky pracovního prostoru, jako je řídicí panel, se vytvoří v pracovním prostoru, ve kterém bylo toto volání provedeno.

databricks quality-monitors create TABLE_NAME ASSETS_DIR OUTPUT_SCHEMA_NAME [flags]

Arguments

TABLE_NAME

    Úplný název tabulky.

ASSETS_DIR

    Adresář pro ukládání monitorovacích prostředků (např. řídicího panelu, tabulek metrik).

OUTPUT_SCHEMA_NAME

    Schéma, ve kterém se vytvářejí výstupní tabulky metrik.

Možnosti

--baseline-table-name string

    Název základní tabulky, ze které se metriky posunu počítají.

--json JSON

    Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.

--skip-builtin-dashboard

    Zda se má přeskočit vytvoření výchozího řídicího panelu se souhrnem metrik kvality dat.

--warehouse-id string

    Volitelný argument pro zadání skladu pro vytvoření řídicího panelu.

Globální příznaky

Examples

Následující příklad vytvoří monitorování kvality pro tabulku:

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

Odstranění monitorování kvality databricks

Odstraňte monitor pro zadanou tabulku.

Volající musí buďto:

  1. být vlastníkem katalogu nadřazeného tabulce
  2. mít USE_CATALOG v nadřazeném katalogu tabulky a být vlastníkem nadřazeného schématu tabulky
  3. mají následující oprávnění:
    • USE_CATALOG v nadřazeném katalogu tabulky
    • USE_SCHEMA na nadřazeném schématu tabulky
    • být vlastníkem tabulky.

Kromě toho musí být volání provedeno z pracovního prostoru, ve kterém byl monitor vytvořen.

Všimněte si, že tabulky metrik a řídicí panel nebudou v rámci tohoto volání odstraněny; tyto prostředky musí být ručně vyčištěny (pokud je to žádoucí).

databricks quality-monitors delete TABLE_NAME [flags]

Arguments

TABLE_NAME

    Úplný název tabulky.

Možnosti

Globální příznaky

Examples

Následující příklad odstraní monitorování kvality:

databricks quality-monitors delete main.my_schema.my_table

Databricks quality-monitory získat

Získejte monitor pro zadanou tabulku.

Volající musí buďto:

  1. být vlastníkem katalogu nadřazeného tabulce
  2. mít USE_CATALOG v nadřazeném katalogu tabulky a být vlastníkem nadřazeného schématu tabulky.
  3. mají následující oprávnění:
    • USE_CATALOG v nadřazeném katalogu tabulky
    • USE_SCHEMA na nadřazeném schématu tabulky
    • SELECT oprávnění k tabulce.

Vrácené informace zahrnují hodnoty konfigurace a také informace o prostředcích vytvořených monitorem. Některé informace (např. řídicí panel) se můžou vyfiltrovat, pokud je volající v jiném pracovním prostoru, než kde byl monitor vytvořen.

databricks quality-monitors get TABLE_NAME [flags]

Arguments

TABLE_NAME

    Úplný název tabulky.

Možnosti

Globální příznaky

Examples

Následující příklad získá informace o monitorování kvality:

databricks quality-monitors get main.my_schema.my_table

Databricks quality-monitor get-refresh

Získejte informace o konkrétní aktualizaci monitorování pomocí daného ID aktualizace.

Volající musí buďto:

  1. být vlastníkem katalogu nadřazeného tabulce
  2. mít USE_CATALOG v nadřazeném katalogu tabulky a být vlastníkem nadřazeného schématu tabulky
  3. mají následující oprávnění:
    • USE_CATALOG v nadřazeném katalogu tabulky
    • USE_SCHEMA na nadřazeném schématu tabulky
    • SELECT oprávnění k tabulce.

Kromě toho musí být volání provedeno z pracovního prostoru, ve kterém byl monitor vytvořen.

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

Arguments

TABLE_NAME

    Úplný název tabulky.

REFRESH_ID

    ID aktualizace.

Možnosti

Globální příznaky

Examples

Následující příklad získá informace o konkrétní aktualizaci:

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

Aktualizace seznamů monitorování kvality databricks

Zobrazí seznam historie nejnovějších aktualizací (až 25) pro tuto tabulku.

Volající musí buďto:

  1. být vlastníkem katalogu nadřazeného tabulce
  2. mít USE_CATALOG v nadřazeném katalogu tabulky a být vlastníkem nadřazeného schématu tabulky
  3. mají následující oprávnění:
    • USE_CATALOG v nadřazeném katalogu tabulky
    • USE_SCHEMA na nadřazeném schématu tabulky
    • SELECT oprávnění k tabulce.

Kromě toho musí být volání provedeno z pracovního prostoru, ve kterém byl monitor vytvořen.

databricks quality-monitors list-refreshes TABLE_NAME [flags]

Arguments

TABLE_NAME

    Úplný název tabulky.

Možnosti

Globální příznaky

Examples

Následující příklad uvádí aktualizace pro monitorování kvality:

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

Monitorování kvality Databricks: aktualizace spuštění

Zařadíte do fronty aktualizaci metrik na monitoru pro zadanou tabulku. Aktualizace se spustí na pozadí.

Volající musí buďto:

  1. být vlastníkem katalogu nadřazeného tabulce
  2. mít USE_CATALOG v nadřazeném katalogu tabulky a být vlastníkem nadřazeného schématu tabulky
  3. mají následující oprávnění:
    • USE_CATALOG v nadřazeném katalogu tabulky
    • USE_SCHEMA na nadřazeném schématu tabulky
    • být vlastníkem tabulky

Kromě toho musí být volání provedeno z pracovního prostoru, ve kterém byl monitor vytvořen.

databricks quality-monitors run-refresh TABLE_NAME [flags]

Arguments

TABLE_NAME

    Úplný název tabulky.

Možnosti

Globální příznaky

Examples

Následující příklad zařadí aktualizaci do fronty pro monitorování kvality:

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

Aktualizace monitorů kvality Databricks

Aktualizujte monitor pro zadanou tabulku.

Volající musí buďto:

  1. být vlastníkem katalogu nadřazeného tabulce
  2. mít USE_CATALOG v nadřazeném katalogu tabulky a být vlastníkem nadřazeného schématu tabulky
  3. mají následující oprávnění:
    • USE_CATALOG v nadřazeném katalogu tabulky
    • USE_SCHEMA na nadřazeném schématu tabulky
    • být vlastníkem tabulky.

Kromě toho musí být volání provedeno z pracovního prostoru, ve kterém byl monitor vytvořen, a volající musí být původním tvůrcem monitoru.

Některá konfigurační pole, například identifikátory výstupních prostředků, nelze aktualizovat.

databricks quality-monitors update TABLE_NAME OUTPUT_SCHEMA_NAME [flags]

Arguments

TABLE_NAME

    Úplný název tabulky.

OUTPUT_SCHEMA_NAME

    Schéma, ve kterém se vytvářejí výstupní tabulky metrik.

Možnosti

--baseline-table-name string

    Název základní tabulky, ze které se metriky posunu počítají.

--dashboard-id string

    ID řídicího panelu, který vizualizuje vypočítané metriky

--json JSON

    Vložený řetězec JSON nebo @path do souboru JSON s textem požadavku.

Globální příznaky

Examples

Následující příklad aktualizuje monitorování kvality:

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

Následující příklad aktualizuje monitorování kvality pomocí nové základní tabulky:

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

Globální příznaky

--debug

  Zda povolit protokolování ladění.

-h nebo --help

    Zobrazení nápovědy k rozhraní příkazového řádku Databricks nebo související skupině příkazů nebo souvisejícímu příkazu

--log-file řetězec

    Řetězec představující soubor, do kterého se zapisují výstupní protokoly. Pokud tento příznak není zadaný, výchozí hodnota je zápis výstupních protokolů do stderru.

--log-format formát

    Typ formátu protokolu, text nebo json. Výchozí hodnota je text.

--log-level řetězec

    Řetězec představující úroveň formátu protokolu. Pokud není zadána, je úroveň formátu protokolu zakázaná.

-o, --output typ

    Typ výstupu příkazu, text nebo json. Výchozí hodnota je text.

-p, --profile řetězec

    Název profilu v ~/.databrickscfg souboru, který se má použít ke spuštění příkazu. Pokud tento příznak není zadán, použije se profil s názvem DEFAULT, pokud existuje.

--progress-format formát

    Formát pro zobrazení protokolů průběhu: default, append, inplacenebo json

-t, --target řetězec

    Pokud je to relevantní, cílový balíček, který se má použít