Repository: incubator-hawq-docs Updated Branches: refs/heads/develop bb347aaa6 -> c0f35d98b
HAWQ-1175 Correct hawq scp syntax description for -J option. This closes #66 Project: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/commit/c0f35d98 Tree: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/tree/c0f35d98 Diff: http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/diff/c0f35d98 Branch: refs/heads/develop Commit: c0f35d98ba8fa49e24632fc16d54f3fab780e951 Parents: bb347aa Author: David Yozie <[email protected]> Authored: Tue Nov 29 15:46:30 2016 -0800 Committer: David Yozie <[email protected]> Committed: Tue Nov 29 15:46:30 2016 -0800 ---------------------------------------------------------------------- .../admin_utilities/hawqregister.html.md.erb | 6 ++--- .../cli/admin_utilities/hawqscp.html.md.erb | 4 +-- .../cli/client_utilities/pg_dump.html.md.erb | 8 +++--- .../cli/client_utilities/pg_dumpall.html.md.erb | 18 +++++++------- reference/cli/client_utilities/psql.html.md.erb | 26 ++++++++++---------- 5 files changed, 31 insertions(+), 31 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/c0f35d98/reference/cli/admin_utilities/hawqregister.html.md.erb ---------------------------------------------------------------------- diff --git a/reference/cli/admin_utilities/hawqregister.html.md.erb b/reference/cli/admin_utilities/hawqregister.html.md.erb index 5ff8dc3..c230d6d 100644 --- a/reference/cli/admin_utilities/hawqregister.html.md.erb +++ b/reference/cli/admin_utilities/hawqregister.html.md.erb @@ -223,8 +223,8 @@ This example shows how to register files using a YAML configuration file. This f Create a table and insert data into the table: ``` -=> create table paq1(a int, b varchar(10))with(appendonly=true, orientation=parquet);` -=> insert into paq1 values(generate_series(1,1000), 'abcde'); +=> CREATE TABLE paq1(a int, b varchar(10))with(appendonly=true, orientation=parquet);` +=> INSERT INTO paq1 values(generate_series(1,1000), 'abcde'); ``` Extract the table's metadata. @@ -242,7 +242,7 @@ hawq register --config paq1.yml paq2 Select the new table to determine if the content has already been registered: ``` -=> select count(*) from paq2; +=> SELECT count(*) FROM paq2; ``` The result should return 1000. http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/c0f35d98/reference/cli/admin_utilities/hawqscp.html.md.erb ---------------------------------------------------------------------- diff --git a/reference/cli/admin_utilities/hawqscp.html.md.erb b/reference/cli/admin_utilities/hawqscp.html.md.erb index a890822..77f64a8 100644 --- a/reference/cli/admin_utilities/hawqscp.html.md.erb +++ b/reference/cli/admin_utilities/hawqscp.html.md.erb @@ -21,7 +21,7 @@ hawq scp --version The `hawq scp` utility allows you to copy one or more files from the specified hosts to other specified hosts in one command using SCP (secure copy). For example, you can copy a file from the HAWQ master host to all of the segment hosts at the same time. -To specify the hosts involved in the SCP session, use the `-f` option to specify a file containing a list of host names, or use the `-h` option to name single host names on the command-line. At least one host name (`-h`) or a host file (`-f`) is required. The `-J` option allows you to specify a single character to substitute for the *hostname* in the `copy from` and `copy to` destination strings. If `-J` is not specified, the default substitution character is an equal sign (`=`). For example, the following command will copy `.bashrc` from the local host to `/home/gpadmin` on all hosts named in `hostfile_gpssh`: +To specify the hosts involved in the SCP session, use the `-f` option to specify a file containing a list of host names, or use the `-h` option to name single host names on the command-line. At least one host name (`-h`) or a host file (`-f`) is required. The `-J` option allows you to specify a single character to substitute for the *hostname* in the `<file_to_copy>` and `<copy_to_path>` destination strings. If `-J` is not specified, the default substitution character is an equal sign (`=`). For example, the following command will copy `.bashrc` from the local host to `/home/gpadmin` on all hosts named in `hostfile_gpssh`: ``` shell $ hawq scp -f hostfile_hawqssh .bashrc =:/home/gpadmin @@ -59,7 +59,7 @@ Overrides copying configuration files to a host on which SSH validation fails. I </dd> <dt>-J \<character\> </dt> -<dd>The `-J` option allows you to specify a single character to substitute for the \<hostname\> in the `copy from` and `copy to` destination strings. If `-J` is not specified, the default substitution character is an equal sign (`=`).</dd> +<dd>The `-J` option allows you to specify a single character to substitute for the \<hostname\> in the `<file_to_copy\>` and `<copy_to_path\>` destination strings. If `-J` is not specified, the default substitution character is an equal sign (`=`).</dd> <dt>-v (verbose mode) </dt> http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/c0f35d98/reference/cli/client_utilities/pg_dump.html.md.erb ---------------------------------------------------------------------- diff --git a/reference/cli/client_utilities/pg_dump.html.md.erb b/reference/cli/client_utilities/pg_dump.html.md.erb index 6758df9..d4a3186 100644 --- a/reference/cli/client_utilities/pg_dump.html.md.erb +++ b/reference/cli/client_utilities/pg_dump.html.md.erb @@ -81,7 +81,7 @@ When used with one of the archive file formats and combined with `pg_restore`, ` <dd>Include large objects in the dump. This is the default behavior except when `--schema`, `--table`, or `--schema-only` is specified, so the `-b` switch is only useful to add large objects to selective dumps.</dd> <dt>-c, -\\\-clean </dt> -<dd>Adds commands to the text output file to clean (drop) database objects prior to (the commands for) creating them. Note that objects are not dropped before the dump operation begins, but `DROP` commands are added to the DDL dump output files so that when you use those files to do a restore, the `DROP` commands are run prior to the `CREATE` commands. This option is only meaningful for the plain-text format. For the archive formats, you may specify the option when you call [pg\_restore](pg_restore.html#topic1).</dd> +<dd>Adds commands to the text output file to clean (DROP) database objects prior to (the commands for) creating them. Note that objects are not dropped before the dump operation begins, but `DROP` commands are added to the DDL dump output files so that when you use those files to do a restore, the `DROP` commands are run prior to the `CREATE` commands. This option is only meaningful for the plain-text format. For the archive formats, you may specify the option when you call [pg\_restore](pg_restore.html#topic1).</dd> <dt>-C, -\\\-create </dt> <dd>Begin the output with a command to create the database itself and reconnect to the created database. (With a script of this form, it doesn't matter which database you connect to before running the script.) This option is only meaningful for the plain-text format. For the archive formats, you may specify the option when you call [pg\_restore](pg_restore.html#topic1).</dd> @@ -108,17 +108,17 @@ c, custom â Output a custom archive suitable for input into [pg\_restore](pg_r t, tar â Output a tar archive suitable for input into [pg\_restore](pg_restore.html#topic1). Using this archive format allows reordering and/or exclusion of database objects at the time the database is restored. It is also possible to limit which data is reloaded at restore time.</dd> <dt>-i, -\\\-ignore-version </dt> -<dd>Ignore version mismatch between `pg_dump` and the database server. `pg_dump` can dump from servers running previous releases of HAWQ (or PostgreSQL), but very old versions may not be supported anymore. Use this option if you need to override the version check.</dd> +<dd>Ignore version mismatch between `pg_dump` and the database server. `pg_dump` can dump from servers running previous releases of HAWQ (or PostgreSQL). However, some older versions might not be supported. Use this option if you need to override the version check.</dd> <dt>-n, -\\\-schema \<schema\> </dt> <dd>Dump only schemas matching the schema pattern; this selects both the schema itself, and all its contained objects. When this option is not specified, all non-system schemas in the target database will be dumped. Multiple schemas can be selected by writing multiple `-n` switches. Also, the schema parameter is interpreted as a pattern according to the same rules used by `psql`'s` \d` commands, so multiple schemas can also be selected by writing wildcard characters in the pattern. When using wildcards, be careful to quote the pattern if needed to prevent the shell from expanding the wildcards. -**Note:** When -n is specified, `pg_dump` makes no attempt to dump any other database objects that the selected schema(s) may depend upon. Therefore, there is no guarantee that the results of a specific-schema dump can be successfully restored by themselves into a clean database. +**Note:** When `-n` is specified, `pg_dump` makes no attempt to dump any other database objects that the selected schema(s) may depend upon. Therefore, there is no guarantee that the results of a specific-schema dump can be successfully restored by themselves into a clean database. **Note:** Non-schema objects such as blobs are not dumped when `-n` is specified. You can add blobs back to the dump with the `--blobs` switch.</dd> <dt>-N, -\\\-exclude-schema \<schema\> </dt> -<dd>Do not dump any schemas matching the schema pattern. The pattern is interpreted according to the same rules as for `-n`. `-N` can be given more than once to exclude schemas matching any of several patterns. When both `-n` and `-N` are given, the behavior is to dump just the schemas that match at least one `-n` switch but no `-N` switches. If `-N` appears without `-n`, then schemas matching `-N` are excluded from what is otherwise a normal dump.</dd> +<dd>Do not dump any schemas matching the schema pattern. The pattern is interpreted according to the same rules as for `-n`. `-N` can be specified multiple times to exclude schemas that match several different patterns. When both `-n` and `-N` are specified, the behavior is to dump only schemas that match at least one `-n` switch but no `-N` switches. If `-N` appears without `-n`, then schemas matching `-N` are excluded from an otherwise normal dump.</dd> <dt>-o, -\\\-oids </dt> <dd>Dump object identifiers (OIDs) as part of the data for every table. Use of this option is not recommended for files that are intended to be restored into HAWQ.</dd> http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/c0f35d98/reference/cli/client_utilities/pg_dumpall.html.md.erb ---------------------------------------------------------------------- diff --git a/reference/cli/client_utilities/pg_dumpall.html.md.erb b/reference/cli/client_utilities/pg_dumpall.html.md.erb index 7e86fdf..255b459 100644 --- a/reference/cli/client_utilities/pg_dumpall.html.md.erb +++ b/reference/cli/client_utilities/pg_dumpall.html.md.erb @@ -52,11 +52,11 @@ where: `pg_dumpall` creates a single script file that contains SQL commands that can be used as input to [psql](psql.html#topic1) to restore the databases. It does this by calling [pg\_dump](pg_dump.html#topic1) for each database. `pg_dumpall` also dumps global objects that are common to all databases. (`pg_dump` does not save these objects.) This currently includes information about database users and groups, and access permissions that apply to databases as a whole. -Since `pg_dumpall` reads tables from all databases you will most likely have to connect as a database superuser in order to produce a complete dump. Also you will need superuser privileges to execute the saved script in order to be allowed to add users and groups, and to create databases. +Since `pg_dumpall` reads tables from all databases, connect as a database superuser to assure producing a complete dump, as well as to execute the saved script, add users and groups, and to create databases. The SQL script will be written to the standard output. Shell operators should be used to redirect it into a file. -`pg_dumpall` needs to connect several times to the HAWQ master server (once per database). If you use password authentication it is likely to ask for a password each time. It is convenient to have a `~/.pgpass` file in such cases. +`pg_dumpall` needs to connect to the HAWQ master server several times (once per database). If you use password authentication, a password could be requested for each connection, so using a `~/.pgpass` file is recommended. ## <a id="topic1__section4"></a>Options @@ -65,7 +65,7 @@ The SQL script will be written to the standard output. Shell operators should be <dd>Dump filespace definitions.</dd> <dt>-i | -\\\-ignore-version </dt> -<dd>Ignore version mismatch between [pg\_dump](pg_dump.html#topic1) and the database server. `pg_dump` can dump from servers running previous releases of HAWQ (or PostgreSQL), but very old versions may not be supported anymore. Use this option if you need to override the version check.</dd> +<dd>Ignore version mismatch between [pg\_dump](pg_dump.html#topic1) and the database server. `pg_dump` can dump from servers running previous releases of HAWQ (or PostgreSQL), but some older versions may not be supported. Use this option if you need to override the version check.</dd> <dt>--help</dt> <dd>Displays this help, then exits.</dt> @@ -76,10 +76,10 @@ The SQL script will be written to the standard output. Shell operators should be **Output Control Options** <dt>-a | -\\\-data-only </dt> -<dd>Dump only the data, not the schema (data definitions). This option is only meaningful for the plain-text format. For the archive formats, you may specify the option when you call [pg\_restore](pg_restore.html#topic1).</dd> +<dd>Dump only the data, not the schema (data definitions). This option is only meaningful for the plain-text format. For the archive formats, you can specify this option when you call [pg\_restore](pg_restore.html#topic1).</dd> <dt>-c | -\\\-clean </dt> -<dd>Output commands to clean (drop) database objects prior to (the commands for) creating them. This option is only meaningful for the plain-text format. For the archive formats, you may specify the option when you call [pg\_restore](pg_restore.html#topic1).</dd> +<dd>Output commands to clean (DROP) database objects prior to (the commands for) creating them. This option is only meaningful for the plain-text format. For the archive formats, you may specify the option when you call [pg\_restore](pg_restore.html#topic1).</dd> <dt>-d | -\\\-inserts </dt> <dd>Dump data as `INSERT` commands (rather than `COPY`). This will make restoration very slow; it is mainly useful for making dumps that can be loaded into non-PostgreSQL-based databases. Also, since this option generates a separate command for each row, an error in reloading a row causes only that row to be lost rather than the entire table contents. Note that the restore may fail altogether if you have rearranged column order. The `-D` option is safe against column order changes, though even slower.</dd> @@ -91,7 +91,7 @@ The SQL script will be written to the standard output. Shell operators should be <dd>Dump only global objects (roles and tablespaces), no databases.</dd> <dt>-o | -\\\-oids </dt> -<dd>Dump object identifiers (OIDs) as part of the data for every table. Use of this option is not recommended for files that are intended to be restored into HAWQ.</dd> +<dd>Dump object identifiers (OIDs) as part of the data for every table. Use of this option is not recommended for files to be restored into HAWQ.</dd> <dt>-O | -\\\-no-owner </dt> <dd>Do not output commands to set ownership of objects to match the original database. By default, [pg\_dump](pg_dump.html#topic1) issues `ALTER OWNER` or `SET SESSION AUTHORIZATION` statements to set ownership of created database objects. These statements will fail when the script is run unless it is started by a superuser (or the same user that owns all of the objects in the script). To make a script that can be restored by any user, but will give that user ownership of all the objects, specify `-O`. This option is only meaningful for the plain-text format. For the archive formats, you may specify the option when you call [pg\_restore](pg_restore.html#topic1).</dd> @@ -103,7 +103,7 @@ The SQL script will be written to the standard output. Shell operators should be <dd>Dump only the object definitions (schema), not data.</dd> <dt>-S \<username\> | -\\\-superuser=\<username\> </dt> -<dd>Specify the superuser user name to use when disabling triggers. This is only relevant if `--disable-triggers` is used. It is better to leave this out, and instead start the resulting script as a superuser. +<dd>Specify the superuser user name to use when disabling triggers. This option is only relevant if `--disable-triggers` is used. Starting the resulting script as a superuser is preferred. **Note:** HAWQ does not support user-defined triggers.</dd> @@ -114,7 +114,7 @@ The SQL script will be written to the standard output. Shell operators should be <dd>This option disables the use of dollar quoting for function bodies, and forces them to be quoted using SQL standard string syntax.</dd> <dt>-\\\-disable-triggers </dt> -<dd>This option is only relevant when creating a data-only dump. It instructs `pg_dumpall` to include commands to temporarily disable triggers on the target tables while the data is reloaded. Use this if you have triggers on the tables that you do not want to invoke during data reload. The commands emitted for `--disable-triggers` must be done as superuser. So, you should also specify a superuser name with `-S`, or preferably be careful to start the resulting script as a superuser. +<dd>This option is only relevant when creating a data-only dump. It instructs `pg_dumpall` to include commands to temporarily disable triggers on the target tables while the data is reloaded. Use this if you do not want to invoke triggers on the tables during data reload. You need superuser permissions to perform commands issued for `--disable-triggers`. Either specify a superuser name with the `-S` option, or start the resulting script as a superuser. **Note:** HAWQ does not support user-defined triggers.</dd> @@ -153,7 +153,7 @@ Since `pg_dumpall` calls [pg\_dump](pg_dump.html#topic1) internally, some diagno Once restored, it is wise to run `ANALYZE` on each database so the query planner has useful statistics. You can also run `vacuumdb -a -z` to analyze all databases. -`pg_dumpall` requires all needed tablespace (filespace) directories to exist before the restore or database creation will fail for databases in non-default locations. +All tablespace (filespace) directories used by `pg_dumpall` must exist before the restore. Otherwise, database creation will fail for databases in non-default locations. ## <a id="topic1__section8"></a>Examples http://git-wip-us.apache.org/repos/asf/incubator-hawq-docs/blob/c0f35d98/reference/cli/client_utilities/psql.html.md.erb ---------------------------------------------------------------------- diff --git a/reference/cli/client_utilities/psql.html.md.erb b/reference/cli/client_utilities/psql.html.md.erb index b3ee5f6..ee245e6 100644 --- a/reference/cli/client_utilities/psql.html.md.erb +++ b/reference/cli/client_utilities/psql.html.md.erb @@ -189,7 +189,7 @@ If the script itself uses `BEGIN`, `COMMIT`, or `ROLLBACK`, this option will not <dd>Force a password prompt. `psql` should automatically prompt for a password whenever the server requests password authentication. However, currently password request detection is not totally reliable, hence this option to force a prompt. If no password prompt is issued and the server requires password authentication, the connection attempt will fail.</dd> <dt>-w -\\\-no-password </dt> -<dd>Never issue a password prompt. If the server requires password authentication and a password is not available by other means such as a .pgpass file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password. +<dd>Never issue a password prompt. If the server requires password authentication and a password is not available by other means, such as through a `~/.pgpass` file, the connection attempt will fail. This option can be useful in batch jobs and scripts where no user is present to enter a password. **Note:** This option remains set for the entire session, and so it affects uses of the meta-command `\connect` as well as the initial connection attempt.</dd> @@ -201,7 +201,7 @@ If the script itself uses `BEGIN`, `COMMIT`, or `ROLLBACK`, this option will not **Connecting to a Database** -`psql` is a client application for HAWQ. In order to connect to a database you need to know the name of your target database, the host name and port number of the HAWQ master server and what database user name you want to connect as. `psql` can be told about those parameters via command line options, namely `-d`, `-h`, `-p`, and `-U` respectively. If an argument is found that does not belong to any option it will be interpreted as the database name (or the user name, if the database name is already given). Not all these options are required; there are useful defaults. If you omit the host name, `psql` will connect via a UNIX-domain socket to a master server on the local host, or via TCP/IP to `localhost` on machines that do not have UNIX-domain sockets. The default master port number is 5432. If you use a different port for the master, you must specify the port. The default database user name is your UNIX user name, as is the default database name. Note that you cannot just connect to any database under any user name. Your database administrator should have informed you about your access rights. +`psql` is a client application for HAWQ. To connect to a database you must know the name of your target database, the host name and port number of the HAWQ master server and what database user name you want to connect as. Use the `-d`, `-h`, `-p`, and `-U` command line options, respectively, to specify these parameters to `psql`. If an argument is found that does not belong to any option, it will be interpreted as the database name (or the user name, if the database name is already given). Not all these options are required; there are useful defaults. If you omit the host name, `psql` will connect via a UNIX-domain socket to a master server on the local host, or via TCP/IP to `localhost` on machines that do not have UNIX-domain sockets. The default master port number is 5432. If you use a different port for the master, you must specify the port. The default database user name is your UNIX user name, as is the default database name. Note that you cannot just connect to any database u nder any user name. Your database administrator should have informed you about your access rights. When the defaults are not right, you can save yourself some typing by setting any or all of the environment variables `PGAPPNAME`, `PGDATABASE`, `PGHOST`, `PGPORT`, and `PGUSER` to appropriate values. @@ -217,7 +217,7 @@ If the connection could not be made for any reason (insufficient privileges, ser **Entering SQL Commands** -In normal operation, `psql` provides a prompt with the name of the database to which `psql` is currently connected, followed by the string **=>** for a regular user or **=\#** for a superuser. For example: +In normal operation, `psql` provides a prompt with the name of the database to which `psql` is currently connected, followed by the string `=>` for a regular user or `=#` for a superuser. For example: ``` pre testdb=> @@ -387,7 +387,7 @@ The response indicates that the large object received object ID 152801 which one <dt>\\prompt \[ \<text\> \] \<name\> </dt> <dd>Prompts the user to set a variable \<name\>. Optionally, you can specify a prompt. Enclose prompts longer than one word in single quotes. -By default, \\prompt uses the terminal for input and output. However, use the -f command line switch to specify standard input and standard output.</dd> +By default, `\prompt` uses the terminal for input and output. However, you can use the `-f` command line switch to specify standard input and standard output.</dd> <dt>\\pset \<print\_option\> \[\<value\>\] </dt> <dd>This command sets options affecting the output of query result tables. \<print\_option\> describes which option is to be set. Adjustable printing options are: @@ -399,9 +399,9 @@ By default, \\prompt uses the terminal for input and output. However, use the -f **Note:** Since `psql` does not attempt to wrap column header titles, the wrapped format behaves the same as aligned if the total width needed for column headers exceeds the target. - **`border`** â The second argument must be a number. In general, the higher the number the more borders and lines the tables will have, but this depends on the particular format. In HTML mode, this will translate directly into the `border=...` attribute, in the others only values `0` (no border), `1` (internal dividing lines), and `2` (table frame) make sense. -- **`columns`** â Sets the target width for the `wrapped` format, and also the width limit for determining whether output is wide enough to require the pager. The default is *zero*. Zero causes the target width to be controlled by the environment variable `COLUMNS`, or the detected screen width if `COLUMNS` is not set. In addition, if `columns` is zero then the wrapped format affects screen output only. If columns is nonzero then file and pipe output is wrapped to that width as well. +- **`columns`** â Sets the target width for the `wrapped` format, and also the width limit for determining whether output is wide enough to require the pager. The default is *zero*. Zero causes the target width to be controlled by the environment variable `COLUMNS`, or the detected screen width if `COLUMNS` is not set. In addition, if `COLUMNS` is zero, then the wrapped format affects screen output only. If `COLUMNS` is nonzero, then file and pipe output is wrapped to that width as well. - After setting the target width, use the command `\pset format wrapped` to enable the wrapped format. + After setting the target width, use the command `\pset format wrapped` to enable the wrapped format. - **`expanded`**, **`x`** â Toggles between regular and expanded format. When expanded format is enabled, query results are displayed in two columns, with the column name on the left and the data on the right. This mode is useful if the data would not fit on the screen in the normal horizontal mode. Expanded mode is supported by all four output formats. - **`linestyle`** \[**`unicode`** | **`ascii`** | **`old-ascii`**\] â Sets the border line drawing style to one of unicode, ascii, or old-ascii. Unique abbreviations, including one letter, are allowed for the three styles. The default setting is `ascii`. This option only affects the `aligned` and `wrapped` output formats. @@ -421,7 +421,7 @@ By default, \\prompt uses the terminal for input and output. However, use the -f - **`recordsep`** â Specifies the record (line) separator to use in unaligned output mode. The default is a newline character. - **`title`** \[\<text\>\] â Sets the table title for any subsequently printed tables. This can be used to give your output descriptive tags. If no argument is given, the title is unset. - **`tableattr`**, **`T`** \[\<text\>\] â Allows you to specify any attributes to be placed inside the HTML table tag. This could for example be `cellpadding` or `bgcolor`. Note that you probably don't want to specify border here, as that is already taken care of by `\pset border`. -- **`tuples_only`**, **`t `** \[ novalue | on | off \] â The `\pset tuples_only` command by itselt toggles between tuples only and full display. The values \<on\> and \</off\> set the tuples display, regardless of the current setting. Full display may show extra information such as column headers, titles, and various footers. In tuples only mode, only actual table data is shown The `\t` command is equivalent to `\pset``tuples_only` and is provided for convenience. +- **`tuples_only`**, **`t `** \[ novalue | on | off \] â The `\pset tuples_only` command by itself toggles between tuples only and full display. The values `on` and `off` set the tuples display, regardless of the current setting. Full display may show extra information such as column headers, titles, and various footers. In tuples only mode, only actual table data is shown The `\t` command is equivalent to `\pset``tuples_only` and is provided for convenience. - **`pager`** â Controls the use of a pager for query and `psql` help output. When `on`, if the environment variable `PAGER` is set, the output is piped to the specified program. Otherwise a platform-dependent default (such as `more`) is used. When `off`, the pager is not used. When `on`, the pager is used only when appropriate. Pager can also be set to `always`, which causes the pager to be always used. </dd> @@ -503,7 +503,7 @@ bar If you call `\set` without a second argument, the variable is set, with an empty string as \<value\>. To unset (or delete) a variable, use the command `\unset`. -`psql`'s internal variable names can consist of letters, numbers, and underscores in any order and any number of them. A number of these variables are treated specially by `psql`. They indicate certain option settings that can be changed at run time by altering the value of the variable or represent some state of the application. Although you can use these variables for any other purpose, this is not recommended, as the program behavior might behave unexpectedly. By convention, all specially treated variables consist of all upper-case letters (and possibly numbers and underscores). To ensure maximum compatibility in the future, avoid using such variable names for your own purposes. A list of all specially treated variables are as follows: +`psql`'s internal variable names can consist of letters, numbers, and underscores in any order and any number of them. A number of these variables are treated specially by `psql`. They indicate certain option settings that can be changed at run time by altering the value of the variable or represent some state of the application. Although you can use these variables for any other purpose, this is not recommended, as the program might behave unexpectedly. By convention, all specially treated variables consist of all upper-case letters (and possibly numbers and underscores). To ensure maximum compatibility in the future, avoid using such variable names for your own purposes. A list of all specially treated variables are as follows: <dt>AUTOCOMMIT </dt> <dd>When on (the default), each SQL command is automatically committed upon successful completion. To postpone commit in this mode, you must enter a `BEGIN` or `START TRANSACTION` SQL command. When off or unset, SQL commands are not committed until you explicitly issue `COMMIT` or `END`. The autocommit-on mode works by issuing an implicit `BEGIN` for you, just before any command that is not already in a transaction block and is not itself a `BEGIN` or other transaction-control command, nor a command that cannot be executed inside a transaction block (such as `VACUUM`). @@ -565,7 +565,7 @@ in `~/.psqlrc` will cause `psql` to maintain a separate history for each databas <dt>PROMPT1 PROMPT2 PROMPT3 </dt> -<dd>These specify what the prompts `psql` issues should look like. See "Prompting".</dd> +<dd>These specify what the prompt's `psql` issues should look like. See "Prompting," below.</dd> <dt>QUIET </dt> <dd>This variable is equivalent to the command line option `-q`. It is not very useful in interactive mode.</dd> @@ -606,7 +606,7 @@ testdb=> \set content '''' `sed -e "s/'/''/g" < my_file.txt` '''' ``` -If you are using non-standard-conforming strings then you'll also need to double backslashes. This is a bit tricky: +If you are using non-standard-conforming strings, then you'll also need to use double backslashes. This is a bit tricky: ``` pre testdb=> \set content '''' `sed -e "s/'/''/g" -e @@ -642,13 +642,13 @@ The value of the selected prompt variable is printed literally, except where a p <dd>Like `%/`, but the output is `~` (tilde) if the database is your default database.</dd> <dt>%\# </dt> -<dd>If the session user is a database superuser, then a **\#**, otherwise a **>**. (The expansion of this value might change during a database session as the result of the command `SET SESSION AUTHORIZATION`.)</dd> +<dd>If the session user is a database superuser, then a `#`, otherwise a `>`. (The expansion of this value might change during a database session as the result of the command `SET SESSION AUTHORIZATION`.)</dd> <dt>%R </dt> -<dd>In prompt 1 normally **=**, but **^** if in single-line mode, and **!** if the session is disconnected from the database (which can happen if `\connect` fails). In prompt 2 the sequence is replaced by **-**, **\***, a single quote, a double quote, or a dollar sign, depending on whether `psql` expects more input because the command wasn't terminated yet, because you are inside a `/* ... */` comment, or because you are inside a quoted or dollar-escaped string. In prompt 3 the sequence doesn't produce anything.</dd> +<dd>In prompt 1, normally `=`, but is `^` if in single-line mode, and `!` if the session is disconnected from the database (which can happen if `\connect` fails). In prompt 2, the sequence is replaced by `-`, `*`, a single quote \(`'`\), a double quote \(`"`\), or a dollar sign \(`$`\), depending on whether `psql` expects more input because: the command is not yet terminated, you are inside a `/* ... */` comment, or you are inside a quoted or dollar-escaped string. In prompt 3, no substitution is produced.</dd> <dt>%x </dt> -<dd>Transaction status: an empty string when not in a transaction block, or **\*** when in a transaction block, or **!** when in a failed transaction block, or **?** when the transaction state is indeterminate (for example, because there is no connection).</dd> +<dd>Transaction status: an empty string when not in a transaction block, or `*` when in a transaction block, or `!` when in a failed transaction block, or `?` when the transaction state is indeterminate (for example, because there is no connection).</dd> <dt>%digits </dt> <dd>The character with the indicated octal code is substituted.</dd>
