AdbcError Struct Reference

A detailed error message for an operation. More...

#include <duckdb.hpp>

Collaboration diagram for AdbcError:

Public Attributes
char *	message
	The error message.
int32_t	vendor_code
	A vendor-specific error code, if applicable.
char	sqlstate [5]
	A SQLSTATE error code, if provided, as defined by the SQL:2003 standard. If not set, it should be set to "\0\0\0\0\0".
void(*	release )(struct AdbcError *error)
	Release the contained error.
void *	private_data
	Opaque implementation-defined state.
struct AdbcDriver *	private_driver
	The associated driver (used by the driver manager to help track state).

Detailed Description

A detailed error message for an operation.

The caller must zero-initialize this struct (clarified in ADBC 1.1.0).

The structure was extended in ADBC 1.1.0. Drivers and clients using ADBC 1.0.0 will not have the private_data or private_driver fields. Drivers should read/write these fields if and only if vendor_code is equal to ADBC_ERROR_VENDOR_CODE_PRIVATE_DATA. Clients are required to initialize this struct to avoid the possibility of uninitialized values confusing the driver.

Member Data Documentation

release

void(* AdbcError::release) (struct AdbcError *error)

Release the contained error.

Unlike other structures, this is an embedded callback to make it easier for the driver manager and driver to cooperate.

private_data

void* AdbcError::private_data

Opaque implementation-defined state.

This field may not be used unless vendor_code is ADBC_ERROR_VENDOR_CODE_PRIVATE_DATA. If present, this field is NULLPTR iff the error is unintialized/freed.

Since

ADBC API revision 1.1.0

private_driver

struct AdbcDriver* AdbcError::private_driver

The associated driver (used by the driver manager to help track state).

This field may not be used unless vendor_code is ADBC_ERROR_VENDOR_CODE_PRIVATE_DATA.

Since

ADBC API revision 1.1.0

---

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

• external/duckdb/duckdb.hpp