C APIs¶
APIs List¶
| API | Description | |
|---|---|---|
| xdb_conn_t* | xdb_open (const char *path) | Open a connection |
| void | xdb_close (xdb_conn_t *pConn) | Close a connection |
| xdb_res_t* | xdb_exec (xdb_conn_t* pConn, const char *sql) | Execute SQL statement |
| xdb_res_t* | xdb_next_result (xdb_conn_t *pConn) | Get next SQL statement result |
| bool | xdb_more_result (xdb_conn_t* pRes) | Check is there more result |
| void | xdb_free_result (xdb_res_t* pRes) | Free result set |
| xdb_col_t* | xdb_column_meta (uint64_t meta, uint16_t iCol) | Get column meta |
| xdb_type_t | xdb_column_type (uint64_t meta, uint16_t iCol) | Get column type |
| const char* | xdb_column_name (uint64_t meta, uint16_t iCol) | Get column name |
| xdb_row_t* | xdb_fetch_row (xdb_res_t* pRes) | Fetch one row |
| int | xdb_column_int (uint64_t meta, void *pRow, uint16_t iCol) | Get int column from row |
| float | xdb_column_float (uint64_t meta, void *pRow, uint16_t iCol) | Get float/double column from row |
| const char * | xdb_column_str (uint64_t meta, void *pRow, uint16_t iCol) | Get string column from row |
| xdb_stmt_t* | xdb_stmt_prepare (xdb_conn_t* pConn, const char *sql) | Prepare statement |
| xdb_ret | xdb_bind_int (xdb_stmt_t *pStmt, uint16_t para_id, int val) | Bind int value |
| xdb_ret | xdb_bind_float (xdb_stmt_t *pStmt, uint16_t para_id, float val) | Bind float value |
| xdb_ret | xdb_bind_str (xdb_stmt_t *pStmt, uint16_t para_id, const char *str) | Bind string value |
| xdb_ret | xdb_clear_bindings (xdb_stmt_t *pStmt) | Clear bindings |
| xdb_res_t* | xdb_stmt_exec (xdb_stmt_t *pStmt) | Execute prepared SQL statement |
| void | xdb_stmt_close (xdb_stmt_t *pStmt) | Free prepared SQL statement |
| xdb_ret | xdb_begin (xdb_conn_t* pConn) | Begin transaction |
| xdb_ret | xdb_commit (xdb_conn_t* pConn) | Commit transaction |
| xdb_ret | xdb_rollback (xdb_conn_t* pConn) | Rollback transaction |
| const char * | xdb_type2str (xdb_type_t type) | Get data type string |
| const char * | xdb_errmsg (xdb_res_t *pRes) | Get error/information message |
| int | xdb_print_row (uint64_t meta, void *pRow, int format) | Print row to console |
| const char * | xdb_version () | Get CrossDB version string |
xdb_open¶
Open a connection and create/open a Database.
xdb_conn_t*
+ C APIs - CrossDB C APIs¶
APIs List¶
API Description xdb_conn_t* xdb_open (const char *path) Open a connection void xdb_close (xdb_conn_t *pConn) Close a connection xdb_res_t* xdb_exec (xdb_conn_t* pConn, const char *sql) Execute SQL statement xdb_res_t* xdb_next_result (xdb_conn_t *pConn) Get next SQL statement result bool xdb_more_result (xdb_conn_t* pRes) Check is there more result void xdb_free_result (xdb_res_t* pRes) Free result set xdb_col_t* xdb_column_meta (uint64_t meta, uint16_t iCol) Get column meta xdb_type_t xdb_column_type (uint64_t meta, uint16_t iCol) Get column type const char* xdb_column_name (uint64_t meta, uint16_t iCol) Get column name xdb_row_t* xdb_fetch_row (xdb_res_t* pRes) Fetch one row int xdb_column_int (uint64_t meta, void *pRow, uint16_t iCol) Get int column from row float xdb_column_float (uint64_t meta, void *pRow, uint16_t iCol) Get float/double column from row const char * xdb_column_str (uint64_t meta, void *pRow, uint16_t iCol) Get string column from row const void * xdb_column_blob (uint64_t meta, xdb_row_t *pRow, uint16_t iCol, int *pLen) Get binary column from row xdb_stmt_t* xdb_stmt_prepare (xdb_conn_t* pConn, const char *sql) Prepare statement xdb_ret xdb_bind_int (xdb_stmt_t *pStmt, uint16_t para_id, int val) Bind int value xdb_ret xdb_bind_float (xdb_stmt_t *pStmt, uint16_t para_id, float val) Bind float value xdb_ret xdb_bind_str (xdb_stmt_t *pStmt, uint16_t para_id, const char *str) Bind string value xdb_ret xdb_clear_bindings (xdb_stmt_t *pStmt) Clear bindings xdb_res_t* xdb_stmt_exec (xdb_stmt_t *pStmt) Execute prepared SQL statement void xdb_stmt_close (xdb_stmt_t *pStmt) Free prepared SQL statement xdb_ret xdb_begin (xdb_conn_t* pConn) Begin transaction xdb_ret xdb_commit (xdb_conn_t* pConn) Commit transaction xdb_ret xdb_rollback (xdb_conn_t* pConn) Rollback transaction const char * xdb_type2str (xdb_type_t type) Get data type string const char * xdb_errmsg (xdb_res_t *pRes) Get error/information message int xdb_print_row (uint64_t meta, void *pRow, int format) Print row to console const char * xdb_version () Get CrossDB version string
xdb_open¶
Open a connection and create/open a Database.
xdb_conn_t*
xdb_open (const char *path);
// TBD
@@ -51,136 +51,138 @@
const char*
xdb_column_str2 (uint64_t meta, xdb_row_t *pRow, uint16_t iCol, int *pLen);
-
Note
You can access the pointer directly: *(const char*)pVal[iCol], get the length *(uint16_t*)(pVal[iCol]-2)
xdb_stmt_prepare¶
xdb_bind_int¶
Binds an int value to the prepared statement at the specified parameter index (from 1).
xdb_ret
-xdb_bind_int (xdb_stmt_t *pStmt, uint16_t para_id, int val);
-
-xdb_ret
-xdb_bind_int64 (xdb_stmt_t *pStmt, uint16_t para_id, int64_t val);
-
xdb_bind_float¶
Binds a double value to the prepared statement at the specified parameter index (from 1).
Note
You can access the pointer directly: *(const char*)pVal[iCol], get the length *(uint16_t*)(pVal[iCol]-2)
xdb_column_blob¶
Get blob column from row.
Note
You can access the pointer directly: *(const char*)pVal[iCol], get the length *(uint16_t*)(pVal[iCol]-2)
xdb_stmt_prepare¶
xdb_bind_int¶
Binds an int value to the prepared statement at the specified parameter index (from 1).
xdb_ret
+xdb_bind_int (xdb_stmt_t *pStmt, uint16_t para_id, int val);
xdb_ret
-xdb_bind_double (xdb_stmt_t *pStmt, uint16_t para_id, double val)
-
xdb_bind_str¶
Binds a string value to the prepared statement at the specified parameter index (from 1).
xdb_ret
-xdb_bind_str (xdb_stmt_t *pStmt, uint16_t id, const char *str, int len);
+xdb_bind_int64 (xdb_stmt_t *pStmt, uint16_t para_id, int64_t val);
+
xdb_bind_float¶
Binds a double value to the prepared statement at the specified parameter index (from 1).
xdb_ret
+xdb_bind_float (xdb_stmt_t *pStmt, uint16_t para_id, float val);
xdb_ret
-xdb_bind_str2 (xdb_stmt_t *pStmt, uint16_t para_id, const char *str, int len)
-
xdb_clear_bindings¶
Clear bindings.
Note
If you bind all args, don't need to call this APIs.
xdb_stmt_exec¶
Execute a prepared statement.
// use binding APIs first then execute
-xdb_res_t*
-xdb_stmt_exec (xdb_stmt_t *pStmt);
-
-// bind args then execute
-xdb_res_t*
-xdb_stmt_bexec (xdb_stmt_t *pStmt, ...);
-
-xdb_res_t*
-xdb_stmt_vbexec (xdb_stmt_t *pStmt, va_list ap);
-
Result refers xdb_exec
xdb_stmt_close¶
Close a prepared statement.
xdb_begin¶
Begin a transaction.
- For embedded local connection, always return
XDB_OK.
xdb_commit¶
Commit a transaction.
- For embedded local connection, always return
XDB_OK.
xdb_rollback¶
Rollback a transaction.
- For embedded local connection, always return
XDB_OK.
xdb_type2str¶
Get data type string.
xdb_errmsg¶
Get error/information message in result.
xdb_print_row¶
Print row to console.
xdb_version¶
Get CrossDB version string.
Types¶
xdb_errno_e¶
Error Code
typedef enum {
- XDB_OK,
- XDB_ERROR,
- XDB_E_PARAM,
- XDB_E_STMT,
- XDB_E_NODB,
- XDB_E_NOTFOUND,
- XDB_E_EXISTS,
- XDB_E_FULL,
- XDB_E_CONSTRAINT,
- XDB_E_AUTH,
- XDB_E_MEMORY,
- XDB_E_FILE,
- XDB_E_SOCK,
-} xdb_errno_e;
-
xdb_type_t¶
Data Types
typedef enum {
- XDB_TYPE_NULL = 0, // 1 bit
- XDB_TYPE_TINYINT = 1, // 1 byte
- XDB_TYPE_SMALLINT = 2, // 2 bytes
- XDB_TYPE_INT = 3, // 4 bytes
- XDB_TYPE_BIGINT = 4, // 8 bytes
- XDB_TYPE_UTINYINT = 5, // 1 byte
- XDB_TYPE_USMALLINT = 6, // 2 bytes
- XDB_TYPE_UINT = 7, // 4 bytes
- XDB_TYPE_UBIGINT = 8, // 8 bytes
- XDB_TYPE_FLOAT = 9, // 4 bytes
- XDB_TYPE_DOUBLE = 10, // 8 bytes
- XDB_TYPE_TIMESTAMP = 11, // 8 bytes
- XDB_TYPE_CHAR = 12, // fixed-length string(at most 65535 byte)
- XDB_TYPE_BINARY = 13, // fixed-length binary(at most 65535 byte)
- XDB_TYPE_VCHAR = 14, // varied-length string(at most 65535 byte)
- XDB_TYPE_VBINARY = 15, // varied-length binary(at most 65535 byte)
- XDB_TYPE_MAX = 21
-} xdb_type_t;
-
Structures¶
xdb_res_t¶
Result Set
typedef struct xdb_res_t {
- uint32_t len_type; // MSB 4bit are type xdb_restype_t
- uint16_t errcode; // 4
- uint16_t status; // 6 xdb_status_t
-
- uint32_t meta_len; // 8
- uint16_t col_count; // 12
- uint8_t stmt_type; // 14 SQL type(create/delete/drop/show/select/delete/update...)
- uint8_t rsvd;
-
- uint64_t row_count; // 2*8 SELECT/SHOW
- uint64_t affected_rows; // 3*8 INSERT/UPDATE/DELETE
- uint64_t insert_id; // 4*8 INSERT
- uint64_t col_meta; // 5*8 xdb_meta_t, <ptr:ptr off: 0 following is meta>
- uint64_t row_data; // 6*8 xdb_rowlist_t, ptr: base ptr or error str or information xdb_msg_t
- uint64_t data_len; // 7*8
-} xdb_res_t;
-
xdb_msg_t¶
Return Message
typedef struct {
- uint32_t len_type; // LSB 4bit are type
- uint16_t len;
- char msg[];
-} xdb_msg_t;
-
xdb_meta_t¶
Query Meta information
xdb_bind_str¶
Binds a string value to the prepared statement at the specified parameter index (from 1).
xdb_ret
+xdb_bind_str (xdb_stmt_t *pStmt, uint16_t id, const char *str, int len);
+
+xdb_ret
+xdb_bind_str2 (xdb_stmt_t *pStmt, uint16_t para_id, const char *str, int len)
+
xdb_clear_bindings¶
Clear bindings.
Note
If you bind all args, don't need to call this APIs.
xdb_stmt_exec¶
Execute a prepared statement.
// use binding APIs first then execute
+xdb_res_t*
+xdb_stmt_exec (xdb_stmt_t *pStmt);
+
+// bind args then execute
+xdb_res_t*
+xdb_stmt_bexec (xdb_stmt_t *pStmt, ...);
+
+xdb_res_t*
+xdb_stmt_vbexec (xdb_stmt_t *pStmt, va_list ap);
+
Result refers xdb_exec
xdb_stmt_close¶
Close a prepared statement.
xdb_begin¶
Begin a transaction.
- For embedded local connection, always return
XDB_OK.
xdb_commit¶
Commit a transaction.
- For embedded local connection, always return
XDB_OK.
xdb_rollback¶
Rollback a transaction.
- For embedded local connection, always return
XDB_OK.
xdb_type2str¶
Get data type string.
xdb_errmsg¶
Get error/information message in result.
xdb_print_row¶
Print row to console.
xdb_version¶
Get CrossDB version string.
Types¶
xdb_errno_e¶
Error Code
typedef enum {
+ XDB_OK,
+ XDB_ERROR,
+ XDB_E_PARAM,
+ XDB_E_STMT,
+ XDB_E_NODB,
+ XDB_E_NOTFOUND,
+ XDB_E_EXISTS,
+ XDB_E_FULL,
+ XDB_E_CONSTRAINT,
+ XDB_E_AUTH,
+ XDB_E_MEMORY,
+ XDB_E_FILE,
+ XDB_E_SOCK,
+} xdb_errno_e;
+
xdb_type_t¶
Data Types
typedef enum {
+ XDB_TYPE_NULL = 0, // 1 bit
+ XDB_TYPE_TINYINT = 1, // 1 byte
+ XDB_TYPE_SMALLINT = 2, // 2 bytes
+ XDB_TYPE_INT = 3, // 4 bytes
+ XDB_TYPE_BIGINT = 4, // 8 bytes
+ XDB_TYPE_UTINYINT = 5, // 1 byte
+ XDB_TYPE_USMALLINT = 6, // 2 bytes
+ XDB_TYPE_UINT = 7, // 4 bytes
+ XDB_TYPE_UBIGINT = 8, // 8 bytes
+ XDB_TYPE_FLOAT = 9, // 4 bytes
+ XDB_TYPE_DOUBLE = 10, // 8 bytes
+ XDB_TYPE_TIMESTAMP = 11, // 8 bytes
+ XDB_TYPE_CHAR = 12, // fixed-length string(at most 65535 byte)
+ XDB_TYPE_BINARY = 13, // fixed-length binary(at most 65535 byte)
+ XDB_TYPE_VCHAR = 14, // varied-length string(at most 65535 byte)
+ XDB_TYPE_VBINARY = 15, // varied-length binary(at most 65535 byte)
+ XDB_TYPE_MAX = 21
+} xdb_type_t;
+
Structures¶
xdb_res_t¶
Result Set
typedef struct xdb_res_t {
+ uint32_t len_type; // MSB 4bit are type xdb_restype_t
+ uint16_t errcode; // 4
+ uint16_t status; // 6 xdb_status_t
+
+ uint32_t meta_len; // 8
+ uint16_t col_count; // 12
+ uint8_t stmt_type; // 14 SQL type(create/delete/drop/show/select/delete/update...)
+ uint8_t rsvd;
+
+ uint64_t row_count; // 2*8 SELECT/SHOW
+ uint64_t affected_rows; // 3*8 INSERT/UPDATE/DELETE
+ uint64_t insert_id; // 4*8 INSERT
+ uint64_t col_meta; // 5*8 xdb_meta_t, <ptr:ptr off: 0 following is meta>
+ uint64_t row_data; // 6*8 xdb_rowlist_t, ptr: base ptr or error str or information xdb_msg_t
+ uint64_t data_len; // 7*8
+} xdb_res_t;
+
xdb_msg_t¶
Return Message
typedef struct {
uint32_t len_type; // LSB 4bit are type
- uint16_t col_count; // 3*4
- uint16_t null_off; // 3*4+2
- uint16_t row_size;
- uint16_t rsvd;
- uint64_t col_list; // xdb_col_t list
- xdb_col_t cols[];
-} xdb_meta_t;
-
xdb_col_t¶
Query Column information
typedef struct {
- uint16_t col_len; // colum total len
- uint8_t col_type; // xdb_type_t
- uint8_t col_rsvd;
- uint32_t col_off;
- uint16_t col_rsvd2;
- uint8_t col_nmlen;
- char col_name[];
-} xdb_col_t;
-
xdb_rowdat_t¶
Query row data information
xdb_rowlist_t¶
typedef uint64_t xdb_row_t; // xdb_rowdat_t
-
-typedef struct {
- uint32_t rl_count;
- uint32_t rl_curid;
- xdb_row_t rl_pRows[];
-} xdb_rowlist_t;
+ uint16_t len;
+ char msg[];
+} xdb_msg_t;
+
xdb_meta_t¶
Query Meta information
typedef struct {
+ uint32_t len_type; // LSB 4bit are type
+ uint16_t col_count; // 3*4
+ uint16_t null_off; // 3*4+2
+ uint16_t row_size;
+ uint16_t rsvd;
+ uint64_t col_list; // xdb_col_t list
+ xdb_col_t cols[];
+} xdb_meta_t;
+
xdb_col_t¶
Query Column information
typedef struct {
+ uint16_t col_len; // colum total len
+ uint8_t col_type; // xdb_type_t
+ uint8_t col_rsvd;
+ uint32_t col_off;
+ uint16_t col_rsvd2;
+ uint8_t col_nmlen;
+ char col_name[];
+} xdb_col_t;
+
xdb_rowdat_t¶
Query row data information
xdb_rowlist_t¶
typedef uint64_t xdb_row_t; // xdb_rowdat_t
+
+typedef struct {
+ uint32_t rl_count;
+ uint32_t rl_curid;
+ xdb_row_t rl_pRows[];
+} xdb_rowlist_t;
Comments
CrossDB Data Types¶
Type Bytes Description Note BOOL 1 Bool, the value range is {true, false}. TBD TINYINT 1 Single-byte integer, the value range is [-128, 127]. SMALLINT 2 Short integer, the value range is [-32768, 32767]. INT 4 Integer, the value range is [-2^31, 2^31-1]. BIGINT 8 Long integer, the value range is [-2^63, 2^63-1]. TINYINT UNSIGNED 1 unsigned single-byte integer, the value range is [0, 255]. TBD SMALLINT UNSIGNED 2 unsigned integer, the value range is [0, 65535]. TBD INT UNSIGNED 4 Unsigned integer, the value range is [0, 2^32-1]. TBD BIGINT UNSIGNED 8 unsigned long integer, the value range is [0, 2^64-1]. TBD TIMESTAMP 8 Default precision is microsecond. TBD FLOAT 4 Floating point number. DOUBLE 8 Double precision floating point number. CHAR [COLLATE collation_name] User-defined, max 65535 Fixed-length UTF-8 string. VARCHAR [COLLATE collation_name] User-defined, max 65535 Variable-Length UTF-8 string. BINARY User-defined, max 65535 Fixed-length binary data. TBD VARBINARY User-defined, max 65535 Variable-Length binary data. TBD
Collation¶
Type Description NOCASE Case insensitive [Default]. BINARY Case sensitive.
Escape Characters¶
Escape Character Actual Meaning \n Line Break \r Carriage Return \t tab \' Single quote ' \" Double quote " ` backtick ` \ Back Slash \ \% % see below for details _ _ see below for details
Comments
Data Types¶
Type Bytes Description Note BOOL 1 Bool, the value range is {true, false}. TBD TINYINT 1 Single-byte integer, the value range is [-128, 127]. SMALLINT 2 Short integer, the value range is [-32768, 32767]. INT 4 Integer, the value range is [-2^31, 2^31-1]. BIGINT 8 Long integer, the value range is [-2^63, 2^63-1]. TINYINT UNSIGNED 1 unsigned single-byte integer, the value range is [0, 255]. TBD SMALLINT UNSIGNED 2 unsigned integer, the value range is [0, 65535]. TBD INT UNSIGNED 4 Unsigned integer, the value range is [0, 2^32-1]. TBD BIGINT UNSIGNED 8 unsigned long integer, the value range is [0, 2^64-1]. TBD TIMESTAMP 8 Default precision is microsecond. TBD FLOAT 4 Floating point number. DOUBLE 8 Double precision floating point number. CHAR [COLLATE collation_name] User-defined, max 65535 Fixed-length UTF-8 string. VARCHAR [COLLATE collation_name] User-defined, max 65535 Variable-length UTF-8 string. BINARY User-defined, max 65535 Fixed-length binary data. VARBINARY User-defined, max 65535 Variable-length binary data.
Collation¶
Type Description NOCASE Case insensitive [Default]. BINARY Case sensitive.
Literals¶
Type Literals Boolean true, false Integer 123, -123 Floating-Point 1.23, -1.23 Character 'abc', "abc" Binary x'a23f5fde', X'A23F5FDE', 0xa23f5fde, 0XA23F5FDE Timestamp TBD
Escape Characters¶
Escape Character Actual Meaning \n Line Break \r Carriage Return \t tab \' Single quote ' \" Double quote " ` backtick ` \ Back Slash \ \% % see below for details _ _ see below for details
Comments