duckdb::OutOfMemoryException Class Reference

Inheritance diagram for duckdb::OutOfMemoryException:

Collaboration diagram for duckdb::OutOfMemoryException:

Public Member Functions
DUCKDB_API	OutOfMemoryException (const string &msg)
template<typename... ARGS>
	OutOfMemoryException (const string &msg, ARGS &&...params)
Public Member Functions inherited from duckdb::Exception
DUCKDB_API	Exception (ExceptionType exception_type, const string &message)
DUCKDB_API	Exception (const unordered_map< string, string > &extra_info, ExceptionType exception_type, const string &message)

Private Member Functions
string	ExtendOutOfMemoryError (const string &msg)

Additional Inherited Members
Static Public Member Functions inherited from duckdb::Exception
static DUCKDB_API string	ExceptionTypeToString (ExceptionType type)
static DUCKDB_API ExceptionType	StringToExceptionType (const string &type)
template<typename... ARGS>
static string	ConstructMessage (const string &msg, ARGS const &...params)
static DUCKDB_API unordered_map< string, string >	InitializeExtraInfo (const Expression &expr)
static DUCKDB_API unordered_map< string, string >	InitializeExtraInfo (const ParsedExpression &expr)
static DUCKDB_API unordered_map< string, string >	InitializeExtraInfo (const QueryErrorContext &error_context)
static DUCKDB_API unordered_map< string, string >	InitializeExtraInfo (const TableRef &ref)
static DUCKDB_API unordered_map< string, string >	InitializeExtraInfo (optional_idx error_location)
static DUCKDB_API unordered_map< string, string >	InitializeExtraInfo (const string &subtype, optional_idx error_location)
static DUCKDB_API bool	IsExecutionError (ExceptionType type)
	Whether this exception type can occur during execution of a query.
static DUCKDB_API string	ToJSON (ExceptionType type, const string &message)
static DUCKDB_API string	ToJSON (const unordered_map< string, string > &extra_info, ExceptionType type, const string &message)
static DUCKDB_API bool	InvalidatesTransaction (ExceptionType exception_type)
static DUCKDB_API bool	InvalidatesDatabase (ExceptionType exception_type)
static DUCKDB_API string	ConstructMessageRecursive (const string &msg, std::vector< ExceptionFormatValue > &values)
template<class T , typename... ARGS>
static string	ConstructMessageRecursive (const string &msg, std::vector< ExceptionFormatValue > &values, const T &param, ARGS &&...params)
static DUCKDB_API bool	UncaughtException ()
static DUCKDB_API string	GetStackTrace (idx_t max_depth=120)
static string	FormatStackTrace (const string &message="")
static DUCKDB_API void	SetQueryLocation (optional_idx error_location, unordered_map< string, string > &extra_info)

Constructor & Destructor Documentation

OutOfMemoryException() [1/2]

duckdb::OutOfMemoryException::OutOfMemoryException ( const string &  msg )

explicit

    : Exception(ExceptionType::OUT_OF_MEMORY, ExtendOutOfMemoryError(msg)) {
}

OutOfMemoryException() [2/2]

template<typename... ARGS>

duckdb::OutOfMemoryException::OutOfMemoryException ( const string &  msg, ARGS &&...  params  )

inlineexplicit

        : OutOfMemoryException(ConstructMessage(msg, std::forward<ARGS>(params)...)) {
    }

Member Function Documentation

ExtendOutOfMemoryError()

string duckdb::OutOfMemoryException::ExtendOutOfMemoryError ( const string &  msg )

private

                                                                     {
    string link = "https://duckdb.org/docs/stable/guides/performance/how_to_tune_workloads";
    if (StringUtil::Contains(msg, link)) {
        // already extended
        return msg;
    }
    string new_msg = msg;
    new_msg += "\n\nPossible solutions:\n";
    new_msg += "* Reducing the number of threads (SET threads=X)\n";
    new_msg += "* Disabling insertion-order preservation (SET preserve_insertion_order=false)\n";
    new_msg += "* Increasing the memory limit (SET memory_limit='...GB')\n";
    new_msg += "\nSee also " + link;
    return new_msg;
}

---

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

• external/duckdb/duckdb.hpp
• external/duckdb/duckdb.cpp