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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
|
/***************************************************************************
gb.db.h
(c) 2000-2017 Benoît Minisini <benoit.minisini@gambas-basic.org>
This program 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 2, 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
MA 02110-1301, USA.
***************************************************************************/
#ifndef __GB_DB_H
#define __GB_DB_H
#include "gambas.h"
#define DB_INTERFACE_VERSION 1
typedef
struct {
char *type;
char *host;
char *port;
char *name;
char *user;
char *password;
int options;
}
DB_DESC;
/* LIMIT position */
#define DB_LIMIT_NONE 0
#define DB_LIMIT_AT_BEGIN 1
#define DB_LIMIT_AT_END 2
#define DB_IGNORE_NONE 0
#define DB_IGNORE_INSERT 1
#define DB_IGNORE_ON_CONFLICT 2
typedef
struct {
void *handle; /* Connection handle */
int version; /* Version of the database server */
char *full_version; /* Full version of the database server */
char *charset; /* Charset used by the database server */
void *data; /* Can be used by the driver for storing its own private data */
int error; /* Last SQL error code raise by a query */
int timeout; /* Connection timeout */
int timezone; /* Timezone of dates (default to local timezone) */
unsigned ignore_case : 1; /* If table, field and index names are case sensitive */
struct {
unsigned no_table_type : 1; /* Tables do not have types */
unsigned no_serial : 1; /* Serial fields are not supported */
unsigned no_blob : 1; /* Blob fields are not supported */
unsigned no_seek : 1; /* Cannot seek anywhere in a Result */
unsigned no_nest : 1; /* Cannot nest transactions */
//unsigned no_case : 1; /* table, field and index names must be converted to lower case */
unsigned schema : 1; /* If table names can be prefixed by a schema name and a dot */
unsigned no_collation : 1; /* No collation support at field level */
unsigned no_returning : 1; /* Database does not support RETURNING keyword */
unsigned system : 1; /* system database */
unsigned if_not_exist : 2; // INSERT if not exist syntax type
}
flags;
struct {
const char *keyword; /* keyword for limiting the result of a query */
int pos; /* position of 'limit' keyword */
}
limit;
const char *db_name_char; /* These characters are allowed in a database name */
}
DB_DATABASE;
typedef
void *DB_RESULT;
typedef
struct _DB_FIELD {
struct _DB_FIELD *next;
char *name;
GB_TYPE type; /* gambas field type */
int length; /* max length for text fields (0 = no limit) */
GB_VARIANT_VALUE def; /* default value */
char *collation; /* field collation */
}
DB_FIELD;
typedef
struct {
char *table;
int nfield;
int nindex;
DB_FIELD *field;
int *index;
}
DB_INFO;
typedef
struct {
char *name;
char *fields; /* list of index fields separated by commas */
int unique; /* index is unique */
int primary; /* primary index */
}
DB_INDEX;
typedef
struct {
char *name;
char *password;
int admin; /* user is a superuser */
}
DB_USER;
typedef
struct {
GB_BASE ob;
char *data;
int length;
int constant;
}
DB_BLOB;
typedef
void (*DB_FORMAT_CALLBACK)(const char *, int);
typedef
void (*DB_SUBST_CALLBACK)(int, char **, int *, char);
typedef
void (*DB_OPTIONS_CALLBACK)(const char *, GB_VALUE *);
typedef
struct {
const char *name;
int (*Open)(DB_DESC *desc, DB_DATABASE *db);
void (*Close)(DB_DATABASE *db);
int (*Format)(GB_VALUE *val, DB_FORMAT_CALLBACK add);
void (*FormatBlob)(DB_BLOB *blob, DB_FORMAT_CALLBACK add);
int (*Exec)(DB_DATABASE *db, const char *, DB_RESULT *result, const char *err);
int (*Begin)(DB_DATABASE *db);
int (*Commit)(DB_DATABASE *db);
int (*Rollback)(DB_DATABASE *db);
GB_ARRAY (*GetCollations)(DB_DATABASE *db);
const char *(*GetQuote)(void);
int64_t (*GetLastInsertId)(DB_DATABASE *db);
struct {
void (*Init)(DB_RESULT result, DB_INFO *info, int *count);
int (*Fill)(DB_DATABASE *db, DB_RESULT result, int pos, GB_VARIANT_VALUE *buffer, int next);
void (*Blob)(DB_RESULT result, int pos, int field, DB_BLOB *blob);
void (*Release)(DB_RESULT result, DB_INFO *info, bool invalid);
struct {
GB_TYPE (*Type)(DB_RESULT result, int index);
char *(*Name)(DB_RESULT result, int index);
int (*Index)(DB_RESULT result, const char *name, DB_DATABASE *db);
int (*Length)(DB_RESULT result, int index);
}
Field;
}
Result;
struct {
int (*Exist)(DB_DATABASE *db, const char *table, const char *field);
int (*List)(DB_DATABASE *db, const char *table, char ***fields);
int (*Info)(DB_DATABASE *db, const char *table, const char *field, DB_FIELD *info);
}
Field;
struct {
int (*Init)(DB_DATABASE *db, const char *table, DB_INFO *info);
int (*Index)(DB_DATABASE *db, const char *table, DB_INFO *info);
void (*Release)(DB_DATABASE *db, DB_INFO *info);
int (*Exist)(DB_DATABASE *db, const char *table);
int (*List)(DB_DATABASE *db, char ***tables);
int (*PrimaryKey)(DB_DATABASE *db, const char *table, char ***primary);
int (*IsSystem)(DB_DATABASE *db, const char *table);
char *(*Type)(DB_DATABASE *db, const char *table, const char *type);
int (*Delete)(DB_DATABASE *db, const char *table);
int (*Create)(DB_DATABASE *db, const char *table, DB_FIELD *fields, char **primary, const char *tabletype);
}
Table;
struct {
int (*Exist)(DB_DATABASE *db, const char *table, const char *index);
int (*List)(DB_DATABASE *db, const char *table, char ***indexes);
int (*Info)(DB_DATABASE *db, const char *table, const char *index, DB_INDEX *info);
int (*Delete)(DB_DATABASE *db, const char *table, const char *index);
int (*Create)(DB_DATABASE *db, const char *table, const char *index, DB_INDEX *info);
}
Index;
struct {
int (*Exist)(DB_DATABASE *db, const char *name);
int (*List)(DB_DATABASE *db, char ***names);
int (*IsSystem)(DB_DATABASE *db, const char *name);
int (*Delete)(DB_DATABASE *db, const char *name);
int (*Create)(DB_DATABASE *db, const char *name);
}
Database;
struct {
int (*Exist)(DB_DATABASE *db, const char *user);
int (*List)(DB_DATABASE *db, char ***users);
int (*Info)(DB_DATABASE *db, const char *user, DB_USER *info);
int (*Delete)(DB_DATABASE *db, const char *user);
int (*Create)(DB_DATABASE *db, const char *user, DB_USER *info);
int (*SetPassword)(DB_DATABASE *db, const char *user, const char *password);
}
User;
}
DB_DRIVER;
typedef
struct {
intptr_t version;
void (*Register)(DB_DRIVER *);
void (*Format)(DB_DRIVER *, GB_VALUE *, DB_FORMAT_CALLBACK);
void (*FormatVariant)(DB_DRIVER *, GB_VARIANT_VALUE *, DB_FORMAT_CALLBACK);
bool (*IsDebug)();
void (*Debug)(const char *, const char *, ...);
void (*TryAnother)(const char *);
char *(*SubstString)(const char *, int, DB_SUBST_CALLBACK);
char *(*QuoteString)(const char *, int, char);
char *(*UnquoteString)(const char *, int, char);
DB_DATABASE *(*GetCurrentDatabase)();
void (*GetOptions)(DB_OPTIONS_CALLBACK);
struct {
void (*Init)(void);
void (*Add)(const char *);
void (*AddLower)(const char *);
void (*AddLength)(const char *, int);
char *(*Get)(void);
char *(*GetNew)(void);
int (*Length)(void);
}
Query;
struct {
int (*Find)(char **, const char *);
}
StringArray;
}
DB_INTERFACE;
/* Field datatypes */
#define DB_T_SERIAL ((GB_TYPE)-1)
#define DB_T_BLOB ((GB_TYPE)-2)
// Result.Fill() return values
#define DB_OK 0
#define DB_ERROR 1
#define DB_NO_DATA 2
/* Field Separator Character e.g. Table.field = Table.field */
#define FLD_SEP '.'
#endif /* __MAIN_H */
|
