Skip to content

Commit 9357acc

Browse files
authored
Merge pull request #6513 from EnterpriseDB/extensions-docs-810-pgrouting
Extensions docs 810 pgrouting
2 parents 609fba5 + 10f0dd4 commit 9357acc

File tree

9 files changed

+125
-2
lines changed

9 files changed

+125
-2
lines changed

advocacy_docs/pg_extensions/extensionrefs.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
"pg_store_plans": "https://ossc-db.github.io/pg_store_plans/",
6262
"pgaudit": "https://www.pgaudit.org/",
6363
"pglogical_2.x": "https://www.enterprisedb.com/docs/supported-open-source/pglogical2/",
64-
"pgrouting": "https://pgrouting.org/",
64+
"pgrouting": "https://www.enterprisedb.com/docs/pg_extensions/pgrouting",
6565
"pgsnmpd_(11-13)": "undefined",
6666
"pgvector": "https://www.enterprisedb.com/docs/pg_extensions/pgvector",
6767
"pljava_(11)": "https://tada.github.io/pljava/",

advocacy_docs/pg_extensions/index.mdx

Lines changed: 2 additions & 1 deletion
Large diffs are not rendered by default.

advocacy_docs/pg_extensions/index.mdx.in

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ navigation:
1111
- wait_states
1212
- pgaudit
1313
- pg_failover_slots
14+
- pgRouting
1415
- pg_squeeze
1516
- pgvector
1617
- system_stats
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
title: Configuring pgRouting
3+
navTitle: Configuring
4+
---
5+
!!! Note
6+
`pgRouting` depends on PostGIS. To install PostGIS, see [EDB PostGIS](https://www.enterprisedb.com/docs/postgis/latest/)
7+
8+
To enable `pgRouting`, create the extension.
9+
10+
CREATE EXTENSION pgrouting;
11+
12+
For additional configuration information, see the [Configuring pgRouting](https://docs.pgrouting.org/latest/en/pgRouting-installation.html#configuring) in the official documentation.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
title: 'pgRouting'
3+
indexCards: none
4+
navigation:
5+
- rel_notes
6+
- installing
7+
- configuring
8+
- using
9+
directoryDefaults:
10+
product: pgRouting
11+
---
12+
13+
`pgRouting` is an extension released as open source software under the PostgreSQL License.
14+
15+
`pgRouting` provides geospatial routing functionality.
16+
17+
For more information about `pgRouting`, see:
18+
19+
- [Installing pgRouting](installing.mdx)
20+
- [Configuring pgRouting](configuring.mdx)
21+
- [Using pgRouting](using.mdx)
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
title: Installing pgRouting
3+
navTitle: Installing
4+
---
5+
6+
`pgRouting` is supported on the same platforms as the Postgres distribution you're using. Support for `pgRouting` starts with Postgres 13. For details, see:
7+
8+
- [EDB Postgres Advanced Server Product Compatibility](https://www.enterprisedb.com/platform-compatibility#epas)
9+
- [PostgreSQL Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#pg)
10+
- [EDB Postgres Extended Server Product Compatibility](https://www.enterprisedb.com/resources/platform-compatibility#epas_extended)
11+
12+
## Installation
13+
14+
Before you begin the installation process:
15+
16+
- Install Postgres. See:
17+
18+
- [Installing EDB Postgres Advanced Server](/epas/latest/installing/)
19+
20+
- [Installing PostgreSQL](https://www.postgresql.org/download/)
21+
22+
- [Installing EDB Postgres Extended Server](/pge/latest/installing/)
23+
24+
- Set up the repository.
25+
26+
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.
27+
28+
To set up the repository, go to [EDB repositories](https://www.enterprisedb.com/repos-downloads) and follow the instructions provided there.
29+
30+
## Install the package
31+
32+
The syntax for the package install command is:
33+
34+
```shell
35+
# For SLES, CentOS, RHEL and its derivatives
36+
sudo <package-manager> -y install edb-<postgres><postgres_version>-pgRouting0
37+
38+
# For Debian and Ubuntu
39+
sudo <package-manager> -y install edb-<postgres><postgres_version>-pgRouting-0
40+
```
41+
42+
Where:
43+
- `<package-manager>`is the package manager used with your operating system:
44+
45+
| Package manager | Operating system |
46+
| --------------- | -------------------------------- |
47+
| dnf | RHEL 8/9 and derivatives |
48+
| yum | RHEL 7 and derivatives, CentOS 7 |
49+
| zypper | SLES |
50+
| apt-get | Debian and derivatives |
51+
52+
- `<postgres>` is the distribution of Postgres you're using:
53+
54+
| Postgres distribution | Value |
55+
| ---------------------------- | ---------- |
56+
| PostgreSQL | pg |
57+
| EDB Postgres Advanced Server | as |
58+
| EDB Postgres Extended Server | postgresextended |
59+
60+
- `<postgres_version>` is the version of Postgres you're using.
61+
62+
For example, to install pgRouting for EDB Postgres Advanced Server 15 on a RHEL 8 platform:
63+
64+
```shell
65+
sudo dnf -y install edb-as15-pgRouting0
66+
```
Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: 'pgRouting release notes'
3+
navTitle: "Release notes"
4+
indexCards: none
5+
---
6+
The `pgRouting` documentation describes the latest version of `pgRouting`, 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.
7+
8+
| Version | Release Date |
9+
| ----------------------------------- | ------------ |
10+
| [3.7.0](pgrouting_3.7.0_rel_notes) | Dec 2024 |
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Release notes for pgRouting
3+
navTitle: "Version 3.7.0"
4+
---
5+
6+
For `pgRouting` release notes, see the [pgRouting official release notes](https://docs.pgrouting.org/latest/en/release_notes.html).
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Using pgRouting
3+
navTitle: Using
4+
---
5+
6+
For more information on using `pgRouting`, see [Getting Started](https://github.com/pgRouting/pgRouting?tab=readme-ov-file#getting-started) in the `pgRouting` official documentation.

0 commit comments

Comments
 (0)