Dela via


quality-monitors kommandogrupp

Note

Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. The Databricks CLI is in Public Preview.

Databricks CLI use is subject to the Databricks License and Databricks Privacy Notice, including any Usage Data provisions.

The quality-monitors command group within the Databricks CLI contains commands to create, edit, and delete quality monitors. En övervakar beräknar och övervakar data eller modellkvalitetsmått för en tabell över tid. Den genererar måtttabeller och en instrumentpanel som du kan använda för att övervaka tabellens hälsotillstånd och ange aviseringar. Se Introduktion till Databricks Lakehouse Monitoring.

skapa databricks-kvalitetsövervakare

Skapa en ny övervakare för den angivna tabellen.

Anroparen måste antingen:

  1. vara ägare till tabellens överordnade katalog, ha USE_SCHEMA på tabellens överordnade schema och ha SELECT åtkomst till tabellen
  2. ha USE_CATALOG i tabellens överordnade katalog, vara ägare till tabellens överordnade schema och ha SELECT åtkomst till tabellen.
  3. har följande behörigheter:
    • USE_CATALOG i tabellens överordnade katalog
    • USE_SCHEMA i tabellens överordnade schema
    • vara ägare till tabellen.

Arbetsytetillgångar, till exempel instrumentpanelen, skapas på arbetsytan där det här anropet gjordes.

databricks quality-monitors create TABLE_NAME ASSETS_DIR OUTPUT_SCHEMA_NAME [flags]

Arguments

TABLE_NAME

    Fullständigt namn på tabellen.

ASSETS_DIR

    Katalogen som ska lagra övervakningstillgångar (t.ex. instrumentpanel, måtttabeller).

OUTPUT_SCHEMA_NAME

    Schema där utdatamåtttabeller skapas.

Options

--baseline-table-name string

    Namnet på baslinjetabellen som driftmått beräknas från.

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

--skip-builtin-dashboard

    Huruvida man ska hoppa över att skapa en standardpanel som sammanfattar mått på datakvalitet.

--warehouse-id string

    Valfritt argument för att ange lagret för att skapa en instrumentpanel.

Global flags

Examples

I följande exempel skapas en kvalitetsövervakare för en tabell:

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

borttagning av databricks-kvalitetsövervakare

Ta bort en övervakare för den angivna tabellen.

Anroparen måste antingen:

  1. vara ägare till tabellens överordnade katalog
  2. ha USE_CATALOG i tabellens överordnade katalog och vara ägare till tabellens överordnade schema
  3. har följande behörigheter:
    • USE_CATALOG i tabellens överordnade katalog
    • USE_SCHEMA i tabellens överordnade schema
    • vara ägare till tabellen.

Dessutom måste anropet göras från arbetsytan där övervakaren skapades.

Observera att måtttabellerna och instrumentpanelen inte tas bort som en del av det här anropet. dessa tillgångar måste rensas manuellt (om så önskas).

databricks quality-monitors delete TABLE_NAME [flags]

Arguments

TABLE_NAME

    Fullständigt namn på tabellen.

Options

Global flags

Examples

I följande exempel tas en kvalitetsövervakare bort:

databricks quality-monitors delete main.my_schema.my_table

databricks kvalitetsövervakare får

Hämta en övervakare för den angivna tabellen.

Anroparen måste antingen:

  1. vara ägare till tabellens överordnade katalog
  2. ha USE_CATALOG i tabellens överordnade katalog och vara ägare till tabellens överordnade schema.
  3. har följande behörigheter:
    • USE_CATALOG i tabellens överordnade katalog
    • USE_SCHEMA i tabellens överordnade schema
    • SELECT behörigheter på tabellen.

Den returnerade informationen innehåller konfigurationsvärden samt information om tillgångar som skapats av övervakaren. Viss information (t.ex. instrumentpanel) kan filtreras bort om anroparen befinner sig på en annan arbetsyta än där övervakaren skapades.

databricks quality-monitors get TABLE_NAME [flags]

Arguments

TABLE_NAME

    Fullständigt namn på tabellen.

Options

Global flags

Examples

I följande exempel hämtas information om en kvalitetsövervakare:

databricks quality-monitors get main.my_schema.my_table

databricks quality-monitors get-refresh

Hämta information om en specifik övervakningsuppdatering med hjälp av det angivna uppdaterings-ID:t.

Anroparen måste antingen:

  1. vara ägare till tabellens överordnade katalog
  2. ha USE_CATALOG i tabellens överordnade katalog och vara ägare till tabellens överordnade schema
  3. har följande behörigheter:
    • USE_CATALOG i tabellens överordnade katalog
    • USE_SCHEMA i tabellens överordnade schema
    • SELECT behörigheter på tabellen.

