~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/table.h

  • Committer: lbieber
  • Date: 2010-10-06 16:34:16 UTC
  • mfrom: (1816.1.3 build)
  • Revision ID: lbieber@orisndriz08-20101006163416-ea0sl59qgpglk21y
Merge Monty - Change the requirement from either libinnodb to libhaildb. Also, tied it to version 2.2
Merge Andrew - fix bug 650935: remove --compress from all clients
Merge Andrew - fix bug 653471: Add -A to drizzle client
Merge Travis - 621861 = To change C structs to C++ classes in Drizzle

Show diffs side-by-side

added added

removed removed

Lines of Context:
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.
 
4
 *  Copyright (C) 2008 Sun Microsystems
5
5
 *
6
6
 *  This program is free software; you can redistribute it and/or modify
7
7
 *  it under the terms of the GNU General Public License as published by
20
20
 
21
21
/* Structs that defines the Table */
22
22
 
23
 
 
24
 
 
25
23
#ifndef DRIZZLED_TABLE_H
26
24
#define DRIZZLED_TABLE_H
27
25
 
28
26
#include <string>
29
 
#include <boost/dynamic_bitset.hpp>
30
27
 
31
28
#include "drizzled/order.h"
32
29
#include "drizzled/filesort_info.h"
35
32
#include "drizzled/cursor.h"
36
33
#include "drizzled/lex_string.h"
37
34
#include "drizzled/table_list.h"
38
 
#include "drizzled/table/instance.h"
 
35
#include "drizzled/table_share.h"
39
36
#include "drizzled/atomics.h"
40
37
#include "drizzled/query_id.h"
41
38
 
42
 
#include "drizzled/visibility.h"
43
 
 
44
39
namespace drizzled
45
40
{
46
41
 
47
 
class COND_EQUAL;
48
 
class Field_blob;
49
42
class Item;
50
43
class Item_subselect;
 
44
class Select_Lex_Unit;
 
45
class Select_Lex;
 
46
class COND_EQUAL;
51
47
class SecurityContext;
52
 
class Select_Lex;
53
 
class Select_Lex_Unit;
54
48
class TableList;
55
 
namespace field { class Epoch; }
56
 
namespace plugin { class StorageEngine; }
 
49
class Field_timestamp;
 
50
class Field_blob;
 
51
 
 
52
extern uint64_t refresh_version;
57
53
 
58
54
typedef enum enum_table_category TABLE_CATEGORY;
59
55
typedef struct st_columndef MI_COLUMNDEF;
62
58
 * Class representing a set of records, either in a temporary, 
63
59
 * normal, or derived table.
64
60
 */
65
 
class DRIZZLED_API Table 
 
61
class Table 
66
62
{
 
63
public:
 
64
  TableShare *s; /**< Pointer to the shared metadata about the table */
 
65
 
 
66
private:
67
67
  Field **field; /**< Pointer to fields collection */
 
68
public:
68
69
 
69
 
public:
70
70
  Field **getFields() const
71
71
  {
72
72
    return field;
88
88
  }
89
89
 
90
90
  Cursor *cursor; /**< Pointer to the storage engine's Cursor managing this table */
91
 
 
92
91
private:
93
92
  Table *next;
94
 
 
95
93
public:
96
94
  Table *getNext() const
97
95
  {
132
130
    prev= arg;
133
131
  }
134
132
 
135
 
  boost::dynamic_bitset<> *read_set; /* Active column sets */
136
 
  boost::dynamic_bitset<> *write_set; /* Active column sets */
 
133
  MyBitmap *read_set; /* Active column sets */
 
134
  MyBitmap *write_set; /* Active column sets */
137
135
 
138
136
  uint32_t tablenr;
139
137
  uint32_t db_stat; /**< information about the cursor as in Cursor.h */
140
138
 
141
 
  boost::dynamic_bitset<> def_read_set; /**< Default read set of columns */
142
 
  boost::dynamic_bitset<> def_write_set; /**< Default write set of columns */
143
 
  boost::dynamic_bitset<> tmp_set; /* Not sure about this... */
 
139
  MyBitmap def_read_set; /**< Default read set of columns */
 
140
  MyBitmap def_write_set; /**< Default write set of columns */
 
141
  MyBitmap tmp_set; /* Not sure about this... */
144
142
 
145
143
  Session *in_use; /**< Pointer to the current session using this object */
146
144
  Session *getSession()
148
146
    return in_use;
149
147
  }
150
148
 
151
 
  unsigned char *getInsertRecord() const
 
149
  unsigned char *getInsertRecord()
152
150
  {
153
151
    return record[0];
154
152
  }
163
161
  KeyInfo  *key_info; /**< data of keys in database */
164
162
  Field *next_number_field; /**< Set if next_number is activated. @TODO What the heck is the difference between this and the next member? */
165
163
  Field *found_next_number_field; /**< Points to the "next-number" field (autoincrement field) */
166
 
  field::Epoch *timestamp_field; /**< Points to the auto-setting timestamp field, if any */
 
164
  Field_timestamp *timestamp_field; /**< Points to the auto-setting timestamp field, if any */
167
165
 
168
166
  TableList *pos_in_table_list; /* Element referring to this table */
169
 
  Order *group;
 
167
  order_st *group;
170
168
  
171
169
  const char *getAlias() const
172
170
  {
173
 
    return _alias.c_str();
174
 
  }
175
 
 
176
 
  void clearAlias()
177
 
  {
178
 
    _alias.clear();
179
 
  }
180
 
 
181
 
  void setAlias(const char *arg)
182
 
  {
183
 
    _alias= arg;
184
 
  }
185
 
 
186
 
private:
187
 
  std::string _alias; /**< alias or table name if no alias */
188
 
public:
 
171
    return alias;
 
172
  }
 
