連線建立

主題
	Metadata
	分割結果
	交易語意

類別
struct	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 的方法）。（不保證一定會取消，例如，結果集可能已緩衝在記憶體中。）

這必須始終是執行緒安全的（其他操作則不是）。它不一定是訊號安全的。

Since

ADBC API revision 1.1.0

參數

[in]	connection	要取消的連線。
[out]	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 )

銷毀此連線。

參數

[in]	connection	要釋放的連線。
[out]	error	如果需要，用於傳回錯誤訊息的可選位置。

AdbcConnectionSetOption()

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

設定一個 char* 選項。

選項可以在 AdbcConnectionInit 之前設定。某些驅動程式也可能支援在初始化後設定選項。

參數

[in]	connection	資料庫連線。
[in]	key	要設定的選項。
[in]	value	選項值。
[out]	error	如果需要，用於傳回錯誤訊息的可選位置。

傳回

如果選項無法識別，則傳回 ADBC_STATUS_NOT_IMPLEMENTED

AdbcConnectionSetOptionBytes()

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

在連線上設定一個位元組字串選項。

Since

ADBC API revision 1.1.0

參數

[in]	connection	連線。
[in]	key	要設定的選項。
[in]	value	選項值。
[in]	length	選項值長度。
[out]	error	如果需要，用於傳回錯誤訊息的可選位置。

傳回

如果選項無法識別，則傳回 ADBC_STATUS_NOT_IMPLEMENTED

AdbcConnectionSetOptionDouble()

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

設定一個雙精度浮點數選項。

選項可以在 AdbcConnectionInit 之前設定。某些驅動程式也可能支援在初始化後設定選項。

Since

ADBC API revision 1.1.0

參數

[in]	connection	資料庫連線。
[in]	key	要設定的選項。
[in]	value	選項值。
[out]	error	如果需要，用於傳回錯誤訊息的可選位置。

傳回

如果選項無法識別，則傳回 ADBC_STATUS_NOT_IMPLEMENTED

AdbcConnectionSetOptionInt()

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

設定一個整數選項。

選項可以在 AdbcConnectionInit 之前設定。某些驅動程式也可能支援在初始化後設定選項。

Since

ADBC API revision 1.1.0

參數

[in]	connection	資料庫連線。
[in]	key	要設定的選項。
[in]	value	選項值。
[out]	error	如果需要，用於傳回錯誤訊息的可選位置。

傳回

如果選項無法識別，則傳回 ADBC_STATUS_NOT_IMPLEMENTED