Grupo de comandos external-metadata

Observação

Essas informações se aplicam às versões 0.205 e superiores da CLI do Databricks. A CLI do Databricks está em Visualização Pública.

O uso da CLI do Databricks está sujeito à Licença do Databricks e ao Aviso de Privacidade do Databricks, incluindo quaisquer provisionamentos de Dados de Uso.

O external-metadata grupo de comandos dentro da CLI do Databricks contém comandos para registrar e gerenciar metadados sobre sistemas externos no Catálogo do Unity.

databricks external-metadata create-external-metadata

Crie um novo objeto de metadados externos no metastore pai se o chamador for um administrador metastore ou tiver o privilégio CREATE_EXTERNAL_METADATA . Concede BROWSE a todos os usuários da conta após a criação por padrão.

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

Argumentos

NAME

    Nome do objeto de metadados externos.

SYSTEM_TYPE

    Tipo de sistema externo. Valores com suporte: AMAZON_REDSHIFT, , AZURE_SYNAPSE, CONFLUENT, , DATABRICKS, KAFKAGOOGLE_BIGQUERY, , LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, , ORACLE, , OTHER, , POSTGRESQL, POWER_BI, SALESFORCE, , SAP, SERVICENOW, SNOWFLAKE, STREAM_NATIVE, TABLEAU, , TERADATA. WORKDAY

ENTITY_TYPE

    Tipo de entidade dentro do sistema externo.

Opções

--description string

    Descrição do texto de forma livre fornecida pelo usuário.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação

--owner string

    Proprietário do objeto de metadados externos.

--url string

    URL associada ao objeto de metadados externos.

Sinalizadores globais

Exemplos

O exemplo a seguir cria um objeto de metadados externos para uma tabela Snowflake:

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

O exemplo a seguir cria um objeto de metadados externos usando JSON:

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

O exemplo a seguir cria um objeto de metadados externo usando um arquivo JSON:

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

databricks external-metadata delete-external-metadata

Exclua o objeto de metadados externo que corresponde ao nome fornecido. O chamador deve ser um administrador metastore, o proprietário do objeto de metadados externos ou um usuário que tenha o privilégio MANAGE .

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

Argumentos

NAME

    Nome do objeto de metadados externo a ser excluído.

Opções

Sinalizadores globais

Exemplos

O exemplo a seguir exclui um objeto de metadados externos:

databricks external-metadata delete-external-metadata my_snowflake_table

databricks external-metadata get-external-metadata

Obtenha o objeto de metadados externos especificado em um metastore. O chamador deve ser um administrador metastore, o proprietário do objeto de metadados externos ou um usuário que tenha o privilégio BROWSE .

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

Argumentos

NAME

    Nome do objeto de metadados externo a ser obtido.

Opções

Sinalizadores globais

Exemplos

O exemplo a seguir obtém um objeto de metadados externos:

databricks external-metadata get-external-metadata my_snowflake_table

databricks external-metadata list-external-metadata

Listar objetos de metadados externos no metastore. Se o chamador for o administrador do metastore, todos os objetos de metadados externos serão recuperados. Caso contrário, somente os objetos de metadados externos em que o chamador tiver BROWSE serão recuperados. Não há garantia de uma ordenação específica dos elementos na matriz.

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

Opções

--page-size int

    Número máximo de objetos de metadados externos a serem retornados por página.

--page-token string

    Token para recuperar a próxima página de resultados.

Sinalizadores globais

Exemplos

O exemplo a seguir lista todos os objetos de metadados externos:

databricks external-metadata list-external-metadata

O exemplo a seguir lista objetos de metadados externos com paginação:

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

databricks external-metadata update-external-metadata

Atualize o objeto de metadados externo que corresponde ao nome fornecido. O chamador só pode atualizar o proprietário ou outros campos de metadados em uma solicitação. O chamador deve ser um administrador metastore, o proprietário do objeto de metadados externos ou um usuário que tenha o privilégio MODIFY . Se o chamador estiver atualizando o proprietário, ele também deverá ter o privilégio MANAGE .

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

Argumentos

NAME

    Nome do objeto de metadados externos.

UPDATE_MASK

    A máscara de campo deve ser uma única cadeia de caracteres, com vários campos separados por vírgulas (sem espaços). O caminho do campo é relativo ao objeto de recurso, usando um ponto (.) para navegar por sub-campos (por exemplo, author.given_name). A especificação de elementos em campos de sequência ou mapa não é permitida, pois somente todo o campo de coleção pode ser especificado. Os nomes de campo devem corresponder exatamente aos nomes de campo de recurso.

    Uma máscara de campo de asterisco (*) indica a substituição completa. É recomendável sempre listar explicitamente os campos que estão sendo atualizados e evitar o uso de curingas, pois isso pode levar a resultados não intencionais se a API for alterada no futuro.

SYSTEM_TYPE

    Tipo de sistema externo. Valores com suporte: AMAZON_REDSHIFT, , AZURE_SYNAPSE, CONFLUENT, , DATABRICKS, KAFKAGOOGLE_BIGQUERY, , LOOKER, MICROSOFT_FABRIC, MICROSOFT_SQL_SERVER, MONGODB, MYSQL, , ORACLE, , OTHER, , POSTGRESQL, POWER_BI, SALESFORCE, , SAP, SERVICENOW, SNOWFLAKE, STREAM_NATIVE, TABLEAU, , TERADATA. WORKDAY

ENTITY_TYPE

    Tipo de entidade dentro do sistema externo.

Opções

--description string

    Descrição do texto de forma livre fornecida pelo usuário.

--json JSON

    A cadeia de caracteres JSON inserida em linha ou o @path para o arquivo JSON com o corpo da solicitação

--owner string

    Proprietário do objeto de metadados externos.

--url string

    URL associada ao objeto de metadados externos.

Sinalizadores globais

Exemplos

O exemplo a seguir atualiza a descrição de um objeto de metadados externo:

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

O exemplo a seguir atualiza o proprietário de um objeto de metadados externo:

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

O exemplo a seguir atualiza um objeto de metadados externos usando 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"}'

Sinalizadores globais

--debug

  Indica se deve habilitar o registro em log de depuração.

-h ou --help

    Exiba ajuda para a CLI do Databricks ou o grupo de comandos relacionado ou o comando relacionado.

--log-file corda

    Uma cadeia de caracteres que representa o arquivo onde serão gravados os logs de saída. Se esse sinalizador não for especificado, o padrão será gravar logs de saída no stderr.

--log-format formato

    O tipo de formato de log, text ou json. O valor padrão é text.

--log-level corda

    Uma cadeia de caracteres que representa o nível de formato de log. Se não for especificado, o nível de formato de log será desabilitado.

-o, --output tipo

    O tipo de saída do comando, text ou json. O valor padrão é text.

-p, --profile corda

    O nome do perfil no arquivo ~/.databrickscfg, que deverá ser usado para executar o comando. Se esse sinalizador não for especificado, se existir, o perfil nomeado DEFAULT será usado.

--progress-format formato

    O formato para exibir logs de progresso: default, append, inplace ou json

-t, --target corda

    Se aplicável, o destino do pacote a ser usado