kuzu::catalog::TableCatalogEntry Class Reference

#include <table_catalog_entry.h>

Inheritance diagram for kuzu::catalog::TableCatalogEntry:

Public Member Functions
	TableCatalogEntry ()=default
	TableCatalogEntry (CatalogSet *set, CatalogEntryType catalogType, std::string name, common::table_id_t tableID)
TableCatalogEntry &	operator= (const TableCatalogEntry &)=delete
std::unique_ptr< TableCatalogEntry >	alter (const binder::BoundAlterInfo &alterInfo)
common::table_id_t	getTableID () const
std::string	getComment () const
void	setComment (std::string newComment)
virtual bool	isParent (common::table_id_t)
virtual common::TableType	getTableType () const =0
virtual function::TableFunction	getScanFunction ()
binder::BoundAlterInfo *	getAlterInfo () const
void	resetAlterInfo ()
void	setAlterInfo (const binder::BoundAlterInfo &alterInfo_)
uint32_t	getNumProperties () const
const std::vector< Property > &	getPropertiesRef () const
std::vector< Property > &	getPropertiesUnsafe ()
bool	containProperty (const std::string &propertyName) const
common::property_id_t	getPropertyID (const std::string &propertyName) const
const Property *	getProperty (common::property_id_t propertyID) const
uint32_t	getPropertyPos (common::property_id_t propertyID) const
virtual common::column_id_t	getColumnID (common::property_id_t propertyID) const
void	addProperty (std::string propertyName, common::LogicalType dataType, std::unique_ptr< parser::ParsedExpression > defaultExpr)
void	dropProperty (common::property_id_t propertyID)
void	renameProperty (common::property_id_t propertyID, const std::string &newName)
void	resetColumnIDs ()
void	serialize (common::Serializer &serializer) const override
virtual std::unique_ptr< TableCatalogEntry >	copy () const =0
binder::BoundCreateTableInfo	getBoundCreateTableInfo (transaction::Transaction *transaction) const
Public Member Functions inherited from kuzu::catalog::CatalogEntry
	CatalogEntry ()=default
	CatalogEntry (CatalogEntryType type, std::string name)
	DELETE_COPY_DEFAULT_MOVE (CatalogEntry)
virtual	~CatalogEntry ()=default
CatalogEntryType	getType () const
void	rename (std::string name_)
std::string	getName () const
common::transaction_t	getTimestamp () const
void	setTimestamp (common::transaction_t timestamp_)
bool	isDeleted () const
void	setDeleted (bool deleted_)
bool	hasParent () const
void	setHasParent (bool hasParent)
CatalogEntry *	getPrev () const
std::unique_ptr< CatalogEntry >	movePrev ()
void	setPrev (std::unique_ptr< CatalogEntry > prev_)
CatalogEntry *	getNext () const
void	setNext (CatalogEntry *next_)
virtual std::string	toCypher (main::ClientContext *) const
template<class TARGET >
const TARGET &	constCast () const
template<class TARGET >
const TARGET *	constPtrCast () const
template<class TARGET >
TARGET *	ptrCast ()

Static Public Member Functions
static std::unique_ptr< TableCatalogEntry >	deserialize (common::Deserializer &deserializer, CatalogEntryType type)
Static Public Member Functions inherited from kuzu::catalog::CatalogEntry
static std::unique_ptr< CatalogEntry >	deserialize (common::Deserializer &deserializer)

Protected Member Functions
void	copyFrom (const CatalogEntry &other) override
virtual std::unique_ptr< binder::BoundExtraCreateCatalogEntryInfo >	getBoundExtraCreateInfo (transaction::Transaction *transaction) const =0
Protected Member Functions inherited from kuzu::catalog::CatalogEntry

Protected Attributes
CatalogSet *	set
common::table_id_t	tableID
std::string	comment
common::property_id_t	nextPID
common::column_id_t	nextColumnID
std::vector< Property >	properties
std::unique_ptr< binder::BoundAlterInfo >	alterInfo
Protected Attributes inherited from kuzu::catalog::CatalogEntry
CatalogEntryType	type
std::string	name
common::transaction_t	timestamp
bool	deleted = false
bool	hasParent_ = false
std::unique_ptr< CatalogEntry >	prev
CatalogEntry *	next = nullptr

Constructor & Destructor Documentation

TableCatalogEntry() [1/2]

kuzu::catalog::TableCatalogEntry::TableCatalogEntry ( )

default

TableCatalogEntry() [2/2]

kuzu::catalog::TableCatalogEntry::TableCatalogEntry ( CatalogSet * set, CatalogEntryType catalogType, std::string name, common::table_id_t tableID )

inline

Member Function Documentation

addProperty()

void kuzu::catalog::TableCatalogEntry::addProperty	(	std::string	propertyName,
		common::LogicalType	dataType,
		std::unique_ptr< parser::ParsedExpression >	defaultExpr )

alter()

