Search Shortcut cmd + k | ctrl + k
compression_fs

Adds LZ4, Snappy, Brotli, Bzip2, and XZ file compression support

Maintainer(s): dentiny

Compatibility Matrix

This table covers all DuckDB releases that have not reached end-of-life, including LTS releases, and shows the 2 most recent patch releases of each. Older patch releases are not listed, but the extension may be available for them as well.

Platform 1.4.4 1.4.5 1.5.5 1.5.6 2.0.0
Linux AMD64
Linux ARM64
macOS AMD64
macOS ARM64
Windows AMD64
Windows ARM64
WebAssembly

Installing and Loading

INSTALL compression_fs FROM community;
LOAD compression_fs;

Example

COPY (SELECT 42 AS value) TO 'example.csv.xz'
  (FORMAT CSV, HEADER, COMPRESSION 'xz');
SELECT * FROM read_csv('example.csv.xz');

About compression_fs

This extension adds file-level compression formats that DuckDB does not support natively. It integrates with DuckDB's virtual filesystem so compressed files can be used directly by readers and writers such as read_csv and COPY.

Supported formats include LZ4 (.lz4), Snappy (.sz and .snappy), Brotli (.br), Bzip2 (.bz2), and XZ (.xz).

Added Functions

This extension does not add any functions.

Overloaded Functions

This extension does not add any function overloads.

Added Types

This extension does not add any types.

Added Settings

name description input_type scope aliases typed_value
temp_directory Set the directory to which temporary files are written. VARCHAR GLOBAL [] post.db.tmp