external-metadata kommandogrupp

Anmärkning

Den här informationen gäller för Databricks CLI-versionerna 0.205 och senare. Databricks CLI finns i offentlig förhandsversion.

Databricks CLI-användning omfattas av Databricks-licensen och Databricks sekretessmeddelande, inklusive eventuella användningsdatabestämmelser.

Kommandogruppen external-metadata i Databricks CLI innehåller kommandon för att registrera och hantera metadata om externa system i Unity Catalog.

databricks external-metadata create-external-metadata

Skapa ett nytt externt metadataobjekt i det överordnade metaarkivet om anroparen är metaarkivadministratör eller har CREATE_EXTERNAL_METADATA behörighet. Beviljar BROWSE till alla kontoanvändare när de skapas som standard.

databricks external-metadata create-external-metadata NAME SYSTEM_TYPE ENTITY_TYPE [flags]

Arguments

NAME

    Namnet på det externa metadataobjektet.

SYSTEM_TYPE

    Typ av externt system. Värden som stöds: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MONGODBMICROSOFT_SQL_SERVER, , MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, STREAM_NATIVE, TABLEAU, WORKDAYTERADATA.

ENTITY_TYPE

    Typ av entitet i det externa systemet.

Alternativ

--description string

    Beskrivning av text i fritt formulär som tillhandahålls av användaren.

--json JSON

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

--owner string

    Ägare till det externa metadataobjektet.

--url string

    URL som är associerad med det externa metadataobjektet.

Globala flaggor

Exempel

I följande exempel skapas ett externt metadataobjekt för en Snowflake-tabell:

databricks external-metadata create-external-metadata my_snowflake_table SNOWFLAKE TABLE --description "Production sales table" --url "https://example.snowflakecomputing.com/table/sales"

I följande exempel skapas ett externt metadataobjekt med JSON:

databricks external-metadata create-external-metadata tableau_dashboard TABLEAU DASHBOARD --json '{"description": "Sales dashboard", "owner": "user@example.com"}'

I följande exempel skapas ett externt metadataobjekt med hjälp av en JSON-fil:

databricks external-metadata create-external-metadata bigquery_dataset GOOGLE_BIGQUERY DATASET --json @external-metadata.json

databricks external-metadata delete-external-metadata

Ta bort det externa metadataobjektet som matchar det angivna namnet. Anroparen måste vara metaarkivadministratör, ägare till det externa metadataobjektet eller en användare som har behörigheten HANTERA .

databricks external-metadata delete-external-metadata NAME [flags]

Arguments

NAME

    Namnet på det externa metadataobjekt som ska tas bort.

Alternativ

Globala flaggor

Exempel

I följande exempel tas ett externt metadataobjekt bort:

databricks external-metadata delete-external-metadata my_snowflake_table

databricks external-metadata get-external-metadata

Hämta det angivna externa metadataobjektet i ett metaarkiv. Anroparen måste vara metaarkivadministratör, ägare till det externa metadataobjektet eller en användare som har browse-behörigheten .

databricks external-metadata get-external-metadata NAME [flags]

Arguments

NAME

    Namnet på det externa metadataobjekt som ska hämtas.

Alternativ

Globala flaggor

Exempel

I följande exempel hämtas ett externt metadataobjekt:

databricks external-metadata get-external-metadata my_snowflake_table

databricks external-metadata list-external-metadata

Visa en lista över externa metadataobjekt i metaarkivet. Om anroparen är metaarkivadministratör hämtas alla externa metadataobjekt. Annars hämtas endast externa metadataobjekt som anroparen har BLÄDDRA på. Det finns ingen garanti för en specifik ordning på elementen i matrisen.

databricks external-metadata list-external-metadata [flags]

Alternativ

--page-size int

    Maximalt antal externa metadataobjekt som ska returneras per sida.

--page-token string

    Token för att hämta nästa sida med resultat.

Globala flaggor

Exempel

I följande exempel visas alla externa metadataobjekt:

databricks external-metadata list-external-metadata

I följande exempel visas externa metadataobjekt med sidnumrering:

databricks external-metadata list-external-metadata --page-size 10

databricks external-metadata update-external-metadata

Uppdatera det externa metadataobjektet som matchar det angivna namnet. Anroparen kan bara uppdatera ägaren eller andra metadatafält i en begäran. Anroparen måste vara metaarkivadministratör, ägare till det externa metadataobjektet eller en användare som har behörigheten ÄNDRA . Om anroparen uppdaterar ägaren måste de också ha behörigheten HANTERA .

databricks external-metadata update-external-metadata NAME UPDATE_MASK SYSTEM_TYPE ENTITY_TYPE [flags]

Arguments

NAME

    Namnet på det externa metadataobjektet.

UPDATE_MASK

    Fältmasken måste vara en enda sträng med flera fält avgränsade med kommatecken (inga blanksteg). Fältsökvägen är relativ till resursobjektet med hjälp av en punkt (.) för att navigera i underfält (t.ex. author.given_name). Specifikation av element i sekvens- eller kartfält tillåts inte, eftersom endast hela samlingsfältet kan anges. Fältnamn måste exakt matcha resursfältnamnen.

    En asterisk (*) fältmask anger fullständig ersättning. Vi rekommenderar att du alltid uttryckligen visar de fält som uppdateras och undviker att använda jokertecken, eftersom det kan leda till oavsiktliga resultat om API:et ändras i framtiden.

SYSTEM_TYPE

    Typ av externt system. Värden som stöds: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, LOOKER, MICROSOFT_FABRIC, MONGODBMICROSOFT_SQL_SERVER, , MYSQL, ORACLE, OTHER, POSTGRESQL, POWER_BI, SALESFORCE, SAP, SERVICENOW, SNOWFLAKE, STREAM_NATIVE, TABLEAU, WORKDAYTERADATA.

ENTITY_TYPE

    Typ av entitet i det externa systemet.

Alternativ

--description string

    Beskrivning av text i fritt formulär som tillhandahålls av användaren.

--json JSON

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

--owner string

    Ägare till det externa metadataobjektet.

--url string

    URL som är associerad med det externa metadataobjektet.

Globala flaggor

Exempel

I följande exempel uppdateras beskrivningen av ett externt metadataobjekt:

databricks external-metadata update-external-metadata my_snowflake_table "description" SNOWFLAKE TABLE --description "Updated production sales table"

I följande exempel uppdateras ägaren till ett externt metadataobjekt:

databricks external-metadata update-external-metadata my_snowflake_table "owner" SNOWFLAKE TABLE --owner "newowner@example.com"

I följande exempel uppdateras ett externt metadataobjekt med JSON:

databricks external-metadata update-external-metadata my_snowflake_table "description,url" SNOWFLAKE TABLE --json '{"description": "Latest sales data", "url": "https://example.snowflakecomputing.com/table/sales_v2"}'

Globala flaggor

--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, text eller json. 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 ~/.databrickscfg-filen som 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