compress

package
v0.0.4 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 31, 2022 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Overview

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

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

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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.

Directories

Path Synopsis
Package brotli implements the BROTLI parquet compression codec.
Package brotli implements the BROTLI parquet compression codec.
Package gzip implements the GZIP parquet compression codec.
Package gzip implements the GZIP parquet compression codec.
Package lz4 implements the LZ4_RAW parquet compression codec.
Package lz4 implements the LZ4_RAW parquet compression codec.
Package snappy implements the SNAPPY parquet compression codec.
Package snappy implements the SNAPPY parquet compression codec.
Package uncompressed provides implementations of the compression codec interfaces as pass-through without applying any compression nor decompression.
Package uncompressed provides implementations of the compression codec interfaces as pass-through without applying any compression nor decompression.
Package zstd implements the ZSTD parquet compression codec.
Package zstd implements the ZSTD parquet compression codec.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL