無料スクリプト配布のPHP.TO   PHPの実用的なtips PHPマニュアル MySQLマニュアル Apacheマニュアル PostgreSQLマニュアル マニュアル検索    

COMMENT

名前

COMMENT -- オブジェクトのコメントを定義する、または変更する

概要

COMMENT ON
{
  AGGREGATE 

agg_name

 (

agg_type

 [, ...] ) |
  CAST (

source_type

 AS 

target_type

) |
  COLLATION 

object_name

 |
  COLUMN 

relation_name

.

column_name

 |
  CONSTRAINT 

constraint_name

 ON 

table_name

 |
  CONVERSION 

object_name

 |
  DATABASE 

object_name

 |
  DOMAIN 

object_name

 |
  EXTENSION 

object_name

 |
  EVENT TRIGGER 

object_name

 |
  FOREIGN DATA WRAPPER 

object_name

 |
  FOREIGN TABLE 

object_name

 |
  FUNCTION 

function_name

 ( [ [ 

argmode

 ] [ 

argname

 ] 

argtype

 [, ...] ] ) |
  INDEX 

object_name

 |
  LARGE OBJECT 

large_object_oid

 |
  MATERIALIZED VIEW 

object_name

 |
  OPERATOR 

operator_name

 (

left_type

, 

right_type

) |
  OPERATOR CLASS 

object_name

 USING 

index_method

 |
  OPERATOR FAMILY 

object_name

 USING 

index_method

 |
  [ PROCEDURAL ] LANGUAGE 

object_name

 |
  ROLE 

object_name

 |
  RULE 

rule_name

 ON 

table_name

 |
  SCHEMA 

object_name

 |
  SEQUENCE 

object_name

 |
  SERVER 

object_name

 |
  TABLE 

object_name

 |
  TABLESPACE 

object_name

 |
  TEXT SEARCH CONFIGURATION 

object_name

 |
  TEXT SEARCH DICTIONARY 

object_name

 |
  TEXT SEARCH PARSER 

object_name

 |
  TEXT SEARCH TEMPLATE 

object_name

 |
  TRIGGER 

trigger_name

 ON 

table_name

 |
  TYPE 

object_name

 |
  VIEW 

object_name


} IS '

text

'

説明

COMMENT は、データベースオブジェクトに関するコメントを保存します。

各オブジェクトに保存できるコメント文字列は1つだけです。 ですので、コメントを編集するためには、同一オブジェクトに対して新しく COMMENT コマンドを発行してください。 コメントを削除するには、テキスト文字列の部分に NULL を記述してください。 オブジェクトが削除された時、コメントは自動的に削除されます。

ほとんどの種類のオブジェクトでは、オブジェクトの所有者のみがコメントを設定することができます。 ロールには所有者がありませんので、 COMMENT ON ROLE における規則は、スーパーユーザロールに対するコメント付けはスーパーユーザでなければならず、スーパーユーザ以外のロールに対するコメント付けは CREATEROLE を持たなければならないとなります。 当然ながらスーパーユーザは何にでもコメントを付けることができます。

コメントは、 psql \d 系のコマンドで表示することができます。 obj_description() col_description() shobj_description という名前の、 psql が使用する組み込み関数を使うように構築することで、他のユーザインタフェースを使ってコメントを取り出せるようになります ( 表9-55 を参照してください)。

パラメータ

object_name
relation_name . column_name
agg_name
constraint_name
function_name
operator_name
rule_name
trigger_name

コメントを付加するオブジェクトの名前です。 テーブル、集約、照合順、変換、ドメイン、外部テーブル、関数、インデックス、演算子、演算子クラス、演算子族、シーケンス、テキスト検索オブジェクト、データ型、ビューの名前は、スキーマ修飾することができます。 列にコメントを付与する場合、 relation_name はテーブル、ビュー、複合型、外部テーブルを参照するものでなければなりません。

agg_type

集約関数が演算する入力データ型です。 引数を持たない集約関数を参照する場合は、入力データ型のリストに * を指定してください。

source_type

キャストの変換元データ型の名前です。

target_type

キャストの変換先のデータ型の名前です。

argmode

関数の引数のモードで、 IN OUT INOUT VARIADIC のいずれかです。 省略時のデフォルトは IN です。 関数を識別するには入力引数のみが必要ですので、 COMMENT ON FUNCTION が実際には OUT 引数を無視することに注意してください。 したがって、 IN INOUT および VARIADIC 引数を列挙することで十分です。

