Merge pull request #2357 from EnterpriseDB/release/2022-02-18

Release: 2022-02-18

advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx

@@ -102,14 +102,42 @@ host all all all md5
 host   replication    streaming_barman   all md5
 ```
 
-### Database settings for streaming
+### Enable remote access to your PostgreSQL Server
+
+If the PostgreSQL server isn't already configured for remote access, or is restricted to connections from known machines, our database server won't be able to connect.
 
-We'll also need to make sure there are replication slots available, and that PostgreSQL will allow another sender to connect. We'll use psql to check the current settings:
+We'll use psql to check this setting:
 
 ```shell
 psql -d pagila
 ```
 
+The relevant configuration parameter is [`listen_addresses`](https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-LISTEN-ADDRESSES):
+
+```sql
+show listen_addresses;
+__OUTPUT__
+ listen_addresses 
+------------------
+ *
+(1 row)
+```
+
+The value for this server is `*` - which allows connections from anything. This doesn't need to be changed. If the value were to be empty, `localhost`, or a list of hosts or addresses that don't include our database server, we'd need to add its hostname (`backup`) to the list, or change it to the wildcard. 
+
+```sql
+ALTER SYSTEM SET listen_addresses TO "*";
+__OUTPUT__
+ALTER SYSTEM
+```
+
+!!! Note
+    If you change this setting, you'll need to restart the database server for it to take effect. Since our setting was already allowing all remote connections, we don't need to do that.
+
+### Database settings for streaming
+
+We'll also need to make sure there are replication slots available, and that PostgreSQL will allow another sender to connect. We'll continue to use psql to check the current settings:
+
 ```sql
 Show max_wal_senders;
 Show max_replication_slots;

build-sources.json

@@ -1,8 +1,10 @@
 {
   "ark": false,
   "bdr": true,
+  "biganimal": true,
   "harp": true,
   "bart": true,
+  "edb_plus": true,
   "efm": true,
   "epas": true,
   "eprs": true,
@@ -22,6 +24,5 @@
   "pgpool": true,
   "postgis": true,
   "repmgr": true,
-  "slony": true,
-  "biganimal": true
+  "slony": true
 }

gatsby-config.js

