table.h 16 KB
Newer Older
unknown's avatar
unknown committed
1
/* Copyright (C) 2000 MySQL AB & MySQL Finland AB & TCX DataKonsult AB
unknown's avatar
unknown committed
2

unknown's avatar
unknown committed
3 4 5 6
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.
unknown's avatar
unknown committed
7

unknown's avatar
unknown committed
8 9 10 11
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
unknown's avatar
unknown committed
12

unknown's avatar
unknown committed
13 14 15 16 17 18 19 20 21
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */


/* Structs that defines the TABLE */

class Item;				/* Needed by ORDER */
class GRANT_TABLE;
22
class st_select_lex_unit;
unknown's avatar
VIEW  
unknown committed
23
class st_select_lex;
unknown's avatar
unknown committed
24
class COND_EQUAL;
unknown's avatar
unknown committed
25 26 27 28 29 30

/* Order clause list element */

typedef struct st_order {
  struct st_order *next;
  Item	 **item;			/* Point at item in select fields */
unknown's avatar
unknown committed
31
  Item	 *item_ptr;			/* Storage for initial item */
32
  Item   **item_copy;			/* For SPs; the original item ptr */
33 34
  int    counter;                       /* position in SELECT list, correct
                                           only if counter_used is true*/
unknown's avatar
unknown committed
35 36 37
  bool	 asc;				/* true if ascending */
  bool	 free_me;			/* true if item isn't shared  */
  bool	 in_field_list;			/* true if in select field list */
38
  bool   counter_used;                  /* parameter was counter of columns */
unknown's avatar
unknown committed
39 40 41 42 43 44 45 46 47
  Field  *field;			/* If tmp-table group */
  char	 *buff;				/* If tmp-table group */
  table_map used,depend_map;
} ORDER;

typedef struct st_grant_info
{
  GRANT_TABLE *grant_table;
  uint version;
unknown's avatar
unknown committed
48 49
  ulong privilege;
  ulong want_privilege;
unknown's avatar
unknown committed
50 51
} GRANT_INFO;

unknown's avatar
unknown committed
52 53
enum tmp_table_type {NO_TMP_TABLE=0, TMP_TABLE=1, TRANSACTIONAL_TMP_TABLE=2};

54 55 56 57 58 59 60
enum frm_type_enum
{
  FRMTYPE_ERROR= 0,
  FRMTYPE_TABLE,
  FRMTYPE_VIEW
};

unknown's avatar
unknown committed
61 62 63 64 65 66 67 68 69 70 71
typedef struct st_filesort_info
{
  IO_CACHE *io_cache;           /* If sorted through filebyte                */
  byte     *addon_buf;          /* Pointer to a buffer if sorted with fields */
  uint      addon_length;       /* Length of the buffer                      */
  struct st_sort_addon_field *addon_field;     /* Pointer to the fields info */
  void    (*unpack)(struct st_sort_addon_field *, byte *); /* To unpack back */
  byte     *record_pointers;    /* If sorted in memory                       */
  ha_rows   found_records;      /* How many records in sort                  */
} FILESORT_INFO;

unknown's avatar
unknown committed
72

73 74 75 76 77 78 79 80 81 82
/*
  Values in this enum are used to indicate during which operations value
  of TIMESTAMP field should be set to current timestamp.
*/
enum timestamp_auto_set_type
{
  TIMESTAMP_NO_AUTO_SET= 0, TIMESTAMP_AUTO_SET_ON_INSERT= 1,
  TIMESTAMP_AUTO_SET_ON_UPDATE= 2, TIMESTAMP_AUTO_SET_ON_BOTH= 3
};

unknown's avatar
unknown committed
83 84 85 86
/* Table cache entry struct */

class Field_timestamp;
class Field_blob;
87
class Table_triggers_list;
unknown's avatar
unknown committed
88 89 90

