← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/transaction_services.h

  • Committer: patrick crews
  • Date: 2010-09-29 15:15:19 UTC
  • mfrom: (1099.4.188 drizzle)
  • Revision ID: gleebix@gmail.com-20100929151519-6mrmzd1ciw2p9nws
Tags: 2010.09.1802
Update translations

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/transaction_services.h
1
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
3
 *
4
 
 *  Copyright (C) 2008 Sun Microsystems, Inc.
5
 
 *  Copyright (C) 2010 Jay Pipes <jaypipes@gmail.com>
 
4
 *  Copyright (C) 2008 Sun Microsystems
 
5
 *  Copyright (c) 2010 Jay Pipes <jaypipes@gmail.com>
6
6
 *
7
7
 *  This program is free software; you can redistribute it and/or modify
8
8
 *  it under the terms of the GNU General Public License as published by
25
25
#ifndef DRIZZLED_TRANSACTION_SERVICES_H
26
26
#define DRIZZLED_TRANSACTION_SERVICES_H
27
27
 
28
 
#include <drizzled/atomics.h>
29
 
#include <drizzled/message/transaction.pb.h>
30
 
#include <drizzled/identifier/table.h>
31
 
#include <drizzled/message/schema.h>
32
 
#include <drizzled/session.h>
33
 
 
34
 
#include "drizzled/visibility.h"
 
28
#include "drizzled/atomics.h"
 
29
#include "drizzled/message/transaction.pb.h"
35
30
 
