Merge pull request #2478 from EnterpriseDB/release/2022-03-22

Release: 2022-03-22
EnterpriseDB · Mar 22, 2022 · 6624a55 · 6624a55
2 parents c7e4e6c + 5b662f8
commit 6624a55
Show file tree

Hide file tree

Showing 349 changed files with 825 additions and 13,170 deletions.
diff --git a/product_docs/docs/edb_plus/40/02_release_notes/09_edbplus_40.01_rel_notes.mdx b/product_docs/docs/edb_plus/40/02_release_notes/09_edbplus_40.01_rel_notes.mdx
@@ -7,5 +7,5 @@ New features, enhancements, bug fixes, and other changes in EDB*Plus 40.0.1 incl
 | Type         | Description                                                                                                                                                                  |
 | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 
 | Enhancement  | The display format for a decimal point is now compatible with Oracle SQL*Plus [75092].                                                                                       |
-| Security Fix | The EDB JDBC Driver in EDB*Plus is upgraded to version 42.3.2.1. This upgrade fixes the CVE-2022-21724 vulnerability reported in older versions of EDB JDBC Driver. |
-| Bug Fix      | Describe command no longer fails for a schema qualified SYNONYM name [72994].                                                                                                |
+| Security fix | The EDB JDBC Driver in EDB*Plus is upgraded to version 42.3.2.1. This upgrade fixes the CVE-2022-21724 vulnerability reported in older versions of EDB JDBC Driver. |
+| Bug fix      | Describe command no longer fails for a schema qualified SYNONYM name [72994].                                                                                                |
diff --git a/product_docs/docs/edb_plus/40/02_release_notes/index.mdx b/product_docs/docs/edb_plus/40/02_release_notes/index.mdx
@@ -1,11 +1,11 @@
 ---
-title: "Release Notes"
+title: "Release notes"
 
 ---
 
-EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server.
+EDB\*Plus is a utility program that provides a command line interface to EDB Postgres Advanced Server.
 
-The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 40. The release notes in this section provide information on what was new in each release. 
+The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 40. The release notes provide information on what was new in each release. 
 
 | Version                                | Release Date |                        
 | --------------------------------------- | ------------ |  

diff --git a/product_docs/docs/edb_plus/40/03_installing_edb_plus.mdx b/product_docs/docs/edb_plus/40/03_installing_edb_plus.mdx
@@ -4,7 +4,7 @@ title: "Installing EDB*Plus"
 
 <div id="installing_edb_plus" class="registered_link"></div>
 