struct st_table {
  handler *file;
91
  Field **field;			/* Pointer to fields */
unknown's avatar
unknown committed
92
  Field_blob **blob_field;		/* Pointer to blob fields */
unknown's avatar
unknown committed
93 94
  /* hash of field names (contains pointers to elements of field array) */
  HASH	name_hash;
unknown's avatar
unknown committed
95
  byte *record[2];			/* Pointer to records */
unknown's avatar
VIEW  
unknown committed
96
  byte *default_values;         	/* Default values for INSERT */
unknown's avatar
unknown committed
97
  byte *insert_values;                  /* used by INSERT ... UPDATE */
unknown's avatar
unknown committed
98 99 100 101
  uint fields;				/* field count */
  uint reclength;			/* Recordlength */
  uint rec_buff_length;
  uint keys,key_parts,primary_key,max_key_length,max_unique_length;
102
  uint total_key_length;
unknown's avatar
unknown committed
103 104 105
  uint uniques;
  uint null_fields;			/* number of null fields */
  uint blob_fields;			/* number of blob fields */
106
  key_map keys_in_use, keys_for_keyread, read_only_keys;
107
  key_map quick_keys, used_keys, keys_in_use_for_query;
unknown's avatar
unknown committed
108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124
  KEY  *key_info;			/* data of keys in database */
  TYPELIB keynames;			/* Pointers to keynames */
  ha_rows max_rows;			/* create information */
  ha_rows min_rows;			/* create information */
  ulong   avg_row_length;		/* create information */
  ulong   raid_chunksize;
  TYPELIB fieldnames;			/* Pointer to fieldnames */
  TYPELIB *intervals;			/* pointer to interval info */
  enum db_type db_type;			/* table_type for handler */
  enum row_type row_type;		/* How rows are stored */
  uint db_create_options;		/* Create options from database */
  uint db_options_in_use;		/* Options in use */
  uint db_record_offset;		/* if HA_REC_IN_SEQ */
  uint db_stat;				/* mode of file as in handler.h */
  uint raid_type,raid_chunks;
  uint status;				/* Used by postfix.. */
  uint system;				/* Set if system record */
unknown's avatar
unknown committed
125

126 127 128 129 130 131 132 133 134 135 136
  /*
    If this table has TIMESTAMP field with auto-set property (pointed by
    timestamp_field member) then this variable indicates during which
    operations (insert only/on update/in both cases) we should set this
    field to current timestamp. If there are no such field in this table
    or we should not automatically set its value during execution of current
    statement then the variable contains TIMESTAMP_NO_AUTO_SET (i.e. 0).

    Value of this variable is set for each statement in open_table() and
    if needed cleared later in statement processing code (see mysql_update()
    as example).
unknown's avatar
unknown committed
137
  */
138
  timestamp_auto_set_type timestamp_field_type;
unknown's avatar
unknown committed
139
  /* Index of auto-updated TIMESTAMP field in field array */
unknown's avatar
unknown committed
140
  uint timestamp_field_offset;
unknown's avatar
unknown committed
141
  
unknown's avatar
unknown committed
142 143 144 145
  uint next_number_index;
  uint blob_ptr_size;			/* 4 or 8 */
  uint next_number_key_offset;
  int current_lock;			/* Type of lock on table */
unknown's avatar
unknown committed
146
  enum tmp_table_type tmp_table;
unknown's avatar
unknown committed
147 148 149
  my_bool copy_blobs;			/* copy_blobs when storing */
  my_bool null_row;			/* All columns are null */
  my_bool maybe_null,outer_join;	/* Used with OUTER JOIN */
150
  my_bool force_index;
151
  my_bool distinct,const_table,no_rows;
unknown's avatar
unknown committed
152
  my_bool key_read;
unknown's avatar
unknown committed
153 154 155
  my_bool crypted;
  my_bool db_low_byte_first;		/* Portable row format */
  my_bool locked_by_flush;
unknown's avatar
unknown committed
156
  my_bool locked_by_name;
unknown's avatar
unknown committed
157
  my_bool fulltext_searched;
158
  my_bool crashed;
unknown's avatar
unknown committed
159
  my_bool is_view;
160
  my_bool no_keyread, no_cache;
unknown's avatar
unknown committed
161
  my_bool clear_query_id;               /* To reset query_id for tables and cols */
unknown's avatar
unknown committed
162
  my_bool auto_increment_field_not_null;
unknown's avatar
unknown committed
163
  my_bool alias_name_used; /* true if table_name is alias */
unknown's avatar
unknown committed
164 165 166 167
  Field *next_number_field,		/* Set if next_number is activated */
	*found_next_number_field,	/* Set on open */
        *rowid_field;
  Field_timestamp *timestamp_field;
168 169 170 171 172 173 174 175
#if MYSQL_VERSION_ID < 40100
  /*
    Indicates whenever we have to set field_length members of all TIMESTAMP
    fields to 19 (to honour 'new_mode' variable) or to original
    field_length values.
  */
  my_bool timestamp_mode;
#endif
unknown's avatar
unknown committed
176
  my_string comment;			/* Comment about table */
177
  CHARSET_INFO *table_charset;		/* Default charset of string fields */
unknown's avatar
unknown committed
178 179 180
  REGINFO reginfo;			/* field connections */
  MEM_ROOT mem_root;
  GRANT_INFO grant;
181 182
  /* Table's triggers, 0 if there are no of them */
  Table_triggers_list *triggers;
unknown's avatar
unknown committed
183

184
  /* A pair "database_name\0table_name\0", widely used as simply a db name */
unknown's avatar
unknown committed
185 186 187 188
  char		*table_cache_key;
  char		*table_name,*real_name,*path;
  uint		key_length;		/* Length of key */
  uint		tablenr,used_fields,null_bytes;
unknown's avatar
unknown committed
189
  table_map	map;                    /* ID bit of table (1,2,4,8,16...) */
unknown's avatar
unknown committed
190 191
  ulong		version,flush_version;
  uchar		*null_flags;
unknown's avatar
unknown committed
192
  FILESORT_INFO sort;
unknown's avatar
unknown committed
193 194 195 196 197
  ORDER		*group;
  ha_rows	quick_rows[MAX_KEY];
  uint		quick_key_parts[MAX_KEY];
  key_part_map  const_key_parts[MAX_KEY];
  ulong		query_id;
198
  uchar		frm_version;
unknown's avatar
unknown committed
199
  uint          temp_pool_slot;		/* Used by intern temp tables */
200
  struct st_table_list *pos_in_table_list;/* Element referring to this table */
unknown's avatar
unknown committed
201
  /* number of select if it is derived table */
unknown's avatar
unknown committed
202
  uint          derived_select_number;
unknown's avatar
unknown committed
203
  THD		*in_use;		/* Which thread uses this */
unknown's avatar
unknown committed
204 205 206 207
  struct st_table *next,*prev;
};


208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
typedef struct st_foreign_key_info
{
  LEX_STRING *forein_id;
  LEX_STRING *referenced_db;
  LEX_STRING *referenced_table;
  LEX_STRING *constraint_method;
  List<LEX_STRING> foreign_fields;
  List<LEX_STRING> referenced_fields;
} FOREIGN_KEY_INFO;


enum enum_schema_tables
{
  SCH_SCHEMATA= 0, SCH_TABLES, SCH_COLUMNS, SCH_CHARSETS, SCH_COLLATIONS,
  SCH_COLLATION_CHARACTER_SET_APPLICABILITY, SCH_PROCEDURES, SCH_STATISTICS,
  SCH_VIEWS, SCH_USER_PRIVILEGES, SCH_SCHEMA_PRIVILEGES, SCH_TABLE_PRIVILEGES,
  SCH_COLUMN_PRIVILEGES, SCH_TABLE_CONSTRAINTS, SCH_KEY_COLUMN_USAGE,
  SCH_TABLE_NAMES
};


typedef struct st_field_info
{
  const char* field_name;
  uint field_length;
  enum enum_field_types field_type;
  int value;
  bool maybe_null;
  const char* old_name;
} ST_FIELD_INFO;

struct st_table_list;
typedef class Item COND;

typedef struct st_schema_table
{
  const char* table_name;
  ST_FIELD_INFO *fields_info;
  /* Create information_schema table */
247
  TABLE *(*create_table)  (THD *thd, struct st_table_list *table_list);
248 249 250 251 252
  /* Fill table with data */
  int (*fill_table) (THD *thd, struct st_table_list *tables, COND *cond);
  /* Handle fileds for old SHOW */
  int (*old_format) (THD *thd, struct st_schema_table *schema_table);
  int (*process_table) (THD *thd, struct st_table_list *tables,
unknown's avatar
unknown committed
253
                        TABLE *table, bool res, const char *base_name,
254 255 256 257 258
                        const char *file_name);
  int idx_field1, idx_field2; 
} ST_SCHEMA_TABLE;


