Wikis do Catálogo Unity

Importante

Este recurso está em versão Beta. Os administradores de contas podem gerir o acesso a esta funcionalidade a partir da página de Pré-visualizações da consola da conta. Consulte Gerir pré-visualizações ao nível da conta.

Uma wiki permite que a sua equipa documente o significado de uma tabela, o uso pretendido e as fontes, e depois colabore nessa informação. Os proprietários de dados e gestores de dados redigem e publicam wikis para captar o contexto empresarial associado a uma tabela, como definições e ressalvas conhecidas. Qualquer pessoa que consiga ver os metadados da tabela pode ler uma wiki publicada, comentar, sugerir edições e reagir a ela.

Uma wiki documenta uma tabela. Uma Página define um conceito de negócio que pode abranger muitos ativos. Usa uma wiki para contexto sobre uma tabela específica e usa uma Página para uma definição partilhada.

As wikis funcionam em conjunto com o comentário existente da tabela. Consulte Wikis e comentários da tabela.

O que está numa wiki

Uma wiki contém os seguintes campos:

Field Description
Description Um resumo de uma linha da tabela, mostrado no topo da wiki.
Corpo da página Documentação em texto enriquecido que suporta títulos, links, imagens e menções inline de objetos securáveis no Unity Catalog e objetos de espaço de trabalho.
Sources Ligações para as Páginas ou fontes externas em que o conteúdo da wiki se baseia.

Uma wiki publicada no separador Visão Geral de uma tabela no Explorador de Catálogos, com uma descrição, secções do corpo da página e um link de Fontes

Permissions

Uma wiki não é um objeto securizável. São metadados da tabela associada, por isso os seus privilégios existentes do Unity Catalog na tabela determinam o que pode fazer com a sua wiki. Para contexto sobre privilégios do Catálogo Unity, veja conceitos do modelo de permissões do Catálogo Unity.

A tabela de privilégios que se segue utiliza privilégios de utilização nos objetos pais para significar os privilégios de uso que READ_METADATA, MANAGE, ou que a posse requerem para entrar em vigor. Dependem do objeto:

  • Tabela: USE SCHEMA no esquema pai e USE CATALOG no catálogo pai.
  • Esquema: USE CATALOG no catálogo principal.
  • Catálogo: Nenhum catálogo.
Action Privilégios necessários
Veja e colabore em wikis publicadas: veja wikis publicadas, adicione, edite ou elimine os seus próprios comentários, sugira edições e adicione reações Uma das seguintes opções:
  • SELECT na mesa, USE SCHEMA no esquema e USE CATALOG no catálogo
  • BROWSE no catálogo pai
  • READ_METADATA na tabela, esquema, catálogo ou metastore, com privilégios de utilização nos objetos pais
  • MANAGE na tabela, esquema ou catálogo, com privilégios de utilização nos objetos pai
  • Proprietário da tabela, do esquema pai ou do catálogo pai, com privilégios de utilização nos objetos pais
  • Administrador do Metastore
Ver rascunhos de wikis Uma das seguintes opções:
  • READ_METADATA na tabela, esquema, catálogo ou metastore, com privilégios de utilização nos objetos pais
  • MANAGE na tabela, esquema ou catálogo, com privilégios de utilização nos objetos pais
  • Proprietário da tabela, esquema pai ou catálogo pai, com privilégios de utilização nos objetos pais
  • Administrador do Metastore
Gerir wikis e comentários: criar, editar, publicar ou retirar a publicação de wikis, aceitar ou rejeitar edições sugeridas e apagar qualquer comentário Uma das seguintes opções:
  • MANAGE na tabela, esquema ou catálogo, com privilégios de utilização nos objetos pais
  • Proprietário da tabela, esquema pai ou catálogo pai, com privilégios de utilização nos objetos pais
  • Administrador do Metastore

Criar uma wiki

Para criar uma wiki, precisas dos privilégios para gerir wikis na tabela. Consulte Permissões.

