18
18
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
#ifndef DRIZZLED_TABLE_LIST_H
22
#define DRIZZLED_TABLE_LIST_H
24
#include <drizzled/table.h>
22
#ifndef DRIZZLED_TMP_TABLE_H
23
#define DRIZZLED_TMP_TABLE_H
26
Table reference in the FROM clause.
28
These table references can be of several types that correspond to
29
different SQL elements. Below we list all types of TableLists with
30
the necessary conditions to determine when a TableList instance
31
belongs to a certain type.
33
1) table (TableList::view == NULL)
35
(TableList::derived == NULL)
36
- subquery - TableList::table is a temp table
37
(TableList::derived != NULL)
38
- information schema table
39
(TableList::schema_table != NULL)
40
NOTICE: for schema tables TableList::field_translation may be != NULL
41
2) view (TableList::view != NULL)
42
- merge (TableList::effective_algorithm == VIEW_ALGORITHM_MERGE)
43
also (TableList::field_translation != NULL)
44
- tmptable (TableList::effective_algorithm == VIEW_ALGORITHM_TMPTABLE)
45
also (TableList::field_translation == NULL)
46
3) nested table reference (TableList::nested_join != NULL)
47
- table sequence - e.g. (t1, t2, t3)
48
TODO: how to distinguish from a JOIN?
50
TODO: how to distinguish from a table sequence?
52
(TableList::natural_join != NULL)
54
(TableList::join_using_fields != NULL)
31
64
class Natural_join_column;
32
65
class select_union;
33
class Select_Lex_Unit;
35
class Tmp_Table_Param;
66
class st_select_lex_unit;
67
class ST_SCHEMA_TABLE;
69
class TMP_TABLE_PARAM;
70
class Field_translator;
36
71
class Item_subselect;
44
struct nested_join_st;
47
* A Table referenced in the FROM clause.
49
* These table references can be of several types that correspond to
50
* different SQL elements. Below we list all types of TableLists with
51
* the necessary conditions to determine when a TableList instance
52
* belongs to a certain type.
54
* 1) table (TableList::view == NULL)
56
* (TableList::derived == NULL)
57
* - subquery - TableList::table is a temp table
58
* (TableList::derived != NULL)
62
* for schema tables TableList::field_translation may be != NULL
65
* 3) nested table reference (TableList::nested_join != NULL)
66
* - table sequence - e.g. (t1, t2, t3)
67
* @todo how to distinguish from a JOIN?
69
* @todo how to distinguish from a table sequence?
71
* (TableList::natural_join != NULL)
73
* (TableList::join_using_fields != NULL)
74
enum enum_schema_table_state
77
PROCESSED_BY_CREATE_SORT_INDEX,
78
PROCESSED_BY_JOIN_EXEC
92
is_natural_join(false),
93
is_join_columns_complete(false),
97
join_using_fields(NULL),
99
next_name_resolution_table(NULL),
101
derived_result(NULL),
103
schema_select_lex(NULL),
108
table_name_length(0),
110
on_expr_dep_tables(0),
115
internal_tmp_table(false),
85
TableList() {} /* Remove gcc warning */
122
* List of tables local to a subquery (used by SQL_LIST). Considers
123
* views as leaves (unlike 'next_leaf' below). Created at parse time
124
* in Select_Lex::add_table_to_list() -> table_list.link_in_list().
88
Prepare TableList that consists of one table instance to use in
89
simple_open_and_lock_tables
91
inline void init_one_table(const char *db_name_arg,
92
const char *table_name_arg,
93
enum thr_lock_type lock_type_arg)
95
memset(this, 0, sizeof(*this));
96
db= (char*) db_name_arg;
97
table_name= alias= (char*) table_name_arg;
98
lock_type= lock_type_arg;
102
List of tables local to a subquery (used by SQL_LIST). Considers
103
views as leaves (unlike 'next_leaf' below). Created at parse time
104
in st_select_lex::add_table_to_list() -> table_list.link_in_list().
126
106
TableList *next_local;
128
/** link in a global list of all queries tables */
129
TableList *next_global;
130
TableList **prev_global;
136
const char *getSchemaName()
141
char **getSchemaNamePtr()
146
void setSchemaName(char *arg)
157
const char *getTableName()
162
char **getTableNamePtr()
167
void setTableName(char *arg)
172
char *option; ///< Used by cache index
173
Item *on_expr; ///< Used with outer join
174
Table *table; ///< opened table
176
* The structure of ON expression presented in the member above
177
* can be changed during certain optimizations. This member
178
* contains a snapshot of AND-OR structure of the ON expression
179
* made after permanent transformations of the parse tree, and is
180
* used to restore ON clause before every reexecution of a prepared
181
* statement or stored procedure.
184
COND_EQUAL *cond_equal; ///< Used with outer join
186
* During parsing - left operand of NATURAL/USING join where 'this' is
187
* the right operand. After parsing (this->natural_join == this) iff
188
* 'this' represents a NATURAL or USING join operation. Thus after
189
* parsing 'this' is a NATURAL/USING join iff (natural_join != NULL).
107
/* link in a global list of all queries tables */
108
TableList *next_global, **prev_global;
109
char *db, *alias, *table_name, *schema_table_name;
110
char *option; /* Used by cache index */
111
Item *on_expr; /* Used with outer join */
114
(Valid only for semi-join nests) Bitmap of tables that are within the
115
semi-join (this is different from bitmap of all nest's children because
116
tables that were pulled out of the semi-join nest remain listed as
119
table_map sj_inner_tables;
120
/* Number of IN-compared expressions */
121
uint32_t sj_in_exprs;
123
The structure of ON expression presented in the member above
124
can be changed during certain optimizations. This member
125
contains a snapshot of AND-OR structure of the ON expression
126
made after permanent transformations of the parse tree, and is
127
used to restore ON clause before every reexecution of a prepared
128
statement or stored procedure.
131
COND_EQUAL *cond_equal; /* Used with outer join */
133
During parsing - left operand of NATURAL/USING join where 'this' is
134
the right operand. After parsing (this->natural_join == this) iff
135
'this' represents a NATURAL or USING join operation. Thus after
136
parsing 'this' is a NATURAL/USING join iff (natural_join != NULL).
191
138
TableList *natural_join;
193
* True if 'this' represents a nested join that is a NATURAL JOIN.
194
* For one of the operands of 'this', the member 'natural_join' points
195
* to the other operand of 'this'.
140
True if 'this' represents a nested join that is a NATURAL JOIN.
141
For one of the operands of 'this', the member 'natural_join' points
142
to the other operand of 'this'.
197
144
bool is_natural_join;
199
/** true if join_columns contains all columns of this table reference. */
200
bool is_join_columns_complete;
202
bool straight; ///< optimize with prev table
203
bool force_index; ///< prefer index over table scan
204
bool ignore_leaves; ///< preload only non-leaf nodes
207
is the table a cartesian join, assumption is yes unless "solved"
209
bool isCartesian() const;
211
/** Field names in a USING clause for JOIN ... USING. */
145
/* Field names in a USING clause for JOIN ... USING. */
212
146
List<String> *join_using_fields;
214
* Explicitly store the result columns of either a NATURAL/USING join or
215
* an operand of such a join.
148
Explicitly store the result columns of either a NATURAL/USING join or
149
an operand of such a join.
217
151
List<Natural_join_column> *join_columns;
152
/* true if join_columns contains all columns of this table reference. */
153
bool is_join_columns_complete;
220
* List of nodes in a nested join tree, that should be considered as
221
* leaves with respect to name resolution. The leaves are: views,
222
* top-most nodes representing NATURAL/USING joins, subqueries, and
223
* base tables. All of these TableList instances contain a
224
* materialized list of columns. The list is local to a subquery.
156
List of nodes in a nested join tree, that should be considered as
157
leaves with respect to name resolution. The leaves are: views,
158
top-most nodes representing NATURAL/USING joins, subqueries, and
159
base tables. All of these TableList instances contain a
160
materialized list of columns. The list is local to a subquery.
226
162
TableList *next_name_resolution_table;
227
/** Index names in a "... JOIN ... USE/IGNORE INDEX ..." clause. */
163
/* Index names in a "... JOIN ... USE/IGNORE INDEX ..." clause. */
228
164
List<Index_hint> *index_hints;
230
* select_result for derived table to pass it from table creation to table
233
select_union *derived_result;
234
Select_Lex_Unit *derived; ///< Select_Lex_Unit of derived table */
235
Select_Lex *schema_select_lex;
236
/** link to select_lex where this table was used */
237
Select_Lex *select_lex;
239
* List of all base tables local to a subquery including all view
240
* tables. Unlike 'next_local', this in this list views are *not*
241
* leaves. Created in setup_tables() -> make_leaves_list().
243
TableList *next_leaf;
165
Table *table; /* opened table */
166
uint32_t table_id; /* table id (from binlog) for opened table */
168
select_result for derived table to pass it from table creation to table
171
select_union *derived_result;
173
Reference from aux_tables to local list entry of main select of
174
multi-delete statement:
175
delete t1 from t2,t1 where t1.a<'B' and t2.b=t1.b;
176
here it will be reference of first occurrence of t1 to second (as you
177
can see this lists can't be merged)
179
TableList *correspondent_table;
180
st_select_lex_unit *derived; /* SELECT_LEX_UNIT of derived table */
181
ST_SCHEMA_TABLE *schema_table; /* Information_schema table */
182
st_select_lex *schema_select_lex;
184
True when the view field translation table is used to convert
185
schema table fields for backwards compatibility with SHOW command.
187
bool schema_table_reformed;
188
TMP_TABLE_PARAM *schema_table_param;
189
/* link to select_lex where this table was used */
190
st_select_lex *select_lex;
191
Field_translator *field_translation; /* array of VIEW fields */
192
/* pointer to element after last one in translation table above */
193
Field_translator *field_translation_end;
195
List (based on next_local) of underlying tables of this view. I.e. it
196
does not include the tables of subqueries used in the view. Is set only
199
TableList *merge_underlying_list;
201
List of all base tables local to a subquery including all view
202
tables. Unlike 'next_local', this in this list views are *not*
203
leaves. Created in setup_tables() -> make_leaves_list().
205
TableList *next_leaf;
244
206
thr_lock_type lock_type;
245
uint32_t outer_join; ///< Which join type
247
size_t table_name_length;
207
uint outer_join; /* Which join type */
208
uint shared; /* Used in multi-upd */
210
size_t table_name_length;
211
bool straight; /* optimize with prev table */
212
bool updating; /* for replicate-do/ignore table */
213
bool force_index; /* prefer index over table scan */
214
bool ignore_leaves; /* preload only non-leaf nodes */
215
table_map dep_tables; /* tables the table depends on */
216
table_map on_expr_dep_tables; /* tables on expression depends on */
217
nested_join_st *nested_join; /* if the element is a nested join */
218
TableList *embedding; /* nested join containing the table */
219
List<TableList> *join_list;/* join list the table belongs to */
220
bool cacheable_table; /* stop PS caching */
221
handlerton *db_type; /* table_type for handler */
222
char timestamp_buffer[20]; /* buffer for timestamp (19+1) */
224
This TableList object corresponds to the table to be created
225
so it is possible that it does not exist (used in CREATE TABLE
226
... SELECT implementation).
229
/* For transactional locking. */
230
int lock_timeout; /* NOWAIT or WAIT [X] */
231
bool lock_transactional; /* If transactional lock requested. */
232
bool internal_tmp_table;
233
/** true if an alias for this table was specified in the SQL. */
235
/** true if the table is referred to in the statement using a fully
236
qualified name (<db_name>.<table_name>).
240
uint32_t i_s_requested_object;
241
bool has_db_lookup_value;
242
bool has_table_lookup_value;
243
uint32_t table_open_method;
244
enum enum_schema_table_state schema_table_state;
249
245
void set_underlying_merge();
250
bool setup_underlying(Session *session);
253
* If you change placeholder(), please check the condition in
254
* check_transactional_lock() too.
258
* Print table as it should be in join list.
260
* @param str string where table should be printed
262
void print(Session *session, String *str, enum_query_type query_type);
264
* Sets insert_values buffer
266
* @param[in] memory pool for allocating
271
* true - out of memory
273
bool set_insert_values(memory::Root *mem_root);
275
* Find underlying base tables (TableList) which represent given
276
* table_to_find (Table)
278
* @param[in] table to find
281
* NULL if table is not found
283
* Pointer to found table reference
246
bool setup_underlying(THD *thd);
247
void cleanup_items();
249
If you change placeholder(), please check the condition in
250
check_transactional_lock() too.
254
return derived || schema_table || (create && !table->getDBStat()) || !table;
256
void print(THD *thd, String *str, enum_query_type query_type);
257
bool set_insert_values(MEM_ROOT *mem_root);
285
258
TableList *find_underlying_table(Table *table);
287
* Retrieve the first (left-most) leaf in a nested join tree with
288
* respect to name resolution.
292
* Given that 'this' is a nested table reference, recursively walk
293
* down the left-most children of 'this' until we reach a leaf
294
* table reference with respect to name resolution.
297
* If 'this' is a nested table reference - the left-most child of
298
* the tree rooted in 'this',
301
259
TableList *first_leaf_for_name_resolution();
303
* Retrieve the last (right-most) leaf in a nested join tree with
304
* respect to name resolution.
308
* Given that 'this' is a nested table reference, recursively walk
309
* down the right-most children of 'this' until we reach a leaf
310
* table reference with respect to name resolution.
313
* If 'this' is a nested table reference - the right-most child of
314
* the tree rooted in 'this',
317
260
TableList *last_leaf_for_name_resolution();
319
* Test if this is a leaf with respect to name resolution.
323
* A table reference is a leaf with respect to name resolution if
324
* it is either a leaf node in a nested join tree (table, view,
325
* schema table, subquery), or an inner node that represents a
326
* NATURAL/USING join, or a nested join with materialized join
330
* true if a leaf, false otherwise.
332
261
bool is_leaf_for_name_resolution();
333
262
inline TableList *top_table()
337
* Return subselect that contains the FROM list this table is taken from
340
* Subselect item for the subquery that contains the FROM list
341
* this table is taken from if there is any
266
Cleanup for re-execution in a prepared statement or a stored
269
void reinit_before_use(THD *thd);
345
270
Item_subselect *containing_subselect();
348
* Compiles the tagged hints list and fills up st_table::keys_in_use_for_query,
349
* st_table::keys_in_use_for_group_by, st_table::keys_in_use_for_order_by,
350
* st_table::force_index and st_table::covering_keys.
352
* @param the Table to operate on.
356
* The parser collects the index hints for each table in a "tagged list"
357
* (TableList::index_hints). Using the information in this tagged list
358
* this function sets the members Table::keys_in_use_for_query,
359
* Table::keys_in_use_for_group_by, Table::keys_in_use_for_order_by,
360
* Table::force_index and Table::covering_keys.
362
* Current implementation of the runtime does not allow mixing FORCE INDEX
363
* and USE INDEX, so this is checked here. Then the FORCE INDEX list
364
* (if non-empty) is appended to the USE INDEX list and a flag is set.
366
* Multiple hints of the same kind are processed so that each clause
367
* is applied to what is computed in the previous clause.
370
* USE INDEX (i1) USE INDEX (i2)
373
* and means "consider only i1 and i2".
376
* USE INDEX () USE INDEX (i1)
379
* and means "consider only the index i1"
381
* It is OK to have the same index several times, e.g. "USE INDEX (i1,i1)" is
384
* Different kind of hints (USE/FORCE/IGNORE) are processed in the following
386
* 1. All indexes in USE (or FORCE) INDEX are added to the mask.
387
* 2. All IGNORE INDEX
388
* e.g. "USE INDEX i1, IGNORE INDEX i1, USE INDEX i1" will not use i1 at all
389
* as if we had "USE INDEX i1, USE INDEX i1, IGNORE INDEX i1".
390
* As an optimization if there is a covering index, and we have
391
* IGNORE INDEX FOR GROUP/order_st, and this index is used for the JOIN part,
392
* then we have to ignore the IGNORE INDEX FROM GROUP/order_st.
395
* false no errors found
397
* true found and reported an error.
273
Compiles the tagged hints list and fills up st_table::keys_in_use_for_query,
274
st_table::keys_in_use_for_group_by, st_table::keys_in_use_for_order_by,
275
st_table::force_index and st_table::covering_keys.
399
277
bool process_index_hints(Table *table);
401
friend std::ostream& operator<<(std::ostream& output, const TableList &list)
403
output << "TableList:(";
406
output << list.table_name;
408
output << list.alias;
410
output << "is_natural_join:" << list.is_natural_join;
412
output << "is_join_columns_complete:" << list.is_join_columns_complete;
414
output << "straight:" << list.straight;
416
output << "force_index" << list.force_index;
418
output << "ignore_leaves:" << list.ignore_leaves;
420
output << "create:" << list.create;
422
output << "outer_join:" << list.outer_join;
424
output << "nested_join:" << list.nested_join;
427
return output; // for multiple << operators.
430
void setIsAlias(bool in_is_alias)
432
is_alias= in_is_alias;
435
void setIsFqtn(bool in_is_fqtn)
440
void setCreate(bool in_create)
445
void setInternalTmpTable(bool in_internal_tmp_table)
447
internal_tmp_table= in_internal_tmp_table;
450
void setDbType(plugin::StorageEngine *in_db_type)
455
void setJoinList(List<TableList> *in_join_list)
457
join_list= in_join_list;
460
void setEmbedding(TableList *in_embedding)
462
embedding= in_embedding;
465
void setNestedJoin(nested_join_st *in_nested_join)
467
nested_join= in_nested_join;
470
void setDepTables(table_map in_dep_tables)
472
dep_tables= in_dep_tables;
475
void setOnExprDepTables(table_map in_on_expr_dep_tables)
477
on_expr_dep_tables= in_on_expr_dep_tables;
480
bool getIsAlias() const
485
bool getIsFqtn() const
490
bool isCreate() const
495
bool getInternalTmpTable() const
497
return internal_tmp_table;
500
plugin::StorageEngine *getDbType() const
505
TableList *getEmbedding() const
510
List<TableList> *getJoinList() const
515
nested_join_st *getNestedJoin() const
520
table_map getDepTables() const
525
table_map getOnExprDepTables() const
527
return on_expr_dep_tables;
530
void unlock_table_name();
531
void unlock_table_names(TableList *last_table= NULL);
535
table_map dep_tables; ///< tables the table depends on
536
table_map on_expr_dep_tables; ///< tables on expression depends on
537
nested_join_st *nested_join; ///< if the element is a nested join
538
TableList *embedding; ///< nested join containing the table
539
List<TableList> *join_list; ///< join list the table belongs to
540
plugin::StorageEngine *db_type; ///< table_type for handler
541
char timestamp_buffer[20]; ///< buffer for timestamp (19+1)
542
bool internal_tmp_table;
543
/** true if an alias for this table was specified in the SQL. */
547
* true if the table is referred to in the statement using a fully
548
* qualified name (<db_name>.<table_name>).
552
* This TableList object corresponds to the table to be created
553
* so it is possible that it does not exist (used in CREATE TABLE
554
* ... SELECT implementation).
560
void close_thread_tables(Session *session);
562
} /* namespace drizzled */
564
#endif /* DRIZZLED_TABLE_LIST_H */
279
#endif /* DRIZZLED_TMP_TABLE_H */