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
232
210
enum ha_choice transactional;
233
211
enum ha_choice page_checksum;
235
uint ref_count; /* How many TABLE objects uses this */
236
uint open_count; /* Number of tables in open list */
237
uint blob_ptr_size; /* 4 or 8 */
238
uint key_block_size; /* create key_block_size, if used */
239
uint null_bytes, last_null_bit_pos;
240
uint fields; /* Number of fields */
241
uint rec_buff_length; /* Size of table->record[] buffer */
242
uint keys, key_parts;
243
uint max_key_length, max_unique_length, total_key_length;
244
uint uniques; /* Number of UNIQUE index */
245
uint null_fields; /* number of null fields */
246
uint blob_fields; /* number of blob fields */
247
uint timestamp_field_offset; /* Field number for timestamp field */
248
uint varchar_fields; /* number of varchar fields */
249
uint db_create_options; /* Create options from database */
250
uint db_options_in_use; /* Options in use */
251
uint db_record_offset; /* if HA_REC_IN_SEQ */
252
uint rowid_field_offset; /* Field_nr +1 to rowid field */
213
uint32_t ref_count; /* How many Table objects uses this */
214
uint32_t open_count; /* Number of tables in open list */
215
uint32_t blob_ptr_size; /* 4 or 8 */
216
uint32_t key_block_size; /* create key_block_size, if used */
217
uint32_t null_bytes, last_null_bit_pos;
218
uint32_t fields; /* Number of fields */
219
uint32_t stored_fields; /* Number of stored fields
220
(i.e. without generated-only ones) */
221
uint32_t rec_buff_length; /* Size of table->record[] buffer */
222
uint32_t keys, key_parts;
223
uint32_t max_key_length, max_unique_length, total_key_length;
224
uint32_t uniques; /* Number of UNIQUE index */
225
uint32_t null_fields; /* number of null fields */
226
uint32_t blob_fields; /* number of blob fields */
227
uint32_t timestamp_field_offset; /* Field number for timestamp field */
228
uint32_t varchar_fields; /* number of varchar fields */
229
uint32_t db_create_options; /* Create options from database */
230
uint32_t db_options_in_use; /* Options in use */
231
uint32_t db_record_offset; /* if HA_REC_IN_SEQ */
232
uint32_t rowid_field_offset; /* Field_nr +1 to rowid field */
253
233
/* Index of auto-updated TIMESTAMP field in field array */
255
uint next_number_index; /* autoincrement key number */
256
uint next_number_key_offset; /* autoinc keypart offset in a key */
257
uint next_number_keypart; /* autoinc keypart number in a key */
258
uint error, open_errno, errarg; /* error from open_table_def() */
259
uint column_bitmap_size;
234
uint32_t primary_key;
235
uint32_t next_number_index; /* autoincrement key number */
236
uint32_t next_number_key_offset; /* autoinc keypart offset in a key */
237
uint32_t next_number_keypart; /* autoinc keypart number in a key */
238
uint32_t error, open_errno, errarg; /* error from open_table_def() */
239
uint32_t column_bitmap_size;
240
unsigned char frm_version;
241
uint32_t vfields; /* Number of virtual fields */
261
242
bool null_field_first;
262
bool system; /* Set if system table (one record) */
263
243
bool db_low_byte_first; /* Portable row format */
265
245
bool name_lock, replace_with_name_lock;
266
246
bool waiting_on_cond; /* Protection against free */
267
ulong table_map_id; /* for row-based replication */
247
uint32_t table_map_id; /* for row-based replication */
268
248
uint64_t table_map_version;
703
Column reference of a NATURAL/USING join. Since column references in
704
joins can be both from views and stored tables, may point to either a
705
Field (for tables), or a Field_translator (for views).
708
class Natural_join_column: public Sql_alloc
711
Field_translator *view_field; /* Column reference of merge view. */
712
Field *table_field; /* Column reference of table or temp view. */
713
TABLE_LIST *table_ref; /* Original base table/view reference. */
715
True if a common join column of two NATURAL/USING join operands. Notice
716
that when we have a hierarchy of nested NATURAL/USING joins, a column can
717
be common at some level of nesting but it may not be common at higher
718
levels of nesting. Thus this flag may change depending on at which level
719
we are looking at some column.
723
Natural_join_column(Field_translator *field_param, TABLE_LIST *tab);
724
Natural_join_column(Field *field_param, TABLE_LIST *tab);
726
Item *create_item(THD *thd);
728
const char *table_name();
729
const char *db_name();
734
Table reference in the FROM clause.
736
These table references can be of several types that correspond to
737
different SQL elements. Below we list all types of TABLE_LISTs with
738
the necessary conditions to determine when a TABLE_LIST instance
739
belongs to a certain type.
741
1) table (TABLE_LIST::view == NULL)
743
(TABLE_LIST::derived == NULL)
744
- subquery - TABLE_LIST::table is a temp table
745
(TABLE_LIST::derived != NULL)
746
- information schema table
747
(TABLE_LIST::schema_table != NULL)
748
NOTICE: for schema tables TABLE_LIST::field_translation may be != NULL
749
2) view (TABLE_LIST::view != NULL)
750
- merge (TABLE_LIST::effective_algorithm == VIEW_ALGORITHM_MERGE)
751
also (TABLE_LIST::field_translation != NULL)
752
- tmptable (TABLE_LIST::effective_algorithm == VIEW_ALGORITHM_TMPTABLE)
753
also (TABLE_LIST::field_translation == NULL)
754
3) nested table reference (TABLE_LIST::nested_join != NULL)
755
- table sequence - e.g. (t1, t2, t3)
756
TODO: how to distinguish from a JOIN?
758
TODO: how to distinguish from a table sequence?
760
(TABLE_LIST::natural_join != NULL)
762
(TABLE_LIST::join_using_fields != NULL)
770
TABLE_LIST() {} /* Remove gcc warning */
773
Prepare TABLE_LIST that consists of one table instance to use in
774
simple_open_and_lock_tables
776
inline void init_one_table(const char *db_name_arg,
777
const char *table_name_arg,
778
enum thr_lock_type lock_type_arg)
780
memset(this, 0, sizeof(*this));
781
db= (char*) db_name_arg;
782
table_name= alias= (char*) table_name_arg;
783
lock_type= lock_type_arg;
787
List of tables local to a subquery (used by SQL_LIST). Considers
788
views as leaves (unlike 'next_leaf' below). Created at parse time
789
in st_select_lex::add_table_to_list() -> table_list.link_in_list().
791
TABLE_LIST *next_local;
792
/* link in a global list of all queries tables */
793
TABLE_LIST *next_global, **prev_global;
794
char *db, *alias, *table_name, *schema_table_name;
795
char *option; /* Used by cache index */
796
Item *on_expr; /* Used with outer join */
799
(Valid only for semi-join nests) Bitmap of tables that are within the
800
semi-join (this is different from bitmap of all nest's children because
801
tables that were pulled out of the semi-join nest remain listed as
804
table_map sj_inner_tables;
805
/* Number of IN-compared expressions */
808
The structure of ON expression presented in the member above
809
can be changed during certain optimizations. This member
810
contains a snapshot of AND-OR structure of the ON expression
811
made after permanent transformations of the parse tree, and is
812
used to restore ON clause before every reexecution of a prepared
813
statement or stored procedure.
816
COND_EQUAL *cond_equal; /* Used with outer join */
818
During parsing - left operand of NATURAL/USING join where 'this' is
819
the right operand. After parsing (this->natural_join == this) iff
820
'this' represents a NATURAL or USING join operation. Thus after
821
parsing 'this' is a NATURAL/USING join iff (natural_join != NULL).
823
TABLE_LIST *natural_join;
825
True if 'this' represents a nested join that is a NATURAL JOIN.
826
For one of the operands of 'this', the member 'natural_join' points
827
to the other operand of 'this'.
829
bool is_natural_join;
830
/* Field names in a USING clause for JOIN ... USING. */
831
List<String> *join_using_fields;
833
Explicitly store the result columns of either a NATURAL/USING join or
834
an operand of such a join.
836
List<Natural_join_column> *join_columns;
837
/* true if join_columns contains all columns of this table reference. */
838
bool is_join_columns_complete;
841
List of nodes in a nested join tree, that should be considered as
842
leaves with respect to name resolution. The leaves are: views,
843
top-most nodes representing NATURAL/USING joins, subqueries, and
844
base tables. All of these TABLE_LIST instances contain a
845
materialized list of columns. The list is local to a subquery.
847
TABLE_LIST *next_name_resolution_table;
848
/* Index names in a "... JOIN ... USE/IGNORE INDEX ..." clause. */
849
List<Index_hint> *index_hints;
850
TABLE *table; /* opened table */
851
uint table_id; /* table id (from binlog) for opened table */
853
select_result for derived table to pass it from table creation to table
856
select_union *derived_result;
858
Reference from aux_tables to local list entry of main select of
859
multi-delete statement:
860
delete t1 from t2,t1 where t1.a<'B' and t2.b=t1.b;
861
here it will be reference of first occurrence of t1 to second (as you
862
can see this lists can't be merged)
864
TABLE_LIST *correspondent_table;
865
st_select_lex_unit *derived; /* SELECT_LEX_UNIT of derived table */
866
ST_SCHEMA_TABLE *schema_table; /* Information_schema table */
867
st_select_lex *schema_select_lex;
869
True when the view field translation table is used to convert
870
schema table fields for backwards compatibility with SHOW command.
872
bool schema_table_reformed;
873
TMP_TABLE_PARAM *schema_table_param;
874
/* link to select_lex where this table was used */
875
st_select_lex *select_lex;
876
Field_translator *field_translation; /* array of VIEW fields */
877
/* pointer to element after last one in translation table above */
878
Field_translator *field_translation_end;
880
List (based on next_local) of underlying tables of this view. I.e. it
881
does not include the tables of subqueries used in the view. Is set only
884
TABLE_LIST *merge_underlying_list;
887
- in case of the view it is the list of all (not only underlying
888
tables but also used in subquery ones) tables of the view.
890
List<TABLE_LIST> *view_tables;
891
/* most upper view this table belongs to */
892
TABLE_LIST *belong_to_view;
893
/* Ptr to parent MERGE table list item. See top comment in ha_myisammrg.cc */
894
TABLE_LIST *parent_l;
896
List of all base tables local to a subquery including all view
897
tables. Unlike 'next_local', this in this list views are *not*
898
leaves. Created in setup_tables() -> make_leaves_list().
900
TABLE_LIST *next_leaf;
901
/* data need by some engines in query cache*/
902
uint64_t engine_data;
903
/* call back function for asking handler about caching in query cache */
904
qc_engine_callback callback_func;
905
thr_lock_type lock_type;
906
uint outer_join; /* Which join type */
907
uint shared; /* Used in multi-upd */
909
size_t table_name_length;
910
bool straight; /* optimize with prev table */
911
bool updating; /* for replicate-do/ignore table */
912
bool force_index; /* prefer index over table scan */
913
bool ignore_leaves; /* preload only non-leaf nodes */
914
table_map dep_tables; /* tables the table depends on */
915
table_map on_expr_dep_tables; /* tables on expression depends on */
916
struct st_nested_join *nested_join; /* if the element is a nested join */
917
TABLE_LIST *embedding; /* nested join containing the table */
918
List<TABLE_LIST> *join_list;/* join list the table belongs to */
919
bool cacheable_table; /* stop PS caching */
920
/* FRMTYPE_ERROR if any type is acceptable */
921
enum frm_type_enum required_type;
922
handlerton *db_type; /* table_type for handler */
923
char timestamp_buffer[20]; /* buffer for timestamp (19+1) */
925
This TABLE_LIST object corresponds to the table to be created
926
so it is possible that it does not exist (used in CREATE TABLE
927
... SELECT implementation).
930
/* For transactional locking. */
931
int lock_timeout; /* NOWAIT or WAIT [X] */
932
bool lock_transactional; /* If transactional lock requested. */
933
bool internal_tmp_table;
934
/** true if an alias for this table was specified in the SQL. */
936
/** true if the table is referred to in the statement using a fully
937
qualified name (<db_name>.<table_name>).
941
uint i_s_requested_object;
942
bool has_db_lookup_value;
943
bool has_table_lookup_value;
944
uint table_open_method;
945
enum enum_schema_table_state schema_table_state;
946
void set_underlying_merge();
947
bool setup_underlying(THD *thd);
948
void cleanup_items();
950
If you change placeholder(), please check the condition in
951
check_transactional_lock() too.
955
return derived || schema_table || (create && !table->db_stat) || !table;
957
void print(THD *thd, String *str, enum_query_type query_type);
958
bool set_insert_values(MEM_ROOT *mem_root);
959
TABLE_LIST *find_underlying_table(TABLE *table);
960
TABLE_LIST *first_leaf_for_name_resolution();
961
TABLE_LIST *last_leaf_for_name_resolution();
962
bool is_leaf_for_name_resolution();
963
inline TABLE_LIST *top_table()
964
{ return belong_to_view ? belong_to_view : this; }
967
Cleanup for re-execution in a prepared statement or a stored
970
void reinit_before_use(THD *thd);
971
Item_subselect *containing_subselect();
974
Compiles the tagged hints list and fills up st_table::keys_in_use_for_query,
975
st_table::keys_in_use_for_group_by, st_table::keys_in_use_for_order_by,
976
st_table::force_index and st_table::covering_keys.
978
bool process_index_hints(TABLE *table);
981
bool prep_where(THD *thd, Item **conds, bool no_where_clause);
983
Cleanup for re-execution in a prepared statement or a stored
991
Iterator over the fields of a generic table reference.
994
class Field_iterator: public Sql_alloc
997
Field_iterator() {} /* Remove gcc warning */
998
virtual ~Field_iterator() {}
999
virtual void set(TABLE_LIST *)= 0;
1000
virtual void next()= 0;
1001
virtual bool end_of_fields()= 0; /* Return 1 at end of list */
1002
virtual const char *name()= 0;
1003
virtual Item *create_item(THD *)= 0;
1004
virtual Field *field()= 0;
1009
Iterator over the fields of a base table, view with temporary
1013
class Field_iterator_table: public Field_iterator
1017
Field_iterator_table() :ptr(0) {}
1018
void set(TABLE_LIST *table) { ptr= table->table->field; }
1019
void set_table(TABLE *table) { ptr= table->field; }
1020
void next() { ptr++; }
1021
bool end_of_fields() { return *ptr == 0; }
1023
Item *create_item(THD *thd);
1024
Field *field() { return *ptr; }
1028
/* Iterator over the fields of a merge view. */
1030
class Field_iterator_view: public Field_iterator
1032
Field_translator *ptr, *array_end;
1035
Field_iterator_view() :ptr(0), array_end(0) {}
1036
void set(TABLE_LIST *table);
1037
void next() { ptr++; }
1038
bool end_of_fields() { return ptr == array_end; }
1040
Item *create_item(THD *thd);
1041
Item **item_ptr() {return &ptr->item; }
1042
Field *field() { return 0; }
1043
inline Item *item() { return ptr->item; }
1044
Field_translator *field_translator() { return ptr; }
1049
Field_iterator interface to the list of materialized fields of a
1053
class Field_iterator_natural_join: public Field_iterator
1055
List_iterator_fast<Natural_join_column> column_ref_it;
1056
Natural_join_column *cur_column_ref;
1058
Field_iterator_natural_join() :cur_column_ref(NULL) {}
1059
~Field_iterator_natural_join() {}
1060
void set(TABLE_LIST *table);
1062
bool end_of_fields() { return !cur_column_ref; }
1063
const char *name() { return cur_column_ref->name(); }
1064
Item *create_item(THD *thd) { return cur_column_ref->create_item(thd); }
1065
Field *field() { return cur_column_ref->field(); }
1066
Natural_join_column *column_ref() { return cur_column_ref; }
1071
Generic iterator over the fields of an arbitrary table reference.
1074
This class unifies the various ways of iterating over the columns
1075
of a table reference depending on the type of SQL entity it
1076
represents. If such an entity represents a nested table reference,
1077
this iterator encapsulates the iteration over the columns of the
1078
members of the table reference.
1081
The implementation assumes that all underlying NATURAL/USING table
1082
references already contain their result columns and are linked into
1083
the list TABLE_LIST::next_name_resolution_table.
1086
class Field_iterator_table_ref: public Field_iterator
1088
TABLE_LIST *table_ref, *first_leaf, *last_leaf;
1089
Field_iterator_table table_field_it;
1090
Field_iterator_view view_field_it;
1091
Field_iterator_natural_join natural_join_it;
1092
Field_iterator *field_it;
1093
void set_field_iterator();
1095
Field_iterator_table_ref() :field_it(NULL) {}
1096
void set(TABLE_LIST *table);
1098
bool end_of_fields()
1099
{ return (table_ref == last_leaf && field_it->end_of_fields()); }
1100
const char *name() { return field_it->name(); }
1101
const char *table_name();
1102
const char *db_name();
1103
Item *create_item(THD *thd) { return field_it->create_item(thd); }
1104
Field *field() { return field_it->field(); }
1105
Natural_join_column *get_or_create_column_ref(TABLE_LIST *parent_table_ref);
1106
Natural_join_column *get_natural_column_ref();
1110
typedef struct st_nested_join
1112
List<TABLE_LIST> join_list; /* list of elements in the nested join */
1113
table_map used_tables; /* bitmap of tables in the nested join */
1114
table_map not_null_tables; /* tables that rejects nulls */
1115
struct st_join_table *first_nested;/* the first nested table in the plan */
1117
Used to count tables in the nested join in 2 isolated places:
1118
1. In make_outerjoin_info().
1119
2. check_interleaving_with_nj/restore_prev_nj_state (these are called
1120
by the join optimizer.
1121
Before each use the counters are zeroed by reset_nj_counters.
1124
nested_join_map nj_map; /* Bit used to identify this nested join*/
1126
(Valid only for semi-join nests) Bitmap of tables outside the semi-join
1127
that are used within the semi-join's ON condition.
1129
table_map sj_depends_on;
1130
/* Outer non-trivially correlated tables */
1131
table_map sj_corr_tables;
1132
List<Item> sj_outer_expr_list;
1136
731
typedef struct st_changed_table_list
1138
733
struct st_changed_table_list *next;
1140
735
uint32_t key_length;
1141
} CHANGED_TABLE_LIST;
1144
typedef struct st_open_table_list{
739
typedef struct st_open_table_list
1145
741
struct st_open_table_list *next;
1146
742
char *db,*table;
1147
743
uint32_t in_use,locked;
1150
typedef struct st_table_field_w_type
1155
} TABLE_FIELD_W_TYPE;
1159
table_check_intact(TABLE *table, const uint table_f_count,
1160
const TABLE_FIELD_W_TYPE *table_def);
1162
static inline my_bitmap_map *tmp_use_all_columns(TABLE *table,
1165
my_bitmap_map *old= bitmap->bitmap;
1166
bitmap->bitmap= table->s->all_set.bitmap;
1171
static inline void tmp_restore_column_map(MY_BITMAP *bitmap,
1174
bitmap->bitmap= old;
1177
/* The following is only needed for debugging */
1179
static inline my_bitmap_map *dbug_tmp_use_all_columns(TABLE *table __attribute__((unused)),
1180
MY_BITMAP *bitmap __attribute__((unused)))
1185
static inline void dbug_tmp_restore_column_map(MY_BITMAP *bitmap __attribute__((unused)),
1186
my_bitmap_map *old __attribute__((unused)))
1191
size_t max_row_length(TABLE *table, const uchar *data);
747
#endif /* DRIZZLED_TABLE_H */
added
removed
drizzled/table.h
