COMMENT

Fügt einen Kommentar hinzu oder überschreibt einen bestehenden Kommentar zu einem bestehenden Objekt.

Kommentare können zu allen Objekten (Benutzer, Rollen, Warehouses, Datenbanken, Tabellen usw.) hinzugefügt werden. Mit diesem Befehl können Sie auch Kommentare zu einzelnen Tabellenspalten hinzufügen, aber nicht zu Einschränkungen für Spalten.

Syntax

COMMENT [ IF EXISTS ] ON <object_type> <object_name> IS '<string_literal>';

COMMENT [ IF EXISTS ] ON COLUMN <table_name>.<column_name> IS '<string_literal>';

Parameter

ON object_type object_name

Fügt dem Objekt des angegebenen Typs (z. B. TABLE, SCHEMA, VIEW usw.) einen Kommentar mit dem angegebenen Bezeichner hinzu.

Wenn der Bezeichner Leerzeichen oder Sonderzeichen enthält, muss die gesamte Zeichenfolge in doppelte Anführungszeichen gesetzt werden. Bei Bezeichnern, die in doppelte Anführungszeichen eingeschlossen sind, ist auch die Groß- und Kleinschreibung zu beachten.

Weitere Informationen dazu finden Sie unter Anforderungen an Bezeichner.

ON COLUMN table_name.column_name

Fügt einen Kommentar zu der angegebenen Tabellenspalte hinzu.

Wenn der Bezeichner Leerzeichen oder Sonderzeichen enthält, muss die gesamte Zeichenfolge in doppelte Anführungszeichen gesetzt werden. Bei Bezeichnern, die in doppelte Anführungszeichen eingeschlossen sind, ist auch die Groß- und Kleinschreibung zu beachten.

Weitere Informationen dazu finden Sie unter Anforderungen an Bezeichner.

IS string_literal

Gibt den Kommentar an, der hinzugefügt werden soll.

Standard: NULL

Nutzungshinweise

  • Sie können auch Kommentare hinzufügen oder ändern, wenn Sie Objekte erstellen oder ändern:

    • Um einen Kommentar hinzuzufügen, geben Sie den Parameter COMMENT in den Befehlen CREATE <Objekt> oder ALTER <Objekt> an.

    • Um einen bestehenden Kommentar zu ändern, geben Sie den Parameter COMMENT im Befehl ALTER <Objekt> an.

  • Für das Hinzufügen oder Ändern von Kommentaren zu Tabellenspalten wird eine etwas andere Syntax verwendet:

    • Um bei der Erstellung einen Kommentar hinzuzufügen, folgen Sie der Spaltendeklaration mit dem Schlüsselwort COMMENT (nicht Eigenschaft).

    • Um einen Kommentar zu ändern, verwenden Sie diesen Befehl.

  • Um einen Kommentar zu einer Einschränkung hinzuzufügen, verwenden Sie die Befehle CREATE TABLE oder CREATE | ALTER TABLE … CONSTRAINT.

  • Die Ausgabe von DESCRIBE TABLE zeigt keine Kommentare für Tabelleneinschränkungen, wie z. B. mehrspaltige Primärschlüssel. Um diese Kommentare zu sehen, fragen Sie die Ansicht TABLE_CONSTRAINTS ab.

  • Metadaten:

    Achtung

    Kunden müssen sicherstellen, dass bei der Nutzung des Snowflake-Dienstes keine personenbezogenen Daten (außer für ein Objekt „User“), sensible Daten, exportkontrollierte Daten oder andere regulierte Daten als Metadaten eingegeben werden. Weitere Informationen dazu finden Sie unter Metadatenfelder in Snowflake.

Beispiele

Erstellen Sie ein Schema mit einem Kommentar und überschreiben Sie dann den Kommentar:

CREATE SCHEMA my_schema COMMENT='this is comment1';

SHOW SCHEMAS LIKE 'my_schema';

