Kudu C++ client API
Public Types | Public Member Functions | Static Public Member Functions | List of all members
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

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]encodingEncoding type for the column storage.
[in]compressionCompression type for the column storage.
[in]block_sizeBlock 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()

static Status kudu::client::KuduColumnStorageAttributes::StringToCompressionType ( const std::string &  compression,
CompressionType type 
)
static
Parameters
[in]compressionString representation of the column compression type
[out]typeEnum representation of the column compression type, Converted from string format.
Returns
Operation result status.

◆ StringToEncodingType()

static Status kudu::client::KuduColumnStorageAttributes::StringToEncodingType ( const std::string &  encoding,
EncodingType type 
)
static
Parameters
[in]encodingString representation of the column encoding type
[out]typeEnum 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: