lbug::main::ClientContext Class Reference

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

#include <client_context.h>

Classes
struct	QueryConfig
struct	TransactionHelper

Public Member Functions
	ClientContext (Database *database)
	~ClientContext ()
const ClientConfig *	getClientConfig () const
ClientConfig *	getClientConfigUnsafe ()
const DBConfig *	getDBConfig () const
DBConfig *	getDBConfigUnsafe () const
common::Value	getCurrentSetting (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
void	addScanReplace (function::ScanReplacement scanReplacement)
std::unique_ptr< function::ScanReplacementData >	tryReplaceByName (const std::string &objectName) const
std::unique_ptr< function::ScanReplacementData >	tryReplaceByHandle (function::scan_replace_handle_t handle) const
void	setExtensionOption (std::string name, common::Value value)
const ExtensionOption *	getExtensionOption (std::string optionName) const
std::string	getExtensionDir () const
std::string	getDatabasePath () const
Database *	getDatabase () const
AttachedLbugDatabase *	getAttachedDatabase () const
const CachedPreparedStatementManager &	getCachedPreparedStatementManager () const
bool	isInMemory () const
void	setDefaultDatabase (AttachedLbugDatabase *defaultDatabase_)
bool	hasDefaultDatabase () const
void	setUseInternalCatalogEntry (bool useInternalCatalogEntry)
bool	useInternalCatalogEntry () const
void	addScalarFunction (std::string name, function::function_set definitions)
void	removeScalarFunction (const std::string &name)
void	cleanUp ()
std::unique_ptr< QueryResult >	query (std::string_view queryStatement, std::optional< uint64_t > queryID=std::nullopt, QueryConfig config={})
std::unique_ptr< PreparedStatement >	prepareWithParams (std::string_view query, std::unordered_map< std::string, std::unique_ptr< common::Value > > inputParams={})
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)

Static Public Member Functions
static std::string	getEnvVariable (const std::string &name)
static std::string	getUserHomeDir ()

Friends
class	Connection
class	EmbeddedShell
struct	SpillToDiskSetting
class	processor::ImportDB
class	processor::WarningContext
class	transaction::TransactionContext
class	common::RandomEngine
class	common::ProgressBar
class	graph::GraphEntrySet

Detailed Description

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

Constructor & Destructor Documentation

ClientContext()

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

explicit

~ClientContext()

lbug::main::ClientContext::~ClientContext

(

)

Member Function Documentation

addScalarFunction()

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

addScanReplace()

void lbug::main::ClientContext::addScanReplace

(

function::ScanReplacement

scanReplacement

)

cleanUp()

void lbug::main::ClientContext::cleanUp

(

)

executeWithParams()

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

getAttachedDatabase()

AttachedLbugDatabase * lbug::main::ClientContext::getAttachedDatabase

(

)

const

getCachedPreparedStatementManager()

const CachedPreparedStatementManager & lbug::main::ClientContext::getCachedPreparedStatementManager ( ) const

inline

getClientConfig()

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

inline

getClientConfigUnsafe()

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

inline

getCurrentSetting()

common::Value lbug::main::ClientContext::getCurrentSetting

(

const std::string &

optionName

)

const

getDatabase()

Database * lbug::main::ClientContext::getDatabase

(

)

const

getDatabasePath()

std::string lbug::main::ClientContext::getDatabasePath

(

)

const

getDBConfig()

const DBConfig * lbug::main::ClientContext::getDBConfig

(

)

const

getDBConfigUnsafe()

DBConfig * lbug::main::ClientContext::getDBConfigUnsafe

(

)

const

getEnvVariable()

std::string lbug::main::ClientContext::getEnvVariable ( const std::string & name )

static

getExtensionDir()

std::string lbug::main::ClientContext::getExtensionDir

(

)

const

getExtensionOption()

const ExtensionOption * lbug::main::ClientContext::getExtensionOption

(

std::string

optionName

)

const

getMaxNumThreadForExec()

uint64_t lbug::main::ClientContext::getMaxNumThreadForExec

(

)

const

getQueryTimeOut()

uint64_t lbug::main::ClientContext::getQueryTimeOut

(

)

const

getTimeoutRemainingInMS()

uint64_t lbug::main::ClientContext::getTimeoutRemainingInMS

(

)

const

getUserHomeDir()

std::string lbug::main::ClientContext::getUserHomeDir ( )

static

hasDefaultDatabase()

bool lbug::main::ClientContext::hasDefaultDatabase

(

)

const

hasTimeout()

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

inline

interrupt()

void lbug::main::ClientContext::interrupt ( )

inline

interrupted()

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

inline

isInMemory()

bool lbug::main::ClientContext::isInMemory

(

)

const

prepareWithParams()

std::unique_ptr< PreparedStatement > lbug::main::ClientContext::prepareWithParams	(	std::string_view	query,
		std::unordered_map< std::string, std::unique_ptr< common::Value > >	inputParams = {} )

query()

std::unique_ptr< QueryResult > lbug::main::ClientContext::query	(	std::string_view	queryStatement,
		std::optional< uint64_t >	queryID = std::nullopt,
		QueryConfig	config = {} )

removeScalarFunction()

void lbug::main::ClientContext::removeScalarFunction

(

const std::string &

name

)

resetActiveQuery()

void lbug::main::ClientContext::resetActiveQuery ( )

inline

setDefaultDatabase()

void lbug::main::ClientContext::setDefaultDatabase

(

AttachedLbugDatabase *

defaultDatabase_

)

setExtensionOption()

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

setMaxNumThreadForExec()

void lbug::main::ClientContext::setMaxNumThreadForExec

(

uint64_t

numThreads

)

setQueryTimeOut()

void lbug::main::ClientContext::setQueryTimeOut

(

uint64_t

timeoutInMS

)

setUseInternalCatalogEntry()

void lbug::main::ClientContext::setUseInternalCatalogEntry ( bool useInternalCatalogEntry )

inline

startTimer()

void lbug::main::ClientContext::startTimer

(

)

tryReplaceByHandle()

std::unique_ptr< function::ScanReplacementData > lbug::main::ClientContext::tryReplaceByHandle

(

function::scan_replace_handle_t

handle

)

const

tryReplaceByName()

std::unique_ptr< function::ScanReplacementData > lbug::main::ClientContext::tryReplaceByName

(

const std::string &

objectName

)

const

useInternalCatalogEntry()

bool lbug::main::ClientContext::useInternalCatalogEntry ( ) const

inline

Friends And Related Symbol Documentation

common::ProgressBar

friend class common::ProgressBar

friend

common::RandomEngine

friend class common::RandomEngine

friend

Connection

friend class Connection

friend

EmbeddedShell

friend class EmbeddedShell

friend

graph::GraphEntrySet

friend class graph::GraphEntrySet

friend

processor::ImportDB

friend class processor::ImportDB

friend

processor::WarningContext

friend class processor::WarningContext

friend

SpillToDiskSetting

friend struct SpillToDiskSetting

friend

transaction::TransactionContext

friend class transaction::TransactionContext

friend

---

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

• headers/client_context.h