common/database.h

Go to the documentation of this file.

/*
    This file is part of darktable,
    Copyright (C) 2010-2011 Henrik Andersson.
    Copyright (C) 2010 johannes hanika.
    Copyright (C) 2011-2012 Edouard Gomez.
    Copyright (C) 2012 Richard Wonka.
    Copyright (C) 2013-2017 Tobias Ellinghaus.
    Copyright (C) 2019 Edgardo Hoszowski.
    Copyright (C) 2020 Hubert Kowalski.
    Copyright (C) 2020, 2022 Pascal Obry.
    Copyright (C) 2022 Martin Bařinka.
    Copyright (C) 2025 Alynx Zhou.
    Copyright (C) 2025-2026 Aurélien PIERRE.
    Copyright (C) 2025 Guillaume Stutin.
    
    darktable is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.
    
    darktable 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 General Public License for more details.
    
    You should have received a copy of the GNU General Public License
    along with darktable.  If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include <glib.h>
#include <sqlite3.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct dt_database_t;
 
struct dt_database_t *dt_database_init(const char *alternative, const gboolean load_data, const gboolean has_gui);
void dt_database_destroy(const struct dt_database_t *);
sqlite3 *dt_database_get(const struct dt_database_t *);
const gchar *dt_database_get_path(const struct dt_database_t *db);
gboolean dt_database_get_lock_acquired(const struct dt_database_t *db);
gboolean dt_database_show_error(const struct dt_database_t *db);
void dt_database_optimize(const struct dt_database_t *);
gboolean dt_database_maybe_maintenance(const struct dt_database_t *db, const gboolean has_gui, const gboolean closing_time);
void dt_database_perform_maintenance(const struct dt_database_t *db);
void dt_database_cleanup_busy_statements(const struct dt_database_t *db);
gboolean dt_database_snapshot(const struct dt_database_t *db);
gboolean dt_database_maybe_snapshot(const struct dt_database_t *db);
char **dt_database_snaps_to_remove(const struct dt_database_t *db);
gchar *dt_database_get_most_recent_snap(const char* db_filename);
 
 
// nested transactions support
void dt_database_start_transaction_debug(const struct dt_database_t *db);
void dt_database_release_transaction_debug(const struct dt_database_t *db);
void dt_database_rollback_transaction(const struct dt_database_t *db);
void dt_database_begin_transaction_batch(const struct dt_database_t *db);
void dt_database_end_transaction_batch(const struct dt_database_t *db);
 
#define dt_database_start_transaction(db) DT_DEBUG_TRACE_WRAPPER(DT_DEBUG_SQL, dt_database_start_transaction_debug, (db))
#define dt_database_release_transaction(db) DT_DEBUG_TRACE_WRAPPER(DT_DEBUG_SQL, dt_database_release_transaction_debug, (db))
 
#ifdef __cplusplus
}
#endif
 
// clang-format off
// modelines: These editor modelines have been set for all relevant files by tools/update_modelines.py
// vim: shiftwidth=2 expandtab tabstop=2 cindent
// kate: tab-indents: off; indent-width 2; replace-tabs on; indent-mode cstyle; remove-trailing-spaces modified;
// clang-format on