259 260 261
#define JOIN_TYPE_LEFT	1
#define JOIN_TYPE_RIGHT	2

unknown's avatar
VIEW  
unknown committed
262
#define VIEW_ALGORITHM_UNDEFINED	0
263
#define VIEW_ALGORITHM_TMPTABLE	1
unknown's avatar
VIEW  
unknown committed
264 265
#define VIEW_ALGORITHM_MERGE		2

unknown's avatar
unknown committed
266
/* view WITH CHECK OPTION parameter options */
unknown's avatar
unknown committed
267 268 269 270
#define VIEW_CHECK_NONE       0
#define VIEW_CHECK_LOCAL      1
#define VIEW_CHECK_CASCADED   2

unknown's avatar
unknown committed
271 272 273 274 275
/* result of view WITH CHECK OPTION parameter check */
#define VIEW_CHECK_OK         0
#define VIEW_CHECK_ERROR      1
#define VIEW_CHECK_SKIP       2

unknown's avatar
VIEW  
unknown committed
276
struct st_lex;
277
class select_union;
278 279 280 281 282
struct Field_translator
{
  Item *item;
  const char *name;
};
unknown's avatar
VIEW  
unknown committed
283

284 285
typedef struct st_table_list
{
unknown's avatar
VIEW  
unknown committed
286 287 288 289
  /* link in a local table list (used by SQL_LIST) */
  struct st_table_list *next_local;
  /* link in a global list of all queries tables */
  struct st_table_list *next_global, **prev_global;
unknown's avatar
unknown committed
290
  char		*db, *alias, *real_name, *schema_table_name;
291
  char          *option;                /* Used by cache index  */
292
  Item		*on_expr;		/* Used with outer join */
unknown's avatar
unknown committed
293
  COND_EQUAL    *cond_equal;            /* Used with outer join */
294
  struct st_table_list *natural_join;	/* natural join on this table*/
unknown's avatar
unknown committed
295
  /* ... join ... USE INDEX ... IGNORE INDEX */
296
  List<String>	*use_index, *ignore_index;
unknown's avatar
VIEW  
unknown committed
297
  TABLE         *table;                 /* opened table */
unknown's avatar
unknown committed
298 299 300 301 302
  /*
    select_result for derived table to pass it from table creation to table
    filling procedure
  */
  select_union  *derived_result;
unknown's avatar
VIEW  
unknown committed
303 304 305 306 307 308 309 310 311
  /*
    Reference from aux_tables to local list entry of main select of
    multi-delete statement:
    delete t1 from t2,t1 where t1.a<'B' and t2.b=t1.b;
    here it will be reference of first occurrence of t1 to second (as you
    can see this lists can't be merged)
  */
  st_table_list	*correspondent_table;
  st_select_lex_unit *derived;		/* SELECT_LEX_UNIT of derived table */
312 313
  ST_SCHEMA_TABLE *schema_table;        /* Information_schema table */
  st_select_lex	*schema_select_lex;
unknown's avatar
VIEW  
unknown committed
314 315 316
  /* link to select_lex where this table was used */
  st_select_lex	*select_lex;
  st_lex	*view;			/* link on VIEW lex for merging */
317
  Field_translator *field_translation;	/* array of VIEW fields */
unknown's avatar
VIEW  
unknown committed
318 319
  /* ancestor of this table (VIEW merge algorithm) */
  st_table_list	*ancestor;
320 321
  /* most upper view this table belongs to */
  st_table_list	*belong_to_view;
322 323
  /* list of join table tree leaves */
  st_table_list	*next_leaf;
unknown's avatar
VIEW  
unknown committed
324
  Item          *where;                 /* VIEW WHERE clause condition */
unknown's avatar
unknown committed
325
  Item          *check_option;          /* WITH CHECK OPTION condition */
unknown's avatar
VIEW  
unknown committed
326
  LEX_STRING	query;			/* text of (CRETE/SELECT) statement */
327
  LEX_STRING	md5;			/* md5 of query text */
unknown's avatar
VIEW  
unknown committed
328
  LEX_STRING	source;			/* source of CREATE VIEW */
329 330
  LEX_STRING	view_db;		/* saved view database */
  LEX_STRING	view_name;		/* saved view name */
unknown's avatar
VIEW  
unknown committed
331 332
  LEX_STRING	timestamp;		/* GMT time stamp of last operation */
  ulonglong	file_version;		/* version of file's field set */
unknown's avatar
unknown committed
333
  ulonglong     updatable_view;         /* VIEW can be updated */
unknown's avatar
VIEW  
unknown committed
334 335
  ulonglong	revision;		/* revision control number */
  ulonglong	algorithm;		/* 0 any, 1 tmp tables , 2 merging */
unknown's avatar
unknown committed
336
  ulonglong     with_check;             /* WITH CHECK OPTION */
337 338 339 340 341
  /*
    effective value of WITH CHECK OPTION (differ for temporary table
    algorithm)
  */
  uint8         effective_with_check;
unknown's avatar
VIEW  
unknown committed
342
  uint          effective_algorithm;    /* which algorithm was really used */
343
  uint		privilege_backup;       /* place for saving privileges */
unknown's avatar
VIEW  
unknown committed
344
  GRANT_INFO	grant;
345
  thr_lock_type lock_type;
346
  uint		outer_join;		/* Which join type */
unknown's avatar
unknown committed
347
  uint		shared;			/* Used in multi-upd */
348
  uint32        db_length, real_name_length;
349
  bool          updatable;		/* VIEW/TABLE can be updated now */
350 351
  bool		straight;		/* optimize with prev table */
  bool          updating;               /* for replicate-do/ignore table */
352 353
  bool		force_index;		/* prefer index over table scan */
  bool          ignore_leaves;          /* preload only non-leaf nodes */
unknown's avatar
unknown committed
354
  bool          no_where_clause;        /* do not attach WHERE to SELECT */
355
  table_map     dep_tables;             /* tables the table depends on      */
356
  table_map     on_expr_dep_tables;     /* tables on expression depends on  */
357 358
  struct st_nested_join *nested_join;   /* if the element is a nested join  */
  st_table_list *embedding;             /* nested join containing the table */
359
  List<struct st_table_list> *join_list;/* join list the table belongs to   */
unknown's avatar
unknown committed
360
  bool		cacheable_table;	/* stop PS caching */
361
  /* used in multi-upd/views privilege check */
unknown's avatar
VIEW  
unknown committed
362 363 364
  bool		table_in_first_from_clause;
  bool		skip_temporary;		/* this table shouldn't be temporary */
  bool          setup_is_done;          /* setup_tables() is done */
365
  /* TRUE if this merged view contain auto_increment field */
unknown's avatar
VIEW  
unknown committed
366
  bool          contain_auto_increment;
367 368
  /* FRMTYPE_ERROR if any type is acceptable */
  enum frm_type_enum required_type;
unknown's avatar
VIEW  
unknown committed
369
  char		timestamp_buffer[20];	/* buffer for timestamp (19+1) */
370

unknown's avatar
VIEW  
unknown committed
371 372
  void calc_md5(char *buffer);
  void set_ancestor();
unknown's avatar
unknown committed
373
  int view_check_option(THD *thd, bool ignore_failure);
374
  bool setup_ancestor(THD *thd, Item **conds, uint8 check_option);
unknown's avatar
unknown committed
375
  void cleanup_items();
unknown's avatar
VIEW  
unknown committed
376
  bool placeholder() {return derived || view; }
377
  void print(THD *thd, String *str);
378 379
  void save_and_clear_want_privilege();
  void restore_want_privilege();
380 381 382
  bool check_single_table(st_table_list **table, table_map map);
  bool set_insert_values(MEM_ROOT *mem_root);
  void clear_insert_values();
unknown's avatar
unknown committed
383
} TABLE_LIST;
384

