← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/open_tables_state.h

Merge/fix in FAQ.

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/open_tables_state.h
1
 
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
 
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
 
 *
4
 
 *  Copyright (C) 2008 Sun Microsystems, Inc.
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; version 2 of the License.
9
 
 *
10
 
 *  This program is distributed in the hope that it will be useful,
11
 
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
12
 
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13
 
 *  GNU General Public License for more details.
14
 
 *
15
 
 *  You should have received a copy of the GNU General Public License
16
 
 *  along with this program; if not, write to the Free Software
17
 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
18
 
 */
19
 
 
20
 
 
21
 
#ifndef DRIZZLED_OPEN_TABLES_STATE_H
22
 
#define DRIZZLED_OPEN_TABLES_STATE_H
23
 
 
24
 
#include <drizzled/lock.h>
25
 
#include <drizzled/query_id.h>
26
 
 
27
 
namespace drizzled
28
 
{
29
 
 
30
 
class CachedDirectory;
31
 
 
32
 
/**
33
 
  Class that holds information about tables which were opened and locked
34
 
  by the thread. It is also used to save/restore this information in
35
 
  push_open_tables_state()/pop_open_tables_state().
36
 
*/
37
 
 
38
 
class Open_tables_state
39
 
{
40
 
public:
41
 
  /**
42
 
    List of regular tables in use by this thread. Contains temporary and
43
 
    base tables that were opened with @see open_tables().
44
 
  */
45
 
  Table *open_tables;
46
 
 
47
 
  /**
48
 
    List of temporary tables used by this thread. Contains user-level
49
 
    temporary tables, created with CREATE TEMPORARY TABLE, and
50
 
    internal temporary tables, created, e.g., to resolve a SELECT,
51
 
    or for an intermediate table used in ALTER.
52
 
    XXX Why are internal temporary tables added to this list?
53
 
  */
54
 
private:
55
 
  Table *temporary_tables;
56
 
 
57
 
public:
58
 
 
59
 
  Table *getTemporaryTables()
60
 
  {
61
 
    return temporary_tables;
62
 
  }
63
 
 
64
 
  /**
65
 
    Mark all temporary tables which were used by the current statement or
66
 
    substatement as free for reuse, but only if the query_id can be cleared.
67
 
 
68
 
    @param session thread context
69
 
 
70
 
    @remark For temp tables associated with a open SQL HANDLER the query_id
71
 
            is not reset until the HANDLER is closed.
72
 
  */
73
 
  void mark_temp_tables_as_free_for_reuse();
74
 
 
75
 
protected:
76
 
  void close_temporary_tables();
77
 
 
78
 
public:
79
 
  void close_temporary_table(Table *table);
80
 
  
81
 
private:
82
 
  // The method below just handles the de-allocation of the table. In
83
 
  // a better memory type world, this would not be needed.
84
 
  void nukeTable(Table *table);
85
 
 
86
 
public:
87
 
  /* Work with temporary tables */
88
 
  Table *find_temporary_table(const identifier::Table &identifier);
89
 
 
90
 
  void dumpTemporaryTableNames(const char *id);
91
 
  int drop_temporary_table(const drizzled::identifier::Table &identifier);
92
 
  bool rm_temporary_table(plugin::StorageEngine *base, const identifier::Table &identifier);
93
 
  bool rm_temporary_table(const drizzled::identifier::Table &identifier, bool best_effort= false);
94
 
  Table *open_temporary_table(const drizzled::identifier::Table &identifier,
95
 
                              bool link_in_list= true);
96
 
 
97
 
  virtual query_id_t getQueryId()  const= 0;
98
 
 
99
 
private:
100
 
  Table *derived_tables;
101
 
public:
102
 
 
103
 
 
104
 
  Table *getDerivedTables()
105
 
  {
106
 
    return derived_tables;
107
 
  }
108
 
 
109
 
  void setDerivedTables(Table *arg)
110
 
  {
111
 
    derived_tables= arg;
112
 
  }
113
 
 
114
 
  void clearDerivedTables()
115
 
  {
116
 
    if (derived_tables)
117
 
      derived_tables= NULL; // They should all be invalid by this point
118
 
  }
119
 
 
120
 
  /*
121
 
    During a MySQL session, one can lock tables in two modes: automatic
122
 
    or manual. In automatic mode all necessary tables are locked just before
123
 
    statement execution, and all acquired locks are stored in 'lock'
124
 
    member. Unlocking takes place automatically as well, when the
125
 
    statement ends.
126
 
    Manual mode comes into play when a user issues a 'LOCK TABLES'
127
 
    statement. In this mode the user can only use the locked tables.
128
 
    Trying to use any other tables will give an error. The locked tables are
129
 
    stored in 'locked_tables' member.  Manual locking is described in
130
 
    the 'LOCK_TABLES' chapter of the MySQL manual.
131
 
    See also lock_tables() for details.
132
 
  */
133
 
  DrizzleLock *lock;
134
 
 
135
 
  /*
136
 
    CREATE-SELECT keeps an extra lock for the table being
137
 
    created. This field is used to keep the extra lock available for
138
 
    lower level routines, which would otherwise miss that lock.
139
 
   */
140
 
  DrizzleLock *extra_lock;
141
 
 
142
 
  uint64_t version;
143
 
  uint32_t current_tablenr;
144
 
 
145
 
  /*
146
 
    This constructor serves for creation of Open_tables_state instances
147
 
    which are used as backup storage.
148
 
  */
149
 
  Open_tables_state() :
150
 
    open_tables(0),
151
 
    temporary_tables(0),
152
 
    derived_tables(0),
153
 
    lock(0),
154
 
    extra_lock(0),
155
 
    version(0),
156
 
    current_tablenr(0)
157
 
  { }
158
 
  virtual ~Open_tables_state() {}
159
 
 
160
 
  void doGetTableNames(CachedDirectory &directory,
161
 
                       const identifier::Schema &schema_identifier,
162
 
                       std::set<std::string>& set_of_names);
163
 
  void doGetTableNames(const identifier::Schema &schema_identifier,
164
 
                       std::set<std::string>& set_of_names);
165
 
 
166
 
  void doGetTableIdentifiers(CachedDirectory &directory,
167
 
                             const identifier::Schema &schema_identifier,
168
 
                             identifier::Table::vector &set_of_identifiers);
169
 
  void doGetTableIdentifiers(const identifier::Schema &schema_identifier,
170
 
                             identifier::Table::vector &set_of_identifiers);
171
 
 
172
 
  int doGetTableDefinition(const drizzled::identifier::Table &identifier,
173
 
                           message::Table &table_proto);
174
 
  bool doDoesTableExist(const drizzled::identifier::Table &identifier);
175
 
 
176
 
 
177
 
  Open_tables_state(uint64_t version_arg);
178
 
};
179
 
 
180
 
} /* namespace drizzled */
181
 
 
182
 
#endif /* DRIZZLED_OPEN_TABLES_STATE_H */