Kùzu C++ API
Loading...
Searching...
No Matches
kuzu::main::Database Class Reference

Database class is the main class of KùzuDB. 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.
 
void addTableFunction (std::string name, std::vector< std::unique_ptr< function::Function > > functionSet)
 
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)
 
KUZU_API catalog::Catalog * getCatalog ()
 
ExtensionOptiongetExtensionOption (std::string name) const
 
const DBConfiggetConfig () const
 
common::case_insensitive_map_t< std::unique_ptr< 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 KùzuDB. 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
databasePathDatabase path. If left empty, or :memory: is specified, this will create an in-memory database.
systemConfigSystem configurations (buffer pool size and max num threads).

◆ ~Database()

KUZU_API kuzu::main::Database::~Database ( )

Destructs the database object.

Member Function Documentation

◆ addExtensionOption()

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

◆ addTableFunction()

void kuzu::main::Database::addTableFunction ( std::string name,
std::vector< std::unique_ptr< function::Function > > functionSet )

◆ getCatalog()

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

◆ getConfig()

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

◆ getExtensionOption()

ExtensionOption * kuzu::main::Database::getExtensionOption ( std::string name) const

◆ getNextQueryID()

uint64_t kuzu::main::Database::getNextQueryID ( )

◆ getStorageExtensions()

common::case_insensitive_map_t< std::unique_ptr< storage::StorageExtension > > & kuzu::main::Database::getStorageExtensions ( )

◆ 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: