Ansel 0.0
A darktable fork - bloat + design vision
Loading...
Searching...
No Matches
sql_debug.h File Reference

Checked wrappers around the sqlite3_* calls: trace the statement, assert the return code, report the connection's error message when it is not SQLITE_OK. More...

#include "common/logging.h"
#include "database/database.h"
#include <sqlite3.h>
#include <stdio.h>
Include dependency graph for sql_debug.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros

#define __DT_DEBUG_SQL_QUERY__(value)
#define __DT_DEBUG_ASSERT__(xin)
#define __DT_DEBUG_ASSERT_WITH_QUERY__(xin, query)
#define DT_DEBUG_SQLITE3_EXEC(a, b, c, d, e)
#define DT_DEBUG_SQLITE3_PREPARE_V2(a, b, c, d, e)
#define DT_DEBUG_SQLITE3_BIND_INT(a, b, c)
#define DT_DEBUG_SQLITE3_BIND_INT64(a, b, c)
#define DT_DEBUG_SQLITE3_BIND_DOUBLE(a, b, c)
#define DT_DEBUG_SQLITE3_BIND_TEXT(a, b, c, d, e)
#define DT_DEBUG_SQLITE3_BIND_BLOB(a, b, c, d, e)
#define DT_DEBUG_SQLITE3_CLEAR_BINDINGS(a)
#define DT_DEBUG_SQLITE3_RESET(a)

Detailed Description

Checked wrappers around the sqlite3_* calls: trace the statement, assert the return code, report the connection's error message when it is not SQLITE_OK.

Warning
This header is scaffolding, and it is counted. It exists because SQL is still written outside src/database – every file that issues a query includes it, and every one of those is a translation unit holding a raw sqlite3 * that the module cannot account for. tools/check_module_boundaries.sh ratchets the number of such files downwards; the header is deleted when the count reaches zero and the macros become private to the repositories.

So: do not include this from new code. A new query belongs in a repository under src/database/, reached through a named function. See src/database/README.md.

Note
It used to live in common/debug.h, which meant that a file wanting nothing but DT_DEBUG_TRACE_WRAPPER – a generic tracing helper with no relation to SQL – pulled in database.h and <sqlite3.h> as well. That was 42 translation units, of which 5 never issued a query. common/debug.h now carries only the tracing wrapper.

Definition in file sql_debug.h.

Macro Definition Documentation

◆ __DT_DEBUG_ASSERT__

#define __DT_DEBUG_ASSERT__ ( xin)
Value:
{ \
_Pragma("GCC diagnostic push") _Pragma("GCC diagnostic ignored \"-Wshadow\"") const int x = xin; \
if(x != SQLITE_OK) \
{ \
fprintf(stderr, "sqlite3 error: %s:%d, function %s(): %s\n", __FILE__, __LINE__, __FUNCTION__, \
sqlite3_errmsg(dt_database_get_sqlite3_global())); \
} \
_Pragma("GCC diagnostic pop") \
}
static const float x
sqlite3 * dt_database_get_sqlite3_global(void)
Definition database.c:3790

Definition at line 106 of file sql_debug.h.

◆ __DT_DEBUG_ASSERT_WITH_QUERY__

#define __DT_DEBUG_ASSERT_WITH_QUERY__ ( xin,
query )
Value:
{ \
_Pragma("GCC diagnostic push") _Pragma("GCC diagnostic ignored \"-Wshadow\"") const int x = xin; \
if(x != SQLITE_OK) \
{ \
fprintf(stderr, "sqlite3 error: %s:%d, function %s(), query \"%s\": %s\n", __FILE__, __LINE__, __FUNCTION__,\
(query), sqlite3_errmsg(dt_database_get_sqlite3_global())); \
} \
_Pragma("GCC diagnostic pop") \
}

Definition at line 116 of file sql_debug.h.

◆ __DT_DEBUG_SQL_QUERY__

#define __DT_DEBUG_SQL_QUERY__ ( value)

Definition at line 77 of file sql_debug.h.

◆ DT_DEBUG_SQLITE3_BIND_BLOB

◆ DT_DEBUG_SQLITE3_BIND_DOUBLE

◆ DT_DEBUG_SQLITE3_BIND_INT

#define DT_DEBUG_SQLITE3_BIND_INT ( a,
b,
c )
Value:
__DT_DEBUG_ASSERT__(sqlite3_bind_int(a, b, c))

Definition at line 145 of file sql_debug.h.