+-------------------------------+-----------+------------+------------+---------------+---------+------------------+---------+----------------+------+
| created_on                    | name      | is_default | is_current | database_name | owner   | comment          | options | retention_time | ...  |
|-------------------------------+-----------+------------+------------+---------------+---------+------------------+---------+----------------+------|
| 2025-02-26 12:08:52.363 -0800 | MY_SCHEMA | N          | Y          | MY_DB         | MY_ROLE | this is comment1 |         | 1              |  ... |
+-------------------------------+-----------+------------+------------+---------------+---------+------------------+---------+----------------+------+

COMMENT ON SCHEMA my_schema IS 'now comment2';

SHOW SCHEMAS LIKE 'my_schema';

+-------------------------------+-----------+------------+------------+---------------+---------+--------------+---------+----------------+-----+
| created_on                    | name      | is_default | is_current | database_name | owner   | comment      | options | retention_time | ... |
|-------------------------------+-----------+------------+------------+---------------+---------+--------------+---------+----------------+-----+
| 2025-02-26 12:08:52.363 -0800 | MY_SCHEMA | N          | Y          | MY_DB         | MY_ROLE | now comment2 |         | 1              | ... |
+-------------------------------+-----------+------------+------------+---------------+---------+--------------+---------+----------------+-----+

Erstellen Sie eine Tabelle mit einem Kommentar zu einer Tabellenspalte und überschreiben Sie dann den Kommentar:

CREATE OR REPLACE TABLE test_comment_table_column(my_column STRING COMMENT 'this is comment3');

DESC TABLE test_comment_table_column;

+-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+------------------+-------------+----------------+
| name      | type              | kind   | null? | default | primary key | unique key | check | expression | comment          | policy name | privacy domain |
|-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+------------------+-------------+----------------|
| MY_COLUMN | VARCHAR(16777216) | COLUMN | Y     | NULL    | N           | N          | NULL  | NULL       | this is comment3 | NULL        | NULL           |
+-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+------------------+-------------+----------------+

COMMENT ON COLUMN test_comment_table_column.my_column IS 'now comment4';

DESC TABLE test_comment_table_column;

+-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+--------------+-------------+----------------+
| name      | type              | kind   | null? | default | primary key | unique key | check | expression | comment      | policy name | privacy domain |
|-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+--------------+-------------+----------------|
| MY_COLUMN | VARCHAR(16777216) | COLUMN | Y     | NULL    | N           | N          | NULL  | NULL       | now comment4 | NULL        | NULL           |
+-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+--------------+-------------+----------------+

Erstellen Sie eine Ansicht mit einem Kommentar und überschreiben Sie dann den Kommentar:

CREATE OR REPLACE VIEW test_comment_view COMMENT='this is comment5' AS (SELECT * FROM test_comment_table_column);

SHOW VIEWS LIKE 'test_comment_view';

+-------------------------------+-------------------+----------+---------------+-------------+---------+------------------+-----+
| created_on                    | name              | reserved | database_name | schema_name | owner   | comment          | ... |
|-------------------------------+-------------------+----------+---------------+-------------+---------+------------------+-----+
| 2025-02-26 12:38:35.440 -0800 | TEST_COMMENT_VIEW |          | MY_DB         | MY_SCHEMA   | MY_ROLE | this is comment5 | ... |
+-------------------------------+-------------------+----------+---------------+-------------+---------+------------------+-----+

COMMENT ON VIEW test_comment_view IS 'now comment6';

SHOW VIEWS LIKE 'test_comment_view';

+-------------------------------+-------------------+----------+---------------+-------------+---------+--------------+-----+
| created_on                    | name              | reserved | database_name | schema_name | owner   | comment      | ... |
|-------------------------------+-------------------+----------+---------------+-------------+---------+--------------+-----+
| 2025-02-26 12:38:35.440 -0800 | TEST_COMMENT_VIEW |          | MY_DB         | MY_SCHEMA   | MY_ROLE | now comment6 | ... |
+-------------------------------+-------------------+----------+---------------+-------------+---------+--------------+-----+