Merge pull request #6326 from EnterpriseDB/release/2024-12-05a

Release/2024-12-05a

Author: jpe442

advocacy_docs/edb-postgres-ai/cloud-service/index.mdx

@@ -3,7 +3,7 @@ title: EDB Postgres AI Cloud Service
 navTitle: Cloud Service
 description: An introduction to the EDB Postgres AI Cloud Service and its features.
 directoryDefaults:
-  displayBanner: "The EDB Hosted Cloud Service has been deprecated. Support is available for current customers. However, the related documentation topics will be removed shortly. Further updates will be provided as the removal progresses."
+  displayBanner: "Notice: EDB will no longer offer the  Hosted Cloud Service option for new customers. However, support will remain available for existing customers of the EDB Hosted plan. The associated documentation topics will soon be removed, and updates regarding the removal process will be shared as they become available. The 'Your Cloud Account' option will continue to be available."
 navigation:
 - getting_started
 - using_cluster

advocacy_docs/edb-postgres-ai/console/estate/agent/install-agent.mdx

@@ -82,7 +82,7 @@ export BEACON_AGENT_ACCESS_KEY=<your-access-key>
 export BEACON_AGENT_PROJECT_ID=<your-project-id>
 ```
 
-Running the `beacon-agent setup` command creates a configuration file in the Beacon configuration directory. using those environment variables.
+These environment variables are used when you run the `beacon-agent setup` command to create a configuration file in the Beacon configuration directory.
 
 You also need to specify the Beacon configuration directory for storing the configuration file and the name of the configuration file to generate there. The `$HOME/.beacon/` file is one of the default locations which `beacon_agent` searches for `beacon_agent.yaml` when it starts. Using the `-file` flag tells the agent setup process to create its configuration file in a specific location. 
 
@@ -153,7 +153,7 @@ provider:
     poll_interval: 5m0s
 ```
 
-## Test Beacon Agent locally.
+## Test Beacon Agent locally
 
 For an initial test of the agent, you can get it to send the data that it would normally send to the EDB Enterprise AI control plane to standard output, your terminal session, instead. This allows you to quickly confirm if the agent is successfully able to gather data and what that data looks like.
 