@@ -19,15 +19,16 @@ const sourceToPluginConfig = {
   ark: { name: "ark", path: "product_docs/docs/ark" },
   bart: { name: "bart", path: "product_docs/docs/bart" },
   bdr: { name: "bdr", path: "product_docs/docs/bdr" },
-  harp: { name: "harp", path: "product_docs/docs/harp" },
   biganimal: { name: "biganimal", path: "product_docs/docs/biganimal" },
+  edb_plus: { name: "edb_plus", path: "product_docs/docs/edb_plus" },
   efm: { name: "efm", path: "product_docs/docs/efm" },
   epas: { name: "epas", path: "product_docs/docs/epas" },
   eprs: { name: "eprs", path: "product_docs/docs/eprs" },
   hadoop_data_adapter: {
     name: "hadoop_data_adapter",
     path: "product_docs/docs/hadoop_data_adapter",
   },
+  harp: { name: "harp", path: "product_docs/docs/harp" },
   jdbc_connector: {
     name: "jdbc_connector",
     path: "product_docs/docs/jdbc_connector",

gatsby-node.js

@@ -521,7 +521,7 @@ exports.onPostBuild = async ({ reporter, pathPrefix }) => {
 /edb-docs/p/edb-postgres-mongodb-data-adapter/* /docs/mongo_data_adapter/latest/ 301
 /edb-docs/p/edb-postgres-migration-portal/*     /docs/migration_portal/latest/ 301
 /edb-docs/p/edb-postgres-enterprise-manager/*   /docs/pem/latest/ 301
-/edb-docs/p/edbplus/*                           /docs/epas/latest/edb_plus/ 301
+/edb-docs/p/edbplus/*                           /docs/edb_plus/latest/ 301
 /edb-docs/p/edb-postgres-odbc-connector/*       /docs/odbc_connector/latest/ 301
 /edb-docs/p/edb-postgres-ocl-connector/*        /docs/ocl_connector/latest/ 301
 /edb-docs/p/edb-backup-and-recovery-tool/*      /docs/bart/latest/ 301

product_docs/docs/edb_plus/36/01_release_notes.mdx

@@ -0,0 +1,13 @@
+---
+navTitle: Release Notes
+title: "EDB*Plus Version 36 Release Notes"
+---
+<div id="release_notes" class="registered_link"></div>
+
+New features, enhancements, bug fixes, and other changes in EDB*Plus 36 include:
+
+| Type        | Description                                                                                                             |
+| ----------- | ----------------------------------------------------------------------------------------------------------------------- | 
+| Enhancement | Support for EDB Postgres Advanced Server 10.0.0                                                          |
+| Enhancement | EDB Postgres Advanced Server support of Internet Protocol version 6 (IPv6) to log into EDB\*Plus.                               |
+| Enhancement | EDB Postgres Advanced Server support of a Secure Sockets Layer (SSL) connection from EDB\*Plus to the EDB Postgres Advanced Server database. |

product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/01_installing_prereq.mdx → product_docs/docs/edb_plus/36/03_installing_edb_plus/01_installing_prereq.mdx

@@ -5,6 +5,12 @@ title: "Installation Prerequisites"
 
 <div id="installing_prereq" class="registered_link"></div>
 
+This table lists the 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.
+
+| EDB*Plus | EPAS 14 | EPAS 13 | EPAS 12 | EPAS 11 | EPAS 10 | 
+| -------- | ------- | ------- | ------- | ------- | ------- | 
+| 36       | N       | N       | N       | Y       | Y       | 
+
 Before installing EDB\*Plus, you must first install Java (version 1.7 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:
 
    ```text

product_docs/docs/edb_plus/36/04_using_edb_plus.mdx

@@ -0,0 +1,145 @@
+---
+title: "Using EDB*Plus"
+---
+
+<div id="using_edb_plus" class="registered_link"></div>
+
+<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:
+
+```text
+edbplus [ -S[ILENT ] ] [ <login> | /NOLOG ] [ @<scriptfile>[.<ext> ] ]
+```
+
+`SILENT`
+
+ If specified, the EDB\*Plus sign-on banner is suppressed along with all prompts.
+
+`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.
+
+```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.
+
+ `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:
+
+```text
+edbplus.sh enterprisedb/password@[fe80::20c:29ff:fe7c:78b2]:5444/edb
+```
+
+ The `pg_hba.conf` file for the database server must contain an appropriate entry for the IPv6 connection. The following example shows an entry that allows all addresses:
+
+```text
+# TYPE  DATABASE        USER         ADDRESS           METHOD
+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/10/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.
+
+ `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.
+
+`/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.
+
+`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.)
+
+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\as10\edbplus>edbplus enterprisedb/password
+Connected to EnterpriseDB 10.0.1 (localhost:5444/edb) AS enterprisedb
+
+EDB*Plus: Release 10 (Build 36.0.0)
+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`.
+
+```text
+C:\Program Files\edb\as10\edbplus>edbplus enterprisedb/password@localhost:5445/edb
+Connected to EnterpriseDB 10.0.1 (localhost:5445/edb) AS enterprisedb
+
+EDB*Plus: Release 10 (Build 36.0.0)
+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`.
+
+```text
+C:\Program Files\edb\as10\edbplus>edbplus enterprisedb/password@hr_5445
+Connected to EnterpriseDB 10.0.1 (localhost:5445/hr) AS enterprisedb
+
+EDB*Plus: Release 10 (Build 36.0.0)
+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.
+
+```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`.
+
+```text
+C:\Program Files\edb\as10\edbplus>edbplus enterprisedb/password @dept_query
+Connected to EnterpriseDB 10.0.1 (localhost:5444/edb) AS enterprisedb
+
+SQL> SELECT * FROM dept;
+
+DEPTNO DNAME          LOC
+------ -------------- -------------
+10     ACCOUNTING     NEW YORK
+20     RESEARCH       DALLAS
+30     SALES          CHICAGO
+40     OPERATIONS     BOSTON
+
+SQL> EXIT
+Disconnected from EnterpriseDB Database.
+```
+
+The following is the content of file `dept_query.sql` used in the previous example.
+
+```text
+SET PAGESIZE 9999
+SET ECHO ON
+SELECT * FROM dept;
+EXIT
+```