Podes criar uma wiki manualmente ou redigir uma com o Código Genie.

Warning

Os dados da wiki são encriptados em repouso com chaves geridas pela Microsoft. As wikis não suportam encriptação por chave gerida pelo cliente (CMK). Não inclua PII, dados regulados ou outra informação sensível nas descrições da wiki ou nos corpos das páginas.

  1. No Explorador de Catálogos, abra a tabela.

  2. No guia Visão Geral, clique em Criar wiki. Se ignorou o banner Criar wiki , clique no ícone do menu Kebab. menu Kebab no canto superior direito da página e selecione Criar wiki em vez disso. Se a tabela tiver um comentário existente, pré-preenche o corpo da página da wiki.

    O banner Criar wiki acima da descrição de uma tabela no separador Visão Geral

  3. Adicione o conteúdo da wiki:

    • Para escrever manualmente, preencha a Descrição e o corpo da página, e adicione quaisquer Fontes.
    • Para escrever com o Código Genie, use o painel do Código Genie no editor da wiki. Anexa ficheiros ou outro contexto para o Genie Code trabalhar. Ver Código Génio.
  4. Clique em Guardar como rascunho para continuar a trabalhar na wiki, ou clique em Publicar para tornar visível a todos os que conseguem ver os metadados da tabela.

Depois de publicar uma wiki, ela aparece no topo do separador de Visão Geral da tabela, e a Descrição da tabela passa para o separador Detalhes .

Editar e publicar wikis

Para editar, publicar ou despublicar uma wiki, precisa dos privilégios para gerir wikis na tabela. Consulte Permissões.

  1. No Explorador de Catálogos, abra a tabela.

  2. Na wiki, clique em Edit.

  3. Faz as tuas alterações, depois clica em Guardar para as guardar, ou clica em Publicar para tornar um rascunho da wiki visível.

    Uma wiki de rascunho em modo de edição, com os botões Cancelar, Guardar e Publicar

Para esconder uma wiki publicada sem perder o seu conteúdo, clica em Editar, no menu do kebab e depois em Anular publicação. A wiki reverte para um rascunho que só os utilizadores que podem ver rascunhos podem ver. Até publicares a wiki novamente, a Descrição da tabela aparece no topo do separador Visão Geral .

A opção Despublicar no menu kebab de uma wiki publicada em modo de edição

Colabore numa wiki

Qualquer pessoa que possa consultar uma wiki publicada pode colaborar nela. Consulte Permissões.

  • Comentário: Faça perguntas ou adicione contexto. Pode editar ou eliminar os seus próprios comentários.
  • Sugerir edições: Sugirir alterações ao corpo da página da wiki. Clique em Sugerir, edite o corpo da página e clique em Guardar. Um utilizador com privilégios para gerir a wiki aceita ou rejeita a sugestão.
  • React: Vote positivo ou negativo na wiki para sinalizar se foi útil.

Wikis e comentários de tabelas

Uma wiki não substitui o comentário da tabela, por isso os pipelines existentes que leem ou escrevem comentários continuam a funcionar:

  • Ainda podes definir o comentário com COMMENT ON TABLE ou ALTER TABLE. O comentário ainda aparece em information_schema e no campo Descrição no Explorador de Catálogos.
  • Quando crias uma wiki, o comentário existente da tabela preenche inicialmente o corpo da página da wiki. Depois disso, a wiki e o comentário tornam-se independentes. As alterações a um não atualizam o outro.

Para mais informações sobre comentários em tabelas, consulte Adicionar comentários a dados e ativos de IA.

Limitations

  • As wikis estão disponíveis apenas em mesas. Os wikis sobre colunas, esquemas, catálogos e outros objetos protegíveis não são suportados.
  • Cada tabela pode ter uma wiki.
  • Wikis não estão disponíveis nas regiões do Azure Government, Azure China ou FedRAMP.