173
 
 
174
  const char *alias; /**< alias or table name if no alias */
189
175
 
190
176
  unsigned char *null_flags;
191
177
 
285
271
    statement then the variable contains TIMESTAMP_NO_AUTO_SET (i.e. 0).
286
272
 
287
273
    Value of this variable is set for each statement in open_table() and
288
 
    if needed cleared later in statement processing code (see update_query()
 
274
    if needed cleared later in statement processing code (see mysql_update()
289
275
    as example).
290
276
  */
291
277
  timestamp_auto_set_type timestamp_field_type;
313
299
    The set is implemented as a bitmap.
314
300
  */
315
301
  key_map keys_in_use_for_query;
316
 
 
317
302
  /* Map of keys that can be used to calculate GROUP BY without sorting */
318
303
  key_map keys_in_use_for_group_by;
319
 
 
320
304
  /* Map of keys that can be used to calculate ORDER BY without sorting */
321
305
  key_map keys_in_use_for_order_by;
322
306
 
370
354
    return mem_root.strmake_root(str_arg, len_arg);
371
355
  }
372
356
 
373
 
  filesort_info sort;
 
357
  filesort_info_st sort;
374
358
 
375
359
  Table();
376
 
  virtual ~Table();
 
360
  virtual ~Table() { };
377
361
 
378
362
  int report_error(int error);
379
363
  /**
387
371
  void resetTable(Session *session, TableShare *share, uint32_t db_stat_arg);
388
372
 
389
373
  /* SHARE methods */
390
 
  virtual const TableShare *getShare() const= 0; /* Get rid of this long term */
391
 
  virtual TableShare *getMutableShare()= 0; /* Get rid of this long term */
392
 
  virtual bool hasShare() const= 0; /* Get rid of this long term */
393
 
  virtual void setShare(TableShare *new_share)= 0; /* Get rid of this long term */
394
 
 
395
 
  virtual void release(void)= 0;
396
 
 
397
 
  uint32_t sizeKeys() { return getMutableShare()->sizeKeys(); }
