kuzu::main::ClientContext Class Reference

Contain client side configuration. We make profiler associated per query, so profiler is not maintained in client context. More...

#include <client_context.h>

Public Member Functions
	ClientContext (Database *database)
	~ClientContext ()
const ClientConfig *	getClientConfig () const
ClientConfig *	getClientConfigUnsafe ()
const DBConfig *	getDBConfig () const
DBConfig *	getDBConfigUnsafe ()
common::Value	getCurrentSetting (const std::string &optionName)
bool	isOptionSet (const std::string &optionName) const
void	interrupt ()
bool	interrupted () const
bool	hasTimeout () const
void	setQueryTimeOut (uint64_t timeoutInMS)
uint64_t	getQueryTimeOut () const
void	startTimer ()
uint64_t	getTimeoutRemainingInMS () const
void	resetActiveQuery ()
void	setMaxNumThreadForExec (uint64_t numThreads)
uint64_t	getMaxNumThreadForExec () const
transaction::Transaction *	getTx () const
transaction::TransactionContext *	getTransactionContext () const
common::ProgressBar *	getProgressBar () const
void	addScanReplace (function::ScanReplacement scanReplacement)
std::unique_ptr< function::ScanReplacementData >	tryReplace (const std::string &objectName) const
void	setExtensionOption (std::string name, common::Value value)
extension::ExtensionOptions *	getExtensionOptions () const
std::string	getExtensionDir () const
std::string	getEnvVariable (const std::string &name)
std::string	getDatabasePath () const
Database *	getDatabase () const
common::TaskScheduler *	getTaskScheduler () const
DatabaseManager *	getDatabaseManager () const
storage::StorageManager *	getStorageManager () const
storage::MemoryManager *	getMemoryManager ()
storage::WAL *	getWAL () const
catalog::Catalog *	getCatalog () const
transaction::TransactionManager *	getTransactionManagerUnsafe () const
common::VirtualFileSystem *	getVFSUnsafe () const
common::RandomEngine *	getRandomEngine ()
std::unique_ptr< PreparedStatement >	prepare (std::string_view query)
std::unique_ptr< QueryResult >	executeWithParams (PreparedStatement *preparedStatement, std::unordered_map< std::string, std::unique_ptr< common::Value > > inputParams, std::optional< uint64_t > queryID=std::nullopt)
std::unique_ptr< QueryResult >	query (std::string_view queryStatement, std::optional< uint64_t > queryID=std::nullopt)
std::vector< std::shared_ptr< parser::Statement > >	parseQuery (std::string_view query)
void	setDefaultDatabase (AttachedKuzuDatabase *defaultDatabase_)
bool	hasDefaultDatabase ()
void	addScalarFunction (std::string name, function::function_set definitions)
void	removeScalarFunction (std::string name)
processor::WarningContext &	getWarningContextUnsafe ()
const processor::WarningContext &	getWarningContext () const
graph::GraphEntrySet &	getGraphEntrySetUnsafe ()
void	cleanUP ()
std::unique_ptr< QueryResult >	queryInternal (std::string_view query, std::string_view encodedJoin, bool enumerateAllPlans=true, std::optional< uint64_t > queryID=std::nullopt)

Friends
class	Connection
class	binder::Binder
class	binder::ExpressionBinder
class	processor::ImportDB
struct	main::SpillToDiskSetting

Detailed Description

Contain client side configuration. We make profiler associated per query, so profiler is not maintained in client context.

Constructor & Destructor Documentation

ClientContext()

kuzu::main::ClientContext::ClientContext ( Database * database )

explicit

~ClientContext()

kuzu::main::ClientContext::~ClientContext

(

)

Member Function Documentation

addScalarFunction()

void kuzu::main::ClientContext::addScalarFunction	(	std::string	name,
		function::function_set	definitions )

addScanReplace()

void kuzu::main::ClientContext::addScanReplace

(

function::ScanReplacement

scanReplacement

)

cleanUP()

void kuzu::main::ClientContext::cleanUP

(

)

executeWithParams()

std::unique_ptr< QueryResult > kuzu::main::ClientContext::executeWithParams	(	PreparedStatement *	preparedStatement,
		std::unordered_map< std::string, std::unique_ptr< common::Value > >	inputParams,
		std::optional< uint64_t >	queryID = std::nullopt )

getCatalog()

catalog::Catalog * kuzu::main::ClientContext::getCatalog

(

)

const

getClientConfig()

const ClientConfig * kuzu::main::ClientContext::getClientConfig ( ) const

inline

getClientConfigUnsafe()

ClientConfig * kuzu::main::ClientContext::getClientConfigUnsafe ( )

inline

getCurrentSetting()

common::Value kuzu::main::ClientContext::getCurrentSetting

(

const std::string &

optionName

)

getDatabase()

Database * kuzu::main::ClientContext::getDatabase ( ) const

inline

getDatabaseManager()

DatabaseManager * kuzu::main::ClientContext::getDatabaseManager

(

)

const

getDatabasePath()

std::string kuzu::main::ClientContext::getDatabasePath

