mirror of
https://github.com/postgres/postgres.git
synced 2025-06-22 02:52:08 +03:00
183 lines
7.9 KiB
C
183 lines
7.9 KiB
C
/*-------------------------------------------------------------------------
|
|
*
|
|
* psqlHelp.h--
|
|
* Help for query language syntax
|
|
*
|
|
* Copyright (c) 1994, Regents of the University of California
|
|
*
|
|
* $Id: psqlHelp.h,v 1.26 1997/10/01 19:14:35 momjian Exp $
|
|
*
|
|
*-------------------------------------------------------------------------
|
|
*/
|
|
|
|
struct _helpStruct
|
|
{
|
|
char *cmd; /* the command name */
|
|
char *help; /* the help associated with it */
|
|
char *syntax; /* the syntax associated with it */
|
|
};
|
|
|
|
static struct _helpStruct QL_HELP[] = {
|
|
{"abort",
|
|
"abort the current transaction",
|
|
"abort [transaction];"},
|
|
{"abort transaction",
|
|
"abort the current transaction",
|
|
"abort [transaction];"},
|
|
{"alter table",
|
|
"add/rename attributes, rename tables",
|
|
"\talter table <class_name> [*] add column <attr> <type>;\n\talter table <class_name> [*] rename [column] <attr1> to <attr2>;\n\talter table <class_name1> rename to <class_name2>"},
|
|
{"begin",
|
|
"begin a new transaction",
|
|
"begin [transaction|work];"},
|
|
{"begin transaction",
|
|
"begin a new transaction",
|
|
"begin [transaction|work];"},
|
|
{"begin work",
|
|
"begin a new transaction",
|
|
"begin [transaction|work];"},
|
|
{"cluster",
|
|
"create a clustered index (from an existing index)",
|
|
"cluster <index_name> on <relation_name>"},
|
|
{"close",
|
|
"close an existing cursor (cursor)",
|
|
"close <cursorname>;"},
|
|
{"commit",
|
|
"commit a transaction",
|
|
"commit [work]"},
|
|
{"commit work",
|
|
"commit a transaction",
|
|
"commit [work]"},
|
|
{"copy",
|
|
"copy data to and from a table",
|
|
"copy [binary] <class_name> [with oids]\n\t{to|from} {<filename>|stdin|stdout} [using delimiters <delim>];"},
|
|
{"create",
|
|
"Please more be specific:",
|
|
"\tcreate aggregate\n\tcreate database\n\tcreate function\n\tcreate index\n\tcreate operator\n\tcreate rule\n\tcreate sequence\n\tcreate table\n\tcreate type\n\tcreate view"},
|
|
{"create aggregate",
|
|
"define an aggregate function",
|
|
"create aggregate <agg_name> [as] (basetype = <data_type>, \n\t[sfunc1 = <sfunc_1>, stype1 = <sfunc1_return_type>]\n\t[sfunc2 = <sfunc_2>, stype2 = <sfunc2_return_type>]\n\t[,finalfunc = <final-function>]\n\t[,initcond1 = <initial-cond1>][,initcond2 = <initial-cond2>]);"},
|
|
{"create database",
|
|
"create a database",
|
|
"create database <dbname>"},
|
|
{"create function",
|
|
"create a user-defined function",
|
|
"create function <function_name> ([<type1>,...<typeN>]) returns <return_type>\n\tas '<object_filename>'|'<sql-queries>'\n\tlanguage 'c'|'sql'|'internal';"},
|
|
{"create index",
|
|
"construct an index",
|
|
"create [unique] index <indexname> on <class_name> [using <access_method>]\n( <attr1> [<type_class1>] [,...] | <funcname>(<attr1>,...) [<type_class>] );"},
|
|
{"create operator",
|
|
"create a user-defined operator",
|
|
"create operator <operator_name> (\n\t[leftarg = <type1>][,rightarg = <type2>]\n\t,procedure = <func_name>,\n\t[,commutator = <com_op>][,negator = <neg_op>]\n\t[,restrict = <res_proc>][,hashes]\n\t[,join = <join_proc>][,sort = <sort_op1>...<sort_opN>]);"},
|
|
{"create rule",
|
|
"define a new rule",
|
|
"create rule <rule_name> as on\n\t[select|update|delete|insert]\n\tto <object> [where <qual>]\n\tdo [instead] [<action>|nothing| [<actions>]];"},
|
|
{"create sequence",
|
|
"create a new sequence number generator",
|
|
"create sequence <sequence_name>\n\t[increment <NUMBER>]\n\t[start <NUMBER>]\n\t[minvalue <NUMBER>]\n\t[maxvalue <NUMBER>]\n\t[cache <NUMBER>]\n\t[cycle];"},
|
|
{"create table",
|
|
"create a new table",
|
|
"create table <class_name> ( <attr1> <type1> [not null] [default <value>],...)\n\t[inherits (<class_name1>,...<class_nameN>)\n\t[constraint <name> check (<test>) [,check (<test>)]\n\tarchive=<archive_mode>\n\tstore=<smgr_name>\n\tarch_store=<smgr_name>];"},
|
|
{"create type",
|
|
"create a new user-defined base data type",
|
|
"create type <typename> (\n\tinternallength = (<number> | variable),\n\t[externallength = (<number>|variable),]\n\tinput=<input_function>, output = <output_function>\n\t[,element = <typename>][,delimiter=<character>][,default=\'<string>\']\n\t[,send = <send_function>][,receive = <receive_function>][,passedbyvalue]);"},
|
|
{"create view",
|
|
"create a view",
|
|
"create view <view_name> as select <expr1>[as <attr1>][,... <exprN>[as <attrN>]] [from <from_list>] [where <qual>];"},
|
|
{"declare",
|
|
"set up a cursor",
|
|
"declare <cursorname> [binary] cursor for\n\tselect [distinct]\n\t<expr1> [as <attr1>],...<exprN> [as <attrN>]\n\t[from <from_list>] [where <qual>]\n\t[order by <attr1> [using <op1>],... <attrN> [using <opN>]];"},
|
|
{"delete",
|
|
"delete tuples",
|
|
"delete from <class_name> [where <qual>];"},
|
|
{"drop",
|
|
"Please more be specific:",
|
|
"\tdrop aggregate\n\tdrop database\n\tdrop function\n\tdrop index\n\tdrop operator\n\tdrop rule\n\tdrop sequence\n\tdrop table\n\tdrop type\n\tdrop view"},
|
|
{"drop aggregate",
|
|
"remove an aggregate function",
|
|
"drop aggregate <agg_name> <agg_type>|*;"},
|
|
{"drop database",
|
|
"remove a database",
|
|
"drop database <dbname>"},
|
|
{"drop function",
|
|
"remove a user-defined function",
|
|
"drop function <funcname> ([<type1>,....<typeN>]);"},
|
|
{"drop index",
|
|
"remove an existing index",
|
|
"drop index <indexname>;"},
|
|
{"drop operator",
|
|
"remove a user-defined operator",
|
|
"drop operator <operator_name> ([<ltype>|none],[<rtype>|none]);"},
|
|
{"drop rule",
|
|
"remove a rule",
|
|
"drop rule <rulename>;"},
|
|
{"drop table",
|
|
"remove a table",
|
|
"drop table <class_name>[,...<class_nameN];"},
|
|
{"drop sequence",
|
|
"remove a sequence number generator",
|
|
"drop sequence <sequence_name>[,...<sequence_nameN];"},
|
|
{"drop type",
|
|
"remove a user-defined base type",
|
|
"drop type <typename>;"},
|
|
{"drop view",
|
|
"remove a view",
|
|
"drop view <view_name>"},
|
|
{"end",
|
|
"end the current transaction",
|
|
"end [transaction];"},
|
|
{"end transaction",
|
|
"end the current transaction",
|
|
"end [transaction];"},
|
|
{"explain",
|
|
"explain the query execution plan",
|
|
"explain [verbose] <query>"},
|
|
{"fetch",
|
|
"retrieve tuples from a cursor",
|
|
"fetch [forward|backward] [<number>|all] [in <cursorname>];"},
|
|
{"grant",
|
|
"grant access control to a user or group",
|
|
"grant <privilege[,privilege,...]> on <rel1>[,...<reln>] to \n[public | group <group> | <username>]\n\t privilege is {ALL | SELECT | INSERT | UPDATE | DELETE | RULE}"},
|
|
{"insert",
|
|
"insert tuples",
|
|
"insert into <class_name> [(<attr1>...<attrN>)]\n\t[values (<expr1>...<exprN>); |\n\tselect <expr1>,...<exprN> [from <from_clause>] [where <qual>];"},
|
|
{"listen",
|
|
"listen for notification on a relation",
|
|
"listen <class_name>"},
|
|
{"load",
|
|
"dynamically load a module",
|
|
"load <filename>;"},
|
|
{"notify",
|
|
"signal all frontends and backends listening on a relation",
|
|
"notify <class_name>"},
|
|
{"purge",
|
|
"purge historical data",
|
|
"purge <class_name> [before <abstime>] [after <reltime>];"},
|
|
{"reset",
|
|
"set run-time environment back to default",
|
|
"reset {DateStyle | GEQO | R_PLANS}"},
|
|
{"revoke",
|
|
"revoke access control from a user or group",
|
|
"revoke <privilege[,privilege,...]> on <rel1>[,...<reln>] from \n[public | group <group> | <username>]\n\t privilege is {ALL | SELECT | INSERT | UPDATE | DELETE | RULE}"},
|
|
{"rollback",
|
|
"abort a transaction",
|
|
"rollback [transaction|work]"},
|
|
{"select",
|
|
"retrieve tuples",
|
|
"select [distinct on <attr>] <expr1> [as <attr1>], ... <exprN> [as <attrN>]\n\t[into table <class_name>] [from <from_list>]\n\t[where <qual>]\n\t[order by <attr1>\n\t\t[using <op1>],..<attrN> [[using <opN>] | ASC | DESC]];"},
|
|
{"set",
|
|
"set run-time environment",
|
|
"set DateStyle to {'ISO' | 'SQL' | 'Postgres' | 'European' | 'US' | 'NonEuropean'}\nset GEQO to {'ON[=#]' | 'OFF'}\nset R_PLANS to {'ON' | 'OFF'}"},
|
|
{"show",
|
|
"show current run-time environment",
|
|
"show {DateStyle | GEQO | R_PLANS}"},
|
|
{"update",
|
|
"update tuples",
|
|
"update <class_name> set <attr1>=<expr1>,...<attrN>=<exprN> [from <from_clause>] [where <qual>];"},
|
|
{"vacuum",
|
|
"vacuum the database, i.e. cleans out deleted records, updates statistics",
|
|
"vacuum [verbose] [analyze]\n\tor\nvacuum [verbose] [analyze] table [analyze [(attr1, ... attrN)] ];"},
|
|
{NULL, NULL, NULL} /* important to keep a NULL terminator
|
|
* here! */
|
|
};
|