398
 
  uint32_t sizeFields() { return getMutableShare()->sizeFields(); }
399
 
  uint32_t getRecordLength() const { return getShare()->getRecordLength(); }
400
 
  uint32_t sizeBlobFields() { return getMutableShare()->blob_fields; }
401
 
  uint32_t *getBlobField() { return &getMutableShare()->blob_field[0]; }
402
 
 
403
 
public:
404
 
  virtual bool hasVariableWidth() const
405
 
  {
406
 
    return getShare()->hasVariableWidth(); // We should calculate this.
407
 
  }
408
 
 
409
 
  virtual void setVariableWidth(void);
 
374
  inline const TableShare *getShare() const { assert(s); return s; } /* Get rid of this long term */
 
375
  inline bool hasShare() const { return s ? true : false ; } /* Get rid of this long term */
 
376
  inline TableShare *getMutableShare() { assert(s); return s; } /* Get rid of this long term */
 
377
  inline void setShare(TableShare *new_share) { s= new_share; } /* Get rid of this long term */
 
378
  inline uint32_t sizeKeys() { return s->sizeKeys(); }
 
379
  inline uint32_t sizeFields() { return s->sizeFields(); }
 
380
  inline uint32_t getRecordLength() const { return s->getRecordLength(); }
 
381
  inline uint32_t sizeBlobFields() { return s->blob_fields; }
 
382
  inline uint32_t *getBlobField() { return &s->blob_field[0]; }
410
383
 
411
384
  Field_blob *getBlobFieldAt(uint32_t arg) const
412
385
  {
413
 
    if (arg < getShare()->blob_fields)
414
 
      return (Field_blob*) field[getShare()->blob_field[arg]]; /*NOTE: Using 'Table.field' NOT SharedTable.field. */
 
386
    if (arg < s->blob_fields)
 
387
      return (Field_blob*) field[s->blob_field[arg]]; /*NOTE: Using 'Table.field' NOT SharedTable.field. */
415
388
 
416
389
    return NULL;
417
390
  }
418
 
  inline uint8_t getBlobPtrSize() const { return getShare()->sizeBlobPtr(); }
419
 
  inline uint32_t getNullBytes() const { return getShare()->null_bytes; }
420
 
  inline uint32_t getNullFields() const { return getShare()->null_fields; }
421
 
  inline unsigned char *getDefaultValues() { return  getMutableShare()->getDefaultValues(); }
422
 
  inline const char *getSchemaName()  const { return getShare()->getSchemaName(); }
423
 
  inline const char *getTableName()  const { return getShare()->getTableName(); }
424
 
 
425
 
  inline bool isDatabaseLowByteFirst() const { return getShare()->db_low_byte_first; } /* Portable row format */
426
 
  inline bool isNameLock() const { return open_placeholder; }
427
 
 
428
 
  uint32_t index_flags(uint32_t idx) const;
 
391
  inline uint8_t getBlobPtrSize() { return s->blob_ptr_size; }
 
392
  inline uint32_t getNullBytes() { return s->null_bytes; }
 
393
  inline uint32_t getNullFields() { return s->null_fields; }
 
394
  inline unsigned char *getDefaultValues() { return  s->getDefaultValues(); }
 
395
  inline const char *getSchemaName()  const { return s->getSchemaName(); }
 
396
  inline const char *getTableName()  const { return s->getTableName(); }
 
397
 
 
398
  inline bool isDatabaseLowByteFirst() { return s->db_low_byte_first; } /* Portable row format */
 
399
  inline bool isNameLock() const { return s->isNameLock(); }
 
400
  inline bool isReplaceWithNameLock() { return s->replace_with_name_lock; }
 
401
 
 
402
  uint32_t index_flags(uint32_t idx) const
 
403
  {
 
404
    return s->storage_engine->index_flags(s->getKeyInfo(idx).algorithm);
 
405
  }
429
406
 