@@ -210,7 +210,7 @@ agent:
 
 ```
 
-## Run Beacon Agent.
+## Run Beacon Agent
 
 Run the agent using the following command:
 

advocacy_docs/edb-postgres-ai/index.mdx

@@ -23,5 +23,5 @@ navigation:
 The home of all EDB Postgres® AI documentation.
 
 !!!note "Deprecation"
-    The EDB Hosted Cloud Service has been deprecated. Support is available for current customers. However, the related documentation topics will be removed shortly. Further updates will be provided as the removal progresses.
+   EDB will no longer offer the  Hosted Cloud Service option for new customers. However, support will remain available for existing customers of the EDB Hosted plan. The associated documentation topics will soon be removed, and updates regarding the removal process will be shared as they become available. The 'Your Cloud Account' option will continue to be available.
 

advocacy_docs/pg_extensions/extensionrefs.json

@@ -63,7 +63,7 @@
     "pglogical_2.x": "https://www.enterprisedb.com/docs/supported-open-source/pglogical2/",
     "pgrouting": "https://pgrouting.org/",
     "pgsnmpd_(11-13)": "undefined",
-    "pgvector": "https://github.com/pgvector/pgvector",
+    "pgvector": "https://www.enterprisedb.com/docs/pg_extensions/pgvector",
     "pljava_(11)": "https://tada.github.io/pljava/",
     "plperl": "https://www.postgresql.org/docs/current/plperl.html",
     "plperl.plperlu": "https://www.postgresql.org/docs/current/plperl-trusted.html",

advocacy_docs/pg_extensions/index.mdx

@@ -11,6 +11,7 @@ navigation:
     - wait_states
     - pg_failover_slots
     - pg_squeeze
+    - pgvector
     - system_stats
     - wal2json
     - "#EDB Postgres Advanced Server only"

advocacy_docs/pg_extensions/index.mdx.in

@@ -7,7 +7,7 @@ This release of PG Failover Slots includes:
 
 |  Type   |               Description               |
 | ------- | --------------------------------------- |
-| Feature | Add support for PostgreSQL 17. |
-| Bug fix | Do not drop physical slots on standby.  Previously, physical replication slots were dropped on the standby if they didn't exist on the primary. This fix ensures only logical replication slots are acted upon.  
-| Enhancement | New configuration setting: `pg_failover_slots.maintenance_db`.  This value was previously hardcoded. |
+| Feature | Added support for PostgreSQL 17. |
+| Bug fix | Physical slots aren't dropped on standby. Previously, physical replication slots were dropped on the standby if they didn't exist on the primary. This fix ensures only logical replication slots are acted upon.  
+| Enhancement | New configuration setting: `pg_failover_slots.maintenance_db`. This value was previously hardcoded. |
 | Enhancement | New configuration setting: `pg_failover_slots.worker_nap_time`. This value was previously hardcoded. |

advocacy_docs/pg_extensions/pg_failover_slots/rel_notes/pg_failover_slots_1.1.0_rel_notes.mdx

@@ -0,0 +1,6 @@
+---
+title: Configuring pgvector 
+navTitle: Configuring
+---
+
+No additional configuration is required after enabling the `pgvector` extension.

advocacy_docs/pg_extensions/pgvector/configuring.mdx

@@ -0,0 +1,23 @@
+---
+title: 'pgvector'
+indexCards: none
+navigation:
+   - rel_notes
+   - installing
+   - configuring
+   - using
+directoryDefaults:
+  product: pgvector
+---
+
+`pgvector` is an extension released as open source software under the PostgreSQL License. 
+
+`pgvector` provides vector similarity search capabilities and the ability to store embeddings for retrieval augmented generation.  
+
+For more information about `pgvector`, see:
+
+- [Installing pgvector](installing.mdx)
+- [Configuring pgvector](configuring.mdx)
+- [Using pgvector](using.mdx)
+
+

advocacy_docs/pg_extensions/pgvector/index.mdx

@@ -0,0 +1,71 @@
+---
+title: Installing pgvector 
+navTitle: Installing
+---
+
+`pgvector` is supported on the same platforms as the Postgres distribution you're using. Support for `pgvector` starts with Postgres 13. For details, see:
+
+- [EDB Postgres Advanced Server Product Compatibility](https://www.enterprisedb.com/platform-compatibility#epas)
+- [PostgreSQL Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#pg)
+- [EDB Postgres Extended Server Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#epas_extended)
+
+## Installation
+
+Before you begin the installation process:
+
+- Install Postgres. See: 
+
+  - [Installing EDB Postgres Advanced Server](/epas/latest/installing/)
+
+  - [Installing PostgreSQL](https://www.postgresql.org/download/) 
+
+  - [Installing EDB Postgres Extended Server](/pge/latest/installing/)
+
+- Set up the repository.
+
+  Setting up the repository is a one-time task. If you've already set up your repository, you don't need to perform this step.
+
+  To set up the repository, go to [EDB repositories](https://www.enterprisedb.com/repos-downloads) and follow the instructions provided there.
+
+## Install the package
+
+The syntax for the package install command is:
+
+```shell
+# For SLES, CentOS, RHEL and its derivatives
+sudo <package-manager> -y install edb-<postgres><postgres_version>-pgvector0
+
+# For Debian and Ubuntu
+sudo <package-manager> -y install edb-<postgres><postgres_version>-pgvector-0
+```
+
+Where: 
+- `<package-manager>`is the package manager used with your operating system:
+
+  | Package manager |             Operating system     |
+  | --------------- | -------------------------------- |
+  | dnf             | RHEL 8/9 and derivatives         |
+  | yum             | RHEL 7 and derivatives, CentOS 7 |
+  | zypper          | SLES                             |
+  | apt-get         | Debian and derivatives           |
+
+- `<postgres>` is the distribution of Postgres you're using:
+
+ |    Postgres distribution     |   Value    |
+ | ---------------------------- | ---------- |
+ | PostgreSQL                   | pg         |
+ | EDB Postgres Advanced Server | as         |
+ | EDB Postgres Extended Server | postgresextended |
+
+- `<postgres_version>` is the version of Postgres you're using.
+
+For example, to install pgvector for EDB Postgres Advanced Server 15 on a RHEL 8 platform:
+
+```shell
+sudo dnf -y install edb-as15-pgvector0
+```
+
+
+
+
+

advocacy_docs/pg_extensions/pgvector/installing.mdx

@@ -0,0 +1,10 @@
+---
+title: 'pgvector release notes'
+navTitle: "Release notes"
+indexCards: none
+---
+The pgvector documentation describes the latest version of pgvector, including minor releases and patches. These release notes cover what was new in each release. For new functionality introduced in a minor or patch release, there are also indicators in the content about the release that introduced the feature.
+
+|               Version               | Release Date |
+| ----------------------------------- | ------------ |
+| [0.8.0](pgvector_0.8.0_rel_notes) | 30 Oct 2024  |

advocacy_docs/pg_extensions/pgvector/rel_notes/index.mdx

@@ -0,0 +1,6 @@
+---
+title: Release notes for pgvector
+navTitle: "Version 0.8.0"
+---
+
+For `pgvector` release notes, see the [pgvector official change log](https://github.com/pgvector/pgvector/blob/master/CHANGELOG.md).

advocacy_docs/pg_extensions/pgvector/rel_notes/pgvector_0.8.0_rel_notes.mdx

@@ -0,0 +1,6 @@
+---
+title: Using pgvector
+navTitle: Using
+---
+
+For more information on using `pgvector`, see the [Getting Started](https://github.com/pgvector/pgvector?tab=readme-ov-file#getting-started) guide in the pgvector official documentation.

advocacy_docs/pg_extensions/pgvector/using.mdx

@@ -5,11 +5,11 @@ navTitle: Configuring
 
 ## Parameters
 
-The following parameters in `postgresql.conf` control the EDB Wait States extension behavior.  If you modify these parameters, reload or restart Postgres to apply the changes.
+The following parameters in `postgresql.conf` control the EDB Wait States extension behavior. If you modify these parameters, reload or restart Postgres to apply the changes.
 
-| Parameter                    | Description | Default | Reload or Restart  |                                                                                                                                                                                                                                                |
+| Parameter                    | Description | Default | Reload or restart  |                                                                                                                                                                                                                                                |
 |---------------------------------|-------------|---------|----------------------|
 | `edb_wait_states.sampling_interval`| The interval between two EDB Wait States sampling cycles.| 1 second | Reload| 
 | `edb_wait_states.retention_period`| Deletes EDB Wait States log files after a defined retention period. | 604800 seconds (7 days)| Reload|                                                                                                                                                                            |
 | `edb_wait_states.enable_collection`| Enable or disable EDB Wait States data collection. | true | Reload|                                                                                                                                                                                                                                        |
-| `edb_wait_states.directory` | Stores the EDB Wait States logs in this directory. The path must be a full, absolute path.  It can't be a relative path. | $PGDATA/edb_wait_states |Restart| 
+| `edb_wait_states.directory` | Stores the EDB Wait States logs in this directory. The path must be a full, absolute path. It can't be a relative path. | $PGDATA/edb_wait_states |Restart| 

advocacy_docs/pg_extensions/wait_states/configuring.mdx

@@ -76,7 +76,9 @@ Standby priority host list:
 172.19.12.163 172.19.10.2
 ```
 
