m::idx::IndexBase Struct Reference

The base class for indexes. More...

#include <Index.hpp>

Inheritance diagram for m::idx::IndexBase:

Public Member Functions
	IndexBase (IndexBase &&)=default
virtual	~IndexBase ()
virtual void	bulkload (const Table &table, const Schema &key_schema)=0
	Bulkloads the index by executing a query on table using key_schema.
virtual std::size_t	num_entries () const =0
virtual IndexMethod	method () const =0
	Returns the IndexMethod of the index.
virtual void	dump (std::ostream &out) const =0
virtual void	dump () const =0

Protected Member Functions
	IndexBase ()=default

Static Protected Member Functions
static std::string	build_query (const Table &table, const Schema &schema)
	Constructs a query string to select all attributes in schema from table.

Detailed Description

The base class for indexes.

Definition at line 26 of file Index.hpp.

Constructor & Destructor Documentation

IndexBase() [1/2]

m::idx::IndexBase::IndexBase ( )

protecteddefault

IndexBase() [2/2]

m::idx::IndexBase::IndexBase ( IndexBase &&  )

default

~IndexBase()

virtual m::idx::IndexBase::~IndexBase ( )

inlinevirtual

Definition at line 33 of file Index.hpp.

Member Function Documentation

build_query()

std::string IndexBase::build_query ( const Table &  table, const Schema &  schema  )

staticprotected

Constructs a query string to select all attributes in schema from table.

Definition at line 40 of file Index.cpp.

References m::Schema::at(), m::Schema::entry_type::id, m::Table::name(), and m::Schema::num_entries().

bulkload()

virtual void m::idx::IndexBase::bulkload ( const Table &  table, const Schema &  key_schema  )

pure virtual

Bulkloads the index by executing a query on table using key_schema.

Implemented in m::idx::ArrayIndex< Key >.

dump() [1/2]

virtual void m::idx::IndexBase::dump ( ) const

pure virtual

Implemented in m::idx::ArrayIndex< Key >, and m::idx::RecursiveModelIndex< Key >.

dump() [2/2]

virtual void m::idx::IndexBase::dump ( std::ostream &  out ) const

pure virtual

Implemented in m::idx::ArrayIndex< Key >, and m::idx::RecursiveModelIndex< Key >.

method()

virtual IndexMethod m::idx::IndexBase::method ( ) const

pure virtual

Returns the IndexMethod of the index.

Implemented in m::idx::ArrayIndex< Key >, and m::idx::RecursiveModelIndex< Key >.

num_entries()

virtual std::size_t m::idx::IndexBase::num_entries ( ) const

pure virtual

Implemented in m::idx::ArrayIndex< Key >.

---

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

• include/mutable/storage/Index.hpp
• src/storage/Index.cpp