C API

Author: Gazizonoki

.gitignore

@@ -52,6 +52,8 @@ __pycache__/
 
 .idea/
 .vscode/
+.cursor/
+.cursorrules
 
 # KDevelop IDE
 *.kdev4

CMakeLists.txt

@@ -5,7 +5,7 @@ string(REGEX MATCH "YDB_SDK_VERSION = \"([0-9]+\\.[0-9]+\\.[0-9]+)\"" _ ${YDB_SD
 set(YDB_SDK_VERSION ${CMAKE_MATCH_1})
 message(STATUS "YDB С++ SDK version: ${YDB_SDK_VERSION}")
 
-project(YDB-CPP-SDK VERSION ${YDB_SDK_VERSION} LANGUAGES C CXX ASM)
+project(ydb-cpp-sdk VERSION ${YDB_SDK_VERSION} LANGUAGES C CXX ASM)
 
 option(YDB_SDK_INSTALL "Install YDB C++ SDK" Off)
 option(YDB_SDK_TESTS "Build YDB C++ SDK tests" Off)
@@ -60,11 +60,12 @@ add_subdirectory(library/cpp)
 add_subdirectory(include/ydb-cpp-sdk/client)
 add_subdirectory(src)
 add_subdirectory(util)
+add_subdirectory(c_api)
 
 #_ydb_sdk_validate_public_headers()
 
 if (YDB_SDK_ODBC)
-  add_subdirectory(odbc)
+  #add_subdirectory(odbc)
 endif()
 
 if (YDB_SDK_EXAMPLES)
@@ -80,7 +81,7 @@ if (YDB_SDK_INSTALL)
   install(EXPORT ydb-cpp-sdk-targets
     FILE ydb-cpp-sdk-targets.cmake
     CONFIGURATIONS RELEASE
-    NAMESPACE YDB-CPP-SDK::
+    NAMESPACE ydb-cpp-sdk::
     DESTINATION ${CMAKE_INSTALL_LIBDIR}/cmake/ydb-cpp-sdk/release
   )
   configure_package_config_file(

c_api/CMakeLists.txt

@@ -0,0 +1,18 @@
+add_library(ydb-c-api STATIC
+  src/driver.cpp
+  src/query.cpp
+  src/result.cpp
+  src/value.cpp
+)
+
+target_include_directories(ydb-c-api PUBLIC include)
+
+target_link_libraries(ydb-c-api
+  PRIVATE
+    yutil
+    ydb-cpp-sdk::Query
+    ydb-cpp-sdk::Table
+    ydb-cpp-sdk::Driver
+)
+
+add_library(ydb-cpp-sdk::c-api ALIAS ydb-c-api)

c_api/README.md

@@ -0,0 +1,51 @@
+Синхронный API	Асинхронный API
+
+libpq: 
+```c
+PGconn *conn = PQconnectdb("...");
+// Блокирует выполнение до завершения
+```
+
+libpq: 
+```c
+PGconn *conn = PQconnectStart("...");
+do {
+    pollstatus = PQconnectPoll(conn);
+    // Ожидание событий
+} while (pollstatus != PGRES_POLLING_OK);
+```
+
+MySQL: 
+<br>MYSQL *conn = mysql_init(NULL);
+<br>mysql_real_connect(conn, ...);	
+
+MySQL: 
+<br>status = mysql_real_connect_nonblocking(mysql, ...);
+<br>while (status == NET_ASYNC_NOT_READY) {
+    <br>  // Обработка других задач<br>  
+    status = mysql_real_connect_nonblocking(...);<br>
+}
+
+Выполнение запросов
+
+Синхронный API	Асинхронный API
+
+libpq: <br>PGresult *res = PQexec(conn, "SELECT ...");<br>Ожидает завершения выполнения	
+
+libpq: <br>PQsendQuery(conn, "SELECT ...");<br>// Можно выполнять другую работу<br>while ((res = PQgetResult(conn)) != NULL) {<br>  // Обработка результатов<br>}
+
+MySQL: <br>mysql_query(conn, "SELECT ...");<br>result = mysql_store_result(conn);	
+
+MySQL: <br>status = mysql_real_query_nonblocking(mysql, "...");<br>// Проверка status и ожидание<br>status = mysql_store_result_nonblocking(mysql, &result);
+
+Обработка ошибок
+
+Синхронный API	Асинхронный API
+
+libpq: <br>if (PQstatus(conn) != CONNECTION_OK) {<br>  fprintf(stderr, "%s", PQerrorMessage(conn));<br>}	
+
+libpq: <br>Такая же проверка, но в каждом шаге асинхронного процесса:<br>if (pollstatus == PGRES_POLLING_FAILED) {<br>  fprintf(stderr, "%s", PQerrorMessage(conn));<br>}
+
+MySQL: <br>if (mysql_query(conn, query)) {<br>  fprintf(stderr, "%s", mysql_error(conn));<br>}	
+
+MySQL: <br>if (status == NET_ASYNC_ERROR) {<br>  fprintf(stderr, "%s", mysql_error(mysql));<br>}

c_api/include/ydb-cpp-sdk/c_api/driver.h

@@ -0,0 +1,47 @@
+#pragma once
+
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct TYdbDriverConfigImpl TYdbDriverConfig;
+typedef struct TYdbDriverImpl TYdbDriver;
+
+typedef enum {
+    YDB_DRIVER_CONFIG_OK,
+    YDB_DRIVER_CONFIG_INVALID,
+} EYdbDriverConfigStatus;
+
+typedef enum {
+    YDB_DRIVER_OK,
+    YDB_DRIVER_ERROR,
+} EYdbDriverStatus;
+
+// Создание и уничтожение конфигурации
+TYdbDriverConfig* YdbCreateDriverConfig(const char* connectionString);
+void YdbDestroyDriverConfig(TYdbDriverConfig* config);
+
+// Установка параметров конфигурации
+TYdbDriverConfig* YdbSetEndpoint(TYdbDriverConfig* config, const char* endpoint);
+TYdbDriverConfig* YdbSetDatabase(TYdbDriverConfig* config, const char* database);
+TYdbDriverConfig* YdbSetAuthToken(TYdbDriverConfig* config, const char* token);
+TYdbDriverConfig* YdbSetSecureConnection(TYdbDriverConfig* config, const char* cert);
+
+// Получение результата конфигурации
+EYdbDriverConfigStatus YdbGetDriverConfigStatus(TYdbDriverConfig* config);
+const char* YdbGetDriverConfigErrorMessage(TYdbDriverConfig* config);
+
+// Создание и уничтожение драйвера
+TYdbDriver* YdbCreateDriver(const char* connectionString);
+TYdbDriver* YdbCreateDriverFromConfig(TYdbDriverConfig* config);
+void YdbDestroyDriver(TYdbDriver* driver);
+
+// Получение результата драйвера
+EYdbDriverStatus YdbGetDriverStatus(TYdbDriver* driver);
+const char* YdbGetDriverErrorMessage(TYdbDriver* driver);
+
+#ifdef __cplusplus
+}
+#endif

c_api/include/ydb-cpp-sdk/c_api/query.h

@@ -0,0 +1,39 @@
+#pragma once
+
+#include <stddef.h>
+
+#include "driver.h"
+#include "result.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct TYdbQueryClientImpl TYdbQueryClient;
+typedef struct TYdbQueryResultImpl TYdbQueryResult;
+
+typedef enum {
+    YDB_QUERY_CLIENT_OK,
+    YDB_QUERY_CLIENT_ERROR,
+} EYdbQueryClientError;
+
+typedef enum {
+    YDB_QUERY_RESULT_OK,
+    YDB_QUERY_RESULT_ERROR,
+} EYdbQueryResultError;
+
+// Создание и уничтожение клиента запросов
+TYdbQueryClient* YdbCreateQueryClient(TYdbDriver* driver);
+void YdbDestroyQueryClient(TYdbQueryClient* queryClient);
+
+// Выполнение запроса
+TYdbQueryResult* YdbExecuteQuery(TYdbQueryClient* queryClient, const char* query);
+void YdbDestroyQueryResult(TYdbQueryResult* result);
+
+// Получение результата запроса
+int YdbGetQueryResultSetsCount(TYdbQueryResult* result);
+TYdbResultSet* YdbGetQueryResultSet(TYdbQueryResult* result, size_t index);
+
+#ifdef __cplusplus
+}
+#endif

c_api/include/ydb-cpp-sdk/c_api/result.h

@@ -0,0 +1,32 @@
+#pragma once
+
+#include "value.h"
+
+#include <stddef.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct TYdbResultSetImpl TYdbResultSet;
+
+typedef enum {
+    YDB_RESULT_SET_OK,
+    YDB_RESULT_SET_ERROR,
+} EYdbResultSetStatus;
+
+int YdbGetColumnsCount(TYdbResultSet* resultSet);
+int YdbGetRowsCount(TYdbResultSet* resultSet);
+int YdbIsTruncated(TYdbResultSet* resultSet);
+
+const char* YdbGetColumnName(TYdbResultSet* resultSet, size_t index);
+int YdbGetColumnIndex(TYdbResultSet* resultSet, const char* name);
+
+TYdbValue* YdbGetValue(TYdbResultSet* resultSet, size_t rowIndex, const char* name);
+TYdbValue* YdbGetValueByIndex(TYdbResultSet* resultSet, size_t rowIndex, size_t columnIndex);
+
+void YdbDestroyResultSet(TYdbResultSet* resultSet);
+
+#ifdef __cplusplus
+}
+#endif

