psqlHelp.h
上传用户:blenddy
上传日期:2007-01-07
资源大小:6495k
文件大小:10k
源码类别:

数据库系统

开发平台:

Unix_Linux

  1. /*-------------------------------------------------------------------------
  2.  *
  3.  * psqlHelp.h
  4.  *   Help for query language syntax
  5.  *
  6.  * Copyright (c) 1994, Regents of the University of California
  7.  *
  8.  * $Id: psqlHelp.h,v 1.72 1999/07/11 22:47:21 ishii Exp $
  9.  *
  10.  *-------------------------------------------------------------------------
  11.  */
  12. struct _helpStruct
  13. {
  14. char    *cmd; /* the command name */
  15. char    *help; /* the help associated with it */
  16. char    *syntax; /* the syntax associated with it */
  17. };
  18. static struct _helpStruct QL_HELP[] = {
  19. {"abort transaction",
  20. "abort the current transaction",
  21. "
  22. tabort [transaction|work];"},
  23. {"alter table",
  24. "add/rename attributes, rename tables",
  25. "
  26. tALTER TABLE class_name [*] ADD COLUMN attr typen
  27. tALTER TABLE class_name [*] RENAME [COLUMN] attr1 TO attr2n
  28. tALTER TABLE class_name1 RENAME TO class_name2"},
  29. {"alter user",
  30. "alter system information for a user",
  31. "
  32. tALTER USER user_namen
  33. t[WITH PASSWORD password]n
  34. t[CREATEDB | NOCCREATEDB]n
  35. t[CREATEUSER | NOCREATEUSER]n
  36. t[IN GROUP group_1, ...groupN]n
  37. t[VALID UNTIL 'abstime'];"},
  38. {"begin work",
  39. "begin a new transaction",
  40. "
  41. tBEGIN [WORK|TRANSACTION];"},
  42. {"cluster",
  43. "create a clustered index (from an existing index)",
  44. "
  45. tCLUSTER index_name ON relation_name"},
  46. {"close",
  47. "close an existing cursor (cursor)",
  48. "
  49. tCLOSE cursorname;"},
  50. {"commit work",
  51. "commit a transaction",
  52. "
  53. tCOMMIT [WORK|TRANSACTION]"},
  54. {"copy",
  55. "copy data to and from a table",
  56. "
  57. tCOPY [BINARY] class_name [WITH OIDS]n
  58. tTO|FROM filename|STDIN|STDOUT [USING DELIMITERS 'delim'];"},
  59. {"create",
  60. "Please be more specific:",
  61. "
  62. tcreate aggregaten
  63. tcreate databasen
  64. tcreate functionn
  65. tcreate indexn
  66. tcreate operatorn
  67. tcreate rulen
  68. tcreate sequencen
  69. tcreate tablen
  70. tcreate triggern
  71. tcreate typen
  72. tcreate view"},
  73. {"create aggregate",
  74. "define an aggregate function",
  75. "
  76. tCREATE AGGREGATE agg_name [AS] (BASETYPE = data_type, n
  77. t[SFUNC1 = sfunc_1, STYPE1 = sfunc1_return_type]n
  78. t[SFUNC2 = sfunc_2, STYPE2 = sfunc2_return_type]n
  79. t[,FINALFUNC = final-function]n
  80. t[,INITCOND1 = initial-cond1][,INITCOND2 = initial-cond2]);"},
  81. {"create database",
  82. "create a database",
  83. "
  84. tCREATE DATABASE dbname [WITH LOCATION = 'dbpath']"},
  85. {"create function",
  86. "create a user-defined function",
  87. "
  88. tCREATE FUNCTION function_name ([type1, ...typeN]) RETURNS return_typen
  89. tAS 'object_filename'|'sql-queries'|'builtin_function_name'n
  90. tLANGUAGE 'c'|'sql'|'internal';"},
  91. {"create index",
  92. "construct an index",
  93. "
  94. tCREATE [UNIQUE] INDEX indexname ON class_name [USING access_method]n
  95. ( attr1 [type_class1], ...attrN | funcname(attr1, ...) [type_class] );"},
  96. {"create operator",
  97. "create a user-defined operator",
  98. "
  99. tCREATE OPERATOR operator_name (n
  100. t[LEFTARG = type1][,RIGHTARG = type2]n
  101. t,PROCEDURE = func_name,n
  102. t[,COMMUTATOR = com_op][,NEGATOR = neg_op]n
  103. t[,RESTRICT = res_proc][,JOIN = join_proc][,HASHES]n
  104. t[,SORT1 = left_sort_op][,SORT2 = right_sort_op]);"},
  105. {"create rule",
  106. "define a new rule",
  107. "
  108. tCREATE RULE rule_name AS ONn
  109. t{ SELECT | UPDATE | DELETE | INSERT }n
  110. tTO object [WHERE qual]n
  111. tDO [INSTEAD] [action|NOTHING|[actions]];"},
  112. {"create sequence",
  113. "create a new sequence number generator",
  114. "
  115. tCREATE SEQUENCE sequence_namen
  116. t[INCREMENT number]n
  117. t[START number]n
  118. t[MINVALUE number]n
  119. t[MAXVALUE number]n
  120. t[CACHE number]n
  121. t[CYCLE];"},
  122. {"create table",
  123. "create a new table",
  124. "
  125. tCREATE [TEMP] TABLE class_namen
  126. t(attr1 type1 [DEFAULT expression] [NOT NULL], ...attrNn
  127. t[[CONSTRAINT name] CHECK condition1, ...conditionN] )n
  128. t[INHERITS (class_name1, ...class_nameN)n
  129. ;"},
  130. {"create trigger",
  131. "create a new trigger",
  132. "
  133. tCREATE TRIGGER trigger_name AFTER|BEFORE event1 [OR event2 [OR event3] ]n
  134. tON class_name FOR EACH ROW|STATEMENTn
  135. tEXECUTE PROCEDURE func_name ([arguments])n
  136. n
  137. teventX is one of INSERT, DELETE, UPDATE"},
  138. {"create type",
  139. "create a new user-defined base data type",
  140. "
  141. tCREATE TYPE typename (n
  142. tINTERNALLENGTH = (number|VARIABLE),n
  143. t[EXTERNALLENGTH = (number|VARIABLE),]n
  144. tINPUT = input_function, OUTPUT = output_functionn
  145. t[,ELEMENT = typename][,DELIMITER = character][,DEFAULT='<string>']n
  146. t[,SEND = send_function][,RECEIVE = receive_function][,PASSEDBYVALUE]);"},
  147. {"create user",
  148. "create a new user",
  149. "
  150. tCREATE USER user_namen
  151. t[WITH PASSWORD password]n
  152. t[CREATEDB | NOCREATEDB]n
  153. t[CREATEUSER | NOCREATEUSER]n
  154. t[IN GROUP group1, ...groupN]n
  155. t[VALID UNTIL 'abstime'];"},
  156. {"create view",
  157. "create a view",
  158. "
  159. tCREATE VIEW view_name ASn
  160. tSELECT [DISTINCT [ON attrN]]n
  161. texpr1 [AS attr1], ...exprNn
  162. t[FROM from_list]n
  163. t[WHERE qual]n
  164. t[GROUP BY group_list];"},
  165. {"declare",
  166. "set up a cursor",
  167. "
  168. tDECLARE cursorname [BINARY] CURSOR FORn
  169. tSELECT [DISTINCT [ON attrN]]n
  170. texpr1 [AS attr1], ...exprNn
  171. t[FROM from_list]n
  172. t[WHERE qual]n
  173. t[GROUP BY group_list]n
  174. t[HAVING having_clause]n
  175. t[ORDER BY attr1 [USING op1], ...attrN]n
  176. t[ { UNION [ALL] | INTERSECT | EXCEPT } SELECT ...];"},
  177. {"delete",
  178. "delete tuples",
  179. "
  180. tDELETE FROM class_name [WHERE qual];"},
  181. {"drop",
  182. "Please be more specific:",
  183. "
  184. tdrop aggregaten
  185. tdrop databasen
  186. tdrop functionn
  187. tdrop indexn
  188. tdrop operatorn
  189. tdrop rulen
  190. tdrop sequencen
  191. tdrop tablen
  192. tdrop triggern
  193. tdrop typen
  194. tdrop view"},
  195. {"drop aggregate",
  196. "remove an aggregate function",
  197. "
  198. tDROP AGGREGATE agg_name agg_type|*;"},
  199. {"drop database",
  200. "remove a database",
  201. "
  202. tDROP DATABASE dbname"},
  203. {"drop function",
  204. "remove a user-defined function",
  205. "
  206. tDROP FUNCTION funcname ([type1, ...typeN]);"},
  207. {"drop index",
  208. "remove an existing index",
  209. "
  210. tDROP INDEX indexname;"},
  211. {"drop operator",
  212. "remove a user-defined operator",
  213. "
  214. tDROP OPERATOR operator_name ([ltype|NONE],[RTYPE|none]);"},
  215. {"drop rule",
  216. "remove a rule",
  217. "
  218. tDROP RULE rulename;"},
  219. {"drop sequence",
  220. "remove a sequence number generator",
  221. "
  222. tDROP SEQUENCE sequence_name[, ...sequence_nameN];"},
  223. {"drop table",
  224. "remove a table",
  225. "
  226. tDROP TABLE class_name1, ...class_nameN;"},
  227. {"drop trigger",
  228. "remove a trigger",
  229. "
  230. tDROP TRIGGER trigger_name ON class_name;"},
  231. {"drop type",
  232. "remove a user-defined base type",
  233. "
  234. tDROP TYPE typename;"},
  235. {"drop user",
  236. "remove a user from the system",
  237. "
  238. tDROP USER user_name;"},
  239. {"drop view",
  240. "remove a view",
  241. "
  242. tDROP VIEW view_name"},
  243. {"end work",
  244. "end the current transaction",
  245. "
  246. tEND [WORK|TRANSACTION];"},
  247. {"explain",
  248. "explain the query execution plan",
  249. "
  250. tEXPLAIN [VERBOSE] query"},
  251. {"fetch",
  252. "retrieve tuples from a cursor",
  253. "
  254. tFETCH [FORWARD|BACKWARD] [number|ALL] [IN cursorname];"},
  255. {"grant",
  256. "grant access control to a user or group",
  257. "
  258. tGRANT privilege1, ...privilegeN ON rel1, ...relN TO n
  259. { PUBLIC | GROUP group | username }n
  260. t privilege is { ALL | SELECT | INSERT | UPDATE | DELETE | RULE }"},
  261. {"insert",
  262. "insert tuples",
  263. "
  264. tINSERT INTO class_name [(attr1, ...attrN)]n
  265. tVALUES (expr1,..exprN) |n
  266. tSELECT [DISTINCT [ON attrN]]n
  267. texpr1, ...exprNn
  268. t[FROM from_clause]n
  269. t[WHERE qual]n
  270. t[GROUP BY group_list]n
  271. t[HAVING having_clause]n
  272. t[ { UNION [ALL] | INTERSECT | EXCEPT } SELECT ...];"},
  273. {"listen",
  274. "listen for notification on a condition name",
  275. "
  276. tLISTEN name|"non-name string""},
  277. {"load",
  278. "dynamically load a module",
  279. "
  280. tLOAD 'filename';"},
  281. {"lock",
  282. "exclusive lock a table inside a transaction",
  283. "
  284. tLOCK [TABLE] class_name n
  285. t[IN [ROW|ACCESS] [SHARE|EXCLUSIVE] | [SHARE ROW EXCLUSIVE] MODE];"},
  286. {"move",
  287. "move an cursor position",
  288. "
  289. tMOVE [FORWARD|BACKWARD] [number|ALL] [IN cursorname];"},
  290. {"notify",
  291. "signal all frontends listening on a condition name",
  292. "
  293. tNOTIFY name|"non-name string""},
  294. {"reset",
  295. "set run-time environment back to default",
  296. "
  297. tRESET DATESTYLE|COST_HEAP|COST_INDEX|GEQO|KSQO|n
  298. TIMEZONE|XACTISOLEVEL|CLIENT_ENCODING|SERVER_ENCODING"},
  299. {"revoke",
  300. "revoke access control from a user or group",
  301. "
  302. tREVOKE privilege1, ...privilegeN ON rel1, ...relN FROM n
  303. { PUBLIC | GROUP group | username }n
  304. t privilege is { ALL | SELECT | INSERT | UPDATE | DELETE | RULE }"},
  305. {"rollback work",
  306. "abort a transaction",
  307. "
  308. tROLLBACK [WORK|TRANSACTION]"},
  309. {"select",
  310. "retrieve tuples",
  311. "
  312. tSELECT [DISTINCT [ON attrN]] expr1 [AS attr1], ...exprNn
  313. t[INTO [TEMP] [TABLE] class_name]n
  314. t[FROM from_list]n
  315. t[WHERE qual]n
  316. t[GROUP BY group_list]n
  317. t[HAVING having_clause]n
  318. t[ { UNION [ALL] | INTERSECT | EXCEPT } SELECT ...]n
  319. t[ORDER BY attr1 [ASC|DESC] [USING op1], ...attrN ]n
  320. t[FOR UPDATE [OF class_name...]]n
  321. t[LIMIT count [OFFSET|, count]];"},
  322. {"set",
  323. "set run-time environment",
  324. "
  325. tSET DATESTYLE TO 'ISO'|'SQL'|'Postgres'|'European'|'US'|'NonEuropean'n
  326. tSET COST_HEAP TO #n
  327. tSET COST_INDEX TO #n
  328. tSET GEQO TO 'ON[=#]'|'OFF'n
  329. tSET KSQO TO 'ON'|'OFF'n
  330. tSET TIMEZONE TO 'value'n
  331. tSET TRANSACTION ISOLATION LEVEL 'SERIALIZABLE'|'READ COMMITTED'n
  332. tSET CLIENT_ENCODING|NAMES TO 'EUC_JP'|'SJIS'|'EUC_CN'|'EUC_KR'|'EUC_TW'|n
  333. t  'BIG5'|'MULE_INTERNAL'|'LATIN1'|'LATIN2'|'LATIN3'|'LATIN4'|'LATIN5'|n
  334. t  'KOI8|'WIN'|'ALT'|'WIN1250'n
  335. tSET SERVER_ENCODING TO 'EUC_JP'|'SJIS'|'EUC_CN'|'EUC_KR'|'EUC_TW'|n
  336. t  'BIG5'|'MULE_INTERNAL'|'LATIN1'|'LATIN2'|'LATIN3'|'LATIN4'|'LATIN5'|n
  337. t  'KOI8|'WIN'|'ALT'"},
  338. {"show",
  339. "show current run-time environment",
  340. "
  341. tSHOW DATESTYLE|COST_HEAP|COST_INDEX|GEQO|KSQO|n
  342. TIMEZONE|XACTISOLEVEL|CLIENT_ENCODING|SERVER_ENCODING"},
  343. {"unlisten",
  344. "stop listening for notification on a condition name",
  345. "
  346. tUNLISTEN name|"non-name string"|"*""},
  347. {"update",
  348. "update tuples",
  349. "
  350. tUPDATE class_name SET attr1 = expr1, ...attrN = exprNn
  351. t[FROM from_clause]n
  352. t[WHERE qual];"},
  353. {"vacuum",
  354. "vacuum the database, i.e. cleans out deleted records, updates statistics",
  355. "
  356. tVACUUM [VERBOSE] [ANALYZE] [table]n
  357. torn
  358. tVACUUM [VERBOSE]  ANALYZE  [table [(attr1, ...attrN)]];"},
  359. {NULL, NULL, NULL} /* important to keep a NULL terminator
  360.  * here! */
  361. };