#include <catalog.h>

Public Member Functions
	Catalog ()
	creates an empty Catalog (should only be one in the system)

	Catalog (std::string db_metadata_file)
	create a catalog from existing DB state stored in meta data file

	~Catalog ()
	Destroys the Catalog object.

FileId	addEntry (std::string name, Schema schema, File file, SearchKeyFormat *key_format, CatType type, FileId relation, std::string file_name, bool to_save=true)
	Adds an entry to the catalog with a defined schema. May be called to create an entry for an index or relation as the SwatDB instance runs, or may be called as a SwatDB instance is booted from a saved state.

void	deleteEntry (FileId file_id)
	Deletes an entry from the database.

void	printCatInfo ()
	prints out all files in the catalog and its type, then prints out the relation file associated with it if its an index, or a list of indexes if its a relation.

std::uint32_t	getNumValid ()
	Returns the number of valid entries in the catalog.

std::string	getFileName (FileId file_id)
	Returns the filename associated with the given FileId.

FileId	getFileId (std::string name)
	Returns the FileId associated with the File identified by the given relation name.

FileId	getRelationFileId (FileId file_id)
	Returns the FileId for the relation file associated with the given index file id.

File *	getFile (FileId file_id)
	Returns the File object associated with the given FileId.

Schema *	getSchema (FileId file_id)
	Returns the schema of the requested file.

CatType	getType (FileId file_id)
	Returns the type of the requested file.

std::vector< FileId >	getFileIds ()
	Gets the set of valid FileIDs in the system.

void	setSave (bool save_on_exit, std::string rel_name)
	Setter method for the boolean save_on_exit.

void	setRelName (std::string old_rel_name, std::string new_rel_name)
	Setter method for the relation name and file name of a relation. Note that both the rel_name and the name of the file on disk will be changed.

Protected Member Functions
void	_setFile (FileId file_id, File *file_ptr)
	Set the File * field of a Catalog entry.

void	_saveDBStateToFile (std::string db_metadata_filename)
	Valled by SwatDB on shutdown to save DB meta data state to a file.

Private Attributes
std::unordered_map< std::string, FileId >	relations

std::vector< CatalogEntry >	entries

FileId	next_fid

std::uint32_t	num_valid_entries

std::mutex	cat_mux

Friends
class	SwatDB

class	FileManager

Detailed Description

SwatDB Catalog Class: defines the interface to the part of SwatDB that keeps track of information about Relations and Indices in the system. High-level layers may add index and relation entries, and examine their schema for query processing. Low level layers may access some internal information about a Relation or Index through methods provided by the Catalog class. A Relation and Index is uniquely identified in the system by its FileId value.

The Catalog class is the only one that needs to know the format of a saved DB metadata file. It is the class that reads and parses the DB metadata as part of initing the SwatDB state to an existing DB, and also the one that saves Catalog state to a DB metadata file on shutdown. The main SwatDB class controls invoking the Catalog class constructor to init the catalog from a saved DB metadata file or to init an empty Catalog on start-up. It also is the only class that can invoke the Catalog's _saveDBStateToFile method, which it may do on shutdown of the DB. Currently, the metadata file format is the following (NOTE: TODO missing is representation of entries schema in metadata): num_entries 1st entry's Relation or Index name (string) 1st entry's File or Relation Type (int (its CatType value)) 1st entry's Disk file name (string) 2nd entry's Relation of Index name (string) ... FileIds are unique for a full execution of SwatDB regardless of if relations and indices are created or deleted at runtime. They do not persist across two separate boots of SwatDB.

Constructor & Destructor Documentation

◆ Catalog()

Catalog::Catalog ( std::string db_metadata_file )

create a catalog from existing DB state stored in meta data file

Parameters

db_metadata_file file containing metadata information about the DB with which to initialize the Catalog

◆ ~Catalog()

Catalog::~Catalog ( )

Destroys the Catalog object.

NOTE: The destructor does not determine whether the state of the SwatDB should be saved or not in the current implementation.

Member Function Documentation

◆ _saveDBStateToFile()

void Catalog::_saveDBStateToFile ( std::string db_metadata_filename )

protected

Valled by SwatDB on shutdown to save DB meta data state to a file.

Parameters

db_metadta_filename: name of file to save DB state to

◆ _setFile()

void Catalog::_setFile	(	FileId	file_id,
		File *	file_ptr
	)

protected

Set the File * field of a Catalog entry.

This is called by the FileManager constructor when SwatDB is booted and inited from exising db state.

Precondition: file_id is a valid FileId and its Catalog entry has a nullptr value for its file field.

Postcondition: The file field of the Catalog entry for file_id is set to file_ptr

Parameters

file_id	A valid FileId.
file_ptr	A pointer to a valid File object

Exceptions

InvalidFileIdCat	if the FileId is not valid.
FileAlreadyExistCat	if the file entry already has a valid File *

◆ addEntry()

FileId Catalog::addEntry	(	std::string	name,
		Schema *	schema,
		File *	file,
		SearchKeyFormat *	key_format,
		CatType	type,
		FileId	relation,
		std::string	file_name,
		bool	to_save = `true`
	)

Adds an entry to the catalog with a defined schema. May be called to create an entry for an index or relation as the SwatDB instance runs, or may be called as a SwatDB instance is booted from a saved state.

Precondition: An entry with matching name, type and file_name does not already exist in the system.

Postcondition: A new file or index has been added to the system, the passed File object's file_id field is set by this method since a file's id is determined by adding an entry for it to the Catalog.

Parameters

