← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/plugin/info_schema_table.h

Merge Stewart's dead code removal

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/plugin/info_schema_table.h
 
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2009 Sun Microsystems
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; either version 2 of the License, or
 
9
 *  (at your option) any later version.
 
10
 *
 
11
 *  This program is distributed in the hope that it will be useful,
 
12
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 *  GNU General Public License for more details.
 
15
 *
 
16
 *  You should have received a copy of the GNU General Public License
 
17
 *  along with this program; if not, write to the Free Software
 
18
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
19
 */
 
20
 
 
21
#ifndef DRIZZLED_PLUGIN_INFO_SCHEMA_TABLE_H
 
22
#define DRIZZLED_PLUGIN_INFO_SCHEMA_TABLE_H
 
23
 
 
24
#include <string>
 
25
 
 
26
namespace drizzled
 
27
{
 
28
namespace plugin
 
29
{
 
30
 
 
31
/**
 
32
 * @file
 
33
 *   info_schema.h
 
34
 * @brief 
 
35
 *   Header file which contains all classes related to I_S
 
36
 */
 
37
 
 
38
typedef class Item COND;
 
39
 
 
40
 
 
41
/**
 
42
 * @class ColumnInfo
 
43
 * @brief
 
44
 *   Represents a field (column) in an I_S table.
 
45
 */
 
46
class ColumnInfo 
 
47
{ 
 
48
public: 
 
49
  ColumnInfo(const std::string& in_name, 
 
50
             uint32_t in_length, 
 
51
             enum enum_field_types in_type,
 
52
             int32_t in_value,
 
53
             uint32_t in_flags,
 
54
             const std::string& in_old_name,
 
55
             uint32_t in_open_method)
 
56
    :
 
57
      name(in_name),
 
58
      length(in_length),
 
59
      type(in_type),
 
60
      value(in_value),
 
61
      flags(in_flags),
 
62
      old_name(in_old_name),
 
63
      open_method(in_open_method)
 
64
  {}
 
65
 
 
66
  ColumnInfo()
 
67
    :
 
68
      name(),
 
69
      length(0),
 
70
      type(DRIZZLE_TYPE_VARCHAR),
 
71
      flags(0),
 
72
      old_name(),
 
73
      open_method(SKIP_OPEN_TABLE)
 
74
  {}
 
75
 
 
76
  /**
 
77
   * @return the name of this column.
 
78
   */
 
79
  const std::string &getName() const
 
80
  {
 
81
    return name;
 
82
  }
 
83
 
 
84
  /**
 
85
   * This method is only ever called from the
 
86
   * InfoSchemaMethods::oldFormat() methods. It is mostly
 
87
   * for old SHOW compatability. It is used when a list
 
88
   * of fields need to be generated for SHOW. The names
 
89
   * for those fields (or columns) are found by calling
 
90
   * this method on each column in the I_S table.
 
91
   *
 
92
   * @return the old name of this column.
 
93
   */
 
94
  const std::string &getOldName() const
 
95
  {
 
96
    return old_name;
 
97
  }
 
98
 
 
99
  /**
 
100
   * @return the open method for this column.
 
101
   */
 
102
  uint32_t getOpenMethod() const
 
103
  {
 
104
    return open_method;
 
105
  }
 
106
 
 
107
  /**
 
108
   * @return the flags for this column.
 
109
   */
 
110
  uint32_t getFlags() const
 
111
  {
 
112
    return flags;
 
113
  }
 
114
 
 
115
  /**
 
116
   * @return the length of this column.
 
117
   */
 
118
  uint32_t getLength() const
 
119
  {
 
120
    return length;
 
121
  }
 
122
 
 
123
  /**
 
124
   * @return the value of this column.
 
125
   */
 
126
  int32_t getValue() const
 
127
  {
 
128
    return value;
 
129
  }
 
130
 
 
131
  /**
 
132
   * @return this column's type.
 
133
   */
 
134
  enum enum_field_types getType() const
 
135
  {
 
136
    return type;
 
137
  }
 
138
 
 
139
private:
 
140
 
 
141
  /**
 
142
   * This is used as column name.
 
143
   */
 
144
  const std::string name;
 
145
 
 
146
  /**
 
147
   * For string-type columns, this is the maximum number of
 
148
   * characters. Otherwise, it is the 'display-length' for the column.
 
149
   */
 
150
  uint32_t length;
 
151
 
 
152
  /**
 
153
   * This denotes data type for the column. For the most part, there seems to
 
154
   * be one entry in the enum for each SQL data type, although there seem to
 
155
   * be a number of additional entries in the enum.
 
156
   */
 
157
  enum enum_field_types type;
 
158
 
 
159
  int32_t value;
 
160
 
 
161
  /**
 
162
   * This is used to set column attributes. By default, columns are @c NOT
 
163
   * @c NULL and @c SIGNED, and you can deviate from the default
 
164
   * by setting the appopriate flags. You can use either one of the flags
 
165
   * @c MY_I_S_MAYBE_NULL and @cMY_I_S_UNSIGNED or
 
166
   * combine them using the bitwise or operator @c |. Both flags are
 
167
   * defined in table.h.
 
168
   */
 
169
  uint32_t flags;
 
170
 
 
171
  /**
 
172
   * The name of this column which is used for old SHOW
 
173
   * compatability.
 
174
   */
 
175
  const std::string old_name;
 
176
 
 
177
  /**
 
178
   * This should be one of @c SKIP_OPEN_TABLE,
 
179
   * @c OPEN_FRM_ONLY or @c OPEN_FULL_TABLE.
 
180
   */
 
181
  uint32_t open_method;
 
182
 
 
183
};
 
184
 
 
185
/**
 
186
 * @class InfoSchemaMethods
 
187
 * @brief
 
188
 *   The methods that an I_S table can support
 
189
 */
 
190
class InfoSchemaMethods
 
191
{
 
192
public:
 
193
  virtual ~InfoSchemaMethods() {}
 
194
 
 
195
  virtual Table *createSchemaTable(Session *session,
 
196
                                   TableList *table_list) const;
 
197
  virtual int fillTable(Session *session, 
 
198
                        TableList *tables,
 
199
                        COND *cond);
 
200
  virtual int processTable(Session *session, TableList *tables,
 
201
                           Table *table, bool res, LEX_STRING *db_name,
 
202
                           LEX_STRING *table_name) const;
 
203
  virtual int oldFormat(Session *session, 
 
204
                        InfoSchemaTable *schema_table) const;
 
205
};
 
206
 
 
207
/**
 
208
 * @class InfoSchemaTable
 
209
 * @brief 
 
210
 *   Represents an I_S table.
 
211
 */
 
212
class InfoSchemaTable : public Plugin
 
213
{
 
214
  InfoSchemaTable();
 
215
  InfoSchemaTable(const InfoSchemaTable &);
 
216
  InfoSchemaTable& operator=(const InfoSchemaTable &);
 
217
public:
 
218
 
 
219
  typedef std::vector<const ColumnInfo *> Columns;
 
220
  
 
221
  InfoSchemaTable(const std::string& tab_name,
 
222
                  Columns& in_column_info,
 
223
                  int idx_col1,
 
224
                  int idx_col2,
 
225
                  bool in_hidden,
 
226
                  bool in_opt_possible,
 
227
                  uint32_t req_object,
 
228
                  InfoSchemaMethods *in_methods)
 
229
    :
 
230
      Plugin(tab_name),
 
231
      hidden(in_hidden),
 
232
      is_opt_possible(in_opt_possible),
 
233
      first_column_index(idx_col1),
 
234
      second_column_index(idx_col2),
 
235
      requested_object(req_object),
 
236
      column_info(in_column_info),
 
237
      i_s_methods(in_methods)
 
238
  {}
 
239
 
 
240
  explicit InfoSchemaTable(const std::string& tab_name)
 
241
    :
 
242
      Plugin(tab_name),
 
243
      hidden(false),
 
244
      is_opt_possible(false),
 
245
      first_column_index(0),
 
246
      second_column_index(0),
 
247
      requested_object(0),
 
248
      column_info(),
 
249
      i_s_methods(NULL)
 
250
  {}
 
251
 
 
252
  virtual ~InfoSchemaTable()
 
253
  {}
 
254
 
 
255
  /**
 
256
   * Set the methods available on this I_S table.
 
257
   * @param[in] new_methods the methods to use
 
258
   */
 
259
  void setInfoSchemaMethods(InfoSchemaMethods *new_methods)
 
260
  {
 
261
    i_s_methods= new_methods;
 
262
  }
 
263
 
 
264
  /**
 
265
   * Create the temporary I_S tables using schema_table data.
 
266
   *
 
267
   * @param[in] session a session handler
 
268
   * @param[in] table_list Used to pass I_S table information (fields,
 
269
   *                       tables, parameters, etc.) and table name
 
270
   * @retval \# pointer to created table
 
271
   * @retval NULL Can't create table
 
272
   */
 
273
  Table *createSchemaTable(Session *session, TableList *table_list) const
 
274
  {
 
275
    Table *retval= i_s_methods->createSchemaTable(session, table_list);
 
276
    return retval;
 
277
  }
 
278
 
 
279
  /**
 
280
   * Fill I_S table.
 
281
   *
 
282
   * @param[in] session a session handler
 
283
   * @param[in] tables I_S table
 
284
   * @param[in] cond 'WHERE' condition
 
285
   * @return 0 on success; 1 on error
 
286
   */
 
287
  int fillTable(Session *session, TableList *tables, COND *cond)
 
288
  {
 
289
    int retval= i_s_methods->fillTable(session, tables, cond);
 
290
    return retval;
 
291
  }
 
292
 
 
293
  /**
 
294
   * Fill and store records into an I_S table.
 
295
   *
 
296
   * @param[in] session a session handler
 
297
   * @param[in] tables table list (processed table)
 
298
   * @param[in] table I_S table
 
299
   * @param[in] res 1 means error during opening of the processed table
 
300
   *                0 means processed table opened without error
 
301
   * @param[in] db_name database name
 
302
   * @param[in] tab_name table name
 
303
   * @return 0 on success; 1 on error
 
304
   */
 
305
  int processTable(Session *session, TableList *tables, Table *table,
 
306
                   bool res, LEX_STRING *db_name, LEX_STRING *tab_name) const
 
307
  {
 
308
    int retval= i_s_methods->processTable(session, tables, table,
 
309
                                          res, db_name, tab_name);
 
310
    return retval;
 
311
  }
 
312
 
 
313
  /**
 
314
   * For old SHOW compatibility. It is used when old SHOW doesn't
 
315
   * have generated column names. Generates the list of fields
 
316
   * for SHOW.
 
317
   *
 
318
   * @param[in] session a session handler
 
319
   * @param[in] schema_table pointer to element of the I_S tables list
 
320
   */
 
321
  int oldFormat(Session *session, InfoSchemaTable *schema_table) const
 
322
  {
 
323
    int retval= i_s_methods->oldFormat(session, schema_table);
 
324
    return retval;
 
325
  }
 
326
 
 
327
  /**
 
328
   * @param[in] new_first_index value to set first column index to
 
329
   */
 
330
  void setFirstColumnIndex(int32_t new_first_index)
 
331
  {
 
332
    first_column_index= new_first_index;
 
333
  }
 
334
 
 
335
  /**
 
336
   * @param[in] new_second_index value to set second column index to
 
337
   */
 
338
  void setSecondColumnIndex(int32_t new_second_index)
 
339
  {
 
340
    second_column_index= new_second_index;
 
341
  }
 
342
 
 
343
  /**
 
344
   * @param[in] in_column_info the columns info to use for this I_S table
 
345
   */
 
346
  void setColumnInfo(ColumnInfo *in_column_info)
 
347
  {
 
348
    ColumnInfo *tmp= in_column_info;
 
349
    for (; tmp->getName().length() != 0; tmp++)
 
350
    {
 
351
      column_info.push_back(tmp);
 
352
    }
 
353
  }
 
354
 
 
355
  /**
 
356
   * @return the name of the I_S table.
 
357
   */
 
358
  const std::string &getTableName() const
 
359
  {
 
360
    return getName();
 
361
  }
 
362
 
 
363
  /**
 
364
   * @return true if this I_S table is hidden; false otherwise.
 
365
   */
 
366
  bool isHidden() const
 
367
  {
 
368
    return hidden;
 
369
  }
 
370
 
 
371
  /**
 
372
   * @return true if I_S optimizations can be performed on this
 
373
   *         I_S table when running the fillTable method; false
 
374
   *         otherwise.
 
375
   */
 
376
  bool isOptimizationPossible() const
 
377
  {
 
378
    return is_opt_possible;
 
379
  }
 
380
 
 
381
  /**
 
382
   * @return the index for the first field.
 
383
   */
 
384
  int32_t getFirstColumnIndex() const
 
385
  {
 
386
    return first_column_index;
 
387
  }
 
388
 
 
389
  /**
 
390
   * @return the index the second field.
 
391
   */
 
392
  int32_t getSecondColumnIndex() const
 
393
  {
 
394
    return second_column_index;
 
395
  }
 
396
 
 
397
  /**
 
398
   * @return the requested object.
 
399
   */
 
400
  uint32_t getRequestedObject() const
 
401
  {
 
402
    return requested_object;
 
403
  }
 
404
 
 
405
  /**
 
406
   * @return the columns for this I_S table
 
407
   */
 
408
  const Columns &getColumns() const
 
409
  {
 
410
    return column_info;
 
411
  }
 
412
 
 
413
  /**
 
414
   * @param[in] index the index of this column
 
415
   * @return the name for the column at the given index
 
416
   */
 
417
  const std::string &getColumnName(int index) const
 
418
  {
 
419
    return column_info[index]->getName();
 
420
  }
 
421
 
 
422
  /**
 
423
   * @param[in] index the index of this column
 
424
   * @return the open method for the column at the given index
 
425
   */
 
426
  uint32_t getColumnOpenMethod(int index) const
 
427
  {
 
428
    return column_info[index]->getOpenMethod();
 
429
  }
 
430
 
 
431
private:
 
432
 
 
433
  /**
 
434
   * Boolean which indicates whether this I_S table
 
435
   * is hidden or not. If it is hidden, it will not show
 
436
   * up in the list of I_S tables.
 
437
   */
 
438
  bool hidden;
 
439
 
 
440
  /**
 
441
   * Boolean which indicates whether optimizations are
 
442
   * possible on this I_S table when performing the
 
443
   * fillTable method.
 
444
   */
 
445
  bool is_opt_possible;
 
446
 
 
447
  /**
 
448
   * The index of the first column.
 
449
   */
 
450
  int32_t first_column_index;
 
451
 
 
452
  /**
 
453
   * The index of the second column.
 
454
   */
 
455
  int32_t second_column_index;
 
456
 
 
457
  /**
 
458
   * The object to open (TABLE | VIEW).
 
459
   */
 
460
  uint32_t requested_object;
 
461
 
 
462
  /**
 
463
   * The columns for this I_S table.
 
464
   */
 
465
  Columns column_info;
 
466
 
 
467
  /**
 
468
   * Contains the methods available on this I_S table.
 
469
   */
 
470
  InfoSchemaMethods *i_s_methods;
 
471
 
 
472
public:
 
473
  static bool addPlugin(plugin::InfoSchemaTable *schema_table);
 
474
  static void removePlugin(plugin::InfoSchemaTable *table);
 
475
 
 
476
  static plugin::InfoSchemaTable *getTable(const char *table_name);
 
477
  static int addTableToList(Session *session, std::vector<LEX_STRING*> &files,
 
478
                            const char *wild);
 
479
};
 
480
 
 
481
} /* namespace plugin */
 
482
} /* namespace drizzled */
 
483
 
 
484
#endif /* DRIZZLED_PLUGIN_INFO_SCHEMA_TABLE_H */