430
407
  inline plugin::StorageEngine *getEngine() const   /* table_type for handler */
431
408
  {
432
 
    return getShare()->getEngine();
 
409
    return s->storage_engine;
433
410
  }
434
411
 
435
412
  Cursor &getCursor() const /* table_type for handler */
438
415
    return *cursor;
439
416
  }
440
417
 
 
418
  /* For TMP tables, should be pulled out as a class */
 
419
  void setup_tmp_table_column_bitmaps(unsigned char *bitmaps);
 
420
  bool create_myisam_tmp_table(KeyInfo *keyinfo,
 
421
                               MI_COLUMNDEF *start_recinfo,
 
422
                               MI_COLUMNDEF **recinfo,
 
423
                               uint64_t options);
 
424
  void free_tmp_table(Session *session);
 
425
  bool open_tmp_table();
441
426
  size_t max_row_length(const unsigned char *data);
442
427
  uint32_t find_shortest_key(const key_map *usable_keys);
443
428
  bool compare_record(Field **ptr);
444
 
  bool records_are_comparable();
445
 
  bool compare_records();
 
429
  bool compare_record();
446
430
  /* TODO: the (re)storeRecord's may be able to be further condensed */
447
431
  void storeRecord();
448
432
  void storeRecordAsInsert();
451
435
  void restoreRecordAsDefault();
452
436
  void emptyRecord();
453
437
 
454
 
 
455
438
  /* See if this can be blown away */
456
439
  inline uint32_t getDBStat () { return db_stat; }
457
440
  inline uint32_t setDBStat () { return db_stat; }
474
457
  bool fill_item_list(List<Item> *item_list) const;
475
458
  void clear_column_bitmaps(void);
476
459
  void prepare_for_position(void);
477
 
  void mark_columns_used_by_index_no_reset(uint32_t index, boost::dynamic_bitset<>& bitmap);
 
460
  void mark_columns_used_by_index_no_reset(uint32_t index, MyBitmap *map);
478
461
  void mark_columns_used_by_index_no_reset(uint32_t index);
479
462
  void mark_columns_used_by_index(uint32_t index);
480
463
  void restore_column_maps_after_mark_index();
482
465
  void mark_columns_needed_for_update(void);
483
466
  void mark_columns_needed_for_delete(void);
484
467
  void mark_columns_needed_for_insert(void);
485
 
  void column_bitmaps_set(boost::dynamic_bitset<>& read_set_arg,
486
 
                          boost::dynamic_bitset<>& write_set_arg);
487
 
 
488
 
  void restore_column_map(const boost::dynamic_bitset<>& old);
489
 
 
490
 
  const boost::dynamic_bitset<> use_all_columns(boost::dynamic_bitset<>& map);
 
468
  inline void column_bitmaps_set(MyBitmap *read_set_arg,
 
469
                                 MyBitmap *write_set_arg)
 
470
  {
 
471
    read_set= read_set_arg;
 
472
    write_set= write_set_arg;
 
473
  }
 
474
 
 
475
  void restore_column_map(my_bitmap_map *old);
 
476
 
 
477
  my_bitmap_map *use_all_columns(MyBitmap *bitmap);
491
478
  inline void use_all_columns()
492
479
  {
493
 
    column_bitmaps_set(getMutableShare()->all_set, getMutableShare()->all_set);
 
480
    column_bitmaps_set(&s->all_set, &s->all_set);
494
481
  }
495
482
 
496
483
  inline void default_column_bitmaps()
502
489
  /* Both of the below should go away once we can move this bit to the field objects */
503
490
  inline bool isReadSet(uint32_t index)
504
491
  {
505
 
    return read_set->test(index);
 
492
    return read_set->isBitSet(index);
506
493
  }
507
494
 
508
495
  inline void setReadSet(uint32_t index)
509
496
  {
510
 
    read_set->set(index);
 
497
    read_set->setBit(index);
511
498
  }
512
499
 
513
500
  inline void setReadSet()