c_api/include/ydb-cpp-sdk/c_api/value.h

@@ -0,0 +1,75 @@
+#pragma once
+
+#include <stdint.h>
+#include <stdbool.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+typedef struct TYdbValueImpl TYdbValue;
+typedef struct TYdbParamsImpl TYdbParams;
+
+typedef enum {
+    YDB_VALUE_OK,
+    YDB_VALUE_ERROR,
+} EYdbValueStatus;
+
+typedef enum {
+    YDB_TYPE_KIND_UNDEFINED,
+    YDB_TYPE_KIND_PRIMITIVE,
+    YDB_TYPE_KIND_OPTIONAL,
+    YDB_TYPE_KIND_LIST,
+    YDB_TYPE_KIND_TUPLE,
+    YDB_TYPE_KIND_STRUCT,
+    YDB_TYPE_KIND_DICT,
+    YDB_TYPE_KIND_VARIANT,
+} EYdbTypeKind;
+
+typedef enum {
+    YDB_PRIMITIVE_TYPE_UNDEFINED,
+    YDB_PRIMITIVE_TYPE_BOOL,
+    YDB_PRIMITIVE_TYPE_INT8,
+    YDB_PRIMITIVE_TYPE_UINT8,
+    YDB_PRIMITIVE_TYPE_INT16,
+    YDB_PRIMITIVE_TYPE_UINT16,
+    YDB_PRIMITIVE_TYPE_INT32,
+    YDB_PRIMITIVE_TYPE_UINT32,
+    YDB_PRIMITIVE_TYPE_INT64,
+    YDB_PRIMITIVE_TYPE_UINT64,
+    YDB_PRIMITIVE_TYPE_FLOAT,
+    YDB_PRIMITIVE_TYPE_DOUBLE,
+    YDB_PRIMITIVE_TYPE_STRING,
+    YDB_PRIMITIVE_TYPE_UTF8,
+    YDB_PRIMITIVE_TYPE_YSON,
+    YDB_PRIMITIVE_TYPE_JSON,
+    YDB_PRIMITIVE_TYPE_JSON_DOCUMENT,
+    YDB_PRIMITIVE_TYPE_DYNUMBER,
+} EYdbPrimitiveType;
+
+EYdbTypeKind YdbGetTypeKind(TYdbValue* value);
+EYdbPrimitiveType YdbGetPrimitiveType(TYdbValue* value);
+
+EYdbValueStatus YdbGetBool(TYdbValue* value, bool* result);
+EYdbValueStatus YdbGetInt8(TYdbValue* value, int8_t* result);
+EYdbValueStatus YdbGetUint8(TYdbValue* value, uint8_t* result);
+EYdbValueStatus YdbGetInt16(TYdbValue* value, int16_t* result);
+EYdbValueStatus YdbGetUint16(TYdbValue* value, uint16_t* result);
+EYdbValueStatus YdbGetInt32(TYdbValue* value, int32_t* result);
+EYdbValueStatus YdbGetUint32(TYdbValue* value, uint32_t* result);
+EYdbValueStatus YdbGetInt64(TYdbValue* value, int64_t* result);
+EYdbValueStatus YdbGetUint64(TYdbValue* value, uint64_t* result);
+EYdbValueStatus YdbGetFloat(TYdbValue* value, float* result);
+EYdbValueStatus YdbGetDouble(TYdbValue* value, double* result);
+EYdbValueStatus YdbGetString(TYdbValue* value, char** result);
+EYdbValueStatus YdbGetUtf8(TYdbValue* value, char** result);
+EYdbValueStatus YdbGetYson(TYdbValue* value, char** result);
+EYdbValueStatus YdbGetJson(TYdbValue* value, char** result);
+EYdbValueStatus YdbGetJsonDocument(TYdbValue* value, char** result);
+EYdbValueStatus YdbGetDyNumber(TYdbValue* value, char** result);
+
+void YdbDestroyValue(TYdbValue* value);
+
+#ifdef __cplusplus
+}
+#endif