kuzu::main::Database Class Reference

Database class is the main class of Kuzu. It manages all database components. More...

#include <database.h>

Public Member Functions
KUZU_API	Database (std::string_view databasePath, SystemConfig systemConfig=SystemConfig())
	Creates a database object.
KUZU_API	~Database ()
	Destructs the database object.
KUZU_API void	registerFileSystem (std::unique_ptr< common::FileSystem > fs)
KUZU_API void	registerStorageExtension (std::string name, std::unique_ptr< storage::StorageExtension > storageExtension)
KUZU_API void	addExtensionOption (std::string name, common::LogicalTypeID type, common::Value defaultValue, bool isConfidential=false)
KUZU_API void	addTransformerExtension (std::unique_ptr< extension::TransformerExtension > transformerExtension)
std::vector< extension::TransformerExtension * >	getTransformerExtensions ()
KUZU_API void	addBinderExtension (std::unique_ptr< extension::BinderExtension > transformerExtension)
std::vector< extension::BinderExtension * >	getBinderExtensions ()
KUZU_API void	addPlannerExtension (std::unique_ptr< extension::PlannerExtension > plannerExtension)
std::vector< extension::PlannerExtension * >	getPlannerExtensions ()
KUZU_API void	addMapperExtension (std::unique_ptr< extension::MapperExtension > mapperExtension)
std::vector< extension::MapperExtension * >	getMapperExtensions ()
KUZU_API catalog::Catalog *	getCatalog ()
const DBConfig &	getConfig () const
std::vector< storage::StorageExtension * >	getStorageExtensions ()
uint64_t	getNextQueryID ()

Friends
class	EmbeddedShell
class	ClientContext
class	Connection
class	StorageDriver
class	testing::BaseGraphTest
class	testing::PrivateGraphTest
class	transaction::TransactionContext
struct	extension::ExtensionUtils

Detailed Description

Database class is the main class of Kuzu. It manages all database components.

Constructor & Destructor Documentation

Database()

KUZU_API kuzu::main::Database::Database ( std::string_view databasePath, SystemConfig systemConfig = SystemConfig() )

explicit

Creates a database object.

Parameters

databasePath	Database path. If left empty, or :memory: is specified, this will create an in-memory database.
systemConfig	System configurations (buffer pool size and max num threads).

~Database()

KUZU_API kuzu::main::Database::~Database

(

)

Destructs the database object.

Member Function Documentation

addBinderExtension()

KUZU_API void kuzu::main::Database::addBinderExtension

(

std::unique_ptr< extension::BinderExtension >

transformerExtension

)

addExtensionOption()

KUZU_API void kuzu::main::Database::addExtensionOption	(	std::string	name,
		common::LogicalTypeID	type,
		common::Value	defaultValue,
		bool	isConfidential = false )

addMapperExtension()

KUZU_API void kuzu::main::Database::addMapperExtension

(

std::unique_ptr< extension::MapperExtension >

mapperExtension

)

addPlannerExtension()

KUZU_API void kuzu::main::Database::addPlannerExtension

(

std::unique_ptr< extension::PlannerExtension >

plannerExtension

)

addTransformerExtension()

KUZU_API void kuzu::main::Database::addTransformerExtension

(

std::unique_ptr< extension::TransformerExtension >

transformerExtension

)

getBinderExtensions()

std::vector< extension::BinderExtension * > kuzu::main::Database::getBinderExtensions

(

)

getCatalog()

KUZU_API catalog::Catalog * kuzu::main::Database::getCatalog ( )

inline

getConfig()

const DBConfig & kuzu::main::Database::getConfig ( ) const

inline

getMapperExtensions()

std::vector< extension::MapperExtension * > kuzu::main::Database::getMapperExtensions

(

)

getNextQueryID()

uint64_t kuzu::main::Database::getNextQueryID

(

)

getPlannerExtensions()

std::vector< extension::PlannerExtension * > kuzu::main::Database::getPlannerExtensions

(

)

getStorageExtensions()

std::vector< storage::StorageExtension * > kuzu::main::Database::getStorageExtensions

(

)

getTransformerExtensions()

std::vector< extension::TransformerExtension * > kuzu::main::Database::getTransformerExtensions

(

)

registerFileSystem()

KUZU_API void kuzu::main::Database::registerFileSystem

(

std::unique_ptr< common::FileSystem >

fs

)

registerStorageExtension()

KUZU_API void kuzu::main::Database::registerStorageExtension	(	std::string	name,
		std::unique_ptr< storage::StorageExtension >	storageExtension )

Friends And Related Symbol Documentation

ClientContext

friend class ClientContext

friend

Connection

friend class Connection

friend

EmbeddedShell

friend class EmbeddedShell

friend

extension::ExtensionUtils

friend struct extension::ExtensionUtils

friend

StorageDriver

friend class StorageDriver

friend

testing::BaseGraphTest

friend class testing::BaseGraphTest

friend

testing::PrivateGraphTest

friend class testing::PrivateGraphTest

friend

transaction::TransactionContext

friend class transaction::TransactionContext

friend

---

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

• headers/database.h