514
501
  {
515
 
    read_set->set();
 
502
    read_set->setAll();
516
503
  }
517
504
 
518
505
  inline void clearReadSet(uint32_t index)
519
506
  {
520
 
    read_set->reset(index);
 
507
    read_set->clearBit(index);
521
508
  }
522
509
 
523
510
  inline void clearReadSet()
524
511
  {
525
 
    read_set->reset();
 
512
    read_set->clearAll();
526
513
  }
527
514
 
528
515
  inline bool isWriteSet(uint32_t index)
529
516
  {
530
 
    return write_set->test(index);
 
517
    return write_set->isBitSet(index);
531
518
  }
532
519
 
533
520
  inline void setWriteSet(uint32_t index)
534
521
  {
535
 
    write_set->set(index);
 
522
    write_set->setBit(index);
536
523
  }
537
524
 
538
525
  inline void setWriteSet()
539
526
  {
540
 
    write_set->set();
 
527
    write_set->setAll();
541
528
  }
542
529
 
543
530
  inline void clearWriteSet(uint32_t index)
544
531
  {
545
 
    write_set->reset(index);
 
532
    write_set->clearBit(index);
546
533
  }
547
534
 
548
535
  inline void clearWriteSet()
549
536
  {
550
 
    write_set->reset();
 
537
    write_set->clearAll();
551
538
  }
552
539
 
553
540
  /* Is table open or should be treated as such by name-locking? */
555
542
  {
556
543
    return db_stat || open_placeholder;
557
544
  }
558
 
 
559
545
  /*
560
546
    Is this instance of the table should be reopen or represents a name-lock?
561
547
  */
562
 
  bool needs_reopen_or_name_lock() const;
 
548
  inline bool needs_reopen_or_name_lock()
 
549
  { 
 
550
    return s->getVersion() != refresh_version;
 
551
  }
563
552
 
564
553
  /**
565
554
    clean/setup table fields and map.
573
562
  {
574
563
    null_row= 1;
575
564
    status|= STATUS_NULL_ROW;
576
 
    memset(null_flags, 255, getShare()->null_bytes);
 
565
    memset(null_flags, 255, s->null_bytes);
577
566
  }
578
567
 
579
568
  void free_io_cache();
580
569
  void filesort_free_buffers(bool full= false);
581
570
  void intern_close_table();
582
571
 
583
 
  void print_error(int error, myf errflag) const;
 
572
  void print_error(int error, myf errflag)
 
573
  {
 
574
    s->storage_engine->print_error(error, errflag, *this);
 
575
  }
584
576
 
585
577
  /**
586
578
    @return
587
579
    key if error because of duplicated keys
588
580
  */
589
 
  uint32_t get_dup_key(int error) const
 
581
  uint32_t get_dup_key(int error)