Referenced by _bind_conditions(), _bind_match(), _image_write_history_hash(), _next_id(), _run(), _run_for_id(), _run_snap_imgid(), dt_collection_query_get_images(), dt_collection_query_get_nth(), dt_collection_query_refresh_memory_table(), dt_colorlabel_repository_foreach(), dt_colorlabel_repository_get(), dt_colorlabel_repository_get_list(), dt_colorlabel_repository_has(), dt_colorlabel_repository_remove(), dt_colorlabel_repository_remove_all(), dt_colorlabel_repository_set(), dt_film_repository_delete(), dt_film_repository_folder_status_set(), dt_film_repository_get_folder(), dt_film_repository_get_image_ids(), dt_film_repository_has_images(), dt_film_repository_set_folder(), dt_film_repository_touch_access(), dt_history_repository_count_items(), dt_history_repository_count_mask_items(), dt_history_repository_delete_all_for_image(), dt_history_repository_delete_history(), dt_history_repository_delete_masks_history(), dt_history_repository_foreach_active_module(), dt_history_repository_foreach_auto_preset_row(), dt_history_repository_foreach_item(), dt_history_repository_foreach_last_item(), dt_history_repository_foreach_mask_item(), dt_history_repository_foreach_row(), dt_history_repository_get_autoapply_ioporder_params(), dt_history_repository_get_end(), dt_history_repository_get_last_enabled_params(), dt_history_repository_get_module_order(), dt_history_repository_get_module_order_version(), dt_history_repository_get_next_num(), dt_history_repository_module_exists(), dt_history_repository_set_end(), dt_history_repository_set_module_order(), dt_history_repository_shift_nums(), dt_history_repository_write_item(), dt_history_repository_write_mask_item(), dt_history_snapshot_repository_next_id(), dt_image_repository_clear_flag_among(), dt_image_repository_copy_to_film(), dt_image_repository_count_in_id_range(), dt_image_repository_count_others_with_flag(), dt_image_repository_delete(), dt_image_repository_duplicate(), dt_image_repository_find_by_film_and_filename(), dt_image_repository_find_group_for_pattern(), dt_image_repository_foreach_in_id_range(), dt_image_repository_get_duplicate_ids(), dt_image_repository_get_group_member_rows(), dt_image_repository_get_group_members(), dt_image_repository_get_ids_with_flag(), dt_image_repository_get_ids_with_flag_among(), dt_image_repository_get_ratings(), dt_image_repository_get_timestamps(), dt_image_repository_get_version(), dt_image_repository_get_versions(), dt_image_repository_get_write_timestamp(), dt_image_repository_get_xmp_row(), dt_image_repository_insert_import(), dt_image_repository_load(), dt_image_repository_reassign_group(), dt_image_repository_set_flag_among(), dt_image_repository_set_flags(), dt_image_repository_set_flags_masked(), dt_image_repository_set_group(), dt_image_repository_set_version(), dt_image_repository_set_write_timestamp(), dt_image_repository_store(), dt_image_repository_touch_write_timestamp(), dt_location_repository_delete(), dt_location_repository_find_images_for_location(), dt_location_repository_find_locations_for_image(), dt_location_repository_get_data(), dt_location_repository_get_image_locations(), dt_location_repository_get_polygon(), dt_location_repository_set_data(), dt_metadata_repository_foreach(), dt_metadata_repository_get_all(), dt_metadata_repository_get_values(), dt_preset_repository_add_iop_preset(), dt_preset_repository_add_module_preset(), dt_preset_repository_add_shipped_preset(), dt_preset_repository_delete_by_rowid(), dt_preset_repository_delete_by_rowid_unprotected(), dt_preset_repository_delete_module_preset(), dt_preset_repository_duplicate_module_preset(), dt_preset_repository_find_autoapply(), dt_preset_repository_find_rowid(), dt_preset_repository_get_by_rowid(), dt_preset_repository_get_conditions(), dt_preset_repository_get_identity(), dt_preset_repository_get_iop_preset(), dt_preset_repository_get_module_preset(), dt_preset_repository_insert(), dt_preset_repository_insert_with_conditions(), dt_preset_repository_list_for_iop(), dt_preset_repository_list_for_module(), dt_preset_repository_list_for_version(), dt_preset_repository_module_preset_exists(), dt_preset_repository_rename_module_preset(), dt_preset_repository_set_blend_params(), dt_preset_repository_set_module_version(), dt_preset_repository_update_camera(), dt_preset_repository_update_conditions(), dt_preset_repository_update_flag(), dt_preset_repository_update_iop_params(), dt_preset_repository_update_module_params(), dt_preset_repository_update_params_by_rowid(), dt_preset_repository_update_range(), dt_style_repository_copy_items_from_history(), dt_style_repository_copy_items_from_style(), dt_style_repository_delete(), dt_style_repository_delete_items_except(), dt_style_repository_foreach_apply_item(), dt_style_repository_foreach_item(), dt_style_repository_foreach_item_against_image(), dt_style_repository_foreach_item_for_export(), dt_style_repository_foreach_item_with_params(), dt_style_repository_get_description(), dt_style_repository_insert_item(), dt_style_repository_normalize_multi_priority(), dt_style_repository_set_iop_list(), dt_style_repository_update_header(), dt_tag_repository_attach(), dt_tag_repository_count_attachments(), dt_tag_repository_count_distinct_images(), dt_tag_repository_get_attached(), dt_tag_repository_get_attached_for_export(), dt_tag_repository_get_attached_names(), dt_tag_repository_get_flags(), dt_tag_repository_get_images(), dt_tag_repository_get_name(), dt_tag_repository_get_names_under(), dt_tag_repository_get_synonyms(), dt_tag_repository_is_attached(), dt_tag_repository_rename(), dt_tag_repository_set_flags(), dt_tag_repository_set_synonyms(), and dt_tag_repository_update_flags().

