taco::IndexDesc Class Reference

#include <catalog/IndexDesc.h>

Public Member Functions
const SysTable_Index *	GetIndexEntry () const
	Returns the cached Index entry associated with this index descriptor. More...
const SysTable_IndexColumn *	GetIndexColumnEntry (FieldId keyid) const
const Schema *	GetKeySchema () const
	Returns the cached index key schema, which we guanrantee ‘IsLayoutComputed() == true’. More...

Static Public Member Functions
static IndexDesc *	Create (std::shared_ptr< const SysTable_Index > index, std::vector< std::shared_ptr< SysTable_IndexColumn >> index_columns, std::unique_ptr< Schema > key_schema)
	This overload simply passes the arguments to the constructor. More...

Private Member Functions
	IndexDesc (std::shared_ptr< const SysTable_Index > index, std::vector< std::shared_ptr< SysTable_IndexColumn >> index_columns, std::unique_ptr< Schema > key_schema)

Private Attributes
std::shared_ptr< const SysTable_Index >	m_index
std::vector< std::shared_ptr< SysTable_IndexColumn > >	m_index_columns
std::unique_ptr< Schema >	m_key_schema

Constructor & Destructor Documentation

IndexDesc()

taco::IndexDesc::IndexDesc ( std::shared_ptr< const SysTable_Index >  index, std::vector< std::shared_ptr< SysTable_IndexColumn >>  index_columns, std::unique_ptr< Schema >  key_schema  )

inlineprivate

Member Function Documentation

Create()

IndexDesc * taco::IndexDesc::Create ( std::shared_ptr< const SysTable_Index >  index, std::vector< std::shared_ptr< SysTable_IndexColumn >>  index_columns, std::unique_ptr< Schema >  key_schema  )

static

This overload simply passes the arguments to the constructor.

GetIndexColumnEntry()

const SysTable_IndexColumn* taco::IndexDesc::GetIndexColumnEntry ( FieldId  keyid ) const

inline

GetIndexEntry()

const SysTable_Index* taco::IndexDesc::GetIndexEntry ( ) const

inline

Returns the cached Index entry associated with this index descriptor.

Note that the Index entry may be destructed as well if the index descriptor is destructed, so you must access the Index entry while the index descriptor is still alive.

GetKeySchema()

const Schema* taco::IndexDesc::GetKeySchema ( ) const

inline

Returns the cached index key schema, which we guanrantee ‘IsLayoutComputed() == true’.

Member Data Documentation

m_index

std::shared_ptr<const SysTable_Index> taco::IndexDesc::m_index

private

m_index_columns

std::vector<std::shared_ptr<SysTable_IndexColumn> > taco::IndexDesc::m_index_columns

private

m_key_schema

std::unique_ptr<Schema> taco::IndexDesc::m_key_schema

private

---

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

• catalog/IndexDesc.h
• catalog/IndexDesc.cpp