SQL Server 2000+ でテーブルに説明/コメントを追加する方法

2024-04-04

SQL Server 2000 以降では、テーブルに説明やコメントを追加することができます。これは、テーブルの構造や用途を理解しやすくするために役立ちます。

方法

テーブルに説明/コメントを追加するには、以下の2つの方法があります。

拡張プロパティを使用する

拡張プロパティは、テーブルにユーザー定義の情報を追加するための機能です。説明/コメントを追加するには、以下の手順に従います。

SQL Server Management Studio (SSMS) を起動し、対象のデータベースに接続します。
オブジェクトエクスプローラーで、テーブルを展開します。
テーブル名を右クリックし、「プロパティ」を選択します。
「拡張プロパティ」ページで、「追加」ボタンをクリックします。
名前欄に「説明」など、わかりやすい名前を入力します。
値欄に、説明/コメントを入力します。
「OK」ボタンをクリックします。

例

EXEC sp_addextendedproperty
    @name = N'説明',
    @value = N'このテーブルは顧客情報を格納します。',
    @level0type = N'SCHEMA',
    @level0name = N'dbo',
    @level1type = N'TABLE',
    @level1name = N'Customers';

コメントを使用する

コメントは、SQL ステートメント内で記述することができ、そのステートメントの説明や補足情報を提供します。テーブルに説明/コメントを追加するには、以下の手順に従います。

SSMS を起動し、対象のデータベースに接続します。
新しいクエリウィンドウを開きます。
以下のSQL ステートメントを実行します。

ALTER TABLE テーブル名 COMMENT = '説明/コメント';

ALTER TABLE Customers COMMENT = 'このテーブルは顧客情報を格納します。';

どちらの方法を使用しても、テーブルに説明/コメントを追加することができます。拡張プロパティを使用する方法は、GUI で操作できるため、初心者にもおすすめです。一方、コメントを使用する方法は、より簡潔に記述することができます。

注意事項

拡張プロパティは、SQL Server 2000 以降でのみ使用できます。
コメントは、すべての SQL クライアントでサポートされているわけではありません。

-- テーブル作成
CREATE TABLE Customers (
    CustomerID int NOT NULL IDENTITY(1, 1),
    FirstName varchar(50) NOT NULL,
    LastName varchar(50) NOT NULL,
    Email varchar(100) NOT NULL
);

-- 説明/コメントを追加
EXEC sp_addextendedproperty
    @name = N'説明',
    @value = N'このテーブルは顧客情報を格納します。',
    @level0type = N'SCHEMA',
    @level0name = N'dbo',
    @level1type = N'TABLE',
    @level1name = N'Customers';

-- 説明/コメントを取得
SELECT *
FROM sys.extended_properties
WHERE object_id = OBJECT_ID('Customers');

-- テーブル作成
CREATE TABLE Customers (
    CustomerID int NOT NULL IDENTITY(1, 1),
    FirstName varchar(50) NOT NULL,
    LastName varchar(50) NOT NULL,
    Email varchar(100) NOT NULL
);

-- 説明/コメントを追加
ALTER TABLE Customers COMMENT = 'このテーブルは顧客情報を格納します。';

-- 説明/コメントを取得
SELECT TABLEPROPERTY(OBJECT_ID('Customers'), 'Comment');