zstd

Overview

PIGSTY 3rd Party Extension: pg_zstd : Zstandard compression algorithm implementation in PostgreSQL

Information

• Extension ID: 4000
• Extension Name: zstd
• Package Name: pg_zstd
• Category: UTIL
• License: ISC
• Website: https://github.com/grahamedgecombe/pgzstd
• Language: C
• Extra Tags: N/A
• Comment:

Metadata

• Latest Version: 1.1.0
• Postgres Support: 17,16,15,14,13
• Need Load: Shared library do not need explicit loading
• Need DDL: Need CREATE EXTENSION DDL
• Relocatable: Can not install to arbitrary schema
• Trusted: Unknown
• Schemas: N/A
• Requires: N/A

RPM / DEB

• RPM Repo: PIGSTY
• RPM Name: pg_zstd_$v*
• RPM Ver : 1.1.0
• RPM Deps: N/A
• DEB Repo: PIGSTY
• DEB Name: postgresql-$v-pg-zstd
• DEB Ver : 1.1.0
• DEB Deps: N/A

Packages

Installation

Install zstd via the pig CLI tool:

pig ext install pg_zstd; # Extension Namepig ext install zstd; # normalized package name

Install pg_zstd via Pigsty playbook:

./pgsql.yml -t pg_extension -e '{"pg_extensions": ["pg_zstd"]}' # -l <cls>

Install pg_zstd RPM from YUM repo directly:

dnf install pg_zstd_17*;
dnf install pg_zstd_16*;
dnf install pg_zstd_15*;
dnf install pg_zstd_14*;
dnf install pg_zstd_13*;

Install pg_zstd DEB from APT repo directly:

apt install postgresql-17-pg-zstd;
apt install postgresql-16-pg-zstd;
apt install postgresql-15-pg-zstd;
apt install postgresql-14-pg-zstd;
apt install postgresql-13-pg-zstd;

Enable zstd extension on PostgreSQL cluster：

CREATE EXTENSION zstd;

Usage

zstd_compress compresses the provided data and returns a Zstandard frame. A preset dictionary may also be provided. The default compression level may also be overriden, valid values range from 1 (best speed) to 22 (best compression). The default level is 3.

If you want to override the compression level without using a dictionary, set dictionary to NULL.

zstd_decompress decompresses the provided Zstandard frame in data and returns the uncompressed data. A preset dictionary, matching the dictionary used to compress the data, may also be provided.

zstd_length returns the decompressed length of the provided Zstandard frame. If ZSTD_getFrameContentSize() is available it returns NULL if the length is unknown. If unavailable, it isn’t possible to distinguish the error, unknown decompressed length and zero decompressed length cases.

Example

Basic compress/decompress example:

CREATE EXTENSION zstd;

SELECT zstd_compress('hello world');
-- zstd_compress
-- --------------------------------------------
-- \x28b52ffd200b59000068656c6c6f20776f726c64

SELECT convert_from(zstd_decompress('\x28b52ffd200b59000068656c6c6f20776f726c64'), 'utf-8');
-- convert_from
-- --------------
--  hello world

Compress with level (1 for best speed, 22 for best compression, default to 3)

CREATE EXTENSION zstd;

SELECT zstd_compress('hello world',  NULL, 10);
-- zstd_compress
-- --------------------------------------------
-- \x28b52ffd200b59000068656c6c6f20776f726c64

SELECT convert_from(zstd_decompress('\x28b52ffd200b59000068656c6c6f20776f726c64'), 'utf-8');
-- convert_from
-- --------------
--  hello world