The pg_analytics extension powers ParadeDB’s ingest API.

This guide explains how to install pg_analytics inside an existing PostgreSQL database. These instructions are for deploying on Linux Debian/Ubuntu. If you are using a different version of Linux, please contact us.

​

Prerequisites

Ensure that you have superuser access to the Postgres database.

​

Install pg_analytics

ParadeDB provides prebuilt binaries for the pg_analytics extension on Debian 12, Ubuntu 22.04 and 24.04, and Red Hat Enterprise Linux 8 and 9 for Postgres 14, 15 and 16 on both amd64 (x86_64) and arm64. They can be found in GitHub Releases. If you are using a different version of Postgres or a different operating system, you will need to build the extension from source.

​

Using Prebuilt Binaries

Note: You can replace v0.1.4 with the pg_analytics version you wish to install, and 16 with the version of Postgres you are using.

​

Building from Source

Please follow these instructions.

​

Update postgresql.conf

Next, add pg_analytics to shared_preload_libraries in postgresql.conf.

shared_preload_libraries = 'pg_analytics'

Reload your PostgreSQL server for these changes to take effect.

​

Load the Extension

Once the extension binary is installed on your system, connect to your Postgres database via your client of choice (e.g. psql) and run the following command:

CREATE EXTENSION pg_analytics;

That’s it! For next steps, follow the quickstart guide.