Skip to content
Snippets Groups Projects
Commit 4bec96f1 authored by Bruce Momjian's avatar Bruce Momjian
Browse files

Brought psql help up to date with syntax and manual.

parent 92210d49
No related branches found
No related tags found
No related merge requests found
...@@ -5,7 +5,7 @@ ...@@ -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.4 1996/10/03 04:20:41 momjian Exp $ * $Id: psqlHelp.h,v 1.5 1996/10/03 15:46:31 momjian Exp $
* *
*------------------------------------------------------------------------- *-------------------------------------------------------------------------
*/ */
...@@ -25,7 +25,7 @@ static struct _helpStruct QL_HELP[] = { ...@@ -25,7 +25,7 @@ static struct _helpStruct QL_HELP[] = {
"abort [transaction];"}, "abort [transaction];"},
{ "alter table", { "alter table",
"add/rename attributes, rename tables", "add/rename attributes, rename tables",
"alter table <relname> [*] add column <attr> <type>;\n\talter table <relname> [*] rename [column] <attr1> to <attr2>;\n\talter table <relname1> rename to <relname2>"}, "alter 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",
"begin a new transaction", "begin a new transaction",
"begin [transaction|work];"}, "begin [transaction|work];"},
...@@ -39,8 +39,8 @@ static struct _helpStruct QL_HELP[] = { ...@@ -39,8 +39,8 @@ static struct _helpStruct QL_HELP[] = {
"create a clustered index (from an existing index)", "create a clustered index (from an existing index)",
"cluster <index_name> on <relation_name>"}, "cluster <index_name> on <relation_name>"},
{ "close", { "close",
"close an existing cursor (portal)", "close an existing cursor (cursor)",
"close <portalname>;"}, "close <cursorname>;"},
{ "commit", { "commit",
"commit a transaction", "commit a transaction",
"commit [work]"}, "commit [work]"},
...@@ -49,7 +49,7 @@ static struct _helpStruct QL_HELP[] = { ...@@ -49,7 +49,7 @@ static struct _helpStruct QL_HELP[] = {
"commit [work]"}, "commit [work]"},
{ "copy", { "copy",
"copy data to and from a table", "copy data to and from a table",
"copy [binary] <relname> [with oids]\n\t{to|from} {<filename>|stdin|stdout} [using delimiters <delim>];"}, "copy [binary] <class_name> [with oids]\n\t{to|from} {<filename>|stdin|stdout} [using delimiters <delim>];"},
{ "create", { "create",
"Please more be specific:", "Please more be specific:",
"\tcreate aggregate\n\tcreate database\n\tcreate function\n\tcreate index\n\tcreate operator\n\tcreate rule\n\tcreate table\n\tcreate type\n\tcreate view"}, "\tcreate aggregate\n\tcreate database\n\tcreate function\n\tcreate index\n\tcreate operator\n\tcreate rule\n\tcreate table\n\tcreate type\n\tcreate view"},
...@@ -64,7 +64,7 @@ static struct _helpStruct QL_HELP[] = { ...@@ -64,7 +64,7 @@ static struct _helpStruct QL_HELP[] = {
"create function <function_name> ([<type1>,...<typeN>]) returns <return_type>\n\tas '<object_filename>'|'<sql-queries>'\n\tlanguage 'c'|'sql'|'internal';"}, "create function <function_name> ([<type1>,...<typeN>]) returns <return_type>\n\tas '<object_filename>'|'<sql-queries>'\n\tlanguage 'c'|'sql'|'internal';"},
{ "create index", { "create index",
"construct an index", "construct an index",
"create index <indexname> on <relname> [using <access_method>] (<attr1>|<funcname>(<attr1>,...) [<type_class1>]);"}, "create index <indexname> on <class_name> [using <access_method>] (<attr1>|<funcname>(<attr1>,...) [<type_class1>]);"},
{ "create operator", { "create operator",
"create a user-defined 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 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>]);"},
...@@ -73,7 +73,7 @@ static struct _helpStruct QL_HELP[] = { ...@@ -73,7 +73,7 @@ static struct _helpStruct QL_HELP[] = {
"create rule <rule_name> as on\n\t[select|update|delete|insert]\n\tto <object> [where <qual>]\n\tdo [instead] [<action>|nothing| [<actions>]];"}, "create rule <rule_name> as on\n\t[select|update|delete|insert]\n\tto <object> [where <qual>]\n\tdo [instead] [<action>|nothing| [<actions>]];"},
{ "create table", { "create table",
"create a new table", "create a new table",
"create table <relname> ( <attr1> <type1>,... <attrN> <typeN>)\n\t[inherits (<relname1>,...<relnameN>\n\tarchive=<archive_mode>\n\tstore=<smgr_name>\n\tarch_store=<smgr_name>];"}, "create table <class_name> ( <attr1> <type1>,... <attrN> <typeN>)\n\t[inherits (<class_name1>,...<class_nameN>\n\tarchive=<archive_mode>\n\tstore=<smgr_name>\n\tarch_store=<smgr_name>];"},
{ "create type", { "create type",
"create a new user-defined base data 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 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]);"},
...@@ -81,11 +81,11 @@ static struct _helpStruct QL_HELP[] = { ...@@ -81,11 +81,11 @@ static struct _helpStruct QL_HELP[] = {
"create a view", "create a view",
"create view <view_name> as select <expr1>[as <attr1>][,... <exprN>[as <attrN>]] [from <from_list>] [where <qual>];"}, "create view <view_name> as select <expr1>[as <attr1>][,... <exprN>[as <attrN>]] [from <from_list>] [where <qual>];"},
{ "declare", { "declare",
"set up a cursor (portal)", "set up a cursor",
"declare <portalname> [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>]];"}, "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",
"delete tuples", "delete tuples",
"delete from <relname> [where <qual>];"}, "delete from <class_name> [where <qual>];"},
{ "drop", { "drop",
"Please more be specific:", "Please more be specific:",
"\tdrop aggregate\n\tdrop database\n\tdrop function\n\tdrop index\n\tdrop operator\n\tdrop rule\n\tdrop table\n\tdrop type\n\tdrop view"}, "\tdrop aggregate\n\tdrop database\n\tdrop function\n\tdrop index\n\tdrop operator\n\tdrop rule\n\tdrop table\n\tdrop type\n\tdrop view"},
...@@ -109,7 +109,7 @@ static struct _helpStruct QL_HELP[] = { ...@@ -109,7 +109,7 @@ static struct _helpStruct QL_HELP[] = {
"drop rule <rulename>;"}, "drop rule <rulename>;"},
{ "drop table", { "drop table",
"remove a table", "remove a table",
"drop table <relname>[,...<relnameN];"}, "drop table <class_name>[,...<class_nameN];"},
{ "drop type", { "drop type",
"remove a user-defined base type", "remove a user-defined base type",
"drop type <typename>;"}, "drop type <typename>;"},
...@@ -129,38 +129,38 @@ static struct _helpStruct QL_HELP[] = { ...@@ -129,38 +129,38 @@ static struct _helpStruct QL_HELP[] = {
"extend a partial index", "extend a partial index",
"extend index <indexname> [where <qual>];"}, "extend index <indexname> [where <qual>];"},
{ "fetch", { "fetch",
"retrieve tuples from a cursor (portal)", "retrieve tuples from a cursor",
"fetch [forward|backward] [<number>|all] [in <portalname>];"}, "fetch [forward|backward] [<number>|all] [in <cursorname>];"},
{ "grant", { "grant",
"grant access control to a user or group", "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}"}, "grant <privilege[,privilege,...]> on <rel1>[,...<reln>] to \n[public | group <group> | <username>]\n\t privilege is {ALL | SELECT | INSERT | UPDATE | DELETE | RULE}"},
{ "insert", { "insert",
"insert tuples", "insert tuples",
"insert into <relname> [(<attr1>...<attrN>)]\n\t[values (<expr1>...<exprN>); |\n\tselect <expr1>,...<exprN> [from <from_clause>] [where <qual>];"}, "insert into <class_name> [(<attr1>...<attrN>)]\n\t[values (<expr1>...<exprN>); |\n\tselect <expr1>,...<exprN> [from <from_clause>] [where <qual>];"},
{ "listen", { "listen",
"listen for notification on a relation", "listen for notification on a relation",
"listen <relname>"}, "listen <class_name>"},
{ "load", { "load",
"dynamically load a module", "dynamically load a module",
"load <filename>;"}, "load <filename>;"},
{ "notify", { "notify",
"signal all frontends and backends listening on a relation", "signal all frontends and backends listening on a relation",
"notify <relname>"}, "notify <class_name>"},
{ "purge", { "purge",
"purge historical data", "purge historical data",
"purge <relname> [before <abstime>] [after <reltime>];"}, "purge <class_name> [before <abstime>] [after <reltime>];"},
{ "revoke", { "revoke",
"revoke access control from a user or group", "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}"}, "revoke <privilege[,privilege,...]> on <rel1>[,...<reln>] from \n[public | group <group> | <username>]\n\t privilege is {ALL | SELECT | INSERT | UPDATE | DELETE | RULE}"},
{ "rollback", { "rollback",
"abort a transaction", "abort a transaction",
"rollback [work]"}, "rollback [transaction|work]"},
{ "select", { "select",
"retrieve tuples", "retrieve tuples",
"select [distinct on <attr>] <expr1> [as <attr1>], ... <exprN> [as <attrN>]\n\t[into table <relname>] [from <from_list>]\n\t[where <qual>]\n\t[order by <attr1>\n\t\t[using <op1>],..<attrN> [[using <opN>] | ASC | DESC]];" }, "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]];" },
{ "update", { "update",
"update tuples", "update tuples",
"update <relname> set <attr1>=<expr1>,...<attrN>=<exprN> [from <from_clause>] [where <qual>];"}, "update <class_name> set <attr1>=<expr1>,...<attrN>=<exprN> [from <from_clause>] [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",
"vacuum [table];"}, "vacuum [table];"},
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment