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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
|
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
*
* Copyright (C) 2009 Sun Microsystems
*
* Authors:
*
* Jay Pipes <joinfu@sun.com>
*
* 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; version 2 of the License.
*
* 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 St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* @file
*
* Declarations of various routines that can be used to convert
* Transaction messages to other formats, including SQL statements.
*/
#ifndef DRIZZLED_MESSAGE_STATEMENT_TRANSFORM_H
#define DRIZZLED_MESSAGE_STATEMENT_TRANSFORM_H
#include <drizzled/message/table.pb.h>
#include <string>
#include <vector>
namespace drizzled
{
namespace message
{
/* some forward declarations */
class Statement;
class InsertHeader;
class InsertData;
class InsertRecord;
class UpdateHeader;
class UpdateData;
class UpdateRecord;
class DeleteHeader;
class DeleteData;
class DeleteRecord;
class TruncateTableStatement;
class SetVariableStatement;
/** A Variation of SQL to be output during transformation */
enum TransformSqlVariant
{
ANSI,
MYSQL_4,
MYSQL_5,
DRIZZLE
};
/** Error codes which can happen during tranformations */
enum TransformSqlError
{
NONE= 0,
MISSING_HEADER= 1, /* A data segment without a header segment was found */
MISSING_DATA= 2 /* A header segment without a data segment was found */
};
/**
* This function looks at the Statement
* message and appends one or more correctly-formatted SQL
* strings to the supplied vector of strings.
*
* @param Statement message to transform
* @param Vector of strings to append SQL statements to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformStatementToSql(const Statement &source,
std::vector<std::string> &sql_strings,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* This function looks at a supplied InsertHeader
* and InsertData message and constructs a correctly-formatted SQL
* statement to the supplied destination string.
*
* @note
*
* This function is used when you want to construct a <strong>
* single SQL statement</strong> from an entire InsertHeader and
* InsertData message. If there are many records in the InsertData
* message, the SQL statement will be a multi-value INSERT statement.
*
* @param InsertHeader message to transform
* @param InsertData message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformInsertStatementToSql(const InsertHeader &header,
const InsertData &data,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* This function looks at a supplied InsertHeader
* and a single InsertRecord message and constructs a correctly-formatted
* SQL statement to the supplied destination string.
*
* @param InsertHeader message to transform
* @param InsertRecord message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformInsertRecordToSql(const InsertHeader &header,
const InsertRecord &record,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* Helper function to construct the header portion of an INSERT
* SQL statement from an InsertHeader message.
*
* @param InsertHeader message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformInsertHeaderToSql(const InsertHeader &header,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* Helper function to construct the header portion of an UPDATE
* SQL statement from an UpdateHeader message.
*
* @param UpdateHeader message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformUpdateHeaderToSql(const UpdateHeader &header,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* This function looks at a supplied UpdateHeader
* and a single UpdateRecord message and constructs a correctly-formatted
* SQL statement to the supplied destination string.
*
* @param UpdateHeader message to transform
* @param UpdateRecord message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformUpdateRecordToSql(const UpdateHeader &header,
const UpdateRecord &record,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* This function looks at a supplied DeleteHeader
* and DeleteData message and constructs a correctly-formatted SQL
* statement to the supplied destination string.
*
* @note
*
* This function constructs a <strong>single SQL statement</strong>
* for all keys in the DeleteData message.
*
* @param DeleteHeader message to transform
* @param DeleteData message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformDeleteStatementToSql(const DeleteHeader &header,
const DeleteData &data,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* This function looks at a supplied DeleteHeader
* and a single DeleteRecord message and constructs a correctly-formatted
* SQL statement to the supplied destination string.
*
* @param DeleteHeader message to transform
* @param DeleteRecord message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformDeleteRecordToSql(const DeleteHeader &header,
const DeleteRecord &record,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* Helper function to construct the header portion of a DELETE
* SQL statement from an DeleteHeader message.
*
* @param DeleteHeader message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformDeleteHeaderToSql(const DeleteHeader &header,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* This function looks at a supplied TruncateTableStatement
* and constructs a correctly-formatted SQL
* statement to the supplied destination string.
*
* @param TruncateTableStatement message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformTruncateTableStatementToSql(const TruncateTableStatement &statement,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* This function looks at a supplied SetVariableStatement
* and constructs a correctly-formatted SQL
* statement to the supplied destination string.
*
* @param SetVariableStatement message to transform
* @param Destination string to append SQL to
* @param Variation of SQL to generate
*
* @retval
* NONE if successful transformation
* @retval
* Error code (see enum TransformSqlError definition) if failure
*/
enum TransformSqlError
transformSetVariableStatementToSql(const SetVariableStatement &statement,
std::string *destination,
enum TransformSqlVariant sql_variant= DRIZZLE);
/**
* Returns true if the supplied message::Table::Field::FieldType
* should have its values quoted when modifying values.
*
* @param[in] type of field
*/
bool shouldQuoteFieldValue(Table::Field::FieldType in_type);
} /* end namespace drizzled::message */
} /* end namespace drizzled */
#endif /* DRIZZLED_MESSAGE_STATEMENT_TRANSFORM_H */
|