IndexManager Class Reference

Manage index files. More...

#include <Index.h>

Public Member Functions
	IndexManager (BufferManager *bfm)
void	CreateIndex (const std::string &indexName)
	Create an Index of an attr. Actually creates an has_index file with a head block. File name convention: ${INDEX_PATH}/{table name}_{attribute name}. More...
void	DropIndex (const std::string &indexName)
	Drop an Index of an attr. User should make sure the table exists. More...
void	UpdateId (const std::string &indexName, const Data &key, const Index_t &new_rec_ptr)
	Update the pointer of a record in the has_index file. More...
void	UpdateKey (const std::string &indexName, const Data &key, const Data &new_key)
void	DeleteId (const std::string &indexName, const Data &key)
	Delete an has_index of a certain key. More...
bool	CheckExistance (const std::string &indexName, const Data &key, Index_t &id)
bool	FindId (const std::string &indexName, const Data &key, Index_t &result)
	Find the Index based on the key (cell) More...
bool	FindId (const std::string &indexName, const Data &lower_key, const Data &upper_key, std::vector< Index_t > &result)
	Find the Indexes based on given key range. Return the indexes in between. If the key exists in the tree, the key is returned as well. More...
void	InsertId (const std::string &indexName, const Data &Key, const Index_t &rec_ptr)
	Insert a key into the has_index table The user should make sure that the file exists. Or he should use TRY! More...

Detailed Description

Manage index files.

Definition at line 15 of file Index.h.

Member Function Documentation

CreateIndex()

void IndexManager::CreateIndex

(

const std::string &

indexName

)

Create an Index of an attr. Actually creates an has_index file with a head block. File name convention: ${INDEX_PATH}/{table name}_{attribute name}.

Parameters

indexName

the name of has_index as a string.

Exceptions

DB_FILE_NOT_FOUND

Definition at line 8 of file index.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

DeleteId()

void IndexManager::DeleteId	(	const std::string &	indexName,
		const Data &	key
	)

Delete an has_index of a certain key.

Parameters

tableName	the name of table (file) as a string.
key	the key that user wish to delete

Exceptions

DB_KEY_NOT_FOUND

Definition at line 85 of file index.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

DropIndex()

void IndexManager::DropIndex

(

const std::string &

indexName

)

Drop an Index of an attr. User should make sure the table exists.

Parameters

tableName
attr

Exceptions

DB_FILE_NOT_FOUND

Definition at line 21 of file index.cpp.

Here is the caller graph for this function:

FindId() [1/2]

bool IndexManager::FindId	(	const std::string &	indexName,
		const Data &	key,
		Index_t &	result
	)

Find the Index based on the key (cell)

Parameters

indexName	name of the index
key[in]	The cell to search for, as a key.
result[out]	The container for result

Exceptions

DB_KEY_NOT_FOUND

Returns

true if the key actually exists in the tree.

Definition at line 69 of file index.cpp.

Here is the call graph for this function:

FindId() [2/2]

bool IndexManager::FindId	(	const std::string &	indexName,
		const Data &	lower_key,
		const Data &	upper_key,
		std::vector< Index_t > &	result
	)

Find the Indexes based on given key range. Return the indexes in between. If the key exists in the tree, the key is returned as well.

Parameters

indexName	Name of the index
lower_key	Smaller key.
upper_key	Greater key.
result	[out] Search result

Returns

Definition at line 77 of file index.cpp.

Here is the call graph for this function:

InsertId()

void IndexManager::InsertId	(	const std::string &	indexName,
		const Data &	Key,
		const Index_t &	rec_ptr
	)

Insert a key into the has_index table The user should make sure that the file exists. Or he should use TRY!

Parameters

tableName
attr[in]	the attribute of the Key that user wish to insert on
key	The key of the cell. Here simply insert the value of the cell itself.
rec_ptr	record pointer. The protocal has_index of a sinlge record.

Exceptions

DB_KEY_NOT_FOUND

Definition at line 26 of file index.cpp.

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateId()

void IndexManager::UpdateId	(	const std::string &	indexName,
		const Data &	key,
		const Index_t &	new_rec_ptr
	)

Update the pointer of a record in the has_index file.

Parameters

indexName	Name of has_index.
key	Key of the record.
rec_ptr	Pointer of the record.

Exceptions

DB_KEY_NOT_FOUND

If key doesn't exist

Definition at line 35 of file index.cpp.

Here is the call graph for this function:

---

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

• src/include/index/Index.h
• src/index/index.cpp