Skip to main content
Version: 0.1

Get Started

Docker Image​

The easiest way to get started with pg_mooncake is through our Docker container, which comes pre-installed with PostgreSQL 17 and the pg_mooncake extension.

Pull the image:

docker pull mooncakelabs/pg_mooncake

Run the container:

docker run --name mooncake-demo -e POSTGRES_HOST_AUTH_METHOD=trust -p 5432:5432 -d mooncakelabs/pg_mooncake

This will start a PostgreSQL 17 instance with pg_mooncake already installed and ready to use. Connect to the database using any PostgreSQL client:

docker run -it --rm --link mooncake-demo:postgres mooncakelabs/pg_mooncake psql -h postgres -U postgres

or use the following connection details:

  • Host: localhost
  • Port: 5432
  • Username: postgres
  • Password: postgres

From Source​

Compile and install the pg_mooncake extension. Supported PostgreSQL versions: 14, 15, 16, and 17.

git submodule update --init --recursive
make release -j$(nproc)
make install

Create the extension​

In psql:

CREATE EXTENSION pg_mooncake;

It's also recommended to load the extension to ensure all functions will run correctly:

LOAD EXTENSION pg_mooncake;