hazelcast::client::config::index_config Struct Reference

Configuration of an index. More...

#include <index_config.h>

Classes
struct	bitmap_index_options

Public Types
enum	index_type { SORTED, HASH, BITMAP }

Public Member Functions
	index_config (index_type type)
	Creates an index configuration of the given type. More...
template<typename ... T>
	index_config (index_type t, T... attrs)
	Creates an index configuration of the given type with provided attributes. More...

Public Attributes
boost::optional< std::string >	name
	Name of the index. More...
index_type	type
	Type of the index. More...
std::vector< std::string >	attributes
	Indexed attributes. More...
boost::optional< bitmap_index_options >	options

Static Public Attributes
static const index_type	DEFAULT_TYPE = index_config::index_type::SORTED

Detailed Description

Configuration of an index.

Hazelcast support two types of indexes: sorted index and hash index. Sorted indexes could be used with equality and range predicates and have logarithmic search time. Hash indexes could be used with equality predicates and have constant search time assuming the hash function of the indexed field disperses the elements properly.

Index could be created on one or more attributes.

Member Enumeration Documentation

index_type

enum hazelcast::client::config::index_config::index_type

Enumerator
SORTED	Sorted index. Can be used with equality and range predicates.
HASH	Hash index. Can be used with equality predicates.
BITMAP	Bitmap index. Can be used with equality predicates.

Constructor & Destructor Documentation

index_config() [1/2]

hazelcast::client::config::index_config::index_config

(

index_config::index_type

type

)

Creates an index configuration of the given type.

Parameters

type	Index type.

index_config() [2/2]

template<typename ... T>

hazelcast::client::config::index_config::index_config ( index_type  t, T...  attrs  )

inline

Creates an index configuration of the given type with provided attributes.

Parameters

type	Index type.
attributes	Attributes to be indexed.

Member Data Documentation

attributes

std::vector<std::string> hazelcast::client::config::index_config::attributes

Indexed attributes.

name

boost::optional<std::string> hazelcast::client::config::index_config::name

Name of the index.

type

index_type hazelcast::client::config::index_config::type

Type of the index.

---

The documentation for this struct was generated from the following files:

• hazelcast/include/hazelcast/client/config/index_config.h
• hazelcast/src/hazelcast/client/config.cpp