Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add postgrest extension #5991

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion advocacy_docs/pg_extensions/index.mdx

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions advocacy_docs/pg_extensions/index.mdx.in
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ navigation:
- wait_states
- pg_failover_slots
- pg_squeeze
- postgrest
- system_stats
- wal2json
- "#EDB Postgres Advanced Server only"
Expand Down
7 changes: 7 additions & 0 deletions advocacy_docs/pg_extensions/postgrest/configuring.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Configuring postgREST
navTitle: Configuring
---

Once you have postgREST installed, no other configuration steps are required.

19 changes: 19 additions & 0 deletions advocacy_docs/pg_extensions/postgrest/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: 'postgREST'
indexCards: none
directoryDefaults:
product: postgREST
navigation:
- installing
- configuring
- using
---

`postgREST` is a standalone web server that allows a PostgreSQL database to function as a RESTful API. The API can be customized based on the database schema.


For more information about `postgREST`, see:

- [Installing postgREST](installing.mdx)
- [Configuring postgREST](configuring.mdx)
- [Using postgREST](using.mdx)
62 changes: 62 additions & 0 deletions advocacy_docs/pg_extensions/postgrest/installing.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: Installing postgREST
navTitle: Installing
---

`postgREST` is supported on the same platforms as the Postgres distribution you're using. Support for `postgREST` starts with Postgres 12. For details, see:

- [PostgreSQL Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#pg)

## Installation

Before you begin the installation process:

- Install Postgres. See:

- [Installing PostgreSQL](https://www.postgresql.org/download/)

- 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>-postgrest2

# For Debian and Ubuntu
sudo <package-manager> -y install edb-<postgres><postgres_version>-postgrest2
```

Where:
- `<package-manager>`is the package manager used with your operating system:

| Package manager | Operating system |
| --------------- | -------------------------------- |
| dnf | RHEL 8/9 and derivatives |
| zypper | SLES |
| apt-get | Debian and derivatives |

- `<postgres>` is the distribution of Postgres you're using:

| Postgres distribution | Value |
| ---------------------------- | ---------- |
| PostgreSQL | pg |

- `<postgres_version>` is the version of Postgres you're using.

For example, to install postgREST for EDB Postgres 15 on a RHEL 8 platform:

```shell
sudo dnf -y install edb-pg15-postgrest2
```





6 changes: 6 additions & 0 deletions advocacy_docs/pg_extensions/postgrest/using.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: Using postgREST
navTitle: Using
---

For more information about using `postgREST`, see the [PostgREST documentation](https://postgrest.org/en/stable/index.html).