1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
/*
* Copyright (C) 2008, Nokia <ivan.frade@nokia.com>
*
* This library 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 2.1 of the License, or (at your option) any later version.
*
* This library 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 library; if not, write to the
* Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef __LIBTRACKER_DB_INTERFACE_H__
#define __LIBTRACKER_DB_INTERFACE_H__
#include <glib-object.h>
#include <gio/gio.h>
#include <libtracker-sparql/tracker-cursor.h>
#include "tracker-property.h"
G_BEGIN_DECLS
#if !defined (__LIBTRACKER_DATA_INSIDE__) && !defined (TRACKER_COMPILATION)
#error "only <libtracker-data/tracker-data.h> must be included directly."
#endif
#define TRACKER_TYPE_DB_INTERFACE (tracker_db_interface_get_type ())
#define TRACKER_DB_INTERFACE(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TRACKER_TYPE_DB_INTERFACE, TrackerDBInterface))
#define TRACKER_DB_INTERFACE_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), TRACKER_TYPE_DB_INTERFACE, TrackerDBInterfaceClass))
#define TRACKER_IS_DB_INTERFACE(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TRACKER_TYPE_DB_INTERFACE))
#define TRACKER_IS_DB_INTERFACE_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((o), TRACKER_TYPE_DB_INTERFACE))
#define TRACKER_DB_INTERFACE_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TRACKER_TYPE_DB_INTERFACE, TrackerDBInterfaceClass))
#define TRACKER_TYPE_DB_STATEMENT (tracker_db_statement_get_type ())
#define TRACKER_DB_STATEMENT(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TRACKER_TYPE_DB_STATEMENT, TrackerDBStatement))
#define TRACKER_DB_STATEMENT_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), TRACKER_TYPE_DB_STATEMENT, TrackerDBStatementClass))
#define TRACKER_IS_DB_STATEMENT(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TRACKER_TYPE_DB_STATEMENT))
#define TRACKER_IS_DB_STATEMENT_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((o), TRACKER_TYPE_DB_STATEMENT))
#define TRACKER_DB_STATEMENT_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TRACKER_TYPE_DB_STATEMENT, TrackerDBStatementClass))
#define TRACKER_TYPE_DB_CURSOR (tracker_db_cursor_get_type ())
#define TRACKER_DB_CURSOR(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), TRACKER_TYPE_DB_CURSOR, TrackerDBCursor))
#define TRACKER_DB_CURSOR_CLASS(c) (G_TYPE_CHECK_CLASS_CAST ((c), TRACKER_TYPE_DB_CURSOR, TrackerDBCursorClass))
#define TRACKER_IS_DB_CURSOR(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), TRACKER_TYPE_DB_CURSOR))
#define TRACKER_IS_DB_CURSOR_CLASS(c) (G_TYPE_CHECK_CLASS_TYPE ((o), TRACKER_TYPE_DB_CURSOR))
#define TRACKER_DB_CURSOR_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), TRACKER_TYPE_DB_CURSOR, TrackerDBCursorClass))
#define TRACKER_DB_INTERFACE_ERROR (tracker_db_interface_error_quark ())
typedef void (*TrackerBusyCallback) (const gchar *status,
gdouble progress,
gpointer user_data);
typedef enum {
TRACKER_DB_QUERY_ERROR,
TRACKER_DB_INTERRUPTED,
TRACKER_DB_OPEN_ERROR,
TRACKER_DB_NO_SPACE,
TRACKER_DB_CONSTRAINT,
} TrackerDBInterfaceError;
typedef enum {
TRACKER_DB_STATEMENT_CACHE_TYPE_SELECT,
TRACKER_DB_STATEMENT_CACHE_TYPE_UPDATE,
TRACKER_DB_STATEMENT_CACHE_TYPE_NONE
} TrackerDBStatementCacheType;
typedef struct TrackerDBInterface TrackerDBInterface;
typedef struct TrackerDBInterfaceClass TrackerDBInterfaceClass;
typedef struct TrackerDBStatement TrackerDBStatement;
typedef struct TrackerDBStatementClass TrackerDBStatementClass;
typedef struct TrackerDBCursor TrackerDBCursor;
typedef struct TrackerDBCursorClass TrackerDBCursorClass;
GQuark tracker_db_interface_error_quark (void);
GType tracker_db_interface_get_type (void);
GType tracker_db_statement_get_type (void);
GType tracker_db_cursor_get_type (void);
void tracker_db_interface_set_max_stmt_cache_size (TrackerDBInterface *db_interface,
TrackerDBStatementCacheType cache_type,
guint max_size);
/* User data functions, mainly to attach the data manager */
void tracker_db_interface_set_user_data (TrackerDBInterface *interface,
gpointer user_data,
GDestroyNotify destroy_notify);
gpointer tracker_db_interface_get_user_data (TrackerDBInterface *interface);
/* Functions to create queries/procedures */
TrackerDBStatement * tracker_db_interface_create_statement (TrackerDBInterface *db_interface,
TrackerDBStatementCacheType cache_type,
GError **error,
const gchar *query);
TrackerDBStatement * tracker_db_interface_create_vstatement (TrackerDBInterface *interface,
TrackerDBStatementCacheType cache_type,
GError **error,
const gchar *query,
...) G_GNUC_PRINTF (4, 5);
void tracker_db_interface_execute_vquery (TrackerDBInterface *interface,
GError **error,
const gchar *query,
va_list args);
void tracker_db_interface_execute_query (TrackerDBInterface *interface,
GError **error,
const gchar *query,
...) G_GNUC_PRINTF (3, 4);
gboolean tracker_db_interface_start_transaction (TrackerDBInterface *interface);
gboolean tracker_db_interface_end_db_transaction (TrackerDBInterface *interface,
GError **error);
gboolean tracker_db_interface_get_is_used (TrackerDBInterface *interface);
void tracker_db_statement_bind_double (TrackerDBStatement *stmt,
int index,
double value);
void tracker_db_statement_bind_int (TrackerDBStatement *stmt,
int index,
gint64 value);
void tracker_db_statement_bind_null (TrackerDBStatement *stmt,
int index);
void tracker_db_statement_bind_text (TrackerDBStatement *stmt,
int index,
const gchar *value);
void tracker_db_statement_bind_bytes (TrackerDBStatement *stmt,
int index,
GBytes *value);
void tracker_db_statement_bind_value (TrackerDBStatement *stmt,
int index,
const GValue *value);
void tracker_db_statement_execute (TrackerDBStatement *stmt,
GError **error);
TrackerDBCursor * tracker_db_statement_start_cursor (TrackerDBStatement *stmt,
GError **error);
TrackerDBCursor * tracker_db_statement_start_sparql_cursor (TrackerDBStatement *stmt,
TrackerPropertyType *types,
gint n_types,
const gchar * const *variable_names,
gint n_variable_names,
GError **error);
/* Functions to deal with a cursor */
void tracker_db_cursor_rewind (TrackerDBCursor *cursor);
gboolean tracker_db_cursor_iter_next (TrackerDBCursor *cursor,
GCancellable *cancellable,
GError **error);
guint tracker_db_cursor_get_n_columns (TrackerDBCursor *cursor);
const gchar* tracker_db_cursor_get_variable_name (TrackerDBCursor *cursor,
guint column);
TrackerSparqlValueType tracker_db_cursor_get_value_type (TrackerDBCursor *cursor,
guint column);
void tracker_db_cursor_get_value (TrackerDBCursor *cursor,
guint column,
GValue *value);
const gchar* tracker_db_cursor_get_string (TrackerDBCursor *cursor,
guint column,
glong *length);
gint64 tracker_db_cursor_get_int (TrackerDBCursor *cursor,
guint column);
gdouble tracker_db_cursor_get_double (TrackerDBCursor *cursor,
guint column);
G_END_DECLS
#endif /* __LIBTRACKER_DB_INTERFACE_H__ */
|