unknown's avatar
VIEW  
unknown committed
385 386 387 388 389 390 391 392
class Item;

class Field_iterator: public Sql_alloc
{
public:
  virtual ~Field_iterator() {}
  virtual void set(TABLE_LIST *)= 0;
  virtual void next()= 0;
393
  virtual bool end_of_fields()= 0;              /* Return 1 at end of list */
unknown's avatar
VIEW  
unknown committed
394 395 396 397 398 399 400 401 402 403 404 405 406 407
  virtual const char *name()= 0;
  virtual Item *item(THD *)= 0;
  virtual Field *field()= 0;
};


class Field_iterator_table: public Field_iterator
{
  Field **ptr;
public:
  Field_iterator_table() :ptr(0) {}
  void set(TABLE_LIST *table) { ptr= table->table->field; }
  void set_table(TABLE *table) { ptr= table->field; }
  void next() { ptr++; }
408
  bool end_of_fields() { return *ptr == 0; }
unknown's avatar
VIEW  
unknown committed
409 410 411 412 413 414 415 416
  const char *name();
  Item *item(THD *thd);
  Field *field() { return *ptr; }
};


class Field_iterator_view: public Field_iterator
{
417
  Field_translator *ptr, *array_end;
unknown's avatar
VIEW  
unknown committed
418 419 420 421
public:
  Field_iterator_view() :ptr(0), array_end(0) {}
  void set(TABLE_LIST *table);
  void next() { ptr++; }
422
  bool end_of_fields() { return ptr == array_end; }
unknown's avatar
VIEW  
unknown committed
423
  const char *name();
424
  Item *item(THD *thd) { return ptr->item; }
unknown's avatar
VIEW  
unknown committed
425 426 427
  Field *field() { return 0; }
};

428 429 430 431
typedef struct st_nested_join
{
  List<TABLE_LIST>  join_list;       /* list of elements in the nested join */
  table_map         used_tables;     /* bitmap of tables in the nested join */
432
  table_map         not_null_tables; /* tables that rejects nulls           */
433 434 435
  struct st_join_table *first_nested;/* the first nested table in the plan  */
  uint              counter;         /* to count tables in the nested join  */
} NESTED_JOIN;
436

437 438
typedef struct st_changed_table_list
{
439
  struct	st_changed_table_list *next;
440
  char		*key;
441 442 443
  uint32        key_length;
} CHANGED_TABLE_LIST;

444
typedef struct st_open_table_list{
445 446 447 448
  struct st_open_table_list *next;
  char	*db,*table;
  uint32 in_use,locked;
} OPEN_TABLE_LIST;
unknown's avatar
unknown committed
449 450