From 3a16aec2fdea41e549d6fdc77d975e2f5d6cdeb0 Mon Sep 17 00:00:00 2001
From: Chris Estes <106166814+ccestes@users.noreply.github.com>
Date: Thu, 23 Jun 2022 11:25:59 -0400
Subject: [PATCH 01/13] Using the Query tool changes
---
product_docs/docs/pem/8/pem_query_tool.mdx | 38 +++++++++++-----------
1 file changed, 19 insertions(+), 19 deletions(-)
diff --git a/product_docs/docs/pem/8/pem_query_tool.mdx b/product_docs/docs/pem/8/pem_query_tool.mdx
index 2a14b935ba7..9ea0223db8e 100644
--- a/product_docs/docs/pem/8/pem_query_tool.mdx
+++ b/product_docs/docs/pem/8/pem_query_tool.mdx
@@ -27,8 +27,8 @@ You can open multiple copies of the Query tool in individual tabs simultaneously
The Query Tool features two panels:
-- The upper panel displays the `SQL Editor`. You can use the panel to enter, edit, or execute a query. It also shows the `History` tab which can be used to view the queries that have been executed in the session, and a `Scratch Pad` which can be used to hold text snippets during editing. If the Scratch Pad is closed, it can be re-opened (or additional ones opened) by right-clicking in the SQL Editor and other panels and adding a new panel.
-- The lower panel displays the `Data Output` panel. The tabbed panel displays the result set returned by a query, information about a query's execution plan, server messages related to the query's execution and any asynchronous notifications received from the server.
+- The upper panel displays the `SQL Editor`. You can use the panel to enter, edit, or execute a query. It also shows the `History` tab which can be used to view the queries that have been executed in the session, and a `Scratch Pad` which can be used to hold text snippets during editing. If the Scratch Pad is closed, it can be re-opened (or additional ones opened) by right-clicking in the SQL Editor, or other panels, and adding a new panel.
+- The lower panel displays the `Data Output` panel. The tabbed panel displays the result set returned by a query, information about a query's execution plan, server messages related to the query's execution, and any asynchronous notifications received from the server.
**The Query Tool Toolbar**
@@ -41,24 +41,24 @@ Hover over an icon to display a tool-tip that describes the icon's functionality
| **Icon** | **Behavior** | **Shortcut** |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| `Open File` | Click the `Open File` icon to display a previously saved query in the SQL Editor. | Accesskey + O |
-| `Save` | Click the `Save` icon to perform a quick-save of a previously saved query, or to access the Save menu:
- Select `Save` to save the selected content of the SQL Editor panel in a file.
- Select Save As to open a new browser dialog and specify a new location to which to save the selected content of the SQL Editor panel. | Accesskey + S |
+| `Save` | Click the `Save` icon to perform a quick-save of a previously saved query, or to access the Save menu:
- Select `Save` to save the selected content of the SQL Editor panel in a file.
- Select `Save As` to open a new browser dialog and specify a new location to which to save the selected content of the SQL Editor panel. | Accesskey + S |
| `Save Data Changes` | Click the `Save Data Changes` icon to save the data changes (insert, update, or delete) in the Data Output Panel to the server. | F6 |
| `Find` | Use the `Find` menu to search, replace, or navigate the code displayed in the SQL Editor:
- Select `Find` to provide a search target, and search the SQL Editor contents.
- Select `Find next` to locate the next occurrence of the search target.
- Select `Find previous` to move to the last occurrence of the search target.
- Select `Pesistent find` to identify all occurrences of the search target within the editor.
- Select `Replace` to locate and replace (with prompting) individual occurrences of the target.
- Select `Replace all` to locate and replace all occurrences of the target within the editor.
- Select `Jump` to navigate to the next occurrence of the search target. | Cmd+F
Cmd+G
Cmd+Shift+G
Cmd+Shift+F
Alt+G |
-| `Copy` | Click the `Copy` icon to copy the content that is currently highlighted in the Data Output panel. when in View/Edit data mode. | Accesskey + C |
-| `Paste` | Click the `Paste` icon to paste a previously row into a new row when in View/Edit data mode. | Accesskey + P |
-| `Delete` | Click the `Delete` icon to mark the selected rows for deletion. These marked rows get deleted when you click the `Save Data Changes` icon. | Accesskey + D |
+| `Copy` | Click the `Copy` icon to copy the content that is currently highlighted in the Data Output panel when in View/Edit data mode. | Accesskey + C |
+| `Paste` | Click the `Paste` icon to paste a previously copied row into a new row when in View/Edit data mode. | Accesskey + P |
+| `Delete` | Click the `Delete` icon to mark the selected rows for deletion. These marked rows are deleted when you click the `Save Data Changes` icon. | Accesskey + D |
| `Edit` | Use options on the `Edit` menu to access text editing tools; the options operate on the text displayed in the SQL Editor panel when in Query Tool mode:
- Select `Indent Selection` to indent the currently selected text.
- Select `Unindent Selection` to remove indentation from the currently selected text.
- Select `Inline Comment Selection` to enclose any lines that contain the selection in SQL style comment notation.
- Select `Inline Uncomment Selection` to remove SQL style comment notation from the selected line.
- Select `Block Comment` to enclose all lines that contain the selection in C style comment notation. This option acts as a toggle. | Tab
Shift+Tab
Cmd+/
Cmd+.
Shift+Cmd+/ |
| `Filter` | Click the `Filter` icon to set filtering and sorting criteria for the data when in View/Edit data mode. Click the down arrow to access other filtering and sorting options:
-Click `Sort/Filter` to open the sorting and filtering dialogue.
- Click `Filter by Selection` to show only the rows containing the values in the selected cells.
- Click `Exclude by Selection` to show only the rows that do not contain the values in the selected cells.
- Click `Remove Sort/Filter` to remove any previously selected sort or filtering options. | Accesskey + F |
| `Limit Selector` | Select a value in the `Limit Selector` to limit the size of the dataset to a number of rows. | Accesskey + R |
| `Stop` | Click the `Stop` icon to cancel the execution of the currently running query. | Accesskey + Q |
-| `Execute/Refresh` | Click the `Execute/Refresh` icon to either execute or refresh the query highlighted in the SQL editor panel. Click the down arrow to access other execution options:
- Add a check next to `Auto-Rollback` to instruct the server to automatically roll back a transaction if an error occurs during the transaction.
- Add a check next to `Auto-Commit` to instruct the server to automatically commit each transaction. Any changes made by the transaction will be visible to others, and durable in the event of a crash. | F5 |
+| `Execute/Refresh` | Click the `Execute/Refresh` icon to either execute or refresh the query highlighted in the SQL editor panel. Click the down arrow to access other execution options:
- Add a check next to `Auto-Rollback` to instruct the server to automatically roll back a transaction if an error occurs during the transaction.
- Add a check next to `Auto-Commit` to instruct the server to automatically commit each transaction. Any changes made by the transaction are visible to others, and durable in the event of a crash. | F5 |
| `Explain` | Click the `Explain` icon to view an explanation plan for the current query. The result of EXPLAIN is displayed graphically on the `Explain` tab of the output panel, and in text form on the `Data Output` tab. | F7 |
-| `Explain analyze` | Click the `Explain analyze` icon to invoke an EXPLAIN ANALYZE command on the current query.Navigate through the Explain Options menu to select options for the EXPLAIN command:
- Select `Verbose` to display additional information regarding the query plan.
- Select `Costs` to include information on the estimated startup and total cost of each plan node, as well as the estimated number of rows and the estimated width of each row.
- Select `Buffers` to include information on buffer usage.
- Select `Timing` to include information about the startup time and the amount of time spent in each node of the query.
- Select `Summary` to include the summary information about the query plan. | |
+| `Explain analyze` | Click the `Explain analyze` icon to invoke an EXPLAIN ANALYZE command on the current query. Navigate through the Explain Options menu to select options for the EXPLAIN command:
- Select `Verbose` to display additional information regarding the query plan.
- Select `Costs` to include information on the estimated startup and total cost of each plan node, as well as the estimated number of rows and the estimated width of each row.
- Select `Buffers` to include information on buffer usage.
- Select `Timing` to include information about the startup time and the amount of time spent in each node of the query.
- Select `Summary` to include the summary information about the query plan. | |
| `Commit` | Click the `Commit` icon to commit the transaction. | Shift+CTRL+M |
| `Rollback` | Click the `Rollback` icon to rollback the transaction. | Shift+CTRL+R |
| `Clear` | Use options on the `Clear` drop-down menu to erase display contents:
- Select `Clear Query Window` to erase the content of the SQL Editor panel.
- Select `Clear History` to erase the content of the `History` tab. | Accesskey + L |
-| `Download as CSV` | Click the `Download as CSV` icon to download the result set of the current query to a comma-separated list. You can specify the CSV settings through `Preferences -> SQL Editor -> CSV output` dialogue. | F8 |
-| `Macros` | Click the `Macros` icon to manage the macros. You can create, edit or clear the `macros` through Manage Macros option. | |
+| `Download as CSV` | Click the `Download as CSV` icon to download the result set of the current query to a comma-separated list. You can specify the CSV settings through the `Preferences -> SQL Editor -> CSV output` dialogue. | F8 |
+| `Macros` | Click the `Macros` icon to manage the macros. You can create, edit or clear the `macros` through the Manage Macros option. | |
## The SQL editor panel
@@ -137,11 +137,11 @@ On successful generation of `Explain` plan, it will create three tabs/panels und
### Graphical tab
-Hover over an icon on the `Graphical` tab to review information about that item; a popup window will display information about the selected object. For information on JIT statistics, triggers and a summary, hover over the icon on top-right corner; a similar popup window will be displayed when appropriate.
+Hover over an icon on the `Graphical` tab to review information about that item; a popup window displays information about the selected object. For information on JIT statistics, triggers, and a summary, hover over the icon on top-right corner; a similar popup window is displayed when appropriate.
Please note that `EXPLAIN VERBOSE` cannot be displayed graphically.
-Use the download button on top left corner of the `Explain` canvas to download the plan as an SVG file. Please note that `Download as SVG` feature is not supported on Internet Explorer.
+Use the download button on the top left corner of the `Explain` canvas to download the plan as an SVG file. Please note that `Download as SVG` feature is not supported on Internet Explorer.
@@ -149,7 +149,7 @@ The query plan that accompanies the `Explain analyze` is available on the `Data
### Analysis tab
-The `Analysis` tab shows the plan details in table format, it generates a format similar to the format available at `explain.depsez.com`. Each row of the table represents the data for a `Explain Plan Node`. The output may contain the node information, exclusive timing, inclusive timing, actual vs. planned rows, actual rows, planned rows, or loops. When you select a row, the child rows of that selected row are marked with an orange dot.
+The `Analysis` tab shows the plan details in table format, generating a format similar to the one available at `explain.depsez.com`. Each row of the table represents the data for a `Explain Plan Node`. The output may contain the node information, exclusive timing, inclusive timing, actual vs. planned rows, actual rows, planned rows, or loops. When you select a row, the child rows of that selected row are marked with an orange dot.
If the percentage of the exclusive/inclusive timings of the total query time is:
@@ -238,26 +238,26 @@ Use the `Connection status` feature to view the current connection and transacti
## Macros
-Query Tool Macros enable you to execute pre-defined SQL queries with a single key press. Pre-defined queries can contain the placeholder $SELECTION$. Upon macro execution, the placeholder will be replaced with the currently selected text in the Query Editor pane of the Query Tool.
+Query Tool Macros enable you to execute pre-defined SQL queries with a single key-press. Pre-defined queries can contain the placeholder $SELECTION$. Upon macro execution, the placeholder will be replaced with the currently selected text in the Query Editor pane of the Query Tool.
-To create a macro, select the *Manage Macros* option from the *Macros* menu on the *Query Tool*. Select the key you wish to use, enter the name of the macro, and the query, optionally including the selection placeholder, and then click the *Save* button to store the macro.
+To create a macro, select the `Manage Macros` option from the Macros menu on the Query Tool. Select the key you wish to use, enter the name of the macro, and the query, optionally including the selection placeholder, and then click the `Save` button to store the macro.
-To clear a macro, select the macro on the *Manage Macros* dialogue, and then click the *Clear* button.
+To clear a macro, select the macro on the `Manage Macros` dialogue, and then click the `Clear` button.
-The server will prompt you for confirmation to clear the macro.
+In the sever prompt, click `Yes` to clear the selected macro.
-To clear all macros, click on the *Clear* button on left side of the key. The server will prompt you for confirmation to clear all the rows.
+To clear all macros, click on the `Clear` button on left side of the key. In the server prompt, click `Yes` to clear all the rows.
-To execute a macro, simply select the appropriate shortcut keys, or select it from the *Macros* menu.
+To execute a macro, simply select the appropriate shortcut keys, or select it from the `Macros` menu.
From 9b2c87d6fea65c0aa26b06f7e4e00b2478e22e8f Mon Sep 17 00:00:00 2001
From: Chris Estes <106166814+ccestes@users.noreply.github.com>
Date: Thu, 23 Jun 2022 17:00:41 -0400
Subject: [PATCH 02/13] feedback changes up to Copy icon behavior
---
product_docs/docs/pem/8/pem_query_tool.mdx | 50 +++++++++++-----------
1 file changed, 26 insertions(+), 24 deletions(-)
diff --git a/product_docs/docs/pem/8/pem_query_tool.mdx b/product_docs/docs/pem/8/pem_query_tool.mdx
index 9ea0223db8e..53a5688089e 100644
--- a/product_docs/docs/pem/8/pem_query_tool.mdx
+++ b/product_docs/docs/pem/8/pem_query_tool.mdx
@@ -11,7 +11,7 @@ redirects:
PEM contains a feature-rich Interactive Development Environment (IDE) that allows you to issue ad-hoc SQL queries against Postgres servers.
-You can access the Query Tool via the `Query Tool` menu option on the `Tools` menu, or through the context menu of select nodes of the Browser tree control. The Query Tool allows you to:
+You can access the Query Tool via the **Query Tool** menu option on the **Tools** menu, or through the context menu of select nodes of the Browser tree control. The Query Tool allows you to:
- Issue ad-hoc SQL queries.
- Execute arbitrary SQL commands.
@@ -23,16 +23,18 @@ You can access the Query Tool via the `Query Tool` menu option on the `Tools` me
-You can open multiple copies of the Query tool in individual tabs simultaneously. To close a copy of the Query tool, click the *X* in the upper-right hand corner of the tab bar.
+You can open multiple copies of the Query tool in individual tabs simultaneously. To close a copy of the Query tool, select the **X** in the upper-right hand corner of the tab bar.
The Query Tool features two panels:
-- The upper panel displays the `SQL Editor`. You can use the panel to enter, edit, or execute a query. It also shows the `History` tab which can be used to view the queries that have been executed in the session, and a `Scratch Pad` which can be used to hold text snippets during editing. If the Scratch Pad is closed, it can be re-opened (or additional ones opened) by right-clicking in the SQL Editor, or other panels, and adding a new panel.
-- The lower panel displays the `Data Output` panel. The tabbed panel displays the result set returned by a query, information about a query's execution plan, server messages related to the query's execution, and any asynchronous notifications received from the server.
+- The upper panel displays the SQL Editor. You can use the panel to enter, edit, or execute a query. It also shows the **History** tab, which you can use to view the queries that executed in the session. You can use the scratch pad to hold text snippets during editing.
+
+ To reopen a closed scratch pad or open a new one, right-click the SQL Editor and select **Add Panel**. You can also open new scratch pads from other panels using the same technique.
+- The lower panel displays the **Data Output** panel. The tabbed panel displays the result set returned by a query, information about a query's execution plan, server messages related to the query's execution, and any asynchronous notifications received from the server.
**The Query Tool Toolbar**
-The `Query Tool` toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. If an icon is highlighted, the option is enabled; if the icon is grayed-out, the task is disabled.
+The **Query Tool** toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. If an icon is highlighted, the option is enabled; if the icon is grayed-out, the task is disabled.
@@ -40,25 +42,25 @@ Hover over an icon to display a tool-tip that describes the icon's functionality
| **Icon** | **Behavior** | **Shortcut** |
| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
-| `Open File` | Click the `Open File` icon to display a previously saved query in the SQL Editor. | Accesskey + O |
-| `Save` | Click the `Save` icon to perform a quick-save of a previously saved query, or to access the Save menu:
- Select `Save` to save the selected content of the SQL Editor panel in a file.
- Select `Save As` to open a new browser dialog and specify a new location to which to save the selected content of the SQL Editor panel. | Accesskey + S |
-| `Save Data Changes` | Click the `Save Data Changes` icon to save the data changes (insert, update, or delete) in the Data Output Panel to the server. | F6 |
-| `Find` | Use the `Find` menu to search, replace, or navigate the code displayed in the SQL Editor:
- Select `Find` to provide a search target, and search the SQL Editor contents.
- Select `Find next` to locate the next occurrence of the search target.
- Select `Find previous` to move to the last occurrence of the search target.
- Select `Pesistent find` to identify all occurrences of the search target within the editor.
- Select `Replace` to locate and replace (with prompting) individual occurrences of the target.
- Select `Replace all` to locate and replace all occurrences of the target within the editor.
- Select `Jump` to navigate to the next occurrence of the search target. | Cmd+F
Cmd+G
Cmd+Shift+G
Cmd+Shift+F
Alt+G |
-| `Copy` | Click the `Copy` icon to copy the content that is currently highlighted in the Data Output panel when in View/Edit data mode. | Accesskey + C |
-| `Paste` | Click the `Paste` icon to paste a previously copied row into a new row when in View/Edit data mode. | Accesskey + P |
-| `Delete` | Click the `Delete` icon to mark the selected rows for deletion. These marked rows are deleted when you click the `Save Data Changes` icon. | Accesskey + D |
-| `Edit` | Use options on the `Edit` menu to access text editing tools; the options operate on the text displayed in the SQL Editor panel when in Query Tool mode:
- Select `Indent Selection` to indent the currently selected text.
- Select `Unindent Selection` to remove indentation from the currently selected text.
- Select `Inline Comment Selection` to enclose any lines that contain the selection in SQL style comment notation.
- Select `Inline Uncomment Selection` to remove SQL style comment notation from the selected line.
- Select `Block Comment` to enclose all lines that contain the selection in C style comment notation. This option acts as a toggle. | Tab
Shift+Tab
Cmd+/
Cmd+.
Shift+Cmd+/ |
-| `Filter` | Click the `Filter` icon to set filtering and sorting criteria for the data when in View/Edit data mode. Click the down arrow to access other filtering and sorting options:
-Click `Sort/Filter` to open the sorting and filtering dialogue.
- Click `Filter by Selection` to show only the rows containing the values in the selected cells.
- Click `Exclude by Selection` to show only the rows that do not contain the values in the selected cells.
- Click `Remove Sort/Filter` to remove any previously selected sort or filtering options. | Accesskey + F |
-| `Limit Selector` | Select a value in the `Limit Selector` to limit the size of the dataset to a number of rows. | Accesskey + R |
-| `Stop` | Click the `Stop` icon to cancel the execution of the currently running query. | Accesskey + Q |
-| `Execute/Refresh` | Click the `Execute/Refresh` icon to either execute or refresh the query highlighted in the SQL editor panel. Click the down arrow to access other execution options:
- Add a check next to `Auto-Rollback` to instruct the server to automatically roll back a transaction if an error occurs during the transaction.
- Add a check next to `Auto-Commit` to instruct the server to automatically commit each transaction. Any changes made by the transaction are visible to others, and durable in the event of a crash. | F5 |
-| `Explain` | Click the `Explain` icon to view an explanation plan for the current query. The result of EXPLAIN is displayed graphically on the `Explain` tab of the output panel, and in text form on the `Data Output` tab. | F7 |
-| `Explain analyze` | Click the `Explain analyze` icon to invoke an EXPLAIN ANALYZE command on the current query. Navigate through the Explain Options menu to select options for the EXPLAIN command:
- Select `Verbose` to display additional information regarding the query plan.
- Select `Costs` to include information on the estimated startup and total cost of each plan node, as well as the estimated number of rows and the estimated width of each row.
- Select `Buffers` to include information on buffer usage.
- Select `Timing` to include information about the startup time and the amount of time spent in each node of the query.
- Select `Summary` to include the summary information about the query plan. | |
-| `Commit` | Click the `Commit` icon to commit the transaction. | Shift+CTRL+M |
-| `Rollback` | Click the `Rollback` icon to rollback the transaction. | Shift+CTRL+R |
-| `Clear` | Use options on the `Clear` drop-down menu to erase display contents:
- Select `Clear Query Window` to erase the content of the SQL Editor panel.
- Select `Clear History` to erase the content of the `History` tab. | Accesskey + L |
-| `Download as CSV` | Click the `Download as CSV` icon to download the result set of the current query to a comma-separated list. You can specify the CSV settings through the `Preferences -> SQL Editor -> CSV output` dialogue. | F8 |
-| `Macros` | Click the `Macros` icon to manage the macros. You can create, edit or clear the `macros` through the Manage Macros option. | |
+| Open File | Display a previously saved query in the SQL Editor. | Accesskey + O |
+| Save | Save a query or access the Save menu:
- Select **Save** to save the selected content of the SQL Editor panel in a file.
- Select **Save As** to open a new browser dialog and specify a new location to save the selected content of the SQL Editor panel. | Accesskey + S |
+| Save Data Changes | Save the data changes (insert, update, or delete) in the Data Output Panel to the server. | F6 |
+| Find | Search, replace, or navigate the code displayed in the SQL Editor:
- Select **Find** to provide a search target and search the SQL Editor contents.
- Select **Find next** to locate the next occurrence of the search target.
- Select **Find previous** to move to the last occurrence of the search target.
- Select **Pesistent find** to identify all occurrences of the search target within the editor.
- Select **Replace** to locate and replace (with prompting) individual occurrences of the target.
- Select **Replace all** to locate and replace all occurrences of the target within the editor.
- Select **Jump** to navigate to the next occurrence of the search target. | Cmd+F
Cmd+G
Cmd+Shift+G
Cmd+Shift+F
Alt+G |
+| Copy | Copy the content that is currently highlighted in the Data Output panel when in View/Edit data mode. | Accesskey + C |
+| Paste | Click the `Paste` icon to paste a previously copied row into a new row when in View/Edit data mode. | Accesskey + P |
+| Delete | Click the `Delete` icon to mark the selected rows for deletion. These marked rows are deleted when you click the `Save Data Changes` icon. | Accesskey + D |
+| Edit | Use options on the `Edit` menu to access text editing tools; the options operate on the text displayed in the SQL Editor panel when in Query Tool mode:
- Select `Indent Selection` to indent the currently selected text.
- Select `Unindent Selection` to remove indentation from the currently selected text.
- Select `Inline Comment Selection` to enclose any lines that contain the selection in SQL style comment notation.
- Select `Inline Uncomment Selection` to remove SQL style comment notation from the selected line.
- Select `Block Comment` to enclose all lines that contain the selection in C style comment notation. This option acts as a toggle. | Tab
Shift+Tab
Cmd+/
Cmd+.
Shift+Cmd+/ |
+| Filter | Click the `Filter` icon to set filtering and sorting criteria for the data when in View/Edit data mode. Click the down arrow to access other filtering and sorting options:
-Click `Sort/Filter` to open the sorting and filtering dialogue.
- Click `Filter by Selection` to show only the rows containing the values in the selected cells.
- Click `Exclude by Selection` to show only the rows that do not contain the values in the selected cells.
- Click `Remove Sort/Filter` to remove any previously selected sort or filtering options. | Accesskey + F |
+| Limit Selector | Select a value in the `Limit Selector` to limit the size of the dataset to a number of rows. | Accesskey + R |
+| Stop | Click the `Stop` icon to cancel the execution of the currently running query. | Accesskey + Q |
+| Execute/Refresh | Click the `Execute/Refresh` icon to either execute or refresh the query highlighted in the SQL editor panel. Click the down arrow to access other execution options:
- Add a check next to `Auto-Rollback` to instruct the server to automatically roll back a transaction if an error occurs during the transaction.
- Add a check next to `Auto-Commit` to instruct the server to automatically commit each transaction. Any changes made by the transaction are visible to others, and durable in the event of a crash. | F5 |
+| Explain | Click the `Explain` icon to view an explanation plan for the current query. The result of EXPLAIN is displayed graphically on the `Explain` tab of the output panel, and in text form on the `Data Output` tab. | F7 |
+| Explain analyze | Click the `Explain analyze` icon to invoke an EXPLAIN ANALYZE command on the current query. Navigate through the Explain Options menu to select options for the EXPLAIN command:
- Select `Verbose` to display additional information regarding the query plan.
- Select `Costs` to include information on the estimated startup and total cost of each plan node, as well as the estimated number of rows and the estimated width of each row.
- Select `Buffers` to include information on buffer usage.
- Select `Timing` to include information about the startup time and the amount of time spent in each node of the query.
- Select `Summary` to include the summary information about the query plan. | |
+| Commit | Click the `Commit` icon to commit the transaction. | Shift+CTRL+M |
+| Rollback | Click the `Rollback` icon to rollback the transaction. | Shift+CTRL+R |
+| Clear | Use options on the `Clear` drop-down menu to erase display contents:
- Select `Clear Query Window` to erase the content of the SQL Editor panel.
- Select `Clear History` to erase the content of the `History` tab. | Accesskey + L |
+| Download as CSV | Click the `Download as CSV` icon to download the result set of the current query to a comma-separated list. You can specify the CSV settings through the `Preferences -> SQL Editor -> CSV output` dialogue. | F8 |
+| Macros | Click the `Macros` icon to manage the macros. You can create, edit or clear the `macros` through the Manage Macros option. | |
## The SQL editor panel
From 3fbbe88e40cfcdcfb3980c257ca191d310520a1c Mon Sep 17 00:00:00 2001
From: Chris Estes <106166814+ccestes@users.noreply.github.com>
Date: Fri, 24 Jun 2022 16:26:03 -0400
Subject: [PATCH 03/13] remaining feedback changes
---
product_docs/docs/pem/8/pem_query_tool.mdx | 137 +++++++++++----------
1 file changed, 69 insertions(+), 68 deletions(-)
diff --git a/product_docs/docs/pem/8/pem_query_tool.mdx b/product_docs/docs/pem/8/pem_query_tool.mdx
index 53a5688089e..7aea7c4f13c 100644
--- a/product_docs/docs/pem/8/pem_query_tool.mdx
+++ b/product_docs/docs/pem/8/pem_query_tool.mdx
@@ -40,67 +40,67 @@ The **Query Tool** toolbar uses context-sensitive icons that provide shortcuts t
Hover over an icon to display a tool-tip that describes the icon's functionality:
-| **Icon** | **Behavior** | **Shortcut** |
-| ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
-| Open File | Display a previously saved query in the SQL Editor. | Accesskey + O |
-| Save | Save a query or access the Save menu:
- Select **Save** to save the selected content of the SQL Editor panel in a file.
- Select **Save As** to open a new browser dialog and specify a new location to save the selected content of the SQL Editor panel. | Accesskey + S |
+| **Icon** | **Behavior** | **Shortcut** |
+| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
+| Open File | Display a previously saved query in the SQL Editor. | Accesskey + O |
+| Save | Save a query or access the Save menu:
- Select **Save** to save the selected content of the SQL Editor panel in a file.
- Select **Save As** to open a new browser dialog and specify a new location to save the selected content of the SQL Editor panel. | Accesskey + S |
| Save Data Changes | Save the data changes (insert, update, or delete) in the Data Output Panel to the server. | F6 |
| Find | Search, replace, or navigate the code displayed in the SQL Editor:
- Select **Find** to provide a search target and search the SQL Editor contents.
- Select **Find next** to locate the next occurrence of the search target.
- Select **Find previous** to move to the last occurrence of the search target.
- Select **Pesistent find** to identify all occurrences of the search target within the editor.
- Select **Replace** to locate and replace (with prompting) individual occurrences of the target.
- Select **Replace all** to locate and replace all occurrences of the target within the editor.
- Select **Jump** to navigate to the next occurrence of the search target. | Cmd+F
Cmd+G
Cmd+Shift+G
Cmd+Shift+F
Alt+G |
-| Copy | Copy the content that is currently highlighted in the Data Output panel when in View/Edit data mode. | Accesskey + C |
-| Paste | Click the `Paste` icon to paste a previously copied row into a new row when in View/Edit data mode. | Accesskey + P |
-| Delete | Click the `Delete` icon to mark the selected rows for deletion. These marked rows are deleted when you click the `Save Data Changes` icon. | Accesskey + D |
-| Edit | Use options on the `Edit` menu to access text editing tools; the options operate on the text displayed in the SQL Editor panel when in Query Tool mode:
- Select `Indent Selection` to indent the currently selected text.
- Select `Unindent Selection` to remove indentation from the currently selected text.
- Select `Inline Comment Selection` to enclose any lines that contain the selection in SQL style comment notation.
- Select `Inline Uncomment Selection` to remove SQL style comment notation from the selected line.
- Select `Block Comment` to enclose all lines that contain the selection in C style comment notation. This option acts as a toggle. | Tab
Shift+Tab
Cmd+/
Cmd+.
Shift+Cmd+/ |
-| Filter | Click the `Filter` icon to set filtering and sorting criteria for the data when in View/Edit data mode. Click the down arrow to access other filtering and sorting options:
-Click `Sort/Filter` to open the sorting and filtering dialogue.
- Click `Filter by Selection` to show only the rows containing the values in the selected cells.
- Click `Exclude by Selection` to show only the rows that do not contain the values in the selected cells.
- Click `Remove Sort/Filter` to remove any previously selected sort or filtering options. | Accesskey + F |
-| Limit Selector | Select a value in the `Limit Selector` to limit the size of the dataset to a number of rows. | Accesskey + R |
-| Stop | Click the `Stop` icon to cancel the execution of the currently running query. | Accesskey + Q |
-| Execute/Refresh | Click the `Execute/Refresh` icon to either execute or refresh the query highlighted in the SQL editor panel. Click the down arrow to access other execution options:
- Add a check next to `Auto-Rollback` to instruct the server to automatically roll back a transaction if an error occurs during the transaction.
- Add a check next to `Auto-Commit` to instruct the server to automatically commit each transaction. Any changes made by the transaction are visible to others, and durable in the event of a crash. | F5 |
-| Explain | Click the `Explain` icon to view an explanation plan for the current query. The result of EXPLAIN is displayed graphically on the `Explain` tab of the output panel, and in text form on the `Data Output` tab. | F7 |
-| Explain analyze | Click the `Explain analyze` icon to invoke an EXPLAIN ANALYZE command on the current query. Navigate through the Explain Options menu to select options for the EXPLAIN command:
- Select `Verbose` to display additional information regarding the query plan.
- Select `Costs` to include information on the estimated startup and total cost of each plan node, as well as the estimated number of rows and the estimated width of each row.
- Select `Buffers` to include information on buffer usage.
- Select `Timing` to include information about the startup time and the amount of time spent in each node of the query.
- Select `Summary` to include the summary information about the query plan. | |
-| Commit | Click the `Commit` icon to commit the transaction. | Shift+CTRL+M |
-| Rollback | Click the `Rollback` icon to rollback the transaction. | Shift+CTRL+R |
-| Clear | Use options on the `Clear` drop-down menu to erase display contents:
- Select `Clear Query Window` to erase the content of the SQL Editor panel.
- Select `Clear History` to erase the content of the `History` tab. | Accesskey + L |
-| Download as CSV | Click the `Download as CSV` icon to download the result set of the current query to a comma-separated list. You can specify the CSV settings through the `Preferences -> SQL Editor -> CSV output` dialogue. | F8 |
-| Macros | Click the `Macros` icon to manage the macros. You can create, edit or clear the `macros` through the Manage Macros option. | |
+| Copy | Copy the content that's currently highlighted in the Data Output panel when in View/Edit data mode. | Accesskey + C |
+| Paste | Paste a copied row into a new row when in View/Edit data mode. | Accesskey + P |
+| Delete | Mark selected rows for deletion. Select **Save Data Changes** to update the content with your deletions. | Accesskey + D |
+| Edit | Use options on the **Edit** menu to access text editing tools; the options operate on the text displayed in the SQL Editor panel when in Query Tool mode:
- Select **Indent Selection** to indent the currently selected text.
- Select **Unindent Selection** to remove indentation from the currently selected text.
- Select **Inline Comment Selection** to enclose any lines that contain the selection in SQL style comment notation.
- Select **Inline Uncomment Selection** to remove SQL style comment notation from the selected line.
- Select **Block Comment** to enclose all lines that contain the selection in C style comment notation. This option acts as a toggle. | Tab
Shift+Tab
Cmd+/
Cmd+.
Shift+Cmd+/ |
+| Filter | Set filtering and sorting criteria for the data when in View/Edit data mode. Select the down arrow to access other filtering and sorting options:
-Select **Sort/Filter** to open the sorting and filtering dialog box.
- Select **Filter by Selection** to show only the rows containing the values in the selected cells.
- Select **Exclude by Selection** to show only the rows that do not contain the values in the selected cells.
- Select **Remove Sort/Filter** to remove any previously selected sorting or filtering options. | Accesskey + F |
+| Limit Selector | Set a value for the maximum number of rows in a dataset. | Accesskey + R |
+| Stop | Cancel the execution of the currently running query. | Accesskey + Q |
+| Execute/Refresh | Execute or refresh the query highlighted in the SQL editor panel. Select the down arrow to access other execution options:
- Select **Auto-Rollback** to instruct the server to roll back a transaction in case an error occurs during the transaction.
- Select **Auto-Commit** to instruct the server to commit each transaction. Any changes made by the transaction are visible to others and durable in the event of a crash. | F5 |
+| Explain | View an explanation plan for the current query. The result of `EXPLAIN` is displayed graphically on the **Explain** tab of the output panel, and in text form on the **Data Output** tab. | F7 |
+| Explain analyze | Invoke an `EXPLAIN ANALYZE` command on the current query. Navigate through the **Explain Options** menu to select options for the `EXPLAIN` command:
- Select **Verbose** to display additional information regarding the query plan.
- Select **Costs** to include information on the estimated startup and total cost of each plan node as well as the estimated number of rows and the estimated width of each row.
- Select **Buffers** to include information on buffer usage.
- Select **Timing** to include information about the startup time and the amount of time spent in each node of the query.
- Select **Summary** to include the summary information about the query plan. | |
+| Commit | Commit the transaction. | Shift+CTRL+M |
+| Rollback | Rollback the transaction. | Shift+CTRL+R |
+| Clear | Use options on the **Clear** drop-down menu to erase display contents:
- Select **Clear Query Window** to erase the content of the SQL Editor panel.
- Select **Clear History** to erase the content of the **History** tab. | Accesskey + L |
+| Download as CSV | Download the result set of the current query to a comma-separated list. You can specify the CSV settings through the **Preferences -> SQL Editor -> CSV output** dialog box. | F8 |
+| Macros | Create, edit, or clear the macros by selecting **Manage Macros**. | |
## The SQL editor panel
-The `SQL editor` panel is a workspace where you can manually provide a query, copy a query from another source, or read a query from a file. The SQL editor features syntax coloring and auto-completion.
+The **SQL editor** panel is a workspace where you can manually provide a query, copy a query from another source, or read a query from a file. The SQL editor features syntax coloring and auto-completion.
-To use auto-complete, begin typing your query; when you would like the Query editor to suggest object names or commands that might be next in your query, press the Control+Space key combination. For example, type `\*SELECT \* FROM\*` (with a trailing space), and then press the `Control+Space` key combination to select from a popup menu of auto-complete options.
+To use auto-complete, begin typing your query; when you would like the Query editor to suggest object names or commands that might be next in your query, press the Control+Space key combination. For example, type `\*SELECT \* FROM\*` (with a trailing space), and then press the Control+Space key combination to select from a popup menu of auto-complete options.
-After entering a query, select the `Execute/Refresh` icon from the toolbar. The complete contents of the SQL editor panel will be sent to the database server for execution. To execute only a section of the code that is displayed in the SQL editor, highlight the text that you want the server to execute, and click the `Execute/Refresh` icon.
+After entering a query, select **Execute/Refresh** from the toolbar. The database server receives the complete contents of the SQL editor panel for execution. To execute only a section of the code that is displayed in the SQL editor, highlight the text that you want the server to execute, and select **Execute/Refresh**.
-The message returned by the server when a command executes is displayed on the `Messages` tab. If the command is successful, the `Messages` tab displays execution details.
+The message returned by the server when a command executes is displayed on the **Messages** tab. If the command is successful, the **Messages** tab displays execution details.
-Options on the `Edit` menu offer functionality that helps with code formatting and commenting:
+Options on the **Edit** menu offer functionality that helps with code formatting and commenting:
-- The auto-indent feature will automatically indent text to the same depth as the previous line when you press the Return key.
+- Use the auto-indent feature to indent text to the same depth as the previous line by pressing the Return key.
- Block indent text by selecting two or more lines and pressing the Tab key.
- Implement or remove SQL style or toggle C style comment notation within your code.
-You can also `drag and drop` certain objects from the tree-view to save time spent typing long object names. Text containing the object name will be fully qualified with the schema name. Double quotes will be added if required. For functions and procedures, the function name along with parameter names will be pasted in the Query Tool.
+You can also drag and drop certain objects from the tree-view to save time spent typing long object names. Text containing the object name are fully qualified with the schema name. Double quotes are added if required. For functions and procedures, the function name along with parameter names are pasted into the Query Tool.
## The Data Output panel
-The `Data Output` panel displays data and statistics generated by the most recently executed query.
+The **Data Output** panel displays data and statistics generated by the most recently executed query.
### Data Output tab
-The `Data Output` tab displays the result set of the query in a table format. You can:
+The **Data Output** tab displays the result set of the query in a table format. You can:
- Select and copy from the displayed result set.
-- Use the `Execute/Refresh` options to retrieve query execution information and set query execution options.
-- Use the `Download as CSV` icon to download the content of the `Data Output` tab as a comma-delimited file.
+- Use the **Execute/Refresh** options to retrieve query execution information and set query execution options.
+- Select **Download as CSV** to download the content of the **Data Output** tab as a comma-delimited file.
- Edit the data in the result set of a `SELECT` query if it is updatable.
A result set is updatable if:
@@ -111,47 +111,43 @@ A result set is updatable if:
Any columns that are renamed or selected more than once are also read-only.
!!! Note
- To work with an updatable query result set, you must have `psycopg2` driver version 2.8 or above installed.
+ To work with an updatable query result set, you must have psycopg2 driver version 2.8 or above installed.
Editable and read-only columns are identified using pencil and lock icons (respectively) in the column headers.
-An updatable result set is similar to the `Data Grid` in `View/Edit Data` mode, and can be modified in the same way.
+An updatable result set is similar to the **Data Grid** in **View/Edit Data** mode and can be modified in the same way.
-If Auto-commit is `off`, data changes are made as part of the ongoing transaction; if no transaction is ongoing a new one is initiated. The data changes are not committed to the database unless the transaction is committed.
+If Auto-commit is off, data changes are made as part of the ongoing transaction; if no transaction is ongoing, a new one is initiated. The data changes are not committed to the database unless the transaction is committed.
-If any errors occur during saving (for example, trying to save a NULL into a column with a NOT NULL constraint) the data changes are rolled back to an automatically created SAVEPOINT to ensure any previously executed queries in the ongoing transaction are not rolled back.
+If any errors occur during saving (for example, trying to save a NULL into a column with a NOT NULL constraint), the data changes are rolled back to an automatically created `SAVEPOINT` to ensure any previously executed queries in the ongoing transaction are not rolled back.
-All rowsets from previous queries or commands that are displayed in the `Data Output` panel will be discarded when you invoke another query; open another query tool browser tab to keep your previous results available.
+All rowsets from previous queries or commands that are displayed in the **Data Output** panel get discarded when you invoke another query; open another query tool browser tab to keep your previous results available.
### Explain tab
-To generate the `Explain` or `Explain Analyze` plan of a query, click on `Explain` or `Explain Analyze` button in the toolbar.
+To generate the **Explain** or **Explain Analyze** plan of a query, select **Explain** or **Explain Analyze** in the toolbar.
-More options related to `Explain` and `Explain Analyze` can be selected from the drop down on the right side of `Explain Analyze` button in the toolbar.
+More options related to **Explain** and **Explain Analyze** can be selected from the drop-down menu.
-Please note that PEM generates the `Explain [Analyze]` plan in JSON format.
+Please note that PEM generates the **Explain [Analyze]** plan in JSON format.
-On successful generation of `Explain` plan, it will create three tabs/panels under the `Explain` panel.
+On successful generation of **Explain** plan, three tabs/panels generate under the **Explain** panel.
### Graphical tab
-Hover over an icon on the `Graphical` tab to review information about that item; a popup window displays information about the selected object. For information on JIT statistics, triggers, and a summary, hover over the icon on top-right corner; a similar popup window is displayed when appropriate.
-
-Please note that `EXPLAIN VERBOSE` cannot be displayed graphically.
-
-Use the download button on the top left corner of the `Explain` canvas to download the plan as an SVG file. Please note that `Download as SVG` feature is not supported on Internet Explorer.
+To download the plan as an SVG file, select **Download** in the top-left corner of the Explain canvas. **Download as SVG** isn't supported on Internet Explorer.
-The query plan that accompanies the `Explain analyze` is available on the `Data Output` tab.
+The query plan that accompanies **Explain analyze** is available on the **Data Output** tab.
### Analysis tab
-The `Analysis` tab shows the plan details in table format, generating a format similar to the one available at `explain.depsez.com`. Each row of the table represents the data for a `Explain Plan Node`. The output may contain the node information, exclusive timing, inclusive timing, actual vs. planned rows, actual rows, planned rows, or loops. When you select a row, the child rows of that selected row are marked with an orange dot.
+The **Analysis** tab shows the plan details in table format, generating a format similar to the one available at `explain.depsez.com`. Each row of the table represents the data for an Explain Plan node. The output can contain the node information, exclusive timing, inclusive timing, actual versus planned rows, actual rows, planned rows, or loops. Child rows of the selected row are marked with an orange dot.
If the percentage of the exclusive/inclusive timings of the total query time is:
@@ -173,39 +169,39 @@ If the planner has misestimated the number of rows (actual vs planned) by:
### Statistics tab
-The `Statistics` tab displays information in two tables:
+The **Statistics** tab displays information in two tables:
-- `Statistics per Node Type` tells you how many times each node type was referenced.
-- `Statistics per Table` tells you how many times each table was referenced by the query.
+- **Statistics per Node Type** tells you how many times each node type was referenced.
+- **Statistics per Table** tells you how many times each table was referenced by the query.
### Messages tab
-Use the `Messages` tab to view information about the most recently executed query:
+Use the **Messages** tab to view information about the most recently executed query:
-If the server returns an error, the error message will be displayed on the `Messages` tab, and the syntax that caused the error will be underlined in the SQL editor. If a query succeeds, the `Messages` tab displays how long the query took to complete and how many rows were retrieved:
+If the server returns an error, the error message appears on the **Messages** tab, and the syntax that caused the error is underlined in the SQL editor. If a query succeeds, the **Messages** tab displays how long the query took to complete and how many rows were retrieved:
### Notifications tab
-Use the `Notifications` tab to view the notifications using PostgreSQL `Listen/Notify` feature. For more details, see [PostgreSQL documentation](https://www.postgresql.org/docs/current/sql-listen.html).
+Use the **Notifications** tab to view the notifications using the PostgreSQL Listen/Notify feature. For more details, see [PostgreSQL documentation](https://www.postgresql.org/docs/current/sql-listen.html).
Example:
-1. Execute `LISTEN "foo"` in first `Query Tool` session.
+1. Execute `LISTEN "foo"` in first Query Tool session.
-2. In the another `Query Tool` session, execute `Notify` command or `pg_notify`
+2. In the another Query Tool session, execute `Notify` command or `pg_notify`
function to send the notification of the event together with the payload.
-3. You can observe the `Notification` tab in the first `Query Tool` session
+3. You can observe the **Notification** tab in the first Query Tool session
where it shows the Recorded time, Event, Process ID, and the Payload of the
particular channel.
@@ -213,53 +209,58 @@ Example:
## Query History panel
-Use the `Query History` tab to review activity for the current session:
+Use the **Query History** tab to review activity for the current session:
-The `Query History` tab displays information about recent commands:
+The **Query History** tab displays information about recent commands:
- The date and time that a query was invoked.
- The text of the query.
- The number of rows returned by the query.
- The amount of time it took the server to process the query and return a result set.
-- Messages returned by the server (not noted on the `Messages` tab).
+- Messages returned by the server (not noted on the **Messages** tab).
- The source of the query (indicated by icons corresponding to the toolbar).
-You can show or hide the queries generated internally by pgAdmin (during `View/Edit Data` or `Save Data` operations).
+You can show or hide the queries generated internally by pgAdmin (during **View/Edit Data** or **Save Data** operations).
-To erase the content of the `Query History` tab, select `Clear history` from the `Clear` drop-down menu.
+To erase the content of the **Query History** tab, select **Clear history** from the **Clear** drop-down menu.
-Query history is maintained across sessions for each database on a per-user basis when running in `Query Tool` mode. In `View/Edit Data` mode, history is not retained. By default, the last 20 queries are stored for each database. This can be adjusted in `config_local.py` by overriding the `MAX_QUERY_HIST_STORED` value.
+Query history is maintained across sessions for each database on a per-user basis when running in **Query Tool** mode. In **View/Edit Data** mode, history is not retained. By default, the last 20 queries are stored for each database. This can be adjusted in `config_local.py` by overriding the `MAX_QUERY_HIST_STORED` value.
## Connection status
-Use the `Connection status` feature to view the current connection and transaction status by clicking on the status icon in query tool:
+Use the **Connection status** feature to view the current connection and transaction status by selecting the status in Query Tool:
## Macros
-Query Tool Macros enable you to execute pre-defined SQL queries with a single key-press. Pre-defined queries can contain the placeholder $SELECTION$. Upon macro execution, the placeholder will be replaced with the currently selected text in the Query Editor pane of the Query Tool.
+Query Tool Macros enable you to execute predefined SQL queries by pressing a single key. Predefined queries can contain the placeholder `$SELECTION$`. When the macro executes, the placeholder is replaced with the currently selected text in the **Query Editor** pane of the Query Tool.
-To create a macro, select the `Manage Macros` option from the Macros menu on the Query Tool. Select the key you wish to use, enter the name of the macro, and the query, optionally including the selection placeholder, and then click the `Save` button to store the macro.
+To create a macro:
+
+1. In the Query Tool, select **Macros** > **Manage Macros**.
+2. Select the key you want to use, enter the name of the macro and the query.
+3. Optionally, include the selection placeholder.
+4. Select **Save**.
-To clear a macro, select the macro on the `Manage Macros` dialogue, and then click the `Clear` button.
+To clear a macro, in the Manage Macros dialog box, select the macro and select **Clear**.
-In the sever prompt, click `Yes` to clear the selected macro.
+To clear the selected macro, respond **Yes** to the prompt.
-To clear all macros, click on the `Clear` button on left side of the key. In the server prompt, click `Yes` to clear all the rows.
+To clear all macros, select **Clear** next to **Key**. Respond **Yes** to the prompt.
-To execute a macro, simply select the appropriate shortcut keys, or select it from the `Macros` menu.
+To execute a macro, select the shortcut keys, or select it from the **Macros** menu.
From 5e521554a4936e923abdbbb20cfa8dd4ade5d623 Mon Sep 17 00:00:00 2001
From: Chris Estes <106166814+ccestes@users.noreply.github.com>
Date: Tue, 28 Jun 2022 13:13:17 -0400
Subject: [PATCH 04/13] Using the Schema diff tool
---
.../docs/pem/8/pem_schema_diff_tool.mdx | 52 ++++++++++---------
1 file changed, 28 insertions(+), 24 deletions(-)
diff --git a/product_docs/docs/pem/8/pem_schema_diff_tool.mdx b/product_docs/docs/pem/8/pem_schema_diff_tool.mdx
index e263e534622..bef5ce589bc 100644
--- a/product_docs/docs/pem/8/pem_schema_diff_tool.mdx
+++ b/product_docs/docs/pem/8/pem_schema_diff_tool.mdx
@@ -9,7 +9,7 @@ redirects:
- /pem/latest/pem_ent_feat/03_pem_schema_diff_tool/
---
-**Schema Diff** is a feature that allows you to compare schema objects between two database schemas. Use the `Tools` menu to access Schema Diff.
+Schema Diff is a feature that allows you to compare schema objects between two database schemas. Use the **Tools** menu to access Schema Diff.
The Schema Diff feature allows you to:
@@ -21,46 +21,46 @@ The Schema Diff feature allows you to:
!!! Note
The source and target databases must be of the same major version.
-Click on `Schema Diff` under the `Tools` menu to open a selection panel. Choose the source and target servers, databases, and schemas that will be compared. After selecting the objects, click on the `Compare` button.
+Select **Tools > Schema Diff** and a selection panel opens. Choose the source and target servers, databases, and schemas to compare. After choosing the objects, select **Compare**.
-You can open multiple copies of `Schema Diff` in individual tabs simultaneously. To close a tab, click the `X` in the upper-right hand corner of the tab bar.
+You can open multiple copies of Schema Diff in individual tabs simultaneously. To close a tab, select **X** in the upper-right corner of the tab bar.
-Use the `Preferences` dialog to specify if `Schema Diff` should open in a new browser tab. Set `Open in new browser tab` option to `true`.
+To specify whether to open Schema Diff in a new browser tab, select the Preferences dialog box. Set **Open in new browser tab** option to **true**.
-The `Schema Diff` panel is divided into two panels; an `Object Comparison panel` and a `DDL Comparison panel`.
+The Schema Diff panel is divided into two panels: an Object Comparison panel and a DDL Comparison panel.
-## Schema Diff object comparison panel
+## Schema Diff Object Comparison panel
-In the object comparison panel, you can select the source and target servers of the same major version, databases, and schemas to be compared. You can select any server listed under the browser tree whether it is connected or disconnected. If you select a server that is not connected then it will prompt you for the password before using the server.
+In the Object Comparison panel, you can select the source and target servers of the same major version, databases, and schemas to compare. You can select any server listed under the browser tree whether it is connected or disconnected. If you select a server that isn't connected, then you must enter the password before using that server.
-Next, select the databases that will be compared. The databases can be the same or different (and within the same server or from different servers).
+Next, select the databases to compare. The databases can be the same or different (and from the same server or different servers).
-Lastly, select the source and target schemas which will be compared.
+Lastly, select the source and target schemas to compare.
-After you select servers, databases, and schemas, click on the `Compare` button to obtain the `Comparison Result`.
+After you select servers, databases, and schemas, select **Compare** to obtain the comparison results.
-Use the drop-down lists of Functions, Materialized Views, Tables, Trigger Functions, Procedures, and Views to view the DDL statements of all the schema objects.
+Use the lists of Functions, Materialized Views, Tables, Trigger Functions, Procedures, and Views to view the DDL statements of all the schema objects.
-In the upper-right hand corner of the object comparison panel is a `Filter` option that you can use to filter the schema objects based on the following comparison criteria:
+To filter the schema objects, select **Filter** in the upper-right corner of the Object Comparison panel. Filter the schema objects according to these criteria:
-- `Identical` – If the object is found in both schemas with the same SQL statement, then the comparison result is identical.
-- `Different` – If the object is found in both schemas but have different SQL statements, then the comparison result is different.
-- `Source Only` – If the object is found in source schema only and not in target schema, then the comparison result is source only.
-- `Target Only` – If the object is found in target schema only and not in source schema, then the comparison result is target only.
+- **Identical** – If the object is found in both schemas with the same SQL statement, then the comparison result is identical.
+- **Different** – If the object is found in both schemas but have different SQL statements, then the comparison result is different.
+- **Source Only** – If the object is found only in source schema and not in target schema, then the comparison result is source only.
+- **Target Only** – If the object is found only in target schema and not in source schema, then the comparison result is target only.
-Click on any of the schema objects in the object comparison panel to display the DDL statements for that object in the `DDL Comparison` panel.
+Select any of the schema objects in the Object Comparison panel to display the DDL statements for that object in the DDL Comparison panel.
-## Schema Diff DDL comparison panel
+## Schema Diff DDL Comparison panel
-The `DDL Comparison` panel displays three columns:
+The DDL Comparison panel displays three columns:
- The first column displays the DDL statement of the object from the source schema.
- The second column displays the DDL statement of the object from the target schema.
@@ -68,18 +68,22 @@ The `DDL Comparison` panel displays three columns:
-You can review the DDL statements of all the schema objects to check for the differences in the SQL statements.
+To check for differences in the SQL statements, review the DDL statements of all the schema objects.
-You can also use the Schema Diff tool to generate a SQL script of the differences found in the target schema object based on the SQL statement of the source schema object. To generate the script, select the checkboxes of the schema objects in the object comparison panel and then click on the `Generate Script` button in the upper-right hand corner of the object comparison panel.
+The Schema Diff tool can generate a SQL script with the differences found in the target schema object. The SQL script compares the target schema object to the SQL statement of the source schema object. To generate the script:
+1. Select the checkboxes of the schema objects in the Object Comparison panel.
+1. Select **Generate Script**.
-Select the schema objects and click on the `Generate Script` button to open the `Query Tool` in a new tab, with the difference in the SQL statement displayed in the `Query Editor`.
+To open the Query Tool in a new tab and display the differences in the SQL statement in the Query Editor:
+1. Select the schema objects.
+1. Select **Generate Script**.
-If you have clicked on the schema object to check the difference generated in the `DDL Comparison` Panel, and you have not selected the checkbox of the schema object, PEM will open the `Query Tool` in a new tab, with the differences in the SQL statements displayed in the `Query Editor`.
+If you select the schema object to check the difference generated in the DDL Comparison panel but don't select the checkbox of the schema object, then PEM opens the Query Tool in a new tab and displays the differences in the SQL statements in the Query Editor.
-You can also use the `Copy` button to copy the difference generated in the `DDL Comparison` panel.
+To copy the difference generated in the DDL Comparison panel, select **Copy**.
Apply the SQL Statement in the target schema to synchronize the schemas.
From 578d7b59ea65135037903a23720df3450ca5cc3b Mon Sep 17 00:00:00 2001
From: Chris Estes <106166814+ccestes@users.noreply.github.com>
Date: Wed, 29 Jun 2022 11:19:05 -0400
Subject: [PATCH 05/13] Schema Diff tool feedback changes
---
.../docs/pem/8/pem_schema_diff_tool.mdx | 36 +++++++++----------
1 file changed, 18 insertions(+), 18 deletions(-)
diff --git a/product_docs/docs/pem/8/pem_schema_diff_tool.mdx b/product_docs/docs/pem/8/pem_schema_diff_tool.mdx
index bef5ce589bc..ba9b763389c 100644
--- a/product_docs/docs/pem/8/pem_schema_diff_tool.mdx
+++ b/product_docs/docs/pem/8/pem_schema_diff_tool.mdx
@@ -9,50 +9,50 @@ redirects:
- /pem/latest/pem_ent_feat/03_pem_schema_diff_tool/
---
-Schema Diff is a feature that allows you to compare schema objects between two database schemas. Use the **Tools** menu to access Schema Diff.
+Schema Diff compares schema objects between two database schemas. Use the **Tools** menu to access Schema Diff.
-The Schema Diff feature allows you to:
+Schema Diff allows you to:
- Compare and synchronize the database schemas (from source to target).
- Visualize the differences between database schemas.
- List the differences in SQL statement for target schema objects.
- Generate synchronization scripts.
-!!! Note
- The source and target databases must be of the same major version.
+To open the selection panel, select **Tools > Schema Diff**. Select the source and target servers, databases, and schemas to compare. After selecting the objects, select **Compare**.
-Select **Tools > Schema Diff** and a selection panel opens. Choose the source and target servers, databases, and schemas to compare. After choosing the objects, select **Compare**.
+!!! Note
+ The source and target databases must use the same major version.
-You can open multiple copies of Schema Diff in individual tabs simultaneously. To close a tab, select **X** in the upper-right corner of the tab bar.
+You can open multiple copies of Schema Diff in individual tabs. To close a tab, select **X** in the upper-right corner of the tab bar.
-To specify whether to open Schema Diff in a new browser tab, select the Preferences dialog box. Set **Open in new browser tab** option to **true**.
+To specify whether to open Schema Diff in a new browser tab, select the Preferences dialog box. Set **Open in new browser tab** to **true**.
The Schema Diff panel is divided into two panels: an Object Comparison panel and a DDL Comparison panel.
## Schema Diff Object Comparison panel
-In the Object Comparison panel, you can select the source and target servers of the same major version, databases, and schemas to compare. You can select any server listed under the browser tree whether it is connected or disconnected. If you select a server that isn't connected, then you must enter the password before using that server.
+In the Object Comparison panel, you can select the source and target servers of the same major version, databases, and schemas to compare. You can select any server listed under the browser tree whether it's connected or disconnected. If you select a server that isn't connected, then you must enter the password before using that server.
-Next, select the databases to compare. The databases can be the same or different (and from the same server or different servers).
+Select the databases to compare. The databases can be the same or different, and from the same or different servers.
-Lastly, select the source and target schemas to compare.
+Select the source and target schemas to compare.
-After you select servers, databases, and schemas, select **Compare** to obtain the comparison results.
+After you select servers, databases, and schemas, select **Compare** to get the comparison results.
-Use the lists of Functions, Materialized Views, Tables, Trigger Functions, Procedures, and Views to view the DDL statements of all the schema objects.
+Use the lists of **Functions**, **Materialized Views**, **Tables**, **Trigger Functions**, **Procedures**, and **Views** to view the DDL statements of all the schema objects.
To filter the schema objects, select **Filter** in the upper-right corner of the Object Comparison panel. Filter the schema objects according to these criteria:
-- **Identical** – If the object is found in both schemas with the same SQL statement, then the comparison result is identical.
-- **Different** – If the object is found in both schemas but have different SQL statements, then the comparison result is different.
-- **Source Only** – If the object is found only in source schema and not in target schema, then the comparison result is source only.
-- **Target Only** – If the object is found only in target schema and not in source schema, then the comparison result is target only.
+- **Identical** — If the object is found in both schemas with the same SQL statement, then the comparison result is identical.
+- **Different** — If the object is found in both schemas with different SQL statements, then the comparison result is different.
+- **Source Only** — If the object is found only in source schema and not in target schema, then the comparison result is source only.
+- **Target Only** — If the object is found only in target schema and not in source schema, then the comparison result is target only.
@@ -71,7 +71,7 @@ The DDL Comparison panel displays three columns:
To check for differences in the SQL statements, review the DDL statements of all the schema objects.
The Schema Diff tool can generate a SQL script with the differences found in the target schema object. The SQL script compares the target schema object to the SQL statement of the source schema object. To generate the script:
-1. Select the checkboxes of the schema objects in the Object Comparison panel.
+1. In the Object Comparison panel, select the check boxes of the schema objects.
1. Select **Generate Script**.
@@ -80,7 +80,7 @@ To open the Query Tool in a new tab and display the differences in the SQL state
1. Select the schema objects.
1. Select **Generate Script**.
-If you select the schema object to check the difference generated in the DDL Comparison panel but don't select the checkbox of the schema object, then PEM opens the Query Tool in a new tab and displays the differences in the SQL statements in the Query Editor.
+If you select the schema object to check the difference generated in the DDL Comparison panel but don't select the check box of the schema object, then PEM opens the Query Tool in a new tab. The Query Tool displays the differences in the SQL statements in the Query Editor.
From 4c888aadb62682ba1c38075cbcb4cf0c5e90237b Mon Sep 17 00:00:00 2001
From: Chris Estes <106166814+ccestes@users.noreply.github.com>
Date: Thu, 30 Jun 2022 17:03:04 -0400
Subject: [PATCH 06/13] ERD tool first pass
---
product_docs/docs/pem/8/pem_erd_tool.mdx | 111 ++++++++++++-----------
1 file changed, 57 insertions(+), 54 deletions(-)
diff --git a/product_docs/docs/pem/8/pem_erd_tool.mdx b/product_docs/docs/pem/8/pem_erd_tool.mdx
index d688a1cfe6e..9f7579ec4e3 100644
--- a/product_docs/docs/pem/8/pem_erd_tool.mdx
+++ b/product_docs/docs/pem/8/pem_erd_tool.mdx
@@ -6,10 +6,10 @@ redirects:
- /pem/latest/pem_ent_feat/04_pem_erd_tool/
---
-!!! tip "New Feature "
- The ERD Tool is available in PEM 8.1.0 and later.
+!!! tip "New feature "
+ The ERD tool is available in PEM 8.1.0 and later.
-The **Entity-Relationship Diagram (ERD)** tool is a database design tool that provides a graphical representation of database tables, columns, and inter-relationships. ERD can give sufficient information for the database administrator to follow when developing and maintaining the database. You can access the ERD Tool via the `ERD Tool` menu option on the `Tools` menu. The ERD Tool allows you to:
+The Entity-Relationship Diagram (ERD) tool is a database design tool that provides a graphical representation of database tables, columns, and inter-relationships. ERD can give sufficient information for the database administrator to follow when developing and maintaining the database. To access the ERD tool, select **Tools > ERD Tool**. The ERD tool allows you to:
- Design and visualize the database tables and their relationships.
- Add notes to the diagram.
@@ -20,11 +20,11 @@ The **Entity-Relationship Diagram (ERD)** tool is a database design tool that pr
-You can open multiple copies of the ERD tool in individual tabs simultaneously. To close a copy of the ERD tool, click the `X` in the upper-right hand corner of the tab bar.
+You can open multiple copies of the ERD tool in individual tabs simultaneously. To close a copy of the ERD tool, select the **X** in the upper-right corner of the tab bar.
## Toolbar
-The **ERD Tool** toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. The option is enabled for the highlighted icon and is disabled for the grayed-out icon.
+The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to frequently performed tasks. When an icon is enabled, it appears highlighted. When an icon is disabled, it appears grayed-out.
@@ -32,58 +32,58 @@ The **ERD Tool** toolbar uses context-sensitive icons that provide shortcuts to
| Icon | Behavior | Shortcut |
| ----------- | -------------------------------------------------------------------------------------------------------------- | ---------------- |
-| `Open File` | Click the `Open File` icon to load a previously saved diagram. | Ctrl + O |
-| `Save` | Click the `Save` icon to perform a quick-save of a previously saved diagram, or to save the diagram to a file. | Ctrl + S |
-| `Save as` | Click the `Save As` to open a new browser dialog and specify a new location to save the diagram. | Ctrl + Shift + S |
+| Open File | Load a previously saved diagram. | Ctrl + O |
+| Save | Perform a quick-save of a previously saved diagram or to save the diagram to a file. | Ctrl + S |
+| Save as | Open a new browser dialog box and specify a new location to save the diagram. | Ctrl + Shift + S |
## Export options
| Icon | Behavior | Shortcut |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
-| `Generate SQL` | Click the `Generate SQL` icon to generate the DDL SQL for the diagram and open a query tool with the generated SQL ready for execution. | Option + Ctrl + S |
-| `Download image` | Click the `Download image` icon to save the ERD diagram in a image format. | Option + Ctrl + I |
+| Generate SQL | Generate the DDL SQL for the diagram and open a query tool with the generated SQL ready for execution. | Option + Ctrl + S |
+| Download image | Save the ERD diagram in an image format. | Option + Ctrl + I |
## Editing options
| Icon | Behavior | Shortcut |
| ----------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| `Add table` | Click this button to add a new table to the diagram. On clicking, this will open a table dialog where you can put the table details. | Option/Alt + Ctrl + A |
-| `Edit table` | Click this button to edit a table on the diagram. On clicking, this will open a table dialog where you can change table details. This will enable when a table is selected. | Option/Alt + Ctrl + E |
-| `Clone table` | Click this button to clone the complete table structure, name it with a auto generated name and put it in the diagram. | Option/Alt + Ctrl + C |
-| `Drop table/link` | You can drop a table or link using this button. You need to select a table or link and click on this button to drop it. | Option/Alt + Ctrl + D |
+| Add table | Add a new table to the diagram. In the table dialog box, enter the table details. | Option/Alt + Ctrl + A |
+| Edit table | Edit a selected table on the diagram. In the table dialog box, enter the table details. | Option/Alt + Ctrl + E |
+| Clone table | Clone the complete table structure, name it with a auto-generated name, and put it in the diagram. | Option/Alt + Ctrl + C |
+| Drop table/link | Drop a selected table or link. | Option/Alt + Ctrl + D |
## Table relationship options
| Icon | Behavior | Shortcut |
| ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| `1M` | Click this button to open a one-to-many relationship dialog to add a relationship between the two tables. The selected table becomes the referencing table and will have the `many` endpoint of the link. | Option/Alt + Ctrl + O |
-| `MM` | Click this button to open a many-to-many relationship dialog to add a relationship between the two tables. This option will create a new table based on the selected columns for the two relating tables and link them. | Option/Alt + Ctrl + M |
+| 1M | Open a one-to-many relationship dialog box to add a relationship between the two tables. The selected table is the referencing table and has the `many` endpoint of the link. | Option/Alt + Ctrl + O |
+| MM | Open a many-to-many relationship dialog box to add a relationship between the two tables. This options creates a new, linked table from the selected columns of the two relating tables. | Option/Alt + Ctrl + M |
## Utility Options
| Icon | Behavior | Shortcut |
| --------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------- |
-| `Add/Edit note` | Click this button to make notes on tables nodes while designing the database. | Option/Alt + Ctrl + N |
-| `Auto align` | Click this button to auto align all tables and links to make it look more cleaner. | Option/Alt + Ctrl + L |
-| `Show details` | Click this button to toggle the column details visibility. It allows you to show few or more column details. | Option/Alt + Shift + D |
+| Add/Edit note | Make notes on tables nodes while designing the database. | Option/Alt + Ctrl + N |
+| Auto align | Auto-align all tables and links to make it look cleaner. | Option/Alt + Ctrl + L |
+| Show details | Toggle the column details. You can also choose to show few or more column details. | Option/Alt + Shift + D |
## Zoom options
| Icon | Behavior | Shortcut |
| ------------- | ---------------------------------------------------------------------------------- | ------------------------ |
-| `Zoom to fit` | Click this button to zoom in/out automatically and fit all the tables to the view. | Option/Alt + Shift + F |
-| `Zoom in` | Click this button to zoom in the diagram. | Option/Alt + Shift + "+" |
-| `Zoom out` | Click this button to zoom out the diagram. | Option/Alt + Shift + "-" |
+| Zoom to fit | Zoom in/out automatically and fit all the tables to the view. | Option/Alt + Shift + F |
+| Zoom in | Zoom in on the diagram. | Option/Alt + Shift + "+" |
+| Zoom out | Zoom out on the diagram. | Option/Alt + Shift + "-" |
## Table dialog
-The table dialog allows you to:
+The table dialog box allows you to:
- Change the table structure details.
-- It can be used edit an existing table or add a new one.
-- Refer [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
+- Edit an existing table or add a new one.
+- Refer [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
## Table node
@@ -91,37 +91,39 @@ The table dialog allows you to:
The table node shows table details in a graphical representation:
-- The top bar has a `details toggle button` that is used to toggle column details visibility. There is also a `note button` that is visible only if there is some note added. you can click on this button to quickly change the note.
-- The first row shows the schema name of the table. Eg. `public` in above image.
-- The second row shows the table name. Eg. `users` in above image.
-- All other rows below the table name are the columns of the table along with data type. If the column is a primary key then it will have lock key icon eg. id is the primary key in above image. Otherwise, it will have column icon.
-- You can click on the node and drag to move on the canvas.
-- Upon double click on the table node or by clicking the edit button from the toolbar, the table dialog opens where you can change the table details. Refer [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
+- On the top bar:
+ - To show column details, select **Details toggle**.
+ - When you add a note, **Note** enables. Select **Note** to changes notes.
+- The first row displays the table's schema name, like `public` in the example.
+- The second row displays the table's name, like `users` in the example.
+- The remaining rows dispaly the table's column names and their data types. If the column is a primary key, then a lock key displays, like `id integer` in the example. Otherwise, a column displays, like `email character varying` in the example.
+- Select the node to drag and move it on the canvas.
+- To open the table dialog box and change the table details, either double-click on the table node or select **Edit** on the toolbar. Refer to [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
-## One to many link dialog
+## One-to-many link dialog box
-
+
-The one to many link dialog allows you to:
+The one-to-many link dialog box allows you to:
- Add a foregin key relationship between two tables.
-- `Local Table` is the table that references a table and has the `many` end point.
-- `Local Column` is the column that references.
-- `Referenced Table` is the table that is being referred and has the `one` end point.
-- `Referenced Column` is the column that is being referred.
+- Select a Local Table that references another table. The Local Table has the `many` end point.
+- Select a Local Column that references another column.
+- Select the Referenced Table. The Referenced Table has the `one` end point.
+- Select the Referenced Column.
-## Many to many link dialog
+## Many-to-many link dialog box
-
+
-The many to many link dialog allows you to:
+The many-to-many link dialog box allows you to:
-- Add a many to many relationship between two tables.
-- It creates a relationship tables having columns derived from the two tables and link them to the tables.
-- `Left Table` is the first table that is to be linked. It will receive the `one` endpoint of the link with the new relation table.
-- `Left Column` is the column of the first table, that will always be a primary key.
-- `Right Table` is the second table that is to be linked. It will receive the `one` endpoint of the link with the new relation table.
-- `Right Column` is the column of the second table, that will always be a primary key.
+- Add a many-to-many relationship between two tables.
+- Create a relation table with linked columns that are derived from the two tables.
+- Select the Left Table, which is the first table that is linked. The Left Table has the `one` endpoint of the link with the new relation table.
+- Select the Left table Column, which is the first table's column. The Left table Column is a primary key.
+- Select the Right Table, which is the second table that is linked. The Right Table has the `one` endpoint of the link with the new relation table.
+- Select the Right table Column, which is the second table's column. The Right table Column is a primary key.
## Table link
@@ -129,15 +131,16 @@ The many to many link dialog allows you to:
The table link shows relationship between tables:
-- The single line endpoint of the link shows the column that is being referred.
-- The three line endpoint of the link shows the column that refers.
-- If one of the columns that is being referred or that refers is removed from the table then the link will get dropped.
-- You can click on the link and drag to move on the canvas.
+- The single line endpoint of the link shows the column that is the reference.
+- The three line endpoint of the link shows the column that references.
+- If one of the columns that is a reference or that references is removed from the table, then the link drops.
+- Select the link to drag and move it on the canvas.
## Table notes
-- You can use the notes popup to mark some notes while designing the database.
-- You open the pop-up using the toolbar note button.
-- If some note is added to a table then it will have notes button on the table node. You can click on the button to check/update notes.
+- To add a note to a table:
+ 1. On the toolbar, select **Add/Edit note**.
+ 1. In the window, enter your note.
+- When a note is added to a table, **Note** enables on the Table node. To check or update notes, select **Note**.
From 5da1d2bd7d1f0e4ba43e5eb4a92ee22d87ce4ce4 Mon Sep 17 00:00:00 2001
From: Chris Estes <106166814+ccestes@users.noreply.github.com>
Date: Fri, 1 Jul 2022 09:37:22 -0400
Subject: [PATCH 07/13] ERD tool second pass
---
product_docs/docs/pem/8/pem_erd_tool.mdx | 24 +++++++++++++-----------
1 file changed, 13 insertions(+), 11 deletions(-)
diff --git a/product_docs/docs/pem/8/pem_erd_tool.mdx b/product_docs/docs/pem/8/pem_erd_tool.mdx
index 9f7579ec4e3..d38ed7010a3 100644
--- a/product_docs/docs/pem/8/pem_erd_tool.mdx
+++ b/product_docs/docs/pem/8/pem_erd_tool.mdx
@@ -15,7 +15,7 @@ The Entity-Relationship Diagram (ERD) tool is a database design tool that provid
- Add notes to the diagram.
- Auto-align the tables and links for cleaner visualization.
- Save the diagram and open it later to continue working on it.
-- Generate ready to run SQL from the database design.
+- Generate ready-to-run SQL from the database design.
- Generate the database diagram for an existing database.
@@ -33,14 +33,14 @@ The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to freq
| Icon | Behavior | Shortcut |
| ----------- | -------------------------------------------------------------------------------------------------------------- | ---------------- |
| Open File | Load a previously saved diagram. | Ctrl + O |
-| Save | Perform a quick-save of a previously saved diagram or to save the diagram to a file. | Ctrl + S |
+| Save | Perform a quick-save of a previously saved diagram or save the diagram to a file. | Ctrl + S |
| Save as | Open a new browser dialog box and specify a new location to save the diagram. | Ctrl + Shift + S |
## Export options
| Icon | Behavior | Shortcut |
| ---------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ----------------- |
-| Generate SQL | Generate the DDL SQL for the diagram and open a query tool with the generated SQL ready for execution. | Option + Ctrl + S |
+| Generate SQL | Generate the DDL SQL for the diagram and open a Query tool with the generated SQL ready for execution. | Option + Ctrl + S |
| Download image | Save the ERD diagram in an image format. | Option + Ctrl + I |
## Editing options
@@ -56,15 +56,15 @@ The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to freq
| Icon | Behavior | Shortcut |
| ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
-| 1M | Open a one-to-many relationship dialog box to add a relationship between the two tables. The selected table is the referencing table and has the `many` endpoint of the link. | Option/Alt + Ctrl + O |
-| MM | Open a many-to-many relationship dialog box to add a relationship between the two tables. This options creates a new, linked table from the selected columns of the two relating tables. | Option/Alt + Ctrl + M |
+| 1M | Open a one-to-many relationship dialog box to add a relationship between two tables. The selected table is the referencing table and has the `many` endpoint of the link. | Option/Alt + Ctrl + O |
+| MM | Open a many-to-many relationship dialog box to add a relationship between two tables. This options creates a new, linked table from the selected columns of the two relating tables. | Option/Alt + Ctrl + M |
## Utility Options
| Icon | Behavior | Shortcut |
| --------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------- |
| Add/Edit note | Make notes on tables nodes while designing the database. | Option/Alt + Ctrl + N |
-| Auto align | Auto-align all tables and links to make it look cleaner. | Option/Alt + Ctrl + L |
+| Auto align | Auto-align all tables and links for a cleaner look. | Option/Alt + Ctrl + L |
| Show details | Toggle the column details. You can also choose to show few or more column details. | Option/Alt + Shift + D |
## Zoom options
@@ -83,7 +83,7 @@ The table dialog box allows you to:
- Change the table structure details.
- Edit an existing table or add a new one.
-- Refer [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
+- Refer to [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
## Table node
@@ -96,7 +96,9 @@ The table node shows table details in a graphical representation:
- When you add a note, **Note** enables. Select **Note** to changes notes.
- The first row displays the table's schema name, like `public` in the example.
- The second row displays the table's name, like `users` in the example.
-- The remaining rows dispaly the table's column names and their data types. If the column is a primary key, then a lock key displays, like `id integer` in the example. Otherwise, a column displays, like `email character varying` in the example.
+- The remaining rows dispaly the table's column names and their data types.
+ - A column that is a primary key displays as a lock key, like `id integer` in the example.
+ - Other columns diplay as a green column, like `email character varying` in the example.
- Select the node to drag and move it on the canvas.
- To open the table dialog box and change the table details, either double-click on the table node or select **Edit** on the toolbar. Refer to [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
@@ -129,10 +131,10 @@ The many-to-many link dialog box allows you to:
-The table link shows relationship between tables:
+The table link shows the relationship between tables:
-- The single line endpoint of the link shows the column that is the reference.
-- The three line endpoint of the link shows the column that references.
+- The single-line endpoint of the link shows the column that is the reference.
+- The three-line endpoint of the link shows the column that references.
- If one of the columns that is a reference or that references is removed from the table, then the link drops.
- Select the link to drag and move it on the canvas.
From d24172dab4942e439ad33cf9d19a54a5d47d2e13 Mon Sep 17 00:00:00 2001
From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com>
Date: Mon, 4 Jul 2022 15:21:42 +0530
Subject: [PATCH 08/13] ODBC connector- Debian Ubuntu install topics
---
install_template/config.yaml | 18 +++--
install_template/deploy.mjs | 12 +++-
.../templates/platformBase/debian.njk | 4 +-
.../templates/platformBase/ubuntu.njk | 4 +-
.../products/edb-odbc-connector/debian-10.njk | 2 +-
.../products/edb-odbc-connector/debian-9.njk | 2 +-
.../products/edb-odbc-connector/debian.njk | 7 ++
.../edb-odbc-connector/ubuntu-18.04.njk | 3 +-
.../edb-odbc-connector/ubuntu-20.04.njk | 3 +-
.../products/edb-odbc-connector/ubuntu.njk | 7 ++
.../x86_amd64/08_efm4_deb10_x86.mdx | 53 +++++++++++++++
.../x86_amd64/08a_efm4_deb9_x86.mdx | 52 ++++++++++++++
.../x86_amd64/08_hadoop_deb10_x86.mdx | 42 ++++++++++++
.../x86_amd64/08a_hadoop_deb9_x86.mdx | 41 +++++++++++
.../x86_amd64/08_mongo_deb10_x86.mdx | 42 ++++++++++++
.../x86_amd64/08a_mongo_deb9_x86.mdx | 41 +++++++++++
.../x86_amd64/07_odbc13_ubuntu20_x86.mdx | 68 ++++++++-----------
.../x86_amd64/07a_odbc13_ubuntu18_x86.mdx | 60 ++++++++--------
.../x86_amd64/08_odbc13_deb10_x86.mdx | 68 ++++++++-----------
.../x86_amd64/08a_odbc13_deb9_x86.mdx | 61 ++++++++---------
.../x86_amd64/08_postgis_deb10_x86.mdx | 42 ++++++++++++
.../x86_amd64/08a_postgis_deb9_x86.mdx | 41 +++++++++++
22 files changed, 512 insertions(+), 161 deletions(-)
create mode 100644 install_template/templates/products/edb-odbc-connector/debian.njk
create mode 100644 install_template/templates/products/edb-odbc-connector/ubuntu.njk
create mode 100644 product_docs/docs/efm/4/03_installing_efm/x86_amd64/08_efm4_deb10_x86.mdx
create mode 100644 product_docs/docs/efm/4/03_installing_efm/x86_amd64/08a_efm4_deb9_x86.mdx
create mode 100644 product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/08_hadoop_deb10_x86.mdx
create mode 100644 product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/08a_hadoop_deb9_x86.mdx
create mode 100644 product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/08_mongo_deb10_x86.mdx
create mode 100644 product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/08a_mongo_deb9_x86.mdx
create mode 100644 product_docs/docs/postgis/3.1/01a_installing_postgis/installing_on_linux/x86_amd64/08_postgis_deb10_x86.mdx
create mode 100644 product_docs/docs/postgis/3.1/01a_installing_postgis/installing_on_linux/x86_amd64/08a_postgis_deb9_x86.mdx
diff --git a/install_template/config.yaml b/install_template/config.yaml
index 350cb752c76..651dceb91b6 100644
--- a/install_template/config.yaml
+++ b/install_template/config.yaml
@@ -118,25 +118,31 @@ products:
- name: CentOS 7
arch: x86_64
supported versions: [13.1.0.2]
- - name: CentOS 7
+ - name: RHEL 8
arch: ppc64le
supported versions: [13.1.0.2]
- name: AlmaLinux 8 or Rocky Linux 8
arch: x86_64
supported versions: [13.1.0.2]
- - name: RHEL 7 or OL 7
+ - name: RHEL 7
arch: x86_64
supported versions: [13.1.0.2]
- - name: RHEL 7 or OL 7
+ - name: RHEL 7
arch: ppc64le
supported versions: [13.1.0.2]
- - name: RHEL 8 or OL 8
+ - name: RHEL 8
arch: x86_64
supported versions: [13.1.0.2]
- - name: Ubuntu 18.04 or Debian 9
+ - name: Debian 9
arch: x86_64
supported versions: [13.1.0.2]
- - name: Ubuntu 20.04 or Debian 10
+ - name: Debian 10
+ arch: x86_64
+ supported versions: [13.1.0.2]
+ - name: Ubuntu 18.04
+ arch: x86_64
+ supported versions: [13.1.0.2]
+ - name: Ubuntu 20.04
arch: x86_64
supported versions: [13.1.0.2]
- name: SLES 12
diff --git a/install_template/deploy.mjs b/install_template/deploy.mjs
index 2e699190dfb..d7d93b009bb 100644
--- a/install_template/deploy.mjs
+++ b/install_template/deploy.mjs
@@ -81,8 +81,8 @@ const moveDoc = async (product, platform, version) => {
sles_12_x86_64: "06",
"ubuntu_20.04_x86_64": "07",
"ubuntu_18.04_x86_64": "07a",
- debian_10_x86_64: "07b",
- debian_9_x86_64: "08",
+ debian_10_x86_64: "08",
+ debian_9_x86_64: "08a",
rhel_8_ppc64le: "09",
rhel_7_ppc64le: "10",
sles_15_ppc64le: "11",
@@ -212,6 +212,14 @@ const moveDoc = async (product, platform, version) => {
(ctx) => `odbc_connector/13/03_installing_edb_odbc/01_installing_linux/${fmtArchPath(ctx)}/${prefix[plat]}_odbc13_sles12_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "EDB ODBC Connector"}, platform: {name: "SLES 15"}},
(ctx) => `odbc_connector/13/03_installing_edb_odbc/01_installing_linux/${fmtArchPath(ctx)}/${prefix[plat]}_odbc13_sles15_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB ODBC Connector"}, platform: {name: "Debian 9"}},
+ (ctx) => `odbc_connector/13/03_installing_edb_odbc/01_installing_linux/${fmtArchPath(ctx)}/${prefix[plat]}_odbc13_deb9_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB ODBC Connector"}, platform: {name: "Debian 10"}},
+ (ctx) => `odbc_connector/13/03_installing_edb_odbc/01_installing_linux/${fmtArchPath(ctx)}/${prefix[plat]}_odbc13_deb10_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB ODBC Connector"}, platform: {name: "Ubuntu 18.04"}},
+ (ctx) => `odbc_connector/13/03_installing_edb_odbc/01_installing_linux/${fmtArchPath(ctx)}/${prefix[plat]}_odbc13_ubuntu18_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB ODBC Connector"}, platform: {name: "Ubuntu 20.04"}},
+ (ctx) => `odbc_connector/13/03_installing_edb_odbc/01_installing_linux/${fmtArchPath(ctx)}/${prefix[plat]}_odbc13_ubuntu20_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "EDB pgBouncer", version: 1.16}, platform: {name: "SLES 12"}},
(ctx) => `pgbouncer/1.16/01_installation/install_on_linux/${fmtArchPath(ctx)}/${prefix[plat]}_pgbouncer_sles12_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "EDB pgBouncer", version: 1.16}, platform: {name: "SLES 15"}},
diff --git a/install_template/templates/platformBase/debian.njk b/install_template/templates/platformBase/debian.njk
index 3de764d017b..6ddccbf9a0b 100644
--- a/install_template/templates/platformBase/debian.njk
+++ b/install_template/templates/platformBase/debian.njk
@@ -22,8 +22,8 @@ apt-get update
```
{% endblock prerequisites %}
-{% block installCommand %}
+{% block installCommand %}{% block odbcconnector %}
```shell
apt-get install {{ packageName }}
```
-{% endblock installCommand %}
\ No newline at end of file
+{% endblock odbcconnector %}{% endblock installCommand %}
\ No newline at end of file
diff --git a/install_template/templates/platformBase/ubuntu.njk b/install_template/templates/platformBase/ubuntu.njk
index 4c927ecc450..0b8901a945a 100644
--- a/install_template/templates/platformBase/ubuntu.njk
+++ b/install_template/templates/platformBase/ubuntu.njk
@@ -21,8 +21,8 @@ apt-get update
```
{% endblock prerequisites %}
-{% block installCommand %}
+{% block installCommand %}{% block odbcconnector %}
```shell
apt-get install {{ packageName }}
```
-{% endblock installCommand %}
+{% endblock odbcconnector %}{% endblock installCommand %}
diff --git a/install_template/templates/products/edb-odbc-connector/debian-10.njk b/install_template/templates/products/edb-odbc-connector/debian-10.njk
index c3b68f87253..a743c425dc6 100644
--- a/install_template/templates/products/edb-odbc-connector/debian-10.njk
+++ b/install_template/templates/products/edb-odbc-connector/debian-10.njk
@@ -1,2 +1,2 @@
-{% extends "products/edb-odbc-connector/base.njk" %}
+{% extends "products/edb-odbc-connector/debian.njk" %}
{% set platformBaseTemplate = "debian-10" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-odbc-connector/debian-9.njk b/install_template/templates/products/edb-odbc-connector/debian-9.njk
index 217e336fbf1..aa1b7359224 100644
--- a/install_template/templates/products/edb-odbc-connector/debian-9.njk
+++ b/install_template/templates/products/edb-odbc-connector/debian-9.njk
@@ -1,2 +1,2 @@
-{% extends "products/edb-odbc-connector/base.njk" %}
+{% extends "products/edb-odbc-connector/debian.njk" %}
{% set platformBaseTemplate = "debian-9" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-odbc-connector/debian.njk b/install_template/templates/products/edb-odbc-connector/debian.njk
new file mode 100644
index 00000000000..118cddceb0d
--- /dev/null
+++ b/install_template/templates/products/edb-odbc-connector/debian.njk
@@ -0,0 +1,7 @@
+{% extends "products/edb-odbc-connector/base.njk" %}
+{% block odbcconnector %}
+```shell
+apt-get install {{ packageName }}
+apt-get install {{ packageName }}-dev
+```
+{% endblock odbcconnector %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-odbc-connector/ubuntu-18.04.njk b/install_template/templates/products/edb-odbc-connector/ubuntu-18.04.njk
index 05bcce6ea77..efc9a2eba6d 100644
--- a/install_template/templates/products/edb-odbc-connector/ubuntu-18.04.njk
+++ b/install_template/templates/products/edb-odbc-connector/ubuntu-18.04.njk
@@ -1 +1,2 @@
-{% extends "products/edb-odbc-connector/debian-10.njk" %}
+{% extends "products/edb-odbc-connector/ubuntu.njk" %}
+{% set platformBaseTemplate = "ubuntu-18.04" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-odbc-connector/ubuntu-20.04.njk b/install_template/templates/products/edb-odbc-connector/ubuntu-20.04.njk
index 05bcce6ea77..cf8a74e927f 100644
--- a/install_template/templates/products/edb-odbc-connector/ubuntu-20.04.njk
+++ b/install_template/templates/products/edb-odbc-connector/ubuntu-20.04.njk
@@ -1 +1,2 @@
-{% extends "products/edb-odbc-connector/debian-10.njk" %}
+{% extends "products/edb-odbc-connector/ubuntu.njk" %}
+{% set platformBaseTemplate = "ubuntu-20.04" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-odbc-connector/ubuntu.njk b/install_template/templates/products/edb-odbc-connector/ubuntu.njk
new file mode 100644
index 00000000000..118cddceb0d
--- /dev/null
+++ b/install_template/templates/products/edb-odbc-connector/ubuntu.njk
@@ -0,0 +1,7 @@
+{% extends "products/edb-odbc-connector/base.njk" %}
+{% block odbcconnector %}
+```shell
+apt-get install {{ packageName }}
+apt-get install {{ packageName }}-dev
+```
+{% endblock odbcconnector %}
\ No newline at end of file
diff --git a/product_docs/docs/efm/4/03_installing_efm/x86_amd64/08_efm4_deb10_x86.mdx b/product_docs/docs/efm/4/03_installing_efm/x86_amd64/08_efm4_deb10_x86.mdx
new file mode 100644
index 00000000000..cce8007b8a8
--- /dev/null
+++ b/product_docs/docs/efm/4/03_installing_efm/x86_amd64/08_efm4_deb10_x86.mdx
@@ -0,0 +1,53 @@
+---
+navTitle: Debian 10
+title: Installing Failover Manager on Debian 10 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the EDB repository
+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
+
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-efm<4x>
+```
+
+Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.0, the package name would be `edb-efm40`.
+
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1. Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2. Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3. If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4. Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/product_docs/docs/efm/4/03_installing_efm/x86_amd64/08a_efm4_deb9_x86.mdx b/product_docs/docs/efm/4/03_installing_efm/x86_amd64/08a_efm4_deb9_x86.mdx
new file mode 100644
index 00000000000..1a802df25fc
--- /dev/null
+++ b/product_docs/docs/efm/4/03_installing_efm/x86_amd64/08a_efm4_deb9_x86.mdx
@@ -0,0 +1,52 @@
+---
+navTitle: Debian 9
+title: Installing Failover Manager on Debian 9 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the repository by replacing 'USERNAME:PASSWORD' with your
+# username and password for the EDB repositories.
+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
+# This creates the /etc/apt/sources.list.d/edb-stretch.list
+# configuration file.
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-efm<4x>
+```
+
+Where `<4x>` is the version of Failover Manager that you are installing. For example, if you are installing version 4.0, the package name would be `edb-efm40`.
+
+## Initial configuration
+
+If you are using Failover Manager to monitor a cluster owned by a user other than enterprisedb or postgres, see [Extending Failover Manager permissions](../../04_configuring_efm/04_extending_efm_permissions/#extending_efm_permissions).
+
+After installing on each node of the cluster:
+
+1. Modify the [cluster properties file](../../04_configuring_efm/01_cluster_properties/#cluster_properties) on each node.
+2. Modify the [cluster members file](../../04_configuring_efm/03_cluster_members/#cluster_members) on each node.
+3. If applicable, configure and test virtual IP address settings and any scripts that are identified in the cluster properties file.
+4. Start the agent on each node of the cluster. For more information, see [Controlling the Failover Manager service](../../08_controlling_efm_service/#controlling-the-failover-manager-service).
diff --git a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/08_hadoop_deb10_x86.mdx b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/08_hadoop_deb10_x86.mdx
new file mode 100644
index 00000000000..4890f1a9562
--- /dev/null
+++ b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/08_hadoop_deb10_x86.mdx
@@ -0,0 +1,42 @@
+---
+navTitle: Debian 10
+title: Installing Hadoop Foreign Data Wrapper on Debian 10 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the EDB repository
+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
+
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-as14-hdfs_fdw
+```
+
+Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using.
diff --git a/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/08a_hadoop_deb9_x86.mdx b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/08a_hadoop_deb9_x86.mdx
new file mode 100644
index 00000000000..2635c657b4c
--- /dev/null
+++ b/product_docs/docs/hadoop_data_adapter/2/05_installing_the_hadoop_data_adapter/x86_amd64/08a_hadoop_deb9_x86.mdx
@@ -0,0 +1,41 @@
+---
+navTitle: Debian 9
+title: Installing Hadoop Foreign Data Wrapper on Debian 9 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the repository by replacing 'USERNAME:PASSWORD' with your
+# username and password for the EDB repositories.
+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
+# This creates the /etc/apt/sources.list.d/edb-stretch.list
+# configuration file.
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-as14-hdfs_fdw
+```
+
+Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using.
diff --git a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/08_mongo_deb10_x86.mdx b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/08_mongo_deb10_x86.mdx
new file mode 100644
index 00000000000..15d9b67716d
--- /dev/null
+++ b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/08_mongo_deb10_x86.mdx
@@ -0,0 +1,42 @@
+---
+navTitle: Debian 10
+title: Installing MongoDB Foreign Data Wrapper on Debian 10 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the EDB repository
+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
+
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-as14-mongo_fdw
+```
+
+Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using.
diff --git a/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/08a_mongo_deb9_x86.mdx b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/08a_mongo_deb9_x86.mdx
new file mode 100644
index 00000000000..febaec05a00
--- /dev/null
+++ b/product_docs/docs/mongo_data_adapter/5/04_installing_the_mongo_data_adapter/x86_amd64/08a_mongo_deb9_x86.mdx
@@ -0,0 +1,41 @@
+---
+navTitle: Debian 9
+title: Installing MongoDB Foreign Data Wrapper on Debian 9 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the repository by replacing 'USERNAME:PASSWORD' with your
+# username and password for the EDB repositories.
+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
+# This creates the /etc/apt/sources.list.d/edb-stretch.list
+# configuration file.
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-as14-mongo_fdw
+```
+
+Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using.
diff --git a/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/07_odbc13_ubuntu20_x86.mdx b/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/07_odbc13_ubuntu20_x86.mdx
index f68ad64e8d9..251c9e17e69 100644
--- a/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/07_odbc13_ubuntu20_x86.mdx
+++ b/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/07_odbc13_ubuntu20_x86.mdx
@@ -1,53 +1,41 @@
---
-title: "Installing EDB ODBC Connector on Ubuntu 20.04 x86"
-navTitle: "Ubuntu 20.04"
+navTitle: Ubuntu 20.04
+title: Installing EDB ODBC Connector on Ubuntu 20.04 x86_64
---
-To install a DEB package 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 [EDB website](https://www.enterprisedb.com/repository-access-request/).
+Before you begin the installation process, log in as superuser.
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+```shell
+# To log in as a superuser:
+sudo su -
+```
-1. Assume superuser privileges:
+## Set up the repository
- ```text
- sudo su –
- ```
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
-2. Configure the EDB repository:
+```shell
+# Set up the EDB repository
+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
- 1. Set up the EDB repository:
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
- ```text
- -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'
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
- 2. Substitute your EDB credentials for the `username` and `password` in the following command:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf'
- ```
+# Update the repository metadata:
+apt-get update
+```
-3. Add support to your system for secure APT repositories:
+## Install the package
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-odbc
- apt-get install edb-odbc-dev
- ```
\ No newline at end of file
+```shell
+apt-get install edb-odbc
+apt-get install edb-odbc-dev
+```
diff --git a/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/07a_odbc13_ubuntu18_x86.mdx b/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/07a_odbc13_ubuntu18_x86.mdx
index 9b59e5140f3..afd510a4db1 100644
--- a/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/07a_odbc13_ubuntu18_x86.mdx
+++ b/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/07a_odbc13_ubuntu18_x86.mdx
@@ -1,45 +1,41 @@
---
-title: "Installing EDB ODBC Connector on Ubuntu 18.04 x86"
-navTitle: "Ubuntu 18.04"
+navTitle: Ubuntu 18.04
+title: Installing EDB ODBC Connector on Ubuntu 18.04 x86_64
---
-To install a DEB package 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 [EDB website](https://www.enterprisedb.com/repository-access-request/).
+Before you begin the installation process, log in as superuser.
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+```shell
+# To log in as a superuser:
+sudo su -
+```
-1. Assume superuser privileges:
+## Set up the repository
- ```text
- sudo su –
- ```
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
-2. Configure the EDB repository:
+```shell
+# Set up the EDB repository
+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
- ```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'
- ```
-
-3. Add support to your system for secure APT repositories:
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
- ```text
- apt-get install apt-transport-https
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
-4. Add the EDB signing key:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
+# Update the repository metadata:
+apt-get update
+```
-5. Update the repository metadata:
+## Install the package
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-odbc
- apt-get install edb-odbc-dev
- ```
\ No newline at end of file
+```shell
+apt-get install edb-odbc
+apt-get install edb-odbc-dev
+```
diff --git a/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/08_odbc13_deb10_x86.mdx b/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/08_odbc13_deb10_x86.mdx
index 36fe99230bf..4e8485073b5 100644
--- a/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/08_odbc13_deb10_x86.mdx
+++ b/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/08_odbc13_deb10_x86.mdx
@@ -1,53 +1,41 @@
---
-title: "Installing EDB ODBC Connector on Debian 10 x86"
-navTitle: "Debian 10"
+navTitle: Debian 10
+title: Installing EDB ODBC Connector on Debian 10 x86_64
---
-To install a DEB package 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 [EDB website](https://www.enterprisedb.com/repository-access-request/).
+Before you begin the installation process, log in as superuser.
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+```shell
+# To log in as a superuser:
+sudo su -
+```
-1. Assume superuser privileges:
+## Set up the repository
- ```text
- sudo su –
- ```
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
-2. Configure the EDB repository:
+```shell
+# Set up the EDB repository
+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
- 1. Set up the EDB repository:
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
- ```text
- -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'
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
- 2. Substitute your EDB credentials for the `username` and `password` in the following command:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf'
- ```
+# Update the repository metadata:
+apt-get update
+```
-3. Add support to your system for secure APT repositories:
+## Install the package
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-odbc
- apt-get install edb-odbc-dev
- ```
\ No newline at end of file
+```shell
+apt-get install edb-odbc
+apt-get install edb-odbc-dev
+```
diff --git a/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/08a_odbc13_deb9_x86.mdx b/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/08a_odbc13_deb9_x86.mdx
index 997cc43f389..ad789d7f0b1 100644
--- a/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/08a_odbc13_deb9_x86.mdx
+++ b/product_docs/docs/odbc_connector/13/03_installing_edb_odbc/01_installing_linux/x86_amd64/08a_odbc13_deb9_x86.mdx
@@ -1,45 +1,40 @@
---
-title: "Installing EDB ODBC Connector on Debian 9 x86"
-navTitle: "Debian 9"
+navTitle: Debian 9
+title: Installing EDB ODBC Connector on Debian 9 x86_64
---
-To install a DEB package 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 [EDB website](https://www.enterprisedb.com/repository-access-request/).
+Before you begin the installation process, log in as superuser.
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+```shell
+# To log in as a superuser:
+sudo su -
+```
-1. Assume superuser privileges:
+## Set up the repository
- ```text
- sudo su –
- ```
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
-2. Configure the EDB repository:
+```shell
+# Set up the repository by replacing 'USERNAME:PASSWORD' with your
+# username and password for the EDB repositories.
+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
+# This creates the /etc/apt/sources.list.d/edb-stretch.list
+# configuration file.
- ```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'
- ```
-
-3. Add support to your system for secure APT repositories:
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
- ```text
- apt-get install apt-transport-https
- ```
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
-4. Add the EDB signing key:
+# Update the repository metadata:
+apt-get update
+```
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
+## Install the package
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-odbc
- apt-get install edb-odbc-dev
- ```
\ No newline at end of file
+```shell
+apt-get install edb-odbc
+apt-get install edb-odbc-dev
+```
diff --git a/product_docs/docs/postgis/3.1/01a_installing_postgis/installing_on_linux/x86_amd64/08_postgis_deb10_x86.mdx b/product_docs/docs/postgis/3.1/01a_installing_postgis/installing_on_linux/x86_amd64/08_postgis_deb10_x86.mdx
new file mode 100644
index 00000000000..0376f6c14a1
--- /dev/null
+++ b/product_docs/docs/postgis/3.1/01a_installing_postgis/installing_on_linux/x86_amd64/08_postgis_deb10_x86.mdx
@@ -0,0 +1,42 @@
+---
+navTitle: Debian 10
+title: Installing PostGIS on Debian 10 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the EDB repository
+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
+
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-as14-postgis3
+```
+
+Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using.
diff --git a/product_docs/docs/postgis/3.1/01a_installing_postgis/installing_on_linux/x86_amd64/08a_postgis_deb9_x86.mdx b/product_docs/docs/postgis/3.1/01a_installing_postgis/installing_on_linux/x86_amd64/08a_postgis_deb9_x86.mdx
new file mode 100644
index 00000000000..97faecb27b0
--- /dev/null
+++ b/product_docs/docs/postgis/3.1/01a_installing_postgis/installing_on_linux/x86_amd64/08a_postgis_deb9_x86.mdx
@@ -0,0 +1,41 @@
+---
+navTitle: Debian 9
+title: Installing PostGIS on Debian 9 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the repository by replacing 'USERNAME:PASSWORD' with your
+# username and password for the EDB repositories.
+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
+# This creates the /etc/apt/sources.list.d/edb-stretch.list
+# configuration file.
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-as14-postgis3
+```
+
+Where `14` is the version of EDB Postgres Advanced Server. Replace `14` with the version of EDB Postgres Advanced Server you are using.
From 83edc746c296fd50008f7ea517767c8ea9dc425a Mon Sep 17 00:00:00 2001
From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com>
Date: Mon, 4 Jul 2022 16:04:37 +0530
Subject: [PATCH 09/13] Generated and deployed current Debian/Ubuntu topics for
OCL connector
---
install_template/config.yaml | 18 +++--
install_template/deploy.mjs | 12 ++++
.../products/edb-ocl-connector/debian-10.njk | 2 +-
.../products/edb-ocl-connector/debian-9.njk | 2 +-
.../products/edb-ocl-connector/debian.njk | 7 ++
.../edb-ocl-connector/ubuntu-18.04.njk | 3 +-
.../edb-ocl-connector/ubuntu-20.04.njk | 3 +-
.../products/edb-ocl-connector/ubuntu.njk | 7 ++
.../05_ocl_connector14_ubuntu20_x86.mdx | 68 ++++++++-----------
.../05a_ocl_connector14_ubuntu18_x86.mdx | 68 ++++++++-----------
.../05b_ocl_connector14_deb10_x86.mdx | 68 ++++++++-----------
.../x86_amd64/06_ocl_connector14_deb9_x86.mdx | 68 ++++++++-----------
12 files changed, 156 insertions(+), 170 deletions(-)
create mode 100644 install_template/templates/products/edb-ocl-connector/debian.njk
create mode 100644 install_template/templates/products/edb-ocl-connector/ubuntu.njk
diff --git a/install_template/config.yaml b/install_template/config.yaml
index 651dceb91b6..3fb447e7b97 100644
--- a/install_template/config.yaml
+++ b/install_template/config.yaml
@@ -80,25 +80,31 @@ products:
- name: CentOS 7
arch: x86_64
supported versions: [14.1.0.1]
- - name: CentOS 7
+ - name: RHEL 8
arch: ppc64le
supported versions: [14.1.0.1]
- name: AlmaLinux 8 or Rocky Linux 8
arch: x86_64
supported versions: [14.1.0.1]
- - name: RHEL 7 or OL 7
+ - name: RHEL 7
arch: x86_64
supported versions: [14.1.0.1]
- - name: RHEL 7 or OL 7
+ - name: RHEL 7
arch: ppc64le
supported versions: [14.1.0.1]
- - name: RHEL 8 or OL 8
+ - name: RHEL 8
arch: x86_64
supported versions: [14.1.0.1]
- - name: Ubuntu 18.04 or Debian 9
+ - name: Debian 9
arch: x86_64
supported versions: [14.1.0.1]
- - name: Ubuntu 20.04 or Debian 10
+ - name: Debian 10
+ arch: x86_64
+ supported versions: [14.1.0.1]
+ - name: Ubuntu 18.04
+ arch: x86_64
+ supported versions: [14.1.0.1]
+ - name: Ubuntu 20.04
arch: x86_64
supported versions: [14.1.0.1]
- name: SLES 12
diff --git a/install_template/deploy.mjs b/install_template/deploy.mjs
index d7d93b009bb..3bc4f4826c8 100644
--- a/install_template/deploy.mjs
+++ b/install_template/deploy.mjs
@@ -105,6 +105,10 @@ const moveDoc = async (product, platform, version) => {
prefix["sles_12_x86_64"] = "04";
prefix["sles_15_ppc64le"] = "09";
prefix["sles_12_ppc64le"] = "10";
+ prefix["ubuntu_20.04_x86_64"] = "05";
+ prefix["ubuntu_18.04_x86_64"] = "05a";
+ prefix["debian_10_x86_64"] = "05b";
+ prefix["debian_9_x86_64"] = "06";
break;
}
@@ -208,6 +212,14 @@ const moveDoc = async (product, platform, version) => {
(ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/${prefix[plat]}_ocl_connector14_sles12_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "EDB OCL Connector"}, platform: {name: "SLES 15"}},
(ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/${prefix[plat]}_ocl_connector14_sles15_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB OCL Connector"}, platform: {name: "Debian 9"}},
+ (ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/${prefix[plat]}_ocl_connector14_deb9_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB OCL Connector"}, platform: {name: "Debian 10"}},
+ (ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/${prefix[plat]}_ocl_connector14_deb10_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB OCL Connector"}, platform: {name: "Ubuntu 18.04"}},
+ (ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/${prefix[plat]}_ocl_connector14_ubuntu18_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB OCL Connector"}, platform: {name: "Ubuntu 20.04"}},
+ (ctx) => `ocl_connector/${ctx.product.version}/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/${fmtArchPath(ctx)}/${prefix[plat]}_ocl_connector14_ubuntu20_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "EDB ODBC Connector"}, platform: {name: "SLES 12"}},
(ctx) => `odbc_connector/13/03_installing_edb_odbc/01_installing_linux/${fmtArchPath(ctx)}/${prefix[plat]}_odbc13_sles12_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "EDB ODBC Connector"}, platform: {name: "SLES 15"}},
diff --git a/install_template/templates/products/edb-ocl-connector/debian-10.njk b/install_template/templates/products/edb-ocl-connector/debian-10.njk
index df7c17ecae0..3f601d99e96 100644
--- a/install_template/templates/products/edb-ocl-connector/debian-10.njk
+++ b/install_template/templates/products/edb-ocl-connector/debian-10.njk
@@ -1,2 +1,2 @@
-{% extends "products/edb-ocl-connector/base.njk" %}
+{% extends "products/edb-ocl-connector/debian.njk" %}
{% set platformBaseTemplate = "debian-10" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-ocl-connector/debian-9.njk b/install_template/templates/products/edb-ocl-connector/debian-9.njk
index 69152bba6d4..ddf34b2b4c0 100644
--- a/install_template/templates/products/edb-ocl-connector/debian-9.njk
+++ b/install_template/templates/products/edb-ocl-connector/debian-9.njk
@@ -1,2 +1,2 @@
-{% extends "products/edb-ocl-connector/base.njk" %}
+{% extends "products/edb-ocl-connector/debian.njk" %}
{% set platformBaseTemplate = "debian-9" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-ocl-connector/debian.njk b/install_template/templates/products/edb-ocl-connector/debian.njk
new file mode 100644
index 00000000000..9bd573413b7
--- /dev/null
+++ b/install_template/templates/products/edb-ocl-connector/debian.njk
@@ -0,0 +1,7 @@
+{% extends "products/edb-ocl-connector/base.njk" %}
+{% block odbcconnector %}
+```shell
+apt-get install {{ packageName }}
+apt-get install {{ packageName }}-dev
+```
+{% endblock odbcconnector %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-ocl-connector/ubuntu-18.04.njk b/install_template/templates/products/edb-ocl-connector/ubuntu-18.04.njk
index 91a910513bd..0ac58e002eb 100644
--- a/install_template/templates/products/edb-ocl-connector/ubuntu-18.04.njk
+++ b/install_template/templates/products/edb-ocl-connector/ubuntu-18.04.njk
@@ -1 +1,2 @@
-{% extends "products/edb-ocl-connector/debian-10.njk" %}
+{% extends "products/edb-ocl-connector/ubuntu.njk" %}
+{% set platformBaseTemplate = "ubuntu-20.04" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-ocl-connector/ubuntu-20.04.njk b/install_template/templates/products/edb-ocl-connector/ubuntu-20.04.njk
index 91a910513bd..0ac58e002eb 100644
--- a/install_template/templates/products/edb-ocl-connector/ubuntu-20.04.njk
+++ b/install_template/templates/products/edb-ocl-connector/ubuntu-20.04.njk
@@ -1 +1,2 @@
-{% extends "products/edb-ocl-connector/debian-10.njk" %}
+{% extends "products/edb-ocl-connector/ubuntu.njk" %}
+{% set platformBaseTemplate = "ubuntu-20.04" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-ocl-connector/ubuntu.njk b/install_template/templates/products/edb-ocl-connector/ubuntu.njk
new file mode 100644
index 00000000000..9bd573413b7
--- /dev/null
+++ b/install_template/templates/products/edb-ocl-connector/ubuntu.njk
@@ -0,0 +1,7 @@
+{% extends "products/edb-ocl-connector/base.njk" %}
+{% block odbcconnector %}
+```shell
+apt-get install {{ packageName }}
+apt-get install {{ packageName }}-dev
+```
+{% endblock odbcconnector %}
\ No newline at end of file
diff --git a/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05_ocl_connector14_ubuntu20_x86.mdx b/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05_ocl_connector14_ubuntu20_x86.mdx
index 4d9c3860df6..9074f106842 100644
--- a/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05_ocl_connector14_ubuntu20_x86.mdx
+++ b/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05_ocl_connector14_ubuntu20_x86.mdx
@@ -1,53 +1,41 @@
---
-title: "Installing EDB OCL Connector on Ubuntu 20.04 x86"
-navTitle: "Ubuntu 20.04"
+navTitle: Ubuntu 20.04
+title: Installing EDB OCL Connector on Ubuntu 20.04 x86_64
---
+Before you begin the installation process, log in as superuser.
-To install a DEB package 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 EDB website](https://www.enterprisedb.com/repository-access-request).
+```shell
+# To log in as a superuser:
+sudo su -
+```
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+## Set up the repository
-1. Assume superuser privileges:
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
- ```text
- sudo su –
- ```
+```shell
+# Set up the EDB repository
+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
-1. Set up the EDB repository:
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
- ```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'
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
-1. Substitute your EDB credentials for the `username` and `password` in the following command:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/ edb.conf'
- ```
+# Update the repository metadata:
+apt-get update
+```
-3. Add support to your system for secure APT repositories:
-
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-oci
- apt-get install edb-oci-dev
- ```
+## Install the package
+```shell
+apt-get install edb-oci
+apt-get install edb-oci-dev
+```
diff --git a/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05a_ocl_connector14_ubuntu18_x86.mdx b/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05a_ocl_connector14_ubuntu18_x86.mdx
index e5cbc0fb5dd..14cbb0eb660 100644
--- a/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05a_ocl_connector14_ubuntu18_x86.mdx
+++ b/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05a_ocl_connector14_ubuntu18_x86.mdx
@@ -1,53 +1,41 @@
---
-title: "Installing EDB OCL Connector on Ubuntu 18.04 x86"
-navTitle: "Ubuntu 18.04"
+navTitle: Ubuntu 18.04
+title: Installing EDB OCL Connector on Ubuntu 18.04 x86_64
---
+Before you begin the installation process, log in as superuser.
-To install a DEB package 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 EDB website](https://www.enterprisedb.com/repository-access-request).
+```shell
+# To log in as a superuser:
+sudo su -
+```
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+## Set up the repository
-1. Assume superuser privileges:
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
- ```text
- sudo su –
- ```
+```shell
+# Set up the EDB repository
+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
-1. Set up the EDB repository:
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
- ```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'
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
-1. Substitute your EDB credentials for the `username` and `password` in the following command:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/ edb.conf'
- ```
+# Update the repository metadata:
+apt-get update
+```
-3. Add support to your system for secure APT repositories:
-
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-oci
- apt-get install edb-oci-dev
- ```
+## Install the package
+```shell
+apt-get install edb-oci
+apt-get install edb-oci-dev
+```
diff --git a/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05b_ocl_connector14_deb10_x86.mdx b/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05b_ocl_connector14_deb10_x86.mdx
index bea3dce8f06..0d4777e594a 100644
--- a/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05b_ocl_connector14_deb10_x86.mdx
+++ b/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/05b_ocl_connector14_deb10_x86.mdx
@@ -1,53 +1,41 @@
---
-title: "Installing EDB OCL Connector on Debian 10 x86"
-navTitle: "Debian 10"
+navTitle: Debian 10
+title: Installing EDB OCL Connector on Debian 10 x86_64
---
+Before you begin the installation process, log in as superuser.
-To install a DEB package 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 EDB website](https://www.enterprisedb.com/repository-access-request).
+```shell
+# To log in as a superuser:
+sudo su -
+```
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+## Set up the repository
-1. Assume superuser privileges:
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
- ```text
- sudo su –
- ```
+```shell
+# Set up the EDB repository
+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
-1. Set up the EDB repository:
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
- ```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'
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
-1. Substitute your EDB credentials for the `username` and `password` in the following command:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/ edb.conf'
- ```
+# Update the repository metadata:
+apt-get update
+```
-3. Add support to your system for secure APT repositories:
-
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-oci
- apt-get install edb-oci-dev
- ```
+## Install the package
+```shell
+apt-get install edb-oci
+apt-get install edb-oci-dev
+```
diff --git a/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/06_ocl_connector14_deb9_x86.mdx b/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/06_ocl_connector14_deb9_x86.mdx
index d5293fe346d..8263561675b 100644
--- a/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/06_ocl_connector14_deb9_x86.mdx
+++ b/product_docs/docs/ocl_connector/14.1.0.1/04_open_client_library/01_installing_and_configuring_the_ocl_connector/install_on_linux_using_edb_repo/x86_amd64/06_ocl_connector14_deb9_x86.mdx
@@ -1,52 +1,40 @@
---
-title: "Installing EDB OCL Connector on Debian 9 x86"
-navTitle: "Debian 9"
+navTitle: Debian 9
+title: Installing EDB OCL Connector on Debian 9 x86_64
---
-To install a DEB package 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 EDB website](https://www.enterprisedb.com/repository-access-request).
+Before you begin the installation process, log in as superuser.
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+```shell
+# To log in as a superuser:
+sudo su -
+```
-1. Assume superuser privileges:
+## Set up the repository
- ```text
- sudo su –
- ```
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
-2. Configure the EDB repository:
+```shell
+# Set up the repository by replacing 'USERNAME:PASSWORD' with your
+# username and password for the EDB repositories.
+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
+# This creates the /etc/apt/sources.list.d/edb-stretch.list
+# configuration file.
- ```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'
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
-2. Substitute your EDB credentials for the `username` and `password` in the following command:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf'
- ```
+# Update the repository metadata:
+apt-get update
+```
-3. Add support to your system for secure APT repositories:
-
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-oci
- apt-get install edb-oci-dev
- ```
+## Install the package
+```shell
+apt-get install edb-oci
+apt-get install edb-oci-dev
+```
From 09fa06de3c4896eb4118d2d612bafd205f2b9a2e Mon Sep 17 00:00:00 2001
From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com>
Date: Mon, 4 Jul 2022 16:24:15 +0530
Subject: [PATCH 10/13] Generated and deployed current Debian/Ubuntu topics
for JDBC connector
---
install_template/config.yaml | 22 ++++---
install_template/deploy.mjs | 8 +++
.../products/edb-jdbc-connector/base.njk | 12 +---
.../products/edb-jdbc-connector/sles-12.njk | 2 +-
.../edb-jdbc-connector/sles-12_ppc64le.njk | 2 +-
.../products/edb-jdbc-connector/sles-15.njk | 2 +-
.../edb-jdbc-connector/sles-15_ppc64le.njk | 2 +-
.../products/edb-jdbc-connector/sles.njk | 11 ++++
.../edb-jdbc-connector/ubuntu-18.04.njk | 3 +-
.../edb-jdbc-connector/ubuntu-20.04.njk | 3 +-
.../x86_amd64/07_jdbc42_ubuntu20_x86.mdx | 66 ++++++++-----------
.../x86_amd64/07a_jdbc42_ubuntu18_x86.mdx | 66 ++++++++-----------
.../x86_amd64/07b_jdbc42_deb10_x86.mdx | 52 ---------------
.../x86_amd64/08_jdbc42_deb10_x86.mdx | 40 +++++++++++
.../x86_amd64/08_jdbc42_deb9_x86.mdx | 47 -------------
.../x86_amd64/08a_jdbc42_deb9_x86.mdx | 39 +++++++++++
16 files changed, 175 insertions(+), 202 deletions(-)
create mode 100644 install_template/templates/products/edb-jdbc-connector/sles.njk
delete mode 100644 product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07b_jdbc42_deb10_x86.mdx
create mode 100644 product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08_jdbc42_deb10_x86.mdx
delete mode 100644 product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08_jdbc42_deb9_x86.mdx
create mode 100644 product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08a_jdbc42_deb9_x86.mdx
diff --git a/install_template/config.yaml b/install_template/config.yaml
index 3fb447e7b97..a8736f71806 100644
--- a/install_template/config.yaml
+++ b/install_template/config.yaml
@@ -4,27 +4,33 @@ products:
- name: CentOS 7
arch: x86_64
supported versions: [42.x.x]
- - name: CentOS 7
+ - name: RHEL 8
arch: ppc64le
supported versions: [42.x.x]
- name: AlmaLinux 8 or Rocky Linux 8
arch: x86_64
supported versions: [42.x.x]
- - name: RHEL 7 or OL 7
+ - name: RHEL 7
arch: x86_64
supported versions: [42.x.x]
- - name: RHEL 7 or OL 7
+ - name: RHEL 7
arch: ppc64le
supported versions: [42.x.x]
- - name: RHEL 8 or OL 8
+ - name: RHEL 8
arch: x86_64
supported versions: [42.x.x]
- - name: Ubuntu 18.04 or Debian 9
+ - name: Debian 9
arch: x86_64
- supported versions: [42.x.x]
- - name: Ubuntu 20.04 or Debian 10
+ supported versions: [42.3.3.1]
+ - name: Debian 10
arch: x86_64
- supported versions: [42.x.x]
+ supported versions: [42.3.3.1]
+ - name: Ubuntu 18.04
+ arch: x86_64
+ supported versions: [42.3.3.1]
+ - name: Ubuntu 20.04
+ arch: x86_64
+ supported versions: [42.3.3.1]
- name: SLES 12
arch: x86_64
supported versions: [42.3.3.1]
diff --git a/install_template/deploy.mjs b/install_template/deploy.mjs
index 3bc4f4826c8..7efa60297cf 100644
--- a/install_template/deploy.mjs
+++ b/install_template/deploy.mjs
@@ -188,6 +188,14 @@ const moveDoc = async (product, platform, version) => {
(ctx) => `jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/${fmtArchPath(ctx)}/${prefix[plat]}_jdbc42_sles12_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "EDB JDBC Connector"}, platform: {name: "SLES 15"}},
(ctx) => `jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/${fmtArchPath(ctx)}/${prefix[plat]}_jdbc42_sles15_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB JDBC Connector"}, platform: {name: "Debian 9"}},
+ (ctx) => `jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/${fmtArchPath(ctx)}/${prefix[plat]}_jdbc42_deb9_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB JDBC Connector"}, platform: {name: "Debian 10"}},
+ (ctx) => `jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/${fmtArchPath(ctx)}/${prefix[plat]}_jdbc42_deb10_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB JDBC Connector"}, platform: {name: "Ubuntu 18.04"}},
+ (ctx) => `jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/${fmtArchPath(ctx)}/${prefix[plat]}_jdbc42_ubuntu18_${fmtArchFilename(ctx)}.mdx`),
+ when({product: {name: "EDB JDBC Connector"}, platform: {name: "Ubuntu 20.04"}},
+ (ctx) => `jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/${fmtArchPath(ctx)}/${prefix[plat]}_jdbc42_ubuntu20_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "Migration Toolkit"}, platform: {name: "SLES 12"}},
(ctx) => `migration_toolkit/55/05_installing_mtk/install_on_linux/${fmtArchPath(ctx)}/${prefix[plat]}_mtk55_sles12_${fmtArchFilename(ctx)}.mdx`),
when({product: {name: "Migration Toolkit"}, platform: {name: "SLES 15"}},
diff --git a/install_template/templates/products/edb-jdbc-connector/base.njk b/install_template/templates/products/edb-jdbc-connector/base.njk
index b5d513b9753..5985d7803aa 100644
--- a/install_template/templates/products/edb-jdbc-connector/base.njk
+++ b/install_template/templates/products/edb-jdbc-connector/base.njk
@@ -1,13 +1,3 @@
{% extends "platformBase/" + platformBaseTemplate + '.njk' %}
{% set packageName %}edb-jdbc{% endset %}
-{% block postinstallMenu %}- [Initial configuration](#initial-configuration){% endblock postinstallMenu %}
-{% block postinstall %}
-## Initial configuration
-
-To make the JDBC driver available to Java, you must either copy the appropriate java `.jar` file for the JDBC version that you are using to your `$java_home/jre/lib/ext` directory or append the location of the `.jar` file to the `CLASSPATH` environment variable.
-
-Note that if you choose to append the location of the `jar` file to the `CLASSPATH` environment variable, you must include the complete pathname:
-
- `/usr/edb/jdbc/edb-jdbc18.jar`
-
-{% endblock postinstall %}
\ No newline at end of file
+{% block postinstallMenu %}- [Initial configuration](#initial-configuration){% endblock postinstallMenu %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-jdbc-connector/sles-12.njk b/install_template/templates/products/edb-jdbc-connector/sles-12.njk
index 9e611c35d43..83933a02add 100644
--- a/install_template/templates/products/edb-jdbc-connector/sles-12.njk
+++ b/install_template/templates/products/edb-jdbc-connector/sles-12.njk
@@ -1,2 +1,2 @@
-{% extends "products/edb-jdbc-connector/base.njk" %}
+{% extends "products/edb-jdbc-connector/sles.njk" %}
{% set platformBaseTemplate = "sles-12" %}
diff --git a/install_template/templates/products/edb-jdbc-connector/sles-12_ppc64le.njk b/install_template/templates/products/edb-jdbc-connector/sles-12_ppc64le.njk
index 9e611c35d43..83933a02add 100644
--- a/install_template/templates/products/edb-jdbc-connector/sles-12_ppc64le.njk
+++ b/install_template/templates/products/edb-jdbc-connector/sles-12_ppc64le.njk
@@ -1,2 +1,2 @@
-{% extends "products/edb-jdbc-connector/base.njk" %}
+{% extends "products/edb-jdbc-connector/sles.njk" %}
{% set platformBaseTemplate = "sles-12" %}
diff --git a/install_template/templates/products/edb-jdbc-connector/sles-15.njk b/install_template/templates/products/edb-jdbc-connector/sles-15.njk
index e1afa96be2c..930476b7540 100644
--- a/install_template/templates/products/edb-jdbc-connector/sles-15.njk
+++ b/install_template/templates/products/edb-jdbc-connector/sles-15.njk
@@ -1,2 +1,2 @@
-{% extends "products/edb-jdbc-connector/base.njk" %}
+{% extends "products/edb-jdbc-connector/sles.njk" %}
{% set platformBaseTemplate = "sles-15" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-jdbc-connector/sles-15_ppc64le.njk b/install_template/templates/products/edb-jdbc-connector/sles-15_ppc64le.njk
index 7bc76791795..de73be52b6f 100644
--- a/install_template/templates/products/edb-jdbc-connector/sles-15_ppc64le.njk
+++ b/install_template/templates/products/edb-jdbc-connector/sles-15_ppc64le.njk
@@ -1,3 +1,3 @@
-{% extends "products/edb-jdbc-connector/base.njk" %}
+{% extends "products/edb-jdbc-connector/sles.njk" %}
{% set platformBaseTemplate = "sles-15" %}
{% set includePPC = true %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-jdbc-connector/sles.njk b/install_template/templates/products/edb-jdbc-connector/sles.njk
new file mode 100644
index 00000000000..5430d94a764
--- /dev/null
+++ b/install_template/templates/products/edb-jdbc-connector/sles.njk
@@ -0,0 +1,11 @@
+{% extends "products/edb-jdbc-connector/base.njk" %}
+{% block postinstall %}
+## Initial configuration
+
+To make the JDBC driver available to Java, you must either copy the appropriate java `.jar` file for the JDBC version that you are using to your `$java_home/jre/lib/ext` directory or append the location of the `.jar` file to the `CLASSPATH` environment variable.
+
+Note that if you choose to append the location of the `jar` file to the `CLASSPATH` environment variable, you must include the complete pathname:
+
+ `/usr/edb/jdbc/edb-jdbc18.jar`
+
+{% endblock postinstall %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-jdbc-connector/ubuntu-18.04.njk b/install_template/templates/products/edb-jdbc-connector/ubuntu-18.04.njk
index 33f908ffae7..e601401a230 100644
--- a/install_template/templates/products/edb-jdbc-connector/ubuntu-18.04.njk
+++ b/install_template/templates/products/edb-jdbc-connector/ubuntu-18.04.njk
@@ -1 +1,2 @@
-{% extends "products/edb-jdbc-connector/debian-10.njk" %}
+{% extends "products/edb-jdbc-connector/base.njk" %}
+{% set platformBaseTemplate = "Ubuntu-18.04" %}
\ No newline at end of file
diff --git a/install_template/templates/products/edb-jdbc-connector/ubuntu-20.04.njk b/install_template/templates/products/edb-jdbc-connector/ubuntu-20.04.njk
index 33f908ffae7..70a2ceca3c1 100644
--- a/install_template/templates/products/edb-jdbc-connector/ubuntu-20.04.njk
+++ b/install_template/templates/products/edb-jdbc-connector/ubuntu-20.04.njk
@@ -1 +1,2 @@
-{% extends "products/edb-jdbc-connector/debian-10.njk" %}
+{% extends "products/edb-jdbc-connector/base.njk" %}
+{% set platformBaseTemplate = "Ubuntu-20.04" %}
\ No newline at end of file
diff --git a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07_jdbc42_ubuntu20_x86.mdx b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07_jdbc42_ubuntu20_x86.mdx
index 432545b45fe..0947be08359 100644
--- a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07_jdbc42_ubuntu20_x86.mdx
+++ b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07_jdbc42_ubuntu20_x86.mdx
@@ -1,52 +1,40 @@
---
-title: "Installing EDB JDBC Connector on Ubuntu 20.04 x86"
-navTitle: "Ubuntu 20.04"
+navTitle: Ubuntu 20.04
+title: Installing EDB JDBC Connector on Ubuntu 20.04 x86_64
---
-To install a DEB package 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 EDB website](https://www.enterprisedb.com/repository-access-request).
+Before you begin the installation process, log in as superuser.
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+```shell
+# To log in as a superuser:
+sudo su -
+```
-1. Assume superuser privileges:
+## Set up the repository
- ```text
- sudo su –
- ```
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
-2. Configure the EDB repository:
+```shell
+# Set up the EDB repository
+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
- 1. Set up the EDB repository:
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
- ```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'
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
- 2. Substitute your EDB credentials for the `username` and `password` in the following command:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf'
- ```
+# Update the repository metadata:
+apt-get update
+```
-3. Add support to your system for secure APT repositories:
+## Install the package
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-jdbc
- ```
\ No newline at end of file
+```shell
+apt-get install edb-jdbc
+```
diff --git a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07a_jdbc42_ubuntu18_x86.mdx b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07a_jdbc42_ubuntu18_x86.mdx
index be08dc9d610..314c91ffb5b 100644
--- a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07a_jdbc42_ubuntu18_x86.mdx
+++ b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07a_jdbc42_ubuntu18_x86.mdx
@@ -1,52 +1,40 @@
---
-title: "Installing EDB JDBC Connector on Ubuntu 18.04 x86"
-navTitle: "Ubuntu 18.04"
+navTitle: Ubuntu 18.04
+title: Installing EDB JDBC Connector on Ubuntu 18.04 x86_64
---
-To install a DEB package 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 EDB website](https://www.enterprisedb.com/repository-access-request).
+Before you begin the installation process, log in as superuser.
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
+```shell
+# To log in as a superuser:
+sudo su -
+```
-1. Assume superuser privileges:
+## Set up the repository
- ```text
- sudo su –
- ```
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
-2. Configure the EDB repository:
+```shell
+# Set up the EDB repository
+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
- 1. Set up the EDB repository:
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
- ```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'
- ```
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
- 2. Substitute your EDB credentials for the `username` and `password` in the following command:
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
- ```text
- sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf'
- ```
+# Update the repository metadata:
+apt-get update
+```
-3. Add support to your system for secure APT repositories:
+## Install the package
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-jdbc
- ```
\ No newline at end of file
+```shell
+apt-get install edb-jdbc
+```
diff --git a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07b_jdbc42_deb10_x86.mdx b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07b_jdbc42_deb10_x86.mdx
deleted file mode 100644
index 240f3b59ed1..00000000000
--- a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/07b_jdbc42_deb10_x86.mdx
+++ /dev/null
@@ -1,52 +0,0 @@
----
-title: "Installing EDB JDBC Connector on Debian 10 x86"
-navTitle: "Debian 10"
----
-
-To install a DEB package 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 EDB website](https://www.enterprisedb.com/repository-access-request).
-
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
-
-1. Assume superuser privileges:
-
- ```text
- sudo su –
- ```
-
-2. Configure the EDB repository:
-
- 1. 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'
- ```
-
- 2. Substitute your EDB credentials for the `username` and `password` in the following command:
-
- ```text
- sh -c 'echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf'
- ```
-
-3. Add support to your system for secure APT repositories:
-
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-jdbc
- ```
\ No newline at end of file
diff --git a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08_jdbc42_deb10_x86.mdx b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08_jdbc42_deb10_x86.mdx
new file mode 100644
index 00000000000..d26a992fe35
--- /dev/null
+++ b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08_jdbc42_deb10_x86.mdx
@@ -0,0 +1,40 @@
+---
+navTitle: Debian 10
+title: Installing EDB JDBC Connector on Debian 10 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the EDB repository
+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
+
+# Replace '' and '' below with
+# your username and password for the EDB repositories:
+echo "machine apt.enterprisedb.com login password " > /etc/apt/auth.conf.d/edb.conf
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-jdbc
+```
diff --git a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08_jdbc42_deb9_x86.mdx b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08_jdbc42_deb9_x86.mdx
deleted file mode 100644
index 0b71c5f2bc1..00000000000
--- a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08_jdbc42_deb9_x86.mdx
+++ /dev/null
@@ -1,47 +0,0 @@
----
-title: "Installing EDB JDBC Connector on Debian 9 x86"
-navTitle: "Debian 9"
----
-
-To install a DEB package 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 EDB website](https://www.enterprisedb.com/repository-access-request).
-
-The following steps will walk you through on using the EDB apt repository to install a DEB package. When using the commands, replace the `username` and `password` with the credentials provided by EDB.
-
-1. Assume superuser privileges:
-
- ```text
- sudo su –
- ```
-
-2. Configure the EDB repository
-
- ```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'
- ```
-
-3. Add support to your system for secure APT repositories:
-
- ```text
- apt-get install apt-transport-https
- ```
-
-4. Add the EDB signing key:
-
- ```text
- wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | apt-key add -
- ```
-
-5. Update the repository metadata:
-
- ```text
- apt-get update
- ```
-
-6. Install DEB package:
-
- ```text
- apt-get install edb-jdbc
- ```
-
-!!! Note
- By default, the Debian 9x and Ubuntu 18.04 platform installs Java version 10. Make sure you install Java version 8 on your system to run the EDB Java-based components.
diff --git a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08a_jdbc42_deb9_x86.mdx b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08a_jdbc42_deb9_x86.mdx
new file mode 100644
index 00000000000..045b82a6d0a
--- /dev/null
+++ b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/08a_jdbc42_deb9_x86.mdx
@@ -0,0 +1,39 @@
+---
+navTitle: Debian 9
+title: Installing EDB JDBC Connector on Debian 9 x86_64
+---
+
+Before you begin the installation process, log in as superuser.
+
+```shell
+# To log in as a superuser:
+sudo su -
+```
+
+## Set up the repository
+
+Setting up the repository is a one-time task. If you have already set up your repository, you do not need to perform this step. If you do need to set up the repository, you must register with EDB. To receive credentials for the EDB repository, visit: [Repository Access Request](https://www.enterprisedb.com/repository-access-request).
+
+```shell
+# Set up the repository by replacing 'USERNAME:PASSWORD' with your
+# username and password for the EDB repositories.
+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
+# This creates the /etc/apt/sources.list.d/edb-stretch.list
+# configuration file.
+
+# Add support for secure APT repositories:
+apt-get -y install apt-transport-https
+
+# Add the EDB signing key. Substitute your EnterpriseDB credentials
+# for the '' and '' placeholders.
+wget -q -O - https://:@apt.enterprisedb.com/edb-deb.gpg.key | sudo apt-key add -
+
+# Update the repository metadata:
+apt-get update
+```
+
+## Install the package
+
+```shell
+apt-get install edb-jdbc
+```
From 02ff1f9d3631a4da9aba8e87040d7ebc385e8530 Mon Sep 17 00:00:00 2001
From: nidhibhammar <59045594+nidhibhammar@users.noreply.github.com>
Date: Tue, 5 Jul 2022 17:40:14 +0530
Subject: [PATCH 11/13] Fixed the JDBC links
---
.../01_installing_the_connector_with_an_rpm_package/index.mdx | 4 ++--
.../x86_amd64/index.mdx | 4 ++--
2 files changed, 4 insertions(+), 4 deletions(-)
diff --git a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/index.mdx b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/index.mdx
index 3f307957138..6868c030808 100644
--- a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/index.mdx
+++ b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/index.mdx
@@ -20,8 +20,8 @@ For platform-specific install instructions, see:
- [SLES 12](x86_amd64/06_jdbc42_sles12_x86)
- [Ubuntu 20.04](x86_amd64/07_jdbc42_ubuntu20_x86)
- [Ubuntu 18.04](x86_amd64/07a_jdbc42_ubuntu18_x86)
- - [Debian 10](x86_amd64/07b_jdbc42_deb10_x86)
- - [Debian 9](x86_amd64/08_jdbc42_deb9_x86)
+ - [Debian 10](x86_amd64/08_jdbc42_deb10_x86)
+ - [Debian 9](x86_amd64/08a_jdbc42_deb9_x86)
- Linux on IBM Power (ppc64le):
- [RHEL 8](ibm_power_ppc64le/09_jdbc42_rhel8_ppcle)
diff --git a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/index.mdx b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/index.mdx
index 042c9039918..6b9435f888f 100644
--- a/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/index.mdx
+++ b/product_docs/docs/jdbc_connector/42.3.3.1/04_installing_and_configuring_the_jdbc_connector/01_installing_the_connector_with_an_rpm_package/x86_amd64/index.mdx
@@ -14,5 +14,5 @@ For operating system-specific install instructions, see:
- [SLES 12](06_jdbc42_sles12_x86)
- [Ubuntu 20.04](07_jdbc42_ubuntu20_x86)
- [Ubuntu 18.04](07a_jdbc42_ubuntu18_x86)
- - [Debian 10](07b_jdbc42_deb10_x86)
- - [Debian 9](08_jdbc42_deb9_x86)
+ - [Debian 10](08_jdbc42_deb10_x86)
+ - [Debian 9](08a_jdbc42_deb9_x86)
From 7bf54972936414254a0d927577bf5799275028ce Mon Sep 17 00:00:00 2001
From: Chris Estes <106166814+ccestes@users.noreply.github.com>
Date: Tue, 5 Jul 2022 15:42:32 -0400
Subject: [PATCH 12/13] ERD tool feedback changes
---
product_docs/docs/pem/8/pem_erd_tool.mdx | 30 ++++++++++++------------
1 file changed, 15 insertions(+), 15 deletions(-)
diff --git a/product_docs/docs/pem/8/pem_erd_tool.mdx b/product_docs/docs/pem/8/pem_erd_tool.mdx
index d38ed7010a3..a112e1c8105 100644
--- a/product_docs/docs/pem/8/pem_erd_tool.mdx
+++ b/product_docs/docs/pem/8/pem_erd_tool.mdx
@@ -13,7 +13,7 @@ The Entity-Relationship Diagram (ERD) tool is a database design tool that provid
- Design and visualize the database tables and their relationships.
- Add notes to the diagram.
-- Auto-align the tables and links for cleaner visualization.
+- Align the tables and links for a cleaner look.
- Save the diagram and open it later to continue working on it.
- Generate ready-to-run SQL from the database design.
- Generate the database diagram for an existing database.
@@ -32,9 +32,9 @@ The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to freq
| Icon | Behavior | Shortcut |
| ----------- | -------------------------------------------------------------------------------------------------------------- | ---------------- |
-| Open File | Load a previously saved diagram. | Ctrl + O |
-| Save | Perform a quick-save of a previously saved diagram or save the diagram to a file. | Ctrl + S |
-| Save as | Open a new browser dialog box and specify a new location to save the diagram. | Ctrl + Shift + S |
+| Open File | Load a saved diagram. | Ctrl + O |
+| Save | Save changes to a saved diagram or save the diagram to a file. | Ctrl + S |
+| Save as | Open a new dialog box and specify a new location to save the diagram. | Ctrl + Shift + S |
## Export options
@@ -57,14 +57,14 @@ The ERD Tool toolbar uses context-sensitive icons that provide shortcuts to freq
| Icon | Behavior | Shortcut |
| ---- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| 1M | Open a one-to-many relationship dialog box to add a relationship between two tables. The selected table is the referencing table and has the `many` endpoint of the link. | Option/Alt + Ctrl + O |
-| MM | Open a many-to-many relationship dialog box to add a relationship between two tables. This options creates a new, linked table from the selected columns of the two relating tables. | Option/Alt + Ctrl + M |
+| MM | Open a many-to-many relationship dialog box to add a relationship between two tables. This option creates a linked table from the selected columns of the two relating tables. | Option/Alt + Ctrl + M |
## Utility Options
| Icon | Behavior | Shortcut |
| --------------- | ------------------------------------------------------------------------------------------------------------ | ---------------------- |
-| Add/Edit note | Make notes on tables nodes while designing the database. | Option/Alt + Ctrl + N |
-| Auto align | Auto-align all tables and links for a cleaner look. | Option/Alt + Ctrl + L |
+| Add/Edit note | Make notes on table nodes while designing the database. | Option/Alt + Ctrl + N |
+| Auto align | Align all tables and links for a cleaner look. | Option/Alt + Ctrl + L |
| Show details | Toggle the column details. You can also choose to show few or more column details. | Option/Alt + Shift + D |
## Zoom options
@@ -83,7 +83,7 @@ The table dialog box allows you to:
- Change the table structure details.
- Edit an existing table or add a new one.
-- Refer to [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
+- See [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
## Table node
@@ -93,14 +93,14 @@ The table node shows table details in a graphical representation:
- On the top bar:
- To show column details, select **Details toggle**.
- - When you add a note, **Note** enables. Select **Note** to changes notes.
+ - When you add a note, **Note** becomes enabled. Select **Note** to changes notes.
- The first row displays the table's schema name, like `public` in the example.
- The second row displays the table's name, like `users` in the example.
-- The remaining rows dispaly the table's column names and their data types.
+- The remaining rows dispalys the table's column names and their data types.
- A column that is a primary key displays as a lock key, like `id integer` in the example.
- Other columns diplay as a green column, like `email character varying` in the example.
-- Select the node to drag and move it on the canvas.
-- To open the table dialog box and change the table details, either double-click on the table node or select **Edit** on the toolbar. Refer to [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
+- Select the node to drag it on the canvas.
+- To open the table dialog box and change the table details, either double-click the table node or select **Edit** on the toolbar. See [Table dialog](pem_online_help/05_toc_pem_management_basics/12_modifying_tables/10_table_dialog) for information on different fields.
## One-to-many link dialog box
@@ -136,13 +136,13 @@ The table link shows the relationship between tables:
- The single-line endpoint of the link shows the column that is the reference.
- The three-line endpoint of the link shows the column that references.
- If one of the columns that is a reference or that references is removed from the table, then the link drops.
-- Select the link to drag and move it on the canvas.
+- Select the link to drag it on the canvas.
## Table notes
- To add a note to a table:
- 1. On the toolbar, select **Add/Edit note**.
+ 1. On the toolbar, select **Add/Edit note**.
1. In the window, enter your note.
-- When a note is added to a table, **Note** enables on the Table node. To check or update notes, select **Note**.
+- When a note is added to a table, **Note** becomes enabled on the Table node. To check or update notes, select **Note**.
From 7625f349e64cb9e153f24101d5af639bdfc20c8e Mon Sep 17 00:00:00 2001
From: Moiz Nalwalla
Date: Wed, 6 Jul 2022 17:30:24 +0530
Subject: [PATCH 13/13] Removed pipe in table that was causing an error
---
.../preparing_cloud_account/01_preparing_azure/index.mdx | 2 +-
.../preparing_cloud_account/02_preparing_aws.mdx | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx
index 8f6a9734151..412e7ea2cd9 100644
--- a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx
+++ b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/01_preparing_azure/index.mdx
@@ -45,7 +45,7 @@ EDB provides a shell script, called [`biganimal-csp-preflight`](https://github.c
| `-h` or `--help`| Displays the command help. |
| `-i` or `--instance-type` | Azure VM instance type for the BigAnimal cluster. The `help` command provides a list of possible VM instance types. Choose the instance type that best suits your application and workload. Choose an instance type in the memory optimized ESv3 or ESv4 series for large data sets. Choose from the compute optimized FSv2 series for compute-bound applications. Choose from the general purpose DSv3 or DSv4 series if you don't require memory or compute optimization. See [Sizes for virtual machines in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/sizes) for information to help you choose the appropriate instance type. |
| `-a` or `--high-availability` | *DEPRECATED* - Enables high availability for the cluster. Replaced with `-x` or `--cluster-architecture` command.|
- | `-x` or `--cluster-architecture` | Defines the cluster architecture and can be [ single | ha | eha ]. See [Supported cluster types](/biganimal/release/overview/02_high_availability) for more information.|
+ | `-x` or `--cluster-architecture` | Defines the cluster architecture and can be `single`, `ha`, or `eha`. See [Supported cluster types](/biganimal/release/overview/02_high_availability) for more information.|
| `-e` or `--endpoint` | Type of network endpoint for the BigAnimal cluster, either `public` or `private`. See [Cluster networking architecture](/biganimal/release/getting_started/creating_a_cluster/01_cluster_networking) for more information. |
| `-r` or `--activate-region` | Specifies region activation if no clusters currently exist in the region. |
| `--onboard` | Checks if the user and subscription are correctly configured.
diff --git a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx
index 6576964c25b..5598860a5a9 100644
--- a/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx
+++ b/product_docs/docs/biganimal/release/getting_started/preparing_cloud_account/02_preparing_aws.mdx
@@ -31,7 +31,7 @@ EDB provides a shell script, called [biganimal-csp-preflight](https://github.com
| `-h` or `--help`| Displays the command help. |
| `-i` or `--instance-type` | AWS instance type for the BigAnimal cluster. The help command provides a list of possible VM instance types. Choose the instance type that best suits your application and workload. Choose an instance type in the memory optimized R5, R5B, or R6I series for large data sets. Choose from the compute-optimized C5 or C6I series for compute-bound applications. Choose from the general purpose M5 or M6I series if you don't require memory or compute optimization.|
| `-a` or `--high-availability` | *DEPRECATED* - Enables high availability for the cluster. See [Supported cluster types(../../overview/02_high_availability) for more information.|
- | `-x` or `--cluster-architecture` | Defines the Cluster architecture and can be [ single | ha | eha ]. See [Supported cluster types](/biganimal/release/overview/02_high_availability) for more information.|
+ | `-x` or `--cluster-architecture` | Defines the Cluster architecture and can be `single`, `ha`, or `eha`. See [Supported cluster types](/biganimal/release/overview/02_high_availability) for more information.|
| `-e` or `--endpoint` | Type of network endpoint for the BigAnimal cluster, either `public` or `private`. See [Cluster networking architecture](../creating_a_cluster/01_cluster_networking) for more information. |
| `-r` or `--activate-region` | Specifies region activation if no clusters currently exist in the region. |
| `--onboard` | Checks if the user and subscription are correctly configured.