Managing a Cluster
Supported Components

pgEdge Platform

You can use the pgEdge Update Manager module to help manage extensions on pgEdge platform. Command options let you install, remove, upgrade, and check the availability of extensions for your pgEdge installation. To install an extension, use the um install (opens in a new tab) command:

./pgedge um install component_name

Where component_name is the name of the component you wish to install.

You can use the Update Manager list command to find the available build versions and build dates for components that Update Manager can add to your pgEdge cluster; navigate into the pgedge directory, and invoke the command:

./pgedge um list

CategoryComponentVersionReleaseDtStageStatusUpdatesPreReqs
Postgrespg1414.12-12024-05-09prodNotInitialized
Postgrespg1515.7-12024-05-09prodNotInitialized
Postgrespg1616.3-12024-05-09prodInstalled
Extensionsaudit-pg151.7.0-12023-09-14prod
Extensionsaudit-pg1616.0-12023-09-14prodInstalled
Extensionscitus-pg1512.1.3-12024-05-09prod
Extensionscitus-pg1612.1.3-12024-05-09prodInstalled
Extensionscron-pg151.6.2-12023-11-12prod
Extensionscron-pg161.6.2-12023-11-12prodInstalled
Extensionscurl-pg152.2.2-12024-01-30prod
Extensionscurl-pg162.2.2-12024-01-30prodInstalled
Extensionsfoslots-pg141a-12024-04-02prod
Extensionsfoslots-pg151a-12024-04-02prod
Extensionshintplan-pg151.5.1-12023-09-27prod
Extensionshintplan-pg161.6.0-12023-09-27prodInstalled
Extensionshypopg-pg151.4.1-12024-05-09prod
Extensionshypopg-pg161.4.1-12023-05-09prodInstalled
Extensionspartman-pg155.0.1-12024-01-30prod
Extensionspartman-pg165.0.1-12024-01-30prodInstalled
Extensionspldebugger-pg151.6-12023-11-12prod
Extensionspldebugger-pg161.6-12023-11-12prodInstalled
Extensionsplprofiler-pg154.2.4-12023-09-14prod
Extensionsplprofiler-pg164.2.4-12023-09-14prodInstalled
Extensionsplv8-pg163.2.2-12024-02-14prodInstalled
Extensionspostgis-pg153.4.2-12024-03-07prod
Extensionspostgis-pg163.4.2-12024-03-07prodInstalled
Extensionssnowflake-pg142.0-12024-04-05prod
Extensionssnowflake-pg152.0-12024-04-05prod
Extensionssnowflake-pg162.0-12024-04-05prodInstalled
Extensionsspock33-pg143.3.3-12024-05-09prod
Extensionsspock33-pg153.3.3-12024-05-09prod
Extensionsspock33-pg163.3.3-12024-05-09prodInstalled
Extensionsspock40-pg144.0.130-12024-05-09prod
Extensionsspock40-pg154.0.130-12024-05-09prod
Extensionsspock40-pg164.0.130-12024-05-09prodInstalled
Extensionsvector-pg150.7.0-12024-05-09prod
Extensionsvector-pg160.7.0-12024-05-09prodInstalled
Applicationsbackrest2.51-12024-04-10prodInstalled
Applicationspgcat1.1.12024-01-08prodInstalled
Applicationsprompgexp0.15.0-12024-02-21prodInstalled

The Update Manager table displays the following information:

  • The Category column identifies the component as a PostgreSQL version, an extension, or an application.
  • The Component column lists the name of the component, followed by the PostgreSQL version that the component runs on.
  • The Version column displays the available version of the component.
  • The ReleaseDt column displays the date that the listed version was released.
  • The Stage column displays a note about the build; production releases are noted with the abbreviation prod.
  • The Status column displays Installed if the listed component is installed on your system.
  • The Updates column identifies components with available updates; you can use the pgedge um update (opens in a new tab) command to update components.
  • The PreReqs column identifies any prerequisites required by the component.

PostgreSQL

PostgreSQL

PostgreSQL (opens in a new tab) is a powerful, open source object-relational database system with over 35 years of active development that has earned it a strong reputation for reliability, feature robustness, and performance.

CLI

pgedge

pgedge (opens in a new tab) is the name of the CLI for the pgEdge platform.

Spock

spock

The Spock (opens in a new tab) extension provides multi-master (multi-active) replication for PostgreSQL 15 & 16. We leveraged both the pgLogical & BDR2 Open Source projects as a solid foundation to build upon for this enterprise-class extension.

NodeCtl (part of the pgEdge Platform) provides a command-line interface for the Spock extension; for information and to review online documentation, visit the project website (opens in a new tab).

pgEdge Extended Platform

ACE

ACE

The ace (opens in a new tab) extension provides the Anti Chaos Engine for a pgEdge SPOCK cluster.

Citus

citus

https://docs.citusdata.com/en/stable/get_started/what_is_citus.html (opens in a new tab)

Citus (opens in a new tab) provides an open source extension that supports PostgreSQL features including distributed tables.

