sql-generic.h

Go to the documentation of this file.

/*
 * JULEA - Flexible storage framework
 * Copyright (C) 2022 Timm Leon Erxleben
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef JULEA_DB_UTIL_SQL_GENERIC_H
#define JULEA_DB_UTIL_SQL_GENERIC_H
 
#include <glib.h>
 
#include <julea-db.h>
 
struct JSQLSpecifics
{
    gboolean single_threaded;
    gpointer backend_data; // though the backend_data is usually passed to every function it is usefull to have another global reference (e.g. in j_sql_statement_free)
 
    struct
    {
        gpointer (*connection_open)(gpointer db_connection_info);
        void (*connection_close)(gpointer db_connection);
        gboolean (*transaction_start)(gpointer db_connection, GError** error);
        gboolean (*transaction_commit)(gpointer db_connection, GError** error);
        gboolean (*transaction_abort)(gpointer db_connection, GError** error);
        gboolean (*statement_prepare)(gpointer db_connection, const char* sql, gpointer _stmt, GArray* types_in, GArray* types_out, GError** error);
        gboolean (*statement_finalize)(gpointer db_connection, gpointer _stmt, GError** error);
        gboolean (*statement_bind_null)(gpointer db_connection, gpointer _stmt, guint idx, GError** error);
        gboolean (*statement_bind_value)(gpointer db_connection, gpointer _stmt, guint idx, JDBType type, JDBTypeValue* value, GError** error);
        gboolean (*statement_step)(gpointer db_connection, gpointer _stmt, gboolean* found, GError** error);
        gboolean (*statement_step_and_reset_check_done)(gpointer db_connection, gpointer _stmt, GError** error);
        gboolean (*statement_reset)(gpointer db_connection, gpointer _stmt, GError** error);
        gboolean (*statement_column)(gpointer db_connection, gpointer _stmt, guint idx, JDBType type, JDBTypeValue* value, GError** error);
        gboolean (*sql_exec)(gpointer db_connection, const char* sql, GError** error);
    } func;
 
    struct
    {
        const gchar* autoincrement;
        const gchar* uint64_type;
        // SQLite does not support autoincrement with other types than INTEGER which is 64-bit signed. Therefore ID types should differ between backends instead of simply using unsigned bigint.
        const gchar* id_type;
        const gchar* select_last;
        const gchar* quote;
    } sql;
};
 
typedef struct JSQLSpecifics JSQLSpecifics;
 
gboolean sql_generic_init(JSQLSpecifics* specifics);
void sql_generic_fini(void);
 
gboolean sql_generic_batch_start(gpointer backend_data, gchar const* namespace, JSemantics* semantics, gpointer* _batch, GError** error);
gboolean sql_generic_batch_execute(gpointer backend_data, gpointer _batch, GError** error);
 
gboolean sql_generic_schema_create(gpointer backend_data, gpointer _batch, gchar const* name, bson_t const* schema, GError** error);
gboolean sql_generic_schema_get(gpointer backend_data, gpointer _batch, gchar const* name, bson_t* schema, GError** error);
gboolean sql_generic_schema_delete(gpointer backend_data, gpointer _batch, gchar const* name, GError** error);
 
gboolean sql_generic_insert(gpointer backend_data, gpointer _batch, gchar const* name, bson_t const* metadata, bson_t* id, GError** error);
gboolean sql_generic_update(gpointer backend_data, gpointer _batch, gchar const* name, bson_t const* selector, bson_t const* metadata, GError** error);
gboolean sql_generic_delete(gpointer backend_data, gpointer _batch, gchar const* name, bson_t const* selector, GError** error);
gboolean sql_generic_query(gpointer backend_data, gpointer _batch, gchar const* name, bson_t const* selector, gpointer* iterator, GError** error);
gboolean sql_generic_iterate(gpointer backend_data, gpointer _iterator, bson_t* metadata, GError** error);
 
#endif