From 32eec81603118cbb85c58cf190ee0162c556b33a Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 2 Feb 2022 16:48:45 -0500 Subject: [PATCH 01/29] pulling out EDB*Plus as a separate utility --- .../edb_plus/03_installing_edb_plus.mdx | 12 +++++++++- .../14 => }/edb_plus/04_using_edb_plus.mdx | 0 .../edb_plus/05_using_edb_plus_with_ssl.mdx | 0 .../14 => }/edb_plus/06_command_summary.mdx | 0 .../advanced_server_installation_details.png | 0 .../14 => }/edb_plus/images/edb_logo.png | 0 .../14 => }/edb_plus/images/edb_logo.svg | 0 .../edb_plus/images/edb_plus_welcome.png | 0 .../edb_plus/images/installation_complete.png | 0 .../images/installation_directory.png | 0 .../edb_plus/images/ready_to_install.png | 0 .../02_edb_plus.mdx => edb_plus/index.mdx} | 3 +++ product_docs/docs/epas/14/edb_plus/index.mdx | 23 ------------------- src/pages/index.js | 1 + 14 files changed, 15 insertions(+), 24 deletions(-) rename product_docs/docs/{epas/14 => }/edb_plus/03_installing_edb_plus.mdx (95%) rename product_docs/docs/{epas/14 => }/edb_plus/04_using_edb_plus.mdx (100%) rename product_docs/docs/{epas/14 => }/edb_plus/05_using_edb_plus_with_ssl.mdx (100%) rename product_docs/docs/{epas/14 => }/edb_plus/06_command_summary.mdx (100%) rename product_docs/docs/{epas/14 => }/edb_plus/images/advanced_server_installation_details.png (100%) rename product_docs/docs/{epas/14 => }/edb_plus/images/edb_logo.png (100%) rename product_docs/docs/{epas/14 => }/edb_plus/images/edb_logo.svg (100%) rename product_docs/docs/{epas/14 => }/edb_plus/images/edb_plus_welcome.png (100%) rename product_docs/docs/{epas/14 => }/edb_plus/images/installation_complete.png (100%) rename product_docs/docs/{epas/14 => }/edb_plus/images/installation_directory.png (100%) rename product_docs/docs/{epas/14 => }/edb_plus/images/ready_to_install.png (100%) rename product_docs/docs/{epas/14/edb_plus/02_edb_plus.mdx => edb_plus/index.mdx} (90%) delete mode 100644 product_docs/docs/epas/14/edb_plus/index.mdx diff --git a/product_docs/docs/epas/14/edb_plus/03_installing_edb_plus.mdx b/product_docs/docs/edb_plus/03_installing_edb_plus.mdx similarity index 95% rename from product_docs/docs/epas/14/edb_plus/03_installing_edb_plus.mdx rename to product_docs/docs/edb_plus/03_installing_edb_plus.mdx index 3e25833fe69..a3b29d98e51 100644 --- a/product_docs/docs/epas/14/edb_plus/03_installing_edb_plus.mdx +++ b/product_docs/docs/edb_plus/03_installing_edb_plus.mdx @@ -4,7 +4,17 @@ title: "Installing EDB*Plus" -You can use an RPM installer or a graphical installer to add EDB\*Plus to your Advanced Server installation. +This table lists the latest 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. + +| EDB*Plus | EPAS 14 | EPAS 13 | EPAS 12 | EPAS 11 | EPAS 10 | +| -------- | ------- | ------- | ------- | ------- | ------- | +| 40 | Y | Y | Y | Y | Y | +| 39 | N | Y | Y | Y | Y | +| 38 | N | Y | Y | Y | Y | +| 37 | N | N | Y | Y | Y | +| 36 | N | N | N | Y | Y | + + ## Installation Prerequisites diff --git a/product_docs/docs/epas/14/edb_plus/04_using_edb_plus.mdx b/product_docs/docs/edb_plus/04_using_edb_plus.mdx similarity index 100% rename from product_docs/docs/epas/14/edb_plus/04_using_edb_plus.mdx rename to product_docs/docs/edb_plus/04_using_edb_plus.mdx diff --git a/product_docs/docs/epas/14/edb_plus/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/05_using_edb_plus_with_ssl.mdx similarity index 100% rename from product_docs/docs/epas/14/edb_plus/05_using_edb_plus_with_ssl.mdx rename to product_docs/docs/edb_plus/05_using_edb_plus_with_ssl.mdx diff --git a/product_docs/docs/epas/14/edb_plus/06_command_summary.mdx b/product_docs/docs/edb_plus/06_command_summary.mdx similarity index 100% rename from product_docs/docs/epas/14/edb_plus/06_command_summary.mdx rename to product_docs/docs/edb_plus/06_command_summary.mdx diff --git a/product_docs/docs/epas/14/edb_plus/images/advanced_server_installation_details.png b/product_docs/docs/edb_plus/images/advanced_server_installation_details.png similarity index 100% rename from product_docs/docs/epas/14/edb_plus/images/advanced_server_installation_details.png rename to product_docs/docs/edb_plus/images/advanced_server_installation_details.png diff --git a/product_docs/docs/epas/14/edb_plus/images/edb_logo.png b/product_docs/docs/edb_plus/images/edb_logo.png similarity index 100% rename from product_docs/docs/epas/14/edb_plus/images/edb_logo.png rename to product_docs/docs/edb_plus/images/edb_logo.png diff --git a/product_docs/docs/epas/14/edb_plus/images/edb_logo.svg b/product_docs/docs/edb_plus/images/edb_logo.svg similarity index 100% rename from product_docs/docs/epas/14/edb_plus/images/edb_logo.svg rename to product_docs/docs/edb_plus/images/edb_logo.svg diff --git a/product_docs/docs/epas/14/edb_plus/images/edb_plus_welcome.png b/product_docs/docs/edb_plus/images/edb_plus_welcome.png similarity index 100% rename from product_docs/docs/epas/14/edb_plus/images/edb_plus_welcome.png rename to product_docs/docs/edb_plus/images/edb_plus_welcome.png diff --git a/product_docs/docs/epas/14/edb_plus/images/installation_complete.png b/product_docs/docs/edb_plus/images/installation_complete.png similarity index 100% rename from product_docs/docs/epas/14/edb_plus/images/installation_complete.png rename to product_docs/docs/edb_plus/images/installation_complete.png diff --git a/product_docs/docs/epas/14/edb_plus/images/installation_directory.png b/product_docs/docs/edb_plus/images/installation_directory.png similarity index 100% rename from product_docs/docs/epas/14/edb_plus/images/installation_directory.png rename to product_docs/docs/edb_plus/images/installation_directory.png diff --git a/product_docs/docs/epas/14/edb_plus/images/ready_to_install.png b/product_docs/docs/edb_plus/images/ready_to_install.png similarity index 100% rename from product_docs/docs/epas/14/edb_plus/images/ready_to_install.png rename to product_docs/docs/edb_plus/images/ready_to_install.png diff --git a/product_docs/docs/epas/14/edb_plus/02_edb_plus.mdx b/product_docs/docs/edb_plus/index.mdx similarity index 90% rename from product_docs/docs/epas/14/edb_plus/02_edb_plus.mdx rename to product_docs/docs/edb_plus/index.mdx index 65f106a8d2d..d1afbae93d9 100644 --- a/product_docs/docs/epas/14/edb_plus/02_edb_plus.mdx +++ b/product_docs/docs/edb_plus/index.mdx @@ -1,5 +1,8 @@ --- title: "EDB*Plus" +description: EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server. +redirects: + - 02_edb_plus legacyRedirectsGenerated: # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. - "/edb-docs/d/edb-postgres-advanced-server/user-guides/database-compatibility-for-oracle-developers-tools-and-utilities-guide/9.6/DB_Compat_for_Oracle_Dev_Tools_Guide.1.05.html" diff --git a/product_docs/docs/epas/14/edb_plus/index.mdx b/product_docs/docs/epas/14/edb_plus/index.mdx deleted file mode 100644 index d15d7f40edd..00000000000 --- a/product_docs/docs/epas/14/edb_plus/index.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -navTitle: EDB*Plus — CLI -title: "EDB*Plus User's Guide" ---- - -This guide describes how to connect to an Advanced Server database using EDB\*Plus. EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server that accepts SQL commands that allow you to: - -- Query certain database objects -- Execute stored procedures -- Format output from SQL commands -- Execute batch scripts -- Execute OS commands -- Record output - -For detailed information about the features supported by Advanced Server, consult the complete library of Advanced Server guides available at: - -[https://www.enterprisedb.com/docs](/epas/latest/) - -
- -introduction edb_plus installing_edb_plus using_edb_plus using_edb_plus_with_ssl command_summary conclusion - -
diff --git a/src/pages/index.js b/src/pages/index.js index 1422a3bbeb6..54adfe62f85 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -185,6 +185,7 @@ const Page = () => ( pgAdmin LiveCompare + EDB\*Plus From ec4f38d026bd207403b266b99b843078bf741ba3 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 3 Feb 2022 05:04:32 -0500 Subject: [PATCH 02/29] updates to main page --- src/pages/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/pages/index.js b/src/pages/index.js index 54adfe62f85..790cb2d0a1a 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -185,7 +185,7 @@ const Page = () => ( pgAdmin LiveCompare - EDB\*Plus + EDB*Plus From ae19913693c64e7e4f881947869445da45bb9500 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Thu, 3 Feb 2022 16:17:04 -0500 Subject: [PATCH 03/29] trying to get it to work --- build-sources.json | 5 +++-- gatsby-config.js | 3 ++- .../docs/edb_plus/{ => 40}/03_installing_edb_plus.mdx | 2 +- product_docs/docs/edb_plus/{ => 40}/04_using_edb_plus.mdx | 0 .../docs/edb_plus/{ => 40}/05_using_edb_plus_with_ssl.mdx | 0 product_docs/docs/edb_plus/{ => 40}/06_command_summary.mdx | 0 .../{ => 40}/images/advanced_server_installation_details.png | 0 product_docs/docs/edb_plus/{ => 40}/images/edb_logo.png | 0 product_docs/docs/edb_plus/{ => 40}/images/edb_logo.svg | 0 .../docs/edb_plus/{ => 40}/images/edb_plus_welcome.png | 0 .../docs/edb_plus/{ => 40}/images/installation_complete.png | 0 .../docs/edb_plus/{ => 40}/images/installation_directory.png | 0 .../docs/edb_plus/{ => 40}/images/ready_to_install.png | 0 product_docs/docs/edb_plus/{ => 40}/index.mdx | 0 14 files changed, 6 insertions(+), 4 deletions(-) rename product_docs/docs/edb_plus/{ => 40}/03_installing_edb_plus.mdx (98%) rename product_docs/docs/edb_plus/{ => 40}/04_using_edb_plus.mdx (100%) rename product_docs/docs/edb_plus/{ => 40}/05_using_edb_plus_with_ssl.mdx (100%) rename product_docs/docs/edb_plus/{ => 40}/06_command_summary.mdx (100%) rename product_docs/docs/edb_plus/{ => 40}/images/advanced_server_installation_details.png (100%) rename product_docs/docs/edb_plus/{ => 40}/images/edb_logo.png (100%) rename product_docs/docs/edb_plus/{ => 40}/images/edb_logo.svg (100%) rename product_docs/docs/edb_plus/{ => 40}/images/edb_plus_welcome.png (100%) rename product_docs/docs/edb_plus/{ => 40}/images/installation_complete.png (100%) rename product_docs/docs/edb_plus/{ => 40}/images/installation_directory.png (100%) rename product_docs/docs/edb_plus/{ => 40}/images/ready_to_install.png (100%) rename product_docs/docs/edb_plus/{ => 40}/index.mdx (100%) diff --git a/build-sources.json b/build-sources.json index 747b69c4a6c..0a45f784a2f 100644 --- a/build-sources.json +++ b/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 } diff --git a/gatsby-config.js b/gatsby-config.js index 1813fb548a1..b89fd128d45 100644 --- a/gatsby-config.js +++ b/gatsby-config.js @@ -19,8 +19,8 @@ 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" }, @@ -28,6 +28,7 @@ const sourceToPluginConfig = { 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", diff --git a/product_docs/docs/edb_plus/03_installing_edb_plus.mdx b/product_docs/docs/edb_plus/40/03_installing_edb_plus.mdx similarity index 98% rename from product_docs/docs/edb_plus/03_installing_edb_plus.mdx rename to product_docs/docs/edb_plus/40/03_installing_edb_plus.mdx index a3b29d98e51..389d58c505f 100644 --- a/product_docs/docs/edb_plus/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" -This table lists the latest 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 latest 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. | EDB*Plus | EPAS 14 | EPAS 13 | EPAS 12 | EPAS 11 | EPAS 10 | | -------- | ------- | ------- | ------- | ------- | ------- | diff --git a/product_docs/docs/edb_plus/04_using_edb_plus.mdx b/product_docs/docs/edb_plus/40/04_using_edb_plus.mdx similarity index 100% rename from product_docs/docs/edb_plus/04_using_edb_plus.mdx rename to product_docs/docs/edb_plus/40/04_using_edb_plus.mdx diff --git a/product_docs/docs/edb_plus/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/40/05_using_edb_plus_with_ssl.mdx similarity index 100% rename from product_docs/docs/edb_plus/05_using_edb_plus_with_ssl.mdx rename to product_docs/docs/edb_plus/40/05_using_edb_plus_with_ssl.mdx diff --git a/product_docs/docs/edb_plus/06_command_summary.mdx b/product_docs/docs/edb_plus/40/06_command_summary.mdx similarity index 100% rename from product_docs/docs/edb_plus/06_command_summary.mdx rename to product_docs/docs/edb_plus/40/06_command_summary.mdx diff --git a/product_docs/docs/edb_plus/images/advanced_server_installation_details.png b/product_docs/docs/edb_plus/40/images/advanced_server_installation_details.png similarity index 100% rename from product_docs/docs/edb_plus/images/advanced_server_installation_details.png rename to product_docs/docs/edb_plus/40/images/advanced_server_installation_details.png diff --git a/product_docs/docs/edb_plus/images/edb_logo.png b/product_docs/docs/edb_plus/40/images/edb_logo.png similarity index 100% rename from product_docs/docs/edb_plus/images/edb_logo.png rename to product_docs/docs/edb_plus/40/images/edb_logo.png diff --git a/product_docs/docs/edb_plus/images/edb_logo.svg b/product_docs/docs/edb_plus/40/images/edb_logo.svg similarity index 100% rename from product_docs/docs/edb_plus/images/edb_logo.svg rename to product_docs/docs/edb_plus/40/images/edb_logo.svg diff --git a/product_docs/docs/edb_plus/images/edb_plus_welcome.png b/product_docs/docs/edb_plus/40/images/edb_plus_welcome.png similarity index 100% rename from product_docs/docs/edb_plus/images/edb_plus_welcome.png rename to product_docs/docs/edb_plus/40/images/edb_plus_welcome.png diff --git a/product_docs/docs/edb_plus/images/installation_complete.png b/product_docs/docs/edb_plus/40/images/installation_complete.png similarity index 100% rename from product_docs/docs/edb_plus/images/installation_complete.png rename to product_docs/docs/edb_plus/40/images/installation_complete.png diff --git a/product_docs/docs/edb_plus/images/installation_directory.png b/product_docs/docs/edb_plus/40/images/installation_directory.png similarity index 100% rename from product_docs/docs/edb_plus/images/installation_directory.png rename to product_docs/docs/edb_plus/40/images/installation_directory.png diff --git a/product_docs/docs/edb_plus/images/ready_to_install.png b/product_docs/docs/edb_plus/40/images/ready_to_install.png similarity index 100% rename from product_docs/docs/edb_plus/images/ready_to_install.png rename to product_docs/docs/edb_plus/40/images/ready_to_install.png diff --git a/product_docs/docs/edb_plus/index.mdx b/product_docs/docs/edb_plus/40/index.mdx similarity index 100% rename from product_docs/docs/edb_plus/index.mdx rename to product_docs/docs/edb_plus/40/index.mdx From c556c70d254094d72b661058d3ec1cd8a3e4687b Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Tue, 8 Feb 2022 21:02:51 +0000 Subject: [PATCH 04/29] catch-all redirects for the EDB*Plus breakout --- gatsby-node.js | 2 +- scripts/legacy_redirects/legacy_redirects_metadata.json | 4 ++-- static/_redirects | 5 ++++- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/gatsby-node.js b/gatsby-node.js index 3f4f2921161..f0feb940df4 100644 --- a/gatsby-node.js +++ b/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 diff --git a/scripts/legacy_redirects/legacy_redirects_metadata.json b/scripts/legacy_redirects/legacy_redirects_metadata.json index 4aa2021c626..51e425994dd 100644 --- a/scripts/legacy_redirects/legacy_redirects_metadata.json +++ b/scripts/legacy_redirects/legacy_redirects_metadata.json @@ -284,7 +284,7 @@ } }, "EDB*Plus": { - "folder_name": "epas", + "folder_name": "edb_plus", "subfolders": { "default": { "user-guides/edbplus-users-guide": "edb_plus", @@ -324,4 +324,4 @@ } } } -} +} \ No newline at end of file diff --git a/static/_redirects b/static/_redirects index 1395fd0059f..6500b0fa647 100644 --- a/static/_redirects +++ b/static/_redirects @@ -116,6 +116,9 @@ # BigAnimal /docs/edbcloud/* /docs/biganimal/:splat 301 +# EDB*Plus breakout from EPAS +/docs/epas/latest/edb_plus/* /docs/edb_plus/latest/:splat 301 + # Super legacy redirects (Docs 0.5 -> 1.0) /docs/en/1.0/EDB_HA_SCALABILITY/* https://www.enterprisedb.com/edb-docs/d/edb-postgres-failover-manager/user-guides/high-availability-scalability-guide/3.2/:splat 301 /docs/en/1.0/EDB_Migration_Portal_v1.0/* https://www.enterprisedb.com/edb-docs/d/edb-postgres-migration-portal/user-guides/user-guide/1.0/:splat 301 @@ -337,7 +340,7 @@ /docs/en/2.3/ARK_GSG_01-19/* https://www.enterprisedb.com/edb-docs/p/edb-backup-and-recovery-tool/ 301 /docs/en/3.0/EDB_ARK_RN_3.0-BAK/* https://www.enterprisedb.com/edb-docs/p/edb-postgres-failover-manager/ 301 /docs/en/3.1/edbfm-bak/* https://www.enterprisedb.com/edb-docs/p/edb-postgres-failover-manager/ 301 -/docs/en/36/EDB_Plus/* https://www.enterprisedb.com/edb-docs/p/edb-backup-and-recovery-tool/ 301 +/docs/en/36/EDB_Plus/* /docs/edb_plus/latest 301 /docs/en/5.1/repguide-old-uttam/* https://www.enterprisedb.com/edb-docs/ 301 /docs/en/51/migrate/* https://www.enterprisedb.com/edb-docs/d/edb-postgres-migration-toolkit/user-guides/user-guide/50.0.3/ 301 /docs/en/51/migrate-old/* https://www.enterprisedb.com/edb-docs/p/edb-postgres-migration-portal/ 301 From 56c439a27f7c92b40e959902d3f56db6f2e20d18 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Mon, 14 Feb 2022 11:00:12 -0500 Subject: [PATCH 05/29] set up v39 folder --- .../docs/edb_plus/39/edb_plus/02_edb_plus.mdx | 21 + .../39/edb_plus/03_installing_edb_plus.mdx | 441 ++++++++ .../39/edb_plus/04_using_edb_plus.mdx | 144 +++ .../edb_plus/05_using_edb_plus_with_ssl.mdx | 329 ++++++ .../39/edb_plus/06_command_summary.mdx | 997 ++++++++++++++++++ .../advanced_server_installation_details.png | 3 + .../edb_plus/39/edb_plus/images/edb_logo.png | 3 + .../edb_plus/39/edb_plus/images/edb_logo.svg | 19 + .../39/edb_plus/images/edb_plus_welcome.png | 3 + .../edb_plus/images/installation_complete.png | 3 + .../images/installation_directory.png | 3 + .../39/edb_plus/images/ready_to_install.png | 3 + .../docs/edb_plus/39/edb_plus/index.mdx | 44 + 13 files changed, 2013 insertions(+) create mode 100644 product_docs/docs/edb_plus/39/edb_plus/02_edb_plus.mdx create mode 100644 product_docs/docs/edb_plus/39/edb_plus/03_installing_edb_plus.mdx create mode 100644 product_docs/docs/edb_plus/39/edb_plus/04_using_edb_plus.mdx create mode 100644 product_docs/docs/edb_plus/39/edb_plus/05_using_edb_plus_with_ssl.mdx create mode 100644 product_docs/docs/edb_plus/39/edb_plus/06_command_summary.mdx create mode 100755 product_docs/docs/edb_plus/39/edb_plus/images/advanced_server_installation_details.png create mode 100644 product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.png create mode 100644 product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.svg create mode 100755 product_docs/docs/edb_plus/39/edb_plus/images/edb_plus_welcome.png create mode 100755 product_docs/docs/edb_plus/39/edb_plus/images/installation_complete.png create mode 100755 product_docs/docs/edb_plus/39/edb_plus/images/installation_directory.png create mode 100755 product_docs/docs/edb_plus/39/edb_plus/images/ready_to_install.png create mode 100644 product_docs/docs/edb_plus/39/edb_plus/index.mdx diff --git a/product_docs/docs/edb_plus/39/edb_plus/02_edb_plus.mdx b/product_docs/docs/edb_plus/39/edb_plus/02_edb_plus.mdx new file mode 100644 index 00000000000..236afb3b23d --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/02_edb_plus.mdx @@ -0,0 +1,21 @@ +--- +title: "EDB*Plus" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/edb_plus.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/edb_plus.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/edb_plus.html" +--- + + + +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. + +EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: + +- Querying certain database objects +- Executing stored procedures +- Formatting output from SQL commands +- Executing batch scripts +- Executing OS commands +- Recording output diff --git a/product_docs/docs/edb_plus/39/edb_plus/03_installing_edb_plus.mdx b/product_docs/docs/edb_plus/39/edb_plus/03_installing_edb_plus.mdx new file mode 100644 index 00000000000..b10dd484fee --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/03_installing_edb_plus.mdx @@ -0,0 +1,441 @@ +--- +title: "Installing EDB*Plus" +redirects: + - "01_installing_prereq" + - "02_rpm_installation" + - "03_using_gui" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/installing_edb_plus.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/installing_edb_plus.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/installing_edb_plus.html" +--- + + + +You can use an RPM installer or a graphical installer to add EDB\*Plus to your Advanced Server installation. + +## 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: + +- On RHEL or CentOS 7: + + ```text + # yum -y install java + ``` + +- On RHEL/Rocky Linux/AlmaLinux 8: + + ```text + # dnf -y install java + ``` + +If you are using Windows, Java installers and instructions are available online at: + + + +You must also have credentials that allow access to the EDB repository. For information about requesting credentials, visit: + + + +After receiving your repository credentials: + +1. Create the repository configuration file. +2. Modify the file, providing your user name and password. +3. Install EDB\*Plus. + +For detailed information about creating and using EDB repositories to install Advanced Server or its supporting components, see the *EDB Postgres Advanced Server Installation Guide* available at: + +[https://www.enterprisedb.com/docs](/epas/latest/) + +## Installing EDB\*Plus on a CentOS Host + +You can use an RPM package to install EDB\*Plus on a CentOS host. + +- To install the repository configuration file, assume superuser privileges, and invoke one of the following platform-specific commands: + + On CentOS 7: + + ```text + yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm + ``` + + On Rocky Linux/AlmaLinux 8: + + ```text + dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm + ``` + +- Replace the `USERNAME:PASSWORD` variable in the following command with the username and password of a registered EDB user: + + ```text + sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo + ``` + +- Before installing EDB\*Plus, you must install the `epel-release` package: + + On CentOS 7: + + ```text + yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm + ``` + + On Rocky Linux/AlmaLinux 8: + + ```text + dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm + ``` + +- For Rocky Linux/AlmaLinux 8, enable the PowerTools repository to satisfy package dependencies: + + ```text + dnf config-manager --set-enabled PowerTools + ``` + +- The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After saving your changes to the configuration file, you can use the following command to install EDB\*Plus: + + On CentOS 7: + + ```text + yum -y install edb-asxx-edbplus + ``` + + On Rocky Linux/AlmaLinux 8: + + ```text + dnf -y install edb-asxx-edbplus + ``` + +Where, `xx` is the Advanced Server version. + +When you install an RPM package that is signed by a source that is not recognized by your system, `yum` may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. + +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 + +You can use an RPM package to install EDB\*Plus on a RHEL host. + +- To install the repository configuration file, assume superuser privileges, and invoke one of the following platform-specific commands: + + On RHEL 7: + + ```text + yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm + ``` + + On RHEL 8: + + ```text + dnf -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm + ``` + +- Replace the `USERNAME:PASSWORD` variable in the following command with the username and password of a registered EDB user: + + ```text + sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo + ``` + +- Before installing EDB\*Plus, you must install the `epel-release` package: + + On RHEL 7: + + ```text + yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm + ``` + + On RHEL 8: + + ```text + dnf -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm + ``` + +- Enable the repository: + + On RHEL7, enable the `optional, extras`, and `HA` repositories to satisfy package dependencies: + + ```text + subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" + ``` + + On RHEL 8, enable the `codeready-builder-for-rhel-8-*-rpms` repository to satisfy package dependencies: + + ```text + ARCH=$( /bin/arch ) + + subscription-manager repos --enable "codeready-builder-for-rhel-8-${ARCH}-rpms" + ``` + +- The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After saving your changes to the configuration file, you can use the following command to install EDB\*Plus: + + On RHEL 7: + + ```text + yum -y install edb-asxx-edbplus + ``` + + On RHEL 8: + + ```text + dnf -y install edb-asxx-edbplus + ``` + +Where, `xx` is the Advanced Server version. + +When you install an RPM package that is signed by a source that is not recognized by your system, `yum` may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. + +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 CentOS/RHEL 7 ppc64le Host + +You can use an RPM package to install EDB\*Plus on a CentOS or RHEL 7 ppc64le host. + +- To install the IBM Advance Toolchain repository: + + On CentOS or RHEL 7 ppc64le: + + ```text + rpm --import https://public.dhe.ibm.com/software/server/POWER/Linux/toolchain/at/redhat/RHEL7/gpg-pubkey-6976a827-5164221b + ``` + + The repository configuration file is named `advance-toolchain.repo`. The file resides in `/etc/yum.repos.d`. + +- After creating the `advance-toolchain.repo` file, the `enabled` parameter is set to `1` by default. + + ```text + [advance-toolchain] + name=Advance Toolchain IBM FTP + baseurl=https://public.dhe.ibm.com/software/server/POWER/Linux/ + toolchain/at/redhat/RHEL7 + failovermethod=priority + enabled=1 + gpgcheck=1 + gpgkey=ftp://public.dhe.ibm.com/software/server/POWER/Linux/ + toolchain/at/redhat/RHELX/gpg-pubkey-6976a827-5164221b + ``` + +- To install the Enterprisedb repository configuration file,assume superuser privileges and invoke thefollowing command: + + On CentOS or RHEL 7 ppc64le: + + ```text + yum -y install https://yum.enterprisedb.com/edbrepos/edb-repo-latest.noarch.rpm + ``` + +- Replace the `USERNAME:PASSWORD` variable in the following command with the username and password of a registered EDB user: + + ```text + sed -i "s@:@USERNAME:PASSWORD@" /etc/yum.repos.d/edb.repo + ``` + +- Before installing EDB\*Plus, you must install the `epel-release` package: + + On CentOS or RHEL 7 ppc64le: + + ```text + yum -y install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm + ``` + +- Enable the repository: + + On RHEL7, enable the `optional, extras`, and `HA` repositories to satisfy package dependencies: + + ```text + subscription-manager repos --enable "rhel-*-optional-rpms" --enable "rhel-*-extras-rpms" --enable "rhel-ha-for-rhel-*-server-rpms" + ``` + +- The repository configuration file is named `edb.repo`. The file resides in `/etc/yum.repos.d`. After saving your changes to the configuration file, you can use the following command to install EDB\*Plus: + + ```text + yum -y install edb-asxx-edbplus + ``` + +Where, `xx` is the Advanced Server version. + +When you install an RPM package that is signed by a source that is not recognized by your system, `yum` may ask for your permission to import the key to your local server. If prompted, and you are satisfied that the packages come from a trustworthy source, enter `y`, and press `Return` to continue. + +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 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: + + + +The following steps will walk you through using the EDB apt repository to install a debian package. When using the commands, replace the `username` and `password` with the credentials provided by EDB. + +- Assume superuser privileges: + + ```text + sudo su - + ``` + +- Configure the EDB repository: + + On Debian 9, Ubuntu 18, and Ubuntu 20: + + ```text + sh -c 'echo "deb https://USERNAME:PASSWORD@apt.enterprisedb.com/$(lsb_release -cs)-edb/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/edb-$(lsb_release -cs).list' + ``` + + On Debian 10: + + a. Set up the EDB repository: + + ```text + sh -c 'echo "deb [arch=amd64] https://apt.enterprisedb.com/$(lsb_release -cs)-edb/ $(lsb_release -cs) main" > /etc/apt/sources.list.d/edb-$(lsb_release -cs).list' + ``` + + b. Substitute your EDB credentials for the `username` and `password` placeholders in the following command: + + ```text + sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf' + ``` + +- Add support to your system for secure APT repositories: + + ```text + apt-get -y install apt-transport-https + ``` + +- Add the EDB signing key: + + ```text + wget -q -O - https://apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add - + ``` + +- Update the repository metadata: + + ```text + apt-get update + ``` + +- Install Debian package: + + ```text + apt-get -y install edb-asxx-edbplus + ``` + +Where, `xx` is the Advanced Server version. + +## 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: + +```text +export JAVA_HOME= +export PATH=/bin:$PATH +``` + +By default, the `pg_hba.conf` file for the RPM installer enforces `IDENT` authentication. Before invoking EDB\*Plus, you must either modify the `pg_hba.conf` file, changing the authentication method to a form other than `IDENT` (and restarting the server), or perform the following steps to ensure that an `IDENT` server is accessible: + +You must confirm that an `identd` server is installed and running. You can use the `yum` package manager to install an `identd` server by invoking the command: + +- On RHEL or CentOS 7: + + ```text + yum -y install xinetd authd + ``` + +- On RHEL/Rocky Linux/AlmaLinux 8: + + ```text + dnf -y install xinetd authd + ``` + +The command should create a file named `/etc/xinetd.d/auth` that contains: + +```text +service auth +{ + disable = yes + socket_type = stream +wait =no +user = ident +cps = 4096 10 +instances = UNLIMITED +server = /usr/sbin/in.authd server_args = -t60 --xerror –os +} +``` + +!!! Note + If the file includes a `-E` argument at the end of the server arguments, please erase `-E`. + +Then, to start the `identd` server, invoke the following commands: + +```text +systemctl enable xinetd +systemctl start xinetd +``` + +Open the `pg_ident.conf` file and create a user mapping: + +```text +# map_name system_username postgres_username + edbas enterprisedb enterprisedb +``` + +Where: + +- The name specified in the `map_name` column is a user-defined name that will identify the mapping in the `pg_hba.conf` file. +- The name specified in the `system_username` column is `enterprisedb`. +- The name specified in the `postgres_username` column is `enterprisedb`. + +Then, open the `pg_hba.conf` file and modify the `IDENT` entries: + +- If you are using an IPv4 local connection, modify the file entry to read: + + `host all all 127.0.0.0/0 ident map=edbas` + +- If you are using an IPv6 local connection, modify the file entry to read: + + `host all all ::1/128 ident map=edbas` + +You must restart the Advanced Server service before invoking EDB\*Plus. For detailed information about controlling the Advanced Server service, see the *EDB Postgres Advanced Server Installation Guide*, available at: + +[https://www.enterprisedb.com/docs](/epas/latest/) + +## 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. + +![The EDBPlus Welcome window*](images/edb_plus_welcome.png) + +
Fig. 1: The EDB*Plus Welcome window
+ + +The EDB\*Plus installer welcomes you to the setup wizard, as shown in the figure below. + +![The Installation Directory window](images/installation_directory.png) + +
Fig. 2: The Installation Directory window
+ + +Use the `Installation Directory` field to specify the directory in which you wish to install the EDB\*Plus software. Then, click `Next` to continue. + +![The Advanced Server Installation Details window](images/advanced_server_installation_details.png) + +
Fig. 3: The Advanced Server Installation Details window
+ + +Use fields on the `EDB Postgres Advanced Server Installation Details` window to identify the location of the Advanced Server host: + +- Use the `Host` field to identify the system on which Advanced Server resides. +- Use the `Port` field to identify the listener port that Advanced Server monitors for client connections. + +Then, click `Next` to continue. + +![The Ready to Install window](images/ready_to_install.png) + +
Fig. 4: The Ready to Install window
+ + +The `Ready to Install` window notifies you when the installer has all of the information needed to install EDB\*Plus on your system. Click `Next` to install EDB\*Plus. + +![The installation is complete](images/installation_complete.png) + +
Fig. 5: The installation is complete
+ + +The installer notifies you when the setup wizard has completed the EDB\*Plus installation. Click `Finish` to exit the installer. diff --git a/product_docs/docs/edb_plus/39/edb_plus/04_using_edb_plus.mdx b/product_docs/docs/edb_plus/39/edb_plus/04_using_edb_plus.mdx new file mode 100644 index 00000000000..ce0138457ce --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/04_using_edb_plus.mdx @@ -0,0 +1,144 @@ +--- +title: "Using EDB*Plus" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/using_edb_plus.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/using_edb_plus.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/using_edb_plus.html" +--- + + + + + +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 ] ] [ | /NOLOG ] [ @[. ] ] +``` + +`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 +[/][@{ | } ] +``` + + 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 +[:][/][?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: + + + + 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\as13\edbplus>edbplus enterprisedb/password +Connected to EnterpriseDB 13.0.1 (localhost:5444/edb) AS enterprisedb + +EDB*Plus: Release 13 (Build 39.0.2) +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\as13\edbplus>edbplus enterprisedb/password@localhost:5445/edb +Connected to EnterpriseDB 13.0.1 (localhost:5445/edb) AS enterprisedb + +EDB*Plus: Release 13 (Build 39.0.2) +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\as13\edbplus>edbplus enterprisedb/password@hr_5445 +Connected to EnterpriseDB 13.0.1 (localhost:5445/hr) AS enterprisedb + +EDB*Plus: Release 13 (Build 39.0.2) +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\as13\edbplus>edbplus enterprisedb/password @dept_query +Connected to EnterpriseDB 13.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 +``` diff --git a/product_docs/docs/edb_plus/39/edb_plus/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/39/edb_plus/05_using_edb_plus_with_ssl.mdx new file mode 100644 index 00000000000..251c9086928 --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/05_using_edb_plus_with_ssl.mdx @@ -0,0 +1,329 @@ +--- +title: "Using a Secure Sockets Layer (SSL) Connection" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/using_edb_plus_with_ssl.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/using_edb_plus_with_ssl.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/using_edb_plus_with_ssl.html" +--- + + + + + +An EDB\*Plus connection to the Advanced Server database can be accomplished using secure sockets layer (SSL) connectivity. + +Using SSL requires various prerequisite configuration steps performed on the database server involved with the SSL connection as well as creation of the Java truststore and keystore on the host that will run EDB\*Plus. + +The Java *truststore* is the file containing the Certificate Authority (CA) certificates with which the Java client (EDB\*Plus) uses to verify the authenticity of the server to which it is initiating an SSL connection. + +The Java *keystore* is the file containing private and public keys and their corresponding certificates. The keystore is required for client authentication to the server, which is used for the EDB\*Plus connection. + +The following is material to which you can refer to for guidance in setting up the SSL connections: + +- For information on setting up SSL connectivity to the Advanced Server database, see the section about secure TCP connections with SSL in Chapter 18 “Server Setup and Operation” in the PostgreSQL Core Documentation located at: + + + +- For information on JDBC client connectivity using SSL, see the section on configuring the client in Chapter 4 “Using SSL” in The PostgreSQL JDBC Interface located at: + + + +The following sections provide information for the configuration steps of using SSL. + +- Configuring SSL on Advanced Server +- Configuring SSL for the EDB\*Plus client +- Requesting SSL connection to the Advanced Server database + +## Configuring SSL on Advanced Server + +This section provides an example of configuring SSL on a database server to demonstrate the use of SSL with EDB\*Plus. A self-signed certificate is used for this purpose. + +**Step 1:** Create the certificate signing request (CSR). + +In the following example the generated certificate signing request file is `server.csr`. The private key is generated as file `server.key`. + +```text +$ openssl req -new -nodes -text -out server.csr \ +> -keyout server.key -subj "/CN=enterprisedb" +Generating a 2048 bit RSA private key +.............................+++ +....................................................................+++ +writing new private key to 'server.key' +----- +``` + +!!! Note + When creating the certificate, the value specified for the common name field (designated as `CN=enterprisedb` in this example) must be the database user name that is specified when connecting to EDB\*Plus. + +In addition, user name maps can be used as defined in the `pg_ident.conf` file to permit more flexibility for the common name and database user name. Steps 8 and 9 describe the use of user name `maps`. + +**Step 2:** Generate the self-signed certificate. + +The following generates a self-signed certificate to file `server.crt` using the certificate signing request file, `server.csr`, and the private key, `server.key`, as input. + +```text +$ openssl x509 -req -days 365 -in server.csr -signkey server.key \ +> -out server.crt +Signature ok +subject=/CN=enterprisedb +Getting Private key +``` + +**Step 3:** Make a copy of the server certificate (`server.crt`) to be used as the root Certificate Authority (CA) file (`root.crt`). + +```text +$ cp server.crt root.crt +``` + +**Step 4:** Delete the now redundant certificate signing request (`server.csr`). + +```text +$ rm -f server.csr +``` + +**Step 5:** Move or copy the certificate and private key files to the Advanced Server data directory (for example, `/opt/edb/as13/data`). + +```text +$ mv root.crt /opt/edb/as13/data +$ mv server.crt /opt/edb/as13/data +$ mv server.key /opt/edb/as13/data +``` + +**Step 6:** Set the file ownership and permissions on the certificate files and private key file. + +Set the ownership to the operating system account that owns the data sub-directory of the database server. Set the permissions so that no other groups or accounts other than the owner can access these files. + +```text +$ chown enterprisedb root.crt server.crt server.key +$ chgrp enterprisedb root.crt server.crt server.key +$ chmod 600 root.crt server.crt server.key +$ ls -l +total 152 + . + . + . +-rw------- 1 enterprisedb enterprisedb 985 Aug 22 11:00 root.crt +-rw------- 1 enterprisedb enterprisedb 985 Aug 22 10:59 server.crt +-rw------- 1 enterprisedb enterprisedb 1704 Aug 22 10:58 server.key +``` + +**Step 7:** In the `postgresql.conf` file, make the following modifications. + +```text +ssl = on +ssl_cert_file = 'server.crt' +ssl_key_file = 'server.key' +ssl_ca_file = 'root.crt' +``` + +**Step 8:** Modify the `pg_hba.conf` file to enable SSL usage on the desired database to which EDB\*Plus is to make the SSL connection. + +In the `pg_hba.conf` file, the `hostssl` type indicates the entry is used to validate SSL connection attempts from the client (EDB\*Plus). + +The authentication method is set to cert with the option `clientcert=1` in order to require an SSL certificate from the client against which authentication is performed using the common name of the certificate (`enterprisedb` in this example). + +The `map=sslusers` option specifies that a mapping named `sslusers` defined in the `pg_ident.conf` file is to be used for authentication. This mapping allows a connection to the database if the common name from the certificate and the database user name attempting the connection match the `SYSTEM-USERNAME/PG-USERNAME` pair listed in the `pg_ident.conf` file. + +The following is an example of the settings in the `pg_hba.conf` file if the database `(edb)` must use SSL connections. + +```text +# TYPE DATABASE USER ADDRESS METHOD + +# "local" is for Unix domain socket connections only +local all all md5 +# IPv4 local connections: +hostssl edb all 192.168.2.0/24 cert clientcert=1 map=sslusers +``` + +**Step 9:** The following shows the user name maps in the `pg_ident.conf` file related to the `pg_hba.conf` file by the `map=sslusers` option. These user name maps permit you to specify database user names `edbuser`, `postgres`, or `enterprisedb` when connecting with EDB\*Plus. + +```text +# MAPNAME SYSTEM-USERNAME PG-USERNAME + sslusers enterprisedb edbuser + sslusers enterprisedb postgres + sslusers enterprisedb enterprisedb +``` + +**Step 10:** Restart the database server after you have made the changes to the configuration files. + +## Configuring SSL for the EDB\*Plus Client + +After you have configured SSL on the database server, the following steps provide an example of generating certificate and keystore files for EDB\*Plus (the JDBC client). + +**Step 1:** Using files `server.crt` and `server.key` located under the database server data sub-directory, create copies of these files and move them to the host where EDB\*Plus is to be running. + +Store these files in the desired directory to contain the trusted certificate and keystore files to be generated in the following steps. The suggested location is to create a `.postgresql` sub-directory under the home user account that will invoke EDB\*Plus. Thus, these files will be under the `~/.postgresql` directory of the user account that will run EDB\*Plus. + +For this example, assume file `edb.crt` is a copy of `server.crt` and `edb.key` is a copy of `server.key`. + +**Step 2:** Create an additional copy of `edb.crt`. + +```text +$ cp edb.crt edb_root.crt +$ ls -l +total 12 +-rw-r--r-- 1 user user 985 Aug 22 14:17 edb.crt +-rw-r--r-- 1 user user 1704 Aug 22 14:18 edb.key +-rw-r--r-- 1 user user 985 Aug 22 14:19 edb_root.crt +``` + +**Step 3:** Create a Distinguished Encoding Rules (DER) format of file `edb_root.crt`. The generated DER format of this file is `edb_root.crt.der`. The DER format of the file is required for the `keytool` program used in Step 4. + +```text +$ openssl x509 -in edb_root.crt -out edb_root.crt.der -outform der +$ ls -l +total 16 +-rw-r--r-- 1 user user 985 Aug 22 14:17 edb.crt +-rw-r--r-- 1 user user 1704 Aug 22 14:18 edb.key +-rw-r--r-- 1 user user 985 Aug 22 14:19 edb_root.crt +-rw-rw-r-- 1 user user 686 Aug 22 14:21 edb_root.crt.der +``` + +**Step 4:** Use the `keytool` program to create a keystore file `(postgresql.keystore)` using `edb_root.crt.der` as the input. This process adds the certificate of the Postgres database server to the keystore file. + +!!! Note + The file name `postgresql.keystore` is recommended so that it can be accessed in its default directory location `~/.postgresql postgresql.keystore`, which is under the home directory of the user account invoking EDB\*Plus. Also note that the file name suffix can be `.jks` instead of `.keystore` (thus, file name `postgresql.jks`). However, in the remainder of these examples, file name `postgresql.keystore` is used. + +**For Windows only:** The path is `%APPDATA%\.postgresql\postgresql.keystore` + +The `keytool` program can be found under the `bin` subdirectory of the Java Runtime Environment installation. + +You will be prompted for a new password. Save this password as it must be specified with the PGSSLCERTPASS environment variable. + +```text +$ /usr/java/jdk1.8.0_131/jre/bin/keytool -keystore postgresql.keystore \ +> -alias postgresqlstore -import -file edb_root.crt.der +Enter keystore password: +Re-enter new password: +Owner: CN=enterprisedb +Issuer: CN=enterprisedb +Serial number: c60f40256b0e8d53 +Valid from: Tue Aug 22 10:59:25 EDT 2017 until: Wed Aug 22 10:59:25 EDT 2018 +Certificate fingerprints: + MD5: 85:0B:E9:A7:6E:4F:7C:B0:9B:D6:3A:44:55:E2:E9:8E + SHA1: DD:A6:71:24:0B:6C:F8:BC:7A:4C:89:9B:DC:22:6A:6C:B0:F5:3F:7C + SHA256: +DC:02:64:E2:B0:E9:6F:1C:FC:4F:AE:E6:18:85:0B:79:57:43:C3:C5:AE:43:0D:37 +:49:53:6D:11:69:06:46:48 + Signature algorithm name: SHA1withRSA + Version: 1 +Trust this certificate? [no]: yes +Certificate was added to keystore +``` + +**Step 5:** Create a `PKCS #12` format of the keystore file `(postgresql.p12)` using files `edb.crt` and `edb.key` as input. + +!!! Note + The file name `postgresql.p12` is recommended so that it can be accessed in its default directory location `~/.postgresql/postgresql.p12`, which is under the home directory of the user account invoking EDB\*Plus. + +**For Windows only:** The path is `%APPDATA%\.postgresql\postgresql.p12` + +You will be prompted for a new password. Save this password as it must be specified with the PGSSLKEYPASS environment variable. + +```text +$ openssl pkcs12 -export -in edb.crt -inkey edb.key -out postgresql.p12 +Enter Export Password: +Verifying - Enter Export Password: +$ ls –l +total 24 +-rw-rw-r-- 1 user user 985 Aug 24 12:18 edb.crt +-rw-rw-r-- 1 user user 1704 Aug 24 12:18 edb.key +-rw-rw-r-- 1 user user 985 Aug 24 12:20 edb_root.crt +-rw-rw-r-- 1 user user 686 Aug 24 12:20 edb_root.crt.der +-rw-rw-r-- 1 user user 758 Aug 24 12:26 postgresql.keystore +-rw-rw-r-- 1 user user 2285 Aug 24 12:28 postgresql.p12 +``` + +**Step 6:** If the `postgresql.keystore` and `postgresql.p12` files are not already in the `~/.postgresql` directory, move or copy them to that location. + +**For Windows only:** The directory is `%APPDATA%\.postgresql` + +**Step 7:** If the default location `~/.postgresql` is not used, then the full path (including the file name) to the `postgresql.keystore` file must be set with the `PGSSLCERT` environment variable, and the full path (including the file name) to file `postgresql.p12` must be set with the `PGSSLKEY` environment variable before invoking EDB\*Plus. + +In addition, if the generated file from Step 4 was not named `postgresql.keystore` or `postgresql.jks` then, use the `PGSSLCERT` environment variable to designate the file name and its location. Similarly, if the generated file from Step 5 was not named `postgresql.p12` then, use the `PGSSLKEY` environment variable to designate the file name and its location. + +## Requesting an SSL Connection between EDB\*Plus and the Advanced Server Database + +Be sure the following topics have been addressed in order to perform an SSL connection: + +- The trusted certificate and keystore files have been generated for both the database server and the client host to be invoking EDB\*Plus. +- The `postgresql.conf` file for the database server contains the updated configuration parameters. +- The `pg_hba.conf` file for the database server contains the required entry for permitting the SSL connection. +- For the client host, either the client’s certificate and keystore files have been placed in the user account’s `~/.postgresql` directory or the environment variables `PGSSLCERT` and `PGSSLKEY` are set before invoking EDB\*Plus. +- The `PGSSLCERTPASS` environment variable is set with a password. +- The `PGSSLKEYPASS` environment variable is set with a password + +When invoking EDB\*Plus, include the `?ssl=true` parameter in the database connection string as shown for the `connectstring` option in [Using EDB\*Plus](04_using_edb_plus/#using_edb_plus). + +The following is an example where EDB\*Plus is invoked from a host that is remote to the database server. + +The `postgresql.conf` file of the database server contains the following modified parameters: + +```text +ssl = on +ssl_cert_file = 'server.crt' +ssl_key_file = 'server.key' +ssl_ca_file = 'root.crt' +``` + +The `pg_hba.conf` file of the database server contains the following entry for connecting from EDB\*Plus on the remote host: + +```text +# TYPE DATABASE USER ADDRESS METHOD + +# "local" is for Unix domain socket connections only +local all all md5 +# IPv4 local connections: +hostssl edb all 192.168.2.24/32 cert clientcert=1 +``` + +On the remote host where EDB\*Plus is to be invoked, the Linux user account named `user` contains the certificate and keystore files in its `~/.postgresql` directory: + +```text +[user@localhost ~]$ whoami +user +[user@localhost ~]$ cd .postgresql +[user@localhost .postgresql]$ pwd +/home/user/.postgresql +[user@localhost .postgresql]$ ls -l +total 8 +-rw-rw-r-- 1 user user 758 Aug 24 12:37 postgresql.keystore +-rw-rw-r-- 1 user user 2285 Aug 24 12:37 postgresql.p12 +``` + +Logged into Linux with the account named `user`, EDB\*Plus is successfully invoked with the `ssl=true` parameter: + +```text +$ export PGSSLCERTPASS=keypass +$ export PGSSLKEYPASS=exppass +$ cd /opt/edb/as13/edbplus +$ ./edbplus.sh enterprisedb/password@192.168.2.22:5444/edb?ssl=true +Connected to EnterpriseDB 13.0.1 (192.168.2.22:5444/edb) AS enterprisedb + +EDB*Plus: Release 13 (Build 39.0.2) +Copyright (c) 2008-2021, EnterpriseDB Corporation. All rights reserved. + +SQL> +``` + +Alternatively, without placing the certificate and keystore files in `~/.postgresql`, but in a different directory, EDB\*Plus can be invoked in the following manner: + +```text +$ export PGSSLCERT=/home/user/ssl/postgresql.keystore +$ export PGSSLKEY=/home/user/ssl/postgresql.p12 +$ export PGSSLCERTPASS=keypass +$ export PGSSLKEYPASS=exppass +$ cd /opt/edb/as13/edbplus +$ ./edbplus.sh enterprisedb/password@192.168.2.22:5444/edb?ssl=true +Connected to EnterpriseDB 13.0.1 (192.168.2.22:5444/edb) AS enterprisedb + +EDB*Plus: Release 13 (Build 39.0.2) +Copyright (c) 2008-2021, EnterpriseDB Corporation. All rights reserved. + +SQL> +``` + +Note that in both cases the database user name used to log into EDB\*Plus is `enterprisedb` as this is the user specified for the common name field when creating the certificate in Step 1 of [Configuring SSL on Advanced Server](#using_ssl_connection). + +Other database user names can be used if the `pg_hba.conf` file with the `map` option and the `pg_ident.conf` file are used as described in Steps 8 and 9 of [Configuring SSL on Advanced Server](#using_ssl_connection). diff --git a/product_docs/docs/edb_plus/39/edb_plus/06_command_summary.mdx b/product_docs/docs/edb_plus/39/edb_plus/06_command_summary.mdx new file mode 100644 index 00000000000..ad22ca71519 --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/06_command_summary.mdx @@ -0,0 +1,997 @@ +--- +title: "Command Summary" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/command_summary.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/command_summary.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/command_summary.html" +--- + + + +The following sections contains a summary of EDB\*Plus commands. + +## ACCEPT + +The `ACCEPT` command displays a prompt and waits for the user’s keyboard input. The value input by the user is placed in the specified variable. + +```text +ACC[EPT ] variable +``` + +The following example creates a new variable named `my_name`, accepts a value of John Smith, then displays the value using the `DEFINE` command. + +```text +SQL> ACCEPT my_name +Enter value for my_name: John Smith +SQL> DEFINE my_name +DEFINE MY_NAME = "John Smith" +``` + +## APPEND + +`APPEND` is a line editor command that appends the given text to the end of the current line in the SQL buffer. + +```text +A[PPEND ] text +``` + +In the following example, a `SELECT` command is built-in the SQL buffer using the `APPEND` command. Note that two spaces are placed between the `APPEND` command and the `WHERE` clause in order to separate `dept` and `WHERE` by one space in the SQL buffer. + +```text +SQL> APPEND SELECT * FROM dept +SQL> LIST + 1 SELECT * FROM dept +SQL> APPEND WHERE deptno = 10 +SQL> LIST + 1 SELECT * FROM dept WHERE deptno = 10 +``` + +## CHANGE + +`CHANGE` is a line editor command performs a search-and-replace on the current line in the SQL buffer. + +```text +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. + +The following sequence of commands makes line 3 the current line, then changes the department number in the `WHERE` clause from 20 to 30. + +```text +SQL> LIST + 1 SELECT empno, ename, job, sal, comm + 2 FROM emp + 3 WHERE deptno = 20 + 4* ORDER BY empno +SQL> 3 + 3* WHERE deptno = 20 +SQL> CHANGE /20/30/ + 3* WHERE deptno = 30 +SQL> LIST + 1 SELECT empno, ename, job, sal, comm + 2 FROM emp + 3 WHERE deptno = 30 + 4* ORDER BY empno +``` + +## CLEAR + +The `CLEAR` command removes the contents of the SQL buffer, deletes all column definitions set with the `COLUMN` command, or clears the screen. + +```text +CL[EAR ] [ BUFF[ER ] | SQL | COL[UMNS ] | SCR[EEN ] ] +``` + +`BUFFER | SQL` + + Clears the SQL buffer. + +`COLUMNS` + + Removes column definitions. + +`SCREEN` + + Clears the screen. This is the default if no options are specified. + +## COLUMN + +The `COLUMN` command controls output formatting. The formatting attributes set by using the `COLUMN` command remain in effect only for the duration of the current session. + +```text +COL[UMN ] + [ column + { CLE[AR ] | + { FOR[MAT ] spec | + HEA[DING ] text | + { OFF | ON } + } [...] + } + ] +``` + +If the `COLUMN` command is specified with no subsequent 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 may be followed by one of the following: + +1. No other options +2. `CLEAR` +3. Any combination of `FORMAT`, `HEADING`, and one of `OFF` or `ON` + +`column` + + Name of a column in a table to which subsequent column formatting options are to apply. If no other options follow `column`, then the current column formatting options if any, of `column` are displayed. + +`CLEAR` + + The `CLEAR` option reverts all formatting options back to their defaults for `column`. If the `CLEAR` option is specified, it must be the only option specified. + +`spec` + + Format specification to be applied to `column`. For character columns, `spec` takes the following format: + +`n` + + `n` is a positive integer that specifies the column width in characters within which to display the data. Data in excess of `n` will wrap around with the specified column width. + + For numeric columns, `spec` is comprised of the following elements. + +| Element | Description | +| ------- | ------------------------------------------ | +| `$` | Display a leading dollar sign. | +| `,` | Display a comma in the indicated position. | +| `.` | Marks the location of the decimal point. | +| `0` | Display leading zeros. | +| `9` | Number of significant digits to display. | + + If loss of significant digits occurs due to overflow of the format, then all #’s are displayed. + +`text` + + Text to be used for the column heading of `column`. + +`OFF | ON` + + If `OFF` is specified, formatting options are reverted back to their defaults, but are still available within the session. If `ON` is specified, the formatting options specified by previous `COLUMN` commands for `column` within the session are re-activated. + +The following example shows the effect of changing the display width of the `job` column. + +```text +SQL> SET PAGESIZE 9999 +SQL> COLUMN job FORMAT A5 +SQL> COLUMN job +COLUMN JOB ON +FORMAT A5 +wrapped +SQL> SELECT empno, ename, job FROM emp; + +EMPNO ENAME JOB +----- ---------- ----- + 7369 SMITH CLERK + 7499 ALLEN SALES + MAN + + 7521 WARD SALES + MAN + + 7566 JONES MANAG + ER + + 7654 MARTIN SALES + MAN + + 7698 BLAKE MANAG + ER + + 7782 CLARK MANAG + ER + + 7788 SCOTT ANALY + ST + + 7839 KING PRESI + DENT + + 7844 TURNER SALES + MAN + + 7876 ADAMS CLERK + 7900 JAMES CLERK + 7902 FORD ANALY + ST + + 7934 MILLER CLERK + +14 rows retrieved. +``` + +The following example applies a format to the `sal` column. + +```text +SQL> COLUMN sal FORMAT $99,999.00 +SQL> COLUMN +COLUMN JOB ON +FORMAT A5 +wrapped + +COLUMN SAL ON +FORMAT $99,999.00 +wrapped +SQL> SELECT empno, ename, job, sal FROM emp; + +EMPNO ENAME JOB SAL +----- ---------- ----- ----------- + 7369 SMITH CLERK $800.00 + 7499 ALLEN SALES $1,600.00 + MAN + + 7521 WARD SALES $1,250.00 + MAN + + 7566 JONES MANAG $2,975.00 + ER + + 7654 MARTIN SALES $1,250.00 + MAN + + 7698 BLAKE MANAG $2,850.00 + ER + + 7782 CLARK MANAG $2,450.00 + ER + + 7788 SCOTT ANALY $3,000.00 + ST + + 7839 KING PRESI $5,000.00 + DENT + + 7844 TURNER SALES $1,500.00 + MAN + + 7876 ADAMS CLERK $1,100.00 + 7900 JAMES CLERK $950.00 + 7902 FORD ANALY $3,000.00 + ST + + 7934 MILLER CLERK $1,300.00 + +14 rows retrieved. +``` + +## CONNECT + +Change the database connection to a different user and/or connect to a different database. There must be no white space between any of the parameters following the `CONNECT` command. + +```text +CON[NECT] [/][@{ | } ] +``` + +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 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 +``` + + If a password file cannot be located, or it does not have an entry matching the EDB\*Plus connection parameters, then EDB\*Plus will prompt for the password. For more information about password files, see the PostgreSQL core documentation at: + + + + **Note**: When a password is not required, EDB\*Plus does not 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 at + + `connectstring` is the database connection string. See [Using EDB\*Plus](04_using_edb_plus/#using_edb_plus) for further information on 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 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`. + +```text +SQL> CONNECT smith/mypassword@localhost:5445/edb +Disconnected from EnterpriseDB Database. +Connected to EnterpriseDB 13.0.1 (localhost:5445/edb) AS smith +``` + +From within the session shown above, the connection is changed to username `enterprisedb`. Also note that the host defaults to the localhost, the port defaults to `5444` (which is not the same as the port previously used), and the database defaults to `edb`. + +```text +SQL> CONNECT enterprisedb/password +Disconnected from EnterpriseDB Database. +Connected to EnterpriseDB 13.0.1 (localhost:5444/edb) AS enterprisedb +``` + +## DEFINE + +The `DEFINE` command creates or replaces the value of a *user variable* (also called a *substitution variable*). + +```text +DEF[INE ] [ variable [ = text ] ] +``` + +If the `DEFINE` command is given 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` may be optionally enclosed within single or double quotation marks. Quotation marks must be used if `text` contains space characters. + +The following example defines two variables, `dept` and `name`. + +```text +SQL> DEFINE dept = 20 +SQL> DEFINE name = 'John Smith' +SQL> DEFINE +DEFINE EDB = "localhost:5445/edb" +DEFINE DEPT = "20" +DEFINE NAME = "John Smith" +``` + +!!! Note + The variable `EDB` is read from the `login.sql` file located in the `edbplus` subdirectory of the Advanced Server home directory. + +## DEL + +`DEL` is a line editor command that deletes one or more lines from the SQL buffer. + +```text +DEL [ n | n m | n * | n L[AST ] | * | * n | * L[AST ] | L[AST ] ] +``` + +The parameters specify which lines are to be deleted from the SQL buffer. Two parameters specify the start and end of a range of lines to be deleted. If the `DEL` command is given with no parameters, the current line is deleted. + +`n` + + n is an integer representing the `n`th line + +`n m` + + `n` and `m` are integers where `m` is greater than `n` representing the `n`th through the `m`th lines + +`*` + + Current line + +`LAST` + + 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. + +```text +SQL> LIST + 1 SELECT + 2 empno + 3 ,ename + 4 ,job + 5 ,sal + 6 ,comm + 7 ,deptno + 8* FROM emp +SQL> DEL 5 6 +SQL> LIST + 1 SELECT + 2 empno + 3 ,ename + 4 ,job + 5 ,deptno + 6* FROM emp +``` + +## DESCRIBE + +The `DESCRIBE` command displays: + +- A list of columns, column data types, and column lengths for a table or view +- A list of parameters for a procedure or function +- A list of procedures and functions and their respective parameters for a package + +The `DESCRIBE` command will also display the structure of the database object referred to by a synonym. The syntax is: + +```text +DESC[RIBE] [ schema.]object +``` + +`schema` + + Name of the schema containing the object to be described. + +`object` + + Name of the table, view, procedure, function, or package to be displayed, or the synonym of an object. + +## DISCONNECT + +The `DISCONNECT` command closes the current database connection, but does not terminate EDB\*Plus. + +```text +DISC[ONNECT ] +``` + +## EDIT + +The `EDIT` command invokes an external editor to edit the contents of an operating system file or the SQL buffer. + +```text +ED[IT ] [ filename[.ext ] ] +``` + +`filename[.ext ]` + + `filename` is the name of the file to open with an external editor. `ext` is the filename extension. If the filename extension is `sql`, then the `.sql` extension may be omitted when specifying `filename`. `EDIT` always assumes a `.sql` extension on filenames 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. + +## EXECUTE + +The `EXECUTE` command executes an SPL procedure from EDB\*Plus. + +```text +EXEC[UTE ] spl_procedure [ ([ parameters ]) ] +``` + +`spl_procedure` + + The name of the SPL procedure to be executed. + +`parameters` + + Comma-delimited list of parameters. If there are no parameters, then a pair of empty parentheses may optionally be specified. + +## EXIT + +The `EXIT` command terminates the EDB\*Plus session and returns control to the operating system. `QUIT` is a synonym for `EXIT`. Specifying no parameters is equivalent to `EXIT SUCCESS COMMIT`. + +```text +{ EXIT | QUIT } +[ SUCCESS | FAILURE | WARNING | value | variable ] +[ 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`. + +`value` + + An integer value that is returned as the return code. + +`variable` + + A variable created with the `DEFINE` command whose value is returned as the return code. + +`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`. + +## GET + +The `GET` command loads the contents of the given file to the SQL buffer. + +```text +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 filename extension. If the filename extension is `sql`, then the `.sql` extension may be omitted when specifying `filename`. `GET` always 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`. + +## HELP + +The `HELP` command obtains an index of topics or help on a specific topic. The question mark `(?)` is synonymous with specifying `HELP`. + +```text +{ HELP | ? } { INDEX | topic } +``` + +`INDEX` + + Displays an index of available topics. + +`topic` + + The name of a specific topic – e.g., an EDB\*Plus command, for which help is desired. + +## HOST + +The `HOST` command executes an operating system command from EDB\*Plus. + +```text +HO[ST ] [os_command] +``` + +`os_command` + + The operating system command to be executed. If you do not provide an operating system command, EDB\*Plus pauses execution and opens a new shell prompt. When the shell exits, EDB\*Plus resumes execution. + +## INPUT + +The `INPUT` line editor command adds a line of text to the SQL buffer after the current line. + +```text +I[NPUT ] text +``` + +The following sequence of `INPUT` commands constructs a `SELECT` command. + +```text +SQL> INPUT SELECT empno, ename, job, sal, comm +SQL> INPUT FROM emp +SQL> INPUT WHERE deptno = 20 +SQL> INPUT ORDER BY empno +SQL> LIST + 1 SELECT empno, ename, job, sal, comm + 2 FROM emp + 3 WHERE deptno = 20 + 4* ORDER BY empno +``` + +## LIST + +`LIST` is a line editor command that displays the contents of the SQL buffer. + +```text +L[IST] [ n | n m | n * | n L[AST] | * | * n | * L[AST] | L[AST] ] +``` + +The buffer does not include a history of the EDB\*Plus commands. + +`n` + + `n` represents the buffer line number. + +`n m` + + `n m` displays a list of lines between `n` and `m`. + +`n *` + + `n *` displays a list of lines that range between line `n` and the current line. + +`n L[AST]` + + `n L[AST]` displays a list of lines that range from line `n` through the last line in the buffer. + +`*` + + `*` displays the current line. + +`* n` + + `* n` displays a list of lines that range from the current line through line `n`. + +`* L[AST]` + + `* L[AST]` displays a list of lines that range from the current line through the last line. + +`L[AST]` + + `L[AST]` displays the last line. + +## PASSWORD + +Use the `PASSWORD` command to change your database password. + +```text +PASSW[ORD] [user_name] +``` + +You must have sufficient privileges to use the `PASSWORD` command to change another user's password. The following example demonstrates using the `PASSWORD` command to change the password for a user named `acctg`: + +```text +SQL> PASSWORD acctg +Changing password for acctg + New password: + New password again: +Password successfully changed. +``` + +## PAUSE + +The `PAUSE` command displays a message, and waits for the user to press `ENTER`. + +```text +PAU[SE] [optional_text] +``` + +`optional_text` specifies the text that will be displayed to the user. If the `optional_text` is omitted, Advanced Server will display two blank lines. If you double quote the `optional_text` string, the quotes will be included in the output. + +## PROMPT + +The `PROMPT` command displays a message to the user before continuing. + +```text +PRO[MPT] [message_text] +``` + +`message_text` specifies the text displayed to the user. Double quote the string to include quotes in the output. + +## QUIT + +The `QUIT` command terminates the session and returns control to the operating system. `QUIT` is a synonym for `EXIT`. + +```text +QUIT + +[SUCCESS | FAILURE | WARNING | value | sub_variable] + +[COMMIT | ROLLBACK] +``` + +The default value is `QUIT SUCCESS COMMIT`. + +## REMARK + +Use `REMARK` to include comments in a script. + +```text +REM[ARK] [optional_text] +``` + +You may also use the following convention to include a comment: + +```text +/* + * This is an example of a three line comment. + */ +``` + +## SAVE + +Use the `SAVE` command to write the SQL Buffer to an operating system file. + +```text +SAV[E] file_name +[CRE[ATE] | REP[LACE] | APP[END]] +``` + +`file_name` + + `file_name` specifies the name of the file (including the path) where the buffer contents are written. If you do not provide a file extension, `.sql` is appended to the end of the file name. + +`CREATE` + + Include the `CREATE` keyword to create a new file. A new file is created *only* if a file with the specified name does not already exist. This is the default. + +`REPLACE` + + Include the `REPLACE` keyword to specify that Advanced Server should overwrite an existing file. + +`APPEND` + + Include the `APPEND` keyword to specify that Advanced Server should 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: + +```text +SQL> SAVE C:\example.sql CREATE +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: + +**SET AUTOCOMMIT** + +Use the `SET AUTOCOMMIT` command to specify commit behavior for Advanced Server transactions. + +```text +SET AUTO[COMMIT] + +{ON | OFF | IMMEDIATE | statement_count} +``` + +Please note that EDB\*Plus always automatically commits DDL statements. + +`ON` + + Specify `ON` to turn `AUTOCOMMIT` behavior on. + +`OFF` + + Specify `OFF` to turn `AUTOCOMMIT` behavior off. + +`IMMEDIATE` + + `IMMEDIATE` has the same effect as `ON`. + +`statement_count` + + Include a value for `statement_count` to instruct EDB\*Plus to issue a commit after the specified count of successful SQL statements. + +**SET COLUMN SEPARATOR** + +Use the `SET COLUMN SEPARATOR` command to specify the text that Advanced Server displays between columns. + +```text +SET COLSEP column_separator +``` + +The default value of `column_separator` is a single space. + +**SET ECHO** + +Use the `SET ECHO` command to specify if SQL and EDB\*Plus script statements should be displayed onscreen as they are executed. + +```text +SET ECHO {ON | OFF} +``` + +The default value is `OFF`. + +**SET FEEDBACK** + +The `SET FEEDBACK` command controls the display of interactive information after a SQL statement executes. + +```text +SET FEED[BACK] {ON | OFF | row_threshold} +``` + +`row_threshold` + + Specify an integer value for `row_threshold`. Setting `row_threshold` to `0` is same as setting `FEEDBACK` to `OFF`. Setting `row_threshold` equal `1` effectively sets `FEEDBACK` to `ON`. + +**SET FLUSH** + +Use the `SET FLUSH` command to control display buffering. + +```text +SET FLU[SH] {ON | OFF} +``` + +Set `FLUSH` to `OFF` to enable display buffering. If you enable buffering, messages bound for the screen may not appear until the script completes. Please note that setting `FLUSH` to `OFF` will offer better performance. + +Set `FLUSH` to `ON` to disable display buffering. If you disable buffering, messages bound for the screen appear immediately. + +**SET HEADING** + +Use the `SET HEADING` variable to specify if Advanced Server should display column headings for `SELECT` statements. + +```text +SET HEA[DING] {ON | OFF} +``` + +**SET HEAD SEPARATOR** + +The `SET HEADSEP` command sets the new heading separator character used by the `COLUMN HEADING` command. The default is `'|'`. + +```text +SET HEADS[EP] +``` + +**SET LINESIZE** + +Use the `SET LINESIZE` command to specify the width of a line in characters. + +```text +SET LIN[ESIZE] width_of_line +``` + +`width_of_line` + + The default value of `width_of_line` is `132`. + +**SET NEWPAGE** + +Use the `SET NEWPAGE` command to specify how many blank lines are printed after a page break. + +```text +SET NEWP[AGE] lines_per_page +``` + +`lines_per_page` + + The default value of `lines_per_page` is `1`. + +**SET NULL** + +Use the `SET NULL` command to specify a string that is displayed to the user when a `NULL` column value is displayed in the output buffer. + +```text +SET NULL null_string +``` + +**SET PAGESIZE** + +Use the `SET PAGESIZE` command to specify the number of printed lines that fit on a page. + +```text +SET PAGES[IZE] line_count +``` + +Use the `line_count` parameter to specify the number of lines per page. + +**SET SQLCASE** + +The `SET SQLCASE` command specifies if SQL statements transmitted to the server should be converted to upper or lower case. + +```text +SET SQLC[ASE] {MIX[ED] | UP[PER] | LO[WER]} +``` + +`UPPER` + + Specify `UPPER` to convert the command text to uppercase. + +`LOWER` + + Specify `LOWER` to convert the command text to lowercase. + +`MIXED` + + Specify `MIXED` to leave the case of SQL commands unchanged. The default is `MIXED`. + +**SET PAUSE** + +The `SET PAUSE` command is most useful when included in a script; the command displays a prompt and waits for the user to press `Return`. + +```text +SET PAU[SE] {ON | OFF} +``` + +If `SET PAUSE` is `ON`, the message `Hit ENTER to continue…` will be displayed before each command is executed. + +**SET SPACE** + +Use the `SET SPACE` command to specify the number of spaces to display between columns: + +```text +SET SPACE number_of_spaces +``` + +**SET SQLPROMPT** + +Use `SET SQLPROMPT` to set a value for a user-interactive prompt: + +```text +SET SQLP[ROMPT] "prompt" +``` + +By default, `SQLPROMPT` is set to `"SQL> "` + +**SET TERMOUT** + +Use the `SET TERMOUT` command to specify if command output should be displayed onscreen. + +```text +SET TERM[OUT] {ON | OFF} +``` + +**SET TIMING** + +The `SET TIMING` command specifies if Advanced Server should display the execution time for each SQL statement after it is executed. + +```text +SET TIMI[NG] {ON | OFF} +``` + +**SET TRIMSPOOL** + +Use the `SET TRIMSPOOL` command to remove trailing spaces from each line in the output file specified by the `SPOOL` command. + +```text +SET TRIMS[POOL] {ON | OFF} +``` + +The default value is `OFF`. + +**SET VERIFY** + +Specifies if both the old and new values of a SQL statement are displayed when a substitution variable is encountered. + +```text +SET VER[IFY] { ON | OFF } +``` + +## SHOW + +Use the `SHOW` command to display current parameter values. + +```text +SHO[W] {ALL | parameter_name} +``` + +Display the current parameter settings by including the `ALL` keyword: + +```Text +SQL> SHOW ALL +autocommit OFF +colsep " " +define "&" +echo OFF +FEEDBACK ON for 6 row(s). +flush ON +heading ON +headsep "|" +linesize 78 +newpage 1 +null " " +pagesize 14 +pause OFF +serveroutput OFF +spool OFF +sqlcase MIXED +sqlprompt "SQL> " +sqlterminator ";" +suffix ".sql" +termout ON +timing OFF +verify ON +USER is "enterprisedb" +HOST is "localhost" +PORT is "5444" +DATABASE is "edb" +VERSION is "13.0.0" +``` + +Or display a specific parameter setting by including the `parameter_name` in the `SHOW` command: + +```text +SQL> SHOW VERSION +VERSION is "13.0.0" +``` + +## SPOOL + +The `SPOOL` command sends output from the display to a file. + +```text +SP[OOL] output_file | OFF +``` + +Use the `output_file` parameter to specify a path name for the output file. + +## START + +Use the `START` command to run an EDB\*Plus script file; `START` is an alias for `@` command. + +```text +STA[RT] script_file +``` + +Specify the name of a script file in the `script_file` parameter. + +## UNDEFINE + +The `UNDEFINE` command erases a user variable created by the `DEFINE` command. + +```text +UNDEF[INE] variable_name [ variable_name...] +``` + +Use the `variable_name` parameter to specify the name of a variable or variables. + +## WHENEVER SQLERROR + +The `WHENEVER SQLERROR` command provides error handling for SQL errors or PL/SQL block errors. The syntax is: + +```text +WHENEVER SQLERROR + {CONTINUE[COMMIT|ROLLBACK|NONE] + |EXIT[SUCCESS|FAILURE|WARNING|n|sub_variable] + [COMMIT|ROLLBACK]} +``` + +If Advanced Server encounters an error during the execution of a SQL command or PL/SQL block, EDB\*Plus performs the action specified in the `WHENEVER SQLERROR` command: + + Include the `CONTINUE` clause to instruct EDB\*Plus to perform the specified action before continuing. + + Include the `COMMIT` clause to instruct EDB\*Plus to `COMMIT` the current transaction before exiting or continuing. + + Include the `ROLLBACK` clause to instruct EDB\*Plus to `ROLLBACK` the current transaction before exiting or continuing. + + Include the `NONE` clause to instruct EDB\*Plus to continue without committing or rolling back the transaction. + + Include the `EXIT` clause to instruct EDB\*Plus to perform the specified action and exit if it encounters an error. + + Use the following options to specify a status code that EDB\*Plus will return before exiting: + +```text +[SUCCESS|FAILURE|WARNING|n|sub_variable] +``` + + Please note that EDB\*Plus supports substitution variables, but does not support bind variables. diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/advanced_server_installation_details.png b/product_docs/docs/edb_plus/39/edb_plus/images/advanced_server_installation_details.png new file mode 100755 index 00000000000..4a64fc203b1 --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/images/advanced_server_installation_details.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:9dcb64989a3a2b6e1c683721818a3230d89596b566f3d9acef2246e62ec1477f +size 14772 diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.png b/product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.png new file mode 100644 index 00000000000..f4a93cf57f5 --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07423b012a855204780fe5a2a5a1e33607304a5c3020ae4acbf3d575691dedd6 +size 12136 diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.svg b/product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.svg new file mode 100644 index 00000000000..f24d1dfefee --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.svg @@ -0,0 +1,19 @@ + + + edb-logo-disc-dark + + + + \ No newline at end of file diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/edb_plus_welcome.png b/product_docs/docs/edb_plus/39/edb_plus/images/edb_plus_welcome.png new file mode 100755 index 00000000000..c526c78eabf --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/images/edb_plus_welcome.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f557131b686992e3d8a9f7d0f40ddd14dcdde8a6ee7fb90af3ef57860194024 +size 56911 diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/installation_complete.png b/product_docs/docs/edb_plus/39/edb_plus/images/installation_complete.png new file mode 100755 index 00000000000..f0803ad2adc --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/images/installation_complete.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:685f7fe611646fde1106178bd3d82e48d2dc121a40df73fadb35dbae097448e9 +size 58951 diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/installation_directory.png b/product_docs/docs/edb_plus/39/edb_plus/images/installation_directory.png new file mode 100755 index 00000000000..e9e71920170 --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/images/installation_directory.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:b39c529e783b4a42453d2dd8ff0729549ca0d9cd61047a6dedaa4cb04ba56f05 +size 15499 diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/ready_to_install.png b/product_docs/docs/edb_plus/39/edb_plus/images/ready_to_install.png new file mode 100755 index 00000000000..4e7bba3e25f --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/images/ready_to_install.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7b1d62f081cde3660fc0f1a132e84d108ae7f16c96f535a18bd0cf26555f2310 +size 12733 diff --git a/product_docs/docs/edb_plus/39/edb_plus/index.mdx b/product_docs/docs/edb_plus/39/edb_plus/index.mdx new file mode 100644 index 00000000000..be93a14b2a8 --- /dev/null +++ b/product_docs/docs/edb_plus/39/edb_plus/index.mdx @@ -0,0 +1,44 @@ +--- +navTitle: EDB*Plus — CLI +title: "EDB*Plus User's Guide" +legacyRedirects: + - "/edb-docs/p/edbplus/39" + - "/edb-docs/p/edbplus/38" + - "/edb-docs/p/edbplus/36" + +directoryDefaults: + description: "EDB*Plus Documentation and release notes." +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/index.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/conclusion.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/genindex.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/introduction.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/conclusion.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/introduction.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/genindex.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/index.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/index.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/whats_new.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/genindex.html" + - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/conclusion.html" +--- + +This guide describes how to connect to an Advanced Server database using EDB\*Plus. EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server that accepts SQL commands that allow you to: + +- Query certain database objects +- Execute stored procedures +- Format output from SQL commands +- Execute batch scripts +- Execute OS commands +- Record output + +For detailed information about the features supported by Advanced Server, consult the complete library of Advanced Server guides available at: + +[https://www.enterprisedb.com/docs](/epas/latest/) + +
+ +introduction edb_plus installing_edb_plus using_edb_plus using_edb_plus_with_ssl command_summary conclusion + +
From 31348b3818cac047e071b2654d810aca3e3a6b71 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Mon, 14 Feb 2022 11:14:59 -0500 Subject: [PATCH 06/29] Moved files from epas to edbplus Moved files from epas version 38, 37, and 36 --- .../36}/03_installing_edb_plus/01_installing_prereq.mdx | 0 .../36}/03_installing_edb_plus/02_rpm_installation.mdx | 0 .../36}/03_installing_edb_plus/03_using_gui.mdx | 0 .../10/edb_plus => edb_plus/36}/03_installing_edb_plus/index.mdx | 0 .../docs/{epas/11/edb_plus => edb_plus/37}/02_edb_plus.mdx | 0 .../37}/03_installing_edb_plus/01_installing_prereq.mdx | 0 .../37}/03_installing_edb_plus/02_rpm_installation.mdx | 0 .../37}/03_installing_edb_plus/03_using_gui.mdx | 0 .../11/edb_plus => edb_plus/37}/03_installing_edb_plus/index.mdx | 0 .../docs/{epas/11/edb_plus => edb_plus/37}/04_using_edb_plus.mdx | 0 .../11/edb_plus => edb_plus/37}/05_using_edb_plus_with_ssl.mdx | 0 .../docs/{epas/11/edb_plus => edb_plus/37}/06_command_summary.mdx | 0 .../37}/images/advanced_server_installation_details.png | 0 .../docs/{epas/11/edb_plus => edb_plus/37}/images/edb_logo.png | 0 .../docs/{epas/11/edb_plus => edb_plus/37}/images/edb_logo.svg | 0 .../{epas/11/edb_plus => edb_plus/37}/images/edb_plus_welcome.png | 0 .../11/edb_plus => edb_plus/37}/images/edb_plus_welcome_1.png | 0 .../11/edb_plus => edb_plus/37}/images/installation_complete.png | 0 .../11/edb_plus => edb_plus/37}/images/installation_directory.png | 0 .../{epas/11/edb_plus => edb_plus/37}/images/ready_to_install.png | 0 product_docs/docs/{epas/11/edb_plus => edb_plus/37}/index.mdx | 0 .../38}/03_installing_edb_plus/01_installing_prereq.mdx | 0 .../38}/03_installing_edb_plus/02_rpm_installation.mdx | 0 .../38}/03_installing_edb_plus/03_using_gui.mdx | 0 .../12/edb_plus => edb_plus/38}/03_installing_edb_plus/index.mdx | 0 25 files changed, 0 insertions(+), 0 deletions(-) rename product_docs/docs/{epas/10/edb_plus => edb_plus/36}/03_installing_edb_plus/01_installing_prereq.mdx (100%) rename product_docs/docs/{epas/10/edb_plus => edb_plus/36}/03_installing_edb_plus/02_rpm_installation.mdx (100%) rename product_docs/docs/{epas/10/edb_plus => edb_plus/36}/03_installing_edb_plus/03_using_gui.mdx (100%) rename product_docs/docs/{epas/10/edb_plus => edb_plus/36}/03_installing_edb_plus/index.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/02_edb_plus.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/03_installing_edb_plus/01_installing_prereq.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/03_installing_edb_plus/02_rpm_installation.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/03_installing_edb_plus/03_using_gui.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/03_installing_edb_plus/index.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/04_using_edb_plus.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/05_using_edb_plus_with_ssl.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/06_command_summary.mdx (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/images/advanced_server_installation_details.png (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/images/edb_logo.png (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/images/edb_logo.svg (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/images/edb_plus_welcome.png (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/images/edb_plus_welcome_1.png (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/images/installation_complete.png (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/images/installation_directory.png (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/images/ready_to_install.png (100%) rename product_docs/docs/{epas/11/edb_plus => edb_plus/37}/index.mdx (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/03_installing_edb_plus/01_installing_prereq.mdx (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/03_installing_edb_plus/02_rpm_installation.mdx (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/03_installing_edb_plus/03_using_gui.mdx (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/03_installing_edb_plus/index.mdx (100%) diff --git a/product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/01_installing_prereq.mdx b/product_docs/docs/edb_plus/36/03_installing_edb_plus/01_installing_prereq.mdx similarity index 100% rename from product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/01_installing_prereq.mdx rename to product_docs/docs/edb_plus/36/03_installing_edb_plus/01_installing_prereq.mdx diff --git a/product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/02_rpm_installation.mdx b/product_docs/docs/edb_plus/36/03_installing_edb_plus/02_rpm_installation.mdx similarity index 100% rename from product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/02_rpm_installation.mdx rename to product_docs/docs/edb_plus/36/03_installing_edb_plus/02_rpm_installation.mdx diff --git a/product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/03_using_gui.mdx b/product_docs/docs/edb_plus/36/03_installing_edb_plus/03_using_gui.mdx similarity index 100% rename from product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/03_using_gui.mdx rename to product_docs/docs/edb_plus/36/03_installing_edb_plus/03_using_gui.mdx diff --git a/product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/index.mdx b/product_docs/docs/edb_plus/36/03_installing_edb_plus/index.mdx similarity index 100% rename from product_docs/docs/epas/10/edb_plus/03_installing_edb_plus/index.mdx rename to product_docs/docs/edb_plus/36/03_installing_edb_plus/index.mdx diff --git a/product_docs/docs/epas/11/edb_plus/02_edb_plus.mdx b/product_docs/docs/edb_plus/37/02_edb_plus.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/02_edb_plus.mdx rename to product_docs/docs/edb_plus/37/02_edb_plus.mdx diff --git a/product_docs/docs/epas/11/edb_plus/03_installing_edb_plus/01_installing_prereq.mdx b/product_docs/docs/edb_plus/37/03_installing_edb_plus/01_installing_prereq.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/03_installing_edb_plus/01_installing_prereq.mdx rename to product_docs/docs/edb_plus/37/03_installing_edb_plus/01_installing_prereq.mdx diff --git a/product_docs/docs/epas/11/edb_plus/03_installing_edb_plus/02_rpm_installation.mdx b/product_docs/docs/edb_plus/37/03_installing_edb_plus/02_rpm_installation.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/03_installing_edb_plus/02_rpm_installation.mdx rename to product_docs/docs/edb_plus/37/03_installing_edb_plus/02_rpm_installation.mdx diff --git a/product_docs/docs/epas/11/edb_plus/03_installing_edb_plus/03_using_gui.mdx b/product_docs/docs/edb_plus/37/03_installing_edb_plus/03_using_gui.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/03_installing_edb_plus/03_using_gui.mdx rename to product_docs/docs/edb_plus/37/03_installing_edb_plus/03_using_gui.mdx diff --git a/product_docs/docs/epas/11/edb_plus/03_installing_edb_plus/index.mdx b/product_docs/docs/edb_plus/37/03_installing_edb_plus/index.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/03_installing_edb_plus/index.mdx rename to product_docs/docs/edb_plus/37/03_installing_edb_plus/index.mdx diff --git a/product_docs/docs/epas/11/edb_plus/04_using_edb_plus.mdx b/product_docs/docs/edb_plus/37/04_using_edb_plus.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/04_using_edb_plus.mdx rename to product_docs/docs/edb_plus/37/04_using_edb_plus.mdx diff --git a/product_docs/docs/epas/11/edb_plus/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/37/05_using_edb_plus_with_ssl.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/05_using_edb_plus_with_ssl.mdx rename to product_docs/docs/edb_plus/37/05_using_edb_plus_with_ssl.mdx diff --git a/product_docs/docs/epas/11/edb_plus/06_command_summary.mdx b/product_docs/docs/edb_plus/37/06_command_summary.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/06_command_summary.mdx rename to product_docs/docs/edb_plus/37/06_command_summary.mdx diff --git a/product_docs/docs/epas/11/edb_plus/images/advanced_server_installation_details.png b/product_docs/docs/edb_plus/37/images/advanced_server_installation_details.png similarity index 100% rename from product_docs/docs/epas/11/edb_plus/images/advanced_server_installation_details.png rename to product_docs/docs/edb_plus/37/images/advanced_server_installation_details.png diff --git a/product_docs/docs/epas/11/edb_plus/images/edb_logo.png b/product_docs/docs/edb_plus/37/images/edb_logo.png similarity index 100% rename from product_docs/docs/epas/11/edb_plus/images/edb_logo.png rename to product_docs/docs/edb_plus/37/images/edb_logo.png diff --git a/product_docs/docs/epas/11/edb_plus/images/edb_logo.svg b/product_docs/docs/edb_plus/37/images/edb_logo.svg similarity index 100% rename from product_docs/docs/epas/11/edb_plus/images/edb_logo.svg rename to product_docs/docs/edb_plus/37/images/edb_logo.svg diff --git a/product_docs/docs/epas/11/edb_plus/images/edb_plus_welcome.png b/product_docs/docs/edb_plus/37/images/edb_plus_welcome.png similarity index 100% rename from product_docs/docs/epas/11/edb_plus/images/edb_plus_welcome.png rename to product_docs/docs/edb_plus/37/images/edb_plus_welcome.png diff --git a/product_docs/docs/epas/11/edb_plus/images/edb_plus_welcome_1.png b/product_docs/docs/edb_plus/37/images/edb_plus_welcome_1.png similarity index 100% rename from product_docs/docs/epas/11/edb_plus/images/edb_plus_welcome_1.png rename to product_docs/docs/edb_plus/37/images/edb_plus_welcome_1.png diff --git a/product_docs/docs/epas/11/edb_plus/images/installation_complete.png b/product_docs/docs/edb_plus/37/images/installation_complete.png similarity index 100% rename from product_docs/docs/epas/11/edb_plus/images/installation_complete.png rename to product_docs/docs/edb_plus/37/images/installation_complete.png diff --git a/product_docs/docs/epas/11/edb_plus/images/installation_directory.png b/product_docs/docs/edb_plus/37/images/installation_directory.png similarity index 100% rename from product_docs/docs/epas/11/edb_plus/images/installation_directory.png rename to product_docs/docs/edb_plus/37/images/installation_directory.png diff --git a/product_docs/docs/epas/11/edb_plus/images/ready_to_install.png b/product_docs/docs/edb_plus/37/images/ready_to_install.png similarity index 100% rename from product_docs/docs/epas/11/edb_plus/images/ready_to_install.png rename to product_docs/docs/edb_plus/37/images/ready_to_install.png diff --git a/product_docs/docs/epas/11/edb_plus/index.mdx b/product_docs/docs/edb_plus/37/index.mdx similarity index 100% rename from product_docs/docs/epas/11/edb_plus/index.mdx rename to product_docs/docs/edb_plus/37/index.mdx diff --git a/product_docs/docs/epas/12/edb_plus/03_installing_edb_plus/01_installing_prereq.mdx b/product_docs/docs/edb_plus/38/03_installing_edb_plus/01_installing_prereq.mdx similarity index 100% rename from product_docs/docs/epas/12/edb_plus/03_installing_edb_plus/01_installing_prereq.mdx rename to product_docs/docs/edb_plus/38/03_installing_edb_plus/01_installing_prereq.mdx diff --git a/product_docs/docs/epas/12/edb_plus/03_installing_edb_plus/02_rpm_installation.mdx b/product_docs/docs/edb_plus/38/03_installing_edb_plus/02_rpm_installation.mdx similarity index 100% rename from product_docs/docs/epas/12/edb_plus/03_installing_edb_plus/02_rpm_installation.mdx rename to product_docs/docs/edb_plus/38/03_installing_edb_plus/02_rpm_installation.mdx diff --git a/product_docs/docs/epas/12/edb_plus/03_installing_edb_plus/03_using_gui.mdx b/product_docs/docs/edb_plus/38/03_installing_edb_plus/03_using_gui.mdx similarity index 100% rename from product_docs/docs/epas/12/edb_plus/03_installing_edb_plus/03_using_gui.mdx rename to product_docs/docs/edb_plus/38/03_installing_edb_plus/03_using_gui.mdx diff --git a/product_docs/docs/epas/12/edb_plus/03_installing_edb_plus/index.mdx b/product_docs/docs/edb_plus/38/03_installing_edb_plus/index.mdx similarity index 100% rename from product_docs/docs/epas/12/edb_plus/03_installing_edb_plus/index.mdx rename to product_docs/docs/edb_plus/38/03_installing_edb_plus/index.mdx From 3fee6646e65035b06e3d547d97479236c6e3c701 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Mon, 14 Feb 2022 11:30:48 -0500 Subject: [PATCH 07/29] Release note for edbplus v40 --- product_docs/docs/edb_plus/40/02_release_notes.mdx | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 product_docs/docs/edb_plus/40/02_release_notes.mdx diff --git a/product_docs/docs/edb_plus/40/02_release_notes.mdx b/product_docs/docs/edb_plus/40/02_release_notes.mdx new file mode 100644 index 00000000000..a7c4102885b --- /dev/null +++ b/product_docs/docs/edb_plus/40/02_release_notes.mdx @@ -0,0 +1,10 @@ +--- +navTitle: Release Notes +title: "EDB\*Plus Version 40 Release Notes" +--- + +New features, enhancements, bug fixes, and other changes in EDB*Plus 40 include: + +| Type | Description | +| ----------- | -------------------------------------------------------------- | +| Enhancement | Support for new version of EDB Postgres Advanced Server 14.1.0 | \ No newline at end of file From d225e65e42cdba5770f3724360d2f392eef94a83 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Mon, 14 Feb 2022 12:11:18 -0500 Subject: [PATCH 08/29] removed escape character --- product_docs/docs/edb_plus/40/02_release_notes.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edb_plus/40/02_release_notes.mdx b/product_docs/docs/edb_plus/40/02_release_notes.mdx index a7c4102885b..6269bbef162 100644 --- a/product_docs/docs/edb_plus/40/02_release_notes.mdx +++ b/product_docs/docs/edb_plus/40/02_release_notes.mdx @@ -1,6 +1,6 @@ --- navTitle: Release Notes -title: "EDB\*Plus Version 40 Release Notes" +title: "EDB*Plus Version 40 Release Notes" --- New features, enhancements, bug fixes, and other changes in EDB*Plus 40 include: From 5841ffd1f1567a0944be1698d407be6df2a6e253 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Mon, 14 Feb 2022 14:22:23 -0500 Subject: [PATCH 09/29] moved files around --- product_docs/docs/edb_plus/36/02_edb_plus.mdx | 28 + .../docs/edb_plus/36/04_using_edb_plus.mdx | 145 +++ .../36/05_using_edb_plus_with_ssl.mdx | 324 ++++++ .../docs/edb_plus/36/06_command_summary.mdx | 995 ++++++++++++++++++ .../advanced_server_installation_details.png | 3 + .../{39/edb_plus => 36}/images/edb_logo.png | 0 .../{39/edb_plus => 36}/images/edb_logo.svg | 0 .../images/edb_plus_welcome.png | 0 .../edb_plus/36/images/edb_plus_welcome_1.png | 3 + .../36/images/installation_complete.png | 3 + .../36/images/installation_directory.png | 3 + .../edb_plus/36/images/ready_to_install.png | 3 + product_docs/docs/edb_plus/36/index.mdx | 26 + .../01_installing_prereq.mdx | 0 .../02_rpm_installation.mdx | 0 .../03_using_gui.mdx | 0 .../38/{03_installing_edb_plus => }/index.mdx | 0 .../39/{edb_plus => }/02_edb_plus.mdx | 0 .../{edb_plus => }/03_installing_edb_plus.mdx | 0 .../39/{edb_plus => }/04_using_edb_plus.mdx | 0 .../05_using_edb_plus_with_ssl.mdx | 0 .../39/{edb_plus => }/06_command_summary.mdx | 0 .../advanced_server_installation_details.png | 0 .../docs/edb_plus/39/images/edb_logo.png | 3 + .../docs/edb_plus/39/images/edb_logo.svg | 19 + .../edb_plus/39/images/edb_plus_welcome.png | 3 + .../images/installation_complete.png | 0 .../images/installation_directory.png | 0 .../images/ready_to_install.png | 0 .../docs/edb_plus/39/{edb_plus => }/index.mdx | 0 30 files changed, 1558 insertions(+) create mode 100644 product_docs/docs/edb_plus/36/02_edb_plus.mdx create mode 100644 product_docs/docs/edb_plus/36/04_using_edb_plus.mdx create mode 100644 product_docs/docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx create mode 100644 product_docs/docs/edb_plus/36/06_command_summary.mdx create mode 100755 product_docs/docs/edb_plus/36/images/advanced_server_installation_details.png rename product_docs/docs/edb_plus/{39/edb_plus => 36}/images/edb_logo.png (100%) rename product_docs/docs/edb_plus/{39/edb_plus => 36}/images/edb_logo.svg (100%) rename product_docs/docs/edb_plus/{39/edb_plus => 36}/images/edb_plus_welcome.png (100%) create mode 100755 product_docs/docs/edb_plus/36/images/edb_plus_welcome_1.png create mode 100755 product_docs/docs/edb_plus/36/images/installation_complete.png create mode 100755 product_docs/docs/edb_plus/36/images/installation_directory.png create mode 100755 product_docs/docs/edb_plus/36/images/ready_to_install.png create mode 100644 product_docs/docs/edb_plus/36/index.mdx rename product_docs/docs/edb_plus/38/{03_installing_edb_plus => }/01_installing_prereq.mdx (100%) rename product_docs/docs/edb_plus/38/{03_installing_edb_plus => }/02_rpm_installation.mdx (100%) rename product_docs/docs/edb_plus/38/{03_installing_edb_plus => }/03_using_gui.mdx (100%) rename product_docs/docs/edb_plus/38/{03_installing_edb_plus => }/index.mdx (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/02_edb_plus.mdx (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/03_installing_edb_plus.mdx (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/04_using_edb_plus.mdx (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/05_using_edb_plus_with_ssl.mdx (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/06_command_summary.mdx (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/images/advanced_server_installation_details.png (100%) create mode 100644 product_docs/docs/edb_plus/39/images/edb_logo.png create mode 100644 product_docs/docs/edb_plus/39/images/edb_logo.svg create mode 100755 product_docs/docs/edb_plus/39/images/edb_plus_welcome.png rename product_docs/docs/edb_plus/39/{edb_plus => }/images/installation_complete.png (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/images/installation_directory.png (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/images/ready_to_install.png (100%) rename product_docs/docs/edb_plus/39/{edb_plus => }/index.mdx (100%) diff --git a/product_docs/docs/edb_plus/36/02_edb_plus.mdx b/product_docs/docs/edb_plus/36/02_edb_plus.mdx new file mode 100644 index 00000000000..21749c8393b --- /dev/null +++ b/product_docs/docs/edb_plus/36/02_edb_plus.mdx @@ -0,0 +1,28 @@ +--- +title: "EDB*Plus" +legacyRedirectsGenerated: + # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. + - "/edb-docs/d/edb-postgres-advanced-server/user-guides/database-compatibility-for-oracle-developers-guide/10/Database_Compatibility_for_Oracle_Developers_Guide_10.1.003.html" + - "/edb-docs/d/edb-postgres-advanced-server/reference/database-compatibility-for-oracle-developers-reference-guide/10/Database_Compatibility_for_Oracle_Developers_Reference_Guide.1.003.html" +--- + + + +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. + +EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: + +- Querying certain database objects +- Executing stored procedures +- Formatting output from SQL commands +- Executing batch scripts +- Executing OS commands +- Recording output + +### What's New + +The following features have been added to EDB*Plus version 36: + +- Advanced Server supports use of Internet Protocol version 6 (IPv6) to log into EDB\*Plus. For more information, see [Using EDB Plus](04_using_edb_plus/#using_edb_plus). +- Advanced Server supports use of a Secure Sockets Layer (SSL) connection from EDB\*Plus to the Advanced Server database. For more information, see [Using a Secure Sockets Layer (SSL) Connection](05_using_edb_plus_with_ssl/#using_edb_plus_with_ssl). + diff --git a/product_docs/docs/edb_plus/36/04_using_edb_plus.mdx b/product_docs/docs/edb_plus/36/04_using_edb_plus.mdx new file mode 100644 index 00000000000..e5f9377bb14 --- /dev/null +++ b/product_docs/docs/edb_plus/36/04_using_edb_plus.mdx @@ -0,0 +1,145 @@ +--- +title: "Using EDB*Plus" +--- + + + + + +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 ] ] [ | /NOLOG ] [ @[. ] ] +``` + +`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 +[/][@{ | } ] +``` + + 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 +[:][/][?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: + + + + 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 +``` diff --git a/product_docs/docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx new file mode 100644 index 00000000000..db2553a2332 --- /dev/null +++ b/product_docs/docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx @@ -0,0 +1,324 @@ +--- +title: "Using a Secure Sockets Layer (SSL) Connection" +--- + + + + + +An EDB\*Plus connection to the Advanced Server database can be accomplished using secure sockets layer (SSL) connectivity. + +Using SSL requires various prerequisite configuration steps performed on the database server involved with the SSL connection as well as creation of the Java truststore and keystore on the host that will run EDB\*Plus. + +The Java *truststore* is the file containing the Certificate Authority (CA) certificates with which the Java client (EDB\*Plus) uses to verify the authenticity of the server to which it is initiating an SSL connection. + +The Java *keystore* is the file containing private and public keys and their corresponding certificates. The keystore is required for client authentication to the server, which is used for the EDB\*Plus connection. + +The following is material to which you can refer to for guidance in setting up the SSL connections: + +- For information on setting up SSL connectivity to the Advanced Server database, see the section about secure TCP connections with SSL in Chapter 18 “Server Setup and Operation” in the PostgreSQL Core Documentation located at: + + + +- For information on JDBC client connectivity using SSL, see the section on configuring the client in Chapter 4 “Using SSL” in The PostgreSQL JDBC Interface located at: + + + +The following sections provide information for the configuration steps of using SSL. + +- Configuring SSL on Advanced Server +- Configuring SSL for the EDB\*Plus client +- Requesting SSL connection to the Advanced Server database + +## Configuring SSL on Advanced Server + +This section provides an example of configuring SSL on a database server to demonstrate the use of SSL with EDB\*Plus. A self-signed certificate is used for this purpose. + +**Step 1:** Create the certificate signing request (CSR). + +In the following example the generated certificate signing request file is `server.csr`. The private key is generated as file `server.key`. + +```text +$ openssl req -new -nodes -text -out server.csr \ +> -keyout server.key -subj "/CN=enterprisedb" +Generating a 2048 bit RSA private key +.............................+++ +....................................................................+++ +writing new private key to 'server.key' +----- +``` + +!!! Note + When creating the certificate, the value specified for the common name field (designated as `CN=enterprisedb` in this example) must be the database user name that is specified when connecting to EDB\*Plus. + +In addition, user name maps can be used as defined in the `pg_ident.conf` file to permit more flexibility for the common name and database user name. Steps 8 and 9 describe the use of user name `maps`. + +**Step 2:** Generate the self-signed certificate. + +The following generates a self-signed certificate to file `server.crt` using the certificate signing request file, `server.csr`, and the private key, `server.key`, as input. + +```text +$ openssl x509 -req -days 365 -in server.csr -signkey server.key \ +> -out server.crt +Signature ok +subject=/CN=enterprisedb +Getting Private key +``` + +**Step 3:** Make a copy of the server certificate (`server.crt`) to be used as the root Certificate Authority (CA) file (`root.crt`). + +```text +$ cp server.crt root.crt +``` + +**Step 4:** Delete the now redundant certificate signing request (`server.csr`). + +```text +$ rm -f server.csr +``` + +**Step 5:** Move or copy the certificate and private key files to the Advanced Server data directory (for example, `/opt/edb/as10/data`). + +```text +$ mv root.crt /opt/edb/as10/data +$ mv server.crt /opt/edb/as10/data +$ mv server.key /opt/edb/as10/data +``` + +**Step 6:** Set the file ownership and permissions on the certificate files and private key file. + +Set the ownership to the operating system account that owns the data sub-directory of the database server. Set the permissions so that no other groups or accounts other than the owner can access these files. + +```text +$ chown enterprisedb root.crt server.crt server.key +$ chgrp enterprisedb root.crt server.crt server.key +$ chmod 600 root.crt server.crt server.key +$ ls -l +total 152 + . + . + . +-rw------- 1 enterprisedb enterprisedb 985 Aug 22 11:00 root.crt +-rw------- 1 enterprisedb enterprisedb 985 Aug 22 10:59 server.crt +-rw------- 1 enterprisedb enterprisedb 1704 Aug 22 10:58 server.key +``` + +**Step 7:** In the `postgresql.conf` file, make the following modifications. + +```text +ssl = on +ssl_cert_file = 'server.crt' +ssl_key_file = 'server.key' +ssl_ca_file = 'root.crt' +``` + +**Step 8:** Modify the `pg_hba.conf` file to enable SSL usage on the desired database to which EDB\*Plus is to make the SSL connection. + +In the `pg_hba.conf` file, the `hostssl` type indicates the entry is used to validate SSL connection attempts from the client (EDB\*Plus). + +The authentication method is set to cert with the option `clientcert=1` in order to require an SSL certificate from the client against which authentication is performed using the common name of the certificate (`enterprisedb` in this example). + +The `map=sslusers` option specifies that a mapping named `sslusers` defined in the `pg_ident.conf` file is to be used for authentication. This mapping allows a connection to the database if the common name from the certificate and the database user name attempting the connection match the `SYSTEM-USERNAME/PG-USERNAME` pair listed in the `pg_ident.conf` file. + +The following is an example of the settings in the `pg_hba.conf` file if the database `(edb)` must use SSL connections. + +```text +# TYPE DATABASE USER ADDRESS METHOD + +# "local" is for Unix domain socket connections only +local all all md5 +# IPv4 local connections: +hostssl edb all 192.168.2.0/24 cert clientcert=1 map=sslusers +``` + +**Step 9:** The following shows the user name maps in the `pg_ident.conf` file related to the `pg_hba.conf` file by the `map=sslusers` option. These user name maps permit you to specify database user names `edbuser`, `postgres`, or `enterprisedb` when connecting with EDB\*Plus. + +```text +# MAPNAME SYSTEM-USERNAME PG-USERNAME + sslusers enterprisedb edbuser + sslusers enterprisedb postgres + sslusers enterprisedb enterprisedb +``` + +**Step 10:** Restart the database server after you have made the changes to the configuration files. + +## Configuring SSL for the EDB\*Plus Client + +After you have configured SSL on the database server, the following steps provide an example of generating certificate and keystore files for EDB\*Plus (the JDBC client). + +**Step 1:** Using files `server.crt` and `server.key` located under the database server data sub-directory, create copies of these files and move them to the host where EDB\*Plus is to be running. + +Store these files in the desired directory to contain the trusted certificate and keystore files to be generated in the following steps. The suggested location is to create a `.postgresql` sub-directory under the home user account that will invoke EDB\*Plus. Thus, these files will be under the `~/.postgresql` directory of the user account that will run EDB\*Plus. + +For this example, assume file `edb.crt` is a copy of `server.crt` and `edb.key` is a copy of `server.key`. + +**Step 2:** Create an additional copy of `edb.crt`. + +```text +$ cp edb.crt edb_root.crt +$ ls -l +total 12 +-rw-r--r-- 1 user user 985 Aug 22 14:17 edb.crt +-rw-r--r-- 1 user user 1704 Aug 22 14:18 edb.key +-rw-r--r-- 1 user user 985 Aug 22 14:19 edb_root.crt +``` + +**Step 3:** Create a Distinguished Encoding Rules (DER) format of file `edb_root.crt`. The generated DER format of this file is `edb_root.crt.der`. The DER format of the file is required for the `keytool` program used in Step 4. + +```text +$ openssl x509 -in edb_root.crt -out edb_root.crt.der -outform der +$ ls -l +total 16 +-rw-r--r-- 1 user user 985 Aug 22 14:17 edb.crt +-rw-r--r-- 1 user user 1704 Aug 22 14:18 edb.key +-rw-r--r-- 1 user user 985 Aug 22 14:19 edb_root.crt +-rw-rw-r-- 1 user user 686 Aug 22 14:21 edb_root.crt.der +``` + +**Step 4:** Use the `keytool` program to create a keystore file `(postgresql.keystore)` using `edb_root.crt.der` as the input. This process adds the certificate of the Postgres database server to the keystore file. + +!!! Note + The file name `postgresql.keystore` is recommended so that it can be accessed in its default directory location `~/.postgresql/postgresql.keystore`, which is under the home directory of the user account invoking EDB\*Plus. Also note that the file name suffix can be `.jks` instead of `.keystore` (thus, file name `postgresql.jks`). However, in the remainder of these examples, file name `postgresql.keystore` is used. + +**For Windows only:** The path is `%APPDATA%\.postgresql\postgresql.keystore` + +The `keytool` program can be found under the `bin` subdirectory of the Java Runtime Environment installation. + +You will be prompted for a new password. Save this password as it must be specified with the PGSSLCERTPASS environment variable. + +```text +$ /usr/java/jdk1.8.0_131/jre/bin/keytool -keystore postgresql.keystore \ +> -alias postgresqlstore -import -file edb_root.crt.der +Enter keystore password: +Re-enter new password: +Owner: CN=enterprisedb +Issuer: CN=enterprisedb +Serial number: c60f40256b0e8d53 +Valid from: Tue Aug 22 10:59:25 EDT 2017 until: Wed Aug 22 10:59:25 EDT 2018 +Certificate fingerprints: + MD5: 85:0B:E9:A7:6E:4F:7C:B0:9B:D6:3A:44:55:E2:E9:8E + SHA1: DD:A6:71:24:0B:6C:F8:BC:7A:4C:89:9B:DC:22:6A:6C:B0:F5:3F:7C + SHA256: +DC:02:64:E2:B0:E9:6F:1C:FC:4F:AE:E6:18:85:0B:79:57:43:C3:C5:AE:43:0D:37 +:49:53:6D:11:69:06:46:48 + Signature algorithm name: SHA1withRSA + Version: 1 +Trust this certificate? [no]: yes +Certificate was added to keystore +``` + +**Step 5:** Create a `PKCS #12` format of the keystore file `(postgresql.p12)` using files `edb.crt` and `edb.key` as input. + +!!! Note + The file name `postgresql.p12` is recommended so that it can be accessed in its default directory location `~/.postgresql/postgresql.p12`, which is under the home directory of the user account invoking EDB\*Plus. + +**For Windows only:** The path is `%APPDATA%\.postgresql\postgresql.p12` + +You will be prompted for a new password. Save this password as it must be specified with the PGSSLKEYPASS environment variable. + +```text +$ openssl pkcs12 -export -in edb.crt -inkey edb.key -out postgresql.p12 +Enter Export Password: +Verifying - Enter Export Password: +$ ls –l +total 24 +-rw-rw-r-- 1 user user 985 Aug 24 12:18 edb.crt +-rw-rw-r-- 1 user user 1704 Aug 24 12:18 edb.key +-rw-rw-r-- 1 user user 985 Aug 24 12:20 edb_root.crt +-rw-rw-r-- 1 user user 686 Aug 24 12:20 edb_root.crt.der +-rw-rw-r-- 1 user user 758 Aug 24 12:26 postgresql.keystore +-rw-rw-r-- 1 user user 2285 Aug 24 12:28 postgresql.p12 +``` + +**Step 6:** If the `postgresql.keystore` and `postgresql.p12` files are not already in the `~/.postgresql` directory, move or copy them to that location. + +**For Windows only:** The directory is `%APPDATA%\.postgresql` + +**Step 7:** If the default location `~/.postgresql` is not used, then the full path (including the file name) to the `postgresql.keystore` file must be set with the `PGSSLCERT` environment variable, and the full path (including the file name) to file `postgresql.p12` must be set with the `PGSSLKEY` environment variable before invoking EDB\*Plus. + +In addition, if the generated file from Step 4 was not named `postgresql.keystore` or `postgresql.jks` then, use the `PGSSLCERT` environment variable to designate the file name and its location. Similarly, if the generated file from Step 5 was not named `postgresql.p12` then, use the `PGSSLKEY` environment variable to designate the file name and its location. + +## Requesting an SSL Connection between EDB\*Plus and the Advanced Server Database + +Be sure the following topics have been addressed in order to perform an SSL connection: + +- The trusted certificate and keystore files have been generated for both the database server and the client host to be invoking EDB\*Plus. +- The `postgresql.conf` file for the database server contains the updated configuration parameters. +- The `pg_hba.conf` file for the database server contains the required entry for permitting the SSL connection. +- For the client host, either the client’s certificate and keystore files have been placed in the user account’s `~/.postgresql` directory or the environment variables `PGSSLCERT` and `PGSSLKEY` are set before invoking EDB\*Plus. +- The `PGSSLCERTPASS` environment variable is set with a password. +- The `PGSSLKEYPASS` environment variable is set with a password + +When invoking EDB\*Plus, include the `?ssl=true` parameter in the database connection string as shown for the `connectstring` option. + +The following is an example where EDB\*Plus is invoked from a host that is remote to the database server. + +The `postgresql.conf` file of the database server contains the following modified parameters: + +```text +ssl = on +ssl_cert_file = 'server.crt' +ssl_key_file = 'server.key' +ssl_ca_file = 'root.crt' +``` + +The `pg_hba.conf` file of the database server contains the following entry for connecting from EDB\*Plus on the remote host: + +```text +# TYPE DATABASE USER ADDRESS METHOD + +# "local" is for Unix domain socket connections only +local all all md5 +# IPv4 local connections: +hostssl edb all 192.168.2.24/32 cert clientcert=1 +``` + +On the remote host where EDB\*Plus is to be invoked, the Linux user account named `user` contains the certificate and keystore files in its `~/.postgresql` directory: + +```text +[user@localhost ~]$ whoami +user +[user@localhost ~]$ cd .postgresql +[user@localhost .postgresql]$ pwd +/home/user/.postgresql +[user@localhost .postgresql]$ ls -l +total 8 +-rw-rw-r-- 1 user user 758 Aug 24 12:37 postgresql.keystore +-rw-rw-r-- 1 user user 2285 Aug 24 12:37 postgresql.p12 +``` + +Logged into Linux with the account named `user`, EDB\*Plus is successfully invoked with the `ssl=true` parameter: + +```text +$ export PGSSLCERTPASS=keypass +$ export PGSSLKEYPASS=exppass +$ cd /opt/edb/as10/edbplus +$ ./edbplus.sh enterprisedb/password@192.168.2.22:5444/edb?ssl=true +Connected to EnterpriseDB 10.0.1 (192.168.2.22:5444/edb) AS enterprisedb + +EDB*Plus: Release 10 (Build 36.0.0) +Copyright (c) 2008-2021, EnterpriseDB Corporation. All rights reserved. + +SQL> +``` + +Alternatively, without placing the certificate and keystore files in `~/.postgresql`, but in a different directory, EDB\*Plus can be invoked in the following manner: + +```text +$ export PGSSLCERT=/home/user/ssl/postgresql.keystore +$ export PGSSLKEY=/home/user/ssl/postgresql.p12 +$ export PGSSLCERTPASS=keypass +$ export PGSSLKEYPASS=exppass +$ cd /opt/edb/as10/edbplus +$ ./edbplus.sh enterprisedb/password@192.168.2.22:5444/edb?ssl=true +Connected to EnterpriseDB 10.0.1 (192.168.2.22:5444/edb) AS enterprisedb + +EDB*Plus: Release 10 (Build 36.0.0) +Copyright (c) 2008-2021, EnterpriseDB Corporation. All rights reserved. + +SQL> +``` + +Note that in both cases the database user name used to log into EDB\*Plus is `enterprisedb` as this is the user specified for the common name field when creating the certificate in Step 1 of [Configuring SSL on Advanced Server](#using_ssl_connection). + +Other database user names can be used if the `pg_hba.conf` file with the `map` option and the `pg_ident.conf` file are used. diff --git a/product_docs/docs/edb_plus/36/06_command_summary.mdx b/product_docs/docs/edb_plus/36/06_command_summary.mdx new file mode 100644 index 00000000000..7bd40d1dd0a --- /dev/null +++ b/product_docs/docs/edb_plus/36/06_command_summary.mdx @@ -0,0 +1,995 @@ +--- +title: "Command Summary" +--- + + + +The following sections contains a summary of EDB\*Plus commands. + +## ACCEPT + +The `ACCEPT` command displays a prompt and waits for the user’s keyboard input. The value input by the user is placed in the specified variable. + +```text +ACC[EPT ] variable +``` + +The following example creates a new variable named `my_name`, accepts a value of John Smith, then displays the value using the `DEFINE` command. + +```text +SQL> ACCEPT my_name +Enter value for my_name: John Smith +SQL> DEFINE my_name +DEFINE MY_NAME = "John Smith" +``` + +## APPEND + +`APPEND` is a line editor command that appends the given text to the end of the current line in the SQL buffer. + +```text +A[PPEND ] text +``` + +In the following example, a `SELECT` command is built-in the SQL buffer using the `APPEND` command. Note that two spaces are placed between the `APPEND` command and the `WHERE` clause in order to separate `dept` and `WHERE` by one space in the SQL buffer. + +```text +SQL> APPEND SELECT * FROM dept +SQL> LIST + 1 SELECT * FROM dept +SQL> APPEND WHERE deptno = 10 +SQL> LIST + 1 SELECT * FROM dept WHERE deptno = 10 +``` + +## CHANGE + +`CHANGE` is a line editor command performs a search-and-replace on the current line in the SQL buffer. + +```text +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. + +The following sequence of commands makes line 3 the current line, then changes the department number in the `WHERE` clause from 20 to 30. + +```text +SQL> LIST + 1 SELECT empno, ename, job, sal, comm + 2 FROM emp + 3 WHERE deptno = 20 + 4* ORDER BY empno +SQL> 3 + 3* WHERE deptno = 20 +SQL> CHANGE /20/30/ + 3* WHERE deptno = 30 +SQL> LIST + 1 SELECT empno, ename, job, sal, comm + 2 FROM emp + 3 WHERE deptno = 30 + 4* ORDER BY empno +``` + +## CLEAR + +The `CLEAR` command removes the contents of the SQL buffer, deletes all column definitions set with the `COLUMN` command, or clears the screen. + +```text +CL[EAR ] [ BUFF[ER ] | SQL | COL[UMNS ] | SCR[EEN ] ] +``` + +`BUFFER | SQL` + + Clears the SQL buffer. + +`COLUMNS` + + Removes column definitions. + +`SCREEN` + + Clears the screen. This is the default if no options are specified. + +## COLUMN + +The `COLUMN` command controls output formatting. The formatting attributes set by using the `COLUMN` command remain in effect only for the duration of the current session. + +```text +COL[UMN ] + [ column + { CLE[AR ] | + { FOR[MAT ] spec | + HEA[DING ] text | + { OFF | ON } + } [...] + } + ] +``` + +If the `COLUMN` command is specified with no subsequent 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 may be followed by one of the following: + +1. No other options +2. `CLEAR` +3. Any combination of `FORMAT`, `HEADING`, and one of `OFF` or `ON` + +`column` + + Name of a column in a table to which subsequent column formatting options are to apply. If no other options follow `column`, then the current column formatting options if any, of `column` are displayed. + +`CLEAR` + + The `CLEAR` option reverts all formatting options back to their defaults for `column`. If the `CLEAR` option is specified, it must be the only option specified. + +`spec` + + Format specification to be applied to `column`. For character columns, `spec` takes the following format: + +`n` + + `n` is a positive integer that specifies the column width in characters within which to display the data. Data in excess of `n` will wrap around with the specified column width. + + For numeric columns, `spec` is comprised of the following elements. + +| Element | Description | +| ------- | ------------------------------------------ | +| `$` | Display a leading dollar sign. | +| `,` | Display a comma in the indicated position. | +| `.` | Marks the location of the decimal point. | +| `0` | Display leading zeros. | +| `9` | Number of significant digits to display. | + + If loss of significant digits occurs due to overflow of the format, then all #’s are displayed. + +`text` + + Text to be used for the column heading of `column`. + +`OFF | ON` + + If `OFF` is specified, formatting options are reverted back to their defaults, but are still available within the session. If `ON` is specified, the formatting options specified by previous `COLUMN` commands for `column` within the session are re-activated. + +The following example shows the effect of changing the display width of the `job` column. + +```text +SQL> SET PAGESIZE 9999 +SQL> COLUMN job FORMAT A5 +SQL> COLUMN job +COLUMN JOB ON +FORMAT A5 +wrapped +SQL> SELECT empno, ename, job FROM emp; + +EMPNO ENAME JOB +----- ---------- ----- + 7369 SMITH CLERK + 7499 ALLEN SALES + MAN + + 7521 WARD SALES + MAN + + 7566 JONES MANAG + ER + + 7654 MARTIN SALES + MAN + + 7698 BLAKE MANAG + ER + + 7782 CLARK MANAG + ER + + 7788 SCOTT ANALY + ST + + 7839 KING PRESI + DENT + + 7844 TURNER SALES + MAN + + 7876 ADAMS CLERK + 7900 JAMES CLERK + 7902 FORD ANALY + ST + + 7934 MILLER CLERK + +14 rows retrieved. +``` + +The following example applies a format to the `sal` column. + +```text +SQL> COLUMN sal FORMAT $99,999.00 +SQL> COLUMN +COLUMN JOB ON +FORMAT A5 +wrapped + +COLUMN SAL ON +FORMAT $99,999.00 +wrapped +SQL> SELECT empno, ename, job, sal FROM emp; + +EMPNO ENAME JOB SAL +----- ---------- ----- ----------- + 7369 SMITH CLERK $800.00 + 7499 ALLEN SALES $1,600.00 + MAN + + 7521 WARD SALES $1,250.00 + MAN + + 7566 JONES MANAG $2,975.00 + ER + + 7654 MARTIN SALES $1,250.00 + MAN + + 7698 BLAKE MANAG $2,850.00 + ER + + 7782 CLARK MANAG $2,450.00 + ER + + 7788 SCOTT ANALY $3,000.00 + ST + + 7839 KING PRESI $5,000.00 + DENT + + 7844 TURNER SALES $1,500.00 + MAN + + 7876 ADAMS CLERK $1,100.00 + 7900 JAMES CLERK $950.00 + 7902 FORD ANALY $3,000.00 + ST + + 7934 MILLER CLERK $1,300.00 + +14 rows retrieved. +``` + +## CONNECT + +Change the database connection to a different user and/or connect to a different database. There must be no white space between any of the parameters following the `CONNECT` command. + +```text +CON[NECT] [/][@{ | } ] +``` + +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 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 +``` + + If a password file cannot be located, or it does not have an entry matching the EDB\*Plus connection parameters, then EDB\*Plus will prompt for the password. For more information about password files, see the PostgreSQL core documentation at: + + + +!!! Note + When a password is not required, EDB\*Plus does not 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 at + + `connectstring` is the database connection string. See [Using EDB\*Plus](04_using_edb_plus/#using_edb_plus) for further information on 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 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`. + +```text +SQL> CONNECT smith/mypassword@localhost:5445/edb +Disconnected from EnterpriseDB Database. +Connected to EnterpriseDB 10.0.1 (localhost:5445/edb) AS smith +``` + +From within the session shown above, the connection is changed to username `enterprisedb`. Also note that the host defaults to the localhost, the port defaults to `5444` (which is not the same as the port previously used), and the database defaults to `edb`. + +```text +SQL> CONNECT enterprisedb/password +Disconnected from EnterpriseDB Database. +Connected to EnterpriseDB 10.0.1 (localhost:5444/edb) AS enterprisedb +``` + +## DEFINE + +The `DEFINE` command creates or replaces the value of a *user variable* (also called a *substitution variable*). + +```text +DEF[INE ] [ variable [ = text ] ] +``` + +If the `DEFINE` command is given 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` may be optionally enclosed within single or double quotation marks. Quotation marks must be used if `text` contains space characters. + +The following example defines two variables, `dept` and `name`. + +```text +SQL> DEFINE dept = 20 +SQL> DEFINE name = 'John Smith' +SQL> DEFINE +DEFINE EDB = "localhost:5445/edb" +DEFINE DEPT = "20" +DEFINE NAME = "John Smith" +``` + +!!! Note + The variable `EDB` is read from the `login.sql` file located in the `edbplus` subdirectory of the Advanced Server home directory. + +## DEL + +`DEL` is a line editor command that deletes one or more lines from the SQL buffer. + +```text +DEL [ n | n m | n * | n L[AST ] | * | * n | * L[AST ] | L[AST ] ] +``` + +The parameters specify which lines are to be deleted from the SQL buffer. Two parameters specify the start and end of a range of lines to be deleted. If the `DEL` command is given with no parameters, the current line is deleted. + +`n` + + n is an integer representing the `n`th line + +`n m` + + `n` and `m` are integers where `m` is greater than `n` representing the `n`th through the `m`th lines + +`*` + + Current line + +`LAST` + + 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. + +```text +SQL> LIST + 1 SELECT + 2 empno + 3 ,ename + 4 ,job + 5 ,sal + 6 ,comm + 7 ,deptno + 8* FROM emp +SQL> DEL 5 6 +SQL> LIST + 1 SELECT + 2 empno + 3 ,ename + 4 ,job + 5 ,deptno + 6* FROM emp +``` + +## DESCRIBE + +The `DESCRIBE` command displays: + +- A list of columns, column data types, and column lengths for a table or view +- A list of parameters for a procedure or function +- A list of procedures and functions and their respective parameters for a package + +The `DESCRIBE` command will also display the structure of the database object referred to by a synonym. The syntax is: + +```text +DESC[RIBE] [ schema.]object +``` + +`schema` + + Name of the schema containing the object to be described. + +`object` + + Name of the table, view, procedure, function, or package to be displayed, or the synonym of an object. + +## DISCONNECT + +The `DISCONNECT` command closes the current database connection, but does not terminate EDB\*Plus. + +```text +DISC[ONNECT ] +``` + +## EDIT + +The `EDIT` command invokes an external editor to edit the contents of an operating system file or the SQL buffer. + +```text +ED[IT ] [ filename[.ext ] ] +``` + +`filename[.ext ]` + + `filename` is the name of the file to open with an external editor. `ext` is the filename extension. If the filename extension is `sql`, then the `.sql` extension may be omitted when specifying `filename`. `EDIT` always assumes a `.sql` extension on filenames 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. + +## EXECUTE + +The `EXECUTE` command executes an SPL procedure from EDB\*Plus. + +```text +EXEC[UTE ] spl_procedure [ ([ parameters ]) ] +``` + +`spl_procedure` + + The name of the SPL procedure to be executed. + +`parameters` + + Comma-delimited list of parameters. If there are no parameters, then a pair of empty parentheses may optionally be specified. + +## EXIT + +The `EXIT` command terminates the EDB\*Plus session and returns control to the operating system. `QUIT` is a synonym for `EXIT`. Specifying no parameters is equivalent to `EXIT SUCCESS COMMIT`. + +```text +{ EXIT | QUIT } +[ SUCCESS | FAILURE | WARNING | value | variable ] +[ 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`. + +`value` + + An integer value that is returned as the return code. + +`variable` + + A variable created with the `DEFINE` command whose value is returned as the return code. + +`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`. + +## GET + +The `GET` command loads the contents of the given file to the SQL buffer. + +```text +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 filename extension. If the filename extension is `sql`, then the `.sql` extension may be omitted when specifying `filename`. `GET` always 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`. + +## HELP + +The `HELP` command obtains an index of topics or help on a specific topic. The question mark `(?)` is synonymous with specifying `HELP`. + +```text +{ HELP | ? } { INDEX | topic } +``` + +`INDEX` + + Displays an index of available topics. + +`topic` + + The name of a specific topic – e.g., an EDB\*Plus command, for which help is desired. + +## HOST + +The `HOST` command executes an operating system command from EDB\*Plus. + +```text +HO[ST ] [os_command] +``` + +`os_command` + + The operating system command to be executed. If you do not provide an operating system command, EDB\*Plus pauses execution and opens a new shell prompt. When the shell exits, EDB\*Plus resumes execution. + +## INPUT + +The `INPUT` line editor command adds a line of text to the SQL buffer after the current line. + +```text +I[NPUT ] text +``` + +The following sequence of `INPUT` commands constructs a `SELECT` command. + +```text +SQL> INPUT SELECT empno, ename, job, sal, comm +SQL> INPUT FROM emp +SQL> INPUT WHERE deptno = 20 +SQL> INPUT ORDER BY empno +SQL> LIST + 1 SELECT empno, ename, job, sal, comm + 2 FROM emp + 3 WHERE deptno = 20 + 4* ORDER BY empno +``` + +## LIST + +`LIST` is a line editor command that displays the contents of the SQL buffer. + +```text +L[IST] [ n | n m | n * | n L[AST] | * | * n | * L[AST] | L[AST] ] +``` + +The buffer does not include a history of the EDB\*Plus commands. + +`n` + + `n` represents the buffer line number. + +`n m` + + `n m` displays a list of lines between `n` and `m`. + +`n *` + + `n *` displays a list of lines that range between line `n` and the current line. + +`n L[AST]` + + `n L[AST]` displays a list of lines that range from line `n` through the last line in the buffer. + +`*` + + `*` displays the current line. + +`* n` + + `* n` displays a list of lines that range from the current line through line `n`. + +`* L[AST]` + + `* L[AST]` displays a list of lines that range from the current line through the last line. + +`L[AST]` + + `L[AST]` displays the last line. + +## PASSWORD + +Use the `PASSWORD` command to change your database password. + +```text +PASSW[ORD] [user_name] +``` + +You must have sufficient privileges to use the `PASSWORD` command to change another user's password. The following example demonstrates using the `PASSWORD` command to change the password for a user named `acctg`: + +```text +SQL> PASSWORD acctg +Changing password for acctg + New password: + New password again: +Password successfully changed. +``` + +## PAUSE + +The `PAUSE` command displays a message, and waits for the user to press `ENTER`. + +```text +PAU[SE] [optional_text] +``` + +`optional_text` specifies the text that will be displayed to the user. If the `optional_text` is omitted, Advanced Server will display two blank lines. If you double quote the `optional_text` string, the quotes will be included in the output. + +## PROMPT + +The `PROMPT` command displays a message to the user before continuing. + +```text +PRO[MPT] [message_text] +``` + +`message_text` specifies the text displayed to the user. Double quote the string to include quotes in the output. + +## QUIT + +The `QUIT` command terminates the session and returns control to the operating system. `QUIT` is a synonym for `EXIT`. + +```text +QUIT + +[SUCCESS | FAILURE | WARNING | value | sub_variable] + +[COMMIT | ROLLBACK] +``` + +The default value is `QUIT SUCCESS COMMIT`. + +## REMARK + +Use `REMARK` to include comments in a script. + +```text +REM[ARK] [optional_text] +``` + +You may also use the following convention to include a comment: + +```text +/* + * This is an example of a three line comment. + */ +``` + +## SAVE + +Use the `SAVE` command to write the SQL Buffer to an operating system file. + +```text +SAV[E] file_name +[CRE[ATE] | REP[LACE] | APP[END]] +``` + +`file_name` + + `file_name` specifies the name of the file (including the path) where the buffer contents are written. If you do not provide a file extension, `.sql` is appended to the end of the file name. + +`CREATE` + + Include the `CREATE` keyword to create a new file. A new file is created *only* if a file with the specified name does not already exist. This is the default. + +`REPLACE` + + Include the `REPLACE` keyword to specify that Advanced Server should overwrite an existing file. + +`APPEND` + + Include the `APPEND` keyword to specify that Advanced Server should 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: + +```text +SQL> SAVE C:\example.sql CREATE +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: + +**SET AUTOCOMMIT** + +Use the `SET AUTOCOMMIT` command to specify commit behavior for Advanced Server transactions. + +```text +SET AUTO[COMMIT] + +{ON | OFF | IMMEDIATE | statement_count} +``` + +Please note that EDB\*Plus always automatically commits DDL statements. + +`ON` + + Specify `ON` to turn `AUTOCOMMIT` behavior on. + +`OFF` + + Specify `OFF` to turn `AUTOCOMMIT` behavior off. + +`IMMEDIATE` + + `IMMEDIATE` has the same effect as `ON`. + +`statement_count` + + Include a value for `statement_count` to instruct EDB\*Plus to issue a commit after the specified count of successful SQL statements. + +**SET COLUMN SEPARATOR** + +Use the `SET COLUMN SEPARATOR` command to specify the text that Advanced Server displays between columns. + +```text +SET COLSEP column_separator +``` + +The default value of `column_separator` is a single space. + +**SET ECHO** + +Use the `SET ECHO` command to specify if SQL and EDB\*Plus script statements should be displayed onscreen as they are executed. + +```text +SET ECHO {ON | OFF} +``` + +The default value is `OFF`. + +**SET FEEDBACK** + +The `SET FEEDBACK` command controls the display of interactive information after a SQL statement executes. + +```text +SET FEED[BACK] {ON | OFF | row_threshold} +``` + +`row_threshold` + + Specify an integer value for `row_threshold`. Setting `row_threshold` to `0` is same as setting `FEEDBACK` to `OFF`. Setting `row_threshold` equal `1` effectively sets `FEEDBACK` to `ON`. + +**SET FLUSH** + +Use the `SET FLUSH` command to control display buffering. + +```text +SET FLU[SH] {ON | OFF} +``` + +Set `FLUSH` to `OFF` to enable display buffering. If you enable buffering, messages bound for the screen may not appear until the script completes. Please note that setting `FLUSH` to `OFF` will offer better performance. + +Set `FLUSH` to `ON` to disable display buffering. If you disable buffering, messages bound for the screen appear immediately. + +**SET HEADING** + +Use the `SET HEADING` variable to specify if Advanced Server should display column headings for `SELECT` statements. + +```text +SET HEA[DING] {ON | OFF} +``` + +**SET HEAD SEPARATOR** + +The `SET HEADSEP` command sets the new heading separator character used by the `COLUMN HEADING` command. The default is `'|'`. + +```text +SET HEADS[EP] +``` + +**SET LINESIZE** + +Use the `SET LINESIZE` command to specify the width of a line in characters. + +```text +SET LIN[ESIZE] width_of_line +``` + +`width_of_line` + + The default value of `width_of_line` is `132`. + +**SET NEWPAGE** + +Use the `SET NEWPAGE` command to specify how many blank lines are printed after a page break. + +```text +SET NEWP[AGE] lines_per_page +``` + +`lines_per_page` + + The default value of `lines_per_page` is `1`. + +**SET NULL** + +Use the `SET NULL` command to specify a string that is displayed to the user when a `NULL` column value is displayed in the output buffer. + +```text +SET NULL null_string +``` + +**SET PAGESIZE** + +Use the `SET PAGESIZE` command to specify the number of printed lines that fit on a page. + +```text +SET PAGES[IZE] line_count +``` + +Use the `line_count` parameter to specify the number of lines per page. + +**SET SQLCASE** + +The `SET SQLCASE` command specifies if SQL statements transmitted to the server should be converted to upper or lower case. + +```text +SET SQLC[ASE] {MIX[ED] | UP[PER] | LO[WER]} +``` + +`UPPER` + + Specify `UPPER` to convert the command text to uppercase. + +`LOWER` + + Specify `LOWER` to convert the command text to lowercase. + +`MIXED` + + Specify `MIXED` to leave the case of SQL commands unchanged. The default is `MIXED`. + +**SET PAUSE** + +The `SET PAUSE` command is most useful when included in a script; the command displays a prompt and waits for the user to press `Return`. + +```text +SET PAU[SE] {ON | OFF} +``` + +If `SET PAUSE` is `ON`, the message `Hit ENTER to continue…` will be displayed before each command is executed. + +**SET SPACE** + +Use the `SET SPACE` command to specify the number of spaces to display between columns: + +```text +SET SPACE number_of_spaces +``` + +**SET SQLPROMPT** + +Use `SET SQLPROMPT` to set a value for a user-interactive prompt: + +```text +SET SQLP[ROMPT] "prompt" +``` + +By default, `SQLPROMPT` is set to `"SQL> "` + +**SET TERMOUT** + +Use the `SET TERMOUT` command to specify if command output should be displayed onscreen. + +```text +SET TERM[OUT] {ON | OFF} +``` + +**SET TIMING** + +The `SET TIMING` command specifies if Advanced Server should display the execution time for each SQL statement after it is executed. + +```text +SET TIMI[NG] {ON | OFF} +``` + +**SET TRIMSPOOL** + +Use the `SET TRIMSPOOL` command to remove trailing spaces from each line in the output file specified by the `SPOOL` command. + +```text +SET TRIMS[POOL] {ON | OFF} +``` + +The default value is `OFF`. + +**SET VERIFY** + +Specifies if both the old and new values of a SQL statement are displayed when a substitution variable is encountered. + +```text +SET VER[IFY] { ON | OFF } +``` + +## SHOW + +Use the `SHOW` command to display current parameter values. + +```text +SHO[W] {ALL | parameter_name} +``` + +Display the current parameter settings by including the `ALL` keyword: + +```Text +SQL> SHOW ALL +autocommit OFF +colsep " " +define "&" +echo OFF +FEEDBACK ON for 6 row(s). +flush ON +heading ON +headsep "|" +linesize 78 +newpage 1 +null " " +pagesize 14 +pause OFF +serveroutput OFF +spool OFF +sqlcase MIXED +sqlprompt "SQL> " +sqlterminator ";" +suffix ".sql" +termout ON +timing OFF +verify ON +USER is "enterprisedb" +HOST is "localhost" +PORT is "5444" +DATABASE is "edb" +VERSION is "10.0.0" +``` + +Or display a specific parameter setting by including the `parameter_name` in the `SHOW` command: + +```text +SQL> SHOW VERSION +VERSION is "10.0.0" +``` + +## SPOOL + +The `SPOOL` command sends output from the display to a file. + +```text +SP[OOL] output_file | OFF +``` + +Use the `output_file` parameter to specify a path name for the output file. + +## START + +Use the `START` command to run an EDB\*Plus script file; `START` is an alias for `@` command. + +```text +STA[RT] script_file +``` + +Specify the name of a script file in the `script_file` parameter. + +## UNDEFINE + +The `UNDEFINE` command erases a user variable created by the `DEFINE` command. + +```text +UNDEF[INE] variable_name [ variable_name...] +``` + +Use the `variable_name` parameter to specify the name of a variable or variables. + +## WHENEVER SQLERROR + +The `WHENEVER SQLERROR` command provides error handling for SQL errors or PL/SQL block errors. The syntax is: + +```text +WHENEVER SQLERROR + {CONTINUE[COMMIT|ROLLBACK|NONE] + |EXIT[SUCCESS|FAILURE|WARNING|n|sub_variable] + [COMMIT|ROLLBACK]} +``` + +If Advanced Server encounters an error during the execution of a SQL command or PL/SQL block, EDB\*Plus performs the action specified in the `WHENEVER SQLERROR` command: + + Include the `CONTINUE` clause to instruct EDB\*Plus to perform the specified action before continuing. + + Include the `COMMIT` clause to instruct EDB\*Plus to `COMMIT` the current transaction before exiting or continuing. + + Include the `ROLLBACK` clause to instruct EDB\*Plus to `ROLLBACK` the current transaction before exiting or continuing. + + Include the `NONE` clause to instruct EDB\*Plus to continue without committing or rolling back the transaction. + + Include the `EXIT` clause to instruct EDB\*Plus to perform the specified action and exit if it encounters an error. + + Use the following options to specify a status code that EDB\*Plus will return before exiting: + +```text +[SUCCESS|FAILURE|WARNING|n|sub_variable] +``` + + Please note that EDB\*Plus supports substitution variables, but does not support bind variables. diff --git a/product_docs/docs/edb_plus/36/images/advanced_server_installation_details.png b/product_docs/docs/edb_plus/36/images/advanced_server_installation_details.png new file mode 100755 index 00000000000..3638e7d551f --- /dev/null +++ b/product_docs/docs/edb_plus/36/images/advanced_server_installation_details.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:a9c152dfd15132f11750917e10b0a8dd3646bfcf5f4d9a3525066f68ebd807d3 +size 19239 diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.png b/product_docs/docs/edb_plus/36/images/edb_logo.png similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.png rename to product_docs/docs/edb_plus/36/images/edb_logo.png diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.svg b/product_docs/docs/edb_plus/36/images/edb_logo.svg similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/images/edb_logo.svg rename to product_docs/docs/edb_plus/36/images/edb_logo.svg diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/edb_plus_welcome.png b/product_docs/docs/edb_plus/36/images/edb_plus_welcome.png similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/images/edb_plus_welcome.png rename to product_docs/docs/edb_plus/36/images/edb_plus_welcome.png diff --git a/product_docs/docs/edb_plus/36/images/edb_plus_welcome_1.png b/product_docs/docs/edb_plus/36/images/edb_plus_welcome_1.png new file mode 100755 index 00000000000..ea2a26270ab --- /dev/null +++ b/product_docs/docs/edb_plus/36/images/edb_plus_welcome_1.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:2b1c56ab042cb3f2ea94a6fc8177bb9176fdd0bc42ca36e23c43594993dd6637 +size 34974 diff --git a/product_docs/docs/edb_plus/36/images/installation_complete.png b/product_docs/docs/edb_plus/36/images/installation_complete.png new file mode 100755 index 00000000000..30281ba5583 --- /dev/null +++ b/product_docs/docs/edb_plus/36/images/installation_complete.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:3836a996fa7052af22f4a23e24903594d4edf866c3e2696a6cbc0de8f1db4e03 +size 37674 diff --git a/product_docs/docs/edb_plus/36/images/installation_directory.png b/product_docs/docs/edb_plus/36/images/installation_directory.png new file mode 100755 index 00000000000..0e4ab726341 --- /dev/null +++ b/product_docs/docs/edb_plus/36/images/installation_directory.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:7c9a3d397f6c345f80a95362c407c1b72b0414c5934a8e8ef20d6c04a4980469 +size 71722 diff --git a/product_docs/docs/edb_plus/36/images/ready_to_install.png b/product_docs/docs/edb_plus/36/images/ready_to_install.png new file mode 100755 index 00000000000..a73f573adc5 --- /dev/null +++ b/product_docs/docs/edb_plus/36/images/ready_to_install.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:ddd7dc4e8a4a8e40f9194e5f7971d3fc01c9c6130de1d3a62fc528a2a018c666 +size 15785 diff --git a/product_docs/docs/edb_plus/36/index.mdx b/product_docs/docs/edb_plus/36/index.mdx new file mode 100644 index 00000000000..366f92ea670 --- /dev/null +++ b/product_docs/docs/edb_plus/36/index.mdx @@ -0,0 +1,26 @@ +--- +navTitle: EDB*Plus — CLI +title: "EDB*Plus User's Guide" + +directoryDefaults: + description: "EDB*Plus Documentation and release notes." +--- + +This guide describes how to connect to an Advanced Server database using EDB\*Plus. EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server that accepts SQL commands that allow you to: + +- Query certain database objects +- Execute stored procedures +- Format output from SQL commands +- Execute batch scripts +- Execute OS commands +- Record output + +For detailed information about the features supported by Advanced Server, consult the complete library of Advanced Server guides available at: + + + +
+ +introduction edb_plus installing_edb_plus using_edb_plus using_edb_plus_with_ssl command_summary conclusion + +
diff --git a/product_docs/docs/edb_plus/38/03_installing_edb_plus/01_installing_prereq.mdx b/product_docs/docs/edb_plus/38/01_installing_prereq.mdx similarity index 100% rename from product_docs/docs/edb_plus/38/03_installing_edb_plus/01_installing_prereq.mdx rename to product_docs/docs/edb_plus/38/01_installing_prereq.mdx diff --git a/product_docs/docs/edb_plus/38/03_installing_edb_plus/02_rpm_installation.mdx b/product_docs/docs/edb_plus/38/02_rpm_installation.mdx similarity index 100% rename from product_docs/docs/edb_plus/38/03_installing_edb_plus/02_rpm_installation.mdx rename to product_docs/docs/edb_plus/38/02_rpm_installation.mdx diff --git a/product_docs/docs/edb_plus/38/03_installing_edb_plus/03_using_gui.mdx b/product_docs/docs/edb_plus/38/03_using_gui.mdx similarity index 100% rename from product_docs/docs/edb_plus/38/03_installing_edb_plus/03_using_gui.mdx rename to product_docs/docs/edb_plus/38/03_using_gui.mdx diff --git a/product_docs/docs/edb_plus/38/03_installing_edb_plus/index.mdx b/product_docs/docs/edb_plus/38/index.mdx similarity index 100% rename from product_docs/docs/edb_plus/38/03_installing_edb_plus/index.mdx rename to product_docs/docs/edb_plus/38/index.mdx diff --git a/product_docs/docs/edb_plus/39/edb_plus/02_edb_plus.mdx b/product_docs/docs/edb_plus/39/02_edb_plus.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/02_edb_plus.mdx rename to product_docs/docs/edb_plus/39/02_edb_plus.mdx diff --git a/product_docs/docs/edb_plus/39/edb_plus/03_installing_edb_plus.mdx b/product_docs/docs/edb_plus/39/03_installing_edb_plus.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/03_installing_edb_plus.mdx rename to product_docs/docs/edb_plus/39/03_installing_edb_plus.mdx diff --git a/product_docs/docs/edb_plus/39/edb_plus/04_using_edb_plus.mdx b/product_docs/docs/edb_plus/39/04_using_edb_plus.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/04_using_edb_plus.mdx rename to product_docs/docs/edb_plus/39/04_using_edb_plus.mdx diff --git a/product_docs/docs/edb_plus/39/edb_plus/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/39/05_using_edb_plus_with_ssl.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/05_using_edb_plus_with_ssl.mdx rename to product_docs/docs/edb_plus/39/05_using_edb_plus_with_ssl.mdx diff --git a/product_docs/docs/edb_plus/39/edb_plus/06_command_summary.mdx b/product_docs/docs/edb_plus/39/06_command_summary.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/06_command_summary.mdx rename to product_docs/docs/edb_plus/39/06_command_summary.mdx diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/advanced_server_installation_details.png b/product_docs/docs/edb_plus/39/images/advanced_server_installation_details.png similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/images/advanced_server_installation_details.png rename to product_docs/docs/edb_plus/39/images/advanced_server_installation_details.png diff --git a/product_docs/docs/edb_plus/39/images/edb_logo.png b/product_docs/docs/edb_plus/39/images/edb_logo.png new file mode 100644 index 00000000000..f4a93cf57f5 --- /dev/null +++ b/product_docs/docs/edb_plus/39/images/edb_logo.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:07423b012a855204780fe5a2a5a1e33607304a5c3020ae4acbf3d575691dedd6 +size 12136 diff --git a/product_docs/docs/edb_plus/39/images/edb_logo.svg b/product_docs/docs/edb_plus/39/images/edb_logo.svg new file mode 100644 index 00000000000..f24d1dfefee --- /dev/null +++ b/product_docs/docs/edb_plus/39/images/edb_logo.svg @@ -0,0 +1,19 @@ + + + edb-logo-disc-dark + + + + \ No newline at end of file diff --git a/product_docs/docs/edb_plus/39/images/edb_plus_welcome.png b/product_docs/docs/edb_plus/39/images/edb_plus_welcome.png new file mode 100755 index 00000000000..c526c78eabf --- /dev/null +++ b/product_docs/docs/edb_plus/39/images/edb_plus_welcome.png @@ -0,0 +1,3 @@ +version https://git-lfs.github.com/spec/v1 +oid sha256:4f557131b686992e3d8a9f7d0f40ddd14dcdde8a6ee7fb90af3ef57860194024 +size 56911 diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/installation_complete.png b/product_docs/docs/edb_plus/39/images/installation_complete.png similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/images/installation_complete.png rename to product_docs/docs/edb_plus/39/images/installation_complete.png diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/installation_directory.png b/product_docs/docs/edb_plus/39/images/installation_directory.png similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/images/installation_directory.png rename to product_docs/docs/edb_plus/39/images/installation_directory.png diff --git a/product_docs/docs/edb_plus/39/edb_plus/images/ready_to_install.png b/product_docs/docs/edb_plus/39/images/ready_to_install.png similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/images/ready_to_install.png rename to product_docs/docs/edb_plus/39/images/ready_to_install.png diff --git a/product_docs/docs/edb_plus/39/edb_plus/index.mdx b/product_docs/docs/edb_plus/39/index.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/edb_plus/index.mdx rename to product_docs/docs/edb_plus/39/index.mdx From a625138b6b283663a533139e19aea97de9af4dbf Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 09:50:33 -0500 Subject: [PATCH 10/29] v39 release notes --- .../02_edbplus39.00_rel_notes.mdx | 10 ++++++++++ .../04_edbplus39.01_rel_notes.mdx | 13 +++++++++++++ .../docs/edb_plus/39/02a_release_notes/index.mdx | 14 ++++++++++++++ 3 files changed, 37 insertions(+) create mode 100644 product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx create mode 100644 product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx create mode 100644 product_docs/docs/edb_plus/39/02a_release_notes/index.mdx diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx new file mode 100644 index 00000000000..36cc130dd67 --- /dev/null +++ b/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx @@ -0,0 +1,10 @@ +--- +navTitle: Release Notes +title: "EDB*Plus Version 39.00 Release Notes" +--- + +New features, enhancements, bug fixes, and other changes in EDB*Plus 39.00 include: + +| Type | Description | +| ----------- | -------------------------------------------------------------- | +| Enhancement | Support for new version of EDB Postgres Advanced Server 13.1.4 | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx new file mode 100644 index 00000000000..fe204911381 --- /dev/null +++ b/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx @@ -0,0 +1,13 @@ +--- +navTitle: Release Notes +title: "EDB*Plus Version 39.01 Release Notes" +--- + +New features, enhancements, bug fixes, and other changes in EDB*Plus 39.01 include: + +| Type | Description | +| ------- | ----------------------------------------------------------------------------------------------------------------- | +| Bug Fix | Correction to handle single quotes [‘] properly in the script output. | +| Bug Fix | Correct line number being reported for the error encountered related to the execution of the procedure/code. | +| Bug Fix | Prompt user to enter the password on the second attempt. | +| Bug Fix | Help index now loads the “edbPLUS” topic. | diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx new file mode 100644 index 00000000000..cfba717526a --- /dev/null +++ b/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx @@ -0,0 +1,14 @@ +--- +navTitle: Release Notes +title: "EDB*Plus Version 39 Release Notes" + +--- + +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. + +The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 39. The release notes in this section provide information on what was new in each release. + +| Version - | Release Date | | +| -------------------------------------- | ------------ | +| [39.01](04_edbplus39.01_rel_notes.mdx) | 2021 Aug 12 | +| [39.00](02_edbplus39.00_rel_notes.mdx) | 2020 Dec 12 | \ No newline at end of file From a784227956c31abd4dc1bd75171556572ad884c5 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 09:59:23 -0500 Subject: [PATCH 11/29] Cleanup for v39 --- product_docs/docs/edb_plus/39/02_edb_plus.mdx | 21 ------------------- .../02_edbplus39.00_rel_notes.mdx | 2 +- .../04_edbplus39.01_rel_notes.mdx | 2 +- product_docs/docs/edb_plus/39/index.mdx | 18 +++++++--------- 4 files changed, 10 insertions(+), 33 deletions(-) delete mode 100644 product_docs/docs/edb_plus/39/02_edb_plus.mdx diff --git a/product_docs/docs/edb_plus/39/02_edb_plus.mdx b/product_docs/docs/edb_plus/39/02_edb_plus.mdx deleted file mode 100644 index 236afb3b23d..00000000000 --- a/product_docs/docs/edb_plus/39/02_edb_plus.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "EDB*Plus" -legacyRedirectsGenerated: - # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. - - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/edb_plus.html" - - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/38/edb_plus.html" - - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/edb_plus.html" ---- - - - -EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. - -EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: - -- Querying certain database objects -- Executing stored procedures -- Formatting output from SQL commands -- Executing batch scripts -- Executing OS commands -- Recording output diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx index 36cc130dd67..79a0a2483ac 100644 --- a/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx +++ b/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx @@ -1,5 +1,5 @@ --- -navTitle: Release Notes +navTitle: Version 39.00 title: "EDB*Plus Version 39.00 Release Notes" --- diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx index fe204911381..5332ee23557 100644 --- a/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx +++ b/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx @@ -1,5 +1,5 @@ --- -navTitle: Release Notes +navTitle: Version 39.01 title: "EDB*Plus Version 39.01 Release Notes" --- diff --git a/product_docs/docs/edb_plus/39/index.mdx b/product_docs/docs/edb_plus/39/index.mdx index be93a14b2a8..6f68231f66f 100644 --- a/product_docs/docs/edb_plus/39/index.mdx +++ b/product_docs/docs/edb_plus/39/index.mdx @@ -24,18 +24,16 @@ legacyRedirectsGenerated: - "/edb-docs/d/edbplus/user-guides/edbplus-guide/36/conclusion.html" --- -This guide describes how to connect to an Advanced Server database using EDB\*Plus. EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server that accepts SQL commands that allow you to: +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. -- Query certain database objects -- Execute stored procedures -- Format output from SQL commands -- Execute batch scripts -- Execute OS commands -- Record output +EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: -For detailed information about the features supported by Advanced Server, consult the complete library of Advanced Server guides available at: - -[https://www.enterprisedb.com/docs](/epas/latest/) +- Querying certain database objects +- Executing stored procedures +- Formatting output from SQL commands +- Executing batch scripts +- Executing OS commands +- Recording output
From 6a3e267bc3008b1e789a63e9da451be4009e190a Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 10:20:41 -0500 Subject: [PATCH 12/29] Setting up v38 --- .../docs/edb_plus/38/01_release_notes.mdx | 10 ++++++++++ .../01_installing_prereq.mdx | 0 .../02_rpm_installation.mdx | 0 .../38/{ => 02_installation}/03_using_gui.mdx | 0 .../docs/edb_plus/38/02_installation/index.mdx | 12 ++++++++++++ .../38}/04_using_edb_plus.mdx | 0 .../38}/05_using_edb_plus_with_ssl.mdx | 0 .../38}/06_command_summary.mdx | 0 .../advanced_server_installation_details.png | 0 .../edb_plus => edb_plus/38}/images/edb_logo.png | 0 .../edb_plus => edb_plus/38}/images/edb_logo.svg | 0 .../38}/images/edb_plus_welcome.png | 0 .../38}/images/edb_plus_welcome_1.png | 0 .../38}/images/installation_complete.png | 0 .../38}/images/installation_directory.png | 0 .../38}/images/ready_to_install.png | 0 product_docs/docs/edb_plus/38/index.mdx | 11 ++++++++--- .../docs/epas/12/edb_plus/02_edb_plus.mdx | 16 ---------------- 18 files changed, 30 insertions(+), 19 deletions(-) create mode 100644 product_docs/docs/edb_plus/38/01_release_notes.mdx rename product_docs/docs/edb_plus/38/{ => 02_installation}/01_installing_prereq.mdx (100%) rename product_docs/docs/edb_plus/38/{ => 02_installation}/02_rpm_installation.mdx (100%) rename product_docs/docs/edb_plus/38/{ => 02_installation}/03_using_gui.mdx (100%) create mode 100644 product_docs/docs/edb_plus/38/02_installation/index.mdx rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/04_using_edb_plus.mdx (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/05_using_edb_plus_with_ssl.mdx (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/06_command_summary.mdx (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/images/advanced_server_installation_details.png (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/images/edb_logo.png (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/images/edb_logo.svg (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/images/edb_plus_welcome.png (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/images/edb_plus_welcome_1.png (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/images/installation_complete.png (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/images/installation_directory.png (100%) rename product_docs/docs/{epas/12/edb_plus => edb_plus/38}/images/ready_to_install.png (100%) delete mode 100644 product_docs/docs/epas/12/edb_plus/02_edb_plus.mdx diff --git a/product_docs/docs/edb_plus/38/01_release_notes.mdx b/product_docs/docs/edb_plus/38/01_release_notes.mdx new file mode 100644 index 00000000000..de2b4b63375 --- /dev/null +++ b/product_docs/docs/edb_plus/38/01_release_notes.mdx @@ -0,0 +1,10 @@ +--- +navTitle: Release Notes +title: "EDB*Plus Version 38 Release Notes" +--- + +New features, enhancements, bug fixes, and other changes in EDB*Plus 38 include: + +| Type | Description | +| ----------- | -------------------------------------------------------------- | +| Enhancement | Support for new version of EDB Postgres Advanced Server 12.1.1 | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/38/01_installing_prereq.mdx b/product_docs/docs/edb_plus/38/02_installation/01_installing_prereq.mdx similarity index 100% rename from product_docs/docs/edb_plus/38/01_installing_prereq.mdx rename to product_docs/docs/edb_plus/38/02_installation/01_installing_prereq.mdx diff --git a/product_docs/docs/edb_plus/38/02_rpm_installation.mdx b/product_docs/docs/edb_plus/38/02_installation/02_rpm_installation.mdx similarity index 100% rename from product_docs/docs/edb_plus/38/02_rpm_installation.mdx rename to product_docs/docs/edb_plus/38/02_installation/02_rpm_installation.mdx diff --git a/product_docs/docs/edb_plus/38/03_using_gui.mdx b/product_docs/docs/edb_plus/38/02_installation/03_using_gui.mdx similarity index 100% rename from product_docs/docs/edb_plus/38/03_using_gui.mdx rename to product_docs/docs/edb_plus/38/02_installation/03_using_gui.mdx diff --git a/product_docs/docs/edb_plus/38/02_installation/index.mdx b/product_docs/docs/edb_plus/38/02_installation/index.mdx new file mode 100644 index 00000000000..6c03791b8cc --- /dev/null +++ b/product_docs/docs/edb_plus/38/02_installation/index.mdx @@ -0,0 +1,12 @@ +--- +title: "Installing EDB*Plus" + +--- + +You can use an RPM installer or a graphical installer to add EDB*Plus to your Advanced Server installation. + +
+ +installing_prereq rpm_installation using_gui + + diff --git a/product_docs/docs/epas/12/edb_plus/04_using_edb_plus.mdx b/product_docs/docs/edb_plus/38/04_using_edb_plus.mdx similarity index 100% rename from product_docs/docs/epas/12/edb_plus/04_using_edb_plus.mdx rename to product_docs/docs/edb_plus/38/04_using_edb_plus.mdx diff --git a/product_docs/docs/epas/12/edb_plus/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/38/05_using_edb_plus_with_ssl.mdx similarity index 100% rename from product_docs/docs/epas/12/edb_plus/05_using_edb_plus_with_ssl.mdx rename to product_docs/docs/edb_plus/38/05_using_edb_plus_with_ssl.mdx diff --git a/product_docs/docs/epas/12/edb_plus/06_command_summary.mdx b/product_docs/docs/edb_plus/38/06_command_summary.mdx similarity index 100% rename from product_docs/docs/epas/12/edb_plus/06_command_summary.mdx rename to product_docs/docs/edb_plus/38/06_command_summary.mdx diff --git a/product_docs/docs/epas/12/edb_plus/images/advanced_server_installation_details.png b/product_docs/docs/edb_plus/38/images/advanced_server_installation_details.png similarity index 100% rename from product_docs/docs/epas/12/edb_plus/images/advanced_server_installation_details.png rename to product_docs/docs/edb_plus/38/images/advanced_server_installation_details.png diff --git a/product_docs/docs/epas/12/edb_plus/images/edb_logo.png b/product_docs/docs/edb_plus/38/images/edb_logo.png similarity index 100% rename from product_docs/docs/epas/12/edb_plus/images/edb_logo.png rename to product_docs/docs/edb_plus/38/images/edb_logo.png diff --git a/product_docs/docs/epas/12/edb_plus/images/edb_logo.svg b/product_docs/docs/edb_plus/38/images/edb_logo.svg similarity index 100% rename from product_docs/docs/epas/12/edb_plus/images/edb_logo.svg rename to product_docs/docs/edb_plus/38/images/edb_logo.svg diff --git a/product_docs/docs/epas/12/edb_plus/images/edb_plus_welcome.png b/product_docs/docs/edb_plus/38/images/edb_plus_welcome.png similarity index 100% rename from product_docs/docs/epas/12/edb_plus/images/edb_plus_welcome.png rename to product_docs/docs/edb_plus/38/images/edb_plus_welcome.png diff --git a/product_docs/docs/epas/12/edb_plus/images/edb_plus_welcome_1.png b/product_docs/docs/edb_plus/38/images/edb_plus_welcome_1.png similarity index 100% rename from product_docs/docs/epas/12/edb_plus/images/edb_plus_welcome_1.png rename to product_docs/docs/edb_plus/38/images/edb_plus_welcome_1.png diff --git a/product_docs/docs/epas/12/edb_plus/images/installation_complete.png b/product_docs/docs/edb_plus/38/images/installation_complete.png similarity index 100% rename from product_docs/docs/epas/12/edb_plus/images/installation_complete.png rename to product_docs/docs/edb_plus/38/images/installation_complete.png diff --git a/product_docs/docs/epas/12/edb_plus/images/installation_directory.png b/product_docs/docs/edb_plus/38/images/installation_directory.png similarity index 100% rename from product_docs/docs/epas/12/edb_plus/images/installation_directory.png rename to product_docs/docs/edb_plus/38/images/installation_directory.png diff --git a/product_docs/docs/epas/12/edb_plus/images/ready_to_install.png b/product_docs/docs/edb_plus/38/images/ready_to_install.png similarity index 100% rename from product_docs/docs/epas/12/edb_plus/images/ready_to_install.png rename to product_docs/docs/edb_plus/38/images/ready_to_install.png diff --git a/product_docs/docs/edb_plus/38/index.mdx b/product_docs/docs/edb_plus/38/index.mdx index 7930a6b3298..1084a910053 100644 --- a/product_docs/docs/edb_plus/38/index.mdx +++ b/product_docs/docs/edb_plus/38/index.mdx @@ -3,10 +3,15 @@ title: "Installing EDB*Plus" --- -You can use an RPM installer or a graphical installer to add EDB*Plus to your Advanced Server installation. +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. -
+EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: -installing_prereq rpm_installation using_gui +- Query certain database objects +- Execute stored procedures +- Format output from SQL commands +- Execute batch scripts +- Execute OS commands +- Record output
\ No newline at end of file diff --git a/product_docs/docs/epas/12/edb_plus/02_edb_plus.mdx b/product_docs/docs/epas/12/edb_plus/02_edb_plus.mdx deleted file mode 100644 index da9839b85e4..00000000000 --- a/product_docs/docs/epas/12/edb_plus/02_edb_plus.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "EDB*Plus" ---- - - - -EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. - -EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: - -- Querying certain database objects -- Executing stored procedures -- Formatting output from SQL commands -- Executing batch scripts -- Executing OS commands -- Recording output From 7edc6b673b786d240ec43e6f363914ba7d6c0692 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 10:34:43 -0500 Subject: [PATCH 13/29] cleanup on v38 --- product_docs/docs/edb_plus/38/index.mdx | 4 +++- product_docs/docs/edb_plus/39/index.mdx | 6 ++++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/product_docs/docs/edb_plus/38/index.mdx b/product_docs/docs/edb_plus/38/index.mdx index 1084a910053..7dc57cce64c 100644 --- a/product_docs/docs/edb_plus/38/index.mdx +++ b/product_docs/docs/edb_plus/38/index.mdx @@ -1,5 +1,7 @@ --- -title: "Installing EDB*Plus" +title: "EDB*Plus" +description: EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server. +navTitle: EDB*Plus --- diff --git a/product_docs/docs/edb_plus/39/index.mdx b/product_docs/docs/edb_plus/39/index.mdx index 6f68231f66f..ce7528e4d74 100644 --- a/product_docs/docs/edb_plus/39/index.mdx +++ b/product_docs/docs/edb_plus/39/index.mdx @@ -1,6 +1,8 @@ --- -navTitle: EDB*Plus — CLI -title: "EDB*Plus User's Guide" +title: "EDB*Plus" +description: EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server. +navTitle: EDB*Plus + legacyRedirects: - "/edb-docs/p/edbplus/39" - "/edb-docs/p/edbplus/38" From c7af836be0a831b5be405db9da9743a4802cb9ca Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 11:17:18 -0500 Subject: [PATCH 14/29] removed a hanging div tag --- product_docs/docs/edb_plus/38/index.mdx | 2 -- 1 file changed, 2 deletions(-) diff --git a/product_docs/docs/edb_plus/38/index.mdx b/product_docs/docs/edb_plus/38/index.mdx index 7dc57cce64c..818c1c8703d 100644 --- a/product_docs/docs/edb_plus/38/index.mdx +++ b/product_docs/docs/edb_plus/38/index.mdx @@ -15,5 +15,3 @@ EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide var - Execute batch scripts - Execute OS commands - Record output - -
\ No newline at end of file From 13b152bdffa908f539dc5592f7bbb84897226ac2 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 11:25:20 -0500 Subject: [PATCH 15/29] fixed another open div tag --- product_docs/docs/edb_plus/38/02_installation/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/edb_plus/38/02_installation/index.mdx b/product_docs/docs/edb_plus/38/02_installation/index.mdx index 6c03791b8cc..7930a6b3298 100644 --- a/product_docs/docs/edb_plus/38/02_installation/index.mdx +++ b/product_docs/docs/edb_plus/38/02_installation/index.mdx @@ -9,4 +9,4 @@ You can use an RPM installer or a graphical installer to add EDB*Plus to your Ad installing_prereq rpm_installation using_gui - +
\ No newline at end of file From b01ee933c998e5e3cb4b3bd5f0d01952e9d6b14c Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 11:39:18 -0500 Subject: [PATCH 16/29] experiments with div tags To resolve blank pages in rendered content? --- product_docs/docs/edb_plus/38/01_release_notes.mdx | 1 + product_docs/docs/edb_plus/38/02_installation/index.mdx | 2 ++ 2 files changed, 3 insertions(+) diff --git a/product_docs/docs/edb_plus/38/01_release_notes.mdx b/product_docs/docs/edb_plus/38/01_release_notes.mdx index de2b4b63375..6fdc95edc3c 100644 --- a/product_docs/docs/edb_plus/38/01_release_notes.mdx +++ b/product_docs/docs/edb_plus/38/01_release_notes.mdx @@ -2,6 +2,7 @@ navTitle: Release Notes title: "EDB*Plus Version 38 Release Notes" --- + New features, enhancements, bug fixes, and other changes in EDB*Plus 38 include: diff --git a/product_docs/docs/edb_plus/38/02_installation/index.mdx b/product_docs/docs/edb_plus/38/02_installation/index.mdx index 7930a6b3298..3b495295dd2 100644 --- a/product_docs/docs/edb_plus/38/02_installation/index.mdx +++ b/product_docs/docs/edb_plus/38/02_installation/index.mdx @@ -5,6 +5,8 @@ title: "Installing EDB*Plus" You can use an RPM installer or a graphical installer to add EDB*Plus to your Advanced Server installation. + +
installing_prereq rpm_installation using_gui From cc3c87291342ccf3761355948bf271f1c3be587c Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 11:50:05 -0500 Subject: [PATCH 17/29] setting up version 37 --- .../docs/edb_plus/37/01_release_notes.mdx | 11 +++++++++++ product_docs/docs/edb_plus/37/02_edb_plus.mdx | 16 ---------------- product_docs/docs/edb_plus/37/index.mdx | 8 +++----- 3 files changed, 14 insertions(+), 21 deletions(-) create mode 100644 product_docs/docs/edb_plus/37/01_release_notes.mdx delete mode 100644 product_docs/docs/edb_plus/37/02_edb_plus.mdx diff --git a/product_docs/docs/edb_plus/37/01_release_notes.mdx b/product_docs/docs/edb_plus/37/01_release_notes.mdx new file mode 100644 index 00000000000..95d7f67a4dc --- /dev/null +++ b/product_docs/docs/edb_plus/37/01_release_notes.mdx @@ -0,0 +1,11 @@ +--- +navTitle: Release Notes +title: "EDB*Plus Version 37 Release Notes" +--- + + +New features, enhancements, bug fixes, and other changes in EDB*Plus 37 include: + +| Type | Description | +| ----------- | -------------------------------------------------------------- | +| Enhancement | Support for new version of EDB Postgres Advanced Server 11.1.7 | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/37/02_edb_plus.mdx b/product_docs/docs/edb_plus/37/02_edb_plus.mdx deleted file mode 100644 index da9839b85e4..00000000000 --- a/product_docs/docs/edb_plus/37/02_edb_plus.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: "EDB*Plus" ---- - - - -EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. - -EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: - -- Querying certain database objects -- Executing stored procedures -- Formatting output from SQL commands -- Executing batch scripts -- Executing OS commands -- Recording output diff --git a/product_docs/docs/edb_plus/37/index.mdx b/product_docs/docs/edb_plus/37/index.mdx index 366f92ea670..bc7b8965a32 100644 --- a/product_docs/docs/edb_plus/37/index.mdx +++ b/product_docs/docs/edb_plus/37/index.mdx @@ -6,7 +6,9 @@ directoryDefaults: description: "EDB*Plus Documentation and release notes." --- -This guide describes how to connect to an Advanced Server database using EDB\*Plus. EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server that accepts SQL commands that allow you to: +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. + +EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: - Query certain database objects - Execute stored procedures @@ -15,10 +17,6 @@ This guide describes how to connect to an Advanced Server database using EDB\*Pl - Execute OS commands - Record output -For detailed information about the features supported by Advanced Server, consult the complete library of Advanced Server guides available at: - - -
introduction edb_plus installing_edb_plus using_edb_plus using_edb_plus_with_ssl command_summary conclusion From d228e1dffd58c00df607e27d133bd91d2ac31d24 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 11:57:26 -0500 Subject: [PATCH 18/29] Setting up version 36 --- .../docs/edb_plus/36/01_release_notes.mdx | 13 +++++++++ product_docs/docs/edb_plus/36/02_edb_plus.mdx | 28 ------------------- product_docs/docs/edb_plus/36/index.mdx | 10 +++---- product_docs/docs/edb_plus/37/index.mdx | 2 +- 4 files changed, 18 insertions(+), 35 deletions(-) create mode 100644 product_docs/docs/edb_plus/36/01_release_notes.mdx delete mode 100644 product_docs/docs/edb_plus/36/02_edb_plus.mdx diff --git a/product_docs/docs/edb_plus/36/01_release_notes.mdx b/product_docs/docs/edb_plus/36/01_release_notes.mdx new file mode 100644 index 00000000000..95314a61cb7 --- /dev/null +++ b/product_docs/docs/edb_plus/36/01_release_notes.mdx @@ -0,0 +1,13 @@ +--- +navTitle: Release Notes +title: "EDB*Plus Version 36 Release Notes" +--- + + +New features, enhancements, bug fixes, and other changes in EDB*Plus 36 include: + +| Type | Description | +| ----------- | ----------------------------------------------------------------------------------------------------------------------- | +| Enhancement | Support for new version of EDB Postgres Advanced Server 10.0.0 | +| Enhancement | Advanced Server supports use of Internet Protocol version 6 (IPv6) to log into EDB\*Plus. | +| Enhancement | Advanced Server supports use of a Secure Sockets Layer (SSL) connection from EDB\*Plus to the Advanced Server database. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/36/02_edb_plus.mdx b/product_docs/docs/edb_plus/36/02_edb_plus.mdx deleted file mode 100644 index 21749c8393b..00000000000 --- a/product_docs/docs/edb_plus/36/02_edb_plus.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: "EDB*Plus" -legacyRedirectsGenerated: - # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. - - "/edb-docs/d/edb-postgres-advanced-server/user-guides/database-compatibility-for-oracle-developers-guide/10/Database_Compatibility_for_Oracle_Developers_Guide_10.1.003.html" - - "/edb-docs/d/edb-postgres-advanced-server/reference/database-compatibility-for-oracle-developers-reference-guide/10/Database_Compatibility_for_Oracle_Developers_Reference_Guide.1.003.html" ---- - - - -EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. - -EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: - -- Querying certain database objects -- Executing stored procedures -- Formatting output from SQL commands -- Executing batch scripts -- Executing OS commands -- Recording output - -### What's New - -The following features have been added to EDB*Plus version 36: - -- Advanced Server supports use of Internet Protocol version 6 (IPv6) to log into EDB\*Plus. For more information, see [Using EDB Plus](04_using_edb_plus/#using_edb_plus). -- Advanced Server supports use of a Secure Sockets Layer (SSL) connection from EDB\*Plus to the Advanced Server database. For more information, see [Using a Secure Sockets Layer (SSL) Connection](05_using_edb_plus_with_ssl/#using_edb_plus_with_ssl). - diff --git a/product_docs/docs/edb_plus/36/index.mdx b/product_docs/docs/edb_plus/36/index.mdx index 366f92ea670..9d062bad865 100644 --- a/product_docs/docs/edb_plus/36/index.mdx +++ b/product_docs/docs/edb_plus/36/index.mdx @@ -1,12 +1,14 @@ --- -navTitle: EDB*Plus — CLI +navTitle: EDB*Plus title: "EDB*Plus User's Guide" directoryDefaults: description: "EDB*Plus Documentation and release notes." --- -This guide describes how to connect to an Advanced Server database using EDB\*Plus. EDB\*Plus provides a command line user interface to EDB Postgres Advanced Server that accepts SQL commands that allow you to: +EDB\*Plus is a utility program that provides a command line user interface to EDB Postgres Advanced Server. EDB\*Plus accepts SQL commands, SPL anonymous blocks, and EDB\*Plus commands. + +EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: - Query certain database objects - Execute stored procedures @@ -15,10 +17,6 @@ This guide describes how to connect to an Advanced Server database using EDB\*Pl - Execute OS commands - Record output -For detailed information about the features supported by Advanced Server, consult the complete library of Advanced Server guides available at: - - -
introduction edb_plus installing_edb_plus using_edb_plus using_edb_plus_with_ssl command_summary conclusion diff --git a/product_docs/docs/edb_plus/37/index.mdx b/product_docs/docs/edb_plus/37/index.mdx index bc7b8965a32..9d062bad865 100644 --- a/product_docs/docs/edb_plus/37/index.mdx +++ b/product_docs/docs/edb_plus/37/index.mdx @@ -1,5 +1,5 @@ --- -navTitle: EDB*Plus — CLI +navTitle: EDB*Plus title: "EDB*Plus User's Guide" directoryDefaults: From 7e7c35b7e0aae1281882bfb2ee9ed4b7623a3849 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Tue, 15 Feb 2022 12:01:00 -0500 Subject: [PATCH 19/29] tweaks to titles for consistency --- product_docs/docs/edb_plus/36/index.mdx | 2 +- product_docs/docs/edb_plus/37/index.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/product_docs/docs/edb_plus/36/index.mdx b/product_docs/docs/edb_plus/36/index.mdx index 9d062bad865..4d7acf74f82 100644 --- a/product_docs/docs/edb_plus/36/index.mdx +++ b/product_docs/docs/edb_plus/36/index.mdx @@ -1,6 +1,6 @@ --- navTitle: EDB*Plus -title: "EDB*Plus User's Guide" +title: "EDB*Plus" directoryDefaults: description: "EDB*Plus Documentation and release notes." diff --git a/product_docs/docs/edb_plus/37/index.mdx b/product_docs/docs/edb_plus/37/index.mdx index 9d062bad865..4d7acf74f82 100644 --- a/product_docs/docs/edb_plus/37/index.mdx +++ b/product_docs/docs/edb_plus/37/index.mdx @@ -1,6 +1,6 @@ --- navTitle: EDB*Plus -title: "EDB*Plus User's Guide" +title: "EDB*Plus" directoryDefaults: description: "EDB*Plus Documentation and release notes." From 71047aa45999bd51b99adb4ca33bd68ad7ee3b49 Mon Sep 17 00:00:00 2001 From: David Wicinas <93669463+dwicinas@users.noreply.github.com> Date: Wed, 16 Feb 2022 09:24:34 -0500 Subject: [PATCH 20/29] minor edits --- product_docs/docs/edb_plus/36/index.mdx | 12 ++++++------ product_docs/docs/edb_plus/37/index.mdx | 12 ++++++------ product_docs/docs/edb_plus/38/index.mdx | 12 ++++++------ ...1_rel_notes.mdx => 02_edbplus39.01_rel_notes.mdx} | 0 ...0_rel_notes.mdx => 04_edbplus39.00_rel_notes.mdx} | 0 .../docs/edb_plus/39/02a_release_notes/index.mdx | 4 ++-- 6 files changed, 20 insertions(+), 20 deletions(-) rename product_docs/docs/edb_plus/39/02a_release_notes/{04_edbplus39.01_rel_notes.mdx => 02_edbplus39.01_rel_notes.mdx} (100%) rename product_docs/docs/edb_plus/39/02a_release_notes/{02_edbplus39.00_rel_notes.mdx => 04_edbplus39.00_rel_notes.mdx} (100%) diff --git a/product_docs/docs/edb_plus/36/index.mdx b/product_docs/docs/edb_plus/36/index.mdx index 4d7acf74f82..11e1c7987ad 100644 --- a/product_docs/docs/edb_plus/36/index.mdx +++ b/product_docs/docs/edb_plus/36/index.mdx @@ -10,12 +10,12 @@ EDB\*Plus is a utility program that provides a command line user interface to ED EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: -- Query certain database objects -- Execute stored procedures -- Format output from SQL commands -- Execute batch scripts -- Execute OS commands -- Record output +- Querying certain database objects +- Executing stored procedures +- Formatting output from SQL commands +- Executing batch scripts +- Executing OS commands +- Recording output
diff --git a/product_docs/docs/edb_plus/37/index.mdx b/product_docs/docs/edb_plus/37/index.mdx index 4d7acf74f82..11e1c7987ad 100644 --- a/product_docs/docs/edb_plus/37/index.mdx +++ b/product_docs/docs/edb_plus/37/index.mdx @@ -10,12 +10,12 @@ EDB\*Plus is a utility program that provides a command line user interface to ED EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: -- Query certain database objects -- Execute stored procedures -- Format output from SQL commands -- Execute batch scripts -- Execute OS commands -- Record output +- Querying certain database objects +- Executing stored procedures +- Formatting output from SQL commands +- Executing batch scripts +- Executing OS commands +- Recording output
diff --git a/product_docs/docs/edb_plus/38/index.mdx b/product_docs/docs/edb_plus/38/index.mdx index 818c1c8703d..7d8bef86375 100644 --- a/product_docs/docs/edb_plus/38/index.mdx +++ b/product_docs/docs/edb_plus/38/index.mdx @@ -9,9 +9,9 @@ EDB\*Plus is a utility program that provides a command line user interface to ED EDB\*Plus commands are compatible with Oracle SQL\*Plus commands and provide various capabilities including: -- Query certain database objects -- Execute stored procedures -- Format output from SQL commands -- Execute batch scripts -- Execute OS commands -- Record output +- Querying certain database objects +- Executing stored procedures +- Formatting output from SQL commands +- Executing batch scripts +- Executing OS commands +- Recording output diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.01_rel_notes.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.01_rel_notes.mdx rename to product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.01_rel_notes.mdx diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.00_rel_notes.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.00_rel_notes.mdx rename to product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.00_rel_notes.mdx diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx index cfba717526a..42581a0917d 100644 --- a/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx +++ b/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx @@ -10,5 +10,5 @@ The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 39 | Version - | Release Date | | | -------------------------------------- | ------------ | -| [39.01](04_edbplus39.01_rel_notes.mdx) | 2021 Aug 12 | -| [39.00](02_edbplus39.00_rel_notes.mdx) | 2020 Dec 12 | \ No newline at end of file +| [39.01](02_edbplus39.01_rel_notes.mdx) | 2021 Aug 12 | +| [39.00](04_edbplus39.00_rel_notes.mdx) | 2020 Dec 12 | \ No newline at end of file From 5c92bf06be311e3833c3be4b29a113687852e01e Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Wed, 16 Feb 2022 14:12:04 -0500 Subject: [PATCH 21/29] minor cleanup --- product_docs/docs/edb_plus/36/01_release_notes.mdx | 6 +++--- product_docs/docs/edb_plus/37/01_release_notes.mdx | 2 +- product_docs/docs/edb_plus/38/01_release_notes.mdx | 2 +- .../39/02a_release_notes/04_edbplus39.00_rel_notes.mdx | 2 +- product_docs/docs/edb_plus/40/02_release_notes.mdx | 2 +- 5 files changed, 7 insertions(+), 7 deletions(-) diff --git a/product_docs/docs/edb_plus/36/01_release_notes.mdx b/product_docs/docs/edb_plus/36/01_release_notes.mdx index 95314a61cb7..749f8eee097 100644 --- a/product_docs/docs/edb_plus/36/01_release_notes.mdx +++ b/product_docs/docs/edb_plus/36/01_release_notes.mdx @@ -8,6 +8,6 @@ New features, enhancements, bug fixes, and other changes in EDB*Plus 36 include: | Type | Description | | ----------- | ----------------------------------------------------------------------------------------------------------------------- | -| Enhancement | Support for new version of EDB Postgres Advanced Server 10.0.0 | -| Enhancement | Advanced Server supports use of Internet Protocol version 6 (IPv6) to log into EDB\*Plus. | -| Enhancement | Advanced Server supports use of a Secure Sockets Layer (SSL) connection from EDB\*Plus to the Advanced Server database. | \ No newline at end of file +| 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. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/37/01_release_notes.mdx b/product_docs/docs/edb_plus/37/01_release_notes.mdx index 95d7f67a4dc..8718e324cb7 100644 --- a/product_docs/docs/edb_plus/37/01_release_notes.mdx +++ b/product_docs/docs/edb_plus/37/01_release_notes.mdx @@ -8,4 +8,4 @@ New features, enhancements, bug fixes, and other changes in EDB*Plus 37 include: | Type | Description | | ----------- | -------------------------------------------------------------- | -| Enhancement | Support for new version of EDB Postgres Advanced Server 11.1.7 | \ No newline at end of file +| Enhancement | Support for EDB Postgres Advanced Server 11.1.7. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/38/01_release_notes.mdx b/product_docs/docs/edb_plus/38/01_release_notes.mdx index 6fdc95edc3c..62059d0034c 100644 --- a/product_docs/docs/edb_plus/38/01_release_notes.mdx +++ b/product_docs/docs/edb_plus/38/01_release_notes.mdx @@ -8,4 +8,4 @@ New features, enhancements, bug fixes, and other changes in EDB*Plus 38 include: | Type | Description | | ----------- | -------------------------------------------------------------- | -| Enhancement | Support for new version of EDB Postgres Advanced Server 12.1.1 | \ No newline at end of file +| Enhancement | Support for EDB Postgres Advanced Server 12.1.1. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.00_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.00_rel_notes.mdx index 79a0a2483ac..9235de71f4b 100644 --- a/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.00_rel_notes.mdx +++ b/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.00_rel_notes.mdx @@ -7,4 +7,4 @@ New features, enhancements, bug fixes, and other changes in EDB*Plus 39.00 inclu | Type | Description | | ----------- | -------------------------------------------------------------- | -| Enhancement | Support for new version of EDB Postgres Advanced Server 13.1.4 | \ No newline at end of file +| Enhancement | Support for EDB Postgres Advanced Server 13.1.4. | \ No newline at end of file diff --git a/product_docs/docs/edb_plus/40/02_release_notes.mdx b/product_docs/docs/edb_plus/40/02_release_notes.mdx index 6269bbef162..9d4230969b0 100644 --- a/product_docs/docs/edb_plus/40/02_release_notes.mdx +++ b/product_docs/docs/edb_plus/40/02_release_notes.mdx @@ -7,4 +7,4 @@ New features, enhancements, bug fixes, and other changes in EDB*Plus 40 include: | Type | Description | | ----------- | -------------------------------------------------------------- | -| Enhancement | Support for new version of EDB Postgres Advanced Server 14.1.0 | \ No newline at end of file +| Enhancement | Support for EDB Postgres Advanced Server 14.1.0. | \ No newline at end of file From e953a270cd2d8a7cab9713df946a482788f31a52 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Fri, 18 Feb 2022 05:24:49 -0500 Subject: [PATCH 22/29] added epas matrix and updated SSL topic title --- .../36/03_installing_edb_plus/01_installing_prereq.mdx | 6 ++++++ .../docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx | 2 +- .../37/03_installing_edb_plus/01_installing_prereq.mdx | 8 ++++++++ .../docs/edb_plus/37/05_using_edb_plus_with_ssl.mdx | 2 +- .../38/02_installation/01_installing_prereq.mdx | 8 ++++++++ .../docs/edb_plus/38/05_using_edb_plus_with_ssl.mdx | 2 +- .../docs/edb_plus/39/03_installing_edb_plus.mdx | 10 ++++++++++ .../docs/edb_plus/39/05_using_edb_plus_with_ssl.mdx | 2 +- .../docs/edb_plus/40/03_installing_edb_plus.mdx | 2 +- .../docs/edb_plus/40/05_using_edb_plus_with_ssl.mdx | 2 +- 10 files changed, 38 insertions(+), 6 deletions(-) diff --git a/product_docs/docs/edb_plus/36/03_installing_edb_plus/01_installing_prereq.mdx b/product_docs/docs/edb_plus/36/03_installing_edb_plus/01_installing_prereq.mdx index 6ce9a2634bd..2fffd9c7947 100644 --- a/product_docs/docs/edb_plus/36/03_installing_edb_plus/01_installing_prereq.mdx +++ b/product_docs/docs/edb_plus/36/03_installing_edb_plus/01_installing_prereq.mdx @@ -5,6 +5,12 @@ title: "Installation Prerequisites" +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 diff --git a/product_docs/docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx index db2553a2332..084302cae50 100644 --- a/product_docs/docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx +++ b/product_docs/docs/edb_plus/36/05_using_edb_plus_with_ssl.mdx @@ -1,5 +1,5 @@ --- -title: "Using a Secure Sockets Layer (SSL) Connection" +title: "Using a SSL Connection" --- diff --git a/product_docs/docs/edb_plus/37/03_installing_edb_plus/01_installing_prereq.mdx b/product_docs/docs/edb_plus/37/03_installing_edb_plus/01_installing_prereq.mdx index 6ce9a2634bd..17a909cf117 100644 --- a/product_docs/docs/edb_plus/37/03_installing_edb_plus/01_installing_prereq.mdx +++ b/product_docs/docs/edb_plus/37/03_installing_edb_plus/01_installing_prereq.mdx @@ -5,6 +5,14 @@ title: "Installation Prerequisites" +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. + +| EDB*Plus | EPAS 14 | EPAS 13 | EPAS 12 | EPAS 11 | EPAS 10 | +| -------- | ------- | ------- | ------- | ------- | ------- | +| 37 | N | N | Y | Y | Y | +| 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 diff --git a/product_docs/docs/edb_plus/37/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/37/05_using_edb_plus_with_ssl.mdx index 844b32cd631..b0a39eef7ab 100644 --- a/product_docs/docs/edb_plus/37/05_using_edb_plus_with_ssl.mdx +++ b/product_docs/docs/edb_plus/37/05_using_edb_plus_with_ssl.mdx @@ -1,5 +1,5 @@ --- -title: "Using a Secure Sockets Layer (SSL) Connection" +title: "Using a SSL Connection" --- diff --git a/product_docs/docs/edb_plus/38/02_installation/01_installing_prereq.mdx b/product_docs/docs/edb_plus/38/02_installation/01_installing_prereq.mdx index 78f1a0b665a..c70f0936779 100644 --- a/product_docs/docs/edb_plus/38/02_installation/01_installing_prereq.mdx +++ b/product_docs/docs/edb_plus/38/02_installation/01_installing_prereq.mdx @@ -4,6 +4,14 @@ title: "Installation Prerequisites" +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. + +| EDB*Plus | EPAS 14 | EPAS 13 | EPAS 12 | EPAS 11 | EPAS 10 | +| -------- | ------- | ------- | ------- | ------- | ------- | +| 38 | N | Y | Y | Y | Y | +| 37 | N | N | Y | Y | Y | +| 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: diff --git a/product_docs/docs/edb_plus/38/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/38/05_using_edb_plus_with_ssl.mdx index 039a92454a1..b7f38a21edc 100644 --- a/product_docs/docs/edb_plus/38/05_using_edb_plus_with_ssl.mdx +++ b/product_docs/docs/edb_plus/38/05_using_edb_plus_with_ssl.mdx @@ -1,5 +1,5 @@ --- -title: "Using a Secure Sockets Layer (SSL) Connection" +title: "Using a SSL Connection" --- diff --git a/product_docs/docs/edb_plus/39/03_installing_edb_plus.mdx b/product_docs/docs/edb_plus/39/03_installing_edb_plus.mdx index b10dd484fee..6a430503c10 100644 --- a/product_docs/docs/edb_plus/39/03_installing_edb_plus.mdx +++ b/product_docs/docs/edb_plus/39/03_installing_edb_plus.mdx @@ -13,6 +13,16 @@ legacyRedirectsGenerated: +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. + +| EDB*Plus | EPAS 14 | EPAS 13 | EPAS 12 | EPAS 11 | EPAS 10 | +| -------- | ------- | ------- | ------- | ------- | ------- | +| 39 | N | Y | Y | Y | Y | +| 38 | N | Y | Y | Y | Y | +| 37 | N | N | Y | Y | Y | +| 36 | N | N | N | Y | Y | + + You can use an RPM installer or a graphical installer to add EDB\*Plus to your Advanced Server installation. ## Installation Prerequisites diff --git a/product_docs/docs/edb_plus/39/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/39/05_using_edb_plus_with_ssl.mdx index 251c9086928..472068e33e4 100644 --- a/product_docs/docs/edb_plus/39/05_using_edb_plus_with_ssl.mdx +++ b/product_docs/docs/edb_plus/39/05_using_edb_plus_with_ssl.mdx @@ -1,5 +1,5 @@ --- -title: "Using a Secure Sockets Layer (SSL) Connection" +title: "Using a SSL Connection" legacyRedirectsGenerated: # This list is generated by a script. If you need add entries, use the `legacyRedirects` key. - "/edb-docs/d/edbplus/user-guides/edbplus-users-guide/39/using_edb_plus_with_ssl.html" 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 index 389d58c505f..e5fecf0d888 100644 --- 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" -This table lists the latest 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 (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 | | -------- | ------- | ------- | ------- | ------- | ------- | diff --git a/product_docs/docs/edb_plus/40/05_using_edb_plus_with_ssl.mdx b/product_docs/docs/edb_plus/40/05_using_edb_plus_with_ssl.mdx index 65bf03a4551..8e2b8c827c3 100644 --- a/product_docs/docs/edb_plus/40/05_using_edb_plus_with_ssl.mdx +++ b/product_docs/docs/edb_plus/40/05_using_edb_plus_with_ssl.mdx @@ -1,5 +1,5 @@ --- -title: "Using a Secure Sockets Layer (SSL) Connection" +title: "Using a SSL Connection" --- From 11a8fa22cdd6cfe6aae656c4a865f488c9b54cde Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Fri, 18 Feb 2022 10:24:40 -0500 Subject: [PATCH 23/29] added 39.0.2 release notes --- .../02a_release_notes/08_edbplus39.02_rel_notes.mdx | 12 ++++++++++++ ...1_rel_notes.mdx => 09_edbplus39.01_rel_notes.mdx} | 6 +++--- ...0_rel_notes.mdx => 10_edbplus39.00_rel_notes.mdx} | 0 .../docs/edb_plus/39/02a_release_notes/index.mdx | 7 ++++--- 4 files changed, 19 insertions(+), 6 deletions(-) create mode 100644 product_docs/docs/edb_plus/39/02a_release_notes/08_edbplus39.02_rel_notes.mdx rename product_docs/docs/edb_plus/39/02a_release_notes/{02_edbplus39.01_rel_notes.mdx => 09_edbplus39.01_rel_notes.mdx} (90%) rename product_docs/docs/edb_plus/39/02a_release_notes/{04_edbplus39.00_rel_notes.mdx => 10_edbplus39.00_rel_notes.mdx} (100%) diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/08_edbplus39.02_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/08_edbplus39.02_rel_notes.mdx new file mode 100644 index 00000000000..6864525d5f0 --- /dev/null +++ b/product_docs/docs/edb_plus/39/02a_release_notes/08_edbplus39.02_rel_notes.mdx @@ -0,0 +1,12 @@ +--- +navTitle: Version 39.0.2 +title: "EDB*Plus Version 39.0.2 Release Notes" +--- + +New features, enhancements, bug fixes, and other changes in EDB*Plus 39.0.2 include: + +| Type | Description | +| ------------ | ---------------------------------------------------------------------------------------| +| Enhancement | The display format for a decimal point is now compatible with Oracle SQL*Plus [75092]. | +| Bug Fix | Describe command no longer fails for a schema qualified SYNONYM name [72994]. | + diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.01_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/09_edbplus39.01_rel_notes.mdx similarity index 90% rename from product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.01_rel_notes.mdx rename to product_docs/docs/edb_plus/39/02a_release_notes/09_edbplus39.01_rel_notes.mdx index 5332ee23557..972901dd6f6 100644 --- a/product_docs/docs/edb_plus/39/02a_release_notes/02_edbplus39.01_rel_notes.mdx +++ b/product_docs/docs/edb_plus/39/02a_release_notes/09_edbplus39.01_rel_notes.mdx @@ -1,9 +1,9 @@ --- -navTitle: Version 39.01 -title: "EDB*Plus Version 39.01 Release Notes" +navTitle: Version 39.0.1 +title: "EDB*Plus Version 39.0.1 Release Notes" --- -New features, enhancements, bug fixes, and other changes in EDB*Plus 39.01 include: +New features, enhancements, bug fixes, and other changes in EDB*Plus 39.0.1 include: | Type | Description | | ------- | ----------------------------------------------------------------------------------------------------------------- | diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.00_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/10_edbplus39.00_rel_notes.mdx similarity index 100% rename from product_docs/docs/edb_plus/39/02a_release_notes/04_edbplus39.00_rel_notes.mdx rename to product_docs/docs/edb_plus/39/02a_release_notes/10_edbplus39.00_rel_notes.mdx diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx index 42581a0917d..99bd74cf2f4 100644 --- a/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx +++ b/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx @@ -8,7 +8,8 @@ EDB\*Plus is a utility program that provides a command line user interface to ED The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 39. The release notes in this section provide information on what was new in each release. -| Version - | Release Date | | +| Version | Release Date | | -------------------------------------- | ------------ | -| [39.01](02_edbplus39.01_rel_notes.mdx) | 2021 Aug 12 | -| [39.00](04_edbplus39.00_rel_notes.mdx) | 2020 Dec 12 | \ No newline at end of file +| [39.02](08_edbplus39.02_rel_notes.mdx) | 2022 Feb 18 | +| [39.01](09_edbplus39.01_rel_notes.mdx) | 2021 Aug 12 | +| [39.00](10_edbplus39.00_rel_notes.mdx) | 2020 Dec 12 | \ No newline at end of file From 29142b14a5b8102c5614925e743502461c554758 Mon Sep 17 00:00:00 2001 From: drothery-edb Date: Fri, 18 Feb 2022 12:25:23 -0500 Subject: [PATCH 24/29] fixed formatting of version numbers --- .../39/02a_release_notes/10_edbplus39.00_rel_notes.mdx | 4 ++-- product_docs/docs/edb_plus/39/02a_release_notes/index.mdx | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/10_edbplus39.00_rel_notes.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/10_edbplus39.00_rel_notes.mdx index 9235de71f4b..52848a39622 100644 --- a/product_docs/docs/edb_plus/39/02a_release_notes/10_edbplus39.00_rel_notes.mdx +++ b/product_docs/docs/edb_plus/39/02a_release_notes/10_edbplus39.00_rel_notes.mdx @@ -1,6 +1,6 @@ --- -navTitle: Version 39.00 -title: "EDB*Plus Version 39.00 Release Notes" +navTitle: Version 39.0.0 +title: "EDB*Plus Version 39.0.0 Release Notes" --- New features, enhancements, bug fixes, and other changes in EDB*Plus 39.00 include: diff --git a/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx b/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx index 99bd74cf2f4..01b59489f23 100644 --- a/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx +++ b/product_docs/docs/edb_plus/39/02a_release_notes/index.mdx @@ -10,6 +10,6 @@ The EDB\*Plus documentation describes the latest version of EDB\*Plus Version 39 | Version | Release Date | | -------------------------------------- | ------------ | -| [39.02](08_edbplus39.02_rel_notes.mdx) | 2022 Feb 18 | -| [39.01](09_edbplus39.01_rel_notes.mdx) | 2021 Aug 12 | -| [39.00](10_edbplus39.00_rel_notes.mdx) | 2020 Dec 12 | \ No newline at end of file +| [39.0.2](08_edbplus39.02_rel_notes.mdx)| 2022 Feb 18 | +| [39.0.1](09_edbplus39.01_rel_notes.mdx)| 2021 Aug 12 | +| [39.0.0](10_edbplus39.00_rel_notes.mdx) | 2020 Dec 12 | \ No newline at end of file From 8cf8ea14276666ec626e8635e9ae90635cd0b201 Mon Sep 17 00:00:00 2001 From: gunnar Date: Sun, 13 Feb 2022 13:19:17 +0100 Subject: [PATCH 25/29] Update step01-db-setup.mdx enabling remote access to your PostgreSQL Server (set `listen_addresses = '*'` in `postgresql.conf`) is missing. having not set this up will cause complete failure. Troubleshooting may cost an inexperienced PostgreSQL hours. --- .../barman/single-server-streaming/step01-db-setup.mdx | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx b/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx index ddef588eaeb..89dbe0b948c 100644 --- a/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx +++ b/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx @@ -102,6 +102,12 @@ host all all all md5 host replication streaming_barman all md5 ``` +### enable remote access to your PostgreSQL Server + +set `listen_addresses = '*'` in `postgresql.conf` + +otherwise the barman-backup server will not be able to communicate with your PostgreSQL server at all. + ### 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 use psql to check the current settings: From 22d03428a90b085cb1ee26085f15151fa1948903 Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Fri, 18 Feb 2022 10:56:25 -0700 Subject: [PATCH 26/29] Expand a bit on the remote access instructions --- .../step01-db-setup.mdx | 34 +++++++++++++++---- 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx b/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx index 89dbe0b948c..7ecb4791c21 100644 --- a/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx +++ b/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx @@ -102,20 +102,42 @@ host all all all md5 host replication streaming_barman all md5 ``` -### enable remote access to your PostgreSQL Server +### Enable remote access to your PostgreSQL Server -set `listen_addresses = '*'` in `postgresql.conf` +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. -otherwise the barman-backup server will not be able to communicate with your PostgreSQL server at all. +We'll use psql to check this setting: -### Database settings for streaming +```shell +psql -d pagila +``` -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: +The relevant configuration parameter is [`listen_addresses`](https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-LISTEN-ADDRESSES): ```shell -psql -d pagila +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. + +```shell +pagila=# 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; From 1db8a2a3cb6adde2fd07fee0009f03d8a5079991 Mon Sep 17 00:00:00 2001 From: Josh Heyer <63653723+josh-heyer@users.noreply.github.com> Date: Fri, 18 Feb 2022 10:58:01 -0700 Subject: [PATCH 27/29] remove cruft from my last commit ...i need more coffee --- .../barman/single-server-streaming/step01-db-setup.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx b/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx index 7ecb4791c21..6ffd5dc14ef 100644 --- a/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx +++ b/advocacy_docs/supported-open-source/barman/single-server-streaming/step01-db-setup.mdx @@ -114,7 +114,7 @@ psql -d pagila The relevant configuration parameter is [`listen_addresses`](https://www.postgresql.org/docs/current/runtime-config-connection.html#GUC-LISTEN-ADDRESSES): -```shell +```sql show listen_addresses; __OUTPUT__ listen_addresses @@ -125,8 +125,8 @@ __OUTPUT__ 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. -```shell -pagila=# ALTER SYSTEM SET listen_addresses TO "*"; +```sql +ALTER SYSTEM SET listen_addresses TO "*"; __OUTPUT__ ALTER SYSTEM ``` From c1c53a13b056a1f92cde037ba2981b0279a3eb1e Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Fri, 18 Feb 2022 18:17:16 +0000 Subject: [PATCH 28/29] redirect edb*plus from ALL epas versions --- static/_redirects | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/_redirects b/static/_redirects index 6500b0fa647..e2170e637ee 100644 --- a/static/_redirects +++ b/static/_redirects @@ -117,7 +117,7 @@ /docs/edbcloud/* /docs/biganimal/:splat 301 # EDB*Plus breakout from EPAS -/docs/epas/latest/edb_plus/* /docs/edb_plus/latest/:splat 301 +/docs/epas/:version/edb_plus/* /docs/edb_plus/latest/:splat 301 # Super legacy redirects (Docs 0.5 -> 1.0) /docs/en/1.0/EDB_HA_SCALABILITY/* https://www.enterprisedb.com/edb-docs/d/edb-postgres-failover-manager/user-guides/high-availability-scalability-guide/3.2/:splat 301 From 48e80ae5995f85a5fb7d8abfb5327a19d516ed17 Mon Sep 17 00:00:00 2001 From: Josh Heyer Date: Fri, 18 Feb 2022 18:19:33 +0000 Subject: [PATCH 29/29] do this even when EDB*Plus stub remains --- static/_redirects | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/static/_redirects b/static/_redirects index e2170e637ee..4a6e8b94025 100644 --- a/static/_redirects +++ b/static/_redirects @@ -117,7 +117,7 @@ /docs/edbcloud/* /docs/biganimal/:splat 301 # EDB*Plus breakout from EPAS -/docs/epas/:version/edb_plus/* /docs/edb_plus/latest/:splat 301 +/docs/epas/:version/edb_plus/* /docs/edb_plus/latest/:splat 301! # Super legacy redirects (Docs 0.5 -> 1.0) /docs/en/1.0/EDB_HA_SCALABILITY/* https://www.enterprisedb.com/edb-docs/d/edb-postgres-failover-manager/user-guides/high-availability-scalability-guide/3.2/:splat 301