◆ DT_DEBUG_SQLITE3_BIND_INT64

#define DT_DEBUG_SQLITE3_BIND_INT64 ( a,
b,
c )

◆ DT_DEBUG_SQLITE3_BIND_TEXT

#define DT_DEBUG_SQLITE3_BIND_TEXT ( a,
b,
c,
d,
e )
Value:
__DT_DEBUG_ASSERT__(sqlite3_bind_text(a, b, c, d, e))

Definition at line 148 of file sql_debug.h.

Referenced by _bind_match(), _bind_text(), _fill_similar_tags(), _first_id_for_text(), dt_collection_query_set_iop_names(), dt_film_repository_find_by_folder(), dt_film_repository_foreach_under(), dt_film_repository_insert(), dt_film_repository_set_folder(), dt_history_repository_find_version_for_params(), dt_history_repository_foreach_auto_preset_row(), dt_history_repository_get_autoapply_ioporder_params(), dt_history_repository_get_last_enabled_params(), dt_history_repository_module_exists(), dt_history_repository_set_module_order(), dt_history_repository_write_item(), dt_history_repository_write_mask_item(), dt_image_repository_copy_to_film(), dt_image_repository_duplicate(), dt_image_repository_find_by_film_and_filename(), dt_image_repository_find_by_folder_and_filename(), dt_image_repository_find_group_for_pattern(), dt_image_repository_get_versions(), dt_image_repository_insert_import(), dt_image_repository_store(), dt_location_repository_get_data(), dt_metadata_repository_find_image_by_value(), dt_preset_repository_add_iop_preset(), dt_preset_repository_add_module_preset(), dt_preset_repository_add_shipped_preset(), dt_preset_repository_delete_all_for_module(), dt_preset_repository_delete_module_preset(), dt_preset_repository_duplicate_module_preset(), dt_preset_repository_find_autoapply(), dt_preset_repository_find_rowid(), dt_preset_repository_get_conditions(), dt_preset_repository_get_iop_preset(), dt_preset_repository_get_module_preset(), dt_preset_repository_insert_with_conditions(), dt_preset_repository_list_all_versions(), dt_preset_repository_list_for_iop(), dt_preset_repository_list_for_menu(), dt_preset_repository_list_for_module(), dt_preset_repository_list_for_upgrade(), dt_preset_repository_list_for_version(), dt_preset_repository_module_preset_exists(), dt_preset_repository_rename_module_preset(), dt_preset_repository_set_blend_params(), dt_preset_repository_set_module_version(), dt_preset_repository_update_camera(), dt_preset_repository_update_flag(), dt_preset_repository_update_iop_params(), dt_preset_repository_update_module_params(), dt_preset_repository_update_range(), dt_style_repository_foreach_style(), dt_style_repository_get_id_by_name(), dt_style_repository_get_iop_list(), dt_style_repository_get_style(), dt_style_repository_insert_header(), dt_style_repository_insert_item(), dt_style_repository_set_iop_list(), dt_style_repository_update_header(), dt_tag_repository_get_by_path_with_counts(), dt_tag_repository_get_names_under(), dt_tag_repository_insert(), dt_tag_repository_rename(), and dt_tag_repository_set_synonyms().

◆ DT_DEBUG_SQLITE3_CLEAR_BINDINGS

