kudu::client::KuduColumnStorageAttributes Class Reference

Representation of column storage attributes. More...

#include <schema.h>

Public Types
enum	EncodingType {   AUTO_ENCODING = 0 , PLAIN_ENCODING = 1 , PREFIX_ENCODING = 2 , RLE = 4 ,   DICT_ENCODING = 5 , BIT_SHUFFLE = 6 , GROUP_VARINT = 3 }
	Column encoding types. More...
enum	CompressionType {   DEFAULT_COMPRESSION = 0 , NO_COMPRESSION = 1 , SNAPPY = 2 , LZ4 = 3 ,   ZLIB = 4 }
	Column compression types.

Public Member Functions
	KuduColumnStorageAttributes (EncodingType encoding=AUTO_ENCODING, CompressionType compression=DEFAULT_COMPRESSION, int32_t block_size=0)
const EncodingType	encoding () const
const CompressionType	compression () const
std::string	ToString () const

Static Public Member Functions
static Status	StringToEncodingType (const std::string &encoding, EncodingType *type)
static Status	StringToCompressionType (const std::string &compression, CompressionType *type)

Detailed Description

Representation of column storage attributes.

Member Enumeration Documentation

EncodingType

enum kudu::client::KuduColumnStorageAttributes::EncodingType

Column encoding types.

Enumerator
GROUP_VARINT	Deprecated GROUP_VARINT is not supported for valid types, and will fall back to another encoding on the server side.

Constructor & Destructor Documentation

KuduColumnStorageAttributes()

kudu::client::KuduColumnStorageAttributes::KuduColumnStorageAttributes ( EncodingType encoding = AUTO_ENCODING, CompressionType compression = DEFAULT_COMPRESSION, int32_t block_size = 0 )

inlineexplicit

Deprecated

This constructor is deprecated for external use, and will be made private in a future release.

Todo

Make this constructor private.

Parameters

[in]	encoding	Encoding type for the column storage.
[in]	compression	Compression type for the column storage.
[in]	block_size	Block size (in bytes, uncompressed data) for the column storage.

Member Function Documentation

compression()

const CompressionType kudu::client::KuduColumnStorageAttributes::compression ( ) const

inline

Returns

Compression type for the column storage.

encoding()

const EncodingType kudu::client::KuduColumnStorageAttributes::encoding ( ) const

inline

Returns

Encoding type for the column storage.

StringToCompressionType()

Status kudu::client::KuduColumnStorageAttributes::StringToCompressionType ( const std::string & compression, CompressionType * type )

static

Parameters

[in]	compression	String representation of the column compression type
[out]	type	Enum representation of the column compression type, Converted from string format.

Returns

Operation result status.

StringToEncodingType()

Status kudu::client::KuduColumnStorageAttributes::StringToEncodingType ( const std::string & encoding, EncodingType * type )

static

Parameters

[in]	encoding	String representation of the column encoding type
[out]	type	Enum representation of the column encoding type, Converted from string format.

Returns

Operation result status.

ToString()

std::string kudu::client::KuduColumnStorageAttributes::ToString

(

)

const

Returns

String representation of the storage attributes.

---

The documentation for this class was generated from the following file:

• include/kudu/client/schema.h