(

)

const

getDBConfig()

const DBConfig * kuzu::main::ClientContext::getDBConfig ( ) const

inline

getDBConfigUnsafe()

DBConfig * kuzu::main::ClientContext::getDBConfigUnsafe ( )

inline

getEnvVariable()

std::string kuzu::main::ClientContext::getEnvVariable

(

const std::string &

name

)

getExtensionDir()

std::string kuzu::main::ClientContext::getExtensionDir

(

)

const

getExtensionOptions()

extension::ExtensionOptions * kuzu::main::ClientContext::getExtensionOptions

(

)

const

getGraphEntrySetUnsafe()

graph::GraphEntrySet & kuzu::main::ClientContext::getGraphEntrySetUnsafe

(

)

getMaxNumThreadForExec()

uint64_t kuzu::main::ClientContext::getMaxNumThreadForExec

(

)

const

getMemoryManager()

storage::MemoryManager * kuzu::main::ClientContext::getMemoryManager

(

)

getProgressBar()

common::ProgressBar * kuzu::main::ClientContext::getProgressBar

(

)

const

getQueryTimeOut()

uint64_t kuzu::main::ClientContext::getQueryTimeOut

(

)

const

getRandomEngine()

common::RandomEngine * kuzu::main::ClientContext::getRandomEngine

(

)

getStorageManager()

storage::StorageManager * kuzu::main::ClientContext::getStorageManager

(

)

const

getTaskScheduler()

common::TaskScheduler * kuzu::main::ClientContext::getTaskScheduler

(

)

const

getTimeoutRemainingInMS()

uint64_t kuzu::main::ClientContext::getTimeoutRemainingInMS

(

)

const

getTransactionContext()

transaction::TransactionContext * kuzu::main::ClientContext::getTransactionContext

(

)

const

getTransactionManagerUnsafe()

transaction::TransactionManager * kuzu::main::ClientContext::getTransactionManagerUnsafe

(

)

const

getTx()

transaction::Transaction * kuzu::main::ClientContext::getTx

(

)

const

getVFSUnsafe()

common::VirtualFileSystem * kuzu::main::ClientContext::getVFSUnsafe

(

)

const

getWAL()

storage::WAL * kuzu::main::ClientContext::getWAL

(

)

const

getWarningContext()

const processor::WarningContext & kuzu::main::ClientContext::getWarningContext

(

)

const

getWarningContextUnsafe()

processor::WarningContext & kuzu::main::ClientContext::getWarningContextUnsafe

(

)

hasDefaultDatabase()

bool kuzu::main::ClientContext::hasDefaultDatabase

(

)

hasTimeout()

bool kuzu::main::ClientContext::hasTimeout ( ) const

inline

interrupt()

void kuzu::main::ClientContext::interrupt ( )

inline

interrupted()

bool kuzu::main::ClientContext::interrupted ( ) const

inline

isOptionSet()

bool kuzu::main::ClientContext::isOptionSet

(

const std::string &

optionName

)

const

parseQuery()

std::vector< std::shared_ptr< parser::Statement > > kuzu::main::ClientContext::parseQuery

(

std::string_view

query

)

prepare()

std::unique_ptr< PreparedStatement > kuzu::main::ClientContext::prepare

(

std::string_view

query

)

query()

std::unique_ptr< QueryResult > kuzu::main::ClientContext::query	(	std::string_view	queryStatement,
		std::optional< uint64_t >	queryID = std::nullopt )

queryInternal()

std::unique_ptr< QueryResult > kuzu::main::ClientContext::queryInternal	(	std::string_view	query,
		std::string_view	encodedJoin,
		bool	enumerateAllPlans = true,
		std::optional< uint64_t >	queryID = std::nullopt )

removeScalarFunction()

void kuzu::main::ClientContext::removeScalarFunction

(

std::string

name

)

resetActiveQuery()

void kuzu::main::ClientContext::resetActiveQuery ( )

inline

setDefaultDatabase()

void kuzu::main::ClientContext::setDefaultDatabase

(

AttachedKuzuDatabase *

defaultDatabase_

)

setExtensionOption()

void kuzu::main::ClientContext::setExtensionOption	(	std::string	name,
		common::Value	value )

setMaxNumThreadForExec()

void kuzu::main::ClientContext::setMaxNumThreadForExec

(

uint64_t

numThreads

)

setQueryTimeOut()

void kuzu::main::ClientContext::setQueryTimeOut

(

uint64_t

timeoutInMS

)

startTimer()

void kuzu::main::ClientContext::startTimer

(

)

tryReplace()

std::unique_ptr< function::ScanReplacementData > kuzu::main::ClientContext::tryReplace

(

const std::string &

objectName

)

const

Friends And Related Symbol Documentation

binder::Binder

friend class binder::Binder

friend

binder::ExpressionBinder

friend class binder::ExpressionBinder

friend

Connection

friend class Connection

friend

main::SpillToDiskSetting

friend struct main::SpillToDiskSetting

friend

processor::ImportDB

friend class processor::ImportDB

friend

---

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

• headers/client_context.h