etcd

etcd

etcd (opens in a new tab) is a strongly consistent, distributed key-value store that provides a reliable way to store data that needs to be accessed by a distributed system or cluster of machines.

HAProxy

HAProxy

HAProxy (opens in a new tab) is a free, very fast and reliable reverse-proxy offering high availability, load balancing, and proxying for TCP and HTTP-based applications. It is particularly suited for very high traffic web sites and powers a significant portion of the world's most visited ones.

Patroni

Patroni

Patroni (opens in a new tab) is a template for high availability (HA) PostgreSQL solutions using Python.

pgBackRest

pgBackRest

pgBackRest (opens in a new tab) is a reliable, easy-to-use backup and restore solution that can seamlessly scale up to the largest databases and workloads by utilizing algorithms that are optimized for database-specific requirements.

pgCat2

pgCat

pgCat2 (opens in a new tab) is a PostgreSQL pooler and proxy (like PgBouncer) with support for sharding, load balancing, failover and mirroring.

pgcurl

pgcurl

pg_curl (opens in a new tab) allows most curl actions, including data transfer with URL syntax via HTTP, HTTPS, FTP, FTPS, GOPHER, TFTP, SCP, SFTP, SMB, TELNET, DICT, LDAP, LDAPS, FILE, IMAP, SMTP, POP3, RTSP and RTMP.

PostGREST

PostGREST

PostgREST is a standalone web server that allows you to access your pgEdge Postgres database cluster with RESTful API calls. It is very simple to use because the API is built on the existing structure and inherits permissions you've already defined in your PostgreSQL database. You use a simple configuration file to specify the schema objects that will be exposed through the API. While the PostgreSQL server monitors the default listener port, for libpq-styled calls to the server, the PostgREST server monitors port 3000 for API-styled calls.

For information about installing and using PostGREST with pgEdge, visit our blog post, pgEdge and PostGREST (opens in a new tab).

ReadOnly

ReadOnly

pg_readonly (opens in a new tab) is a PostgreSQL extension that allows you to set all cluster databases to read only.

Additional Community Extensions for Core and Extended Platforms

pgAdmin

pgAdmin

pgAdmin (opens in a new tab) is an open-source graphical administration and development platform for PostgreSQL that works on Linux, Unix, macOS, and Windows.

HypoPG

HypoPG

HypoPG (opens in a new tab) is a PostgreSQL extension that adds support for Hypothetical Indexes.

OracleFDW

OracleFDW

oracle_fdw (opens in a new tab) is a PostgreSQL extension that provides a Foreign Data Wrapper for easy and efficient access to Oracle databases, including pushdown of WHERE conditions and required columns as well as comprehensive EXPLAIN support.

OraFCE

OraFCE

orafce (opens in a new tab) supports functions and operators that emulate a subset of functions and packages from the Oracle RDBMS.

pgAudit

pgAudit

pgAudit (opens in a new tab) provides detailed session and/or object audit logging via the standard PostgreSQL logging facility.

pgcat

pgcat

pg_cat (opens in a new tab) is a PostgreSQL pooler and proxy with support for sharding, load balancing, failover and mirroring.

pgCron

pgCron

pg_cron is a simple cron-based job scheduler for PostgreSQL (10 or higher) that runs inside the database as an extension.

pgHintPlan

pgHintPlan

pg_hint_plan (opens in a new tab) makes it possible to tweak PostgreSQL execution plans using so-called "hints" in SQL comments, like /*+ SeqScan(a) */.

pgPartman

pgPartman

pg_partman (opens in a new tab) is an extension to create and manage both time-based and serial-based table partition sets.

pgRepack

pgRepack

pg_repack (opens in a new tab) is a PostgreSQL extension which lets you remove bloat from tables and indexes, and optionally restore the physical order of clustered indexes.

PgVector

PgVector

pgvector (opens in a new tab) enables you to store vector embeddings and perform vector similarity search in Postgres. It is particularly useful for applications involving natural language processing, such as those built on top of OpenAI's GPT models.

PL/Debugger

PL/Debugger

The PL/Debugger (opens in a new tab) module is a set of shared libraries which implement an API for debugging pl/pgsql functions on PostgreSQL 8.4 and above.

PL/Profiler

PL/Profiler

plprofiler (opens in a new tab) is an extension for PostgreSQL that creates performance profiles of PL/pgSQL functions and stored procedures.

PL/V8

PL/V8

PLV8 (opens in a new tab) is a shared library that provides a PostgreSQL procedural language powered by V8 Javascript Engine. With this program you can write functions in Javascript that are callable from SQL.

PostGIS

PostGIS

PostGIS extends the capabilities of the PostgreSQL relational database by adding support for storing, indexing, and querying geographic data.

TimescaleDB

TimescaleDB

TimescaleDB (opens in a new tab) is an open-source database designed to make SQL scalable for time-series data. It is engineered up from PostgreSQL and packaged as a PostgreSQL extension, providing automatic partitioning across time and space (partitioning key), as well as full SQL support.