Collaboration diagram for duckdb::ClientConfig:

[legend]

Public Member Functions
bool	AnyVerification () const

void	SetUserVariable (const String &name, Value value)

bool	GetUserVariable (const string &name, Value &result)

void	ResetUserVariable (const String &name)

void	SetDefaultStreamingBufferSize ()

Static Public Member Functions
static ClientConfig &	GetConfig (ClientContext &context)

static const ClientConfig &	GetConfig (const ClientContext &context)

Public Attributes
bool	enable_profiler = false
	If the query profiler is enabled or not.

bool	enable_detailed_profiling = false
	If detailed query profiling is enabled.

ProfilerPrintFormat	profiler_print_format = ProfilerPrintFormat::QUERY_TREE
	The format to print query profiling information in (default: query_tree), if enabled.

string	profiler_save_location

profiler_settings_t	profiler_settings = MetricsUtils::GetDefaultMetrics()

LogicalTypeId	profiler_settings_type = LogicalTypeId::VARCHAR
	The input format type of the profiler settings.

bool	emit_profiler_output = true

const char *	system_progress_bar_disable_reason = nullptr
	system-wide progress bar disable.

bool	enable_progress_bar = false
	If the progress bar is enabled or not.

bool	print_progress_bar = true
	If the print of the progress bar is enabled.

int	wait_time = 2000
	The wait time before showing the progress bar.

bool	query_verification_enabled = false
	Whether or not aggressive query verification is enabled.

bool	verify_external = false
	Whether or not verification of external operators is enabled, used for testing.

bool	verify_fetch_row = false
	Whether or not verification of fetch row code is enabled, used for testing.

bool	verify_serializer = false
	Whether or not we should verify the serializer.

bool	enable_optimizer = true
	Enable the running of optimizers.

bool	enable_caching_operators = true
	Enable caching operators.

bool	verify_parallelism = false
	Force parallelism of small tables, used for testing.

bool	force_external = false
	Force out-of-core computation for operators that support it, used for testing.

bool	force_fetch_row = false
	Force use of fetch row instead of scan, used for testing.

bool	use_replacement_scans = true

idx_t	streaming_buffer_size = 1000000
	The maximum amount of memory to keep buffered in a streaming query result. Default: 1mb.

progress_bar_display_create_func_t	display_create_func = nullptr
	Callback to create a progress bar display.

ProfilingCoverage	profiling_coverage = ProfilingCoverage::SELECT

LocalUserSettings	user_settings
	Generic options.

case_insensitive_map_t< Value >	user_variables
	Variables set by the user.

get_result_collector_t	get_result_collector = nullptr
	Function that is used to create the result collector for a materialized result.

bool	enable_http_logging = true
	If HTTP logging is enabled or not.

string	http_logging_output

Member Data Documentation

◆ profiler_save_location

string duckdb::ClientConfig::profiler_save_location

The file to save query profiling information to, instead of printing it to the console (empty = print to console)

◆ profiler_settings

profiler_settings_t duckdb::ClientConfig::profiler_settings = MetricsUtils::GetDefaultMetrics()

The custom settings for the profiler (empty = use the default settings)

◆ emit_profiler_output

bool duckdb::ClientConfig::emit_profiler_output = true

Allows suppressing profiler output, even if enabled. We turn on the profiler on all test runs but don't want to output anything

◆ use_replacement_scans

bool duckdb::ClientConfig::use_replacement_scans = true

If this context should also try to use the available replacement scans True by default

◆ profiling_coverage

ProfilingCoverage duckdb::ClientConfig::profiling_coverage = ProfilingCoverage::SELECT

The profiling coverage. SELECT is the default behavior, and ALL emits profiling information for all operator types.

◆ http_logging_output

string duckdb::ClientConfig::http_logging_output

DEPRECATED The file to save query HTTP logging information to, instead of printing it to the console (empty = output to the DuckDB logger)

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

external/duckdb/duckdb.hpp

Public Member Functions

Static Public Member Functions