36
31
namespace drizzled
37
32
{
41
36
{
42
37
  class MonitoredInTransaction;
43
38
  class XaResourceManager;
44
 
  class XaStorageEngine;
45
39
  class TransactionalStorageEngine;
46
40
}
47
41
 
48
42
class Session;
49
43
class NamedSavepoint;
50
44
class Field;
51
 
 
 
45
 
52
46
/**
53
47
 * This is a class which manages the XA transaction processing
54
48
 * in the server
55
49
 */
56
 
class DRIZZLED_API TransactionServices
 
50
class TransactionServices
57
51
{
58
52
public:
59
53
  static const size_t DEFAULT_RECORD_SIZE= 100;
60
 
  
61
 
  TransactionServices();
 
54
  typedef uint64_t TransactionId;
 
55
  /**
 
56
   * Constructor
 
57
   */
 
58
  TransactionServices()
 
59
  {
 
60
    /**
 
61
     * @todo set transaction ID to the last one from an applier...
 
62
     */
 
63
    current_transaction_id= 0;
 
64
  }
62
65
 
63
66
  /**
64
67
   * Singleton method
75
78
   * Transaction and Statement messages, false otherwise.
76
79
   */
77
80
  bool shouldConstructMessages();
78
 
 
 
81
  /**
 
82
   * Method which returns the active Transaction message
 
83
   * for the supplied Session.  If one is not found, a new Transaction
 
84
   * message is allocated, initialized, and returned. It is possible that
 
85
   * we may want to NOT increment the transaction id for a new Transaction
 
86
   * object (e.g., splitting up Transactions into smaller chunks). The
 
87
   * should_inc_trx_id flag controls if we do this.
 
88
   *
 
89
   * @param in_session The session processing the transaction
 
90
   * @param should_inc_trx_id If true, increments the transaction id for a new trx
 
91
   */
 
92
  message::Transaction *getActiveTransactionMessage(Session *in_session,
 
93
                                                    bool should_inc_trx_id= true);
 
94
  /** 
 
95
   * Method which attaches a transaction context
 
96
   * the supplied transaction based on the supplied Session's
 
97
   * transaction information.  This method also ensure the
 
98
   * transaction message is attached properly to the Session object
 
99
   *
 
100
   * @param in_transaction The transaction message to initialize
 
101
   * @param in_session The Session processing this transaction
 
102
   * @param should_inc_trx_id If true, increments the transaction id for a new trx
 
103
   */
 
104
  void initTransactionMessage(message::Transaction &in_transaction,
 
105
                              Session *in_session,
 
106
                              bool should_inc_trx_id);
 
107
  /** 
 
108
   * Helper method which finalizes data members for the 
 
109
   * supplied transaction's context.
 
110
   *
 
111
   * @param in_transaction The transaction message to finalize 
 
112
   * @param in_session The Session processing this transaction
 
113
   */
 
114
  void finalizeTransactionMessage(message::Transaction &in_transaction, Session *in_session);
 
115
  /**
 
116
   * Helper method which deletes transaction memory and
 
117
   * unsets Session's transaction and statement messages.
 
118
   */
 
119
  void cleanupTransactionMessage(message::Transaction *in_transaction,
 
120
                                 Session *in_session);
 
121
  /**
 
122
   * Helper method which initializes a Statement message
 
123
   *
 
124
   * @param statement The statement to initialize
 
125
   * @param in_type The type of the statement
 
126
   * @param in_session The session processing this statement
 
127
   */
 
128
  void initStatementMessage(message::Statement &statement,
 
129
                            message::Statement::Type in_type,
 
130
                            Session *in_session);
79
131
  /**
80
132
   * Finalizes a Statement message and sets the Session's statement
81
133
   * message to NULL.
82
134
   *
83
135
   * @param statement The statement to initialize
84
 
   * @param session The Session object processing this statement
 
136
   * @param in_session The session processing this statement
85
137
   */
86
138
  void finalizeStatementMessage(message::Statement &statement,
87
 
                                Session::reference session);
88
 
 
 
139
                                Session *in_session);
 
140
  /** Helper method which returns an initialized Statement message for methods
 
141
   * doing insertion of data.
 
142
   *
 
143
   * @param[in] in_session Pointer to the Session doing the processing
 
144
   * @param[in] in_table Pointer to the Table object being inserted into
 
145
   * @param[out] next_segment_id The next Statement segment id to be used
 
146
   */
 
147
  message::Statement &getInsertStatement(Session *in_session,
 
148
                                         Table *in_table,
 
149
                                         uint32_t *next_segment_id);
 
150
 
 
151
  /**
 
152
   * Helper method which initializes the header message for
 
153
   * insert operations.
 
154
   *
 
155
   * @param[in,out] statement Statement message container to modify
 
156
   * @param[in] in_session Pointer to the Session doing the processing
 
157
   * @param[in] in_table Pointer to the Table being inserted into
 
158
   */
 
159
  void setInsertHeader(message::Statement &statement,
 
160
                       Session *in_session,
 
161
                       Table *in_table);
 
162
  /**
 
163
   * Helper method which returns an initialized Statement
 
164
   * message for methods doing updates of data.
 
165
   *
 
166
   * @param[in] in_session Pointer to the Session doing the processing
 
167
   * @param[in] in_table Pointer to the Table object being updated
 
168
   * @param[in] old_record Pointer to the old data in the record
 
169
   * @param[in] new_record Pointer to the new data in the record
 
170
   * @param[out] next_segment_id The next Statement segment id to be used
 
171
   */
 
172
  message::Statement &getUpdateStatement(Session *in_session,
 
173
                                         Table *in_table,
 
174
                                         const unsigned char *old_record, 
 
175
                                         const unsigned char *new_record,
 
176
                                         uint32_t *next_segment_id);
 
177
  /**
 
178
   * Helper method which initializes the header message for
 
179
   * update operations.
 
180
   *
 
181
   * @param[in,out] statement Statement message container to modify
 
182
   * @param[in] in_session Pointer to the Session doing the processing
 
183
   * @param[in] in_table Pointer to the Table being updated
 
184
   * @param[in] old_record Pointer to the old data in the record
 
185
   * @param[in] new_record Pointer to the new data in the record
 
186
   */
 
187
  void setUpdateHeader(message::Statement &statement,
 
188
                       Session *in_session,
 
189
                       Table *in_table,
 
190
                       const unsigned char *old_record, 
 
191
                       const unsigned char *new_record);
 
192
  /**
 
193
   * Helper method which returns an initialized Statement
 
194
   * message for methods doing deletion of data.
 
195
   *
 
196
   * @param[in] in_session Pointer to the Session doing the processing
 
197
   * @param[in] in_table Pointer to the Table object being deleted from
 
198
   * @param[out] next_segment_id The next Statement segment id to be used
 
199
   */
 
200
  message::Statement &getDeleteStatement(Session *in_session,
 
201
                                         Table *in_table,
 
202
                                         uint32_t *next_segment_id);
 
203
 
 
204
  /**
 
205
   * Helper method which initializes the header message for
 
206
   * insert operations.
 
207
   *
 
208
   * @param[in,out] statement Statement message container to modify
 
209
   * @param[in] in_session Pointer to the Session doing the processing
 
210
   * @param[in] in_table Pointer to the Table being deleted from
 
211
   */
 
212
  void setDeleteHeader(message::Statement &statement,
 
213
                       Session *in_session,
 
214
                       Table *in_table);
 
215
  /** 
 
216
   * Commits a normal transaction (see above) and pushes the transaction
 
217
   * message out to the replicators.
 
218
   *
 
219
   * @param in_session Pointer to the Session committing the transaction
 
220
   */
 
221
  int commitTransactionMessage(Session *in_session);
 
222
  /** 
 
223
   * Marks the current active transaction message as being rolled back and
 
224
   * pushes the transaction message out to replicators.
 
225
   *
 
226
   * @param in_session Pointer to the Session committing the transaction
 
227
   */
 
228
  void rollbackTransactionMessage(Session *in_session);
89
229
  /**
90
230
   * Creates a new InsertRecord GPB message and pushes it to
91
231
   * replicators.
92
232
   *
93
 
   * @param session Session object which has inserted a record
94
 
   * @param table Table object containing insert information
 
233
   * @param in_session Pointer to the Session which has inserted a record
 
234
   * @param in_table Pointer to the Table containing insert information
95
235
   *
96
236
   * Grr, returning "true" here on error because of the cursor
97
237
   * reversed bool return crap...fix that.
98
238
   */
99
 
  bool insertRecord(Session::reference session, Table &in_table);
100
 
 
 
239
  bool insertRecord(Session *in_session, Table *in_table);
101
240
  /**
102
241
   * Creates a new UpdateRecord GPB message and pushes it to
103
242
   * replicators.
104
243
   *
105
 
   * @param session Session object which has updated a record
106
 
   * @param table Table object containing update information
 
244
   * @param in_session Pointer to the Session which has updated a record
 
245
   * @param in_table Pointer to the Table containing update information
107
246
   * @param old_record Pointer to the raw bytes representing the old record/row
108
247
   * @param new_record Pointer to the raw bytes representing the new record/row 
109
248
   */
110
 
  void updateRecord(Session::reference session, 
111
 
                    Table &table, 
 
249
  void updateRecord(Session *in_session, 
 
250
                    Table *in_table, 
112
251
                    const unsigned char *old_record, 
113
252
                    const unsigned char *new_record);
114
 
 
115
253
  /**
116
254
   * Creates a new DeleteRecord GPB message and pushes it to
117
255
   * replicators.
118
256
   *
119
 
   * @param session Session object which has deleted a record
120
 
   * @param table Table object containing delete information
 
257
   * @param in_session Pointer to the Session which has deleted a record
 
258
   * @param in_table Pointer to the Table containing delete information
121
259
   * @param use_update_record If true, uses the values from the update row instead
122
260
   */
123
 
  void deleteRecord(Session::reference session,
124
 
                    Table &table,
125
 
                    bool use_update_record= false);
126
 
 
 
261
  void deleteRecord(Session *in_session, Table *in_table, bool use_update_record= false);
127
262
  /**
128
263
   * Creates a CreateSchema Statement GPB message and adds it
129
264
   * to the Session's active Transaction GPB message for pushing
130
265
   * out to the replicator streams.
131
266
   *
132
 
   * @param[in] session Session object which issued the statement
 
267
   * @param[in] in_session Pointer to the Session which issued the statement
133
268
   * @param[in] schema message::Schema message describing new schema
134
269
   */
135
 
  void createSchema(Session::reference session, const message::Schema &schema);
136
 
 
 
270
  void createSchema(Session *in_session, const message::Schema &schema);
137
271
  /**
138
272
   * Creates a DropSchema Statement GPB message and adds it
139
273
   * to the Session's active Transaction GPB message for pushing
140
274
   * out to the replicator streams.
141
275
   *
142
 
   * @param[in] session Session object which issued the statement
143
 
   * @param[in] identifier Identifier for the schema to drop
144
 
   */
145
 
  void dropSchema(Session::reference session,
146
 
                  identifier::Schema::const_reference identifier);
147
 
 
148
 
  /**
149
 
   * Creates an AlterSchema Statement GPB message and adds it
150
 
   * to the Session's active Transaction GPB message for pushing
151
 
   * out to the replicator streams.
152
 
   *
153
 
   * @param[in] session Session object which issued the statement
154
 
   * @param[in] old_schema Original schema definition
155
 
   * @param[in] new_schema New schema definition
156
 
   */
157
 
  void alterSchema(Session::reference session,
158
 
                   const message::schema::shared_ptr &old_schema,
159
 
                   const message::Schema &new_schema);
160
 
 
 
276
   * @param[in] in_session Pointer to the Session which issued the statement
 
277
   * @param[in] schema_name message::Schema message describing new schema
 
278
   */
 
279
  void dropSchema(Session *in_session, const std::string &schema_name);
161
280
  /**
162
281
   * Creates a CreateTable Statement GPB message and adds it
163
282
   * to the Session's active Transaction GPB message for pushing
164
283
   * out to the replicator streams.
165
284
   *
166
 
   * @param[in] session Session object which issued the statement
 
285
   * @param[in] in_session Pointer to the Session which issued the statement
167
286
   * @param[in] table message::Table message describing new schema
168
287
   */
169
 
  void createTable(Session::reference session, const message::Table &table);
170
 
 
 
288
  void createTable(Session *in_session, const message::Table &table);
171
289
  /**
172
290
   * Creates a DropTable Statement GPB message and adds it
173
291
   * to the Session's active Transaction GPB message for pushing
174
292
   * out to the replicator streams.
175
293
   *
176
 
   * @param[in] session Session object which issued the statement
177
 
   * @param[in] table Identifier for the table being dropped
 
294
   * @param[in] in_session Pointer to the Session which issued the statement
 
295
   * @param[in] schema_name The schema of the table being dropped
 
296
   * @param[in] table_name The table name of the table being dropped
178
297
   * @param[in] if_exists Did the user specify an IF EXISTS clause?
179
298
   */
180
 
  void dropTable(Session::reference session,
181
 
                 const identifier::Table &table,
182
 
                 bool if_exists);
183
 
 
 
299
  void dropTable(Session *in_session,
 
300
                     const std::string &schema_name,
 
301
                     const std::string &table_name,
 
302
                     bool if_exists);
184
303
  /**
185
304
   * Creates a TruncateTable Statement GPB message and adds it
186
305
   * to the Session's active Transaction GPB message for pushing
187
306
   * out to the replicator streams.
188
307
   *
189
 
   * @param[in] session Session object which issued the statement
190
 
   * @param[in] table The Table being truncated
 
308
   * @param[in] in_session Pointer to the Session which issued the statement
 
309
   * @param[in] in_table The Table being truncated
191
310
   */
192
 
  void truncateTable(Session::reference session, Table &table);
193
 
 
 
311
  void truncateTable(Session *in_session, Table *in_table);
194
312
  /**
195
313
   * Creates a new RawSql GPB message and pushes it to 
196
314
   * replicators.
200
318
   * on the I_S, etc.  Not sure what to do with administrative
201
319
   * commands like CHECK TABLE, though..
202
320
   *
203
 
   * @param session Session object which issued the statement
 
321
   * @param in_session Pointer to the Session which issued the statement
204
322
   * @param query Query string
205
323
   */
206
 
  void rawStatement(Session::reference session, const std::string &query);
207
 
 
 
324
  void rawStatement(Session *in_session, const std::string &query);
208
325
  /* transactions: interface to plugin::StorageEngine functions */
209
 
  int rollbackTransaction(Session::reference session, bool all);
210
 
 
211
 
  /**
212
 
   * Commit the current transaction.
213
 
   *
214
 
   * @retval 0 ok
215
 
   * @retval 1 transaction was rolled back
216
 
   * @retval 2 error during commit, data may be inconsistent
217
 
   *
218
 
   * @todo
219
 
   * Since we don't support nested statement transactions in 5.0,
220
 
   * we can't commit or rollback stmt transactions while we are inside
221
 
   * stored functions or triggers. So we simply do nothing now.
222
 
   * This should be fixed in later ( >= 5.1) releases.
223
 
   */
224
 
  int commitTransaction(Session::reference session, bool all);
225
 
 
226
 
  /**
227
 
   * This is used to commit or rollback a single statement depending on
228
 
   * the value of error.
229
 
   *
230
 
   * @note
231
 
   * Note that if the autocommit is on, then the following call inside
232
 
   * InnoDB will commit or rollback the whole transaction (= the statement). The
233
 
   * autocommit mechanism built into InnoDB is based on counting locks, but if
234
 
   * the user has used LOCK TABLES then that mechanism does not know to do the
235
 
   * commit.
236
 
   */
237
 
  int autocommitOrRollback(Session::reference session, int error);
 
326
  int commitPhaseOne(Session *session, bool all);
 
327
  int rollbackTransaction(Session *session, bool all);
 
328
 
 
329
  /* transactions: these functions never call plugin::StorageEngine functions directly */
 
330
  int commitTransaction(Session *session, bool all);
 
331
  int autocommitOrRollback(Session *session, int error);
238
332
 
239
333
  /* savepoints */
240
 
  int rollbackToSavepoint(Session::reference session, NamedSavepoint &sv);
241
 
  int setSavepoint(Session::reference session, NamedSavepoint &sv);
242
 
  int releaseSavepoint(Session::reference session, NamedSavepoint &sv);
 
334
  int rollbackToSavepoint(Session *session, NamedSavepoint &sv);
 
335
  int setSavepoint(Session *session, NamedSavepoint &sv);
 
336
  int releaseSavepoint(Session *session, NamedSavepoint &sv);
243
337
 
244
338
  /**
245
339
   * Marks a storage engine as participating in a statement
255
349
   * per statement, and therefore should not need to be idempotent.
256
350
   * Put in assert()s to test this.
257
351
   *
258
 
   * @param[in] session Session object
 
352
   * @param[in] session Session pointer
259
353
   * @param[in] monitored Descriptor for the resource which will be participating
260
354
   * @param[in] engine Pointer to the TransactionalStorageEngine resource
261
355
   */
262
 
  void registerResourceForStatement(Session::reference session,
 
356
  void registerResourceForStatement(Session *session,
263
357
                                    plugin::MonitoredInTransaction *monitored,
264
358
                                    plugin::TransactionalStorageEngine *engine);
265
359
 
277
371
   * per statement, and therefore should not need to be idempotent.
278
372
   * Put in assert()s to test this.
279
373
   *
280
 
   * @param[in] session Session object
 
374
   * @param[in] session Session pointer
281
375
   * @param[in] monitored Descriptor for the resource which will be participating
282
376
   * @param[in] engine Pointer to the TransactionalStorageEngine resource
283
377
   * @param[in] resource_manager Pointer to the XaResourceManager resource manager
284
378
   */
285
 
  void registerResourceForStatement(Session::reference session,
 
379
  void registerResourceForStatement(Session *session,
286
380
                                    plugin::MonitoredInTransaction *monitored,
287
381
                                    plugin::TransactionalStorageEngine *engine,
288
382
                                    plugin::XaResourceManager *resource_manager);
311
405
   * time when this method is called except from the
312
406
   * TransactionServices::registerResourceForStatement method.
313
407
   */
314
 
  void registerResourceForTransaction(Session::reference session,
 
408
  void registerResourceForTransaction(Session *session,
315
409
                                      plugin::MonitoredInTransaction *monitored,
316
410
                                      plugin::TransactionalStorageEngine *engine);
317
 
 
318
 
  void registerResourceForTransaction(Session::reference session,
 
411
  void registerResourceForTransaction(Session *session,
319
412
                                      plugin::MonitoredInTransaction *monitored,
320
413
                                      plugin::TransactionalStorageEngine *engine,
321
414
                                      plugin::XaResourceManager *resource_manager);
322
 
 
323
 
  void allocateNewTransactionId();
324
 
 
325
 
  /**************
326
 
   * Events API
327
 
   **************/
328
 
 
329
 
  /**
330
 
   * Send server startup event.
331
 
   *
332
 
   * @param session Session object
333
 
   *
334
 
   * @retval true Success
335
 
   * @retval false Failure
336
 
   */
337
 
  bool sendStartupEvent(Session::reference session);
338
 
 
339
 
  /**
340
 
   * Send server shutdown event.
341
 
   *
342
 
   * @param session Session object
343
 
   *
344
 
   * @retval true Success
345
 
   * @retval false Failure
346
 
   */
347
 
  bool sendShutdownEvent(Session::reference session);
348
 
 
 
415
  TransactionId getNextTransactionId()
 
416
  {
 
417
    return current_transaction_id.increment();
 
418
  }
 
419
  TransactionId getCurrentTransactionId()
 
420
  {
 
421
    return current_transaction_id;
 
422
  }
 
423
  /**
 
424
   * DEBUG ONLY.  See plugin::TransactionLog::truncate()
 
425
   */
 
426
  void resetTransactionId()
 
427
  {
 
428
    current_transaction_id= 0;
 
429
  }
349
430
private:
350
 
 
351
 
  /**
352
 
   * Method which returns the active Transaction message
353
 
   * for the supplied Session.  If one is not found, a new Transaction
354
 
   * message is allocated, initialized, and returned. It is possible that
355
 
   * we may want to NOT increment the transaction id for a new Transaction
356
 
   * object (e.g., splitting up Transactions into smaller chunks). The
357
 
   * should_inc_trx_id flag controls if we do this.
358
 
   *
359
 
   * @param session The Session object processing the transaction
360
 
   * @param should_inc_trx_id If true, increments the transaction id for a new trx
361
 
   */
362
 
  message::Transaction *getActiveTransactionMessage(Session::reference session,
363
 
                                                    bool should_inc_trx_id= true);
364
 
 
365
 
  /** 
366
 
   * Method which attaches a transaction context
367
 
   * the supplied transaction based on the supplied Session's
368
 
   * transaction information.  This method also ensure the
369
 
   * transaction message is attached properly to the Session object
370
 
   *
371
 
   * @param transaction The transaction message to initialize
372
 
   * @param session The Session object processing this transaction
373
 
   * @param should_inc_trx_id If true, increments the transaction id for a new trx
374
 
   */
375
 
  void initTransactionMessage(message::Transaction &transaction,
376
 
                              Session::reference session,
377
 
                              bool should_inc_trx_id);
378
 
  
379
 
  /**
380
 
   * Helper method which initializes a Statement message
381
 
   *
382
 
   * @param statement The statement to initialize
383
 
   * @param type The type of the statement
384
 
   * @param session The Session object processing this statement
385
 
   */
386
 
  void initStatementMessage(message::Statement &statement,
387
 
                            message::Statement::Type type,
388
 
                            Session::const_reference session);
389
 
 
390
 
  /** 
391
 
   * Helper method which finalizes data members for the 
392
 
   * supplied transaction's context.
393
 
   *
394
 
   * @param transaction The transaction message to finalize 
395
 
   * @param session The Session object processing this transaction
396
 
   */
397
 
  void finalizeTransactionMessage(message::Transaction &transaction,
398
 
                                  Session::const_reference session);
399
 
 
400
 
  /**
401
 
   * Helper method which deletes transaction memory and
402
 
   * unsets Session's transaction and statement messages.
403
 
   */
404
 
  void cleanupTransactionMessage(message::Transaction *transaction,
405
 
                                 Session::reference session);
406
 
  
407
 
  /** Helper method which returns an initialized Statement message for methods
408
 
   * doing insertion of data.
409
 
   *
410
 
   * @param[in] session Session object doing the processing
411
 
   * @param[in] table Table object being inserted into
412
 
   * @param[out] next_segment_id The next Statement segment id to be used
413
 
   */
414
 
  message::Statement &getInsertStatement(Session::reference session,
415
 
                                         Table &table,
416
 
                                         uint32_t *next_segment_id);
417
 
  
418
 
  /**
419
 
   * Helper method which initializes the header message for
420
 
   * insert operations.
421
 
   *
422
 
   * @param[in,out] statement Statement message container to modify
423
 
   * @param[in] session Session object doing the processing
424
 
   * @param[in] table Table object being inserted into
425
 
   */
426
 
  void setInsertHeader(message::Statement &statement,
427
 
                       Session::const_reference session,
428
 
                       Table &table);
429
 
  /**
430
 
   * Helper method which returns an initialized Statement
431
 
   * message for methods doing updates of data.
432
 
   *
433
 
   * @param[in] session Session object doing the processing
434
 
   * @param[in] table Table object being updated
435
 
   * @param[in] old_record Pointer to the old data in the record
436
 
   * @param[in] new_record Pointer to the new data in the record
437
 
   * @param[out] next_segment_id The next Statement segment id to be used
438
 
   */
439
 
  message::Statement &getUpdateStatement(Session::reference session,
440
 
                                         Table &table,
441
 
                                         const unsigned char *old_record, 
442
 
                                         const unsigned char *new_record,
443
 
                                         uint32_t *next_segment_id);
444
 
  /**
445
 
   * Helper method which initializes the header message for
446
 
   * update operations.
447
 
   *
448
 
   * @param[in,out] statement Statement message container to modify
449
 
   * @param[in] session Session object doing the processing
450
 
   * @param[in] table Table object being updated
451
 
   * @param[in] old_record Pointer to the old data in the record
452
 
   * @param[in] new_record Pointer to the new data in the record
453
 
   */
454
 
  void setUpdateHeader(message::Statement &statement,
455
 
                       Session::const_reference session,
456
 
                       Table &table,
457
 
                       const unsigned char *old_record, 
458
 
                       const unsigned char *new_record);
459
 
 
460
 
  /**
461
 
   * Helper method which returns an initialized Statement
462
 
   * message for methods doing deletion of data.
463
 
   *
464
 
   * @param[in] session Session object doing the processing
465
 
   * @param[in] table Table object being deleted from
466
 
   * @param[out] next_segment_id The next Statement segment id to be used
467
 
   */
468
 
  message::Statement &getDeleteStatement(Session::reference session,
469
 
                                         Table &table,
470
 
                                         uint32_t *next_segment_id);
471
 
  
472
 
  /**
473
 
   * Helper method which initializes the header message for
474
 
   * insert operations.
475
 
   *
476
 
   * @param[in,out] statement Statement message container to modify
477
 
   * @param[in] session Session object doing the processing
478
 
   * @param[in] table Table object being deleted from
479
 
   */
480
 
  void setDeleteHeader(message::Statement &statement,
481
 
                       Session::const_reference session,
482
 
                       Table &table);
483
 
 
484
 
  /** 
485
 
   * Commits a normal transaction (see above) and pushes the transaction
486
 
   * message out to the replicators.
487
 
   *
488
 
   * @param session Session object committing the transaction
489
 
   */
490
 
  int commitTransactionMessage(Session::reference session);
491
 
 
492
 
  /** 
493
 
   * Marks the current active transaction message as being rolled back and
494
 
   * pushes the transaction message out to replicators.
495
 
   *
496
 
   * @param session Session object committing the transaction
497
 
   */
498
 
  void rollbackTransactionMessage(Session::reference session);
499
 
 
500
 
  /**
501
 
   * Rolls back the current statement, deleting the last Statement out of
502
 
   * the current Transaction message.
503
 
   *
504
 
   * @param session Session object committing the transaction
505
 
   *
506
 
   * @note This depends on having clear statement boundaries (i.e., one
507
 
   * Statement message per actual SQL statement).
508
 
   */
509
 
  void rollbackStatementMessage(Session::reference session);
 
431
  atomic<TransactionId> current_transaction_id;
510
432
 
511
433
  /**
512
434
   * Checks if a field has been updated 
513
435
   *
514
436
   * @param current_field Pointer to the field to check if it is updated 
515
 
   * @param table Table object containing update information
 
437
   * @in_table Pointer to the Table containing update information
516
438
   * @param old_record Pointer to the raw bytes representing the old record/row
517
439
   * @param new_record Pointer to the raw bytes representing the new record/row
518
440
   */
519
441
  bool isFieldUpdated(Field *current_field,
520
 
                      Table &table,
 
442
                      Table *in_table,
521
443
                      const unsigned char *old_record,
522
444
                      const unsigned char *new_record);
523
 
 
524
 
  /**
525
 
   * Create a Transaction that contains event information and send it off.
526
 
   *
527
 
   * This differs from other uses of Transaction in that we don't use the
528
 
   * message associated with Session. We create a totally new message and
529
 
   * use it.
530
 
   *
531
 
   * @param session Session object
532
 
   * @param event Event message to send
533
 
   *
534
 
   * @note Used by the public Events API.
535
 
   *
536
 
   * @returns Non-zero on error
537
 
   */
538
 
  int sendEvent(Session::reference session, const message::Event &event);
539
 
 
540
 
  /**
541
 
   * Makes a given Transaction message segmented.
542
 
   *
543
 
   * The given Transaction message will have its segment information set
544
 
   * appropriately and a new Transaction message, containing the same
545
 
   * transaction ID as the supplied Transaction, and is created.
546
 
   *
547
 
   * @param session Session object
548
 
   * @param transaction Transaction message to segment.
549
 
   *
550
 
   * @returns Returns a pointer to a new Transaction message ready for use.
551
 
   */
552
 
  message::Transaction *segmentTransactionMessage(Session::reference session,
553
 
                                                  message::Transaction *transaction);
554
 
 
555
 
  int commitPhaseOne(Session::reference session, bool all);
556
 
 
557
 
  uint64_t getCurrentTransactionId(Session::reference session);
558
 
 
559
 
  plugin::XaStorageEngine *xa_storage_engine;
560
445
};
561
446
 
562
447
} /* namespace drizzled */