cpp/api/adbc_8h_source.html

// 根据 Apache 软件基金会 (ASF) 的一项或多项

// 贡献者许可协议获得许可。有关版权所有权的更多信息，请参见

// 此作品随附的 NOTICE 文件。ASF 根据 Apache 许可证 2.0 版（

// “许可证”）向您授权此文件；除非您遵守

// 许可证，否则您不得使用此文件。您可以从以下位置获取许可证副本：

// 许可证。您可以从以下位置获取许可证副本：

//

//

// http://apache.org/licenses/LICENSE-2.0

//

// 除非适用法律要求或书面同意，否则

// 根据许可证分发的软件将按“原样”分发，不提供任何形式的保证或条件，

// 无论是明示的还是暗示的。有关

// 特定语言的权限和限制，请参阅许可证。

//

// 根据许可证。


#pragma once


#include <stddef.h>

#include <stdint.h>


#ifdef __cplusplus

extern "C" {

#endif


// 为没有规范保护的 Arrow 版本提供的额外保护

#ifndef ARROW_FLAG_DICTIONARY_ORDERED


#ifndef ARROW_C_DATA_INTERFACE

#define ARROW_C_DATA_INTERFACE


#define ARROW_FLAG_DICTIONARY_ORDERED 1

#define ARROW_FLAG_NULLABLE 2

#define ARROW_FLAG_MAP_KEYS_SORTED 4


struct ArrowSchema {

 // 数组类型描述

 const char* format;

 const char* name;

 const char* metadata;

 int64_t flags;

 int64_t n_children;

 struct ArrowSchema** children;

 struct ArrowSchema* dictionary;


 // 释放回调

 void (*release)(struct ArrowSchema*);

 // 不透明的生产者特定数据

 void* private_data;

};


struct ArrowArray {

 // 数组数据描述

 int64_t length;

 int64_t null_count;

 int64_t offset;

 int64_t n_buffers;

 int64_t n_children;

 const void** buffers;

 struct ArrowArray** children;

 struct ArrowArray* dictionary;


 // 释放回调

 void (*release)(struct ArrowArray*);

 // 不透明的生产者特定数据

 void* private_data;

};


#endif // ARROW_C_DATA_INTERFACE


#ifndef ARROW_C_STREAM_INTERFACE

#define ARROW_C_STREAM_INTERFACE


struct ArrowArrayStream {

 // 回调以获取流类型

 // （对于流中的所有数组都相同）。

  //

 // 返回值：如果成功，则为 0；否则为与 `errno` 兼容的错误代码。

  //

 // 如果成功，则 ArrowSchema 必须与流独立释放。

 int (*get_schema)(struct ArrowArrayStream*, struct ArrowSchema* out);


 // 回调以获取下一个数组

 // （如果没有错误且数组已释放，则流已结束）

  //

 // 返回值：如果成功，则为 0；否则为与 `errno` 兼容的错误代码。

  //

 // 如果成功，则 ArrowArray 必须与流独立释放。

 int (*get_next)(struct ArrowArrayStream*, struct ArrowArray* out);


 // 回调以获取可选的详细错误信息。

 // 仅当上次流操作失败时才必须调用此方法

 // 返回非 0 返回代码。

  //

 // 返回值：指向描述上次错误的以 null 结尾的字符数组的指针，

 // 如果没有描述可用，则返回 NULL。

  //

 // 返回的指针仅在对此流的下一次操作（包括释放）之前有效。

 //

 const char* (*get_last_error)(struct ArrowArrayStream*);


 // 释放回调：释放流自身的资源。

 // 请注意，必须单独释放 `get_next` 返回的数组。

 void (*release)(struct ArrowArrayStream*);


 // 不透明的生产者特定数据

 void* private_data;

};


#endif // ARROW_C_STREAM_INTERFACE

#endif // ARROW_FLAG_DICTIONARY_ORDERED


#ifndef ADBC

#define ADBC


// Windows 的存储类宏

// 允许使用应用程序定义的宏进行覆盖/别名

#if !defined(ADBC_EXPORT)

#if defined(_WIN32)

#if defined(ADBC_EXPORTING)

#define ADBC_EXPORT __declspec(dllexport)

#else

#define ADBC_EXPORT __declspec(dllimport)

#endif // defined(ADBC_EXPORTING)

#else


#endif // defined(_WIN32)

#endif // !defined(ADBC_EXPORT)


typedef uint8_t AdbcStatusCode;


#define ADBC_STATUS_OK 0

#define ADBC_STATUS_UNKNOWN 1

#define ADBC_STATUS_NOT_IMPLEMENTED 2

#define ADBC_STATUS_NOT_FOUND 3

#define ADBC_STATUS_ALREADY_EXISTS 4

#define ADBC_STATUS_INVALID_ARGUMENT 5

#define ADBC_STATUS_INVALID_STATE 6

#define ADBC_STATUS_INVALID_DATA 7

#define ADBC_STATUS_INTEGRITY 8

#define ADBC_STATUS_INTERNAL 9

#define ADBC_STATUS_IO 10

#define ADBC_STATUS_CANCELLED 11

#define ADBC_STATUS_TIMEOUT 12

#define ADBC_STATUS_UNAUTHENTICATED 13

#define ADBC_STATUS_UNAUTHORIZED 14


#define ADBC_ERROR_VENDOR_CODE_PRIVATE_DATA INT32_MIN


struct ADBC_EXPORT AdbcError {

 char* message;


 int32_t vendor_code;


 char sqlstate[5];


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


 void* private_data;


 struct AdbcDriver* private_driver;

};


#ifdef __cplusplus

#define ADBC_ERROR_INIT \

 (AdbcError{nullptr, \

 ADBC_ERROR_VENDOR_CODE_PRIVATE_DATA, \

             {0, 0, 0, 0, 0},                     \

 nullptr, \

 nullptr, \

 nullptr})

#else


#define ADBC_ERROR_INIT \

 ((struct AdbcError){ \

 NULL, ADBC_ERROR_VENDOR_CODE_PRIVATE_DATA, {0, 0, 0, 0, 0}, NULL, NULL, NULL})


#endif


#define ADBC_ERROR_1_0_0_SIZE (offsetof(struct AdbcError, private_data))

#define ADBC_ERROR_1_1_0_SIZE (sizeof(struct AdbcError))


struct ADBC_EXPORT AdbcErrorDetail {

 const char* key;

 const uint8_t* value;

 size_t value_length;

};


ADBC_EXPORT

int AdbcErrorGetDetailCount(const struct AdbcError* error);


ADBC_EXPORT

struct AdbcErrorDetail AdbcErrorGetDetail(const struct AdbcError* error, int index);


ADBC_EXPORT

const struct AdbcError* AdbcErrorFromArrayStream(struct ArrowArrayStream* stream,

 AdbcStatusCode* status);


#define ADBC_VERSION_1_0_0 1000000


#define ADBC_VERSION_1_1_0 1001000


#define ADBC_OPTION_VALUE_ENABLED "true"

#define ADBC_OPTION_VALUE_DISABLED "false"


#define ADBC_OPTION_URI "uri"

#define ADBC_OPTION_USERNAME "username"

#define ADBC_OPTION_PASSWORD "password"


#define ADBC_INFO_VENDOR_NAME 0

#define ADBC_INFO_VENDOR_VERSION 1

#define ADBC_INFO_VENDOR_ARROW_VERSION 2

#define ADBC_INFO_VENDOR_SQL 3

#define ADBC_INFO_VENDOR_SUBSTRAIT 4

#define ADBC_INFO_VENDOR_SUBSTRAIT_MIN_VERSION 5

#define ADBC_INFO_VENDOR_SUBSTRAIT_MAX_VERSION 6


#define ADBC_INFO_DRIVER_NAME 100

#define ADBC_INFO_DRIVER_VERSION 101

#define ADBC_INFO_DRIVER_ARROW_VERSION 102

#define ADBC_INFO_DRIVER_ADBC_VERSION 103


#define ADBC_OBJECT_DEPTH_ALL 0

#define ADBC_OBJECT_DEPTH_CATALOGS 1

#define ADBC_OBJECT_DEPTH_DB_SCHEMAS 2

#define ADBC_OBJECT_DEPTH_TABLES 3

#define ADBC_OBJECT_DEPTH_COLUMNS ADBC_OBJECT_DEPTH_ALL


#define ADBC_STATISTIC_AVERAGE_BYTE_WIDTH_KEY 0

#define ADBC_STATISTIC_AVERAGE_BYTE_WIDTH_NAME "adbc.statistic.byte_width"

#define ADBC_STATISTIC_DISTINCT_COUNT_KEY 1

#define ADBC_STATISTIC_DISTINCT_COUNT_NAME "adbc.statistic.distinct_count"


#define ADBC_STATISTIC_MAX_VALUE_KEY 3

#define ADBC_STATISTIC_MAX_VALUE_NAME "adbc.statistic.max_value"

#define ADBC_STATISTIC_MIN_VALUE_KEY 4

#define ADBC_STATISTIC_MIN_VALUE_NAME "adbc.statistic.min_value"

#define ADBC_STATISTIC_NULL_COUNT_KEY 5

#define ADBC_STATISTIC_NULL_COUNT_NAME "adbc.statistic.null_count"

#define ADBC_STATISTIC_ROW_COUNT_KEY 6

#define ADBC_STATISTIC_ROW_COUNT_NAME "adbc.statistic.row_count"


#define ADBC_CONNECTION_OPTION_AUTOCOMMIT "adbc.connection.autocommit"


#define ADBC_CONNECTION_OPTION_READ_ONLY "adbc.connection.readonly"


#define ADBC_CONNECTION_OPTION_CURRENT_CATALOG "adbc.connection.catalog"


#define ADBC_CONNECTION_OPTION_CURRENT_DB_SCHEMA "adbc.connection.db_schema"


#define ADBC_STATEMENT_OPTION_INCREMENTAL "adbc.statement.exec.incremental"


#define ADBC_STATEMENT_OPTION_PROGRESS "adbc.statement.exec.progress"


#define ADBC_STATEMENT_OPTION_MAX_PROGRESS "adbc.statement.exec.max_progress"


#define ADBC_CONNECTION_OPTION_ISOLATION_LEVEL \

 "adbc.connection.transaction.isolation_level"


#define ADBC_OPTION_ISOLATION_LEVEL_DEFAULT \

 "adbc.connection.transaction.isolation.default"


#define ADBC_OPTION_ISOLATION_LEVEL_READ_UNCOMMITTED \

 "adbc.connection.transaction.isolation.read_uncommitted"


#define ADBC_OPTION_ISOLATION_LEVEL_READ_COMMITTED \

 "adbc.connection.transaction.isolation.read_committed"


#define ADBC_OPTION_ISOLATION_LEVEL_REPEATABLE_READ \

 "adbc.connection.transaction.isolation.repeatable_read"


#define ADBC_OPTION_ISOLATION_LEVEL_SNAPSHOT \

 "adbc.connection.transaction.isolation.snapshot"


#define ADBC_OPTION_ISOLATION_LEVEL_SERIALIZABLE \

 "adbc.connection.transaction.isolation.serializable"


#define ADBC_OPTION_ISOLATION_LEVEL_LINEARIZABLE \

 "adbc.connection.transaction.isolation.linearizable"


#define ADBC_INGEST_OPTION_TARGET_TABLE "adbc.ingest.target_table"

#define ADBC_INGEST_OPTION_MODE "adbc.ingest.mode"

#define ADBC_INGEST_OPTION_MODE_CREATE "adbc.ingest.mode.create"

#define ADBC_INGEST_OPTION_MODE_APPEND "adbc.ingest.mode.append"

#define ADBC_INGEST_OPTION_MODE_REPLACE "adbc.ingest.mode.replace"

#define ADBC_INGEST_OPTION_MODE_CREATE_APPEND "adbc.ingest.mode.create_append"

#define ADBC_INGEST_OPTION_TARGET_CATALOG "adbc.ingest.target_catalog"

#define ADBC_INGEST_OPTION_TARGET_DB_SCHEMA "adbc.ingest.target_db_schema"

#define ADBC_INGEST_OPTION_TEMPORARY "adbc.ingest.temporary"


struct ADBC_EXPORT AdbcDatabase {

 void* private_data;

 struct AdbcDriver* private_driver;

};


struct ADBC_EXPORT AdbcConnection {

 void* private_data;

 struct AdbcDriver* private_driver;

};


struct ADBC_EXPORT AdbcStatement {

 void* private_data;


 struct AdbcDriver* private_driver;

};


struct AdbcPartitions {

 size_t num_partitions;


 const uint8_t** partitions;


 const size_t* partition_lengths;


 void* private_data;


 void (*release)(struct AdbcPartitions* partitions);

};


struct ADBC_EXPORT AdbcDriver {

 void* private_data;

 void* private_manager;


 AdbcStatusCode (*release)(struct AdbcDriver* driver, struct AdbcError* error);


 AdbcStatusCode (*DatabaseInit)(struct AdbcDatabase*, struct AdbcError*);

 AdbcStatusCode (*DatabaseNew)(struct AdbcDatabase*, struct AdbcError*);


 struct AdbcError*);

 AdbcStatusCode (*DatabaseRelease)(struct AdbcDatabase*, struct AdbcError*);


 AdbcStatusCode (*ConnectionCommit)(struct AdbcConnection*, struct AdbcError*);

 AdbcStatusCode (*ConnectionGetInfo)(struct AdbcConnection*, const uint32_t*, size_t,

 struct ArrowArrayStream*, struct AdbcError*);

 AdbcStatusCode (*ConnectionGetObjects)(struct AdbcConnection*, int, const char*,

 const char*, const char*, const char**,

 const char*, struct ArrowArrayStream*,

 struct AdbcError*);

 AdbcStatusCode (*ConnectionGetTableSchema)(struct AdbcConnection*, const char*,

 const char*, const char*,

 struct ArrowSchema*, struct AdbcError*);

 AdbcStatusCode (*ConnectionGetTableTypes)(struct AdbcConnection*,

 struct ArrowArrayStream*, struct AdbcError*);

 AdbcStatusCode (*ConnectionInit)(struct AdbcConnection*, struct AdbcDatabase*,

 struct AdbcError*);

 AdbcStatusCode (*ConnectionNew)(struct AdbcConnection*, struct AdbcError*);

 AdbcStatusCode (*ConnectionSetOption)(struct AdbcConnection*, const char*, const char*,

 struct AdbcError*);

 AdbcStatusCode (*ConnectionReadPartition)(struct AdbcConnection*, const uint8_t*,

 size_t, struct ArrowArrayStream*,

 struct AdbcError*);

 AdbcStatusCode (*ConnectionRelease)(struct AdbcConnection*, struct AdbcError*);

 AdbcStatusCode (*ConnectionRollback)(struct AdbcConnection*, struct AdbcError*);


 AdbcStatusCode (*StatementBind)(struct AdbcStatement*, struct ArrowArray*,

 struct ArrowSchema*, struct AdbcError*);

 AdbcStatusCode (*StatementBindStream)(struct AdbcStatement*, struct ArrowArrayStream*,

 struct AdbcError*);

 AdbcStatusCode (*StatementExecuteQuery)(struct AdbcStatement*, struct ArrowArrayStream*,

 int64_t*, struct AdbcError*);

 AdbcStatusCode (*StatementExecutePartitions)(struct AdbcStatement*, struct ArrowSchema*,

 struct AdbcPartitions*, int64_t*,

 struct AdbcError*);

 AdbcStatusCode (*StatementGetParameterSchema)(struct AdbcStatement*,

 struct ArrowSchema*, struct AdbcError*);

 AdbcStatusCode (*StatementNew)(struct AdbcConnection*, struct AdbcStatement*,

 struct AdbcError*);

 AdbcStatusCode (*StatementPrepare)(struct AdbcStatement*, struct AdbcError*);

 AdbcStatusCode (*StatementRelease)(struct AdbcStatement*, struct AdbcError*);

 AdbcStatusCode (*StatementSetOption)(struct AdbcStatement*, const char*, const char*,

 struct AdbcError*);

 AdbcStatusCode (*StatementSetSqlQuery)(struct AdbcStatement*, const char*,

 struct AdbcError*);

 AdbcStatusCode (*StatementSetSubstraitPlan)(struct AdbcStatement*, const uint8_t*,

 size_t, struct AdbcError*);


 struct AdbcErrorDetail (*ErrorGetDetail)(const struct AdbcError* error, int index);

 const struct AdbcError* (*ErrorFromArrayStream)(struct ArrowArrayStream* stream,

 AdbcStatusCode* status);


 AdbcStatusCode (*DatabaseGetOption)(struct AdbcDatabase*, const char*, char*, size_t*,

 struct AdbcError*);

 AdbcStatusCode (*DatabaseGetOptionBytes)(struct AdbcDatabase*, const char*, uint8_t*,

 size_t*, struct AdbcError*);

 AdbcStatusCode (*DatabaseGetOptionDouble)(struct AdbcDatabase*, const char*, double*,

 struct AdbcError*);

 AdbcStatusCode (*DatabaseGetOptionInt)(struct AdbcDatabase*, const char*, int64_t*,

 struct AdbcError*);

 AdbcStatusCode (*DatabaseSetOptionBytes)(struct AdbcDatabase*, const char*,

 const uint8_t*, size_t, struct AdbcError*);

 AdbcStatusCode (*DatabaseSetOptionDouble)(struct AdbcDatabase*, const char*, double,

 struct AdbcError*);

 AdbcStatusCode (*DatabaseSetOptionInt)(struct AdbcDatabase*, const char*, int64_t,

 struct AdbcError*);


 AdbcStatusCode (*ConnectionCancel)(struct AdbcConnection*, struct AdbcError*);

 AdbcStatusCode (*ConnectionGetOption)(struct AdbcConnection*, const char*, char*,

 size_t*, struct AdbcError*);

 AdbcStatusCode (*ConnectionGetOptionBytes)(struct AdbcConnection*, const char*,

 uint8_t*, size_t*, struct AdbcError*);

 AdbcStatusCode (*ConnectionGetOptionDouble)(struct AdbcConnection*, const char*,

 double*, struct AdbcError*);

 AdbcStatusCode (*ConnectionGetOptionInt)(struct AdbcConnection*, const char*, int64_t*,

 struct AdbcError*);

 AdbcStatusCode (*ConnectionGetStatistics)(struct AdbcConnection*, const char*,

 const char*, const char*, char,

 struct ArrowArrayStream*, struct AdbcError*);

 AdbcStatusCode (*ConnectionGetStatisticNames)(struct AdbcConnection*,

 struct ArrowArrayStream*,

 struct AdbcError*);

 AdbcStatusCode (*ConnectionSetOptionBytes)(struct AdbcConnection*, const char*,

 const uint8_t*, size_t, struct AdbcError*);

 AdbcStatusCode (*ConnectionSetOptionDouble)(struct AdbcConnection*, const char*, double,

 struct AdbcError*);

 AdbcStatusCode (*ConnectionSetOptionInt)(struct AdbcConnection*, const char*, int64_t,

 struct AdbcError*);


 AdbcStatusCode (*StatementCancel)(struct AdbcStatement*, struct AdbcError*);

 AdbcStatusCode (*StatementExecuteSchema)(struct AdbcStatement*, struct ArrowSchema*,

 struct AdbcError*);

 AdbcStatusCode (*StatementGetOption)(struct AdbcStatement*, const char*, char*, size_t*,

 struct AdbcError*);

 AdbcStatusCode (*StatementGetOptionBytes)(struct AdbcStatement*, const char*, uint8_t*,

 size_t*, struct AdbcError*);

 AdbcStatusCode (*StatementGetOptionDouble)(struct AdbcStatement*, const char*, double*,

 struct AdbcError*);

 AdbcStatusCode (*StatementGetOptionInt)(struct AdbcStatement*, const char*, int64_t*,

 struct AdbcError*);

 AdbcStatusCode (*StatementSetOptionBytes)(struct AdbcStatement*, const char*,

 const uint8_t*, size_t, struct AdbcError*);

 AdbcStatusCode (*StatementSetOptionDouble)(struct AdbcStatement*, const char*, double,

 struct AdbcError*);

 AdbcStatusCode (*StatementSetOptionInt)(struct AdbcStatement*, const char*, int64_t,

 struct AdbcError*);


};


