Skip to content

Commit

Permalink
docs: update extension support
Browse files Browse the repository at this point in the history
  • Loading branch information
@danieltprice
danieltprice committed Jan 30, 2025
1 parent a0c8ca7 commit 537fdd1
Show file tree
Hide file tree
Showing 5 changed files with 42 additions and 12 deletions.
2 changes: 1 addition & 1 deletion content/docs/extensions/extensions-intro.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ updatedOn: '2025-01-24T20:21:15.304Z'

Explore supported Postgres extensions by category. Also see:

- [List view of supported extensions and versions](/docs/extensions/pg-extensions)
- [List view](/docs/extensions/pg-extensions)
- [Install an extension](/docs/extensions/pg-extensions#install-an-extension)
- [Update an extension](/docs/extensions/pg-extensions#update-an-extension-version)

Expand Down
6 changes: 3 additions & 3 deletions content/docs/extensions/pg-extensions.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Do you need an extension we don’t support yet? [Let us know](#request-extensio
| [moddatetime (spi)](https://www.postgresql.org/docs/current/contrib-spi.html) | 1.0 | 1.0 | 1.0 | 1.0 | |
| [neon](/docs/extensions/neon) | 1.5 | 1.5 | 1.5 | 1.5 | |
| [neon_utils](/docs/extensions/neon-utils) | 1.0 | 1.0 | 1.0 | 1.0 | |
| [pg_cron](/docs/extensions/pg_cron) | 1.6 | 1.6 | 1.6 | 1.6 | Available only on paid Neon plans. To install `pg_cron`, it must first be enabled by Neon Support. [Open a support ticket](https://console.neon.tech/app/projects?modal=support) with your endpoint ID and database name to request it. After it's enabled, you'll need to restart your compute before running `CREATE EXTENSION pg_cron;` Please note that `pg_cron` jobs will only run when your compute is active. We therefore recommend only using `pg_cron` on computes that run 24/7 or where you have disabled [scale to zero](https://neon.tech/docs/introduction/scale-to-zero). |
| [pg_cron](/docs/extensions/pg_cron) | 1.6 | 1.6 | 1.6 | 1.6 | To install `pg_cron`, it must first be enabled. See [Enable the pg_cron extension](/docs/extensions/pg_cron#enable-the-pgcron-extension) for instructions. Please note that `pg_cron` jobs will only run when your compute is active. We therefore recommend only using `pg_cron` on computes that run 24/7 or where you have disabled [scale to zero](https://neon.tech/docs/introduction/scale-to-zero). |
| |
| [pg_graphql](https://github.com/supabase/pg_graphql) | 1.5.9 | 1.5.9 | 1.5.9 | 1.5.9 | |
| [pg_hashids](https://github.com/iCyberon/pg_hashids) | 1.2.1 | 1.2.1 | 1.2.1 | 1.2.1 | |
Expand All @@ -66,7 +66,7 @@ Do you need an extension we don’t support yet? [Let us know](#request-extensio
| [pgstattuple](https://www.postgresql.org/docs/16/pgstattuple.html) | 1.5 | 1.5 | 1.5 | 1.5 | |
| [pgtap](https://pgtap.org/documentation.html) | 1.3.3 | 1.3.3 | 1.3.3 | 1.3.3 | |
| [pgvector](/docs/extensions/pgvector) | 0.8.0 | 0.8.0 | 0.8.0 | 0.8.0 | Install with `CREATE EXTENSION vector;` |
| [pgx_ulid](https://github.com/pksunkara/pgx_ulid) | 0.1.5 | 0.1.5 | 0.1.5 | - | Install with `CREATE EXTENSION ulid;` |
| [pgx_ulid](https://github.com/pksunkara/pgx_ulid) | 0.1.5 | 0.1.5 | 0.1.5 | 0.2.0 | Install with `CREATE EXTENSION ulid;` on Postgres 14, 15, 16. Install with `CREATE EXTENSION ulid; ` on Postgres 17. |
| [plcoffee](https://coffeescript.org/) | 3.1.5 | 3.1.5 | 3.1.8 | - | |
| [plls](https://livescript.net/) | 3.1.5 | 3.1.5 | 3.1.8 | - | |
| [plpgsql](https://www.postgresql.org/docs/16/plpgsql.html) | 1.0 | 1.0 | 1.0 | 1.0 | Pre-installed with Postgres. |
Expand All @@ -77,7 +77,7 @@ Do you need an extension we don’t support yet? [Let us know](#request-extensio
| [postgis_sfcgal](/docs/extensions/postgis-related-extensions#postgis-sfcgal) | 1.3.8 | 1.3.8 | 1.3.8 | 3.5.0 | |
| [postgis_tiger_geocoder](/docs/extensions/postgis-related-extensions#postgis-tiger-geocoder) | 3.3.3 | 3.3.3 | 3.3.3 | 3.5.0 | Cannot be installed using the Neon SQL Editor. Use your `psql` user credentials to install this extension. |
| [postgis_topology](https://www.postgis.net/docs/Topology.html) | 3.3.3 | 3.3.3 | 3.3.3 | 3.5.0 | |
| [postgres_fdw](/docs/extensions/postgres_fdw) | - | - | - | - | Support coming soon. |
| [postgres_fdw](/docs/extensions/postgres_fdw) | 1.1 | 1.1 | 1.1 | 1.1 | |
| [prefix](https://github.com/dimitri/prefix) | 1.2.0 | 1.2.0 | 1.2.0 | 1.2.0 | |
| [rdkit](https://github.com/rdkit/rdkit) | 4.3.0 | 4.3.0 | 4.3.0 | 4.6.0 | |
| [refint (spi)](https://www.postgresql.org/docs/current/contrib-spi.html) | 1.0 | 1.0 | 1.0 | 1.0 | |
Expand Down
26 changes: 24 additions & 2 deletions content/docs/extensions/pg_cron.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,31 @@ Please note that `pg_cron` jobs will only run when your compute is active. We th

## Enable the `pg_cron` extension

`pg_cron` is currently available only on paid Neon plans. To install `pg_cron`, it must first be enabled by Neon Support. [Open a support ticket](https://console.neon.tech/app/projects?modal=support) with your endpoint ID and database name to request it. After it's enabled by Neon Support, you need to [restart your compute](/docs/manage/endpoints#restart-a-compute) to apply the changes.
To install `pg_cron`, you must first enable it by setting the `cron.database_name` parameter to the name of the database where you want to install `pg_cron`. This requires running an API command using either the [Update project API](https://api-docs.neon.tech/reference/updateproject) or the [Update compute endpoint API](https://api-docs.neon.tech/reference/updateprojectendpoint).

The `cron.database_name` parameter is passed to your Postgres instance through the endpoint settings object. The following `Update project` API example shows where to specify your Neon `project_id`, [Neon API key](/docs/manage/api-keys), and database name.


```bash
curl --request PATCH \
--url https://console.neon.tech/api/v2/projects/<your_project_id> \
--header 'accept: application/json' \
--header 'authorization: Bearer $NEON_API_KEY' \
--header 'content-type: application/json' \
--data '
{
"project": {
"default_endpoint_settings": {
"pg_settings": {
"cron.database_name": "your_db_name"
}
}
}
}
'
```

You can then enable the extension by running the following `CREATE EXTENSION` statement in the [Neon SQL Editor](/docs/get-started-with-neon/query-with-neon-sql-editor) or from a client such as [psql](/docs/connect/query-with-psql-editor) that is connected to your Neon database.
After setting `cron.database_name`, you can then install the `pg_cron` extension by running the following `CREATE EXTENSION` statement in the [Neon SQL Editor](/docs/get-started-with-neon/query-with-neon-sql-editor) or from a client such as [psql](/docs/connect/query-with-psql-editor) that is connected to your Neon database.

```sql
CREATE EXTENSION IF NOT EXISTS pg_cron;
Expand Down
Loading

0 comments on commit 537fdd1

Please sign in to comment.