std::unique_ptr< TableCatalogEntry > kuzu::catalog::TableCatalogEntry::alter

(

const binder::BoundAlterInfo &

alterInfo

)

containProperty()

bool kuzu::catalog::TableCatalogEntry::containProperty

(

const std::string &

propertyName

)

const

copy()

virtual std::unique_ptr< TableCatalogEntry > kuzu::catalog::TableCatalogEntry::copy ( ) const

pure virtual

copyFrom()

void kuzu::catalog::TableCatalogEntry::copyFrom ( const CatalogEntry & other )

overrideprotectedvirtual

Reimplemented from kuzu::catalog::CatalogEntry.

deserialize()

static std::unique_ptr< TableCatalogEntry > kuzu::catalog::TableCatalogEntry::deserialize ( common::Deserializer & deserializer, CatalogEntryType type )

static

dropProperty()

void kuzu::catalog::TableCatalogEntry::dropProperty

(

common::property_id_t

propertyID

)

getAlterInfo()

binder::BoundAlterInfo * kuzu::catalog::TableCatalogEntry::getAlterInfo ( ) const

inline

getBoundCreateTableInfo()

binder::BoundCreateTableInfo kuzu::catalog::TableCatalogEntry::getBoundCreateTableInfo

(

transaction::Transaction *

transaction

)

const

getBoundExtraCreateInfo()

virtual std::unique_ptr< binder::BoundExtraCreateCatalogEntryInfo > kuzu::catalog::TableCatalogEntry::getBoundExtraCreateInfo ( transaction::Transaction * transaction ) const

protectedpure virtual

getColumnID()

virtual common::column_id_t kuzu::catalog::TableCatalogEntry::getColumnID ( common::property_id_t propertyID ) const

virtual

getComment()

std::string kuzu::catalog::TableCatalogEntry::getComment ( ) const

inline

getNumProperties()

uint32_t kuzu::catalog::TableCatalogEntry::getNumProperties ( ) const

inline

getPropertiesRef()

const std::vector< Property > & kuzu::catalog::TableCatalogEntry::getPropertiesRef ( ) const

inline

getPropertiesUnsafe()

std::vector< Property > & kuzu::catalog::TableCatalogEntry::getPropertiesUnsafe ( )

inline

getProperty()

const Property * kuzu::catalog::TableCatalogEntry::getProperty

(

common::property_id_t

propertyID

)

const

getPropertyID()

common::property_id_t kuzu::catalog::TableCatalogEntry::getPropertyID

(

const std::string &

propertyName

)

const

getPropertyPos()

uint32_t kuzu::catalog::TableCatalogEntry::getPropertyPos

(

common::property_id_t

propertyID

)

const

getScanFunction()

virtual function::TableFunction kuzu::catalog::TableCatalogEntry::getScanFunction ( )

inlinevirtual

getTableID()

common::table_id_t kuzu::catalog::TableCatalogEntry::getTableID ( ) const

inline

getTableType()

virtual common::TableType kuzu::catalog::TableCatalogEntry::getTableType ( ) const

pure virtual

isParent()

virtual bool kuzu::catalog::TableCatalogEntry::isParent ( common::table_id_t )

inlinevirtual

operator=()

TableCatalogEntry & kuzu::catalog::TableCatalogEntry::operator= ( const TableCatalogEntry & )

delete

renameProperty()

void kuzu::catalog::TableCatalogEntry::renameProperty	(	common::property_id_t	propertyID,
		const std::string &	newName )

resetAlterInfo()

void kuzu::catalog::TableCatalogEntry::resetAlterInfo ( )

inline

resetColumnIDs()

void kuzu::catalog::TableCatalogEntry::resetColumnIDs

(

)

serialize()

void kuzu::catalog::TableCatalogEntry::serialize ( common::Serializer & serializer ) const

overridevirtual

Reimplemented from kuzu::catalog::CatalogEntry.

setAlterInfo()

void kuzu::catalog::TableCatalogEntry::setAlterInfo ( const binder::BoundAlterInfo & alterInfo_ )

inline

setComment()

void kuzu::catalog::TableCatalogEntry::setComment ( std::string newComment )

inline

Member Data Documentation

alterInfo

std::unique_ptr<binder::BoundAlterInfo> kuzu::catalog::TableCatalogEntry::alterInfo

protected

comment

std::string kuzu::catalog::TableCatalogEntry::comment

protected

nextColumnID

common::column_id_t kuzu::catalog::TableCatalogEntry::nextColumnID

protected

nextPID

common::property_id_t kuzu::catalog::TableCatalogEntry::nextPID

protected

properties

std::vector<Property> kuzu::catalog::TableCatalogEntry::properties

protected

set

CatalogSet* kuzu::catalog::TableCatalogEntry::set

protected

tableID

common::table_id_t kuzu::catalog::TableCatalogEntry::tableID

protected

---

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

• headers/table_catalog_entry.h