连接建立

主题
	元数据
	分区结果
	事务语义

类
结构体	AdbcConnection
	一个活动的数据库连接。更多...

函数
AdbcStatusCode	AdbcConnectionNew (struct AdbcConnection *connection, struct AdbcError *error)
	分配一个新的（但未初始化的）连接。
AdbcStatusCode	AdbcConnectionSetOption (struct AdbcConnection *connection, const char *key, const char *value, struct AdbcError *error)
	设置一个 char* 选项。
AdbcStatusCode	AdbcConnectionSetOptionBytes (struct AdbcConnection *connection, const char *key, const uint8_t *value, size_t length, struct AdbcError *error)
	在连接上设置一个字节串选项。
AdbcStatusCode	AdbcConnectionSetOptionInt (struct AdbcConnection *connection, const char *key, int64_t value, struct AdbcError *error)
	设置一个整数选项。
AdbcStatusCode	AdbcConnectionSetOptionDouble (struct AdbcConnection *connection, const char *key, double value, struct AdbcError *error)
	设置一个双精度浮点数选项。
AdbcStatusCode	AdbcConnectionInit (struct AdbcConnection *connection, struct AdbcDatabase *database, struct AdbcError *error)
	完成设置选项并初始化连接。
AdbcStatusCode	AdbcConnectionRelease (struct AdbcConnection *connection, struct AdbcError *error)
	销毁此连接。
AdbcStatusCode	AdbcConnectionCancel (struct AdbcConnection *connection, struct AdbcError *error)
	取消连接上正在进行的操作。

详细描述

用于创建、使用和释放数据库连接的函数。

---

类文档

AdbcConnection

struct AdbcConnection

一个活动的数据库连接。

提供用于查询执行、管理预处理语句、使用事务等的方法。

连接不需要是线程安全的，但只要客户端注意序列化对连接的访问，就可以从多个线程使用它们。

公共属性
void *	private_data
	不透明的实现定义状态。仅当连接未初始化/释放时，此字段才为 NULLPTR。
struct AdbcDriver *	private_driver
	关联的驱动程序（由驱动程序管理器用于帮助跟踪状态）。

成员数据文档

private_data

void* AdbcConnection::private_data

不透明的实现定义状态。仅当连接未初始化/释放时，此字段才为 NULLPTR。

private_driver

struct AdbcDriver* AdbcConnection::private_driver

关联的驱动程序（由驱动程序管理器用于帮助跟踪状态）。

函数文档

AdbcConnectionCancel()

AdbcStatusCode AdbcConnectionCancel	(	struct AdbcConnection *	connection,
		struct AdbcError *	error )

取消连接上正在进行的操作。

这可以在 AdbcConnectionGetObjects（或类似函数）期间调用，或者在使用从此类函数返回的 ArrowArrayStream 时调用。调用此函数应使其他函数返回 ADBC_STATUS_CANCELLED（来自 ADBC 函数）或 ECANCELED（来自 ArrowArrayStream 的方法）。（但这不能保证，例如，结果集可能已缓存在内存中。）

这必须始终是线程安全的（其他操作则不需要）。它不一定是信号安全的。

自

ADBC API 修订版 1.1.0

参数

[输入]	connection	要取消的连接。
[输出]	error	如有必要，返回错误消息的可选位置。

返回值

如果没有要取消的操作，则返回 ADBC_STATUS_INVALID_STATE。

如果操作无法取消，则返回 ADBC_STATUS_UNKNOWN。

AdbcConnectionInit()

AdbcStatusCode AdbcConnectionInit	(	struct AdbcConnection *	connection,
		struct AdbcDatabase *	database,
		struct AdbcError *	error )

完成设置选项并初始化连接。

一些驱动程序也可能支持在初始化后设置选项。

AdbcConnectionNew()

AdbcStatusCode AdbcConnectionNew	(	struct AdbcConnection *	connection,
		struct AdbcError *	error )

分配一个新的（但未初始化的）连接。

调用者传入一个初始化为零的 AdbcConnection。

驱动程序应分配其内部数据结构并将 private_data 字段设置为指向新分配的结构体。当调用 AdbcConnectionRelease 时，应释放此结构体。

AdbcConnectionRelease()

AdbcStatusCode AdbcConnectionRelease	(	struct AdbcConnection *	connection,
		struct AdbcError *	error )

销毁此连接。

参数

[输入]	connection	要释放的连接。
[输出]	error	如有必要，返回错误消息的可选位置。

AdbcConnectionSetOption()

AdbcStatusCode AdbcConnectionSetOption	(	struct AdbcConnection *	connection,
		const char *	key,
		const char *	value,
		struct AdbcError *	error )

设置一个 char* 选项。

可以在 AdbcConnectionInit 之前设置选项。一些驱动程序也可能支持在初始化后设置选项。

参数

[输入]	connection	数据库连接。
[输入]	key	要设置的选项。
[输入]	value	选项值。
[输出]	error	如有必要，返回错误消息的可选位置。

返回值

如果无法识别该选项，则返回 ADBC_STATUS_NOT_IMPLEMENTED

AdbcConnectionSetOptionBytes()

AdbcStatusCode AdbcConnectionSetOptionBytes	(	struct AdbcConnection *	connection,
		const char *	key,
		const uint8_t *	value,
		size_t	length,
		struct AdbcError *	error )

在连接上设置一个字节串选项。

自

ADBC API 修订版 1.1.0

参数

[输入]	connection	连接。
[输入]	key	要设置的选项。
[输入]	value	选项值。
[输入]	length	选项值的长度。
[输出]	error	如有必要，返回错误消息的可选位置。

返回值

如果无法识别该选项，则返回 ADBC_STATUS_NOT_IMPLEMENTED

AdbcConnectionSetOptionDouble()

AdbcStatusCode AdbcConnectionSetOptionDouble	(	struct AdbcConnection *	connection,
		const char *	key,
		double	value,
		struct AdbcError *	error )

设置一个双精度浮点数选项。

可以在 AdbcConnectionInit 之前设置选项。一些驱动程序也可能支持在初始化后设置选项。

自

ADBC API 修订版 1.1.0

参数

[输入]	connection	数据库连接。
[输入]	key	要设置的选项。
[输入]	value	选项值。
[输出]	error	如有必要，返回错误消息的可选位置。

返回值

如果无法识别该选项，则返回 ADBC_STATUS_NOT_IMPLEMENTED

AdbcConnectionSetOptionInt()

AdbcStatusCode AdbcConnectionSetOptionInt	(	struct AdbcConnection *	connection,
		const char *	key,
		int64_t	value,
		struct AdbcError *	error )

设置一个整数选项。

可以在 AdbcConnectionInit 之前设置选项。一些驱动程序也可能支持在初始化后设置选项。

自

ADBC API 修订版 1.1.0

参数

[输入]	connection	数据库连接。
[输入]	key	要设置的选项。
[输入]	value	选项值。
[输出]	error	如有必要，返回错误消息的可选位置。

返回值

如果无法识别该选项，则返回 ADBC_STATUS_NOT_IMPLEMENTED