Quick Start

To use extensions in Pigsty, complete four steps: Download, Install, Config, and Create.

1. Download: Download extension packages to the local repository. The default local repository only guarantees the base kernel and pgsql-main package set.
2. Install: Install extension packages on cluster nodes
3. Config: Some extensions need to be preloaded or configured with parameters
4. Create: Execute CREATE EXTENSION in the database to create the extension

Declarative Configuration

Declare extensions in the Pigsty inventory. During cluster initialization, Pigsty installs their packages and creates the extensions automatically:

pg-meta:
  hosts: { 10.10.10.10: { pg_seq: 1, pg_role: primary } }
  vars:
    pg_cluster: pg-meta
    pg_databases:
      - name: meta
        extensions: [ postgis, timescaledb, vector ]   # Create extensions in database
    pg_libs: 'timescaledb, pg_stat_statements, auto_explain' # Preload extension libraries
    pg_extensions: [ postgis, timescaledb, pgvector ]  # Install extension packages

Run ./pgsql.yml to initialize the cluster. The three extensions postgis, timescaledb, and vector will then be available in the meta database.

Imperative Operations

For an existing cluster, you can use commands to add extensions:

# 1. Install extension packages
./pgsql.yml -l pg-meta -t pg_extension -e '{"pg_extensions":["pgvector"]}'

# 2. Preload extension (if needed, requires restart after modification)
pg edit-config pg-meta --force -p shared_preload_libraries='timescaledb, pg_stat_statements, auto_explain'

# 3. Create extension in database
psql -d meta -c 'CREATE EXTENSION vector;'

You can also install extension packages with the pig package manager. Then run CREATE EXTENSION in the database:

pig install pgvector                         # Install extension package
psql -d meta -c 'CREATE EXTENSION vector;'   # Create extension in database

Process Quick Reference

For detailed instructions, see each subsection: Download, Install, Config, Create