1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/*-------------------------------------------------------------------------
*
* psqlHelp.h--
* Help for query language syntax
*
* Copyright (c) 1994, Regents of the University of California
*
* $Id: psqlHelp.h,v 1.34 1997/12/04 00:27:37 scrappy 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>"},
{"alter user",
"alter system information for a user",
"alter user <user_name>\n\t[with password <password>]\n\t[createdb | noccreatedb]\n\t[createuser | nocreateuser]\n\t[in group <group_1>, ..., <group_n>]\n\t[valid until '<abstime>'];"},
{"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 be more 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 trigger\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> [with location = '<dbpath>']"},
{"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>\n\t(<attr1> <type1> [default <expression>] [not null] [,...])\n\t[inherits (<class_name1>,...<class_nameN>)\n\t[[constraint <name>] check <condition> [,...] ]\n;"},
{"create trigger",
"create a new trigger",
"create trigger <trigger_name> after|before event1 [or event2 [or event3] ]\n\ton <class_name> for each row|statement\n\texecute procedure <func_name> ([arguments]);\n\n\teventX is one of INSERT, DELETE, UPDATE"},
{"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 user",
"create a new user",
"create user <user_name>\n\t[with password <password>]\n\t[createdb | nocreatedb]\n\t[createuser | nocreateuser]\n\t[in group <group_1>, ..., <group_n>]\n\t[valid until '<abstime>'];"},
{"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 be more 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 trigger\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 sequence",
"remove a sequence number generator",
"drop sequence <sequence_name>[,...<sequence_nameN];"},
{"drop table",
"remove a table",
"drop table <class_name>[,...<class_nameN];"},
{"drop trigger",
"remove a trigger",
"drop trigger <trigger_name> on <class_name>;"},
{"drop type",
"remove a user-defined base type",
"drop type <typename>;"},
{"drop user",
"remove a user from the system",
"drop user <user_name>;"},
{"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>;"},
{"move",
"move an cursor position",
"move [forward|backward] [<number>|all] [in <cursorname>];"},
{"notify",
"signal all frontends and backends listening on a relation",
"notify <class_name>"},
{"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! */
};
|