-The `Promote Status` section of the report is the result of a direct query from the node on which you are invoking the `cluster-status` command to each database in the cluster. The query also returns the transaction log location of each database. Because the queries to each database return at different times, the LSNs might not match even if streaming replication is working normally for the cluster. To get the latest view of replication, connect to the primary database, and execute SQL command `SELECT * FROM pg_stat_replication;`.
+The `Promote Status` section of the report includes information related to promotion in the cluster. The LSN information is used, along with the `Standby priority host list`, when choosing a standby to promote. If there is a mismatch in replay LSNs, Failover Manager will not allow a switchover (though the promotion of a standby is always allowed).
+
+The LSN information is the result of a direct query from the node on which you are invoking the `cluster-status` command to each database in the cluster. The query also returns the transaction log location of each database. Because the queries to each database return at different times, the LSNs might not match even if streaming replication is working normally for the cluster. To get the latest view of replication, connect to the primary database, and execute SQL command `SELECT * FROM pg_stat_replication;`.
 ```text
 Promote Status:
 

product_docs/docs/efm/4/06_monitoring_efm_cluster.mdx

@@ -19,7 +19,7 @@ The `pgAgent` and `adminpack` packages are end of life from EPAS 17 and later.
 |----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
 | Upstream merge | Merged with community PostgreSQL 17.2. See the [PostgreSQL 17 Release Notes](https://www.postgresql.org/docs/17/release-17-2.html) for more information.                                                                                                                                                             |          |
 | Feature        | Added support for the Oracle-compatible `BFILE` native datatype and the `DBMS_LOB` package APIs. See the [DBMS_LOB](../reference/oracle_compatibility_reference/epas_compat_bip_guide/03_built-in_packages/06_dbms_lob/) for more information.                                                                       |          |
-| Feature        | Added support for the Oracle-compatible `DBMS_XMLDOM` package to provide interface for HTML and XML documents. See the [DBMS_XMLDOM](../reference/oracle_compatibility_reference/epas_compat_bip_guide/03_built-in_packages/dbms_xmldom) for more information.                                                       |          |
+| Feature        | Added support for the Oracle-compatible `DBMS_XMLDOM` package to provide interface for HTML and XML documents. See the [DBMS_XMLDOM](../reference/oracle_compatibility_reference/epas_compat_bip_guide/03_built-in_packages/18_dbms_xmldom) for more information.                                                       |          |
 | Feature        | Added support for the Oracle-compatible `DBMS_ASSERT` package to validate input properties and sanitize user input, thereby reducing the risk of SQL injections. See the [DBMS_ASSERT](../reference/oracle_compatibility_reference/epas_compat_bip_guide/03_built-in_packages/01a_dbms_assert) for more information. |          |
 | Feature        | Added support for the Oracle-equivalent `NLS_UPPER`,`NLS_LOWER`, and `NLS_INITCAP` functions. See the [NLS functions](../reference/sql_reference/03_functions_and_operators/nls_functions) for more information.                                                                                                     |          |
 | Feature        | Implemented `alteruser` utility to modify roles in the clusters. See the [alteruser utility](/tools/alteruser_utility/) for more information.                                                                                                                                                                        |          |

product_docs/docs/epas/17/epas_rel_notes/epas17_2_rel_notes.mdx

@@ -1,4 +1,4 @@
-s---
+---
 title: "SUBSTR"
 redirects:
   - /epas/latest/epas_compat_bip_guide/03_built-in_packages/06_dbms_lob/11_substr/ #generated for docs/epas/reorg-role-use-case-mode

product_docs/docs/epas/17/reference/oracle_compatibility_reference/epas_compat_bip_guide/03_built-in_packages/06_dbms_lob/11_substr.mdx

@@ -0,0 +1,43 @@
+---
+title: "APPENDCHILD"
+---
+
+The `APPENDCHILD` function adds the node at the end of the list of children of a particular node. It returns the newly added node and if the node is already present, it removes the existing node before adding new node.
+
+You can append more than one child to a document node. However, a node cannot belong to several documents.
+
+When appending elements, you cannot add an element to itself. Additionally, if the same element is added twice, only the latest is considered.
+
+```
+APPENDCHILD(n DOMNode, newChild IN DOMNode) RETURN DOMNode
+```
+
+## Parameters
+
+`n`
+
+The `DOMNode` where the new node is to be added.
+
+`newchild`
+
+The child node to be added to the existing list of children of node n.
+
+## Examples
+
+This example creates a new XML `DOMDocument` named `l_domdoc` and a new `DOMElement` named `l_department_element` with tag name `Departments`. It then appends the `DOMElement` as a child of the `DOMDocument`.
+
+```sql
+DECLARE
+   l_domdoc DBMS_XMLDOM.DOMDocument;
+   l_department_element DBMS_XMLDOM.DOMElement;
+   l_xmltype XMLTYPE;
+
+
+BEGIN
+   l_domdoc := DBMS_XMLDOM.NEWDOMDOCUMENT();
+   l_department_element := DBMS_XMLDOM.CREATEELEMENT(l_domdoc, 'Departments' );
+   PERFORM DBMS_XMLDOM.appendChild(DBMS_XMLDOM.MAKENODE(l_domdoc), DBMS_XMLDOM.MAKENODE(l_department_element));
+   l_xmltype := DBMS_XMLDOM.GETXMLTYPE(l_domdoc);
+   DBMS_OUTPUT.PUT_LINE(l_xmltype.getStringVal());
+END;
+```

product_docs/docs/epas/17/reference/oracle_compatibility_reference/epas_compat_bip_guide/03_built-in_packages/18_dbms_xmldom/appendchild.mdx

@@ -0,0 +1,39 @@
+---
+title: "CREATEELEMENT"
+---
+
+The `CREATEELEMENT` function creates and returns a DOMElement.
+
+```
+CREATEELEMENT( doc DOMDocument, tagname IN VARCHAR2) RETURN DOMElement
+```
+
+## Parameters
+
+`doc`
+
+Any `DOMDocument`.
+
+`tagname`
+
+Tag name to be given to the new `DOMElement`.
+
+## Examples
+
+This example creates a new XML `DOMDocument` named `l_domdoc` and a new `DOMElement` named `l_department_element` with tag name `Departments`. It then appends the `DOMElement` as a child of the `DOMDocument`.
+
+```sql
+DECLARE
+   l_domdoc DBMS_XMLDOM.DOMDocument;
+   l_department_element DBMS_XMLDOM.DOMElement;
+   l_xmltype XMLTYPE;
+
+
+BEGIN
+   l_domdoc := DBMS_XMLDOM.NEWDOMDOCUMENT();
+   l_department_element := DBMS_XMLDOM.CREATEELEMENT(l_domdoc, 'Departments' );
+   PERFORM DBMS_XMLDOM.APPENDCHILD(DBMS_XMLDOM.MAKENODE(l_domdoc), DBMS_XMLDOM.MAKENODE(l_department_element));
+   l_xmltype := DBMS_XMLDOM.GETXMLTYPE(l_domdoc);
+   DBMS_OUTPUT.PUT_LINE(l_xmltype.getStringVal());
+END;
+```

product_docs/docs/epas/17/reference/oracle_compatibility_reference/epas_compat_bip_guide/03_built-in_packages/18_dbms_xmldom/createelement.mdx

@@ -0,0 +1,45 @@
+---
+title: "CREATETEXTNODE"
+---
+
+The `CREATETEXTNODE` function creates and returns a DOMText node.
+
+```
+CREATETEXTNODE( doc DOMDocument, data IN VARCHAR2) RETURN DOMText
+```
+
+## Parameters
+
+`doc`
+
+Any `DOMDocument`.
+
+`data`
+
+Content provided for the `DOMText` node.
+
+## Examples
+
+This example creates a new XML `DOMDocument`, a `DOMElement` with tag name “Departments” and a text node with “Depts list” as its value. The `DOMElement` is appended as a child to the `DOMDocument`, and the text node as a child to the `DOMElement`. 
+
+```sql
+DECLARE
+   l_domdoc DBMS_XMLDOM.DOMDocument;
+   l_root_node DBMS_XMLDOM.DOMNode;
+   l_department_element DBMS_XMLDOM.DOMElement;
+   l_departments_node DBMS_XMLDOM.DOMNode;
+   l_name_text DBMS_XMLDOM.DOMText;
+   l_xmltype XMLTYPE;
+
+
+BEGIN
+   l_domdoc := DBMS_XMLDOM.NEWDOMDOCUMENT;
+   l_root_node := DBMS_XMLDOM.MAKENODE(l_domdoc);
+   l_department_element := DBMS_XMLDOM.CREATEELEMENT(l_domdoc, 'Departments' );
+   l_departments_node := DBMS_XMLDOM.APPENDCHILD(l_root_node,DBMS_XMLDOM.MAKENODE(l_department_element));
+   l_name_text := DBMS_XMLDOM.CREATETEXTNODE(l_domdoc, 'Depts list' );
+   PERFORM DBMS_XMLDOM.APPENDCHILD(l_departments_node,DBMS_XMLDOM.MAKENODE(l_name_text));
+   l_xmltype := DBMS_XMLDOM.GETXMLTYPE(l_domdoc);
+   DBMS_OUTPUT.PUT_LINE(l_xmltype.getStringVal());
+END;
+```