1
/* Copyright (C) 2000-2006 MySQL AB
3
This program is free software; you can redistribute it and/or modify
4
it under the terms of the GNU General Public License as published by
5
the Free Software Foundation; version 2 of the License.
7
This program is distributed in the hope that it will be useful,
8
but WITHOUT ANY WARRANTY; without even the implied warranty of
9
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10
GNU General Public License for more details.
12
You should have received a copy of the GNU General Public License
13
along with this program; if not, write to the Free Software
14
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA */
17
/* Structs that defines the TABLE */
19
class Item; /* Needed by ORDER */
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Copyright (C) 2008 Sun Microsystems
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.
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.
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
21
/* Structs that defines the Table */
23
#ifndef DRIZZLED_TABLE_H
24
#define DRIZZLED_TABLE_H
26
#include <storage/myisam/myisam.h>
27
#include <drizzled/order.h>
28
#include <drizzled/filesort_info.h>
29
#include <drizzled/natural_join_column.h>
30
#include <drizzled/nested_join.h>
31
#include <drizzled/field_iterator.h>
33
class Item; /* Needed by order_st */
20
34
class Item_subselect;
21
35
class st_select_lex_unit;
22
36
class st_select_lex;
24
38
class Security_context;
26
41
/*************************************************************************/
28
/* Order clause list element */
30
typedef struct st_order {
31
struct st_order *next;
32
Item **item; /* Point at item in select fields */
33
Item *item_ptr; /* Storage for initial item */
34
Item **item_copy; /* For SPs; the original item ptr */
35
int counter; /* position in SELECT list, correct
36
only if counter_used is true*/
37
bool asc; /* true if ascending */
38
bool free_me; /* true if item isn't shared */
39
bool in_field_list; /* true if in select field list */
40
bool counter_used; /* parameter was counter of columns */
41
Field *field; /* If tmp-table group */
42
char *buff; /* If tmp-table group */
43
table_map used, depend_map;
46
43
enum tmp_table_type
48
45
NO_TMP_TABLE, NON_TRANSACTIONAL_TMP_TABLE, TRANSACTIONAL_TMP_TABLE,
49
46
INTERNAL_TMP_TABLE, SYSTEM_TMP_TABLE, TMP_TABLE_FRM_FILE_ONLY
58
frm_type_enum mysql_frm_type(THD *thd, char *path, enum legacy_db_type *dbt);
49
bool mysql_frm_type(THD *thd, char *path, enum legacy_db_type *dbt);
61
52
enum release_type { RELEASE_NORMAL, RELEASE_WAIT_FOR_DROP };
63
typedef struct st_filesort_info
65
IO_CACHE *io_cache; /* If sorted through filesort */
66
uchar **sort_keys; /* Buffer for sorting keys */
67
uchar *buffpek; /* Buffer for buffpek structures */
68
uint buffpek_len; /* Max number of buffpeks in the buffer */
69
uchar *addon_buf; /* Pointer to a buffer if sorted with fields */
70
size_t addon_length; /* Length of the buffer */
71
struct st_sort_addon_field *addon_field; /* Pointer to the fields info */
72
void (*unpack)(struct st_sort_addon_field *, uchar *); /* To unpack back */
73
uchar *record_pointers; /* If sorted in memory */
74
ha_rows found_records; /* How many records in sort */
79
55
Values in this enum are used to indicate how a tables TIMESTAMP field
80
56
should be treated. It can be set to the current timestamp on insert or
244
208
enum ha_choice transactional;
245
209
enum ha_choice page_checksum;
247
uint ref_count; /* How many TABLE objects uses this */
248
uint open_count; /* Number of tables in open list */
249
uint blob_ptr_size; /* 4 or 8 */
250
uint key_block_size; /* create key_block_size, if used */
251
uint null_bytes, last_null_bit_pos;
252
uint fields; /* Number of fields */
253
uint rec_buff_length; /* Size of table->record[] buffer */
254
uint keys, key_parts;
255
uint max_key_length, max_unique_length, total_key_length;
256
uint uniques; /* Number of UNIQUE index */
257
uint null_fields; /* number of null fields */
258
uint blob_fields; /* number of blob fields */
259
uint timestamp_field_offset; /* Field number for timestamp field */
260
uint varchar_fields; /* number of varchar fields */
261
uint db_create_options; /* Create options from database */
262
uint db_options_in_use; /* Options in use */
263
uint db_record_offset; /* if HA_REC_IN_SEQ */
264
uint raid_type, raid_chunks;
265
uint rowid_field_offset; /* Field_nr +1 to rowid field */
211
uint32_t ref_count; /* How many Table objects uses this */
212
uint32_t open_count; /* Number of tables in open list */
213
uint32_t blob_ptr_size; /* 4 or 8 */
214
uint32_t key_block_size; /* create key_block_size, if used */
215
uint32_t null_bytes, last_null_bit_pos;
216
uint32_t fields; /* Number of fields */
217
uint32_t rec_buff_length; /* Size of table->record[] buffer */
218
uint32_t keys, key_parts;
219
uint32_t max_key_length, max_unique_length, total_key_length;
220
uint32_t uniques; /* Number of UNIQUE index */
221
uint32_t null_fields; /* number of null fields */
222
uint32_t blob_fields; /* number of blob fields */
223
uint32_t timestamp_field_offset; /* Field number for timestamp field */
224
uint32_t varchar_fields; /* number of varchar fields */
225
uint32_t db_create_options; /* Create options from database */
226
uint32_t db_options_in_use; /* Options in use */
227
uint32_t db_record_offset; /* if HA_REC_IN_SEQ */
228
uint32_t rowid_field_offset; /* Field_nr +1 to rowid field */
266
229
/* Index of auto-updated TIMESTAMP field in field array */
268
uint next_number_index; /* autoincrement key number */
269
uint next_number_key_offset; /* autoinc keypart offset in a key */
270
uint next_number_keypart; /* autoinc keypart number in a key */
271
uint error, open_errno, errarg; /* error from open_table_def() */
272
uint column_bitmap_size;
230
uint32_t primary_key;
231
uint32_t next_number_index; /* autoincrement key number */
232
uint32_t next_number_key_offset; /* autoinc keypart offset in a key */
233
uint32_t next_number_keypart; /* autoinc keypart number in a key */
234
uint32_t error, open_errno, errarg; /* error from open_table_def() */
235
uint32_t column_bitmap_size;
236
unsigned char frm_version;
274
237
bool null_field_first;
275
bool system; /* Set if system table (one record) */
276
bool crypted; /* If .frm file is crypted */
277
238
bool db_low_byte_first; /* Portable row format */
279
240
bool name_lock, replace_with_name_lock;
280
241
bool waiting_on_cond; /* Protection against free */
281
ulong table_map_id; /* for row-based replication */
242
uint32_t table_map_id; /* for row-based replication */
282
243
uint64_t table_map_version;
720
Column reference of a NATURAL/USING join. Since column references in
721
joins can be both from views and stored tables, may point to either a
722
Field (for tables), or a Field_translator (for views).
725
class Natural_join_column: public Sql_alloc
728
Field_translator *view_field; /* Column reference of merge view. */
729
Field *table_field; /* Column reference of table or temp view. */
730
TABLE_LIST *table_ref; /* Original base table/view reference. */
732
True if a common join column of two NATURAL/USING join operands. Notice
733
that when we have a hierarchy of nested NATURAL/USING joins, a column can
734
be common at some level of nesting but it may not be common at higher
735
levels of nesting. Thus this flag may change depending on at which level
736
we are looking at some column.
740
Natural_join_column(Field_translator *field_param, TABLE_LIST *tab);
741
Natural_join_column(Field *field_param, TABLE_LIST *tab);
743
Item *create_item(THD *thd);
745
const char *table_name();
746
const char *db_name();
751
Table reference in the FROM clause.
753
These table references can be of several types that correspond to
754
different SQL elements. Below we list all types of TABLE_LISTs with
755
the necessary conditions to determine when a TABLE_LIST instance
756
belongs to a certain type.
758
1) table (TABLE_LIST::view == NULL)
760
(TABLE_LIST::derived == NULL)
761
- subquery - TABLE_LIST::table is a temp table
762
(TABLE_LIST::derived != NULL)
763
- information schema table
764
(TABLE_LIST::schema_table != NULL)
765
NOTICE: for schema tables TABLE_LIST::field_translation may be != NULL
766
2) view (TABLE_LIST::view != NULL)
767
- merge (TABLE_LIST::effective_algorithm == VIEW_ALGORITHM_MERGE)
768
also (TABLE_LIST::field_translation != NULL)
769
- tmptable (TABLE_LIST::effective_algorithm == VIEW_ALGORITHM_TMPTABLE)
770
also (TABLE_LIST::field_translation == NULL)
771
3) nested table reference (TABLE_LIST::nested_join != NULL)
772
- table sequence - e.g. (t1, t2, t3)
773
TODO: how to distinguish from a JOIN?
775
TODO: how to distinguish from a table sequence?
777
(TABLE_LIST::natural_join != NULL)
779
(TABLE_LIST::join_using_fields != NULL)
787
TABLE_LIST() {} /* Remove gcc warning */
790
Prepare TABLE_LIST that consists of one table instance to use in
791
simple_open_and_lock_tables
793
inline void init_one_table(const char *db_name_arg,
794
const char *table_name_arg,
795
enum thr_lock_type lock_type_arg)
797
bzero((char*) this, sizeof(*this));
798
db= (char*) db_name_arg;
799
table_name= alias= (char*) table_name_arg;
800
lock_type= lock_type_arg;
804
List of tables local to a subquery (used by SQL_LIST). Considers
805
views as leaves (unlike 'next_leaf' below). Created at parse time
806
in st_select_lex::add_table_to_list() -> table_list.link_in_list().
808
TABLE_LIST *next_local;
809
/* link in a global list of all queries tables */
810
TABLE_LIST *next_global, **prev_global;
811
char *db, *alias, *table_name, *schema_table_name;
812
char *option; /* Used by cache index */
813
Item *on_expr; /* Used with outer join */
816
(Valid only for semi-join nests) Bitmap of tables that are within the
817
semi-join (this is different from bitmap of all nest's children because
818
tables that were pulled out of the semi-join nest remain listed as
821
table_map sj_inner_tables;
822
/* Number of IN-compared expressions */
825
The structure of ON expression presented in the member above
826
can be changed during certain optimizations. This member
827
contains a snapshot of AND-OR structure of the ON expression
828
made after permanent transformations of the parse tree, and is
829
used to restore ON clause before every reexecution of a prepared
830
statement or stored procedure.
833
COND_EQUAL *cond_equal; /* Used with outer join */
835
During parsing - left operand of NATURAL/USING join where 'this' is
836
the right operand. After parsing (this->natural_join == this) iff
837
'this' represents a NATURAL or USING join operation. Thus after
838
parsing 'this' is a NATURAL/USING join iff (natural_join != NULL).
840
TABLE_LIST *natural_join;
842
True if 'this' represents a nested join that is a NATURAL JOIN.
843
For one of the operands of 'this', the member 'natural_join' points
844
to the other operand of 'this'.
846
bool is_natural_join;
847
/* Field names in a USING clause for JOIN ... USING. */
848
List<String> *join_using_fields;
850
Explicitly store the result columns of either a NATURAL/USING join or
851
an operand of such a join.
853
List<Natural_join_column> *join_columns;
854
/* true if join_columns contains all columns of this table reference. */
855
bool is_join_columns_complete;
858
List of nodes in a nested join tree, that should be considered as
859
leaves with respect to name resolution. The leaves are: views,
860
top-most nodes representing NATURAL/USING joins, subqueries, and
861
base tables. All of these TABLE_LIST instances contain a
862
materialized list of columns. The list is local to a subquery.
864
TABLE_LIST *next_name_resolution_table;
865
/* Index names in a "... JOIN ... USE/IGNORE INDEX ..." clause. */
866
List<Index_hint> *index_hints;
867
TABLE *table; /* opened table */
868
uint table_id; /* table id (from binlog) for opened table */
870
select_result for derived table to pass it from table creation to table
873
select_union *derived_result;
875
Reference from aux_tables to local list entry of main select of
876
multi-delete statement:
877
delete t1 from t2,t1 where t1.a<'B' and t2.b=t1.b;
878
here it will be reference of first occurrence of t1 to second (as you
879
can see this lists can't be merged)
881
TABLE_LIST *correspondent_table;
882
st_select_lex_unit *derived; /* SELECT_LEX_UNIT of derived table */
883
ST_SCHEMA_TABLE *schema_table; /* Information_schema table */
884
st_select_lex *schema_select_lex;
886
True when the view field translation table is used to convert
887
schema table fields for backwards compatibility with SHOW command.
889
bool schema_table_reformed;
890
TMP_TABLE_PARAM *schema_table_param;
891
/* link to select_lex where this table was used */
892
st_select_lex *select_lex;
893
Field_translator *field_translation; /* array of VIEW fields */
894
/* pointer to element after last one in translation table above */
895
Field_translator *field_translation_end;
897
List (based on next_local) of underlying tables of this view. I.e. it
898
does not include the tables of subqueries used in the view. Is set only
901
TABLE_LIST *merge_underlying_list;
904
- in case of the view it is the list of all (not only underlying
905
tables but also used in subquery ones) tables of the view.
907
List<TABLE_LIST> *view_tables;
908
/* most upper view this table belongs to */
909
TABLE_LIST *belong_to_view;
910
/* Ptr to parent MERGE table list item. See top comment in ha_myisammrg.cc */
911
TABLE_LIST *parent_l;
913
List of all base tables local to a subquery including all view
914
tables. Unlike 'next_local', this in this list views are *not*
915
leaves. Created in setup_tables() -> make_leaves_list().
917
TABLE_LIST *next_leaf;
918
/* data need by some engines in query cache*/
919
uint64_t engine_data;
920
/* call back function for asking handler about caching in query cache */
921
qc_engine_callback callback_func;
922
thr_lock_type lock_type;
923
uint outer_join; /* Which join type */
924
uint shared; /* Used in multi-upd */
926
size_t table_name_length;
927
bool straight; /* optimize with prev table */
928
bool updating; /* for replicate-do/ignore table */
929
bool force_index; /* prefer index over table scan */
930
bool ignore_leaves; /* preload only non-leaf nodes */
931
table_map dep_tables; /* tables the table depends on */
932
table_map on_expr_dep_tables; /* tables on expression depends on */
933
struct st_nested_join *nested_join; /* if the element is a nested join */
934
TABLE_LIST *embedding; /* nested join containing the table */
935
List<TABLE_LIST> *join_list;/* join list the table belongs to */
936
bool cacheable_table; /* stop PS caching */
937
/* FRMTYPE_ERROR if any type is acceptable */
938
enum frm_type_enum required_type;
939
handlerton *db_type; /* table_type for handler */
940
char timestamp_buffer[20]; /* buffer for timestamp (19+1) */
942
This TABLE_LIST object corresponds to the table to be created
943
so it is possible that it does not exist (used in CREATE TABLE
944
... SELECT implementation).
947
/* For transactional locking. */
948
int lock_timeout; /* NOWAIT or WAIT [X] */
949
bool lock_transactional; /* If transactional lock requested. */
950
bool internal_tmp_table;
951
/** true if an alias for this table was specified in the SQL. */
953
/** true if the table is referred to in the statement using a fully
954
qualified name (<db_name>.<table_name>).
958
uint i_s_requested_object;
959
bool has_db_lookup_value;
960
bool has_table_lookup_value;
961
uint table_open_method;
962
enum enum_schema_table_state schema_table_state;
963
void set_underlying_merge();
964
bool setup_underlying(THD *thd);
965
void cleanup_items();
967
If you change placeholder(), please check the condition in
968
check_transactional_lock() too.
972
return derived || schema_table || (create && !table->db_stat) || !table;
974
void print(THD *thd, String *str, enum_query_type query_type);
975
bool set_insert_values(MEM_ROOT *mem_root);
976
TABLE_LIST *find_underlying_table(TABLE *table);
977
TABLE_LIST *first_leaf_for_name_resolution();
978
TABLE_LIST *last_leaf_for_name_resolution();
979
bool is_leaf_for_name_resolution();
980
inline TABLE_LIST *top_table()
981
{ return belong_to_view ? belong_to_view : this; }
984
Cleanup for re-execution in a prepared statement or a stored
987
void reinit_before_use(THD *thd);
988
Item_subselect *containing_subselect();
991
Compiles the tagged hints list and fills up st_table::keys_in_use_for_query,
992
st_table::keys_in_use_for_group_by, st_table::keys_in_use_for_order_by,
993
st_table::force_index and st_table::covering_keys.
995
bool process_index_hints(TABLE *table);
998
bool prep_where(THD *thd, Item **conds, bool no_where_clause);
1000
Cleanup for re-execution in a prepared statement or a stored
1008
Iterator over the fields of a generic table reference.
1011
class Field_iterator: public Sql_alloc
1014
Field_iterator() {} /* Remove gcc warning */
1015
virtual ~Field_iterator() {}
1016
virtual void set(TABLE_LIST *)= 0;
1017
virtual void next()= 0;
1018
virtual bool end_of_fields()= 0; /* Return 1 at end of list */
1019
virtual const char *name()= 0;
1020
virtual Item *create_item(THD *)= 0;
1021
virtual Field *field()= 0;
1026
Iterator over the fields of a base table, view with temporary
1030
class Field_iterator_table: public Field_iterator
1034
Field_iterator_table() :ptr(0) {}
1035
void set(TABLE_LIST *table) { ptr= table->table->field; }
1036
void set_table(TABLE *table) { ptr= table->field; }
1037
void next() { ptr++; }
1038
bool end_of_fields() { return *ptr == 0; }
1040
Item *create_item(THD *thd);
1041
Field *field() { return *ptr; }
1045
/* Iterator over the fields of a merge view. */
1047
class Field_iterator_view: public Field_iterator
1049
Field_translator *ptr, *array_end;
1052
Field_iterator_view() :ptr(0), array_end(0) {}
1053
void set(TABLE_LIST *table);
1054
void next() { ptr++; }
1055
bool end_of_fields() { return ptr == array_end; }
1057
Item *create_item(THD *thd);
1058
Item **item_ptr() {return &ptr->item; }
1059
Field *field() { return 0; }
1060
inline Item *item() { return ptr->item; }
1061
Field_translator *field_translator() { return ptr; }
1066
Field_iterator interface to the list of materialized fields of a
1070
class Field_iterator_natural_join: public Field_iterator
1072
List_iterator_fast<Natural_join_column> column_ref_it;
1073
Natural_join_column *cur_column_ref;
1075
Field_iterator_natural_join() :cur_column_ref(NULL) {}
1076
~Field_iterator_natural_join() {}
1077
void set(TABLE_LIST *table);
1079
bool end_of_fields() { return !cur_column_ref; }
1080
const char *name() { return cur_column_ref->name(); }
1081
Item *create_item(THD *thd) { return cur_column_ref->create_item(thd); }
1082
Field *field() { return cur_column_ref->field(); }
1083
Natural_join_column *column_ref() { return cur_column_ref; }
1088
Generic iterator over the fields of an arbitrary table reference.
1091
This class unifies the various ways of iterating over the columns
1092
of a table reference depending on the type of SQL entity it
1093
represents. If such an entity represents a nested table reference,
1094
this iterator encapsulates the iteration over the columns of the
1095
members of the table reference.
1098
The implementation assumes that all underlying NATURAL/USING table
1099
references already contain their result columns and are linked into
1100
the list TABLE_LIST::next_name_resolution_table.
1103
class Field_iterator_table_ref: public Field_iterator
1105
TABLE_LIST *table_ref, *first_leaf, *last_leaf;
1106
Field_iterator_table table_field_it;
1107
Field_iterator_view view_field_it;
1108
Field_iterator_natural_join natural_join_it;
1109
Field_iterator *field_it;
1110
void set_field_iterator();
1112
Field_iterator_table_ref() :field_it(NULL) {}
1113
void set(TABLE_LIST *table);
1115
bool end_of_fields()
1116
{ return (table_ref == last_leaf && field_it->end_of_fields()); }
1117
const char *name() { return field_it->name(); }
1118
const char *table_name();
1119
const char *db_name();
1120
Item *create_item(THD *thd) { return field_it->create_item(thd); }
1121
Field *field() { return field_it->field(); }
1122
Natural_join_column *get_or_create_column_ref(TABLE_LIST *parent_table_ref);
1123
Natural_join_column *get_natural_column_ref();
1127
typedef struct st_nested_join
1129
List<TABLE_LIST> join_list; /* list of elements in the nested join */
1130
table_map used_tables; /* bitmap of tables in the nested join */
1131
table_map not_null_tables; /* tables that rejects nulls */
1132
struct st_join_table *first_nested;/* the first nested table in the plan */
1134
Used to count tables in the nested join in 2 isolated places:
1135
1. In make_outerjoin_info().
1136
2. check_interleaving_with_nj/restore_prev_nj_state (these are called
1137
by the join optimizer.
1138
Before each use the counters are zeroed by reset_nj_counters.
1141
nested_join_map nj_map; /* Bit used to identify this nested join*/
1143
(Valid only for semi-join nests) Bitmap of tables outside the semi-join
1144
that are used within the semi-join's ON condition.
1146
table_map sj_depends_on;
1147
/* Outer non-trivially correlated tables */
1148
table_map sj_corr_tables;
1149
List<Item> sj_outer_expr_list;
1153
724
typedef struct st_changed_table_list
1155
726
struct st_changed_table_list *next;
1158
} CHANGED_TABLE_LIST;
1161
typedef struct st_open_table_list{
732
typedef struct st_open_table_list
1162
734
struct st_open_table_list *next;
1163
735
char *db,*table;
1164
uint32 in_use,locked;
1167
typedef struct st_table_field_w_type
1172
} TABLE_FIELD_W_TYPE;
1176
table_check_intact(TABLE *table, const uint table_f_count,
1177
const TABLE_FIELD_W_TYPE *table_def);
1179
static inline my_bitmap_map *tmp_use_all_columns(TABLE *table,
1182
my_bitmap_map *old= bitmap->bitmap;
1183
bitmap->bitmap= table->s->all_set.bitmap;
1188
static inline void tmp_restore_column_map(MY_BITMAP *bitmap,
1191
bitmap->bitmap= old;
1194
/* The following is only needed for debugging */
1196
static inline my_bitmap_map *dbug_tmp_use_all_columns(TABLE *table __attribute__((__unused__)),
1197
MY_BITMAP *bitmap __attribute__((__unused__)))
1202
static inline void dbug_tmp_restore_column_map(MY_BITMAP *bitmap __attribute__((__unused__)),
1203
my_bitmap_map *old __attribute__((__unused__)))
1208
size_t max_row_length(TABLE *table, const uchar *data);
736
uint32_t in_use,locked;
740
#endif /* DRIZZLED_TABLE_H */
added
removed
drizzled/table.h
