From 2ed45aec2b50397cff48e15bb9598b47d36e836c Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Wed, 4 Dec 2024 19:04:44 -0600 Subject: [PATCH 1/5] add pgvector docs --- .../pg_extensions/pgvector/configuring.mdx | 6 ++ .../pg_extensions/pgvector/index.mdx | 23 ++++++ .../pg_extensions/pgvector/installing.mdx | 71 +++++++++++++++++++ .../pgvector/rel_notes/index.mdx | 10 +++ .../rel_notes/pgvector_0.8.0_rel_notes.mdx | 6 ++ .../pg_extensions/pgvector/using.mdx | 6 ++ 6 files changed, 122 insertions(+) create mode 100644 advocacy_docs/pg_extensions/pgvector/configuring.mdx create mode 100644 advocacy_docs/pg_extensions/pgvector/index.mdx create mode 100644 advocacy_docs/pg_extensions/pgvector/installing.mdx create mode 100644 advocacy_docs/pg_extensions/pgvector/rel_notes/index.mdx create mode 100644 advocacy_docs/pg_extensions/pgvector/rel_notes/pgvector_0.8.0_rel_notes.mdx create mode 100644 advocacy_docs/pg_extensions/pgvector/using.mdx diff --git a/advocacy_docs/pg_extensions/pgvector/configuring.mdx b/advocacy_docs/pg_extensions/pgvector/configuring.mdx new file mode 100644 index 00000000000..c1a3f00b652 --- /dev/null +++ b/advocacy_docs/pg_extensions/pgvector/configuring.mdx @@ -0,0 +1,6 @@ +--- +title: Configuring pgvector +navTitle: Configuring +--- + +No additional configuration is required after enabling the `pgvector` extension. \ No newline at end of file diff --git a/advocacy_docs/pg_extensions/pgvector/index.mdx b/advocacy_docs/pg_extensions/pgvector/index.mdx new file mode 100644 index 00000000000..a8c8d87ee0c --- /dev/null +++ b/advocacy_docs/pg_extensions/pgvector/index.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) + + diff --git a/advocacy_docs/pg_extensions/pgvector/installing.mdx b/advocacy_docs/pg_extensions/pgvector/installing.mdx new file mode 100644 index 00000000000..78b9cce91cf --- /dev/null +++ b/advocacy_docs/pg_extensions/pgvector/installing.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 -y install edb--pg-vector1 + +# For Debian and Ubuntu +sudo -y install edb--pg-vector-1 +``` + +Where: +- ``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 | + +- `` is the distribution of Postgres you're using: + + | Postgres distribution | Value | + | ---------------------------- | ---------- | + | PostgreSQL | pg | + | EDB Postgres Advanced Server | as | + | EDB Postgres Extended Server | postgresextended | + +- `` 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-pg-vector1 +``` + + + + + diff --git a/advocacy_docs/pg_extensions/pgvector/rel_notes/index.mdx b/advocacy_docs/pg_extensions/pgvector/rel_notes/index.mdx new file mode 100644 index 00000000000..c226acc070c --- /dev/null +++ b/advocacy_docs/pg_extensions/pgvector/rel_notes/index.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 | diff --git a/advocacy_docs/pg_extensions/pgvector/rel_notes/pgvector_0.8.0_rel_notes.mdx b/advocacy_docs/pg_extensions/pgvector/rel_notes/pgvector_0.8.0_rel_notes.mdx new file mode 100644 index 00000000000..13739feb61f --- /dev/null +++ b/advocacy_docs/pg_extensions/pgvector/rel_notes/pgvector_0.8.0_rel_notes.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). diff --git a/advocacy_docs/pg_extensions/pgvector/using.mdx b/advocacy_docs/pg_extensions/pgvector/using.mdx new file mode 100644 index 00000000000..2f37f545b91 --- /dev/null +++ b/advocacy_docs/pg_extensions/pgvector/using.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. \ No newline at end of file From ac68200109394c598ddd297450552af1a1c6146c Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Wed, 4 Dec 2024 19:07:31 -0600 Subject: [PATCH 2/5] update pgvector url --- advocacy_docs/pg_extensions/extensionrefs.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/advocacy_docs/pg_extensions/extensionrefs.json b/advocacy_docs/pg_extensions/extensionrefs.json index 02032016927..853259fd913 100644 --- a/advocacy_docs/pg_extensions/extensionrefs.json +++ b/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", From 6593cac440ba4a0dc41923c86fcd502421d87a9c Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Thu, 5 Dec 2024 07:09:41 -0600 Subject: [PATCH 3/5] update version for installing --- advocacy_docs/pg_extensions/pgvector/installing.mdx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/advocacy_docs/pg_extensions/pgvector/installing.mdx b/advocacy_docs/pg_extensions/pgvector/installing.mdx index 78b9cce91cf..999d13127f7 100644 --- a/advocacy_docs/pg_extensions/pgvector/installing.mdx +++ b/advocacy_docs/pg_extensions/pgvector/installing.mdx @@ -33,10 +33,10 @@ The syntax for the package install command is: ```shell # For SLES, CentOS, RHEL and its derivatives -sudo -y install edb--pg-vector1 +sudo -y install edb--pgvector0 # For Debian and Ubuntu -sudo -y install edb--pg-vector-1 +sudo -y install edb--pgvector-0 ``` Where: @@ -62,7 +62,7 @@ Where: For example, to install pgvector for EDB Postgres Advanced Server 15 on a RHEL 8 platform: ```shell -sudo dnf -y install edb-as15-pg-vector1 +sudo dnf -y install edb-as15-pgvector0 ``` From ac4bdebb25378b0346f2511e37da1c8ad450c61e Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Thu, 5 Dec 2024 07:19:56 -0600 Subject: [PATCH 4/5] update indexcard link --- advocacy_docs/pg_extensions/index.mdx.in | 1 + src/pages/index.js | 4 ++++ 2 files changed, 5 insertions(+) diff --git a/advocacy_docs/pg_extensions/index.mdx.in b/advocacy_docs/pg_extensions/index.mdx.in index 0b25a3cd731..c9630c6edfb 100644 --- a/advocacy_docs/pg_extensions/index.mdx.in +++ b/advocacy_docs/pg_extensions/index.mdx.in @@ -11,6 +11,7 @@ navigation: - wait_states - pg_failover_slots - pg_squeeze + - pgvector - system_stats - wal2json - "#EDB Postgres Advanced Server only" diff --git a/src/pages/index.js b/src/pages/index.js index abd5f6d3829..d8d6be10fb8 100644 --- a/src/pages/index.js +++ b/src/pages/index.js @@ -518,6 +518,10 @@ const Page = () => { PG Squeeze + + pgvector + + wal2json From 1bcb8261d2767a8c88d441173c91e551b91f1e35 Mon Sep 17 00:00:00 2001 From: piano35-edb <160748516+piano35-edb@users.noreply.github.com> Date: Thu, 5 Dec 2024 07:28:21 -0600 Subject: [PATCH 5/5] ran extensions tool --- advocacy_docs/pg_extensions/index.mdx | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/advocacy_docs/pg_extensions/index.mdx b/advocacy_docs/pg_extensions/index.mdx index 51282a95a48..2ff45699b01 100644 --- a/advocacy_docs/pg_extensions/index.mdx +++ b/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" @@ -100,7 +101,7 @@ Categories of extensions: pgauditYes✓✓–✓–✓–– pglogical 2.x✓✓✓––––– pgsnmpd (11-13)✓–✓––––– -pgvector✓✓✓––✓✓✓ +pgvector✓✓✓––✓✓✓ plperl✓✓✓––✓✓✓     plperluYes✓✓✓––✓✓✓     bool_plperl✓✓✓––✓✓✓ @@ -120,6 +121,7 @@ Categories of extensions: pltcl✓✓✓––✓✓✓     pltcluYes✓✓✓––✓✓✓ plv8Yes✓––––––– +pg global temporary tables (pgtt)✓✓✓––––– set_user✓––––––– sslutils✓✓✓––––– system_stats✓✓✓––––– @@ -151,7 +153,6 @@ Categories of extensions: spl_check––✓–✓––✓ parallel_clone––✓––––– EDB Postgres Distributed extensions -bdr 3.x✓✓✓––––– bdr 4.x✓✓✓––––– bdr 5.x✓✓✓PreviewPreview–PreviewPreview pglogical 3.xYes✓✓✓–––––