-
Notifications
You must be signed in to change notification settings - Fork 249
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6322 from EnterpriseDB/extensions-docs-811-pgvector
Extensions docs 811 pgvector
- Loading branch information
Showing
10 changed files
with
131 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
title: Configuring pgvector | ||
navTitle: Configuring | ||
--- | ||
|
||
No additional configuration is required after enabling the `pgvector` extension. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | |
6 changes: 6 additions & 0 deletions
6
advocacy_docs/pg_extensions/pgvector/rel_notes/pgvector_0.8.0_rel_notes.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
a532655
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Published on https://edb-docs-staging.netlify.app as production
🚀 Deployed on https://6751f445466dda00e763607c--edb-docs-staging.netlify.app