mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-12-12 09:22:05 +00:00
95 lines
2.9 KiB
C++
95 lines
2.9 KiB
C++
#pragma once
|
|
|
|
#include <memory>
|
|
#include <string>
|
|
|
|
#include <Core/Defines.h>
|
|
|
|
namespace DB
|
|
{
|
|
class ReadBuffer;
|
|
class WriteBuffer;
|
|
|
|
/** These are "generally recognizable" compression methods for data import/export.
|
|
* Do not mess with more efficient compression methods used by ClickHouse internally
|
|
* (they use non-standard framing, indexes, checksums...)
|
|
*/
|
|
|
|
enum class CompressionMethod
|
|
{
|
|
None,
|
|
/// DEFLATE compression with gzip header and CRC32 checksum.
|
|
/// This option corresponds to files produced by gzip(1) or HTTP Content-Encoding: gzip.
|
|
Gzip,
|
|
/// DEFLATE compression with zlib header and Adler32 checksum.
|
|
/// This option corresponds to HTTP Content-Encoding: deflate.
|
|
Zlib,
|
|
/// LZMA2-based content compression
|
|
/// This option corresponds to HTTP Content-Encoding: xz
|
|
Xz,
|
|
/// Zstd compressor
|
|
/// This option corresponds to HTTP Content-Encoding: zstd
|
|
Zstd,
|
|
Brotli,
|
|
Lz4,
|
|
Bzip2,
|
|
Snappy,
|
|
};
|
|
|
|
/// How the compression method is named in HTTP.
|
|
std::string toContentEncodingName(CompressionMethod method);
|
|
|
|
/** Choose compression method from path and hint.
|
|
* if hint is "auto" or empty string, then path is analyzed,
|
|
* otherwise path parameter is ignored and hint is used as compression method name.
|
|
* path is arbitrary string that will be analyzed for file extension (gz, br...) that determines compression.
|
|
*/
|
|
CompressionMethod chooseCompressionMethod(const std::string & path, const std::string & hint);
|
|
|
|
/** Choose a compression method from HTTP header list of supported compression methods.
|
|
*/
|
|
CompressionMethod chooseHTTPCompressionMethod(const std::string & list);
|
|
|
|
/// Get a range of the valid compression levels for the compression method.
|
|
std::pair<uint64_t, uint64_t> getCompressionLevelRange(const CompressionMethod & method);
|
|
|
|
std::unique_ptr<ReadBuffer> wrapReadBufferWithCompressionMethod(
|
|
std::unique_ptr<ReadBuffer> nested,
|
|
CompressionMethod method,
|
|
int zstd_window_log_max = 0,
|
|
size_t buf_size = DBMS_DEFAULT_BUFFER_SIZE,
|
|
char * existing_memory = nullptr,
|
|
size_t alignment = 0);
|
|
|
|
|
|
/*
|
|
template<typename WriteBufferT>
|
|
std::unique_ptr<WriteBuffer> wrapWriteBufferWithCompressionMethod(
|
|
WriteBufferT && nested,
|
|
CompressionMethod method,
|
|
int level,
|
|
size_t buf_size = DBMS_DEFAULT_BUFFER_SIZE,
|
|
char * existing_memory = nullptr,
|
|
size_t alignment = 0);
|
|
*/
|
|
|
|
std::unique_ptr<WriteBuffer> wrapWriteBufferWithCompressionMethod(
|
|
std::unique_ptr<WriteBuffer> nested,
|
|
CompressionMethod method,
|
|
int level,
|
|
size_t buf_size = DBMS_DEFAULT_BUFFER_SIZE,
|
|
char * existing_memory = nullptr,
|
|
size_t alignment = 0,
|
|
bool compress_empty = true);
|
|
|
|
std::unique_ptr<WriteBuffer> wrapWriteBufferWithCompressionMethod(
|
|
WriteBuffer * nested,
|
|
CompressionMethod method,
|
|
int level,
|
|
size_t buf_size = DBMS_DEFAULT_BUFFER_SIZE,
|
|
char * existing_memory = nullptr,
|
|
size_t alignment = 0,
|
|
bool compress_empty = true);
|
|
|
|
}
|