COMMENTは、データベースオブジェクトに関するコメントを格納します。
説明
COMMENTは、データベースオブジェクトに関するコメントを格納します。
オブジェクトごとに1つのコメント文字列のみが保存されるため、コメントを変更するには、同じオブジェクトに対して新しいcommentコマンドを発行します。 コメントを削除するには、テキスト文字列の代わりにNULLを入力します。 オブジェクトが削除されると、コメントは自動的に削除されます。
ほとんどの種類のオブジェクトでは、オブジェクトの所有者だけがコメントを設定できます。 ロールには所有者がないため、COMMENT ON ROLEのルールでは、スーパーユーザーロールにコメントするにはスーパーユーザーであるか、非スーパーユーザーロールにコメントするにはCREATEROLE権限が必要です。 同様に、アクセスメソッドにも所有者がありません。アクセスメソッドにコメントするには、スーパーユーザーである必要があります。 もちろん、スーパーユーザーは何でもコメントできます。
コメントは、\dのコマンドファミリを使用して表示できます。 コメントを取得するための他のユーザインタフェースは、psqlusesと同じ組み込み関数、すなわち、obj_description、col_description、およびshobj_descriptionの上に構築することができる。
概要
コメント
{
アクセスメソッドobject_name |
AGGREGATE aggregate_name ( aggregate_signature ) |
CAST (source_type AS target_type) |
COLLATION object_name |
COLUMN relation_name.column_name |
CONSTRAINT constraint_name ON table_name |
CONSTRAINT constraint_name ON DOMAIN domain_name |
変換object_name |
DATABASE object_name |
ドメインobject_name |
拡張object_name |
イベントトリガーobject_name |
外国データラッパーobject_name |
FOREIGN TABLE object_name |
FUNCTION function_name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] |
INDEX object_name |
大きなオブジェクトlarge_object_oid |
MATERIALIZED VIEW object_name |
OPERATOR operator_name (left_type, right_type) |
index_methodを使用したオペレータークラスobject_name |
index_methodを使用したオペレーター家族object_name |
ポリシーpolicy_name ON table_name |
[PROCEDURAL] 言語object_name |
PROCEDURE procedure_name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] |
出版物object_name |
ROLE object_name |
ROUTINE routine_name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) |
ルールrule_name ON table_name |
SCHEMA object_name |
シーケンスobject_name |
サーバーobject_name |
STATISTICS object_name |
サブスクリプションobject_name |
テーブルobject_name |
TABLESPACE object_name |
テキスト検索構成object_name |
テキスト検索辞書object_name |
テキスト検索パーサーobject_name |
テキスト検索テンプレートobject_name |
type_name LANGUAGE lang_nameの変換 |
TRIGGER trigger_name ON table_name |
TYPE object_name |
オブジェクト名を表示
} IS 'text'
aggregate_signatureは次のとおりです。
* |
[argmode ] [ argname ] argtype [ , ... ] |
[ [ argmode ] [ argname ] argtype [ , ... ] ] ORDER BY [ argmode ] [ argname ] argtype [ , ... ] パラメーター
object_name relation_nameです。 column_name aggregate_name constraint_name function_name operator_name policy_name procedure_name routine_name rule_name trigger_name: コメントするオブジェクトの名前。 スキーマ内に存在するオブジェクトの名前 (テーブル、関数など) は、スキーマ修飾できます。 列にコメントする場合、relation_nameはテーブル、ビュー、複合型、または外部テーブルを参照する必要があります。
table_name domain_name: 制約、トリガー、ルール、またはポリシーに関するコメントを作成する場合、これらのパラメーターは、そのオブジェクトが定義されているテーブルまたはドメインの名前を指定します。
source_type: キャストのソースデータ型の名前。
target_type: キャストのターゲットデータ型の名前。
argmode: 関数、プロシージャ、または集計引数のモード: IN、OUT、INOUT、またはVARIADIC。 省略した場合、デフォルトはINです。 関数のIDを決定するために入力引数のみが必要なため、COMMENTは実際にはOUT引数に注意を払っていません。 したがって、IN、INOUT、およびVARIADIC引数をリストするだけで十分です。
argname: 関数、プロシージャ、または集計引数の名前。 COMMENTは、引数のデータ型のみが関数のIDを決定するために必要なため、実際には引数名に注意を払っていないことに注意してください。
argtype: 関数、プロシージャ、または集計引数のデータ型。
large_object_oid: ラージオブジェクトのOID。
left_type right_type: 演算子の引数のデータ型 (オプションでスキーマ修飾) 。 プレフィックス演算子の欠落している引数に対してNONEを記述します。
PROCEDURAL: これはノイズの言葉です。
type_name: 変換のデータ型の名前。
lang_name: 変換の言語の名前。
text: 新しいコメントを文字列として記述します。 コメントを削除する場合は、NULLとして入力します。
注
現在、コメントを表示するためのセキュリティメカニズムはありません。データベースに接続しているユーザーは、そのデータベース内のオブジェクトのすべてのコメントを見ることができます。 データベース、ロール、テーブルスペースなどの共有オブジェクトの場合、コメントはグローバルに格納されるため、クラスター内の任意のデータベースに接続しているユーザーは、共有オブジェクトのすべてのコメントを表示できます。 したがって、セキュリティに重要な情報をコメントに入れないでください。
例
テーブルmytableにコメントを添付します。
COMMENT ON TABLE IS 'これは私のテーブルです。';もう一度削除する:
COMMENT ON TABLE IS NULL;いくつかのより多くの例:
アクセス方法に関するコメントジンは「ginインデックスアクセス方法」です。
AGGREGATE my_aggregate (倍精度) のコメントは「サンプル変数の計算」です。
COMMENT ON CAST (テキストAS int4) は「テキストからint4へのキャストを許可する」です。
コレクションに関するコメント「fr_CA」は「カナダフランス人」です。
列のコメントmy_table.my_columnは「従業員ID番号」です。
変換に関するコメントmy_convは「UTF8への変換」です。
COMMENT ON CONSTRAINT bar_col_cons ON bar IS 'Constrains column ';
CONSTRAINT dom_col_constr ON DOMAIN dom IS 'Constrains col of DOMAIN ';
データベースに関するコメントmy_databaseは「開発データベース」です。
ドメインに関するコメントmy_domainは「電子メールアドレスドメイン」です。
イベントトリガーについてのコメントabort_ddlは「すべてのDDLコマンドを無効にします」です。
拡張に関するコメントhstore IS 'hstoreデータタイプを実装します';
外交データラッパーのコメントmywrapperは「私の外国のデータラッパー」です。
FOREIGN TABLEのコメントmy_foreign_tableは「他のデータベースの従業員情報」です。
COMMENT ON FUNCTION my_function (timestamp) は「ローマ数字を返します」です。
インデックスのコメントmy_indexは「従業員IDの一意性を強化する」です。
言語に関するコメントplpythonは「ストアドプロシージャのPythonサポート」です。
大きなオブジェクトの346344に関するコメントは「計画文書」です。
MATERIALIZED VIEWに関するコメントmy_matviewは「注文履歴の要約」です。
オペレーターのコメント ^ (テキスト、テキスト) は「2つのテキストの交差を実行する」です。
オペレーターに関するコメント-(なし、整数) は「単一のマイナス」です。
btreeを使用しているオペレータークラスのコメントint4opsは「btreesの4バイト整数演算子」です。
オペレータファミリーに関するコメントbtreeを使用しているのは「btreesのすべての整数演算子」です。
ポリシーのコメントmy_policy ON mytable IS 'ユーザーによる行のフィルタリング;
手順に関するコメントmy_proc (整数、整数) は「レポートを実行」します。
出版物のalltablesに関するコメントは「すべてのテーブルですべての操作を公開します」です。
ROLE my_roleに関するコメントは「財務テーブルの管理グループ」です。
ルーチンのコメントmy_routine (integer, integer) IS 'ルーチンを実行します (これは関数またはプロシージャです)';
COMMENT ON RULE my_rule ON my_tableは「従業員レコードのログ更新」です。
SCHEMA my_schemaのコメントは「部門データ」です。
シーケンスのコメントmy_sequenceは「プライマリキーの生成に使用されます」。
サーバーに関するコメントmyserverは「私の外国人サーバー」です。
統計に関するコメントmy_statisticsは「プランナーの列の推定を改善します」です。
サブスクリプションのコメントalltablesは「すべてのテーブルのすべての操作のサブスクリプション」です。
TABLE my_schema.my_tableのコメントは「従業員情報」です。
タブレットスペースのコメントmy_tablespaceは「インデックスのテーブルスペース」です。
テキスト検索構成に関するコメントmy_configは「特別な単語のフィルタリング」です。
テキスト検索部門のコメントスウェーデン語は「スウェーデン語のスノーボールステマー」です。
テキスト検索パーサーmy_parserに関するコメントは「テキストを単語に分割します」です。
テキスト検索に関するコメントTEMPLATEスノーボールは「スノーボールステマー」です。
hstore言語の変換に関するコメントplpythonuは「hstoreとPython dictの間の変換」です。
COMMENT ON TRIGGER my_trigger ON my_tableは「RIに使用されます」。
COMMENT ON TYPEコンプレックスは「複素数データタイプ」です。
ビューのコメントmy_viewは「部門のコストのビュー」です。