Mssql 테이블, 컬럼 코멘트 조회 - Mssql teibeul, keolleom komenteu johoe

mssql의 테이블 또는 컬럼에 코멘트 사용하는 방법에 대해 알아보겠습니다.

설명을 추가,변경,삭제는 해당 프로시저를 사용하여 사용합니다.

sp_addextendedproperty  - 추가

sp_updateextendedproperty  - 변경

sp_dropextendedproperty  - 삭제

Table Comment 추가 / 변경 / 삭제

-- [Table Comment Add]
exec sp_addextendedproperty 'MS_Description', '[TableComment]', 'USER', [Schema], 'TABLE', [TableName]

-- [Table Comment Update]
exec sp_updateextendedproperty 'MS_Description', '[TableComment]', 'USER', [Schema], 'TABLE', [TableName]

-- [Table Comment Drop]
exec sp_dropextendedproperty 'MS_Description',  'USER', [Schema], 'TABLE', [TableName]

* 코멘트 추가(Add) 후에는 변경(Update)/삭제(Drop) 만 가능합니다.

Table Comment 조회

-- [Table Comment Select]
select * from ::fn_listextendedproperty(null, ' SCHEMA', [Schema], 'TABLE', '[TableName]', default, default)

Column Comment 추가 / 변경 / 삭제

컬럼의 코멘트는 테이블에서 COLUMN값만 추가되어서 실행하며 됩니다.

-- [Column Comment Add]
exec sp_addextendedproperty 'MS_Description', '[TableComment]', 'USER', [Schema], 'TABLE', [TableName], 'COLUMN', [ColumnName]

-- [Column Comment Update]
exec sp_updateextendedproperty 'MS_Description', '[TableComment]', 'USER', [Schema], 'TABLE', [TableName], 'COLUMN', [ColumnName]

-- [Column Comment Drop]
exec sp_dropextendedproperty 'MS_Description',  'USER', [Schema], 'TABLE', [TableName], 'COLUMN', [ColumnName]

* 코멘트 추가(Add) 후에는 변경(Update)/삭제(Drop) 만 가능합니다.

Column Comment 조회

-- [Table Comment Select]
select * from ::fn_listextendedproperty(null, ' SCHEMA', [Schema], 'TABLE', '[TableName]', 'COLUMN', default)

홈tablecomment[mssql] 테이블 스키마 정보, 코멘트 조회 (show table schema fields or comment)

 SELECT 

 A.TABLE_NAME, 

 C.VALUE AS TABLE_COMMENT, 

 A.COLUMN_NAME, A.DATA_TYPE, 

 ISNULL( 

 CAST(A.CHARACTER_MAXIMUM_LENGTH AS VARCHAR), 

 CAST(A.NUMERIC_PRECISION AS VARCHAR) + ',' + 

 CAST(A.NUMERIC_SCALE AS VARCHAR) 

 ) AS COLUMN_LENGTH, 

 A.COLUMN_DEFAULT, A.IS_NULLABLE, 

 B.VALUE AS COLUM_COMMENT 

 FROM INFORMATION_SCHEMA.COLUMNS A 

 LEFT OUTER JOIN SYS.EXTENDED_PROPERTIES B ON B.major_id = object_id(A.TABLE_NAME) 

 AND A.ORDINAL_POSITION = B.minor_id 

 LEFT OUTER JOIN 

 ( 

 SELECT object_id(objname) AS TABLE_ID, VALUE 

 FROM ::FN_LISTEXTENDEDPROPERTY(NULL, 'User','dbo','table',NULL, NULL, NULL) 

 ) C ON object_id(A.TABLE_NAME) = C.TABLE_ID 

 WHERE A.TABLE_NAME IN ( 

 /* 여기에 테이블명 입력 (Enter table name here) */ 

 'BM_product', 

 'BM_Basket', 

 'BM_PurchaseMaster', 

 'BM_PurchaseSub', 

 'BM_PurchaseSubStateLog', 

 'BM_Category', 

 'BM_product' 

 )

 ORDER BY A.TABLE_NAME, A.ORDINAL_POSITION 

 ;

안녕하세요. 인천 토순이네 인토넷 입니다. 

오늘은 MSSQL Table 컬럼에 코멘트(설명) 작성 하는 법을 알아보겠습니다. 

Table을 생성 하고 시간이 지나면 자신이 만든 테이블이라도 기억이 가물가물 하죠 !

그래서 코멘트(설명)를 처음에 추가해 두면 시간이 지나도 해당 컬럼이 어떤 용도로 쓰이는지 알아보기가 편합니다.

그럼 직접 코멘트(설명)를 추가하는 법을 알아 보도록 하겠습니다. 

-----------------------------------------------------------------------------------------------------------------------------------

★ Column 코멘트 추가하기

EXEC sp_addextendedproperty 'MS_Description', '컬럼설명', 'USER', DBO, 'TABLE', 테이블명, 'COLUMN', 컬럼명

★ Column 코멘트 변경하기

EXEC sp_addextendedproperty sp_updateextendedproperty 'MS_Description', '컬럼설명수정', 'USER', DBO, 'TABLE', 테이블명, 'COLUMN', 컬럼명

★ Column 코멘트 삭제하기

EXEC sp_dropextendedproperty 'MS_Description', 'SCHEMA', DBO, 'TABLE', 테이블명, 'COLUMN', 컬럼명

★ Column 코멘트 조회하기

SELECT OBJTYPE, OBJNAME, NAME, VALUE
FROM ::FN_LISTEXTENDEDPROPERTY(NULL, 'SCHEMA', 'DBO', 'TABLE', '테이블명', 'COLUMN', DEFAULT)

---------------------------------------------------------------------------------------------------------------------

색상으로 표시 된 부분을 각자 추가하려는 테이블명 / 컬럼설명 / 컬럼명 으로 변경 하시면 됩니다.

자 ! 그럼 추가 또는 변경한 코멘트를 확인 해 볼까요 !?

조회를 했다면 

자신이 추가한 컬럼의 Value(코멘트)를 확인 할 수 있습니다.

SQL Server Management Studio를 사용하신다면 

해당 테이블을 클릭 테이블 스크립팅 > create > 새 쿼리 편집기 창을 클릭 해 보시면

create문 아래에 해당 코멘트가 추가 된 것을 확인 할 수 있습니다. 

테이블 코멘트 추가 / 변경 / 삭제 / 조회도 알아 보도록 하겠습니다. 

-----------------------------------------------------------------------------------------------------------------------------------

★ Table 코멘트 추가하기

EXEC sp_addextendedproperty 'MS_Description', '테이블설명', 'USER', DBO, 'TABLE', 테이블명

★ Table 코멘트 변경하기

EXEC sp_updateextendedproperty 'MS_Description', '테이블설명수정', 'USER', DBO, 'TABLE', 테이블명

★ Table 코멘트 삭제하기

EXEC sp_dropextendedproperty 'MS_Description', 'SCHEMA', DBO, 'TABLE', 테이블명, DEFAULT, DEFAULT

★ Table 코멘트 조회하기

SELECT
NAME ,(SELECT VALUE FROM SYS.EXTENDED_PROPERTIES WHERE MAJOR_ID = A.ID AND MINOR_ID = 0 ) COMMENT
FROM SYSOBJECTS A
WHERE RTRIM(A.XTYPE) = 'U'
ORDER BY NAME

---------------------------------------------------------------------------------------------------------------------