compress

Documentation

Overview

Package compress provides the generic APIs implemented by parquet compression codecs.

https://github.com/apache/parquet-format/blob/master/Compression.md

Index

• type Codec
• type Reader
• type Writer

Types

type Codec

type Codec interface {
	// Returns a human-readable name for the codec.
	String() string

	// Returns the code of the compression codec in the parquet format.
	CompressionCodec() format.CompressionCodec

	// Creates a new Reader decompressing data from the io.Reader passed as
	// argument.
	NewReader(io.Reader) (Reader, error)

	// Creates a new Writer compressing data to the io.Writer passed as
	// argument.
	NewWriter(io.Writer) (Writer, error)
}

The Codec interface represents parquet compression codecs implemented by the compress sub-packages.

Codec instances must be safe to use concurrently from multiple goroutines.

type Reader

type Reader interface {
	io.Reader
	io.Closer
	Reset(io.Reader) error
}

Reader is an extension of io.Reader implemented by all decompressors.

type Writer

type Writer interface {
	io.Writer
	io.Closer
	Reset(io.Writer) error
}

Writer is an extension of io.Writer implemented by all compressors.