Skip to content

Latest commit

 

History

History
106 lines (73 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

106 lines (73 loc) · 3.56 KB
Raw

Contributing to pg_later

Installation

The fastest way to get started is by running the Tembo docker image, where pg_later and its dependencies come pre-installed.

docker run -d --name pglater-pg -e POSTGRES_PASSWORD=postgres -p 5432:5432 quay.io/tembo/pglater-pg:latest

Building from source

pg_later is written as a Rust extension and requires pgrx.

To build pg_later from source, you need

  • A toolchain capable of building Postgres
  • Rust toolchain
  • pgmq.

Once you have those pre-requisites, you need to setup pgrx.

# Find the version of PGRX to install from in Cargo.toml
cargo install --locked cargo-pgrx --version 0.9.8

Clone the repo and change into the directory.

git clone https://github.com/tembo-io/pg_later.git
cd pg_later

After this point, the steps differ slightly based on if you'd like to build and install against an existing Postgres setup or develop against pgrx managed development environment (which installs and allows you to test against multiple Postgres versions).

Develop inside container

You can use this command to setup a development environment. You will need Docker running.

docker build -t local-dev-pg-later . && docker run -it --rm -v  $(pwd):/app local-dev-pg-later /bin/bash

When the above command completes, you will have a shell inside of a container with the necessary dependencies installed, and the code shared between the container and your workstation.

Start postgres inside the container like this:

cargo pgrx run

If you are running on a ARM machine, then you will get a warning message like this, which you can ignore <jemalloc>: MADV_DONTNEED does not work. When that's done building the local version of your source code for pg_later, then you will be in a psql shell.

Create extension like this:

CREATE EXTENSION pg_later cascade;

Install to a pre-existing Postgres

Initialize cargo-pgrx, and tell it the path to the your pg_config. For example, if pg_config is on your $PATH and you have Postgres 15, you can run:

cargo pgrx init --pg15=`which pg_config`

Then, to install the release build, you can simply run:

cargo pgrx install --release

Install against pgrx managed Postgres (Recommended for Development)

Initialize cargo-pgrx development environment:

cargo pgrx init

Note: Make sure you build and install pgmq against the postgres installation you want to build against (PG_CONFIG in ~/.pgrx/PG_VERSION/pgrx-install/bin/pg_config and PGDATA in /Users/<myuser>/.pgrx/data-PG_MAJOR_VERSION). Refer to the pgmq installation instructions.

Then, you can use the run command, which will build and install the extension and drop you into psql:

cargo pgrx run pg15

Finally, you can create the extension and get started with the example in the README.md.

CREATE EXTENSION pg_later cascade;

Releases and versioning

pg_later Postgres Extension releases are automated through a Github workflow. The compiled binaries are publish to and hosted at pgt.dev. To create a release, create a new tag follow a valid semver, then create a release with the same name. This release must match the version found in Cargo.toml. Auto-generate the release notes and/or add more relevant details as needed.