Partager via

COMMENT ON

  • Article

S’applique à :case marquée oui Databricks SQL case marquée oui Databricks Runtime

Définit un commentaire sur un catalogue, un schéma, une table, un partage, un destinataire, un fournisseur ou un volume.

Remarque

Si vous souhaitez ajouter un commentaire généré par l'IA pour une table ou une colonne de table managée par Unity Catalog, consultez Ajouter des commentaires générés par l'IA aux objets Unity Catalog.

Les catalogues, partages, destinataires et fournisseurs sont uniquement pris en charge dans Unity Catalog.

Pour définir le commentaire d’une colonne de table, utilisez ALTER TABLE.

Syntaxe

COMMENT ON
    { CATALOG catalog_name |
      COLUMN relation_name . column_name |
      CONNECTION connection_name |
      PROVIDER provider_name |
      RECIPIENT recipient_name |
      { SCHEMA | DATABASE } schema_name |
      SHARE share_name |
      TABLE table_name |
      VOLUME volume_name }
    IS comment

Paramètres

  • catalog_name

    Nom du catalogue où votre commentaire apparaît. Pour exécuter cette instruction, vous devez être le propriétaire du volume ou disposer du privilège MANAGE sur celui-ci.

  • relation_name. column_name

    S’applique à : coché oui Databricks SQL coché oui Databricks Runtime 16.1 et versions ultérieures

    Nom qualifié de la colonne sur laquelle vous commentez. relation_name doit identifier une vue ou une table. La relation_name ne doit pas inclure de spécification temporelle ou de spécification d’options.

    Si vous utilisez le Catalogue Unity, pour exécuter cette instruction, vous devez disposer du privilège MODIFY.

  • connection_name

    S’applique à :coche marquée oui Databricks SQL coche marquée oui Databricks Runtime 13.3 LTS et versions ultérieures cochée oui Unity Catalog uniquement

    Nom de la connexion où votre commentaire apparaît. Pour exécuter cette commande, vous devez être le propriétaire de la connexion ou avoir le privilège MANAGE sur celle-ci.

  • schema_name

    Nom du schéma où votre commentaire apparaît.

    Si vous utilisez Le catalogue Unity, pour exécuter cette instruction, vous devez être le propriétaire du schéma ou disposer du privilège MANAGE sur celui-ci..

  • table_name

    Nom de la table où vous ajoutez un commentaire. Le nom ne doit pas inclure de spécification temporelle ou de spécification d’options.

    Si vous utilisez le Catalogue Unity, pour exécuter cette instruction, vous devez disposer du privilège MODIFY.

  • share_name

    S’applique à :coche marquée oui Databricks SQL oui coché Databricks Runtime 11.3 LTS et versions ultérieures

    Nom du partage où votre commentaire apparaît. Pour exécuter cette instruction, vous devez être le propriétaire du partage.

  • recipient_name

    S’applique à :coche marquée oui Databricks SQL oui coché Databricks Runtime 11.3 LTS et versions ultérieures

    Nom du destinataire où votre commentaire apparaît. Pour exécuter cette instruction, vous devez être le propriétaire du destinataire.

  • provider_name

    S’applique à :coche marquée oui Databricks SQL oui coché Databricks Runtime 11.3 LTS et versions ultérieures

    Nom du fournisseur où votre commentaire apparaît. Pour exécuter cette instruction, vous devez être le propriétaire du fournisseur.

  • volume_name

    S’applique à :coche marquée oui Databricks SQL coche marquée oui Databricks Runtime 13.3 LTS et versions ultérieures

    Nom du volume où votre commentaire apparaît. Pour exécuter cette instruction, vous devez être le propriétaire du volume ou disposer du privilège MANAGE sur celui-ci.

  • commentaire

    Un littéral STRING ou NULL. Si vous spécifiez NULL, tous les commentaires existants sont supprimés.

Exemples

> COMMENT ON CATALOG my_catalog IS 'This is my catalog';

> COMMENT ON COLUMN my_table.c1 IS 'This is my column';

> COMMENT ON CONNECTION mysql_connection IS 'this is a mysql connection';

> COMMENT ON SCHEMA my_schema IS 'This is my schema';

> COMMENT ON TABLE my_table IS 'This is my table';

> COMMENT ON TABLE my_table IS NULL;

> COMMENT ON SHARE my_share IS 'A good share';

> COMMENT ON RECIPIENT my_recipient IS 'A good recipient';

> COMMENT ON PROVIDER my_provider IS 'A good provider';

> COMMENT ON PROVIDER my_volume IS 'Huge volume';