diff --git a/product_docs/docs/edb_plus/41/02_release_notes/edbplus_41.1_rel_notes.mdx b/product_docs/docs/edb_plus/41/02_release_notes/edbplus_41.1_rel_notes.mdx index 2f33f164af7..69bc21a38e3 100644 --- a/product_docs/docs/edb_plus/41/02_release_notes/edbplus_41.1_rel_notes.mdx +++ b/product_docs/docs/edb_plus/41/02_release_notes/edbplus_41.1_rel_notes.mdx @@ -6,4 +6,4 @@ New features, enhancements, bug fixes, and other changes in EDB*Plus 41.1.0 incl | Type | Description | | ----------- | -------------------------------------------------------------- | -| Enhancement | The `COLUMN` command in EDB\*Plus has been enhanced to provide support for the `NEW_VALUE` parameter. The `NEW_VALUE` parameter defines a variable to hold the column value in a given EDB*Plus session. | +| Enhancement | The `COLUMN` command in EDB\*Plus now provides support for the `NEW_VALUE` parameter. The `NEW_VALUE` parameter defines a variable to hold the column value in a given EDB\*Plus session. | diff --git a/product_docs/docs/edb_plus/41/06_command_summary.mdx b/product_docs/docs/edb_plus/41/06_command_summary.mdx index 249c749b47e..f83c7ae75b6 100644 --- a/product_docs/docs/edb_plus/41/06_command_summary.mdx +++ b/product_docs/docs/edb_plus/41/06_command_summary.mdx @@ -19,7 +19,7 @@ The `ACCEPT` command displays a prompt and waits for keyboard input. The value f ACC[EPT ] variable ``` -The following example creates a new variable named `my_name`, accepts a value of `John Smith`, and then displays the value using the `DEFINE` command. +This example creates a new variable named `my_name`, accepts a value of `John Smith`, and then displays the value using the `DEFINE` command. ```sql SQL> ACCEPT my_name @@ -36,7 +36,7 @@ DEFINE MY_NAME = "John Smith" A[PPEND ] text ``` -In the following example, a `SELECT` command is built in the SQL buffer using the `APPEND` command. Two spaces are placed between the `APPEND` command and the `WHERE` clause to separate `dept` and `WHERE` by one space in the SQL buffer. +In this example, a `SELECT` command is built in the SQL buffer using the `APPEND` command. Two spaces are placed between the `APPEND` command and the `WHERE` clause to separate `dept` and `WHERE` by one space in the SQL buffer. ```sql SQL> APPEND SELECT * FROM dept @@ -55,9 +55,9 @@ SQL> LIST C[HANGE ] FROM [ TO ] ``` -If `TO/` is specified, the first occurrence of text `FROM` in the current line is changed to text `TO`. If `TO/` is omitted, the first occurrence of text `FROM` in the current line is deleted. +If you specify `TO/`, the first occurrence of the text `FROM` in the current line is changed to text `TO`. If you omit `TO/`, the first occurrence of the text `FROM` in the current line is deleted. -The following sequence of commands makes line 3 the current line and then changes the department number in the `WHERE` clause from 20 to 30. +This sequence of commands makes line 3 the current line and then changes the department number in the `WHERE` clause from 20 to 30. ```sql SQL> LIST @@ -109,7 +109,7 @@ COL[UMN] [column_name [CLE[AR] | OFF...]] ``` -If the `COLUMN` command is specified with no other options, formatting options for current columns in effect for the session are displayed. +If you specify the `COLUMN` command with no other options, formatting options for current columns in effect for the session are displayed. If the `COLUMN` command is followed by a column name, then the column name can be followed by one of the following: @@ -119,11 +119,11 @@ If the `COLUMN` command is followed by a column name, then the column name can b `column_name` - Name of a column in a table to which column formatting options apply. If no other options follow `column_name`, then the current column formatting option of `column_name`, if any, are displayed. + Name of a column in a table to which column formatting options apply. If no other options follow `column_name`, then the current column formatting options of `column_name`, if any, are displayed. `CLEAR` - The `CLEAR` option reverts all formatting options back to their defaults for `column_name`. If you specify the `CLEAR` option, it must be the only option specified. + The `CLEAR` option reverts all formatting options to their defaults for `column_name`. If you specify the `CLEAR` option, it must be the only option specified. `format_spec` @@ -133,7 +133,7 @@ If the `COLUMN` command is followed by a column name, then the column name can b `n` is a positive integer that specifies the column width in characters within which to display the data. Data in excess of `n` wraps around with the specified column width. - For numeric columns, `format_spec` is comprised of the following elements. + For numeric columns, `format_spec` is made up of the following elements. | Element | Description | | ------- | ------------------------------------------ | @@ -151,9 +151,9 @@ If the `COLUMN` command is followed by a column name, then the column name can b `NEW_V[ALUE]` -This variable option is valid if specified alone or with other already supported options. A variable specified in the `COLUMN` command option is associated with the given column. The variable can contain the data value of a column or expression of a variable in the SQL `SELECT` list and can be used in the SQL script for the remainder of the session. +This variable option is valid if specified alone or with other already supported options. A variable specified in the `COLUMN` command option is associated with the given column. The variable can contain the data value of a column or expression of a variable in the SQL `SELECT` list. You can use it in the SQL script for the rest of the session. -To contain the `departmentnumber` value for the `deptno` column, a variable can be defined using the `NEW_VALUE` option: +To contain the `departmentnumber` value for the `deptno` column, you can define a variable using the `NEW_VALUE` option: ```sql SQL> column deptno new_value departmentnumber @@ -175,15 +175,15 @@ SQL> INSERT INTO emp VALUES (1,'micheal','tester',7902,'17-DEC-80',800,NULL,'&de The `NEW_V[ALUE]` variable has the following limitations: -- Column values differ when they are seeded using the `NEW_VALUE` parameter for the "time with time zone" data type. -- The `NEW_VALUE` variable prompts for the value if the corresponding column value is `NULL`. Oracle treats `NULL` and an empty string the same while EDB Postgres Advanced Server has a different behavior. Therefore, in EDB*Plus it prompts for the value. -- The variable value doesn't show in the `COLUMN` header if the user references the `NEW_VALUE` variable in a `SELECT` query without an alias. +- Column values differ when they're seeded using the `NEW_VALUE` parameter for the "time with time zone" data type. +- The `NEW_VALUE` variable prompts for the value if the corresponding column value is `NULL`. Oracle treats `NULL` and an empty string the same, while EDB Postgres Advanced Server has a different behavior. Therefore, in EDB\*Plus it prompts for the value. +- The variable value doesn't show in the `COLUMN` header if you reference the `NEW_VALUE` variable in a `SELECT` query without an alias. `OFF | ON` - If `OFF` is specified, formatting options revert to their defaults but are still available in the session. If `ON` is specified, the formatting options specified by previous `COLUMN` commands for `column_name` in the session are reactivated. + If you specify `OFF`, formatting options revert to their defaults but are still available in the session. If you specify `ON`, the formatting options specified by previous `COLUMN` commands for `column_name` in the session are reactivated. -The following example shows the effect of changing the display width of the `job` column. +This example shows the effect of changing the display width of the `job` column: ```sql SQL> SET PAGESIZE 9999 @@ -234,7 +234,7 @@ EMPNO ENAME JOB 14 rows retrieved. ``` -The following example applies a format to the `sal` column. +This example applies a format to the `sal` column: ```sql SQL> COLUMN sal FORMAT $99,999.00 @@ -290,7 +290,7 @@ EMPNO ENAME JOB SAL ## CONNECT -Change the database connection to a different user or connect to a different database. There must be no white space between any of the parameters following the `CONNECT` command. +Change the database connection to a different user or connect to a different database. There must be no white space between any of the parameters following the `CONNECT` command. The syntax is: ```sql CON[NECT] [/][@{ | } ] @@ -300,7 +300,7 @@ Where: `username` is a database user name with which to connect to the database. - `password` is the password associated with the specified user name. If a `password` isn't provided but a password is required for authentication, a search is made for a password file, first in the home directory of the Linux operating system account invoking EDB\*Plus (or in the `%APPDATA%\postgresql\` directory for Windows) and then at the location specified by the `PGPASSFILE` environment variable. The password file is `.pgpass` on Linux hosts and `pgpass.conf` on Windows hosts. The following is an example on a Windows host: + `password` is the password associated with the specified user name. If you don't provide a `password` but a password is required for authentication, a search is made for a password file, first in the home directory of the Linux operating system account invoking EDB\*Plus (or in the `%APPDATA%\postgresql\` directory for Windows) and then at the location specified by the `PGPASSFILE` environment variable. The password file is `.pgpass` on Linux hosts and `pgpass.conf` on Windows hosts. The following is an example on a Windows host: ```text C:\Users\Administrator\AppData\Roaming\postgresql\pgpass.conf @@ -311,11 +311,11 @@ C:\Users\Administrator\AppData\Roaming\postgresql\pgpass.conf !!! Note When a password isn't required, EDB\*Plus doesn't prompt for a password, such as when the `trust` authentication method is specified in the `pg_hba.conf` file. For more information about the `pg_hba.conf` file and authentication methods, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html). - `connectstring` is the database connection string. See [Using EDB\*Plus](04_using_edb_plus/#using_edb_plus) for more information on the database connection string. + `connectstring` is the database connection string. See [Using EDB\*Plus](04_using_edb_plus/#using_edb_plus) for more information about the database connection string. - `variable` is a variable defined in the `login.sql` file that contains a database connection string. The `login.sql` file can be found in the `edbplus` subdirectory of the EDB Postgres Advanced Server home directory. + `variable` is a variable defined in the `login.sql` file that contains a database connection string. The `login.sql` file is in the `edbplus` subdirectory of the EDB Postgres Advanced Server home directory. -In the following example, the database connection is changed to database `edb` on the localhost at port 5445 with username `smith`. +In this example, the database connection is changed to database `edb` on the localhost at port 5445 with username smith. ```sql SQL> CONNECT smith/mypassword@localhost:5445/edb @@ -323,7 +323,7 @@ Disconnected from EnterpriseDB Database. Connected to EnterpriseDB 14.0.0 (localhost:5445/edb) AS smith ``` -In this session, the connection is changed to user name `enterprisedb`. The host defaults to the localhost, the port defaults to 5444 (which isn't the same as the port previously used), and the database defaults to edb. +In this session, the connection is changed to user name enterprisedb. The host defaults to the localhost, the port defaults to 5444 (which isn't the same as the port previously used), and the database defaults to `edb`. ```sql SQL> CONNECT enterprisedb/password @@ -339,13 +339,13 @@ The `DEFINE` command creates or replaces the value of a *user variable* (also ca DEF[INE ] [ variable [ = text ] ] ``` -If the `DEFINE` command is given without any parameters, all current variables and their values are displayed. +If you give the `DEFINE` command without any parameters, all current variables and their values are displayed. If `DEFINE variable` is given, only `variable` is displayed with its value. -`DEFINE variable = text` assigns `text` to `variable.text`, which can be optionally enclosed in single or double quotation marks. Quotation marks must be used if `text` contains space characters. +`DEFINE variable = text` assigns `text` to `variable.text`, which you can optionally enclose in single or double quotation marks. Quotation marks must be used if `text` contains space characters. -The following example defines two variables, `dept` and `name`. +This example defines two variables, `dept` and `name`: ```sql SQL> DEFINE dept = 20 @@ -371,7 +371,7 @@ The parameters specify the lines to delete from the SQL buffer. Two parameters s `n` - n is an integer representing the nth line. + `n` is an integer representing the nth line. `n m` @@ -379,13 +379,13 @@ The parameters specify the lines to delete from the SQL buffer. Two parameters s `*` - Current line + Current line. `LAST` - Last line + Last line. -In the following example, the fifth and sixth lines containing columns `sal` and `comm`, respectively, are deleted from the `SELECT` command in the SQL buffer. +This example deletes the fifth and sixth lines, which contain columns `sal` and `comm`, respectively, from the `SELECT` command in the SQL buffer. ```sql SQL> LIST @@ -423,7 +423,7 @@ DESC[RIBE] [ schema.]object `schema` - Name of the schema containing the object to be described. + Name of the schema containing the object to describe. `object` @@ -447,7 +447,7 @@ ED[IT ] [ filename[.ext ] ] `filename[.ext ]` - `filename` is the name of the file to open with an external editor. `ext` is the file name extension. If the file name extension is `sql`, then you can omit the `.sql`. `EDIT` always assumes a `.sql` extension on file names that are specified with no extension. If the `filename` parameter is omitted from the `EDIT` command, the contents of the SQL buffer are brought into the editor. + `filename` is the name of the file to open with an external editor. `ext` is the filename extension. If the extension is `sql`, then you can omit it. (`EDIT` assumes a `.sql` extension on filenames that are specified with no extension.) If you omit the `filename` parameter from the `EDIT` command, the contents of the SQL buffer are brought into the editor. ## EXECUTE @@ -475,7 +475,7 @@ The `EXIT` command ends the EDB\*Plus session and returns control to the operati [ COMMIT | ROLLBACK ]SUCCESS | FAILURE |WARNING] ``` -Returns an operating system dependent return code indicating successful operation, failure, or warning for `SUCCESS, FAILURE`, and `WARNING`, respectively. The default is `SUCCESS`. +Returns an operating-system-dependent return code indicating successful operation, failure, or warning for `SUCCESS`, `FAILURE`, and `WARNING`, respectively. The default is `SUCCESS`. `value` @@ -487,7 +487,7 @@ Returns an operating system dependent return code indicating successful operatio `COMMIT | ROLLBACK` - If `COMMIT` is specified, uncommitted updates are committed upon exit. If `ROLLBACK` is specified, uncommitted updates are rolled back upon exit. The default is `COMMIT`. + If you specify `COMMIT`, uncommitted updates are committed upon exit. If you specify `ROLLBACK`, uncommitted updates are rolled back upon exit. The default is `COMMIT`. ## GET @@ -499,15 +499,15 @@ GET filename[.ext ] [ LIS[T ] | NOL[IST ] ] `filename[.ext ]` - `filename` is the name of the file to load into the SQL buffer. `ext` is the file name extension. If the file name extension is `sql`, then you can omit the `.sql` extension. `GET` always assumes a `.sql` extension on file names that are specified with no extension. + `filename` is the name of the file to load into the SQL buffer. `ext` is the filename extension. If the extension is `sql`, then you can omit it. `GET` assumes a `.sql` extension on filenames that are specified with no extension. `LIST | NOLIST` - If `LIST` is specified, the content of the SQL buffer is displayed after the file is loaded. If `NOLIST` is specified, no listing is displayed. The default is `LIST`. + If you specify `LIST`, the contents of the SQL buffer are displayed after the file is loaded. If you specify `NOLIST`, no listing is displayed. The default is `LIST`. ## HELP -The `HELP` command obtains an index of topics or help on a specific topic. The question mark `(?)` is synonymous with specifying `HELP`. +The `HELP` command gets an index of topics or help on a specific topic. The question mark `(?)` is synonymous with specifying `HELP`. ```sql { HELP | ? } { INDEX | topic } @@ -541,7 +541,7 @@ The `INPUT` command adds a line of text to the SQL buffer after the current line I[NPUT ] text ``` -The following sequence of `INPUT` commands constructs a `SELECT` command. +This sequence of `INPUT` commands constructs a `SELECT` command: ```sql SQL> INPUT SELECT empno, ename, job, sal, comm @@ -605,7 +605,7 @@ Use the `PASSWORD` command to change your database password. PASSW[ORD] [user_name] ``` -You must have privileges to use the `PASSWORD` command to change another user's password. The following example uses the `PASSWORD` command to change the password for a user named `acctg`: +You must have privileges to use the `PASSWORD` command to change another user's password. This example uses the `PASSWORD` command to change the password for a user named acctg: ```sql SQL> PASSWORD acctg @@ -623,7 +623,7 @@ The `PAUSE` command displays a message and waits for the user to press `ENTER`. PAU[SE] [optional_text] ``` -`optional_text` specifies the text to display to the user. If `optional_text` is omitted, EDB Postgres Advanced Server displays two blank lines. If you double quote the `optional_text` string, the quotes are included in the output. +`optional_text` specifies the text to display to the user. If you omit `optional_text`, EDB Postgres Advanced Server displays two blank lines. If you double quote the `optional_text` string, the quotes are included in the output. ## PROMPT @@ -661,7 +661,7 @@ You can also use the following convention to include a comment: ```text /* - * This is an example of a three line comment. + * This is an example of a three-line comment. */ ``` @@ -676,7 +676,7 @@ SAV[E] file_name `file_name` - `file_name` specifies the name of the file (including the path) where the buffer contents are written. If you don't provide a file extension, `.sql` is appended to the end of the file name. + `file_name` specifies the name of the file (including the path) where the buffer contents are written. If you don't provide a file extension, `.sql` is appended to the end of the filename. `CREATE` @@ -690,7 +690,7 @@ SAV[E] file_name Include the `APPEND` keyword to append the contents of the SQL buffer to the end of the specified file. -The following example saves the contents of the SQL buffer to a file named `example.sql`, located in the `temp` directory: +This example saves the contents of the SQL buffer to a file named `example.sql`, located in the `temp` directory: ```sql SQL> SAVE C:\example.sql CREATE @@ -699,7 +699,7 @@ File "example.sql" written. ## SET -Use the `SET` command to specify a value for a session-level variable that controls EDB\*Plus behavior. The following forms of the `SET` command are valid: +Use the `SET` command to specify a value for a session-level variable that controls EDB\*Plus behavior. The following forms of the `SET` command are valid. ### SET AUTOCOMMIT` @@ -803,7 +803,7 @@ SET LIN[ESIZE] width_of_line ### SET NEWPAGE -Use the `SET NEWPAGE` command to specify how many blank lines are printed after a page break. +Use the `SET NEWPAGE` command to specify how many blank lines to print after a page break. ```sql SET NEWP[AGE] lines_per_page @@ -859,11 +859,11 @@ The `SET PAUSE` command is most useful when included in a script. The command di SET PAU[SE] {ON | OFF} ``` -If `SET PAUSE` is `ON`, the message `Hit ENTER to continue…` appears before each command is executed. +If `SET PAUSE` is `ON`, the message `Hit ENTER to continue…` appears before each command executes. ### SET SPACE -Use the `SET SPACE` command to specify the number of spaces to display between columns: +Use the `SET SPACE` command to specify the number of spaces to display between columns. ```sql SET SPACE number_of_spaces @@ -871,7 +871,7 @@ SET SPACE number_of_spaces ### SET SQLPROMPT -Use `SET SQLPROMPT` to set a value for a user-interactive prompt: +Use `SET SQLPROMPT` to set a value for a user-interactive prompt. ```sql SET SQLP[ROMPT] "prompt" @@ -969,11 +969,11 @@ The `SPOOL` command sends output from the display to a file. SP[OOL] output_file | OFF ``` -Use the `output_file` parameter to specify a path name for the output file. +Use the `output_file` parameter to specify a pathname for the output file. ## START -Use the `START` command to run an EDB\*Plus script file. `START` is an alias for `@` command. +Use the `START` command to run an EDB\*Plus script file. `START` is an alias for the `@` command. ```sql STA[RT] script_file @@ -1004,17 +1004,17 @@ WHENEVER SQLERROR If EDB Postgres Advanced Server encounters an error while executing a SQL command or PL/SQL block, EDB\*Plus performs the action specified in the `WHENEVER SQLERROR` command: - Include the `CONTINUE` clause to perform the specified action before continuing. +- Include the `CONTINUE` clause to perform the specified action before continuing. - Include the `COMMIT` clause to commit the current transaction before exiting or continuing. +- Include the `COMMIT` clause to commit the current transaction before exiting or continuing. - Include the `ROLLBACK` clause to roll back the current transaction before exiting or continuing. +- Include the `ROLLBACK` clause to roll back the current transaction before exiting or continuing. - Include the `NONE` clause to continue without committing or rolling back the transaction. +- Include the `NONE` clause to continue without committing or rolling back the transaction. - Include the `EXIT` clause to perform the specified action and exit in case of an error. +- Include the `EXIT` clause to perform the specified action and exit in case of an error. - Use the following options to specify a status code that EDB\*Plus returns before exiting: +Use the following options to specify a status code that EDB\*Plus returns before exiting: ```sql [SUCCESS|FAILURE|WARNING|n|sub_variable]