duckdb::CatalogException Class Reference

Inheritance diagram for duckdb::CatalogException:

Collaboration diagram for duckdb::CatalogException:

Public Member Functions
DUCKDB_API	CatalogException (const string &msg)
DUCKDB_API	CatalogException (const unordered_map< string, string > &extra_info, const string &msg)
template<typename... ARGS>
	CatalogException (const string &msg, ARGS &&...params)
template<typename... ARGS>
	CatalogException (QueryErrorContext error_context, 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 CatalogException	MissingEntry (const EntryLookupInfo &lookup_info, const string &suggestion)
static CatalogException	MissingEntry (CatalogType type, const string &name, const string &suggestion, QueryErrorContext context=QueryErrorContext())
static CatalogException	MissingEntry (const string &type, const string &name, const vector< string > &suggestions, QueryErrorContext context=QueryErrorContext())
static CatalogException	EntryAlreadyExists (CatalogType type, const string &name, QueryErrorContext context=QueryErrorContext())
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

CatalogException() [1/4]

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

explicit

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

CatalogException() [2/4]

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

explicit

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

CatalogException() [3/4]

template<typename... ARGS>

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

inlineexplicit

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

CatalogException() [4/4]

template<typename... ARGS>

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

inlineexplicit

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

Member Function Documentation

MissingEntry() [1/3]

CatalogException duckdb::CatalogException::MissingEntry ( const EntryLookupInfo &  lookup_info, const string &  suggestion  )

static

                                                                                                            {
    auto type = lookup_info.GetCatalogType();
    auto context = lookup_info.GetErrorContext();
    auto &name = lookup_info.GetEntryName();
    auto at_clause = lookup_info.GetAtClause();
 
    string did_you_mean;
    if (!suggestion.empty()) {
        did_you_mean = "\nDid you mean \"" + suggestion + "\"?";
    }
    string version_info;
    if (at_clause) {
        version_info += " at " + StringUtil::Lower(at_clause->Unit()) + " " + at_clause->GetValue().ToString();
    }
 
    auto extra_info = Exception::InitializeExtraInfo("MISSING_ENTRY", context.query_location);
 
    extra_info["name"] = name;
    extra_info["type"] = CatalogTypeToString(type);
    if (!suggestion.empty()) {
        extra_info["candidates"] = suggestion;
    }
    return CatalogException(extra_info,
                            StringUtil::Format("%s with name %s does not exist%s!%s", CatalogTypeToString(type), name,
                                               version_info, did_you_mean));
}

MissingEntry() [2/3]

CatalogException duckdb::CatalogException::MissingEntry ( CatalogType  type, const string &  name, const string &  suggestion, QueryErrorContext  context = QueryErrorContext()  )

static

                                                                           {
    EntryLookupInfo lookup_info(type, name, context);
    return MissingEntry(lookup_info, suggestion);
}

MissingEntry() [3/3]

CatalogException duckdb::CatalogException::MissingEntry ( const string &  type, const string &  name, const vector< string > &  suggestions, QueryErrorContext  context = QueryErrorContext()  )

static

                                                                                                              {
    auto extra_info = Exception::InitializeExtraInfo("MISSING_ENTRY", context.query_location);
    extra_info["error_subtype"] = "MISSING_ENTRY";
    extra_info["name"] = name;
    extra_info["type"] = type;
    if (!suggestions.empty()) {
        extra_info["candidates"] = StringUtil::Join(suggestions, ", ");
    }
    return CatalogException(extra_info,
                            StringUtil::Format("unrecognized %s \"%s\"\n%s", type, name,
                                               StringUtil::CandidatesErrorMessage(suggestions, name, "Did you mean")));
}

EntryAlreadyExists()

CatalogException duckdb::CatalogException::EntryAlreadyExists ( CatalogType  type, const string &  name, QueryErrorContext  context = QueryErrorContext()  )

static

                                                                                                                     {
    auto extra_info = Exception::InitializeExtraInfo("ENTRY_ALREADY_EXISTS", optional_idx());
    extra_info["name"] = name;
    extra_info["type"] = CatalogTypeToString(type);
    return CatalogException(extra_info,
                            StringUtil::Format("%s with name \"%s\" already exists!", CatalogTypeToString(type), name));
}

---

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

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