@@ -3,7 +3,7 @@ doc/src/sgml/ref/comment.sgml
3
3
PostgreSQL documentation
4
4
-->
5
5
6
- <refentry id="SQL-COMMENT ">
6
+ <refentry id="sql-comment ">
7
7
<!--==========================orignal english content==========================
8
8
<indexterm zone="sql-comment">
9
9
<primary>COMMENT</primary>
@@ -65,8 +65,10 @@ COMMENT ON
65
65
OPERATOR FAMILY <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> |
66
66
POLICY <replaceable class="parameter">policy_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
67
67
[ PROCEDURAL ] LANGUAGE <replaceable class="parameter">object_name</replaceable> |
68
+ PROCEDURE <replaceable class="parameter">procedure_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] |
68
69
PUBLICATION <replaceable class="parameter">object_name</replaceable> |
69
70
ROLE <replaceable class="parameter">object_name</replaceable> |
71
+ ROUTINE <replaceable class="parameter">routine_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] |
70
72
RULE <replaceable class="parameter">rule_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
71
73
SCHEMA <replaceable class="parameter">object_name</replaceable> |
72
74
SEQUENCE <replaceable class="parameter">object_name</replaceable> |
@@ -95,45 +97,6 @@ ____________________________________________________________________________-->
95
97
<synopsis>
96
98
COMMENT ON
97
99
{
98
- ACCESS METHOD <replaceable class="parameter">object_name</replaceable> |
99
- AGGREGATE <replaceable class="parameter">aggregate_name</replaceable> ( <replaceable>aggregate_signature</replaceable> ) |
100
- CAST (<replaceable>source_type</replaceable> AS <replaceable>target_type</replaceable>) |
101
- COLLATION <replaceable class="parameter">object_name</replaceable> |
102
- COLUMN <replaceable class="parameter">relation_name</replaceable>.<replaceable class="parameter">column_name</replaceable> |
103
- CONSTRAINT <replaceable class="parameter">constraint_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
104
- CONSTRAINT <replaceable class="parameter">constraint_name</replaceable> ON DOMAIN <replaceable class="parameter">domain_name</replaceable> |
105
- CONVERSION <replaceable class="parameter">object_name</replaceable> |
106
- DATABASE <replaceable class="parameter">object_name</replaceable> |
107
- DOMAIN <replaceable class="parameter">object_name</replaceable> |
108
- EXTENSION <replaceable class="parameter">object_name</replaceable> |
109
- EVENT TRIGGER <replaceable class="parameter">object_name</replaceable> |
110
- FOREIGN DATA WRAPPER <replaceable class="parameter">object_name</replaceable> |
111
- FOREIGN TABLE <replaceable class="parameter">object_name</replaceable> |
112
- FUNCTION <replaceable class="parameter">function_name</replaceable> ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) |
113
- INDEX <replaceable class="parameter">object_name</replaceable> |
114
- LARGE OBJECT <replaceable class="parameter">large_object_oid</replaceable> |
115
- MATERIALIZED VIEW <replaceable class="parameter">object_name</replaceable> |
116
- OPERATOR <replaceable class="parameter">operator_name</replaceable> (<replaceable class="parameter">left_type</replaceable>, <replaceable class="parameter">right_type</replaceable>) |
117
- OPERATOR CLASS <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> |
118
- OPERATOR FAMILY <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> |
119
- POLICY <replaceable class="parameter">policy_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
120
- [ PROCEDURAL ] LANGUAGE <replaceable class="parameter">object_name</replaceable> |
121
- ROLE <replaceable class="parameter">object_name</replaceable> |
122
- RULE <replaceable class="parameter">rule_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
123
- SCHEMA <replaceable class="parameter">object_name</replaceable> |
124
- SEQUENCE <replaceable class="parameter">object_name</replaceable> |
125
- SERVER <replaceable class="parameter">object_name</replaceable> |
126
- TABLE <replaceable class="parameter">object_name</replaceable> |
127
- TABLESPACE <replaceable class="parameter">object_name</replaceable> |
128
- TEXT SEARCH CONFIGURATION <replaceable class="parameter">object_name</replaceable> |
129
- TEXT SEARCH DICTIONARY <replaceable class="parameter">object_name</replaceable> |
130
- TEXT SEARCH PARSER <replaceable class="parameter">object_name</replaceable> |
131
- TEXT SEARCH TEMPLATE <replaceable class="parameter">object_name</replaceable> |
132
- TRANSFORM FOR <replaceable>type_name</replaceable> LANGUAGE <replaceable>lang_name</replaceable> |
133
- TRIGGER <replaceable class="parameter">trigger_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
134
- TYPE <replaceable class="parameter">object_name</replaceable> |
135
- VIEW <replaceable class="parameter">object_name</replaceable>
136
- } IS '<replaceable class="parameter">text</replaceable>'
137
100
ACCESS METHOD <replaceable class="parameter">object_name</replaceable> |
138
101
AGGREGATE <replaceable class="parameter">aggregate_name</replaceable> ( <replaceable>aggregate_signature</replaceable> ) |
139
102
CAST (<replaceable>source_type</replaceable> AS <replaceable>target_type</replaceable>) |
@@ -157,8 +120,10 @@ COMMENT ON
157
120
OPERATOR FAMILY <replaceable class="parameter">object_name</replaceable> USING <replaceable class="parameter">index_method</replaceable> |
158
121
POLICY <replaceable class="parameter">policy_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
159
122
[ PROCEDURAL ] LANGUAGE <replaceable class="parameter">object_name</replaceable> |
123
+ PROCEDURE <replaceable class="parameter">procedure_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] |
160
124
PUBLICATION <replaceable class="parameter">object_name</replaceable> |
161
125
ROLE <replaceable class="parameter">object_name</replaceable> |
126
+ ROUTINE <replaceable class="parameter">routine_name</replaceable> [ ( [ [ <replaceable class="parameter">argmode</replaceable> ] [ <replaceable class="parameter">argname</replaceable> ] <replaceable class="parameter">argtype</replaceable> [, ...] ] ) ] |
162
127
RULE <replaceable class="parameter">rule_name</replaceable> ON <replaceable class="parameter">table_name</replaceable> |
163
128
SCHEMA <replaceable class="parameter">object_name</replaceable> |
164
129
SEQUENCE <replaceable class="parameter">object_name</replaceable> |
@@ -291,6 +256,14 @@ ____________________________________________________________________________-->
291
256
<term><replaceable class="parameter">policy_name</replaceable></term>
292
257
____________________________________________________________________________-->
293
258
<term><replaceable class="parameter">policy_name</replaceable></term>
259
+ <!--==========================orignal english content==========================
260
+ <term><replaceable class="parameter">procedure_name</replaceable></term>
261
+ ____________________________________________________________________________-->
262
+ <term><replaceable class="parameter">procedure_name</replaceable></term>
263
+ <!--==========================orignal english content==========================
264
+ <term><replaceable class="parameter">routine_name</replaceable></term>
265
+ ____________________________________________________________________________-->
266
+ <term><replaceable class="parameter">routine_name</replaceable></term>
294
267
<!--==========================orignal english content==========================
295
268
<term><replaceable class="parameter">rule_name</replaceable></term>
296
269
____________________________________________________________________________-->
@@ -304,7 +277,7 @@ ____________________________________________________________________________-->
304
277
<para>
305
278
The name of the object to be commented. Names of tables,
306
279
aggregates, collations, conversions, domains, foreign tables, functions,
307
- indexes, operators, operator classes, operator families, sequences,
280
+ indexes, operators, operator classes, operator families, procedures, routines, sequences,
308
281
statistics, text search objects, types, and views can be
309
282
schema-qualified. When commenting on a column,
310
283
<replaceable class="parameter">relation_name</replaceable> must refer
@@ -313,7 +286,7 @@ ____________________________________________________________________________-->
313
286
____________________________________________________________________________-->
314
287
<para>
315
288
要被注释的对象的名称。表、聚集、排序方式、转换、域、外部表、函数、
316
- 索引、操作符、操作符类、操作符族、序列、统计信息、文本搜索对象、类型和视图
289
+ 索引、操作符、操作符类、操作符族、存储过程、例程、 序列、统计信息、文本搜索对象、类型和视图
317
290
的名称可以被模式限定。在注释一列时,
318
291
<replaceable class="parameter">relation_name</replaceable>必须
319
292
引用一个表、视图、组合类型或者外部表。
@@ -387,7 +360,7 @@ ____________________________________________________________________________-->
387
360
<listitem>
388
361
<!--==========================orignal english content==========================
389
362
<para>
390
- The mode of a function or aggregate
363
+ The mode of a function, procedure, or aggregate
391
364
argument: <literal>IN</>, <literal>OUT</>,
392
365
<literal>INOUT</>, or <literal>VARIADIC</>.
393
366
If omitted, the default is <literal>IN</>.
@@ -399,7 +372,7 @@ ____________________________________________________________________________-->
399
372
</para>
400
373
____________________________________________________________________________-->
401
374
<para>
402
- 一个函数或者聚集的参数的模式 :<literal>IN</literal>、
375
+ 一个函数,存储过程或者聚集函数的参数的模式 :<literal>IN</literal>、
403
376
<literal>OUT</literal>、<literal>INOUT</literal>或者<literal>VARIADIC</literal>。
404
377
如果被省略,默认值是<literal>IN</literal>。注意
405
378
<command>COMMENT</command>并不真正关心
@@ -425,7 +398,7 @@ ____________________________________________________________________________-->
425
398
</para>
426
399
____________________________________________________________________________-->
427
400
<para>
428
- 一个函数或者聚集参数的名称 。注意
401
+ 一个函数,存储过程或者聚集函数参数的名称 。注意
429
402
<command>COMMENT</command>并不真正关心参数名称,
430
403
因为决定函数的身份只需要参数数据类型。
431
404
</para>
@@ -444,7 +417,7 @@ ____________________________________________________________________________-->
444
417
</para>
445
418
____________________________________________________________________________-->
446
419
<para>
447
- 一个函数或者聚集参数的数据类型 。
420
+ 一个函数,存储过程或者聚集函数参数的数据类型 。
448
421
</para>
449
422
</listitem>
450
423
</varlistentry>
@@ -652,6 +625,7 @@ COMMENT ON OPERATOR - (NONE, integer) IS 'Unary minus';
652
625
COMMENT ON OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees';
653
626
COMMENT ON OPERATOR FAMILY integer_ops USING btree IS 'all integer operators for btrees';
654
627
COMMENT ON POLICY my_policy ON mytable IS 'Filter rows by users';
628
+ COMMENT ON PROCEDURE my_proc (integer, integer) IS 'Runs a report';
655
629
COMMENT ON ROLE my_role IS 'Administration group for finance tables';
656
630
COMMENT ON RULE my_rule ON my_table IS 'Logs updates of employee records';
657
631
COMMENT ON SCHEMA my_schema IS 'Departmental data';
@@ -697,6 +671,7 @@ COMMENT ON OPERATOR - (NONE, integer) IS 'Unary minus';
697
671
COMMENT ON OPERATOR CLASS int4ops USING btree IS '4 byte integer operators for btrees';
698
672
COMMENT ON OPERATOR FAMILY integer_ops USING btree IS 'all integer operators for btrees';
699
673
COMMENT ON POLICY my_policy ON mytable IS 'Filter rows by users';
674
+ COMMENT ON PROCEDURE my_proc (integer, integer) IS 'Runs a report';
700
675
COMMENT ON ROLE my_role IS 'Administration group for finance tables';
701
676
COMMENT ON RULE my_rule ON my_table IS 'Logs updates of employee records';
702
677
COMMENT ON SCHEMA my_schema IS 'Departmental data';
0 commit comments