PIG Documentation
Documentation version: v1.10.4. This release adds seven catalog entries, removes one retired record, and fixes target-version category aliases, bringing the embedded catalog to 626 entries. Read the release notes.
PIG provides commands to find, install, and build PostgreSQL extension packages. It also manages PostgreSQL, Patroni, pgBackRest, and Pigsty workflows. Package installation uses the system’s apt, dnf, or yum.
Start here
| Your task | Page |
|---|---|
| Install PostgreSQL and enable your first extension | Getting started |
| Learn what PIG does and which platforms it supports | Introduction |
| Download, install, update, or remove PIG | Installation |
| Look up commands, options, and automation features | Command reference |
Install PostgreSQL and extensions
On a Linux host with root or sudo access, run:
In mainland China, use https://repo.pigsty.cc/pig for the installer. These commands install PostgreSQL 18 and pgvector packages. Continue with Getting started to start a test instance and enable the extension with CREATE EXTENSION vector.
Command reference
| Task | Command |
|---|---|
| Configure APT/DNF repositories | pig repo |
| Query the catalog, install, or update extension packages | pig ext, pig install |
| Build extension packages from source | pig build |
| Manage local PostgreSQL instances and databases | pig pg |
| Manage Patroni clusters through patronictl | pig pt |
| Inspect or reload pg_exporter | pig pe |
| Back up and restore with pgBackRest | pig pb |
| Run point-in-time recovery | pig pitr |
| Install and configure Pigsty, manage Grafana | pig sty |
| Read, edit, and validate Pigsty inventory | pig inventory |
| Run Pigsty administration playbooks | pig do |
| Collect host, database, and backup status | pig context |
Run pig help <command> for command help. For automation, use pig -o json --help to inspect command capabilities, then select the relevant output and plan options.
Find more information
Press Ctrl with K (⌘ with K on macOS) to search the site. Press / for page actions. An AI assistant action sends the public page URL and a reading prompt to the selected service.
- Design Records: implementation decisions, trade-offs, and proposals.
- Release notes: changes and download files for each version.
- Extension catalog: extension descriptions and package information.
- GitHub Issues: report a problem or request a feature.
PIG is developed by Vonng and released under Apache 2.0. Pigsty provides PostgreSQL deployment, monitoring, backups, and high availability.