kdbc.h

Go to the documentation of this file.

#ifndef KDBC_H
#define KDBC_H
 
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* ========================================================================
 * Types and Constants
 * ======================================================================== */


typedef struct kdbc_conn   kdbc_conn;

typedef struct kdbc_stmt   kdbc_stmt;

typedef struct kdbc_result kdbc_result;

typedef enum {
    KDBC_SQLITE   = 0,  
    KDBC_POSTGRES = 1,  
    KDBC_MARIADB  = 2,  
    KDBC_ORACLE   = 3,  
    KDBC_MSSQL    = 4,  
    KDBC_DRIVER_COUNT = 5  
} kdbc_driver;

typedef enum {
    KDBC_TYPE_NULL      = 0,  
    KDBC_TYPE_INT       = 1,  
    KDBC_TYPE_LONG      = 2,  
    KDBC_TYPE_DOUBLE    = 3,  
    KDBC_TYPE_STRING    = 4,  
    KDBC_TYPE_BLOB      = 5,  
    KDBC_TYPE_BOOL      = 6,  
    KDBC_TYPE_DATE      = 7,  
    KDBC_TYPE_TIME      = 8,  
    KDBC_TYPE_TIMESTAMP = 9   
} kdbc_type;

typedef enum {
    KDBC_GK_NONE     = 0,  
    KDBC_GK_BY_INDEX = 1,  
    KDBC_GK_BY_NAME  = 2   
} kdbc_gk_strategy;

#define KDBC_OK    0
#define KDBC_ERROR (-1)
 /* end of types */
 
/* ========================================================================
 * Driver Discovery
 * ======================================================================== */


int kdbc_driver_available(kdbc_driver driver);

const char *kdbc_driver_name(kdbc_driver driver);

kdbc_gk_strategy kdbc_driver_gk_strategy(kdbc_driver driver);

kdbc_gk_strategy kdbc_conn_gk_strategy(kdbc_conn *conn);

int kdbc_driver_supports_release_savepoint(kdbc_driver driver);
 /* end of discovery */
 
/* ========================================================================
 * Error Handling
 * ======================================================================== */


const char *kdbc_error(kdbc_conn *conn);

const char *kdbc_stmt_error(kdbc_stmt *stmt);

const char *kdbc_global_error(void);
 /* end of errors */
 
/* ========================================================================
 * Connection Management
 * ======================================================================== */


kdbc_conn *kdbc_connect(kdbc_driver driver, const char *url,
                        const char *user, const char *password);

void kdbc_close(kdbc_conn *conn);

kdbc_driver kdbc_conn_driver(kdbc_conn *conn);

int kdbc_cancel(kdbc_conn *conn);
 /* end of connection */
 
/* ========================================================================
 * Direct SQL Execution
 * ======================================================================== */


int kdbc_execute_update(kdbc_conn *conn, const char *sql);

kdbc_result *kdbc_execute_query(kdbc_conn *conn, const char *sql);
 /* end of direct */
 
/* ========================================================================
 * Transaction Control
 * ======================================================================== */


int kdbc_set_autocommit(kdbc_conn *conn, int enabled);

int kdbc_commit(kdbc_conn *conn);

int kdbc_rollback(kdbc_conn *conn);

int kdbc_savepoint(kdbc_conn *conn, const char *name);

int kdbc_rollback_to(kdbc_conn *conn, const char *name);

int kdbc_release_savepoint(kdbc_conn *conn, const char *name);
 /* end of transactions */
 
/* ========================================================================
 * Database Metadata
 * ======================================================================== */


const char *kdbc_product_name(kdbc_conn *conn);

const char *kdbc_product_version(kdbc_conn *conn);

int kdbc_major_version(kdbc_conn *conn);

int kdbc_minor_version(kdbc_conn *conn);
 /* end of metadata */
 
/* ========================================================================
 * Prepared Statements and Parameter Binding
 * ======================================================================== */


kdbc_stmt *kdbc_prepare(kdbc_conn *conn, const char *sql);

kdbc_stmt *kdbc_prepare_returning(kdbc_conn *conn, const char *sql,
                                  const char **col_names, int n_cols);

int kdbc_bind_null(kdbc_stmt *stmt, int idx);

int kdbc_bind_int(kdbc_stmt *stmt, int idx, int val);

int kdbc_bind_bool(kdbc_stmt *stmt, int idx, int val);

int kdbc_bind_long(kdbc_stmt *stmt, int idx, int64_t val);

int kdbc_bind_double(kdbc_stmt *stmt, int idx, double val);

int kdbc_bind_string(kdbc_stmt *stmt, int idx, const char *val);

int kdbc_bind_blob(kdbc_stmt *stmt, int idx, const void *data, size_t len);

int kdbc_bind_timestamp(kdbc_stmt *stmt, int idx,
                        int year, int month, int day,
                        int hour, int minute, int second, int usec);

int kdbc_bind_date(kdbc_stmt *stmt, int idx,
                   int year, int month, int day);

int kdbc_bind_time(kdbc_stmt *stmt, int idx,
                   int hour, int minute, int second, int usec);
 /* end of statements */
 
/* ========================================================================
 * Statement Execution
 * ======================================================================== */


int kdbc_execute_update_stmt(kdbc_stmt *stmt);

kdbc_result *kdbc_execute_query_stmt(kdbc_stmt *stmt);

kdbc_result *kdbc_generated_keys(kdbc_stmt *stmt);

void kdbc_stmt_close(kdbc_stmt *stmt);

int kdbc_stmt_reset(kdbc_stmt *stmt);

int kdbc_set_fetch_size(kdbc_stmt *stmt, int rows);
 /* end of execution */
 
/* ========================================================================
 * Batch Execution
 * ======================================================================== */


int kdbc_add_batch(kdbc_stmt *stmt);

int kdbc_execute_batch(kdbc_stmt *stmt);
 /* end of batch */
 
/* ========================================================================
 * Callable Statements (Stored Procedures)
 * ======================================================================== */


kdbc_stmt *kdbc_prepare_call(kdbc_conn *conn, const char *sql);

int kdbc_register_out(kdbc_stmt *stmt, int idx);

int kdbc_call_execute(kdbc_stmt *stmt);

int64_t kdbc_call_get_long(kdbc_stmt *stmt, int idx);

const char *kdbc_call_get_string(kdbc_stmt *stmt, int idx);
 /* end of callable */
 
/* ========================================================================
 * Result Set
 * ======================================================================== */


int kdbc_next(kdbc_result *rs);

int kdbc_col_count(kdbc_result *rs);

const char *kdbc_col_name(kdbc_result *rs, int col);

const char *kdbc_col_label(kdbc_result *rs, int col);

int kdbc_is_null(kdbc_result *rs, int col);

int64_t kdbc_get_long(kdbc_result *rs, int col);

double kdbc_get_double(kdbc_result *rs, int col);

const char *kdbc_get_string(kdbc_result *rs, int col);

const void *kdbc_get_blob(kdbc_result *rs, int col, size_t *out_len);

int kdbc_get_timestamp(kdbc_result *rs, int col,
                       int *year, int *month, int *day,
                       int *hour, int *minute, int *second, int *usec);

int kdbc_get_date(kdbc_result *rs, int col,
                  int *year, int *month, int *day);

int kdbc_get_time(kdbc_result *rs, int col,
                  int *hour, int *minute, int *second, int *usec);

void kdbc_result_close(kdbc_result *rs);
 /* end of resultset */
 
#ifdef __cplusplus
}
#endif
 
#endif /* KDBC_H */