#define ADBC_DRIVER_1_0_0_SIZE (offsetof(struct AdbcDriver, ErrorGetDetailCount))


#define ADBC_DRIVER_1_1_0_SIZE (sizeof(struct AdbcDriver))


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseNew(struct AdbcDatabase* database, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseGetOption(struct AdbcDatabase* database, const char* key,

 char* value, size_t* length,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseGetOptionBytes(struct AdbcDatabase* database, const char* key,

 uint8_t* value, size_t* length,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseGetOptionDouble(struct AdbcDatabase* database, const char* key,

 double* value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseGetOptionInt(struct AdbcDatabase* database, const char* key,

 int64_t* value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseSetOption(struct AdbcDatabase* database, const char* key,

 const char* value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseSetOptionBytes(struct AdbcDatabase* database, const char* key,

 const uint8_t* value, size_t length,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseSetOptionDouble(struct AdbcDatabase* database, const char* key,

 double value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseSetOptionInt(struct AdbcDatabase* database, const char* key,

 int64_t value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseInit(struct AdbcDatabase* database, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcDatabaseRelease(struct AdbcDatabase* database,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionNew(struct AdbcConnection* connection,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionSetOption(struct AdbcConnection* connection, const char* key,

 const char* value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionSetOptionBytes(struct AdbcConnection* connection,

 const char* key, const uint8_t* value,

 size_t length, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode  const char* key, int64_t value,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionSetOptionDouble(struct AdbcConnection* connection,

 const char* key, double value,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionInit(struct AdbcConnection* connection,

 struct AdbcDatabase* database, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionRelease(struct AdbcConnection* connection,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionCancel(struct AdbcConnection* connection,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection* connection,

 const uint32_t* info_codes, size_t info_codes_length,

 struct ArrowArrayStream* out,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetObjects(struct AdbcConnection* connection, int depth,

 const char* catalog, const char* db_schema,

 const char* table_name, const char** table_type,

 const char* column_name,

 struct ArrowArrayStream* out,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetOption(struct AdbcConnection* connection, const char* key,

 char* value, size_t* length,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetOptionBytes(struct AdbcConnection* connection,

 const char* key, uint8_t* value,

 size_t* length, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetOptionInt(struct AdbcConnection* connection,

 const char* key, int64_t* value,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetOptionDouble(struct AdbcConnection* connection,

 const char* key, double* value,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetStatistics(struct AdbcConnection* connection,

 const char* catalog, const char* db_schema,

 const char* table_name, char approximate,

 struct ArrowArrayStream* out,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode  struct ArrowArrayStream* out,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetTableSchema(struct AdbcConnection* connection,

 const char* catalog, const char* db_schema,

 const char* table_name,

 struct ArrowSchema* schema,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionGetTableTypes(struct AdbcConnection* connection,

 struct ArrowArrayStream* out,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionReadPartition(struct AdbcConnection* connection,

 const uint8_t* serialized_partition,

 size_t serialized_length,

 struct ArrowArrayStream* out,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionCommit(struct AdbcConnection* connection,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcConnectionRollback(struct AdbcConnection* connection,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementNew(struct AdbcConnection* connection,

 struct AdbcStatement* statement, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementRelease(struct AdbcStatement* statement,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementExecuteQuery(struct AdbcStatement* statement,

 struct ArrowArrayStream* out,

 int64_t* rows_affected, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementExecuteSchema(struct AdbcStatement* statement,

 struct ArrowSchema* schema,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementPrepare(struct AdbcStatement* statement,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementSetSqlQuery(struct AdbcStatement* statement,

 const char* query, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementSetSubstraitPlan(struct AdbcStatement* statement,

 const uint8_t* plan, size_t length,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementBind(struct AdbcStatement* statement,

 struct ArrowArray* values, struct ArrowSchema* schema,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementBindStream(struct AdbcStatement* statement,

 struct ArrowArrayStream* stream,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementCancel(struct AdbcStatement* statement,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementGetOption(struct AdbcStatement* statement, const char* key,

 char* value, size_t* length,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementGetOptionBytes(struct AdbcStatement* statement,

 const char* key, uint8_t* value,

 size_t* length, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementGetOptionInt(struct AdbcStatement* statement, const char* key,

 int64_t* value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementGetOptionDouble(struct AdbcStatement* statement,

 const char* key, double* value,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementGetParameterSchema(struct AdbcStatement* statement,

 struct ArrowSchema* schema,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementSetOption(struct AdbcStatement* statement, const char* key,

 const char* value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementSetOptionBytes(struct AdbcStatement* statement,

 const char* key, const uint8_t* value,

 size_t length, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementSetOptionInt(struct AdbcStatement* statement, const char* key,

 int64_t value, struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementSetOptionDouble(struct AdbcStatement* statement,

 const char* key, double value,

 struct AdbcError* error);


ADBC_EXPORT

AdbcStatusCode AdbcStatementExecutePartitions(struct AdbcStatement* statement,

 struct ArrowSchema* schema,

 struct AdbcPartitions* partitions,

 int64_t* rows_affected,

 struct AdbcError* error);


typedef AdbcStatusCode (*AdbcDriverInitFunc)(int version, void* driver,

 struct AdbcError* error);


#endif // ADBC


#ifdef __cplusplus

}

#endif

AdbcConnectionGetOptionBytes
AdbcStatusCode AdbcConnectionGetOptionBytes(struct AdbcConnection *connection, const char *key, uint8_t *value, size_t *length, struct AdbcError *error)
获取连接的字节串选项。

AdbcConnectionGetObjects
AdbcStatusCode AdbcConnectionGetObjects(struct AdbcConnection *connection, int depth, const char *catalog, const char *db_schema, const char *table_name, const char **table_type, const char *column_name, struct ArrowArrayStream *out, struct AdbcError *error)
获取所有目录、数据库模式、表和列的分层视图。

AdbcConnectionGetTableTypes
AdbcStatusCode AdbcConnectionGetTableTypes(struct AdbcConnection *connection, struct ArrowArrayStream *out, struct AdbcError *error)
获取数据库中表类型的列表。

AdbcConnectionGetStatisticNames
AdbcStatusCode AdbcConnectionGetStatisticNames(struct AdbcConnection *connection, struct ArrowArrayStream *out, struct AdbcError *error)
获取此驱动程序特有的统计信息的名称。

AdbcConnectionGetOptionInt
AdbcStatusCode AdbcConnectionGetOptionInt(struct AdbcConnection *connection, const char *key, int64_t *value, struct AdbcError *error)
获取连接的整数选项。

AdbcConnectionGetOptionDouble
AdbcStatusCode AdbcConnectionGetOptionDouble(struct AdbcConnection *connection, const char *key, double *value, struct AdbcError *error)
获取连接的双精度浮点数选项。

AdbcConnectionGetStatistics
AdbcStatusCode AdbcConnectionGetStatistics(struct AdbcConnection *connection, const char *catalog, const char *db_schema, const char *table_name, char approximate, struct ArrowArrayStream *out, struct AdbcError *error)
获取关于表的数据分布的统计信息。

AdbcConnectionGetOption
AdbcStatusCode AdbcConnectionGetOption(struct AdbcConnection *connection, const char *key, char *value, size_t *length, struct AdbcError *error)
获取连接的字符串选项。

AdbcConnectionGetInfo
AdbcStatusCode AdbcConnectionGetInfo(struct AdbcConnection *connection, const uint32_t *info_codes, size_t info_codes_length, struct ArrowArrayStream *out, struct AdbcError *error)
获取关于数据库/驱动程序的元数据。

AdbcConnectionGetTableSchema
AdbcStatusCode AdbcConnectionGetTableSchema(struct AdbcConnection *connection, const char *catalog, const char *db_schema, const char *table_name, struct ArrowSchema *schema, struct AdbcError *error)
获取表的 Arrow 模式。

AdbcConnectionReadPartition
AdbcStatusCode AdbcConnectionReadPartition(struct AdbcConnection *connection, const uint8_t *serialized_partition, size_t serialized_length, struct ArrowArrayStream *out, struct AdbcError *error)
为查询的分区构造一个语句。然后可以独立读取结果。

AdbcConnectionCommit
AdbcStatusCode AdbcConnectionCommit(struct AdbcConnection *connection, struct AdbcError *error)
提交任何挂起的事务。仅在禁用自动提交时使用。

AdbcConnectionRollback
AdbcStatusCode AdbcConnectionRollback(struct AdbcConnection *connection, struct AdbcError *error)
回滚任何挂起的事务。仅在禁用自动提交时使用。

AdbcConnection::private_data
void * private_data
不透明的、实现定义的状态。如果连接未初始化/已释放，则此字段为 NULLPTR。
定义 adbc.h:834

AdbcConnection::private_driver
struct AdbcDriver * private_driver
关联的驱动程序（由驱动程序管理器使用，以帮助跟踪状态）。
定义 adbc.h:837

AdbcConnectionSetOption
AdbcStatusCode AdbcConnectionSetOption(struct AdbcConnection *connection, const char *key, const char *value, struct AdbcError *error)
设置 char* 选项。

AdbcConnectionCancel
AdbcStatusCode AdbcConnectionCancel(struct AdbcConnection *connection, struct AdbcError *error)
取消连接上的正在进行的操作。

AdbcConnectionNew
AdbcStatusCode AdbcConnectionNew(struct AdbcConnection *connection, struct AdbcError *error)
分配一个新的（但未初始化的）连接。

AdbcConnectionSetOptionInt
AdbcStatusCode AdbcConnectionSetOptionInt(struct AdbcConnection *connection, const char *key, int64_t value, struct AdbcError *error)
设置整数选项。

AdbcConnectionSetOptionBytes
AdbcStatusCode AdbcConnectionSetOptionBytes(struct AdbcConnection *connection, const char *key, const uint8_t *value, size_t length, struct AdbcError *error)
在连接上设置字节串选项。

AdbcConnectionRelease
AdbcStatusCode AdbcConnectionRelease(struct AdbcConnection *connection, struct AdbcError *error)
销毁此连接。

AdbcConnectionInit
AdbcStatusCode AdbcConnectionInit(struct AdbcConnection *connection, struct AdbcDatabase *database, struct AdbcError *error)
完成设置选项并初始化连接。

AdbcConnectionSetOptionDouble
AdbcStatusCode AdbcConnectionSetOptionDouble(struct AdbcConnection *connection, const char *key, double value, struct AdbcError *error)
设置双精度浮点数选项。

AdbcConnection
一个活动的数据库连接。
定义 adbc.h:831

AdbcDatabase::private_data
void * private_data
不透明的、实现定义的状态。如果连接未初始化/已释放，则此字段为 NULLPTR。
定义 adbc.h:811

AdbcDatabase::private_driver
struct AdbcDriver * private_driver
关联的驱动程序（由驱动程序管理器使用，以帮助跟踪状态）。
定义 adbc.h:814

AdbcDatabaseSetOptionDouble
AdbcStatusCode AdbcDatabaseSetOptionDouble(struct AdbcDatabase *database, const char *key, double value, struct AdbcError *error)
在数据库上设置双精度浮点数选项。

AdbcDatabaseGetOptionBytes
AdbcStatusCode AdbcDatabaseGetOptionBytes(struct AdbcDatabase *database, const char *key, uint8_t *value, size_t *length, struct AdbcError *error)
获取数据库的字节串选项。

AdbcDatabaseGetOptionInt
AdbcStatusCode AdbcDatabaseGetOptionInt(struct AdbcDatabase *database, const char *key, int64_t *value, struct AdbcError *error)
获取数据库的整数选项。

AdbcDatabaseNew
AdbcStatusCode AdbcDatabaseNew(struct AdbcDatabase *database, struct AdbcError *error)
分配一个新的（但未初始化的）数据库。

AdbcDatabaseRelease
AdbcStatusCode AdbcDatabaseRelease(struct AdbcDatabase *database, struct AdbcError *error)
销毁此数据库。不得存在任何连接。

AdbcDatabaseInit
AdbcStatusCode AdbcDatabaseInit(struct AdbcDatabase *database, struct AdbcError *error)
完成设置选项并初始化数据库。

AdbcDatabaseGetOptionDouble
AdbcStatusCode AdbcDatabaseGetOptionDouble(struct AdbcDatabase *database, const char *key, double *value, struct AdbcError *error)
获取数据库的 double 选项。

AdbcDatabaseSetOption
AdbcStatusCode AdbcDatabaseSetOption(struct AdbcDatabase *database, const char *key, const char *value, struct AdbcError *error)
设置 char* 选项。

AdbcDatabaseGetOption
AdbcStatusCode AdbcDatabaseGetOption(struct AdbcDatabase *database, const char *key, char *value, size_t *length, struct AdbcError *error)
获取数据库的字符串选项。

AdbcDatabaseSetOptionInt
AdbcStatusCode AdbcDatabaseSetOptionInt(struct AdbcDatabase *database, const char *key, int64_t value, struct AdbcError *error)
在数据库上设置整数选项。

AdbcDatabaseSetOptionBytes
AdbcStatusCode AdbcDatabaseSetOptionBytes(struct AdbcDatabase *database, const char *key, const uint8_t *value, size_t length, struct AdbcError *error)
在数据库上设置字节串选项。

AdbcDatabase
数据库的实例。
定义 adbc.h:808

AdbcDriver::private_manager
void * private_manager
不透明的驱动程序管理器定义的状态。如果驱动程序未初始化/释放，则此字段为 NULL（但它...
定义 adbc.h:944

AdbcDriver::private_data
void * private_data
不透明的驱动程序定义的状态。如果驱动程序未初始化/释放，则此字段为 NULL（但它不必...）。
定义 adbc.h:940

AdbcDriverInitFunc
AdbcStatusCode(* AdbcDriverInitFunc)(int version, void *driver, struct AdbcError *error)
驱动程序通过驱动程序管理器的公共入口点（使用 dlopen(3)/LoadLibrary）。...
定义 adbc.h:2347

AdbcDriver
已初始化的数据库驱动程序的实例。
定义 adbc.h:936

AdbcError::vendor_code
int32_t vendor_code
供应商特定的错误代码（如果适用）。
定义 adbc.h:274

AdbcError::private_data
void * private_data
不透明的实现定义的状态。
定义 adbc.h:294

AdbcErrorDetail::key
const char * key
元数据键。
定义 adbc.h:352

AdbcError::message
char * message
错误消息。
定义 adbc.h:271

AdbcError::private_driver
struct AdbcDriver * private_driver
关联的驱动程序（由驱动程序管理器使用，以帮助跟踪状态）。
定义 adbc.h:303

AdbcErrorDetail::value_length
size_t value_length
元数据值的长度。
定义 adbc.h:356

AdbcErrorDetail::value
const uint8_t * value
二进制元数据值。
定义 adbc.h:354

AdbcErrorFromArrayStream
const struct AdbcError * AdbcErrorFromArrayStream(struct ArrowArrayStream *stream, AdbcStatusCode *status)
从驱动程序创建的 ArrowArrayStream 获取 ADBC 错误。

AdbcStatusCode
uint8_t AdbcStatusCode
可能失败的操作的错误代码。
定义 adbc.h:176

AdbcErrorGetDetailCount
int AdbcErrorGetDetailCount(const struct AdbcError *error)
获取错误中可用的元数据值的数量。

AdbcErrorGetDetail
struct AdbcErrorDetail AdbcErrorGetDetail(const struct AdbcError *error, int index)
按索引获取错误中的元数据值。

AdbcError
操作的详细错误消息。
定义 adbc.h:269

AdbcErrorDetail
错误的额外键值元数据。
定义 adbc.h:350

AdbcPartitions::partition_lengths
const size_t * partition_lengths
分区中每个对应条目的长度。
定义 adbc.h:907

AdbcPartitions::private_data
void * private_data
不透明的、实现定义的状态。如果连接未初始化/已释放，则此字段为 NULLPTR。
定义 adbc.h:911

AdbcPartitions::release
void(* release)(struct AdbcPartitions *partitions)
释放包含的分区。
定义 adbc.h:917

AdbcPartitions::num_partitions
size_t num_partitions
分区的数量。
定义 adbc.h:899

AdbcPartitions::partitions
const uint8_t ** partitions
结果集的分区，其中每个条目（最多 num_partitions 个条目）是不透明的标识符...
定义 adbc.h:904

AdbcStatementExecutePartitions
AdbcStatusCode AdbcStatementExecutePartitions(struct AdbcStatement *statement, struct ArrowSchema *schema, struct AdbcPartitions *partitions, int64_t *rows_affected, struct AdbcError *error)
执行语句并将结果作为分区结果集获取。

AdbcPartitions
分布式/分区结果集的分区。
定义 adbc.h:897

AdbcStatementSetSqlQuery
AdbcStatusCode AdbcStatementSetSqlQuery(struct AdbcStatement *statement, const char *query, struct AdbcError *error)
设置要执行的 SQL 查询。

AdbcStatementSetSubstraitPlan
AdbcStatusCode AdbcStatementSetSubstraitPlan(struct AdbcStatement *statement, const uint8_t *plan, size_t length, struct AdbcError *error)
设置要执行的 Substrait 计划。

AdbcStatement::private_data
void * private_data
不透明的、实现定义的状态。如果连接未初始化/已释放，则此字段为 NULLPTR。
定义 adbc.h:872

AdbcStatement::private_driver
struct AdbcDriver * private_driver
关联的驱动程序（由驱动程序管理器使用，以帮助跟踪状态）。
定义 adbc.h:876

AdbcStatementExecuteQuery
AdbcStatusCode AdbcStatementExecuteQuery(struct AdbcStatement *statement, struct ArrowArrayStream *out, int64_t *rows_affected, struct AdbcError *error)
执行语句并获取结果。

AdbcStatementCancel
AdbcStatusCode AdbcStatementCancel(struct AdbcStatement *statement, struct AdbcError *error)
取消正在进行的查询的执行。

AdbcStatementGetParameterSchema
AdbcStatusCode AdbcStatementGetParameterSchema(struct AdbcStatement *statement, struct ArrowSchema *schema, struct AdbcError *error)
获取绑定参数的模式。

AdbcStatementSetOptionInt
AdbcStatusCode AdbcStatementSetOptionInt(struct AdbcStatement *statement, const char *key, int64_t value, struct AdbcError *error)
在语句上设置整数选项。

AdbcStatementExecuteSchema
AdbcStatusCode AdbcStatementExecuteSchema(struct AdbcStatement *statement, struct ArrowSchema *schema, struct AdbcError *error)
在不执行查询的情况下获取查询的结果集的模式。

AdbcStatementRelease
AdbcStatusCode AdbcStatementRelease(struct AdbcStatement *statement, struct AdbcError *error)
销毁语句。

AdbcStatementSetOption
AdbcStatusCode AdbcStatementSetOption(struct AdbcStatement *statement, const char *key, const char *value, struct AdbcError *error)
在语句上设置字符串选项。

AdbcStatementPrepare
AdbcStatusCode AdbcStatementPrepare(struct AdbcStatement *statement, struct AdbcError *error)
将此语句转换为准备好的语句，以多次执行。

AdbcStatementGetOptionDouble
AdbcStatusCode AdbcStatementGetOptionDouble(struct AdbcStatement *statement, const char *key, double *value, struct AdbcError *error)
获取语句的 double 选项。

AdbcStatementSetOptionBytes
AdbcStatusCode AdbcStatementSetOptionBytes(struct AdbcStatement *statement, const char *key, const uint8_t *value, size_t length, struct AdbcError *error)
在语句上设置字节串选项。

AdbcStatementBindStream
AdbcStatusCode AdbcStatementBindStream(struct AdbcStatement *statement, struct ArrowArrayStream *stream, struct AdbcError *error)
绑定 Arrow 数据。这可用于批量插入或准备好的语句。

AdbcStatementBind
AdbcStatusCode AdbcStatementBind(struct AdbcStatement *statement, struct ArrowArray *values, struct ArrowSchema *schema, struct AdbcError *error)
绑定 Arrow 数据。这可用于批量插入或准备好的语句。

AdbcStatementGetOption
AdbcStatusCode AdbcStatementGetOption(struct AdbcStatement *statement, const char *key, char *value, size_t *length, struct AdbcError *error)
获取语句的字符串选项。

AdbcStatementGetOptionInt
AdbcStatusCode AdbcStatementGetOptionInt(struct AdbcStatement *statement, const char *key, int64_t *value, struct AdbcError *error)
获取语句的整数选项。

AdbcStatementNew
AdbcStatusCode AdbcStatementNew(struct AdbcConnection *connection, struct AdbcStatement *statement, struct AdbcError *error)
为给定的连接创建新语句。

AdbcStatementGetOptionBytes
AdbcStatusCode AdbcStatementGetOptionBytes(struct AdbcStatement *statement, const char *key, uint8_t *value, size_t *length, struct AdbcError *error)
获取语句的字节串选项。

AdbcStatementSetOptionDouble
AdbcStatusCode AdbcStatementSetOptionDouble(struct AdbcStatement *statement, const char *key, double value, struct AdbcError *error)
在语句上设置 double 选项。

AdbcStatement
执行数据库查询所需的所有状态的容器，例如查询本身，...
定义 adbc.h:869