orm.h

Go to the documentation of this file.

 
#ifndef __CWIST_ORM_H__
#define __CWIST_ORM_H__
 
#include <stdbool.h>
#include <stdint.h>
#include <cwist/sys/err/cwist_err.h>
#include <cjson/cJSON.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Forward declaration ----------------------------------------------------- */
 
typedef struct cwist_orm cwist_orm_t;
 
typedef enum cwist_orm_dialect {
    CWIST_ORM_SQLITE,   
    CWIST_ORM_POSTGRES, 
    CWIST_ORM_MYSQL,    
    CWIST_ORM_MARIADB,  
} cwist_orm_dialect_t;
 
/* Lifecycle --------------------------------------------------------------- */
 
cwist_orm_t *cwist_orm_open_socket(int socket_fd);
 
void cwist_orm_close_socket(cwist_orm_t *orm);
 
/* Transaction control ----------------------------------------------------- */
 
void cwist_orm_immediate_commit(bool enable);
 
void cwist_orm_use_dialect(cwist_orm_t *orm, cwist_orm_dialect_t dialect);
 
cwist_error_t cwist_orm_commit(cwist_orm_t *orm);
 
cwist_error_t cwist_orm_rollback(cwist_orm_t *orm);
 
/* Low-level SQL ----------------------------------------------------------- */
 
cwist_error_t cwist_orm_exec(cwist_orm_t *orm, const char *sql);
 
cwist_error_t cwist_orm_query(cwist_orm_t *orm, const char *sql, cJSON **result);
 
/* High-level helpers ------------------------------------------------------ */
 
cwist_error_t cwist_orm_insert(cwist_orm_t *orm, const char *table, const cJSON *data);
 
cwist_error_t cwist_orm_update(cwist_orm_t *orm, const char *table, const cJSON *data,
                               const char *where_clause);
 
cwist_error_t cwist_orm_delete(cwist_orm_t *orm, const char *table, const char *where_clause);
 
cwist_error_t cwist_orm_select(cwist_orm_t *orm, const char *table, const char *columns,
                               const char *where_clause, cJSON **result);
 
/* ------------------------------------------------------------------ */
/* _Generic type-dispatched RETURNING INSERT                           */
/* ------------------------------------------------------------------ */
 
cwist_error_t cwist_orm_insert_returning_json(cwist_orm_t *orm, const char *table,
                                              const cJSON *data, const char *returning_col,
                                              cJSON **out);
 
cwist_error_t cwist_orm_insert_returning_int(cwist_orm_t *orm, const char *table, const cJSON *data,
                                             const char *returning_col, int *out);
 
cwist_error_t cwist_orm_insert_returning_long(cwist_orm_t *orm, const char *table,
                                              const cJSON *data, const char *returning_col,
                                              long *out);
 
cwist_error_t cwist_orm_insert_returning_llong(cwist_orm_t *orm, const char *table,
                                               const cJSON *data, const char *returning_col,
                                               long long *out);
 
#define cwist_orm_insert_r(orm, table, data, returning_col, out) \
    _Generic((out),                                              \
        int *: cwist_orm_insert_returning_int,                   \
        long *: cwist_orm_insert_returning_long,                 \
        long long *: cwist_orm_insert_returning_llong,           \
        cJSON **: cwist_orm_insert_returning_json)((orm), (table), (data), (returning_col), (out))
 
/* ------------------------------------------------------------------ */
/* Column-typed result sets (#354)                                     */
/* ------------------------------------------------------------------ */
 
typedef enum cwist_orm_value_type {
    CWIST_ORM_TYPE_NULL = 0,   
    CWIST_ORM_TYPE_INTEGER,    
    CWIST_ORM_TYPE_REAL,       
    CWIST_ORM_TYPE_TEXT,       
    CWIST_ORM_TYPE_BLOB,       
} cwist_orm_value_type_t;
 
typedef struct cwist_orm_value {
    cwist_orm_value_type_t type;
    int64_t       i64;      
    double        real;     
    char         *text;     
    unsigned char *blob;    
    size_t        blob_len; 
} cwist_orm_value_t;
 
typedef struct cwist_orm_result {
    size_t              column_count;
    size_t              row_count;
    char              **columns;
    cwist_orm_value_t  *cells;
} cwist_orm_result_t;
 
cwist_error_t cwist_orm_query_typed(cwist_orm_t *orm, const char *sql,
                                    cwist_orm_result_t **result);
 
void cwist_orm_result_free(cwist_orm_result_t *result);
 
size_t cwist_orm_result_column_index(const cwist_orm_result_t *result,
                                     const char *column);
 
const cwist_orm_value_t *cwist_orm_result_cell(const cwist_orm_result_t *result,
                                               size_t row, size_t column);
 
/* ------------------------------------------------------------------ */
/* _Generic type-dispatched SELECT single scalar                       */
/* ------------------------------------------------------------------ */
 
cwist_error_t cwist_orm_select_one_json(cwist_orm_t *orm, const char *table, const char *column,
                                        const char *where_clause, cJSON **out);
 
cwist_error_t cwist_orm_select_one_int(cwist_orm_t *orm, const char *table, const char *column,
                                       const char *where_clause, int *out);
 
cwist_error_t cwist_orm_select_one_long(cwist_orm_t *orm, const char *table, const char *column,
                                        const char *where_clause, long *out);
 
cwist_error_t cwist_orm_select_one_llong(cwist_orm_t *orm, const char *table, const char *column,
                                         const char *where_clause, long long *out);
 
cwist_error_t cwist_orm_select_one_double(cwist_orm_t *orm, const char *table, const char *column,
                                          const char *where_clause, double *out);
 
cwist_error_t cwist_orm_select_one_string(cwist_orm_t *orm, const char *table, const char *column,
                                          const char *where_clause, char **out);
 
/* ------------------------------------------------------------------ */
/* Exact 64-bit integers                                               */
/* ------------------------------------------------------------------ */
 
cwist_error_t cwist_orm_select_one_i64(cwist_orm_t *orm, const char *table, const char *column,
                                       const char *where_clause, int64_t *out);
 
cwist_error_t cwist_orm_insert_returning_i64(cwist_orm_t *orm, const char *table,
                                             const cJSON *data, const char *returning_col,
                                             int64_t *out);
 
#define cwist_orm_select_one(orm, table, column, where, out) \
    _Generic((out),                                          \
        int *: cwist_orm_select_one_int,                     \
        long *: cwist_orm_select_one_long,                   \
        long long *: cwist_orm_select_one_llong,             \
        double *: cwist_orm_select_one_double,               \
        char **: cwist_orm_select_one_string,                \
        cJSON **: cwist_orm_select_one_json)((orm), (table), (column), (where), (out))
 
#ifdef __cplusplus
}
#endif
 
#endif /* __CWIST_ORM_H__ */