duckdb::BinderException Class Reference

Inheritance diagram for duckdb::BinderException:

Collaboration diagram for duckdb::BinderException:

Public Member Functions
DUCKDB_API	BinderException (const string &msg)
DUCKDB_API	BinderException (const unordered_map< string, string > &extra_info, const string &msg)
template<typename... ARGS>
	BinderException (const string &msg, ARGS &&...params)
template<typename... ARGS>
	BinderException (const TableRef &ref, const string &msg, ARGS &&...params)
template<typename... ARGS>
	BinderException (const ParsedExpression &expr, const string &msg, ARGS &&...params)
template<typename... ARGS>
	BinderException (const Expression &expr, const string &msg, ARGS &&...params)
template<typename... ARGS>
	BinderException (QueryErrorContext error_context, const string &msg, ARGS &&...params)
template<typename... ARGS>
	BinderException (optional_idx error_location, 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)

Static Public Member Functions
static BinderException	ColumnNotFound (const string &name, const vector< string > &similar_bindings, QueryErrorContext context=QueryErrorContext())
static BinderException	NoMatchingFunction (const string &catalog_name, const string &schema_name, const string &name, const vector< LogicalType > &arguments, const vector< string > &candidates)
static BinderException	Unsupported (ParsedExpression &expr, const string &message)
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

BinderException() [1/8]

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

explicit

                                                  : Exception(ExceptionType::BINDER, msg) {
}

BinderException() [2/8]

duckdb::BinderException::BinderException ( const unordered_map< string, string > &  extra_info, const string &  msg  )

explicit

    : Exception(extra_info, ExceptionType::BINDER, msg) {
}

BinderException() [3/8]

template<typename... ARGS>

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

inlineexplicit

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

BinderException() [4/8]

template<typename... ARGS>

duckdb::BinderException::BinderException ( const TableRef &  ref, const string &  msg, ARGS &&...  params  )

inlineexplicit

        : BinderException(Exception::InitializeExtraInfo(ref), ConstructMessage(msg, std::forward<ARGS>(params)...)) {
    }

BinderException() [5/8]

template<typename... ARGS>

duckdb::BinderException::BinderException ( const ParsedExpression &  expr, const string &  msg, ARGS &&...  params  )

inlineexplicit

        : BinderException(Exception::InitializeExtraInfo(expr), ConstructMessage(msg, std::forward<ARGS>(params)...)) {
    }

BinderException() [6/8]

template<typename... ARGS>

duckdb::BinderException::BinderException ( const Expression &  expr, const string &  msg, ARGS &&...  params  )

inlineexplicit

        : BinderException(Exception::InitializeExtraInfo(expr), ConstructMessage(msg, std::forward<ARGS>(params)...)) {
    }

BinderException() [7/8]

template<typename... ARGS>

duckdb::BinderException::BinderException ( QueryErrorContext  error_context, const string &  msg, ARGS &&...  params  )

inlineexplicit

        : BinderException(Exception::InitializeExtraInfo(error_context),
                          ConstructMessage(msg, std::forward<ARGS>(params)...)) {
    }

BinderException() [8/8]

template<typename... ARGS>

duckdb::BinderException::BinderException ( optional_idx  error_location, const string &  msg, ARGS &&...  params  )

inlineexplicit

        : BinderException(Exception::InitializeExtraInfo(error_location),
                          ConstructMessage(msg, std::forward<ARGS>(params)...)) {
    }

Member Function Documentation

ColumnNotFound()

BinderException duckdb::BinderException::ColumnNotFound ( const string &  name, const vector< string > &  similar_bindings, QueryErrorContext  context = QueryErrorContext()  )

static

                                                                           {
    auto extra_info = Exception::InitializeExtraInfo("COLUMN_NOT_FOUND", context.query_location);
    string candidate_str = StringUtil::CandidatesMessage(similar_bindings, "Candidate bindings");
    extra_info["name"] = name;
    if (!similar_bindings.empty()) {
        extra_info["candidates"] = StringUtil::Join(similar_bindings, ",");
        return BinderException(extra_info, StringUtil::Format("Referenced column \"%s\" not found in FROM clause!%s",
                                                              name, candidate_str));
    } else {
        return BinderException(
            extra_info,
            StringUtil::Format("Referenced column \"%s\" was not found because the FROM clause is missing", name));
    }
}

NoMatchingFunction()

BinderException duckdb::BinderException::NoMatchingFunction ( const string &  catalog_name, const string &  schema_name, const string &  name, const vector< LogicalType > &  arguments, const vector< string > &  candidates  )

static

                                                                                      {
    auto extra_info = Exception::InitializeExtraInfo("NO_MATCHING_FUNCTION", optional_idx());
    // no matching function was found, throw an error
    string call_str = Function::CallToString(catalog_name, schema_name, name, arguments);
    string candidate_str;
    for (auto &candidate : candidates) {
        candidate_str += "\t" + candidate + "\n";
    }
    extra_info["name"] = name;
    if (!catalog_name.empty()) {
        extra_info["catalog"] = catalog_name;
    }
    if (!schema_name.empty()) {
        extra_info["schema"] = schema_name;
    }
    extra_info["call"] = call_str;
    if (!candidates.empty()) {
        extra_info["candidates"] = StringUtil::Join(candidates, ",");
    }
    return BinderException(
        extra_info,
        StringUtil::Format("No function matches the given name and argument types '%s'. You might need to add "
                           "explicit type casts.\n\tCandidate functions:\n%s",
                           call_str, candidate_str));
}

Unsupported()

BinderException duckdb::BinderException::Unsupported ( ParsedExpression &  expr, const string &  message  )

static

                                                                                          {
    auto extra_info = Exception::InitializeExtraInfo("UNSUPPORTED", expr.GetQueryLocation());
    return BinderException(extra_info, message);
}

---

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

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