-This table lists the EDB*Plus versions and their supported corresponding EDB Postgres Advanced Server (EPAS) versions.  EDB\*Plus is supported on the same platforms as EDB Postgres Advanced Server. See [Product Compatibility](https://www.enterprisedb.com/platform-compatibility#epas) for details.
+This table lists the EDB*Plus versions and their supported corresponding EDB Postgres Advanced Server  versions.  EDB\*Plus is supported on the same platforms as EDB Postgres Advanced Server. See [Product Compatibility](https://www.enterprisedb.com/platform-compatibility#epas) for details.
 
 | EDB*Plus | EPAS 14 | EPAS 13 | EPAS 12 | EPAS 11 | EPAS 10 | 
 | -------- | ------- | ------- | ------- | ------- | ------- | 
@@ -16,7 +16,7 @@ This table lists the EDB*Plus versions and their supported corresponding EDB Pos
 
 
 
-## Installation Prerequisites
+## Installation prerequisites
 
 Before installing EDB\*Plus, you must first install Java (version 1.8 or later). On a Linux system, you can use the `yum` package manager to install Java. Open a terminal window, assume superuser privileges, and enter:
 
@@ -50,7 +50,7 @@ For detailed information about creating and using EDB repositories to install Ad
 
 [https://www.enterprisedb.com/docs](/epas/latest/)
 
-## Installing EDB\*Plus on a CentOS Host
+## Installing EDB\*Plus on a CentOS host
 
 You can use an RPM package to install EDB\*Plus on a CentOS host.
 
@@ -114,7 +114,7 @@ When you install an RPM package that is signed by a source that is not recognize
 
 During the installation, `yum` may encounter a dependency that it cannot resolve. If it does, it will provide a list of the required dependencies that you must manually resolve.
 
-## Installing EDB\*Plus on a RHEL Host
+## Installing EDB\*Plus on a RHEL host
 
 You can use an RPM package to install EDB\*Plus on a RHEL host.
 
@@ -274,7 +274,7 @@ sudo su -
 
 Before setting up the repository, you need to register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
 
-#### Setting up the Repository
+#### Setting up the repository
 
 ```shell
 # Install the repository configuration
@@ -298,7 +298,7 @@ zypper -n install java-11-openjdk
 zypper refresh
 ```
 
-#### Installing the Package
+#### Installing the package
 
 ```shell
 zypper -n install edb-as14-edbplus
@@ -320,7 +320,7 @@ sudo su -
 
 Before setting up the repository, you need to register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
 
-#### Setting up the Repository
+#### Setting up the repository
 
 ```shell
 # Install the repository configuration and enter your EDB repository
@@ -346,7 +346,7 @@ zypper refresh
 zypper -n install java-1_8_0-openjdk
 ```
 
-#### Installing the Package
+#### Installing the package
 
 ```shell
 zypper -n install edb-as14-edbplus
@@ -375,7 +375,7 @@ sudo su -
 
 Before setting up the repository, you need to register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
 
-#### Setting up the Repository
+#### Setting up the repository
 
 ```shell
 # Install the repository configuration
@@ -399,7 +399,7 @@ zypper -n install java-11-openjdk
 zypper refresh
 ```
 
-#### Installing the Package
+#### Installing the package
 
 ```shell
 zypper -n install edb-as14-edbplus
@@ -421,7 +421,7 @@ sudo su -
 
 Before setting up the repository, you need to register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
 
-#### Setting up the Repository
+#### Setting up the repository
 
 ```shell
 # Install the repository configuration and enter your EDB repository
@@ -447,14 +447,14 @@ zypper refresh
 zypper -n install java-1_8_0-openjdk
 ```
 
-#### Installing the Package
+#### Installing the package
 
 ```shell
 zypper -n install edb-as14-edbplus
 ```
 
 
-## Installing EDB\*Plus on a Debian or Ubuntu Host
+## Installing EDB\*Plus on a Debian or Ubuntu host
 
 To install EDB\*Plus on a Debian or Ubuntu host, you must have credentials that allow access to the EDB repository. To request credentials for the repository, visit:
 
@@ -516,7 +516,7 @@ The following steps will walk you through using the EDB apt repository to instal
 
 Where, `xx` is the Advanced Server version.
 
-## Configuring an RPM Installation
+## Configuring an RPM installation
 
 After performing an RPM installation of EDB\*Plus, you must set the values of environment variables that allow EDB\*Plus to locate your Java installation. Use the following commands to set variable values:
 
@@ -593,7 +593,7 @@ You must restart the Advanced Server service before invoking EDB\*Plus. For deta
 
 [https://www.enterprisedb.com/docs](/epas/latest/)
 
-## Using the Graphical Installer
+## Using the graphical installer
 
 Graphical installers for EDB\*Plus are available via StackBuilder Plus; you can access StackBuilder Plus through your Windows or Linux start menu. After opening StackBuilder Plus and selecting the installation for which you wish to install EDB\*Plus, expand the component selection screen tree control to select and download the EDB\*Plus installer.
 

diff --git a/product_docs/docs/edb_plus/40/04_using_edb_plus.mdx b/product_docs/docs/edb_plus/40/04_using_edb_plus.mdx
@@ -6,7 +6,7 @@ title: "Using EDB*Plus"
 
 <div id="starting_edb_plus" class="registered_link"></div>
 
-To open an EDB\*Plus command line, navigate through the `Applications` or `Start` menu to the Advanced Server menu, to the `Run SQL Command Line` menu, and select the EDB\*Plus option. You can also invoke EDB\*Plus from the operating system command line with the following command:
+To open an EDB\*Plus command line, navigate through the **Applications** or **Start** menu to the **EDB Postgres Advanced Server** menu. Select **Run SQL Command Line > EDB\*Plus**. You can also invoke EDB\*Plus from the operating system command line with the following command:
 
 ```text
 edbplus [ -S[ILENT ] ] [ <login> | /NOLOG ] [ @<scriptfile>[.<ext> ] ]
@@ -18,27 +18,30 @@ edbplus [ -S[ILENT ] ] [ <login> | /NOLOG ] [ @<scriptfile>[.<ext> ] ]
 
 `login`
 
- Login information for connecting to the database server and database. `login` takes the following form; there must be no white space within the login information.
+ Login information for connecting to the database server and database. `login` takes the following form. Don't use any white space in the login information.
 
 ```text
 <username>[/<password>][@{<connectstring> | <variable> } ]
 ```
 
- Where:
 
  `username` is a database username with which to connect to the database.
 
- `password` is the password associated with the specified `username`. If a `password` is not provided, but a password is required for authentication, a password file is used if available. If there is no password file or no entry in the password file with the matching connection parameters, then EDB\*Plus will prompt for the password.
+ `password` is the password associated with the specified username. If you don't provide a password but a password is required for authentication, a password file is used if available. If there's no password file or no entry in the password file with the matching connection parameters, then EDB\*Plus prompts for the password.
 
  `connectstring` is the database connection string with the following format:
 
 ```text
 <host>[:<port>][/<dbname>][?ssl={true | false}]
 ```
 
- Where:
-
- `host` is the hostname or IP address on which the database server resides. If neither `@connectstring` nor `@variable` nor `/NOLOG` is specified, the default host is assumed to be the localhost. `port` is the port number receiving connections on the database server. If not specified, the default is `5444`. `dbname` is the name of the database to connect to. If not specified the default is `edb`. If `Internet Protocol version 6` (IPv6) is used for the connection instead of IPv4, then the IP address must be enclosed within square brackets (that is, `[ipv6_address]`). The following is an example using an IPv6 connection:
+ `host` is the hostname or IP address on which the database server resides. If you don't specify `@connectstring`, `@variable`, or `/NOLOG`, the default host is assumed to be the localhost. 
+
+ `port` is the port number receiving connections on the database server. The default is `5444`. 
+
+ `dbname` is the name of the database to connect to. The default is `edb`. 
+
+ If `Internet Protocol version 6` (IPv6) is used for the connection instead of IPv4, then the IP address must be enclosed in square brackets (that is, `[ipv6_address]`). The following is an example using an IPv6 connection:
 
 ```text
 edbplus.sh enterprisedb/password@[fe80::20c:29ff:fe7c:78b2]:5444/edb
@@ -51,23 +54,21 @@ edbplus.sh enterprisedb/password@[fe80::20c:29ff:fe7c:78b2]:5444/edb
 host    all             all          ::0/0             md5
 ```
 
-For more information about the `pg_hba.conf` file, see the PostgreSQL core documentation at:
-
- <https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html>
+For more information about the `pg_hba.conf` file, see the [PostgreSQL core documentation](https://www.postgresql.org/docs/current/static/auth-pg-hba-conf.html).
 
- If an SSL connection is desired, then include the `?ssl=true` parameter in the connection string. In such a case, the connection string must minimally include `host:port`, with or without `/dbname`. If the `ssl` parameter is not specified, the default is `false`. See [Using a Secure Sockets Layer (SSL) Connection](05_using_edb_plus_with_ssl/#using_edb_plus_with_ssl) for instructions on setting up an SSL connection.
+ If you want an SSL connection, then include the `?ssl=true` parameter in the connection string. In such a case, the connection string must minimally include `host:port`, with or without `/dbname`. The default for the `ssl` parameter is `false`. See [Using a secure sockets layer (SSL) connection](05_using_edb_plus_with_ssl/#using_edb_plus_with_ssl) for instructions on setting up an SSL connection.
 
- `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 Advanced Server home directory.
+ `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.
 
 `/NOLOG`
 
- Specify `/NOLOG` to start EDB\*Plus without establishing a database connection. SQL commands and EDB\*Plus commands that require a database connection cannot be used in this mode. The `CONNECT` command can be subsequently given to connect to a database after starting EDB\*Plus with the `/NOLOG` option.
+ Specify `/NOLOG` to start EDB\*Plus without establishing a database connection. In this mode, you can't use SQL commands and EDB\*Plus commands that require a database connection. You can later give the `CONNECT` command to connect to a database after starting EDB\*Plus with the `/NOLOG` option.
 
 `scriptfile[.ext ]`
 
- `scriptfile` is the name of a file residing in the current working directory, containing SQL and/or EDB\*Plus commands that will be automatically executed after startup of EDB\*Plus. `ext` is the filename extension. If the filename extension is `sql`, then the `.sql` extension may be omitted when specifying `scriptfile`. When creating a script file, always name the file with an extension, otherwise it will not be accessible by EDB\*Plus. (EDB\*Plus will always assume a `.sql` extension on filenames that are specified with no extension.)
+ `scriptfile` is the name of a file residing in the current working directory, containing SQL and/or EDB\*Plus commands that execute after startup of EDB\*Plus. `ext` is the filename extension. If the filename extension is `sql`, then you can omit the `.sql` extension. When creating a script file, always name the file with an extension. Otherwise EDB\*Plus can't access it. EDB\*Plus assumes a `.sql` extension on filenames that are specified with no extension.
 
-The following example shows user `enterprisedb` with password `password`, connecting to database `edb` running on a database server on the `localhost` at port `5444`.
+The following example shows user `enterprisedb` with password `password` connecting to database `edb` running on a database server on the localhost at port 5444.
 
 ```text
 C:\Program Files\edb\as14\edbplus>edbplus enterprisedb/password
@@ -79,7 +80,7 @@ Copyright (c) 2008-2021, EnterpriseDB Corporation. All rights reserved.
 SQL>
 ```
 
-The following example shows user `enterprisedb` with password, `password`, connecting to database `edb` running on a database server on the `localhost` at port `5445`.
+The following example shows user `enterprisedb` with password `password` connecting to database `edb` running on a database server on the localhost at port 5445.
 
 ```text
 C:\Program Files\edb\as14\edbplus>edbplus enterprisedb/password@localhost:5445/edb
@@ -91,7 +92,7 @@ Copyright (c) 2008-2021, EnterpriseDB Corporation. All rights reserved.
 SQL>
 ```
 
-Using variable `hr_5445` in the `login.sql` file, the following illustrates how it is used to connect to database `hr` on localhost at port `5445`.
+Using variable `hr_5445` in the `login.sql` file, the following shows how it is used to connect to database `hr` on localhost at port 5445.
 
 ```text
 C:\Program Files\edb\as14\edbplus>edbplus enterprisedb/password@hr_5445
@@ -103,14 +104,14 @@ Copyright (c) 2008-2021, EnterpriseDB Corporation. All rights reserved.
 SQL>
 ```
 
-The following is the content of the `login.sql` file used in the previous example.
+The following is the content of the `login.sql` file used in this example.
 
 ```text
 define edb="localhost:5445/edb"
 define hr_5445="localhost:5445/hr"
 ```
 
-The following example executes a script file, `dept_query.sql` after connecting to database `edb` on server localhost at port `5444`.
+The following example executes a script file, `dept_query.sql`, after connecting to database `edb` on server localhost at port 5444.
 
 ```text
 C:\Program Files\edb\as14\edbplus>edbplus enterprisedb/password @dept_query
@@ -129,7 +130,7 @@ SQL> EXIT
 Disconnected from EnterpriseDB Database.
 ```
 
-The following is the content of file `dept_query.sql` used in the previous example.
+The following is the content of file `dept_query.sql` used in this example.
 
 ```text
 SET PAGESIZE 9999