Dessutom måste anropet göras från arbetsytan där övervakaren skapades.

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

Arguments

TABLE_NAME

    Fullständigt namn på tabellen.

REFRESH_ID

    ID för uppdateringen.

Options

Global flags

Examples

I följande exempel hämtas information om en specifik uppdatering:

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

databricks quality-monitors list-refreshes

Visa en lista över de senaste uppdateringarna (upp till 25) för den här tabellen.

Anroparen måste antingen:

  1. vara ägare till tabellens överordnade katalog
  2. ha USE_CATALOG i tabellens överordnade katalog och vara ägare till tabellens överordnade schema
  3. har följande behörigheter:
    • USE_CATALOG i tabellens överordnade katalog
    • USE_SCHEMA i tabellens överordnade schema
    • SELECT behörigheter på tabellen.

Dessutom måste anropet göras från arbetsytan där övervakaren skapades.

databricks quality-monitors list-refreshes TABLE_NAME [flags]

Arguments

TABLE_NAME

    Fullständigt namn på tabellen.

Options

Global flags

Examples

I följande exempel visas uppdateringar för en kvalitetsövervakare:

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

databricks quality-monitors run-refresh

Köa en måttuppdatering på övervakaren för den angivna tabellen. Uppdateringen körs i bakgrunden.

Anroparen måste antingen:

  1. vara ägare till tabellens överordnade katalog
  2. ha USE_CATALOG i tabellens överordnade katalog och vara ägare till tabellens överordnade schema
  3. har följande behörigheter:
    • USE_CATALOG i tabellens överordnade katalog
    • USE_SCHEMA i tabellens överordnade schema
    • vara ägare till tabellen

Dessutom måste anropet göras från arbetsytan där övervakaren skapades.

databricks quality-monitors run-refresh TABLE_NAME [flags]

Arguments

TABLE_NAME

    Fullständigt namn på tabellen.

Options

Global flags

Examples

I följande exempel köar en uppdatering för en kvalitetsövervakare:

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

uppdatering av databricks-kvalitetsövervakare

Uppdatera en övervakare för den angivna tabellen.

Anroparen måste antingen:

  1. vara ägare till tabellens överordnade katalog
  2. ha USE_CATALOG i tabellens överordnade katalog och vara ägare till tabellens överordnade schema
  3. har följande behörigheter:
    • USE_CATALOG i tabellens överordnade katalog
    • USE_SCHEMA i tabellens överordnade schema
    • vara ägare till tabellen.

Dessutom måste anropet göras från arbetsytan där övervakaren skapades och anroparen måste vara den ursprungliga skaparen av övervakaren.

Vissa konfigurationsfält, till exempel utdatatillgångsidentifierare, kan inte uppdateras.

databricks quality-monitors update TABLE_NAME OUTPUT_SCHEMA_NAME [flags]

Arguments

TABLE_NAME

    Fullständigt namn på tabellen.

OUTPUT_SCHEMA_NAME

    Schema där utdatamåtttabeller skapas.

Options

--baseline-table-name string

    Namnet på baslinjetabellen som driftmått beräknas från.

--dashboard-id string

    ID för instrumentpanelen som visualiserar de beräknade måtten.

--json JSON

    Den infogade JSON-strängen @path eller till JSON-filen med begärandetexten.

Global flags

Examples

I följande exempel uppdateras en kvalitetsövervakare:

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

I följande exempel uppdateras en kvalitetsövervakare med en ny baslinjetabell:

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

Global flags

--debug

  Om felsökningsloggning ska aktiveras.

-h eller --help

    Visa hjälp för Databricks CLI eller den relaterade kommandogruppen eller det relaterade kommandot.

--log-file sträng

    En sträng som representerar filen som utdataloggarna ska skrivas till. Om den här flaggan inte anges är standardvärdet att skriva utdataloggar till stderr.

--log-format format

    Loggformattypen eller textjson. Standardvärdet är text.

--log-level sträng

    En sträng som representerar loggformatnivån. Om det inte anges inaktiveras loggformatnivån.

-o, --output typ

    Kommandots utdatatyp, text eller json. Standardvärdet är text.

-p, --profile sträng

    Namnet på profilen i filen som ~/.databrickscfg ska användas för att köra kommandot. Om den här flaggan inte anges används den namngivna DEFAULT profilen om den finns.

--progress-format format

    Formatet för att visa förloppsloggar: default, append, inplaceeller json

-t, --target sträng

    Om tillämpligt, paketmålet som ska användas