COMMENT¶
기존 오브젝트에 대한 설명을 추가하거나 기존 설명을 덮어씁니다.
모든 오브젝트(사용자, 역할, 웨어하우스, 데이터베이스, 테이블 등)에 설명을 추가할 수 있습니다. 개별 테이블 열에도 설명을 추가할 수 있습니다.
구문¶
COMMENT [IF EXISTS] ON <object_type> <object_name> IS '<string_literal>';
COMMENT [IF EXISTS] ON COLUMN <table_name>.<column_name> IS '<string_literal>';
사용법 노트¶
이 명령 외에도, 오브젝트를 만들거나 변경할 때 설명을 추가할 수 있습니다.
CREATE <오브젝트> 또는 ALTER <오브젝트> 명령에
COMMENT매개 변수를 지정합니다.언제든지 ALTER <오브젝트> 명령에
COMMENT매개 변수를 사용하여 기존 설명을 변경할 수 있습니다.
테이블 열에 설명을 추가하는 데는 약간 다른 구문이 사용됩니다.
COMMENT키워드(속성 아님)를 사용하여 열 선언에 이어 생성 시 설명을 추가할 수 있습니다.그런 다음 이 명령을 사용하여 설명을 변경할 수 있습니다.
메타데이터 관련:
주의
고객은 Snowflake 서비스를 사용할 때 개인 데이터(사용자 오브젝트 제외), 민감한 데이터, 수출 통제 대상 데이터 또는 기타 규제 데이터가 메타데이터로 입력되지 않도록 해야 합니다. 자세한 내용은 Snowflake의 메타데이터 필드 섹션을 참조하십시오.
예¶
처음에 설명이 있는 스키마를 만든 다음 설명 덮어쓰기:
CREATE SCHEMA my_schema COMMENT='this is comment1'; SHOW SCHEMAS LIKE '%schema%'; +-------------------------------+--------------------+------------+------------+---------------+--------------+-----------------------------------------------------------+---------+----------------+ | created_on | name | is_default | is_current | database_name | owner | comment | options | retention_time | |-------------------------------+--------------------+------------+------------+---------------+--------------+-----------------------------------------------------------+---------+----------------| | 2018-06-26 11:06:55.994 -0700 | INFORMATION_SCHEMA | N | N | YDB | | Views describing the contents of schemas in this database | | 1 | | 2018-06-26 11:06:30.532 -0700 | MY_SCHEMA | N | Y | YDB | SYSADMIN | this is comment1 | | 1 | +-------------------------------+--------------------+------------+------------+---------------+--------------+-----------------------------------------------------------+---------+----------------+ COMMENT ON SCHEMA my_schema IS 'now comment2'; SHOW SCHEMAS LIKE '%schema%'; +-------------------------------+--------------------+------------+------------+---------------+--------------+-----------------------------------------------------------+---------+----------------+ | created_on | name | is_default | is_current | database_name | owner | comment | options | retention_time | |-------------------------------+--------------------+------------+------------+---------------+--------------+-----------------------------------------------------------+---------+----------------| | 2018-06-26 11:06:55.994 -0700 | INFORMATION_SCHEMA | N | N | YDB | | Views describing the contents of schemas in this database | | 1 | | 2018-06-26 11:06:30.532 -0700 | MY_SCHEMA | N | Y | YDB | SYSADMIN | now comment2 | | 1 | +-------------------------------+--------------------+------------+------------+---------------+--------------+-----------------------------------------------------------+---------+----------------+
테이블 열에 설명이 있는 테이블을 만든 다음 설명 덮어쓰기:
CREATE TABLE my_table(my_column string COMMENT 'this is comment3'); DESC TABLE my_table; +-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+------------------+ | name | type | kind | null? | default | primary key | unique key | check | expression | comment | |-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+------------------| | MY_COLUMN | VARCHAR(16777216) | COLUMN | Y | NULL | N | N | NULL | NULL | this is comment3 | +-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+------------------+ COMMENT ON COLUMN my_table.my_column IS 'now comment4'; DESC TABLE my_table; +-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+--------------+ | name | type | kind | null? | default | primary key | unique key | check | expression | comment | |-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+--------------| | MY_COLUMN | VARCHAR(16777216) | COLUMN | Y | NULL | N | N | NULL | NULL | now comment4 | +-----------+-------------------+--------+-------+---------+-------------+------------+-------+------------+--------------+
설명이 있는 뷰를 만든 다음 설명 덮어쓰기:
CREATE VIEW my_view comment='this is comment5' AS (SELECT * FROM my_table); SHOW VIEWS LIKE 'my_view'; +-------------------------------+---------+----------+---------------+-------------+----------+------------------+-----------------------------------------------------------------------------+-----------+ | created_on | name | reserved | database_name | schema_name | owner | comment | text | is_secure | |-------------------------------+---------+----------+---------------+-------------+----------+------------------+-----------------------------------------------------------------------------+-----------| | 2018-06-26 11:11:01.048 -0700 | MY_VIEW | | YDB | MY_SCHEMA | SYSADMIN | this is comment5 | CREATE VIEW my_view comment='this is comment5' AS (SELECT * FROM my_table); | false | +-------------------------------+---------+----------+---------------+-------------+----------+------------------+-----------------------------------------------------------------------------+-----------+ COMMENT ON VIEW my_view IS 'now comment6'; SHOW VIEWS LIKE 'my_view'; +-------------------------------+---------+----------+---------------+-------------+----------+--------------+-----------------------------------------------------------------------------+-----------+ | created_on | name | reserved | database_name | schema_name | owner | comment | text | is_secure | |-------------------------------+---------+----------+---------------+-------------+----------+--------------+-----------------------------------------------------------------------------+-----------| | 2018-06-26 11:11:01.048 -0700 | MY_VIEW | | YDB | MY_SCHEMA | SYSADMIN | now comment6 | CREATE VIEW my_view comment='this is comment5' AS (SELECT * FROM my_table); | false | +-------------------------------+---------+----------+---------------+-------------+----------+--------------+-----------------------------------------------------------------------------+-----------+