Wikis du catalogue Unity

Important

Cette fonctionnalité est en version bêta. Les administrateurs de compte peuvent gérer l’accès à cette fonctionnalité à partir de la page Aperçus de la console de compte. Consultez Gérer les versions préliminaires du compte.

Un wiki permet à votre équipe de documenter la signification d’un tableau, son usage prévu et ses sources, puis de collaborer sur ces informations. Les propriétaires et gestionnaires de données rédigent et publient des wikis pour capturer le contexte métier associé à une table, tels que les définitions et les mises en garde connues. Toute personne pouvant consulter les métadonnées de la table peut lire un wiki publié, commenter, suggérer des modifications et y réagir.

Un wiki documente un tableau. Une Page définit un concept d’entreprise qui peut englober de nombreuses ressources. Utilisez un wiki pour le contexte d’un tableau spécifique, et utilisez une page pour une définition partagée.

Les wikis coexistent avec le commentaire existant du tableau. Voir les wikis et les commentaires des tableaux.

Qu’y a-t-il dans un wiki

Un wiki contient les champs suivants :

Champ Description
Description Un résumé d’une ligne du tableau, présenté en haut du wiki.
Corps de page Documentation en texte enrichi qui prend en charge les titres, liens, images et mentions en ligne d’objets sécurisables Unity Catalog et d’objets d’espace de travail.
Sources Des liens vers les Pages ou sources externes sur lesquelles le contenu wiki est basé.

Un wiki publié dans l’onglet Aperçu d’un tableau dans l’Explorateur de catalogue, avec une description, des sections du corps de la page et un lien vers les sources

Permissions

Un wiki n’est pas un objet sécurisable. Ce sont des métadonnées associées à cette table, donc vos privilèges existants du catalogue Unity sur la table déterminent ce que vous pouvez faire avec le wiki de la table. Pour plus de contexte sur les privilèges du catalogue Unity, voir concepts du modèle d’autorisations du catalogue Unity.

La table des privilèges qui suit utilise les privilèges d’utilisation sur les objets parents pour désigner les privilèges d’utilisation que READ_METADATA, MANAGE, ou la propriété requièrent pour prendre effet. Ils dépendent de l’objet :

  • Tableau : USE SCHEMA sur le schéma parent et USE CATALOG sur le catalogue parent.
  • Schéma : USE CATALOG dans le catalogue parent.
  • Catalogue: Aucun.
Action Privilèges requis
Consultez et collaborez sur les wikis publiés : consultez les wikis publiés, ajoutez, modifiez ou supprimez vos propres commentaires, suggérez des modifications et ajoutez des réactions L'un des suivants :
  • SELECT sur la table, USE SCHEMA sur le schéma et USE CATALOG sur le catalogue
  • BROWSE sur le catalogue parent
  • READ_METADATA sur la table, le schéma, le catalogue ou le métastore, avec des privilèges d’utilisation sur les objets parents
  • MANAGE sur la table, le schéma ou le catalogue, avec les privilèges d’utilisation sur les objets parents
  • Propriétaire de la table, du schéma parent ou du catalogue parent, avec des privilèges d’utilisation sur les objets parents
  • Administrateur de metastore
Voir les wikis en brouillon L'un des suivants :
  • READ_METADATA pour la table, le schéma, le catalogue ou le métastore, avec des privilèges d’utilisation sur les objets parents
  • MANAGE sur la table, le schéma ou le catalogue, avec les privilèges d’utilisation sur les objets parents
  • Propriétaire de la table, du schéma parent ou du catalogue parent, avec des privilèges d’utilisation sur les objets parents
  • Administrateur de metastore
Gérez les wikis et commentaires : créez, modifiez, publiez ou dépubliez des wikis, acceptez ou rejetez les modifications suggérées, et supprimez tout commentaire L'un des suivants :
  • MANAGE sur la table, le schéma ou le catalogue, avec des privilèges d’utilisation sur les objets parents
  • Propriétaire de la table, du schéma parent ou du catalogue parent, avec des privilèges d’utilisation sur les objets parents
  • Administrateur de metastore

Créer un wiki

Pour créer un wiki, vous avez besoin des privilèges pour gérer les wikis sur cette table. Voir Autorisations.

Vous pouvez créer un wiki manuellement ou en rédiger un avec Genie Code.

