mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add documentation for comment.

Browse Source
This commit is contained in:
Bruce Momjian 1999-10-26 03:48:58 +00:00
parent 577e21b34f
commit b6d6cffa99
2 changed files with 210 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

156
doc/src/sgml/ref/comment.sgml Normal file
View File

@ -0,0 +1,156 @@
<!--
$Header: /cvsroot/pgsql/doc/src/sgml/ref/comment.sgml,v 1.1 1999/10/26 03:48:58 momjian Exp $
Postgres documentation
-->
<refentry id="SQL-COMMENT">
<refmeta>
<refentrytitle id="SQL-COMMENT-TITLE">
COMMENT
</refentrytitle>
<refmiscinfo>SQL - Language Statements</refmiscinfo>
</refmeta>
<refnamediv>
<refname>
COMMENT
</refname>
<refpurpose>
Add comment to an object
</refpurpose>
</refnamediv>
<refsynopsisdiv>
<refsynopsisdivinfo>
<date>1999-07-20</date>
</refsynopsisdivinfo>
<synopsis>
COMMENT ON
[
[ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ]
<replaceable class="PARAMETER">object_name</replaceable> |
COLUMN <replaceable class="PARAMETER">table_name</replaceable>.<replaceable class="PARAMETER">column_name</replaceable>|
AGGREGATE <replaceable class="PARAMETER">agg_name</replaceable> <replaceable class="PARAMETER">agg_type</replaceable>|
FUNCTION <replaceable class="PARAMETER">func_name</replaceable> (<replaceable class="PARAMETER">arg1</replaceable>, <replaceable class="PARAMETER">arg2</replaceable>, ...)|
OPERATOR <replaceable class="PARAMETER">op</replaceable> (<replaceable class="PARAMETER">leftoperand_type</replaceable> <replaceable class="PARAMETER">rightoperand_type</replaceable>) |
TRIGGER <replaceable class="PARAMETER">trigger_name</replaceable> ON <replaceable class="PARAMETER">table_name</replaceable>
] IS <replaceable class="PARAMETER">'text'</replaceable>
</synopsis>
<refsect2 id="R2-SQL-COMMENT-1">
<refsect2info>
<date>1999-10-25</date>
</refsect2info>
<title>
Inputs
</title>
<para>
<variablelist>
<varlistentry>
<term><replaceable class="PARAMETER">object_name, table_name,
column_name, agg_name, func_name, op, trigger_name</replaceable></term>
<listitem>
<para>
The name of the object to be be commented.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><replaceable class="PARAMETER">text</replaceable></term>
<listitem>
<para>
The comment to add.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
<refsect2 id="R2-SQL-COMMENT-2">
<refsect2info>
<date>1998-09-08</date>
</refsect2info>
<title>
Outputs
</title>
<para>
<variablelist>
<varlistentry>
<term><computeroutput>
COMMENT
</computeroutput></term>
<listitem>
<para>
Message returned if the table is successfully commented.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect2>
</refsynopsisdiv>
<refsect1 id="R1-SQL-COMMENT-1">
<refsect1info>
<date>1998-10-25</date>
</refsect1info>
<title>
Description
</title>
<para>
<command>COMMENT</command> adds a comment to an object that can be
easily retrieved with <application>psql's</application>
<emphasize>\dd</emphasize> command.
To remove a comment, use <literal>''</literal>.
</para>
</refsect1>
<refsect1 id="R1-SQL-COMMENT-2">
<title>
Usage
</title>
<para>
comment the table <literal>mytable</literal>:
<programlisting>
COMMENT ON mytable IS 'This is my table.';
</programlisting>
</para>
</refsect1>
<refsect1 id="R1-SQL-COMMENT-3">
<title>
Compatibility
</title>
<refsect2 id="R2-SQL-COMMENT-4">
<refsect2info>
<date>1998-09-08</date>
</refsect2info>
<title>
SQL92
</title>
<para>
There is no <command>COMMENT</command> in <acronym>SQL92</acronym>.
</para>
</refsect2>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-default-dtd-file:"../reference.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:"/usr/lib/sgml/catalog"
sgml-local-ecat-files:nil
End:
-->

95
src/bin/psql/psqlHelp.h
View File

