granicus.if.org Git - postgresql/blob - src/bin/psql/sql_help.h

   1 /*
   2  * This file is automatically generated from the SGML documentation.
   3  * Direct changes here will be overwritten.
   4  */
   5 #ifndef SQL_HELP_H
   6 #define SQL_HELP_H
   7
   8 struct _helpStruct
   9 {
  10     char           *cmd;           /* the command name */
  11     char           *help;          /* the help associated with it */
  12     char           *syntax;        /* the syntax associated with it */
  13 };
  14
  15
  16 static struct _helpStruct QL_HELP[] = {
  17     { "TRUNCATE",
  18       "Empty a table",
  19       "TRUNCATE [ TABLE ] name" },
  20
  21     { "ABORT",
  22       "Aborts the current transaction",
  23       "ABORT [ WORK | TRANSACTION ]" },
  24
  25     { "ALTER TABLE",
  26       "Modifies table properties",
  27       "ALTER TABLE table\n    [ * ] ADD [ COLUMN ] ER\">coBLE> type\nALTER TABLE table\n    [ * ] RENAME [ COLUMN ] ER\">coBLE> TO newcolumn\nALTER TABLE table\n    RENAME TO newtable" },
  28
  29     { "ALTER USER",
  30       "Modifies user account information",
  31       "ALTER USER username [ WITH PASSWORD password ]\n    [ CREATEDB | NOCREATEDB ] [ CREATEUSER | NOCREATEUSER ]\n    [ IN GROUP groupname [, ...] ]\n    [ VALID UNTIL 'abstime' ]" },
  32
  33     { "BEGIN",
  34       "Begins a transaction in chained mode",
  35       "BEGIN [ WORK | TRANSACTION ]" },
  36
  37     { "CLOSE",
  38       "Close a cursor",
  39       "CLOSE cursor" },
  40
  41     { "CLUSTER",
  42       "Gives storage clustering advice to the server",
  43       "CLUSTER indexname ON table" },
  44
  45     { "COMMIT",
  46       "Commits the current transaction",
  47       "COMMIT [ WORK | TRANSACTION ]" },
  48
  49     { "COPY",
  50       "Copies data between files and tables",
  51       "COPY [ BINARY ] table [ WITH OIDS ]\n    FROM { 'filename' | stdin }\n    [ [USING] DELIMITERS 'delimiter' ]\nCOPY [ BINARY ] table [ WITH OIDS ]\n    TO { 'filename' | stdout }\n    [ [USING] DELIMITERS 'delimiter' ]" },
  52
  53     { "CREATE AGGREGATE",
  54       "Defines a new aggregate function",
  55       "CREATE AGGREGATE name [ AS ] ( BASETYPE = data_type\n    [ , SFUNC1 = sfunc1, STYPE1 = sfunc1_return_type ]\n    [ , SFUNC2 = sfunc2, STYPE2 = sfunc2_return_type ]\n    [ , FINALFUNC = ffunc ]\n    [ , INITCOND1 = initial_condition1 ]\n    [ , INITCOND2 = initial_condition2 ] )" },
  56
  57     { "CREATE DATABASE",
  58       "Creates a new database",
  59       "CREATE DATABASE name [ WITH LOCATION = 'dbpath' ]" },
  60
  61     { "CREATE FUNCTION",
  62       "Defines a new function",
  63       "CREATE FUNCTION name ( [ ftype [, ...] ] )\n    RETURNS rtype\n    [ WITH ( attribute [, ...] ) ]\n    AS definition   \n    LANGUAGE 'langname'\n\n\nCREATE FUNCTION name ( [ ftype [, ...] ] )\n    RETURNS rtype\n    [ WITH ( attribute [, ...] ) ]\n    AS obj_file , link_symbol  \n    LANGUAGE 'C'" },
  64
  65     { "CREATE INDEX",
  66       "Constructs a secondary index",
  67       "CREATE [ UNIQUE ] INDEX index_name ON table\n    [ USING acc_name ] ( column [ ops_name] [, ...] )\nCREATE [ UNIQUE ] INDEX index_name ON table\n    [ USING acc_name ] ( func_name( r\">colle> [, ... ]) ops_name )" },
  68
  69     { "CREATE LANGUAGE",
  70       "Defines a new language for functions",
  71       "CREATE [ TRUSTED ] PROCEDURAL LANGUAGE 'langname'\n    HANDLER call_handler\n    LANCOMPILER 'comment'" },
  72
  73     { "CREATE OPERATOR",
  74       "Defines a new user operator",
  75       "CREATE OPERATOR name ( PROCEDURE = func_name\n     [, LEFTARG = type1 ] [, RIGHTARG = type2 ]\n     [, COMMUTATOR = com_op ] [, NEGATOR = neg_op ]\n     [, RESTRICT = res_proc ] [, JOIN = join_proc ]\n     [, HASHES ] [, SORT1 = left_sort_op ] [, SORT2 = right_sort_op ] )" },
  76
  77     { "CREATE RULE",
  78       "Defines a new rule",
  79       "CREATE RULE name AS ON event\n    TO object [ WHERE condition ]\n    DO [ INSTEAD ] [ action | NOTHING ]" },
  80
  81     { "CREATE SEQUENCE",
  82       "Creates a new sequence number generator",
  83       "CREATE SEQUENCE seqname [ INCREMENT increment ]\n    [ MINVALUE minvalue ] [ MAXVALUE maxvalue ]\n    [ START start ] [ CACHE cache ] [ CYCLE ]" },
  84
  85     { "CREATE TABLE",
  86       "Creates a new table",
  87       "CREATE [ TEMPORARY | TEMP ] TABLE table (\n    column type\n    [ NULL | NOT NULL ] [ UNIQUE ] [ DEFAULT value ]\n    [column_constraint_clause | PRIMARY KEY } [ ... ] ]\n    [, ... ]\n    [, PRIMARY KEY ( column [, ...] ) ]\n    [, CHECK ( condition ) ]\n    [, table_constraint_clause ]\n    ) [ INHERITS ( inherited_table [, ...] ) ]" },
  88
  89     { "CREATE TABLE AS",
  90       "Creates a new table",
  91       "CREATE TABLE table [ (column [, ...] ) ]\n     AS select_clause" },
  92
  93     { "CREATE TRIGGER",
  94       "Creates a new trigger",
  95       "CREATE TRIGGER name { BEFORE | AFTER } { event [OR ...] }\n    ON table FOR EACH { ROW | STATEMENT }\n    EXECUTE PROCEDURE ER\">funcBLE> ( arguments )" },
  96
  97     { "CREATE TYPE",
  98       "Defines a new base data type",
  99       "CREATE TYPE typename ( INPUT = input_function, OUTPUT = output_function\n      , INTERNALLENGTH = { internallength | VARIABLE } [ , EXTERNALLENGTH = { externallength | VARIABLE } ]\n    [ , DEFAULT = \"default\" ]\n    [ , ELEMENT = element ] [ , DELIMITER = delimiter ]\n    [ , SEND = send_function ] [ , RECEIVE = receive_function ]\n    [ , PASSEDBYVALUE ] )" },
 100
 101     { "CREATE USER",
 102       "Creates account information for a new user",
 103       "CREATE USER username\n    [ WITH PASSWORD password ]\n    [ CREATEDB   | NOCREATEDB ] [ CREATEUSER | NOCREATEUSER ]\n    [ IN GROUP     groupname [, ...] ]\n    [ VALID UNTIL  'abstime' ]" },
 104
 105     { "CREATE VIEW",
 106       "Constructs a virtual table",
 107       "CREATE VIEW view AS SELECT query" },
 108
 109     { "DECLARE",
 110       "Defines a cursor for table access",
 111       "DECLARE cursor [ BINARY ] [ INSENSITIVE ] [ SCROLL ]\n    CURSOR FOR query\n    [ FOR { READ ONLY | UPDATE [ OF column [, ...] ] ]" },
 112
 113     { "DELETE",
 114       "Removes rows from a table",
 115       "DELETE FROM table [ WHERE condition ]" },
 116
 117     { "DROP AGGREGATE",
 118       "Removes the definition of an aggregate function",
 119       "DROP AGGREGATE name type" },
 120
 121     { "FETCH",
 122       "Gets rows using a cursor",
 123       "FETCH [ selector ] [ count ] { IN | FROM } cursor\nFETCH [ RELATIVE ] [ { [ # | ALL | NEXT | PRIOR ] } ] FROM ] cursor" },
 124
 125     { "DROP DATABASE",
 126       "Destroys an existing database",
 127       "DROP DATABASE name" },
 128
 129     { "DROP FUNCTION",
 130       "Removes a user-defined C function",
 131       "DROP FUNCTION name ( [ type [, ...] ] )" },
 132
 133     { "DROP INDEX",
 134       "Removes an index from a database",
 135       "DROP INDEX index_name" },
 136
 137     { "DROP LANGUAGE",
 138       "Removes a user-defined procedural language",
 139       "DROP PROCEDURAL LANGUAGE 'name'" },
 140
 141     { "DROP OPERATOR",
 142       "Removes an operator from the database",
 143       "DROP OPERATOR id ( type | NONE [,...] )" },
 144
 145     { "DROP RULE",
 146       "Removes an existing rule from the database",
 147       "DROP RULE name" },
 148
 149     { "DROP SEQUENCE",
 150       "Removes an existing sequence",
 151       "DROP SEQUENCE name [, ...]" },
 152
 153     { "DROP TABLE",
 154       "Removes existing tables from a database",
 155       "DROP TABLE name [, ...]" },
 156
 157     { "DROP TRIGGER",
 158       "Removes the definition of a trigger",
 159       "DROP TRIGGER name ON table" },
 160
 161     { "DROP TYPE",
 162       "Removes a user-defined type from the system catalogs",
 163       "DROP TYPE typename" },
 164
 165     { "DROP USER",
 166       "Removes an user account information",
 167       "DROP USER name" },
 168
 169     { "DROP VIEW",
 170       "Removes an existing view from a database",
 171       "DROP VIEW name" },
 172
 173     { "EXPLAIN",
 174       "Shows statement execution details",
 175       "EXPLAIN [ VERBOSE ] query" },
 176
 177     { "GRANT",
 178       "Grants access privilege to a user, a group or all users",
 179       "GRANT privilege [, ...] ON object [, ...]\n    TO { PUBLIC | GROUP group | username }" },
 180
 181     { "INSERT",
 182       "Inserts new rows into a table",
 183       "INSERT INTO table [ ( column [, ...] ) ]\n    { VALUES ( expression [, ...] ) | SELECT query }" },
 184
 185     { "LISTEN",
 186       "Listen for a response on a notify condition",
 187       "LISTEN name" },
 188
 189     { "LOAD",
 190       "Dynamically loads an object file",
 191       "LOAD 'filename'" },
 192
 193     { "LOCK",
 194       "Explicitly lock a table inside a transaction",
 195       "LOCK [ TABLE ] name\nLOCK [ TABLE ] name IN [ ROW | ACCESS ] { SHARE | EXCLUSIVE } MODE\nLOCK [ TABLE ] name IN SHARE ROW EXCLUSIVE MODE" },
 196
 197     { "MOVE",
 198       "Moves cursor position",
 199       "MOVE [ selector ] [ count ] \n    { IN | FROM } cursor\n    FETCH [ RELATIVE ] [ { [ # | ALL | NEXT | PRIOR ] } ] FROM ] cursor" },
 200
 201     { "NOTIFY",
 202       "Signals all frontends and backends listening on a notify condition",
 203       "NOTIFY name" },
 204
 205     { "RESET",
 206       "Restores run-time parameters for session to default values",
 207       "RESET variable" },
 208
 209     { "REVOKE",
 210       "Revokes access privilege from a user, a group or all users.",
 211       "REVOKE privilege [, ...]\n    ON object [, ...]\n    FROM { PUBLIC | GROUP ER\">gBLE> | username }" },
 212
 213     { "ROLLBACK",
 214       "Aborts the current transaction",
 215       "ROLLBACK [ WORK | TRANSACTION ]" },
 216
 217     { "SELECT",
 218       "Retrieve rows from a table or view.",
 219       "SELECT [ ALL | DISTINCT [ ON column ] ]\n    expression [ AS name ] [, ...]\n    [ INTO [ TEMPORARY | TEMP ] [ TABLE ] new_table ]\n    [ FROM table [ alias ] [, ...] ]\n    [ WHERE condition ]\n    [ GROUP BY column [, ...] ]\n    [ HAVING condition [, ...] ]\n    [ { UNION [ ALL ] | INTERSECT | EXCEPT } select ]\n    [ ORDER BY column [ ASC | DESC ] [, ...] ]\n    [ FOR UPDATE [ OF class_name... ] ]\n    [ LIMIT { count | ALL } [ { OFFSET | , } count ] ]" },
 220
 221     { "SELECT INTO",
 222       "Create a new table from an existing table or view",
 223       "SELECT [ ALL | DISTINCT ] expression [ AS name ] [, ...]\n    INTO [TEMP] [ TABLE ] new_table ]\n    [ FROM table [alias] [, ...] ]\n    [ WHERE condition ]\n    [ GROUP BY column [, ...] ]\n    [ HAVING condition [, ...] ]\n    [ { UNION [ALL] | INTERSECT | EXCEPT } select]\n    [ ORDER BY column [ ASC | DESC ] [, ...] ]\n    [ FOR UPDATE [OF class_name...]]\n    [ LIMIT count [OFFSET|, count]]" },
 224
 225     { "SET",
 226       "Set run-time parameters for session",
 227       "SET variable { TO | = } { 'value' | DEFAULT }\nSET TIME ZONE { 'timezone' | LOCAL | DEFAULT }\nSET TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZABLE }" },
 228
 229     { "SHOW",
 230       "Shows run-time parameters for session",
 231       "SHOW keyword" },
 232
 233     { "UNLISTEN",
 234       "Stop listening for notification",
 235       "UNLISTEN { notifyname | * }" },
 236
 237     { "UPDATE",
 238       "Replaces values of columns in a table",
 239       "UPDATE table SET R\">colle> = expression [, ...]\n    [ FROM fromlist ]\n    [ WHERE condition ]" },
 240
 241     { "VACUUM",
 242       "Clean and analyze a Postgres database",
 243       "VACUUM [ VERBOSE ] [ ANALYZE ] [ table ]\nVACUUM [ VERBOSE ] ANALYZE [ ER\">tBLE> [ (column [, ...] ) ] ]" },
 244
 245     { "END",
 246       "Commits the current transaction",
 247       "END [ WORK | TRANSACTION ]" },
 248
 249     { "COMMENT",
 250       "Add comment to an object",
 251       "COMMENT ON\n[\n  [ DATABASE | INDEX | RULE | SEQUENCE | TABLE | TYPE | VIEW ]\n  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'" },
 252
 253
 254     { NULL, NULL, NULL }    /* End of list marker */
 255 };
 256
 257 #endif /* SQL_HELP_H */