Warning

Les données wiki sont chiffrées au repos avec des clés gérées par Microsoft. Les wikis ne prennent pas en charge le chiffrement avec des clés gérées par le client (CMK). N’incluez pas les PII (informations personnelles identifiables), les données soumises à réglementation ou d’autres informations sensibles dans les descriptions wiki ou le corps des pages.

  1. Dans l’Explorateur de catalogue, ouvrez la table.

  2. Dans l’onglet Aperçu , cliquez sur Créer un wiki. Si vous avez fermé la bannière Créer un wiki, cliquez sur l’icône du menu Kebab. en haut à droite de la page et sélectionnez Créer un wiki à la place. Si le tableau contient un commentaire existant, cela préremplit le corps de la page du wiki.

    La bannière Créer un wiki au-dessus de la description d’un tableau dans l’onglet Aperçu

  3. Ajoutez le contenu wiki :

    • Pour rédiger manuellement, remplissez la Description et le corps de la page, et ajoutez les sources.
    • Pour rédiger avec Genie Code, utilisez le volet Genie Code dans l’éditeur wiki. Attachez des fichiers ou un autre contexte pour que Genie Code puisse s’appuyer dessus. Voir Le code Genie.
  4. Cliquez sur Enregistrer en tant que brouillon pour continuer à travailler sur le wiki, ou cliquez sur Publier pour le rendre visible à tous ceux qui peuvent consulter les métadonnées du tableau.

Après avoir publié un wiki, il apparaît en haut de l’onglet Aperçu du tableau, et la Description du tableau passe à l’onglet Détails .

Modifier et publier les wikis

Pour modifier, publier ou dépublier un wiki, vous avez besoin des privilèges nécessaires pour gérer les wikis dans la table. Voir Autorisations.

  1. Dans l’Explorateur de catalogue, ouvrez la table.

  2. Sur le wiki, cliquez sur Modifier.

  3. Effectuez vos modifications, puis cliquez sur Enregistrer pour les sauvegarder, ou cliquez sur Publier pour rendre visible un brouillon de wiki.

    Un brouillon wiki en mode édition, avec les boutons Annuler, Enregistrer et Publier

Pour masquer un wiki publié sans en perdre le contenu, cliquez sur Modifier, sur le menu kebab, puis sur Dépublier. Le wiki revient à un brouillon que seuls les utilisateurs pouvant consulter les brouillons peuvent voir. Jusqu’à ce que vous publiiez à nouveau le wiki, la Description du tableau apparaît en haut de l’onglet Aperçu .

L’option Dépublier dans le menu kebab d’un wiki publié en mode édition

Collaborez sur un wiki

Toute personne pouvant consulter un wiki publié peut y collaborer. Voir Autorisations.

  • Commentaire : Posez des questions ou ajoutez du contexte. Vous pouvez modifier ou supprimer vos propres commentaires.
  • Suggérer des modifications : suggérer des modifications au corps de la page du wiki. Cliquez sur Suggérer, modifiez le corps de la page, puis cliquez sur Enregistrer. Un utilisateur disposant des privilèges pour gérer le wiki accepte ou rejette la suggestion.
  • React : Votez positivement ou négativement pour le wiki afin d’indiquer s’il a été utile.

Wikis et commentaires de tableaux

Un wiki ne remplace pas le commentaire de la table, donc les pipelines existants qui lisent ou écrivent des commentaires continuent de fonctionner :

  • Vous pouvez toujours définir le commentaire avec COMMENT ON TABLE ou ALTER TABLE. Le commentaire apparaît toujours dans information_schema et dans le champ Description de l’Explorateur de catalogue.
  • Lorsque vous créez un wiki, le commentaire existant de la table sert de contenu initial au corps de la page du wiki. Après cela, le wiki et le commentaire sont indépendants. Les modifications de l’un ne mettent pas à jour l’autre.

Pour en savoir plus sur les commentaires dans les tableaux, voir Ajouter des commentaires aux données et aux ressources IA.

Limitations

  • Les wikis ne sont disponibles que sur des tables. Les wikis sur les colonnes, schémas, catalogues et autres objets sécurisés ne sont pas pris en charge.
  • Chaque tableau peut avoir un wiki.
  • Les wikis ne sont pas disponibles dans les régions Azure Government, Azure China ou FedRAMP.