@ -5,7 +5,7 @@
* *
* Copyright (c) 1994, Regents of the University of California * Copyright (c) 1994, Regents of the University of California
* *
* $Id: psqlHelp.h,v 1.77 1999/10/02 21:33:29 tgl Exp $ * $Id: psqlHelp.h,v 1.78 1999/10/26 03:48:58 momjian Exp $
* *
*------------------------------------------------------------------------- *-------------------------------------------------------------------------
*/ */
@ -25,9 +25,9 @@ static struct _helpStruct QL_HELP[] = {
{"alter table", {"alter table",
"add/rename columns, rename tables", "add/rename columns, rename tables",
"\ "\
\tALTER TABLE tablename [*] ADD COLUMN colname type\n\ \tALTER TABLE table_name [*] ADD COLUMN column_name type\n\
\tALTER TABLE tablename [*] RENAME [COLUMN] colname1 TO colname2\n\ \tALTER TABLE table_name [*] RENAME [COLUMN] column_name1 TO column_name2\n\
\tALTER TABLE tablename1 RENAME TO tablename2"}, \tALTER TABLE table_name1 RENAME TO table_name2"},
{"alter user", {"alter user",
"alter system information for a user", "alter system information for a user",
"\ "\
@ -41,14 +41,26 @@ static struct _helpStruct QL_HELP[] = {
"begin a new transaction", "begin a new transaction",
"\ "\
\tBEGIN [WORK|TRANSACTION];"}, \tBEGIN [WORK|TRANSACTION];"},
{"cluster",
"create a clustered index (from an existing index)",
"\
\tCLUSTER index_name ON relation_name"},
{"close", {"close",
"close an existing cursor (cursor)", "close an existing cursor (cursor)",
"\ "\
\tCLOSE cursorname;"}, \tCLOSE cursorname;"},
{"cluster",
"create a clustered index (from an existing index)",
"\
\tCLUSTER index_name ON relation_name"},
{"comment",
"add comment on object",
"\
\tCOMMENT ON\n\
[\n\
[ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ] <object_name> |\n\
COLUMN <table_name>.<column_name>|\n\
AGGREGATE <agg_name> <agg_type>|\n\
FUNCTION <func_name> (arg1, arg2, ...)|\n\
OPERATOR <op> (leftoperand_type rightoperand_type) |\n\
TRIGGER <trigger_name> ON <table_name>\n\
] IS 'text'},
{"commit work", {"commit work",
"commit a transaction", "commit a transaction",
"\ "\
@ -56,7 +68,7 @@ static struct _helpStruct QL_HELP[] = {
{"copy", {"copy",
"copy data to and from a table", "copy data to and from a table",
"\ "\
\tCOPY [BINARY] tablename [WITH OIDS]\n\ \tCOPY [BINARY] table_name [WITH OIDS]\n\
\tTO|FROM filename|STDIN|STDOUT [USING DELIMITERS 'delim'];"}, \tTO|FROM filename|STDIN|STDOUT [USING DELIMITERS 'delim'];"},
{"create", {"create",
"Please be more specific:", "Please be more specific:",
@ -88,21 +100,22 @@ static struct _helpStruct QL_HELP[] = {
"create a user-defined function", "create a user-defined function",
"\ "\
\tCREATE FUNCTION function_name ([type1, ...typeN]) RETURNS return_type\n\ \tCREATE FUNCTION function_name ([type1, ...typeN]) RETURNS return_type\n\
\t[WITH ( attributes )]\n\ \t[WITH ( column_names )]\n\
\tAS 'sql_queries'|'builtin_function_name'|'procedural_commands'\n\ \tAS 'sql_queries'|'builtin_function_name'|'procedural_commands'\n\
\tLANGUAGE 'sql'|'internal'|'procedural_language_name';\n\ \tLANGUAGE 'sql'|'internal'|'procedural_language_name';\n\
\n\ \n\
OR\n\ OR\n\
\n\ \n\
\tCREATE FUNCTION function_name ([type1, ...typeN]) RETURNS return_type\n\ \tCREATE FUNCTION function_name ([type1, ...typeN]) RETURNS return_type\n\
\t[WITH ( attributes )]\n\ \t[WITH ( column_names )]\n\
\tAS 'object_filename' [, 'link_symbol']\n\ \tAS 'object_filename' [, 'link_symbol']\n\
\tLANGUAGE 'C';"}, \tLANGUAGE 'C';"},
{"create index", {"create index",
"construct an index", "construct an index",
"\ "\
\tCREATE [UNIQUE] INDEX indexname ON tablename [USING access_method]\n\ \tCREATE [UNIQUE] INDEX indexname ON table_name [USING access_method]\n\
( colname1 [type_class1], ...colnameN | funcname(colname1, ...) [type_class] );"}, ( column_name1 [type_class1], ...column_nameN |\n\
funcname(column_name1, ...) [type_class] );"},
{"create operator", {"create operator",
"create a user-defined operator", "create a user-defined operator",
"\ "\
@ -117,7 +130,7 @@ OR\n\
"\ "\
\tCREATE RULE rule_name AS ON\n\ \tCREATE RULE rule_name AS ON\n\
\t{ SELECT | UPDATE | DELETE | INSERT }\n\ \t{ SELECT | UPDATE | DELETE | INSERT }\n\
\tTO object [WHERE qual]\n\ \tTO object_name [WHERE qual]\n\
\tDO [INSTEAD] [action|NOTHING|[actions]];"}, \tDO [INSTEAD] [action|NOTHING|[actions]];"},
{"create sequence", {"create sequence",
"create a new sequence number generator", "create a new sequence number generator",
@ -132,16 +145,16 @@ OR\n\
{"create table", {"create table",
"create a new table", "create a new table",
"\ "\
\tCREATE [TEMP] TABLE tablename\n\ \tCREATE [TEMP] TABLE table_name\n\
\t(colname1 type1 [DEFAULT expression] [NOT NULL], ...colnameN\n\ \t(column_name1 type1 [DEFAULT expression] [NOT NULL], ...column_nameN\n\
\t[[CONSTRAINT name] CHECK condition1, ...conditionN] )\n\ \t[[CONSTRAINT name] CHECK condition1, ...conditionN] )\n\
\t[INHERITS (tablename1, ...tablenameN)\n\ \t[INHERITS (table_name1, ...table_nameN)\n\
;"}, ;"},
{"create trigger", {"create trigger",
"create a new trigger", "create a new trigger",
"\ "\
\tCREATE TRIGGER trigger_name AFTER|BEFORE event1 [OR event2 [OR event3] ]\n\ \tCREATE TRIGGER trigger_name AFTER|BEFORE event1 [OR event2 [OR event3] ]\n\
\tON tablename FOR EACH ROW|STATEMENT\n\ \tON table_name FOR EACH ROW|STATEMENT\n\
\tEXECUTE PROCEDURE func_name ([arguments])\n\ \tEXECUTE PROCEDURE func_name ([arguments])\n\
\n\ \n\
\teventX is one of INSERT, DELETE, UPDATE"}, \teventX is one of INSERT, DELETE, UPDATE"},
@ -167,27 +180,27 @@ OR\n\
"create a view", "create a view",
"\ "\
\tCREATE VIEW view_name AS\n\ \tCREATE VIEW view_name AS\n\
\tSELECT [DISTINCT [ON colnameN]]\n\ \tSELECT [DISTINCT [ON column_nameN]]\n\
\texpr1 [AS colname1], ...exprN\n\ \texpr1 [AS column_name1], ...exprN\n\
\t[FROM from_list]\n\ \t[FROM table_list]\n\
\t[WHERE qual]\n\ \t[WHERE qual]\n\
\t[GROUP BY group_list];"}, \t[GROUP BY group_list];"},
{"declare", {"declare",
"set up a cursor", "set up a cursor",
"\ "\
\tDECLARE cursorname [BINARY] CURSOR FOR\n\ \tDECLARE cursorname [BINARY] CURSOR FOR\n\
\tSELECT [DISTINCT [ON colnameN]]\n\ \tSELECT [DISTINCT [ON column_nameN]]\n\
\texpr1 [AS colname1], ...exprN\n\ \texpr1 [AS column_name1], ...exprN\n\
\t[FROM from_list]\n\ \t[FROM table_list]\n\
\t[WHERE qual]\n\ \t[WHERE qual]\n\
\t[GROUP BY group_list]\n\ \t[GROUP BY group_list]\n\
\t[HAVING having_clause]\n\ \t[HAVING having_clause]\n\
\t[ORDER BY colname1 [USING op1], ...colnameN]\n\ \t[ORDER BY column_name1 [USING op1], ...column_nameN]\n\
\t[ { UNION [ALL] | INTERSECT | EXCEPT } SELECT ...];"}, \t[ { UNION [ALL] | INTERSECT | EXCEPT } SELECT ...];"},
{"delete", {"delete",
"delete tuples", "delete tuples",
"\ "\
\tDELETE FROM tablename [WHERE qual];"}, \tDELETE FROM table_name [WHERE qual];"},
{"drop", {"drop",
"Please be more specific:", "Please be more specific:",
"\ "\
@ -233,11 +246,11 @@ OR\n\
{"drop table", {"drop table",
"remove a table", "remove a table",
"\ "\
\tDROP TABLE tablename1, ...tablenameN;"}, \tDROP TABLE table_name1, ...table_nameN;"},
{"drop trigger", {"drop trigger",
"remove a trigger", "remove a trigger",
"\ "\
\tDROP TRIGGER trigger_name ON tablename;"}, \tDROP TRIGGER trigger_name ON table_name;"},
{"drop type", {"drop type",
"remove a user-defined base type", "remove a user-defined base type",
"\ "\
@ -271,11 +284,11 @@ OR\n\
{"insert", {"insert",
"insert tuples", "insert tuples",
"\ "\
\tINSERT INTO tablename [(colname1, ...colnameN)]\n\ \tINSERT INTO table_name [(column_name1, ...column_nameN)]\n\
\tVALUES (expr1,..exprN) |\n\ \tVALUES (expr1,..exprN) |\n\
\tSELECT [DISTINCT [ON colnameN]]\n\ \tSELECT [DISTINCT [ON column_nameN]]\n\
\texpr1, ...exprN\n\ \texpr1, ...exprN\n\
\t[FROM from_clause]\n\ \t[FROM table_list]\n\
\t[WHERE qual]\n\ \t[WHERE qual]\n\
\t[GROUP BY group_list]\n\ \t[GROUP BY group_list]\n\
\t[HAVING having_clause]\n\ \t[HAVING having_clause]\n\
@ -291,7 +304,7 @@ OR\n\
{"lock", {"lock",
"exclusive lock a table inside a transaction", "exclusive lock a table inside a transaction",
"\ "\
\tLOCK [TABLE] tablename \n\ \tLOCK [TABLE] table_name \n\
\t[IN [ROW|ACCESS] [SHARE|EXCLUSIVE] | [SHARE ROW EXCLUSIVE] MODE];"}, \t[IN [ROW|ACCESS] [SHARE|EXCLUSIVE] | [SHARE ROW EXCLUSIVE] MODE];"},
{"move", {"move",
"move an cursor position", "move an cursor position",
@ -319,15 +332,15 @@ TIMEZONE|XACTISOLEVEL|CLIENT_ENCODING|SERVER_ENCODING"},
{"select", {"select",
"retrieve tuples", "retrieve tuples",
"\ "\
\tSELECT [DISTINCT [ON colnameN]] expr1 [AS colname1], ...exprN\n\ \tSELECT [DISTINCT [ON column_nameN]] expr1 [AS column_name1], ...exprN\n\
\t[INTO [TEMP] [TABLE] tablename]\n\ \t[INTO [TEMP] [TABLE] table_name]\n\
\t[FROM from_list]\n\ \t[FROM table_list]\n\
\t[WHERE qual]\n\ \t[WHERE qual]\n\
\t[GROUP BY group_list]\n\ \t[GROUP BY group_list]\n\
\t[HAVING having_clause]\n\ \t[HAVING having_clause]\n\
\t[ { UNION [ALL] | INTERSECT | EXCEPT } SELECT ...]\n\ \t[ { UNION [ALL] | INTERSECT | EXCEPT } SELECT ...]\n\
\t[ORDER BY colname1 [ASC|DESC] [USING op1], ...colnameN ]\n\ \t[ORDER BY column_name1 [ASC|DESC] [USING op1], ...column_nameN ]\n\
\t[FOR UPDATE [OF tablename...]]\n\ \t[FOR UPDATE [OF table_name...]]\n\
\t[LIMIT count [OFFSET|, count]];"}, \t[LIMIT count [OFFSET|, count]];"},
{"set", {"set",
"set run-time environment", "set run-time environment",
@ -358,18 +371,18 @@ TIMEZONE|XACTISOLEVEL|CLIENT_ENCODING|SERVER_ENCODING"},
{"truncate", {"truncate",
"quickly removes all rows from a table", "quickly removes all rows from a table",
"\ "\
\tTRUNCATE TABLE tablename"}, \tTRUNCATE TABLE table_name"},
{"update", {"update",
"update tuples", "update tuples",
"\ "\
\tUPDATE tablename SET colname1 = expr1, ...colnameN = exprN\n\ \tUPDATE table_name SET column_name1 = expr1, ...column_nameN = exprN\n\
\t[FROM from_clause]\n\ \t[FROM table_list]\n\
\t[WHERE qual];"}, \t[WHERE qual];"},
{"vacuum", {"vacuum",
"vacuum the database, i.e. cleans out deleted records, updates statistics", "vacuum the database, i.e. cleans out deleted records, updates statistics",
"\ "\
\tVACUUM [VERBOSE] [ANALYZE] [table]\n\ \tVACUUM [VERBOSE] [ANALYZE] [table]\n\
\tor\n\ \tor\n\
\tVACUUM [VERBOSE] ANALYZE [table [(colname1, ...colnameN)]];"}, \tVACUUM [VERBOSE] ANALYZE [table [(column_name1, ...column_nameN)]];"},
{NULL, NULL, NULL} /* important to keep a NULL terminator here!*/ {NULL, NULL, NULL} /* important to keep a NULL terminator here!*/
}; };