Pular para o conteúdo principal

external-metadata grupo de comandos

nota

Esta informação aplica-se às versões 0.205 e acima Databricks CLI . A CLI do Databricks está em versão prévia pública.

O uso CLI Databricks está sujeito à LicençaDatabricks e ao Aviso de PrivacidadeDatabricks, incluindo qualquer fornecimento de Dados de Uso.

O grupo de comandos external-metadata dentro da CLIDatabricks contém comandos para registrar e gerenciar metadados sobre sistemas externos dentro Unity Catalog.

databricks metadados-externos criar-metadados-externos

Crie um novo objeto de metadados externos no metastore pai se o chamador for um administrador do metastore ou tiver o privilégio CREATE_EXTERNAL_METADATA . Concede permissão de NAVEGAÇÃO a todos os usuários account por default, no momento da criaçã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 suportados: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, 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 em texto livre fornecida pelo usuário.

--json JSON

As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.

--owner string

Proprietário do objeto de metadados externos.

--url string

URL associada ao objeto de metadados externos.

Bandeiras globais

Exemplos

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

Bash
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 externo usando JSON:

Bash
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:

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

databricks metadados-externos excluir-metadados-externos

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

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

Argumentos

NAME

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

Opções

Bandeiras globais

Exemplos

O exemplo a seguir exclui um objeto de metadados externo:

Bash
databricks external-metadata delete-external-metadata my_snowflake_table

databricks metadados-externos obter-metadados-externos

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

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

Argumentos

NAME

Nome do objeto de metadados externos a ser obtido.

Opções

Bandeiras globais

Exemplos

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

Bash
databricks external-metadata get-external-metadata my_snowflake_table

lista de metadados externos do databricks

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 nos quais o chamador tem permissão de BROWSE serão recuperados. Não há garantia de uma ordem específica para os 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

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

Bandeiras globais

Exemplos

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

Bash
databricks external-metadata list-external-metadata

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

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

atualização de metadados externos do databricks

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

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 string, com múltiplos campos separados por vírgulas (sem espaços). O caminho do campo é relativo ao objeto de recurso, usando um ponto (.) para navegar pelos subcampos (por exemplo, author.given_name). A especificação de elementos em campos de sequência ou mapa não é permitida, pois somente o campo de coleção inteiro pode ser especificado. Os nomes dos campos devem corresponder exatamente aos nomes dos campos de recurso.

Um asterisco (*) no campo indica 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 inesperados caso a API seja alterada no futuro.

SYSTEM_TYPE

Tipo de sistema externo. Valores suportados: AMAZON_REDSHIFT, AZURE_SYNAPSE, CONFLUENT, DATABRICKS, GOOGLE_BIGQUERY, KAFKA, 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 em texto livre fornecida pelo usuário.

--json JSON

As strings JSON embutidas ou o @caminho para o arquivo JSON com o corpo da requisição.

--owner string

Proprietário do objeto de metadados externos.

--url string

URL associada ao objeto de metadados externos.

Bandeiras globais

Exemplos

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

Bash
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:

Bash
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 externo usando JSON:

Bash
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"}'

Bandeiras globais

--debug

Ativar ou não o registro de depuração.

-h ou --help

Exibir ajuda para a CLI Databricks , o grupo de comandos relacionado ou o comando específico.

--log-file string

Uma sequência de caracteres representando o arquivo no qual logs de saída serão gravados. Se essa opção não for especificada, o default é gravar logs de saída em stderr.

--log-format Formato

O tipo de formato de log, text ou json. O valor default é text.

--log-level string

Uma sequência de caracteres representando o nível de formato log . Caso não seja especificado, o nível de formato log será desativado.

-o, --output Tipo

O tipo de saída do comando, text ou json. O valor default é text.

-p, --profile string

O nome do perfil no arquivo ~/.databrickscfg a ser usado para executar o comando. Se este sinalizador não for especificado, então, se existir, o perfil denominado DEFAULT será usado.

--progress-format Formato

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

-t, --target string

Se aplicável, o pacote de destino a ser usado.