Amazon Redshift 將不再支援從修補程式 198 開始建立新的 Python UDFs。現有 Python UDF 將繼續正常運作至 2026 年 6 月 30 日。如需詳細資訊，請參閱[部落格文章](https://aws.amazon.com/blogs/big-data/amazon-redshift-python-user-defined-functions-will-reach-end-of-support-after-june-30-2026/)。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# COMMENT
<a name="r_COMMENT"></a>

建立或變更有關資料庫物件的註解。

## 語法
<a name="r_COMMENT-synopsis"></a>

```
COMMENT ON
{
TABLE object_name |
COLUMN object_name.column_name |
CONSTRAINT constraint_name ON table_name |
DATABASE object_name |
VIEW object_name
}
IS 'text' | NULL
```

## Parameters
<a name="r_COMMENT-parameters"></a>

 *object\_name*   
要加上註解之資料庫物件的名稱。您可以新增註解至下列物件：  
+ TABLE
+ COLUMN (也會取用 *column\_name*)。
+ CONSTRAINT (也會取用 *constraint\_name* 和 *table\_name*)。
+ DATABASE
+ VIEW
+ 結構描述

IS '*text*' \| NULL  
您要對指定物件新增或取代的註解文字。*文字*字串是 TEXT 資料類型。以單引號括住註解。將值設定為 NULL 可移除註解文字。

 *column\_name*   
要加上註解之資料欄的名稱。COLUMN 的參數。接在 `object_name` 中指定的資料表後面。

 *constraint\_name*   
要加上註解之限制條件的名稱。CONSTRAINT 的參數。

 *table\_name*   
包含限制條件的資料表名稱。CONSTRAINT 的參數。

## 使用須知
<a name="r_COMMENT-usage-notes"></a>

您必須是超級使用者或資料庫物件的擁有者，才能新增或更新註解。

資料庫的註解僅適用於目前資料庫。如果您嘗試對不同資料庫加上註解，則會顯示警告訊息。對不存在的資料庫加上註解時，也會顯示同樣的警告。

不支援對外部資料表、外部欄和近期繫結檢視欄的註解。

## 範例
<a name="r_COMMENT-example"></a>

下列範例會將註解新增至 SALES 資料表。

```
COMMENT ON TABLE sales IS 'This table stores tickets sales data';
```

下列範例會在 SALES 資料表上顯示註解。

```
select obj_description('public.sales'::regclass);

obj_description
-------------------------------------
This table stores tickets sales data
```

下列範例會從 SALES 資料表中移除註解。

```
COMMENT ON TABLE sales IS NULL;
```

下列範例會將註解新增至 SALES 資料表的 EVENTID 資料欄。

```
COMMENT ON COLUMN sales.eventid IS 'Foreign-key reference to the EVENT table.';
```

下列範例會在 SALES 資料表的 EVENTID 資料欄 (資料欄編號 5) 上顯示註解。

```
select col_description( 'public.sales'::regclass, 5::integer );

col_description
-----------------------------------------
Foreign-key reference to the EVENT table.
```

下列範例會將描述性註解新增至 EVENT 資料表。

```
comment on table event is 'Contains listings of individual events.';
```

若要檢視註解，請查詢 PG\_DESCRIPTION 系統目錄。以下範例會傳回 EVENT 資料表的描述。

```
select * from pg_catalog.pg_description
where objoid =
(select oid from pg_class where relname = 'event'
and relnamespace =
(select oid from pg_catalog.pg_namespace where nspname = 'public') );

objoid | classoid | objsubid | description
-------+----------+----------+----------------------------------------
116658 |     1259 |        0 | Contains listings of individual events.
```