name	The name of the relation.
schema	The schema object assciated with the relation (may be null).
file	A pointer to the File object associated with the relation/index (may be null).
type	The type of entry (index or relation).
relation	The FileId of the relation if entry created is index.
file_name	The name of the file into which the DiskManager stores the relation.
to_save	boolean indicator of whether or not the new catalog entry upon shutdown of SwatDB. Default to false.

Returns: FileID of the added entry.

Exceptions

FileAlreadyExistCat	if the file_name already exists in the database.
RelationAlreadyExistCat	if a relation named name already exists in the databse.
IndexAlreadyExistsCat	if an index named name already exists in the database.

◆ deleteEntry()

void Catalog::deleteEntry ( FileId file_id )

Deletes an entry from the database.

Precondition: A valid FileId is provided as input.

Postcondition: The relation or index identified by the given FileId is removed from the database, along with all other stored data associated with it.

Parameters

file_id The FileID of the file/index to remove from the database.

Exceptions

InvalidFileIdCat if the FileId is not valid.

◆ getFile()

File * Catalog::getFile ( FileId file_id )

Returns the File object associated with the given FileId.

Precondition: The given FileId is valid.

Postcondition: The File object associated with the given FileId in the system is returned.

Parameters

file_id A FileId.

Returns: File object associated with the given FileId.

Exceptions

InvalidFileIdCat if the given FileId is not valid.

◆ getFileId()

FileId Catalog::getFileId ( std::string name )

Returns the FileId associated with the File identified by the given relation name.

Precondition: A Relation File identified by the given name exists in the SwatDB system.

Postcondition: FileId of the File identified by the given relation name is is returned.

Parameters

file_id A FileId.

Returns: FileId of the File identified by the given relation name.

Exceptions

InvalidNameCat if the given name is not valid.

◆ getFileIds()

std::vector< FileId > Catalog::getFileIds ( )

Gets the set of valid FileIDs in the system.

Returns: std::vector<FileId> vector of FileIDs in the system. The vector is empty if there are no files in the database.

◆ getFileName()

std::string Catalog::getFileName ( FileId file_id )

Returns the filename associated with the given FileId.

Precondition: The given FileId is valid.

Postcondition: The filename associated with the given FileId in the system is returned.

Parameters

file_id A FileId.

Returns: std::string of the file name associated with the given FileId.

Exceptions

InvalidFileIdCat if the given FileId is not valid.

◆ getRelationFileId()

FileId Catalog::getRelationFileId ( FileId file_id )

Returns the FileId for the relation file associated with the given index file id.

Parameters

file_id. FileId of an index.

Returns: FileId of the relation file associated with the given index.

Exceptions

InvalidFileIdCat if the given FileId is not valid or if it is the FileId of a relation file.

◆ getSchema()

Schema * Catalog::getSchema ( FileId file_id )

Returns the schema of the requested file.

Precondition: A valid FileId is provided as input.

Postcondition: The schema pointer of the requested file is returned. (note: this points to the same Schema object as in the catalog—it is not a copy).

Parameters

file_id A valid FileId.

Returns: Schema* associated with the file identified by the given FileId.

Exceptions

InvalidFileIdCat if the FileId is not valid.

◆ getType()

CatType Catalog::getType ( FileId file_id )

Returns the type of the requested file.

Precondition: A valid FileId is provided as input.

Postcondition: The type of the file with this FileId is returned.

Parameters

file_id A valid FileId.

Returns: CatType value of file identified by the given FileId.

Exceptions

InvalidFileIdCat if the FileId is not valid.

◆ setRelName()

void Catalog::setRelName	(	std::string	old_rel_name,
		std::string	new_rel_name
	)

Setter method for the relation name and file name of a relation. Note that both the rel_name and the name of the file on disk will be changed.

Parameters

old_rel_name.	Relation name currently being used.
new_rel_name.	Relation name to set.

◆ setSave()

void Catalog::setSave	(	bool	save_on_exit,
		std::string	rel_name
	)

Setter method for the boolean save_on_exit.

Parameters

save_on_exit.	bool to set save_on_exit to of the catalog entry associated with the rel_name. if true the catalog will save the file to disk when the program exits.
rel_name.	std::string of the relation to change save_on_exit.

Member Data Documentation

◆ cat_mux

std::mutex Catalog::cat_mux

private

Mutex object to control access to the table of catalog entries.

◆ entries

std::vector<CatalogEntry> Catalog::entries

private

The set of entries, one for each relation and index in the database.

◆ next_fid

FileId Catalog::next_fid

private

FileIds increase as SwatDB adds entries. Deleting an entry sets its valid and allocated fields to false. The FileId of invalid files remain in the vector of CatalogEntry and can be re-used by new file or index adds as swatdb runs. If there are no invalid existing entries, a new one is added to the Catalog with a FileID value of next_fid, and next_fid is incremented..

◆ num_valid_entries

std::uint32_t Catalog::num_valid_entries

private

The number of valid entries in the catalog. Because the Catalog vector never shrinks, when a file is deleted, its Catalog entry becomes invalid but stays in the vector. Thus the vector size is not a count of the number of valid entries, and we keep this as separate state in num_valid_entries.

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

catalog.h

Public Member Functions

Protected Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ Catalog()

◆ ~Catalog()

Member Function Documentation

◆ _saveDBStateToFile()

◆ _setFile()

◆ addEntry()

◆ deleteEntry()

◆ getFile()

◆ getFileId()

◆ getFileIds()

◆ getFileName()

◆ getRelationFileId()

◆ getSchema()

◆ getType()

◆ setRelName()

◆ setSave()

Member Data Documentation

◆ cat_mux

◆ entries

◆ next_fid

◆ num_valid_entries