590
582
  {
591
583
    cursor->errkey  = (uint32_t) -1;
592
584
    if (error == HA_ERR_FOUND_DUPP_KEY || error == HA_ERR_FOREIGN_DUPLICATE_KEY ||
602
594
  */
603
595
  bool operator<(const Table &right) const
604
596
  {
605
 
    return getShare()->getCacheKey() < right.getShare()->getCacheKey();
 
597
    int result= strcasecmp(this->getShare()->getSchemaName(), right.getShare()->getSchemaName());
 
598
 
 
599
    if (result <  0)
 
600
      return true;
 
601
 
 
602
    if (result >  0)
 
603
      return false;
 
604
 
 
605
    result= strcasecmp(this->getShare()->getTableName(), right.getShare()->getTableName());
 
606
 
 
607
    if (result <  0)
 
608
      return true;
 
609
 
 
610
    if (result >  0)
 
611
      return false;
 
612
 
 
613
    if (this->getShare()->getTableProto()->type()  < right.getShare()->getTableProto()->type())
 
614
      return true;
 
615
 
 
616
    return false;
606
617
  }
607
618
 
608
619
  static bool compare(const Table *a, const Table *b)
612
623
 
613
624
  friend std::ostream& operator<<(std::ostream& output, const Table &table)
614
625
  {
615
 
    if (table.getShare())
616
 
    {
617
 
      output << "Table:(";
618
 
      output << table.getShare()->getSchemaName();
619
 
      output << ", ";
620
 
      output <<  table.getShare()->getTableName();
621
 
      output << ", ";
622
 
      output <<  table.getShare()->getTableTypeAsString();
623
 
      output << ")";
624
 
    }
625
 
    else
626
 
    {
627
 
      output << "Table:(has no share)";
628
 
    }
 
626
    output << "Table:(";
 
627
    output << table.getShare()->getSchemaName();
 
628
    output << ", ";
 
629
    output <<  table.getShare()->getTableName();
 
630
    output << ", ";
 
631
    output <<  table.getShare()->getTableTypeAsString();
 
632
    output << ")";
629
633
 
630
634
    return output;  // for multiple << operators.
631
635
  }
632
636
 
 
637
protected:
 
638
  bool is_placeholder_created;
 
639
 
633
640
public:
634
 
  virtual bool isPlaceHolder(void) const
 
641
  bool isPlaceHolder()
635
642
  {
636
 
    return false;
 
643
    return is_placeholder_created;
637
644
  }
638
645
};
639
646
 
819
826
class select_union;
820
827
class Tmp_Table_Param;
821
828
 
 
829
struct open_table_list_st
 
830
{
 
831
  std::string   db;
 
832
  std::string   table;
 
833
  uint32_t in_use;
 
834
  uint32_t locked;
 
835
 
 
836
  open_table_list_st() :
 
837
    in_use(0),
 
838
    locked(0)
 
839
  { }
 
840
 
 
841
};
 
842
 
822
843
void free_blobs(Table *table);
823
844
int set_zone(int nr,int min_zone,int max_zone);
824
845
uint32_t convert_period_to_month(uint32_t period);
829
850
 
830
851
namespace optimizer { class SqlSelect; }
831
852
 
 
853
ha_rows filesort(Session *session,
 
854
                 Table *form,
 
855
                 SortField *sortorder,
 
856
                 uint32_t s_length,
 
857
                 optimizer::SqlSelect *select,
 
858
                 ha_rows max_rows,
 
859
                 bool sort_positions,
 
860
                 ha_rows *examined_rows);
 
861
 
 
862
void filesort_free_buffers(Table *table, bool full);
832
863
void change_double_for_sort(double nr,unsigned char *to);
 
864
double my_double_round(double value, int64_t dec, bool dec_unsigned,
 
865
                       bool truncate);
833
866
int get_quick_record(optimizer::SqlSelect *select);
834
867
 
835
868
void find_date(char *pos,uint32_t *vek,uint32_t flag);
836
869
TYPELIB *convert_strings_to_array_type(char * *typelibs, char * *end);
837
870
TYPELIB *typelib(memory::Root *mem_root, List<String> &strings);
838
871
ulong get_form_pos(int file, unsigned char *head, TYPELIB *save_names);
 
872
ulong next_io_size(ulong pos);
839
873
void append_unescaped(String *res, const char *pos, uint32_t length);
840
874
 
841
 
DRIZZLED_API int rename_file_ext(const char * from,const char * to,const char * ext);
 
875
int rename_file_ext(const char * from,const char * to,const char * ext);
842
876
bool check_column_name(const char *name);
843
 
bool check_db_name(Session *session, identifier::Schema &schema);
 
877
bool check_db_name(Session *session, SchemaIdentifier &schema);
844
878
bool check_table_name(const char *name, uint32_t length);
845
879
 
846
880
} /* namespace drizzled */
847
881
 
848
 
#include "drizzled/table/singular.h"
849
 
#include "drizzled/table/concurrent.h"
850
 
 
851
882
#endif /* DRIZZLED_TABLE_H */