#define DT_DEBUG_SQLITE3_CLEAR_BINDINGS ( a)
Value:
__DT_DEBUG_ASSERT__(sqlite3_clear_bindings(a))

Definition at line 150 of file sql_debug.h.

◆ DT_DEBUG_SQLITE3_EXEC

◆ DT_DEBUG_SQLITE3_PREPARE_V2

#define DT_DEBUG_SQLITE3_PREPARE_V2 ( a,
b,
c,
d,
e )
Value:
do \
{ \
dt_print(DT_DEBUG_SQL, "[sql] %s:%d, function %s(): prepare \"%s\"\n", __FILE__, __LINE__, __FUNCTION__, (b));\
__DT_DEBUG_ASSERT_WITH_QUERY__(sqlite3_prepare_v2(a, b, c, d, e), (b)); \
__DT_DEBUG_SQL_QUERY__(b) \
} while(0)

Definition at line 137 of file sql_debug.h.

Referenced by _columns_of(), _compute_count(), _fill_similar_tags(), _first_id_for_text(), _image_get_stmt(), _image_write_history_hash(), _next_id(), _prepared(), _run(), _run_for_id(), _run_snap_imgid(), _scalar(), dt_collection_query_find_neighbour(), dt_collection_query_get_group_members(), dt_collection_query_get_images(), dt_collection_query_get_images_for_rule(), dt_collection_query_get_makermodels(), dt_collection_query_get_nth(), dt_collection_query_get_property_values(), dt_collection_query_image_offset(), dt_collection_query_refresh_memory_table(), dt_collection_query_set_iop_names(), dt_colorlabel_repository_foreach(), dt_colorlabel_repository_get_list(), dt_colorlabel_repository_has(), dt_film_repository_delete(), dt_film_repository_find_by_folder(), dt_film_repository_folder_status_clear(), dt_film_repository_folder_status_set(), dt_film_repository_foreach(), dt_film_repository_foreach_empty(), dt_film_repository_foreach_under(), dt_film_repository_get_folder(), dt_film_repository_get_image_ids(), dt_film_repository_has_images(), dt_film_repository_insert(), dt_film_repository_set_folder(), dt_film_repository_touch_access(), dt_history_repository_count_items(), dt_history_repository_count_mask_items(), dt_history_repository_delete_all_for_image(), dt_history_repository_delete_history(), dt_history_repository_delete_masks_history(), dt_history_repository_find_version_for_params(), dt_history_repository_foreach_active_module(), dt_history_repository_foreach_auto_preset_row(), dt_history_repository_foreach_item(), dt_history_repository_foreach_last_item(), dt_history_repository_foreach_mask_item(), dt_history_repository_foreach_row(), dt_history_repository_get_autoapply_ioporder_params(), dt_history_repository_get_end(), dt_history_repository_get_last_enabled_params(), dt_history_repository_get_module_order(), dt_history_repository_get_module_order_version(), dt_history_repository_get_next_num(), dt_history_repository_module_exists(), dt_history_repository_set_end(), dt_history_repository_set_module_order(), dt_history_repository_shift_nums(), dt_history_repository_write_item(), dt_history_repository_write_mask_item(), dt_history_snapshot_repository_next_id(), dt_image_repository_clear_flag_among(), dt_image_repository_copy_to_film(), dt_image_repository_count_distinct_fields(), dt_image_repository_count_in_id_range(), dt_image_repository_count_others_with_flag(), dt_image_repository_delete(), dt_image_repository_duplicate(), dt_image_repository_find_by_film_and_filename(), dt_image_repository_find_by_folder_and_filename(), dt_image_repository_find_group_for_pattern(), dt_image_repository_foreach_collected(), dt_image_repository_foreach_in_id_range(), dt_image_repository_foreach_with_path(), dt_image_repository_get_collected_geo_bounds(), dt_image_repository_get_collected_geo_points(), dt_image_repository_get_duplicate_ids(), dt_image_repository_get_full_paths(), dt_image_repository_get_group_member_rows(), dt_image_repository_get_group_members(), dt_image_repository_get_ids_with_flag(), dt_image_repository_get_ids_with_flag_among(), dt_image_repository_get_ratings(), dt_image_repository_get_timestamps(), dt_image_repository_get_version(), dt_image_repository_get_versions(), dt_image_repository_get_write_timestamp(), dt_image_repository_get_xmp_row(), dt_image_repository_insert_import(), dt_image_repository_reassign_group(), dt_image_repository_set_flag_among(), dt_image_repository_set_flags(), dt_image_repository_set_flags_masked(), dt_image_repository_set_group(), dt_image_repository_set_version(), dt_image_repository_set_write_timestamp(), dt_image_repository_store(), dt_image_repository_touch_write_timestamp(), dt_location_repository_delete(), dt_location_repository_find_images_for_location(), dt_location_repository_find_locations_for_image(), dt_location_repository_get_data(), dt_location_repository_get_image_locations(), dt_location_repository_get_in_bbox(), dt_location_repository_get_polygon(), dt_location_repository_set_data(), dt_metadata_repository_add(), dt_metadata_repository_find_image_by_value(), dt_metadata_repository_foreach(), dt_metadata_repository_foreach_selected(), dt_metadata_repository_get_all(), dt_metadata_repository_get_values(), dt_metadata_repository_remove(), dt_preset_repository_add_iop_preset(), dt_preset_repository_add_module_preset(), dt_preset_repository_add_shipped_preset(), dt_preset_repository_delete_all_for_module(), dt_preset_repository_delete_by_rowid(), dt_preset_repository_delete_by_rowid_unprotected(), dt_preset_repository_delete_module_preset(), dt_preset_repository_duplicate_module_preset(), dt_preset_repository_find_autoapply(), dt_preset_repository_find_rowid(), dt_preset_repository_get_by_rowid(), dt_preset_repository_get_conditions(), dt_preset_repository_get_identity(), dt_preset_repository_get_iop_preset(), dt_preset_repository_get_module_preset(), dt_preset_repository_insert(), dt_preset_repository_insert_with_conditions(), dt_preset_repository_list_all(), dt_preset_repository_list_all_versions(), dt_preset_repository_list_editable(), dt_preset_repository_list_for_iop(), dt_preset_repository_list_for_menu(), dt_preset_repository_list_for_module(), dt_preset_repository_list_for_upgrade(), dt_preset_repository_list_for_version(), dt_preset_repository_module_preset_exists(), dt_preset_repository_rename_module_preset(), dt_preset_repository_set_blend_params(), dt_preset_repository_set_module_version(), dt_preset_repository_update_camera(), dt_preset_repository_update_conditions(), dt_preset_repository_update_flag(), dt_preset_repository_update_iop_params(), dt_preset_repository_update_module_params(), dt_preset_repository_update_params_by_rowid(), dt_preset_repository_update_range(), dt_selection_repository_get_all(), dt_selection_repository_get_lowest_id(), dt_style_repository_copy_items_from_history(), dt_style_repository_copy_items_from_style(), dt_style_repository_delete(), dt_style_repository_delete_items_except(), dt_style_repository_foreach_apply_item(), dt_style_repository_foreach_item(), dt_style_repository_foreach_item_against_image(), dt_style_repository_foreach_item_for_export(), dt_style_repository_foreach_item_with_params(), dt_style_repository_foreach_style(), dt_style_repository_get_description(), dt_style_repository_get_id_by_name(), dt_style_repository_get_iop_list(), dt_style_repository_get_style(), dt_style_repository_insert_header(), dt_style_repository_insert_item(), dt_style_repository_normalize_multi_priority(), dt_style_repository_set_iop_list(), dt_style_repository_update_header(), dt_tag_repository_attach(), dt_tag_repository_attach_batch(), dt_tag_repository_count_attachments(), dt_tag_repository_count_distinct_images(), dt_tag_repository_delete_batch(), dt_tag_repository_detach_batch(), dt_tag_repository_get_agreement(), dt_tag_repository_get_attached(), dt_tag_repository_get_attached_for_export(), dt_tag_repository_get_attached_names(), dt_tag_repository_get_by_path_with_counts(), dt_tag_repository_get_collection_tags(), dt_tag_repository_get_flags(), dt_tag_repository_get_ids_for_images(), dt_tag_repository_get_images(), dt_tag_repository_get_images_in_list(), dt_tag_repository_get_name(), dt_tag_repository_get_names_under(), dt_tag_repository_get_similar(), dt_tag_repository_get_suggestions(), dt_tag_repository_get_synonyms(), dt_tag_repository_get_with_usage(), dt_tag_repository_insert(), dt_tag_repository_is_attached(), dt_tag_repository_rebuild_internal(), dt_tag_repository_rename(), dt_tag_repository_set_flags(), dt_tag_repository_set_synonyms(), and dt_tag_repository_update_flags().

◆ DT_DEBUG_SQLITE3_RESET

#define DT_DEBUG_SQLITE3_RESET ( a)
Value:
__DT_DEBUG_ASSERT__(sqlite3_reset(a))

Definition at line 151 of file sql_debug.h.