argname

関数の引数の名前です。 関数の識別には引数データ型のみが必要ですので、 COMMENT ON FUNCTION が実際には引数の名前を無視することに注意してください。

argtype

もしあれば、関数の引数のデータ型(複数可、スキーマ修飾も可)です。

large_object_oid

ラージオブジェクトのOIDです。

left_type
right_type

演算子の引数のデータ型(スキーマ修飾も可)です。 右単項演算子、左単項演算子における存在しない引数については NONE と記述してください。

PROCEDURAL

これはノイズワードです。

text

追加するコメントです。文字列リテラルとして記述します。 コメントを削除する場合は NULL を記述します。

注釈

現在、コメントの閲覧に関するセキュリティ機構は存在しません。 データベースに接続したユーザは誰でも、そのデータベース内のオブジェクトのコメントを参照することができます。 データベース、ロール、テーブル空間などの共有オブジェクトに対するコメントは大域的に格納され、クラスタ内の任意のデータベースに接続した任意のユーザが共有オブジェクトに対するコメントをすべて見ることができます。 そのため、コメントにはセキュリティ的に重大な情報を記載してはいけません。

mytable テーブルにコメントを付けます。

COMMENT ON TABLE mytable IS 'This is my table.';

先ほどのコメントを削除します。

COMMENT ON TABLE mytable IS NULL;

その他の例をいくつか示します。

COMMENT ON AGGREGATE my_aggregate (double precision) IS 'Computes sample variance';
COMMENT ON CAST (text AS int4) IS 'Allow casts from text to int4';
COMMENT ON COLLATION "fr_CA" IS 'Canadian French';
COMMENT ON COLUMN my_table.my_column IS 'Employee ID number';
COMMENT ON CONVERSION my_conv IS 'Conversion to UTF8';
COMMENT ON CONSTRAINT bar_col_cons ON bar IS 'Constrains column col';
COMMENT ON DATABASE my_database IS 'Development Database';
COMMENT ON DOMAIN my_domain IS 'Email Address Domain';
COMMENT ON EXTENSION hstore IS 'implements the hstore data type';
COMMENT ON FOREIGN DATA WRAPPER mywrapper IS 'my foreign data wrapper';
COMMENT ON FOREIGN TABLE my_foreign_table IS 'Employee Information in other database';
COMMENT ON FUNCTION my_function (timestamp) IS 'Returns Roman Numeral';
COMMENT ON INDEX my_index IS 'Enforces uniqueness on employee ID';
COMMENT ON LANGUAGE plpython IS 'Python support for stored procedures';
COMMENT ON LARGE OBJECT 346344 IS 'Planning document';
COMMENT ON MATERIALIZED VIEW my_matview IS 'Summary of order history';
COMMENT ON OPERATOR ^ (text, text) IS 'Performs intersection of two texts';
COMMENT ON OPERATOR - (NONE, integer) IS 'Unary minus';
COMMENT ON OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees';
COMMENT ON OPERATOR FAMILY integer_ops USING btree IS 'all integer operators for btrees';
COMMENT ON ROLE my_role IS 'Administration group for finance tables';
COMMENT ON RULE my_rule ON my_table IS 'Logs updates of employee records';
COMMENT ON SCHEMA my_schema IS 'Departmental data';
COMMENT ON SEQUENCE my_sequence IS 'Used to generate primary keys';
COMMENT ON SERVER myserver IS 'my foreign server';
COMMENT ON TABLE my_schema.my_table IS 'Employee Information';
COMMENT ON TABLESPACE my_tablespace IS 'Tablespace for indexes';
COMMENT ON TEXT SEARCH CONFIGURATION my_config IS 'Special word filtering';
COMMENT ON TEXT SEARCH DICTIONARY swedish IS 'Snowball stemmer for swedish language';
COMMENT ON TEXT SEARCH PARSER my_parser IS 'Splits text into words';
COMMENT ON TEXT SEARCH TEMPLATE snowball IS 'Snowball stemmer';
COMMENT ON TRIGGER my_trigger ON my_table IS 'Used for RI';
COMMENT ON TYPE complex IS 'Complex number data type';
COMMENT ON VIEW my_view IS 'View of departmental costs';

互換性

標準SQLには COMMENT はありません。


powered by SEO.CUG.NET