18
18
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
22
#ifndef DRIZZLED_TABLE_LIST_H
22
23
#define DRIZZLED_TABLE_LIST_H
24
#include <drizzled/nested_join.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
42
3) nested table reference (TableList::nested_join != NULL)
43
- table sequence - e.g. (t1, t2, t3)
44
TODO: how to distinguish from a JOIN?
46
TODO: how to distinguish from a table sequence?
48
(TableList::natural_join != NULL)
50
(TableList::join_using_fields != NULL)
25
56
#include <drizzled/table.h>
32
60
class Natural_join_column;
33
61
class select_union;
34
62
class Select_Lex_Unit;
63
class ST_SCHEMA_TABLE;
36
65
class Tmp_Table_Param;
37
66
class Item_subselect;
69
struct nested_join_st;
46
* A Table referenced in the FROM clause.
48
* These table references can be of several types that correspond to
49
* different SQL elements. Below we list all types of TableLists with
50
* the necessary conditions to determine when a TableList instance
51
* belongs to a certain type.
53
* 1) table (TableList::view == NULL)
55
* (TableList::derived == NULL)
56
* - subquery - TableList::table is a temp table
57
* (TableList::derived != NULL)
61
* for schema tables TableList::field_translation may be != NULL
64
* 3) nested table reference (TableList::nested_join != NULL)
65
* - table sequence - e.g. (t1, t2, t3)
66
* @todo how to distinguish from a JOIN?
68
* @todo how to distinguish from a table sequence?
70
* (TableList::natural_join != NULL)
72
* (TableList::join_using_fields != NULL)
91
is_natural_join(false),
92
is_join_columns_complete(false),
96
join_using_fields(NULL),
98
next_name_resolution_table(NULL),
100
derived_result(NULL),
102
schema_select_lex(NULL),
107
table_name_length(0),
109
on_expr_dep_tables(0),
114
internal_tmp_table(false),
74
TableList() {} /* Remove gcc warning */
121
* List of tables local to a subquery (used by SQL_LIST). Considers
122
* views as leaves (unlike 'next_leaf' below). Created at parse time
123
* in Select_Lex::add_table_to_list() -> table_list.link_in_list().
77
Prepare TableList that consists of one table instance to use in
78
simple_open_and_lock_tables
80
inline void init_one_table(const char *db_name_arg,
81
const char *table_name_arg,
82
enum thr_lock_type lock_type_arg)
84
memset(this, 0, sizeof(*this));
85
db= (char*) db_name_arg;
86
table_name= alias= (char*) table_name_arg;
87
lock_type= lock_type_arg;
91
List of tables local to a subquery (used by SQL_LIST). Considers
92
views as leaves (unlike 'next_leaf' below). Created at parse time
93
in Select_Lex::add_table_to_list() -> table_list.link_in_list().
125
95
TableList *next_local;
127
/** link in a global list of all queries tables */
128
TableList *next_global;
129
TableList **prev_global;
135
const char *getSchemaName()
140
char **getSchemaNamePtr()
145
void setSchemaName(char *arg)
153
const char *table_name;
156
const char *getTableName()
161
void setTableName(const char *arg)
166
char *option; ///< Used by cache index
167
Item *on_expr; ///< Used with outer join
168
Table *table; ///< opened table
170
* The structure of ON expression presented in the member above
171
* can be changed during certain optimizations. This member
172
* contains a snapshot of AND-OR structure of the ON expression
173
* made after permanent transformations of the parse tree, and is
174
* used to restore ON clause before every reexecution of a prepared
175
* statement or stored procedure.
178
COND_EQUAL *cond_equal; ///< Used with outer join
180
* During parsing - left operand of NATURAL/USING join where 'this' is
181
* the right operand. After parsing (this->natural_join == this) iff
182
* 'this' represents a NATURAL or USING join operation. Thus after
183
* parsing 'this' is a NATURAL/USING join iff (natural_join != NULL).
96
/* link in a global list of all queries tables */
97
TableList *next_global, **prev_global;
98
char *db, *alias, *table_name, *schema_table_name;
99
char *option; /* Used by cache index */
100
Item *on_expr; /* Used with outer join */
103
(Valid only for semi-join nests) Bitmap of tables that are within the
104
semi-join (this is different from bitmap of all nest's children because
105
tables that were pulled out of the semi-join nest remain listed as
108
table_map sj_inner_tables;
109
/* Number of IN-compared expressions */
110
uint32_t sj_in_exprs;
112
The structure of ON expression presented in the member above
113
can be changed during certain optimizations. This member
114
contains a snapshot of AND-OR structure of the ON expression
115
made after permanent transformations of the parse tree, and is
116
used to restore ON clause before every reexecution of a prepared
117
statement or stored procedure.
120
COND_EQUAL *cond_equal; /* Used with outer join */
122
During parsing - left operand of NATURAL/USING join where 'this' is
123
the right operand. After parsing (this->natural_join == this) iff
124
'this' represents a NATURAL or USING join operation. Thus after
125
parsing 'this' is a NATURAL/USING join iff (natural_join != NULL).
185
127
TableList *natural_join;
187
* True if 'this' represents a nested join that is a NATURAL JOIN.
188
* For one of the operands of 'this', the member 'natural_join' points
189
* to the other operand of 'this'.
129
True if 'this' represents a nested join that is a NATURAL JOIN.
130
For one of the operands of 'this', the member 'natural_join' points
131
to the other operand of 'this'.
191
133
bool is_natural_join;
193
/** true if join_columns contains all columns of this table reference. */
194
bool is_join_columns_complete;
196
bool straight; ///< optimize with prev table
197
bool force_index; ///< prefer index over table scan
198
bool ignore_leaves; ///< preload only non-leaf nodes
201
is the table a cartesian join, assumption is yes unless "solved"
203
bool isCartesian() const;
205
/** Field names in a USING clause for JOIN ... USING. */
134
/* Field names in a USING clause for JOIN ... USING. */
206
135
List<String> *join_using_fields;
208
* Explicitly store the result columns of either a NATURAL/USING join or
209
* an operand of such a join.
137
Explicitly store the result columns of either a NATURAL/USING join or
138
an operand of such a join.
211
140
List<Natural_join_column> *join_columns;
141
/* true if join_columns contains all columns of this table reference. */
142
bool is_join_columns_complete;
214
* List of nodes in a nested join tree, that should be considered as
215
* leaves with respect to name resolution. The leaves are: views,
216
* top-most nodes representing NATURAL/USING joins, subqueries, and
217
* base tables. All of these TableList instances contain a
218
* materialized list of columns. The list is local to a subquery.
145
List of nodes in a nested join tree, that should be considered as
146
leaves with respect to name resolution. The leaves are: views,
147
top-most nodes representing NATURAL/USING joins, subqueries, and
148
base tables. All of these TableList instances contain a
149
materialized list of columns. The list is local to a subquery.
220
151
TableList *next_name_resolution_table;
221
/** Index names in a "... JOIN ... USE/IGNORE INDEX ..." clause. */
152
/* Index names in a "... JOIN ... USE/IGNORE INDEX ..." clause. */
222
153
List<Index_hint> *index_hints;
224
* select_result for derived table to pass it from table creation to table
227
select_union *derived_result;
228
Select_Lex_Unit *derived; ///< Select_Lex_Unit of derived table */
229
Select_Lex *schema_select_lex;
230
/** link to select_lex where this table was used */
231
Select_Lex *select_lex;
233
* List of all base tables local to a subquery including all view
234
* tables. Unlike 'next_local', this in this list views are *not*
235
* leaves. Created in setup_tables() -> make_leaves_list().
237
TableList *next_leaf;
154
Table *table; /* opened table */
155
uint32_t table_id; /* table id (from binlog) for opened table */
157
select_result for derived table to pass it from table creation to table
160
select_union *derived_result;
162
Reference from aux_tables to local list entry of main select of
163
multi-delete statement:
164
delete t1 from t2,t1 where t1.a<'B' and t2.b=t1.b;
165
here it will be reference of first occurrence of t1 to second (as you
166
can see this lists can't be merged)
168
TableList *correspondent_table;
169
Select_Lex_Unit *derived; /* Select_Lex_Unit of derived table */
170
ST_SCHEMA_TABLE *schema_table; /* Information_schema table */
171
Select_Lex *schema_select_lex;
173
True when the view field translation table is used to convert
174
schema table fields for backwards compatibility with SHOW command.
176
bool schema_table_reformed;
177
Tmp_Table_Param *schema_table_param;
178
/* link to select_lex where this table was used */
179
Select_Lex *select_lex;
181
List (based on next_local) of underlying tables of this view. I.e. it
182
does not include the tables of subqueries used in the view. Is set only
185
TableList *merge_underlying_list;
187
List of all base tables local to a subquery including all view
188
tables. Unlike 'next_local', this in this list views are *not*
189
leaves. Created in setup_tables() -> make_leaves_list().
191
TableList *next_leaf;
238
192
thr_lock_type lock_type;
239
uint32_t outer_join; ///< Which join type
241
size_t table_name_length;
193
uint outer_join; /* Which join type */
194
uint shared; /* Used in multi-upd */
196
size_t table_name_length;
197
bool straight; /* optimize with prev table */
198
bool updating; /* for replicate-do/ignore table */
199
bool force_index; /* prefer index over table scan */
200
bool ignore_leaves; /* preload only non-leaf nodes */
201
table_map dep_tables; /* tables the table depends on */
202
table_map on_expr_dep_tables; /* tables on expression depends on */
203
nested_join_st *nested_join; /* if the element is a nested join */
204
TableList *embedding; /* nested join containing the table */
205
List<TableList> *join_list;/* join list the table belongs to */
206
bool cacheable_table; /* stop PS caching */
207
handlerton *db_type; /* table_type for handler */
208
char timestamp_buffer[20]; /* buffer for timestamp (19+1) */
210
This TableList object corresponds to the table to be created
211
so it is possible that it does not exist (used in CREATE TABLE
212
... SELECT implementation).
215
/* For transactional locking. */
216
int lock_timeout; /* NOWAIT or WAIT [X] */
217
bool lock_transactional; /* If transactional lock requested. */
218
bool internal_tmp_table;
219
/** true if an alias for this table was specified in the SQL. */
221
/** true if the table is referred to in the statement using a fully
222
qualified name (<db_name>.<table_name>).
226
uint32_t i_s_requested_object;
227
bool has_db_lookup_value;
228
bool has_table_lookup_value;
229
uint32_t table_open_method;
230
enum enum_schema_table_state schema_table_state;
243
231
void set_underlying_merge();
244
232
bool setup_underlying(Session *session);
247
* If you change placeholder(), please check the condition in
248
* check_transactional_lock() too.
233
void cleanup_items();
235
If you change placeholder(), please check the condition in
236
check_transactional_lock() too.
250
238
bool placeholder();
252
* Print table as it should be in join list.
254
* @param str string where table should be printed
256
239
void print(Session *session, String *str, enum_query_type query_type);
258
* Sets insert_values buffer
260
* @param[in] memory pool for allocating
265
* true - out of memory
267
bool set_insert_values(memory::Root *mem_root);
269
* Find underlying base tables (TableList) which represent given
270
* table_to_find (Table)
272
* @param[in] table to find
275
* NULL if table is not found
277
* Pointer to found table reference
240
bool set_insert_values(MEM_ROOT *mem_root);
279
241
TableList *find_underlying_table(Table *table);
281
* Retrieve the first (left-most) leaf in a nested join tree with
282
* respect to name resolution.
286
* Given that 'this' is a nested table reference, recursively walk
287
* down the left-most children of 'this' until we reach a leaf
288
* table reference with respect to name resolution.
291
* If 'this' is a nested table reference - the left-most child of
292
* the tree rooted in 'this',
295
242
TableList *first_leaf_for_name_resolution();
297
* Retrieve the last (right-most) leaf in a nested join tree with
298
* respect to name resolution.
302
* Given that 'this' is a nested table reference, recursively walk
303
* down the right-most children of 'this' until we reach a leaf
304
* table reference with respect to name resolution.
307
* If 'this' is a nested table reference - the right-most child of
308
* the tree rooted in 'this',
311
243
TableList *last_leaf_for_name_resolution();
313
* Test if this is a leaf with respect to name resolution.
317
* A table reference is a leaf with respect to name resolution if
318
* it is either a leaf node in a nested join tree (table, view,
319
* schema table, subquery), or an inner node that represents a
320
* NATURAL/USING join, or a nested join with materialized join
324
* true if a leaf, false otherwise.
326
244
bool is_leaf_for_name_resolution();
327
245
inline TableList *top_table()
331
* Return subselect that contains the FROM list this table is taken from
334
* Subselect item for the subquery that contains the FROM list
335
* this table is taken from if there is any
249
Cleanup for re-execution in a prepared statement or a stored
252
void reinit_before_use(Session *session);
339
253
Item_subselect *containing_subselect();
342
* Compiles the tagged hints list and fills up st_table::keys_in_use_for_query,
343
* st_table::keys_in_use_for_group_by, st_table::keys_in_use_for_order_by,
344
* st_table::force_index and st_table::covering_keys.
346
* @param the Table to operate on.
350
* The parser collects the index hints for each table in a "tagged list"
351
* (TableList::index_hints). Using the information in this tagged list
352
* this function sets the members Table::keys_in_use_for_query,
353
* Table::keys_in_use_for_group_by, Table::keys_in_use_for_order_by,
354
* Table::force_index and Table::covering_keys.
356
* Current implementation of the runtime does not allow mixing FORCE INDEX
357
* and USE INDEX, so this is checked here. Then the FORCE INDEX list
358
* (if non-empty) is appended to the USE INDEX list and a flag is set.
360
* Multiple hints of the same kind are processed so that each clause
361
* is applied to what is computed in the previous clause.
364
* USE INDEX (i1) USE INDEX (i2)
367
* and means "consider only i1 and i2".
370
* USE INDEX () USE INDEX (i1)
373
* and means "consider only the index i1"
375
* It is OK to have the same index several times, e.g. "USE INDEX (i1,i1)" is
378
* Different kind of hints (USE/FORCE/IGNORE) are processed in the following
380
* 1. All indexes in USE (or FORCE) INDEX are added to the mask.
381
* 2. All IGNORE INDEX
382
* e.g. "USE INDEX i1, IGNORE INDEX i1, USE INDEX i1" will not use i1 at all
383
* as if we had "USE INDEX i1, USE INDEX i1, IGNORE INDEX i1".
384
* As an optimization if there is a covering index, and we have
385
* IGNORE INDEX FOR GROUP/order_st, and this index is used for the JOIN part,
386
* then we have to ignore the IGNORE INDEX FROM GROUP/order_st.
389
* false no errors found
391
* true found and reported an error.
256
Compiles the tagged hints list and fills up st_table::keys_in_use_for_query,
257
st_table::keys_in_use_for_group_by, st_table::keys_in_use_for_order_by,
258
st_table::force_index and st_table::covering_keys.
393
260
bool process_index_hints(Table *table);
395
friend std::ostream& operator<<(std::ostream& output, const TableList &list)
397
output << "TableList:(";
400
output << list.table_name;
402
output << list.alias;
404
output << "is_natural_join:" << list.is_natural_join;
406
output << "is_join_columns_complete:" << list.is_join_columns_complete;
408
output << "straight:" << list.straight;
410
output << "force_index" << list.force_index;
412
output << "ignore_leaves:" << list.ignore_leaves;
414
output << "create:" << list.create;
416
output << "outer_join:" << list.outer_join;
418
output << "nested_join:" << list.nested_join;
421
return output; // for multiple << operators.
424
void setIsAlias(bool in_is_alias)
426
is_alias= in_is_alias;
429
void setIsFqtn(bool in_is_fqtn)
434
void setCreate(bool in_create)
439
void setInternalTmpTable(bool in_internal_tmp_table)
441
internal_tmp_table= in_internal_tmp_table;
444
void setDbType(plugin::StorageEngine *in_db_type)
449
void setJoinList(List<TableList> *in_join_list)
451
join_list= in_join_list;
454
void setEmbedding(TableList *in_embedding)
456
embedding= in_embedding;
459
void setNestedJoin(NestedJoin *in_nested_join)
461
nested_join= in_nested_join;
464
void setDepTables(table_map in_dep_tables)
466
dep_tables= in_dep_tables;
469
void setOnExprDepTables(table_map in_on_expr_dep_tables)
471
on_expr_dep_tables= in_on_expr_dep_tables;
474
bool getIsAlias() const
479
bool getIsFqtn() const
484
bool isCreate() const
489
bool getInternalTmpTable() const
491
return internal_tmp_table;
494
plugin::StorageEngine *getDbType() const
499
TableList *getEmbedding() const
504
List<TableList> *getJoinList() const
509
NestedJoin *getNestedJoin() const
514
table_map getDepTables() const
519
table_map getOnExprDepTables() const
521
return on_expr_dep_tables;
524
void unlock_table_name();
525
void unlock_table_names(TableList *last_table= NULL);
528
table_map dep_tables; ///< tables the table depends on
529
table_map on_expr_dep_tables; ///< tables on expression depends on
530
NestedJoin *nested_join; ///< if the element is a nested join
531
TableList *embedding; ///< nested join containing the table
532
List<TableList> *join_list; ///< join list the table belongs to
533
plugin::StorageEngine *db_type; ///< table_type for handler
534
bool internal_tmp_table;
536
/** true if an alias for this table was specified in the SQL. */
540
* true if the table is referred to in the statement using a fully
541
* qualified name (<db_name>.<table_name>).
546
* This TableList object corresponds to the table to be created
547
* so it is possible that it does not exist (used in CREATE TABLE
548
* ... SELECT implementation).
554
263
void close_thread_tables(Session *session);
556
} /* namespace drizzled */
558
265
#endif /* DRIZZLED_TABLE_LIST_H */