table.h 53.3 KB
Newer Older
unknown's avatar
unknown committed
1
/* Copyright (C) 2000-2006 MySQL AB
unknown's avatar
unknown committed
2

unknown's avatar
unknown committed
3 4
   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
unknown's avatar
unknown committed
5
   the Free Software Foundation; version 2 of the License.
unknown's avatar
unknown committed
6

unknown's avatar
unknown committed
7 8 9 10
   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
11

unknown's avatar
unknown committed
12 13 14 15 16 17 18 19
   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 */
unknown's avatar
unknown committed
20
class Item_subselect;
unknown's avatar
unknown committed
21
class GRANT_TABLE;
22
class st_select_lex_unit;
unknown's avatar
VIEW  
unknown committed
23
class st_select_lex;
24
class partition_info;
unknown's avatar
unknown committed
25
class COND_EQUAL;
26
class Security_context;
unknown's avatar
unknown committed
27

unknown's avatar
unknown committed
28 29 30 31 32 33 34 35 36 37 38 39 40
/*************************************************************************/

/**
 View_creation_ctx -- creation context of view objects.
*/

class View_creation_ctx : public Default_object_creation_ctx,
                          public Sql_alloc
{
public:
  static View_creation_ctx *create(THD *thd);

  static View_creation_ctx *create(THD *thd,
41
                                   TABLE_LIST *view);
unknown's avatar
unknown committed
42 43 44 45 46 47 48 49 50

private:
  View_creation_ctx(THD *thd)
    : Default_object_creation_ctx(thd)
  { }
};

/*************************************************************************/

unknown's avatar
unknown committed
51 52 53 54 55
/* 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
56
  Item	 *item_ptr;			/* Storage for initial item */
57
  Item   **item_copy;			/* For SPs; the original item ptr */
58 59
  int    counter;                       /* position in SELECT list, correct
                                           only if counter_used is true*/
unknown's avatar
unknown committed
60 61 62
  bool	 asc;				/* true if ascending */
  bool	 free_me;			/* true if item isn't shared  */
  bool	 in_field_list;			/* true if in select field list */
63
  bool   counter_used;                  /* parameter was counter of columns */
unknown's avatar
unknown committed
64 65
  Field  *field;			/* If tmp-table group */
  char	 *buff;				/* If tmp-table group */
66
  table_map used, depend_map;
unknown's avatar
unknown committed
67 68 69 70 71 72
} ORDER;

typedef struct st_grant_info
{
  GRANT_TABLE *grant_table;
  uint version;
unknown's avatar
unknown committed
73 74
  ulong privilege;
  ulong want_privilege;
75 76 77 78 79
  /*
    Stores the requested access acl of top level tables list. Is used to
    check access rights to the underlying tables of a view.
  */
  ulong orig_want_privilege;
unknown's avatar
unknown committed
80 81
} GRANT_INFO;

unknown's avatar
unknown committed
82 83
enum tmp_table_type
{
84
  NO_TMP_TABLE, NON_TRANSACTIONAL_TMP_TABLE, TRANSACTIONAL_TMP_TABLE,
unknown's avatar
unknown committed
85 86
  INTERNAL_TMP_TABLE, SYSTEM_TMP_TABLE
};
unknown's avatar
unknown committed
87

88 89 90 91 92 93 94 95 96
/** Event on which trigger is invoked. */
enum trg_event_type
{
  TRG_EVENT_INSERT= 0,
  TRG_EVENT_UPDATE= 1,
  TRG_EVENT_DELETE= 2,
  TRG_EVENT_MAX
};

97 98 99 100 101 102 103
enum frm_type_enum
{
  FRMTYPE_ERROR= 0,
  FRMTYPE_TABLE,
  FRMTYPE_VIEW
};

unknown's avatar
unknown committed
104 105
enum release_type { RELEASE_NORMAL, RELEASE_WAIT_FOR_DROP };

unknown's avatar
unknown committed
106 107
typedef struct st_filesort_info
{
108 109 110 111 112 113
  IO_CACHE *io_cache;           /* If sorted through filesort */
  uchar     **sort_keys;        /* Buffer for sorting keys */
  uchar     *buffpek;           /* Buffer for buffpek structures */
  uint      buffpek_len;        /* Max number of buffpeks in the buffer */
  uchar     *addon_buf;         /* Pointer to a buffer if sorted with fields */
  size_t    addon_length;       /* Length of the buffer */
unknown's avatar
unknown committed
114
  struct st_sort_addon_field *addon_field;     /* Pointer to the fields info */
115 116 117
  void    (*unpack)(struct st_sort_addon_field *, uchar *); /* To unpack back */
  uchar     *record_pointers;    /* If sorted in memory */
  ha_rows   found_records;      /* How many records in sort */
unknown's avatar
unknown committed
118 119
} FILESORT_INFO;

unknown's avatar
unknown committed
120

121
/*
122 123 124 125 126 127 128 129
  Values in this enum are used to indicate how a tables TIMESTAMP field
  should be treated. It can be set to the current timestamp on insert or
  update or both.
  WARNING: The values are used for bit operations. If you change the
  enum, you must keep the bitwise relation of the values. For example:
  (int) TIMESTAMP_AUTO_SET_ON_BOTH must be equal to
  (int) TIMESTAMP_AUTO_SET_ON_INSERT | (int) TIMESTAMP_AUTO_SET_ON_UPDATE.
  We use an enum here so that the debugger can display the value names.
130 131 132 133 134 135
*/
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
};
136 137
#define clear_timestamp_auto_bits(_target_, _bits_) \
  (_target_)= (enum timestamp_auto_set_type)((int)(_target_) & ~(int)(_bits_))
138

unknown's avatar
unknown committed
139 140
class Field_timestamp;
class Field_blob;
141
class Table_triggers_list;
unknown's avatar
unknown committed
142

143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
/**
  Category of table found in the table share.
*/
enum enum_table_category
{
  /**
    Unknown value.
  */
  TABLE_UNKNOWN_CATEGORY=0,

  /**
    Temporary table.
    The table is visible only in the session.
    Therefore,
    - FLUSH TABLES WITH READ LOCK
    - SET GLOBAL READ_ONLY = ON
    do not apply to this table.
unknown's avatar
unknown committed
160
    Note that LOCK TABLE t FOR READ/WRITE
161 162 163 164 165 166 167 168
    can be used on temporary tables.
    Temporary tables are not part of the table cache.
  */
  TABLE_CATEGORY_TEMPORARY=1,

  /**
    User table.
    These tables do honor:
unknown's avatar
unknown committed
169
    - LOCK TABLE t FOR READ/WRITE
170 171 172 173 174 175 176 177 178
    - FLUSH TABLES WITH READ LOCK
    - SET GLOBAL READ_ONLY = ON
    User tables are cached in the table cache.
  */
  TABLE_CATEGORY_USER=2,

  /**
    System table, maintained by the server.
    These tables do honor:
unknown's avatar
unknown committed
179
    - LOCK TABLE t FOR READ/WRITE
180 181 182 183 184 185 186 187 188 189 190 191 192
    - FLUSH TABLES WITH READ LOCK
    - SET GLOBAL READ_ONLY = ON
    Typically, writes to system tables are performed by
    the server implementation, not explicitly be a user.
    System tables are cached in the table cache.
  */
  TABLE_CATEGORY_SYSTEM=3,

  /**
    Information schema tables.
    These tables are an interface provided by the system
    to inspect the system metadata.
    These tables do *not* honor:
unknown's avatar
unknown committed
193
    - LOCK TABLE t FOR READ/WRITE
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
    - FLUSH TABLES WITH READ LOCK
    - SET GLOBAL READ_ONLY = ON
    as there is no point in locking explicitely
    an INFORMATION_SCHEMA table.
    Nothing is directly written to information schema tables.
    Note that this value is not used currently,
    since information schema tables are not shared,
    but implemented as session specific temporary tables.
  */
  /*
    TODO: Fixing the performance issues of I_S will lead
    to I_S tables in the table cache, which should use
    this table type.
  */
  TABLE_CATEGORY_INFORMATION=4,

  /**
    Performance schema tables.
    These tables are an interface provided by the system
    to inspect the system performance data.
    These tables do *not* honor:
unknown's avatar
unknown committed
215
    - LOCK TABLE t FOR READ/WRITE
216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
    - FLUSH TABLES WITH READ LOCK
    - SET GLOBAL READ_ONLY = ON
    as there is no point in locking explicitely
    a PERFORMANCE_SCHEMA table.
    An example of PERFORMANCE_SCHEMA tables are:
    - mysql.slow_log
    - mysql.general_log,
    which *are* updated even when there is either
    a GLOBAL READ LOCK or a GLOBAL READ_ONLY in effect.
    User queries do not write directly to these tables
    (there are exceptions for log tables).
    The server implementation perform writes.
    Performance tables are cached in the table cache.
  */
  TABLE_CATEGORY_PERFORMANCE=5
};
typedef enum enum_table_category TABLE_CATEGORY;

TABLE_CATEGORY get_table_category(const LEX_STRING *db,
                                  const LEX_STRING *name);

unknown's avatar
unknown committed
237 238 239 240
/*
  This structure is shared between different table objects. There is one
  instance of table share per one table in the database.
*/
241 242 243

typedef struct st_table_share
{
244
  st_table_share() {}                    /* Remove gcc warning */
245 246 247 248

  /** Category of this table. */
  TABLE_CATEGORY table_category;

unknown's avatar
unknown committed
249
  /* hash of field names (contains pointers to elements of field array) */
250 251
  HASH	name_hash;			/* hash of field names */
  MEM_ROOT mem_root;
unknown's avatar
unknown committed
252 253 254
  TYPELIB keynames;			/* Pointers to keynames */
  TYPELIB fieldnames;			/* Pointer to fieldnames */
  TYPELIB *intervals;			/* pointer to interval info */
255 256
  pthread_mutex_t mutex;                /* For locking the share  */
  pthread_cond_t cond;			/* To signal that share is ready */
unknown's avatar
unknown committed
257 258 259
  struct st_table_share *next,		/* Link to unused shares */
    **prev;
#ifdef NOT_YET
260
  struct st_table *open_tables;		/* link to open tables */
unknown's avatar
unknown committed
261 262
#endif

263 264
  /* The following is copied to each TABLE on OPEN */
  Field **field;
unknown's avatar
unknown committed
265 266
  Field **found_next_number_field;
  Field *timestamp_field;               /* Used only during open */
267 268
  KEY  *key_info;			/* data of keys in database */
  uint	*blob_field;			/* Index to blobs in Field arrray*/
unknown's avatar
unknown committed
269

270
  uchar	*default_values;		/* row with default values */
271
  LEX_STRING comment;			/* Comment about table */
272 273
  CHARSET_INFO *table_charset;		/* Default charset of string fields */

274
  MY_BITMAP all_set;
275 276 277 278 279 280 281 282 283 284
  /*
    Key which is used for looking-up table in table cache and in the list
    of thread's temporary tables. Has the form of:
      "database_name\0table_name\0" + optional part for temporary tables.

    Note that all three 'table_cache_key', 'db' and 'table_name' members
    must be set (and be non-zero) for tables in table cache. They also
    should correspond to each other.
    To ensure this one can use set_table_cache() methods.
  */
unknown's avatar
unknown committed
285 286 287 288 289
  LEX_STRING table_cache_key;
  LEX_STRING db;                        /* Pointer to db */
  LEX_STRING table_name;                /* Table name (for open) */
  LEX_STRING path;                	/* Path to .frm file (from datadir) */
  LEX_STRING normalized_path;		/* unpack_filename(path) */
290
  LEX_STRING connect_string;
291 292 293 294 295 296

  /* 
     Set of keys in use, implemented as a Bitmap.
     Excludes keys disabled by ALTER TABLE ... DISABLE KEYS.
  */
  key_map keys_in_use;
297
  key_map keys_for_keyread;
unknown's avatar
unknown committed
298
  ha_rows min_rows, max_rows;		/* create information */
299 300
  ulong   avg_row_length;		/* create information */
  ulong   raid_chunksize;
301
  ulong   version, mysql_version;
302 303 304
  ulong   timestamp_offset;		/* Set to offset+1 of record */
  ulong   reclength;			/* Recordlength */

unknown's avatar
unknown committed
305 306 307 308 309 310
  plugin_ref db_plugin;			/* storage engine plugin */
  inline handlerton *db_type() const	/* table_type for handler */
  { 
    // DBUG_ASSERT(db_plugin);
    return db_plugin ? plugin_data(db_plugin, handlerton*) : NULL;
  }
unknown's avatar
unknown committed
311
  enum row_type row_type;		/* How rows are stored */
312
  enum tmp_table_type tmp_table;
313
  enum ha_choice transactional;
314
  enum ha_choice page_checksum;
315

unknown's avatar
unknown committed
316 317
  uint ref_count;                       /* How many TABLE objects uses this */
  uint open_count;			/* Number of tables in open list */
318
  uint blob_ptr_size;			/* 4 or 8 */
319
  uint key_block_size;			/* create key_block_size, if used */
unknown's avatar
unknown committed
320
  uint null_bytes, last_null_bit_pos;
321 322 323 324 325 326 327
  uint fields;				/* Number of fields */
  uint rec_buff_length;                 /* Size of table->record[] buffer */
  uint keys, key_parts;
  uint max_key_length, max_unique_length, total_key_length;
  uint uniques;                         /* Number of UNIQUE index */
  uint null_fields;			/* number of null fields */
  uint blob_fields;			/* number of blob fields */
unknown's avatar
unknown committed
328
  uint timestamp_field_offset;		/* Field number for timestamp field */
329
  uint varchar_fields;                  /* number of varchar fields */
unknown's avatar
unknown committed
330 331 332
  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 */
333
  uint raid_type, raid_chunks;
unknown's avatar
unknown committed
334
  uint rowid_field_offset;		/* Field_nr +1 to rowid field */
335 336
  /* Index of auto-updated TIMESTAMP field in field array */
  uint primary_key;
unknown's avatar
unknown committed
337 338 339
  uint next_number_index;               /* autoincrement key number */
  uint next_number_key_offset;          /* autoinc keypart offset in a key */
  uint next_number_keypart;             /* autoinc keypart number in a key */
unknown's avatar
unknown committed
340
  uint error, open_errno, errarg;       /* error from open_table_def() */
341
  uint column_bitmap_size;
unknown's avatar
unknown committed
342 343 344 345 346 347 348 349 350
  uchar frm_version;
  bool null_field_first;
  bool system;                          /* Set if system table (one record) */
  bool crypted;                         /* If .frm file is crypted */
  bool db_low_byte_first;		/* Portable row format */
  bool crashed;
  bool is_view;
  bool name_lock, replace_with_name_lock;
  bool waiting_on_cond;                 /* Protection against free */
351 352
  ulong table_map_id;                   /* for row-based replication */
  ulonglong table_map_version;
353 354 355 356 357 358 359 360 361

  /*
    Cache for row-based replication table share checks that does not
    need to be repeated. Possible values are: -1 when cache value is
    not calculated yet, 0 when table *shall not* be replicated, 1 when
    table *may* be replicated.
  */
  int cached_row_logging_check;

unknown's avatar
unknown committed
362
#ifdef WITH_PARTITION_STORAGE_ENGINE
363
  bool auto_partitioned;
364
  const char *partition_info;
unknown's avatar
unknown committed
365
  uint  partition_info_len;
366
  uint  partition_info_buffer_size;
367
  const char *part_state;
unknown's avatar
unknown committed
368
  uint part_state_len;
unknown's avatar
unknown committed
369
  handlerton *default_part_db_type;
unknown's avatar
unknown committed
370
#endif
371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424


  /*
    Set share's table cache key and update its db and table name appropriately.

    SYNOPSIS
      set_table_cache_key()
        key_buff    Buffer with already built table cache key to be
                    referenced from share.
        key_length  Key length.

    NOTES
      Since 'key_buff' buffer will be referenced from share it should has same
      life-time as share itself.
      This method automatically ensures that TABLE_SHARE::table_name/db have
      appropriate values by using table cache key as their source.
  */

  void set_table_cache_key(char *key_buff, uint key_length)
  {
    table_cache_key.str= key_buff;
    table_cache_key.length= key_length;
    /*
      Let us use the fact that the key is "db/0/table_name/0" + optional
      part for temporary tables.
    */
    db.str=            table_cache_key.str;
    db.length=         strlen(db.str);
    table_name.str=    db.str + db.length + 1;
    table_name.length= strlen(table_name.str);
  }


  /*
    Set share's table cache key and update its db and table name appropriately.

    SYNOPSIS
      set_table_cache_key()
        key_buff    Buffer to be used as storage for table cache key
                    (should be at least key_length bytes).
        key         Value for table cache key.
        key_length  Key length.

    NOTE
      Since 'key_buff' buffer will be used as storage for table cache key
      it should has same life-time as share itself.
  */

  void set_table_cache_key(char *key_buff, const char *key, uint key_length)
  {
    memcpy(key_buff, key, key_length);
    set_table_cache_key(key_buff, key_length);
  }

425 426 427 428 429 430 431 432 433 434
  inline bool honor_global_locks()
  {
    return ((table_category == TABLE_CATEGORY_USER)
            || (table_category == TABLE_CATEGORY_SYSTEM));
  }

  inline bool require_write_privileges()
  {
    return (table_category == TABLE_CATEGORY_PERFORMANCE);
  }
435 436 437 438 439 440

  inline ulong get_table_def_version()
  {
    return table_map_id;
  }

unknown's avatar
unknown committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480
  /**
    Convert unrelated members of TABLE_SHARE to one enum
    representing its metadata type.

    @todo perhaps we need to have a member instead of a function.
  */
  enum enum_metadata_type get_metadata_type() const
  {
    if (is_view)
      return METADATA_VIEW;
    switch (tmp_table) {
    case NO_TMP_TABLE:
      return METADATA_BASE_TABLE;
    case SYSTEM_TMP_TABLE:
      return METADATA_I_S_TABLE;
    default:
      return METADATA_TMP_TABLE;
    }
  }
  /**
    Return a table metadata version.
     * for base tables, we return table_map_id.
       It is assigned from a global counter incremented for each
       new table loaded into the table definition cache (TDC).
     * for temporary tables it's table_map_id again. But for
       temporary tables table_map_id is assigned from
       thd->query_id. The latter is assigned from a thread local
       counter incremented for every new SQL statement. Since
       temporary tables are thread-local, each temporary table
       gets a unique id.
     * for everything else (views, information schema tables),
       the version id is zero.

   This choice of version id is a large compromise
   to have a working prepared statement validation in 5.1. In
   future version ids will be persistent, as described in WL#4180.

   Let's try to explain why and how this limited solution allows
   to validate prepared statements.

481
   Firstly, sets (in mathematical sense) of version numbers
unknown's avatar
unknown committed
482 483
   never intersect for different metadata types. Therefore,
   version id of a temporary table is never compared with
484
   a version id of a view, and vice versa.
unknown's avatar
unknown committed
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532

   Secondly, for base tables, we know that each DDL flushes the
   respective share from the TDC. This ensures that whenever
   a table is altered or dropped and recreated, it gets a new
   version id.
   Unfortunately, since elements of the TDC are also flushed on
   LRU basis, this choice of version ids leads to false positives.
   E.g. when the TDC size is too small, we may have a SELECT
   * FROM INFORMATION_SCHEMA.TABLES flush all its elements, which
   in turn will lead to a validation error and a subsequent
   reprepare of all prepared statements.  This is
   considered acceptable, since as long as prepared statements are
   automatically reprepared, spurious invalidation is only
   a performance hit. Besides, no better simple solution exists.

   For temporary tables, using thd->query_id ensures that if
   a temporary table was altered or recreated, a new version id is
   assigned. This suits validation needs very well and will perhaps
   never change.

   Metadata of information schema tables never changes.
   Thus we can safely assume 0 for a good enough version id.

   Views are a special and tricky case. A view is always inlined
   into the parse tree of a prepared statement at prepare.
   Thus, when we execute a prepared statement, the parse tree
   will not get modified even if the view is replaced with another
   view.  Therefore, we can safely choose 0 for version id of
   views and effectively never invalidate a prepared statement
   when a view definition is altered. Note, that this leads to
   wrong binary log in statement-based replication, since we log
   prepared statement execution in form Query_log_events
   containing conventional statements. But since there is no
   metadata locking for views, the very same problem exists for
   conventional statements alone, as reported in Bug#25144. The only
   difference between prepared and conventional execution is,
   effectively, that for prepared statements the race condition
   window is much wider.
   In 6.0 we plan to support view metadata locking (WL#3726) and
   extend table definition cache to cache views (WL#4298).
   When this is done, views will be handled in the same fashion
   as the base tables.

   Finally, by taking into account metadata type, we always
   track that a change has taken place when a view is replaced
   with a base table, a base table is replaced with a temporary
   table and so on.

533
   @sa TABLE_LIST::is_metadata_id_equal()
unknown's avatar
unknown committed
534 535 536
  */
  ulong get_metadata_version() const
  {
537
    return (tmp_table == SYSTEM_TMP_TABLE || is_view) ? 0 : table_map_id;
unknown's avatar
unknown committed
538 539
  }

540 541 542
} TABLE_SHARE;


unknown's avatar
unknown committed
543 544
extern ulong refresh_version;

545
/* Information for one open table */
546 547 548 549 550 551
enum index_hint_type
{
  INDEX_HINT_IGNORE,
  INDEX_HINT_USE,
  INDEX_HINT_FORCE
};
552 553

struct st_table {
554 555
  st_table() {}                               /* Remove gcc warning */

556 557 558 559
  TABLE_SHARE	*s;
  handler	*file;
#ifdef NOT_YET
  struct st_table *used_next, **used_prev;	/* Link to used tables */
unknown's avatar
unknown committed
560
  struct st_table *open_next, **open_prev;	/* Link to open tables */
unknown's avatar
unknown committed
561
#endif
562 563
  struct st_table *next, *prev;

564 565 566 567 568
  /* For the below MERGE related members see top comment in ha_myisammrg.cc */
  struct st_table *parent;          /* Set in MERGE child.  Ptr to parent */
  TABLE_LIST      *child_l;         /* Set in MERGE parent. List of children */
  TABLE_LIST      **child_last_l;   /* Set in MERGE parent. End of list */

569 570 571
  THD	*in_use;                        /* Which thread uses this */
  Field **field;			/* Pointer to fields */

572 573
  uchar *record[2];			/* Pointer to records */
  uchar *write_row_record;		/* Used as optimisation in
574
					   THD::write_row */
575
  uchar *insert_values;                  /* used by INSERT ... UPDATE */
576 577 578 579 580 581
  /* 
    Map of keys that can be used to retrieve all data from this table 
    needed by the query without reading the row.
  */
  key_map covering_keys;
  key_map quick_keys, merge_keys;
582 583
  /*
    A set of keys that can be used in the query that references this
584
    table.
585 586 587 588 589 590 591 592 593

    All indexes disabled on the table's TABLE_SHARE (see TABLE::s) will be 
    subtracted from this set upon instantiation. Thus for any TABLE t it holds
    that t.keys_in_use_for_query is a subset of t.s.keys_in_use. Generally we 
    must not introduce any new keys here (see setup_tables).

    The set is implemented as a bitmap.
  */
  key_map keys_in_use_for_query;
594 595 596 597
  /* Map of keys that can be used to calculate GROUP BY without sorting */
  key_map keys_in_use_for_group_by;
  /* Map of keys that can be used to calculate ORDER BY without sorting */
  key_map keys_in_use_for_order_by;
598 599
  KEY  *key_info;			/* data of keys in database */

unknown's avatar
unknown committed
600 601
  Field *next_number_field;		/* Set if next_number is activated */
  Field *found_next_number_field;	/* Set on open */
602 603 604 605
  Field_timestamp *timestamp_field;

  /* Table's triggers, 0 if there are no of them */
  Table_triggers_list *triggers;
606
  TABLE_LIST *pos_in_table_list;/* Element referring to this table */
607 608 609
  ORDER		*group;
  const char	*alias;            	  /* alias or table name */
  uchar		*null_flags;
610 611 612
  my_bitmap_map	*bitmap_init_value;
  MY_BITMAP     def_read_set, def_write_set, tmp_set; /* containers */
  MY_BITMAP     *read_set, *write_set;          /* Active column sets */
613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
  /*
   The ID of the query that opened and is using this table. Has different
   meanings depending on the table type.

   Temporary tables:

   table->query_id is set to thd->query_id for the duration of a statement
   and is reset to 0 once it is closed by the same statement. A non-zero
   table->query_id means that a statement is using the table even if it's
   not the current statement (table is in use by some outer statement).

   Non-temporary tables:

   Under pre-locked or LOCK TABLES mode: query_id is set to thd->query_id
   for the duration of a statement and is reset to 0 once it is closed by
   the same statement. A non-zero query_id is used to control which tables
   in the list of pre-opened and locked tables are actually being used.
  */
631
  query_id_t	query_id;
632

633 634 635 636
  /* 
    For each key that has quick_keys.is_set(key) == TRUE: estimate of #records
    and max #key parts that range access would use.
  */
637
  ha_rows	quick_rows[MAX_KEY];
638 639

  /* Bitmaps of key parts that =const for the entire join. */
640
  key_part_map  const_key_parts[MAX_KEY];
641

642
  uint		quick_key_parts[MAX_KEY];
643
  uint		quick_n_ranges[MAX_KEY];
unknown's avatar
unknown committed
644

645 646 647 648 649 650 651 652 653 654
  /* 
    Estimate of number of records that satisfy SARGable part of the table
    condition, or table->file->records if no SARGable condition could be
    constructed.
    This value is used by join optimizer as an estimate of number of records
    that will pass the table condition (condition that depends on fields of 
    this table and constants)
  */
  ha_rows       quick_condition_rows;

655 656 657 658 659 660 661 662 663 664 665
  /*
    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
666
  */
667
  timestamp_auto_set_type timestamp_field_type;
668
  table_map	map;                    /* ID bit of table (1,2,4,8,16...) */
669 670 671 672

  uint          lock_position;          /* Position in MYSQL_LOCK.table */
  uint          lock_data_start;        /* Start pos. in MYSQL_LOCK.locks */
  uint          lock_count;             /* Number of locks */
673 674 675 676 677 678 679
  uint		tablenr,used_fields;
  uint          temp_pool_slot;		/* Used by intern temp tables */
  uint		status;                 /* What's in record[0] */
  uint		db_stat;		/* mode of file as in handler.h */
  /* number of select if it is derived table */
  uint          derived_select_number;
  int		current_lock;           /* Type of lock on table */
unknown's avatar
unknown committed
680
  my_bool copy_blobs;			/* copy_blobs when storing */
681 682

  /*
683 684 685 686 687
    0 or JOIN_TYPE_{LEFT|RIGHT}. Currently this is only compared to 0.
    If maybe_null !=0, this table is inner w.r.t. some outer join operation,
    and null_row may be true.
  */
  uint maybe_null;
unknown's avatar
unknown committed
688
  /*
689 690
    If true, the current table row is considered to have all columns set to 
    NULL, including columns declared as "not null" (see maybe_null).
691 692
  */
  my_bool null_row;
693

694 695
  /*
    TODO: Each of the following flags take up 8 bits. They can just as easily
696 697
    be put into one single unsigned long and instead of taking up 18
    bytes, it would take up 4.
unknown's avatar
unknown committed
698
  */
699
  my_bool force_index;
700
  my_bool distinct,const_table,no_rows;
701
  my_bool key_read, no_keyread;
unknown's avatar
unknown committed
702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
  /*
    Placeholder for an open table which prevents other connections
    from taking name-locks on this table. Typically used with
    TABLE_SHARE::version member to take an exclusive name-lock on
    this table name -- a name lock that not only prevents other
    threads from opening the table, but also blocks other name
    locks. This is achieved by:
    - setting open_placeholder to 1 - this will block other name
      locks, as wait_for_locked_table_name will be forced to wait,
      see table_is_used for details.
    - setting version to 0 - this will force other threads to close
      the instance of this table and wait (this is the same approach
      as used for usual name locks).
    An exclusively name-locked table currently can have no handler
    object associated with it (db_stat is always 0), but please do
    not rely on that.
  */
  my_bool open_placeholder;
720
  my_bool locked_by_logger;
721
  my_bool no_replicate;
unknown's avatar
unknown committed
722
  my_bool locked_by_name;
unknown's avatar
unknown committed
723
  my_bool fulltext_searched;
724
  my_bool no_cache;
725 726
  /* To signal that the table is associated with a HANDLER statement */
  my_bool open_by_handler;
727 728 729 730 731
  /*
    To indicate that a non-null value of the auto_increment field
    was provided by the user or retrieved from the current record.
    Used only in the MODE_NO_AUTO_VALUE_ON_ZERO mode.
  */
unknown's avatar
unknown committed
732
  my_bool auto_increment_field_not_null;
733
  my_bool insert_or_update;             /* Can be used by the handler */
unknown's avatar
unknown committed
734
  my_bool alias_name_used;		/* true if table_name is alias */
735
  my_bool get_fields_in_item_tree;      /* Signal to fix_field */
736 737
  /* If MERGE children attached to parent. See top comment in ha_myisammrg.cc */
  my_bool children_attached;
738

unknown's avatar
unknown committed
739 740 741
  REGINFO reginfo;			/* field connections */
  MEM_ROOT mem_root;
  GRANT_INFO grant;
unknown's avatar
unknown committed
742
  FILESORT_INFO sort;
unknown's avatar
unknown committed
743 744
#ifdef WITH_PARTITION_STORAGE_ENGINE
  partition_info *part_info;            /* Partition related information */
745
  bool no_partitions_used; /* If true, all partitions have been pruned away */
unknown's avatar
unknown committed
746
#endif
747 748 749

  bool fill_item_list(List<Item> *item_list) const;
  void reset_item_list(List<Item> *item_list) const;
750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781
  void clear_column_bitmaps(void);
  void prepare_for_position(void);
  void mark_columns_used_by_index_no_reset(uint index, MY_BITMAP *map);
  void mark_columns_used_by_index(uint index);
  void restore_column_maps_after_mark_index();
  void mark_auto_increment_column(void);
  void mark_columns_needed_for_update(void);
  void mark_columns_needed_for_delete(void);
  void mark_columns_needed_for_insert(void);
  inline void column_bitmaps_set(MY_BITMAP *read_set_arg,
                                 MY_BITMAP *write_set_arg)
  {
    read_set= read_set_arg;
    write_set= write_set_arg;
    if (file)
      file->column_bitmaps_signal();
  }
  inline void column_bitmaps_set_no_signal(MY_BITMAP *read_set_arg,
                                           MY_BITMAP *write_set_arg)
  {
    read_set= read_set_arg;
    write_set= write_set_arg;
  }
  inline void use_all_columns()
  {
    column_bitmaps_set(&s->all_set, &s->all_set);
  }
  inline void default_column_bitmaps()
  {
    read_set= &def_read_set;
    write_set= &def_write_set;
  }
unknown's avatar
unknown committed
782 783 784 785 786 787 788
  /* Is table open or should be treated as such by name-locking? */
  inline bool is_name_opened() { return db_stat || open_placeholder; }
  /*
    Is this instance of the table should be reopen or represents a name-lock?
  */
  inline bool needs_reopen_or_name_lock()
  { return s->version != refresh_version; }
789
  bool is_children_attached(void);
unknown's avatar
unknown committed
790 791
};

792 793 794 795 796 797
enum enum_schema_table_state
{ 
  NOT_PROCESSED= 0,
  PROCESSED_BY_CREATE_SORT_INDEX,
  PROCESSED_BY_JOIN_EXEC
};
unknown's avatar
unknown committed
798

799 800 801 802 803
typedef struct st_foreign_key_info
{
  LEX_STRING *forein_id;
  LEX_STRING *referenced_db;
  LEX_STRING *referenced_table;
804 805
  LEX_STRING *update_method;
  LEX_STRING *delete_method;
806
  LEX_STRING *referenced_key_name;
807 808 809 810
  List<LEX_STRING> foreign_fields;
  List<LEX_STRING> referenced_fields;
} FOREIGN_KEY_INFO;

unknown's avatar
unknown committed
811 812 813
/*
  Make sure that the order of schema_tables and enum_schema_tables are the same.
*/
814 815 816

enum enum_schema_tables
{
817 818 819 820 821
  SCH_CHARSETS= 0,
  SCH_COLLATIONS,
  SCH_COLLATION_CHARACTER_SET_APPLICABILITY,
  SCH_COLUMNS,
  SCH_COLUMN_PRIVILEGES,
unknown's avatar
unknown committed
822
  SCH_ENGINES,
823
  SCH_EVENTS,
unknown's avatar
unknown committed
824
  SCH_FILES,
825 826
  SCH_GLOBAL_STATUS,
  SCH_GLOBAL_VARIABLES,
827 828
  SCH_KEY_COLUMN_USAGE,
  SCH_OPEN_TABLES,
829
  SCH_PARTITIONS,
unknown's avatar
unknown committed
830
  SCH_PLUGINS,
831
  SCH_PROCESSLIST,
832
  SCH_PROFILES,
833
  SCH_REFERENTIAL_CONSTRAINTS,
834 835 836
  SCH_PROCEDURES,
  SCH_SCHEMATA,
  SCH_SCHEMA_PRIVILEGES,
837 838
  SCH_SESSION_STATUS,
  SCH_SESSION_VARIABLES,
839 840 841 842 843 844 845
  SCH_STATISTICS,
  SCH_STATUS,
  SCH_TABLES,
  SCH_TABLE_CONSTRAINTS,
  SCH_TABLE_NAMES,
  SCH_TABLE_PRIVILEGES,
  SCH_TRIGGERS,
846
  SCH_USER_PRIVILEGES,
847
  SCH_VARIABLES,
848
  SCH_VIEWS
849 850 851
};


852 853 854 855
#define MY_I_S_MAYBE_NULL 1
#define MY_I_S_UNSIGNED   2


856 857 858 859
#define SKIP_OPEN_TABLE 0                // do not open table
#define OPEN_FRM_ONLY   1                // open FRM file only
#define OPEN_FULL_TABLE 2                // open FRM,MYD, MYI files

860 861
typedef struct st_field_info
{
862 863 864
  /** 
      This is used as column name. 
  */
865
  const char* field_name;
866 867 868 869
  /**
     For string-type columns, this is the maximum number of
     characters. Otherwise, it is the 'display-length' for the column.
  */
870
  uint field_length;
871 872 873 874 875
  /**
     This denotes data type for the column. For the most part, there seems to
     be one entry in the enum for each SQL data type, although there seem to
     be a number of additional entries in the enum.
  */
876 877
  enum enum_field_types field_type;
  int value;
878 879 880 881 882 883 884 885
  /**
     This is used to set column attributes. By default, columns are @c NOT
     @c NULL and @c SIGNED, and you can deviate from the default
     by setting the appopriate flags. You can use either one of the flags
     @c MY_I_S_MAYBE_NULL and @cMY_I_S_UNSIGNED or
     combine them using the bitwise or operator @c |. Both flags are
     defined in table.h.
   */
886
  uint field_flags;        // Field atributes(maybe_null, signed, unsigned etc.)
887
  const char* old_name;
888 889 890 891
  /**
     This should be one of @c SKIP_OPEN_TABLE,
     @c OPEN_FRM_ONLY or @c OPEN_FULL_TABLE.
  */
892
  uint open_method;
893 894
} ST_FIELD_INFO;

895

896
struct TABLE_LIST;
897 898 899 900 901 902 903
typedef class Item COND;

typedef struct st_schema_table
{
  const char* table_name;
  ST_FIELD_INFO *fields_info;
  /* Create information_schema table */
904
  TABLE *(*create_table)  (THD *thd, TABLE_LIST *table_list);
905
  /* Fill table with data */
906
  int (*fill_table) (THD *thd, TABLE_LIST *tables, COND *cond);
907 908
  /* Handle fileds for old SHOW */
  int (*old_format) (THD *thd, struct st_schema_table *schema_table);
909 910
  int (*process_table) (THD *thd, TABLE_LIST *tables, TABLE *table,
                        bool res, LEX_STRING *db_name, LEX_STRING *table_name);
911
  int idx_field1, idx_field2; 
912
  bool hidden;
913
  uint i_s_requested_object;  /* the object we need to open(TABLE | VIEW) */
914 915 916
} ST_SCHEMA_TABLE;


917 918 919
#define JOIN_TYPE_LEFT	1
#define JOIN_TYPE_RIGHT	2

920 921 922
#define VIEW_ALGORITHM_UNDEFINED        0
#define VIEW_ALGORITHM_TMPTABLE         1
#define VIEW_ALGORITHM_MERGE            2
unknown's avatar
VIEW  
unknown committed
923

924 925 926 927
#define VIEW_SUID_INVOKER               0
#define VIEW_SUID_DEFINER               1
#define VIEW_SUID_DEFAULT               2

unknown's avatar
unknown committed
928
/* view WITH CHECK OPTION parameter options */
unknown's avatar
unknown committed
929 930 931 932
#define VIEW_CHECK_NONE       0
#define VIEW_CHECK_LOCAL      1
#define VIEW_CHECK_CASCADED   2

unknown's avatar
unknown committed
933 934 935 936 937
/* 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
938
struct st_lex;
939
class select_union;
940
class TMP_TABLE_PARAM;
941

942
Item *create_view_field(THD *thd, TABLE_LIST *view, Item **field_ref,
943 944
                        const char *name);

945 946 947 948 949
struct Field_translator
{
  Item *item;
  const char *name;
};
unknown's avatar
VIEW  
unknown committed
950

951

unknown's avatar
unknown committed
952 953 954 955 956 957
/*
  Column reference of a NATURAL/USING join. Since column references in
  joins can be both from views and stored tables, may point to either a
  Field (for tables), or a Field_translator (for views).
*/

958
class Natural_join_column: public Sql_alloc
unknown's avatar
unknown committed
959 960 961 962
{
public:
  Field_translator *view_field;  /* Column reference of merge view. */
  Field            *table_field; /* Column reference of table or temp view. */
963
  TABLE_LIST *table_ref; /* Original base table/view reference. */
unknown's avatar
unknown committed
964 965 966 967 968 969 970 971 972
  /*
    True if a common join column of two NATURAL/USING join operands. Notice
    that when we have a hierarchy of nested NATURAL/USING joins, a column can
    be common at some level of nesting but it may not be common at higher
    levels of nesting. Thus this flag may change depending on at which level
    we are looking at some column.
  */
  bool is_common;
public:
973 974
  Natural_join_column(Field_translator *field_param, TABLE_LIST *tab);
  Natural_join_column(Field *field_param, TABLE_LIST *tab);
unknown's avatar
unknown committed
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
  const char *name();
  Item *create_item(THD *thd);
  Field *field();
  const char *table_name();
  const char *db_name();
  GRANT_INFO *grant();
};


/*
  Table reference in the FROM clause.

  These table references can be of several types that correspond to
  different SQL elements. Below we list all types of TABLE_LISTs with
  the necessary conditions to determine when a TABLE_LIST instance
  belongs to a certain type.

  1) table (TABLE_LIST::view == NULL)
     - base table
       (TABLE_LIST::derived == NULL)
     - subquery - TABLE_LIST::table is a temp table
       (TABLE_LIST::derived != NULL)
     - information schema table
       (TABLE_LIST::schema_table != NULL)
       NOTICE: for schema tables TABLE_LIST::field_translation may be != NULL
  2) view (TABLE_LIST::view != NULL)
     - merge    (TABLE_LIST::effective_algorithm == VIEW_ALGORITHM_MERGE)
           also (TABLE_LIST::field_translation != NULL)
     - tmptable (TABLE_LIST::effective_algorithm == VIEW_ALGORITHM_TMPTABLE)
           also (TABLE_LIST::field_translation == NULL)
  3) nested table reference (TABLE_LIST::nested_join != NULL)
     - table sequence - e.g. (t1, t2, t3)
       TODO: how to distinguish from a JOIN?
     - general JOIN
       TODO: how to distinguish from a table sequence?
     - NATURAL JOIN
       (TABLE_LIST::natural_join != NULL)
       - JOIN ... USING
         (TABLE_LIST::join_using_fields != NULL)
*/

unknown's avatar
unknown committed
1016
class Index_hint;
1017
struct TABLE_LIST
1018
{
1019
  TABLE_LIST() {}                          /* Remove gcc warning */
1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034

  /**
    Prepare TABLE_LIST that consists of one table instance to use in
    simple_open_and_lock_tables
  */
  inline void init_one_table(const char *db_name_arg,
                             const char *table_name_arg,
                             enum thr_lock_type lock_type_arg)
  {
    bzero((char*) this, sizeof(*this));
    db= (char*) db_name_arg;
    table_name= alias= (char*) table_name_arg;
    lock_type= lock_type_arg;
  }

unknown's avatar
unknown committed
1035 1036 1037 1038 1039
  /*
    List of tables local to a subquery (used by SQL_LIST). Considers
    views as leaves (unlike 'next_leaf' below). Created at parse time
    in st_select_lex::add_table_to_list() -> table_list.link_in_list().
  */
1040
  TABLE_LIST *next_local;
unknown's avatar
VIEW  
unknown committed
1041
  /* link in a global list of all queries tables */
1042
  TABLE_LIST *next_global, **prev_global;
1043
  char		*db, *alias, *table_name, *schema_table_name;
1044
  char          *option;                /* Used by cache index  */
1045
  Item		*on_expr;		/* Used with outer join */
1046
  /*
unknown's avatar
unknown committed
1047
    The structure of ON expression presented in the member above
1048 1049 1050 1051 1052 1053 1054
    can be changed during certain optimizations. This member
    contains a snapshot of AND-OR structure of the ON expression
    made after permanent transformations of the parse tree, and is
    used to restore ON clause before every reexecution of a prepared
    statement or stored procedure.
  */
  Item          *prep_on_expr;
unknown's avatar
unknown committed
1055
  COND_EQUAL    *cond_equal;            /* Used with outer join */
unknown's avatar
unknown committed
1056 1057 1058 1059 1060 1061
  /*
    During parsing - left operand of NATURAL/USING join where 'this' is
    the right operand. After parsing (this->natural_join == this) iff
    'this' represents a NATURAL or USING join operation. Thus after
    parsing 'this' is a NATURAL/USING join iff (natural_join != NULL).
  */
1062
  TABLE_LIST *natural_join;
unknown's avatar
unknown committed
1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085
  /*
    True if 'this' represents a nested join that is a NATURAL JOIN.
    For one of the operands of 'this', the member 'natural_join' points
    to the other operand of 'this'.
  */
  bool is_natural_join;
  /* Field names in a USING clause for JOIN ... USING. */
  List<String> *join_using_fields;
  /*
    Explicitly store the result columns of either a NATURAL/USING join or
    an operand of such a join.
  */
  List<Natural_join_column> *join_columns;
  /* TRUE if join_columns contains all columns of this table reference. */
  bool is_join_columns_complete;

  /*
    List of nodes in a nested join tree, that should be considered as
    leaves with respect to name resolution. The leaves are: views,
    top-most nodes representing NATURAL/USING joins, subqueries, and
    base tables. All of these TABLE_LIST instances contain a
    materialized list of columns. The list is local to a subquery.
  */
1086
  TABLE_LIST *next_name_resolution_table;
unknown's avatar
unknown committed
1087
  /* Index names in a "... JOIN ... USE/IGNORE INDEX ..." clause. */
unknown's avatar
unknown committed
1088
  List<Index_hint> *index_hints;
1089 1090
  TABLE        *table;                          /* opened table */
  uint          table_id; /* table id (from binlog) for opened table */
unknown's avatar
unknown committed
1091 1092 1093 1094 1095
  /*
    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
1096 1097 1098 1099 1100 1101 1102
  /*
    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)
  */
1103
  TABLE_LIST	*correspondent_table;
unknown's avatar
VIEW  
unknown committed
1104
  st_select_lex_unit *derived;		/* SELECT_LEX_UNIT of derived table */
1105 1106
  ST_SCHEMA_TABLE *schema_table;        /* Information_schema table */
  st_select_lex	*schema_select_lex;
unknown's avatar
unknown committed
1107 1108 1109 1110
  /*
    True when the view field translation table is used to convert
    schema table fields for backwards compatibility with SHOW command.
  */
1111
  bool schema_table_reformed;
1112
  TMP_TABLE_PARAM *schema_table_param;
unknown's avatar
VIEW  
unknown committed
1113 1114 1115
  /* link to select_lex where this table was used */
  st_select_lex	*select_lex;
  st_lex	*view;			/* link on VIEW lex for merging */
1116
  Field_translator *field_translation;	/* array of VIEW fields */
1117 1118
  /* pointer to element after last one in translation table above */
  Field_translator *field_translation_end;
1119 1120 1121 1122 1123
  /*
    List (based on next_local) of underlying tables of this view. I.e. it
    does not include the tables of subqueries used in the view. Is set only
    for merged views.
  */
1124
  TABLE_LIST	*merge_underlying_list;
1125 1126 1127 1128 1129
  /*
    - 0 for base tables
    - in case of the view it is the list of all (not only underlying
    tables but also used in subquery ones) tables of the view.
  */
1130
  List<TABLE_LIST> *view_tables;
1131
  /* most upper view this table belongs to */
1132
  TABLE_LIST	*belong_to_view;
1133 1134 1135 1136
  /*
    The view directly referencing this table
    (non-zero only for merged underlying tables of a view).
  */
1137
  TABLE_LIST	*referencing_view;
1138 1139
  /* Ptr to parent MERGE table list item. See top comment in ha_myisammrg.cc */
  TABLE_LIST    *parent_l;
1140
  /*
unknown's avatar
unknown committed
1141 1142
    Security  context (non-zero only for tables which belong
    to view with SQL SECURITY DEFINER)
1143 1144 1145
  */
  Security_context *security_ctx;
  /*
unknown's avatar
unknown committed
1146 1147
    This view security context (non-zero only for views with
    SQL SECURITY DEFINER)
1148 1149
  */
  Security_context *view_sctx;
unknown's avatar
unknown committed
1150 1151 1152 1153 1154
  /*
    List of all base tables local to a subquery including all view
    tables. Unlike 'next_local', this in this list views are *not*
    leaves. Created in setup_tables() -> make_leaves_list().
  */
1155
  bool allowed_show;
1156
  TABLE_LIST	*next_leaf;
unknown's avatar
VIEW  
unknown committed
1157
  Item          *where;                 /* VIEW WHERE clause condition */
unknown's avatar
unknown committed
1158
  Item          *check_option;          /* WITH CHECK OPTION condition */
unknown's avatar
unknown committed
1159
  LEX_STRING	select_stmt;		/* text of (CREATE/SELECT) statement */
1160
  LEX_STRING	md5;			/* md5 of query text */
unknown's avatar
VIEW  
unknown committed
1161
  LEX_STRING	source;			/* source of CREATE VIEW */
1162 1163
  LEX_STRING	view_db;		/* saved view database */
  LEX_STRING	view_name;		/* saved view name */
unknown's avatar
VIEW  
unknown committed
1164
  LEX_STRING	timestamp;		/* GMT time stamp of last operation */
1165
  st_lex_user   definer;                /* definer of view */
unknown's avatar
VIEW  
unknown committed
1166
  ulonglong	file_version;		/* version of file's field set */
unknown's avatar
unknown committed
1167
  ulonglong     updatable_view;         /* VIEW can be updated */
unknown's avatar
VIEW  
unknown committed
1168 1169
  ulonglong	revision;		/* revision control number */
  ulonglong	algorithm;		/* 0 any, 1 tmp tables , 2 merging */
1170
  ulonglong     view_suid;              /* view is suid (TRUE dy default) */
unknown's avatar
unknown committed
1171
  ulonglong     with_check;             /* WITH CHECK OPTION */
1172 1173 1174 1175 1176
  /*
    effective value of WITH CHECK OPTION (differ for temporary table
    algorithm)
  */
  uint8         effective_with_check;
1177
  uint8         effective_algorithm;    /* which algorithm was really used */
unknown's avatar
VIEW  
unknown committed
1178
  GRANT_INFO	grant;
unknown's avatar
unknown committed
1179 1180 1181 1182
  /* data need by some engines in query cache*/
  ulonglong     engine_data;
  /* call back function for asking handler about caching in query cache */
  qc_engine_callback callback_func;
1183
  thr_lock_type lock_type;
1184
  uint		outer_join;		/* Which join type */
unknown's avatar
unknown committed
1185
  uint		shared;			/* Used in multi-upd */
1186 1187
  size_t        db_length;
  size_t        table_name_length;
1188
  bool          updatable;		/* VIEW/TABLE can be updated now */
1189 1190
  bool		straight;		/* optimize with prev table */
  bool          updating;               /* for replicate-do/ignore table */
1191 1192 1193
  bool		force_index;		/* prefer index over table scan */
  bool          ignore_leaves;          /* preload only non-leaf nodes */
  table_map     dep_tables;             /* tables the table depends on      */
1194
  table_map     on_expr_dep_tables;     /* tables on expression depends on  */
1195
  struct st_nested_join *nested_join;   /* if the element is a nested join  */
1196 1197
  TABLE_LIST *embedding;             /* nested join containing the table */
  List<TABLE_LIST> *join_list;/* join list the table belongs to   */
unknown's avatar
unknown committed
1198
  bool		cacheable_table;	/* stop PS caching */
1199
  /* used in multi-upd/views privilege check */
unknown's avatar
VIEW  
unknown committed
1200 1201
  bool		table_in_first_from_clause;
  bool		skip_temporary;		/* this table shouldn't be temporary */
1202
  /* TRUE if this merged view contain auto_increment field */
unknown's avatar
VIEW  
unknown committed
1203
  bool          contain_auto_increment;
unknown's avatar
unknown committed
1204
  bool          multitable_view;        /* TRUE iff this is multitable view */
1205
  bool          compact_view_format;    /* Use compact format for SHOW CREATE VIEW */
1206 1207
  /* view where processed */
  bool          where_processed;
unknown's avatar
unknown committed
1208 1209
  /* TRUE <=> VIEW CHECK OPTION expression has been processed */
  bool          check_option_processed;
1210 1211
  /* FRMTYPE_ERROR if any type is acceptable */
  enum frm_type_enum required_type;
unknown's avatar
unknown committed
1212
  handlerton	*db_type;		/* table_type for handler */
unknown's avatar
VIEW  
unknown committed
1213
  char		timestamp_buffer[20];	/* buffer for timestamp (19+1) */
1214 1215 1216 1217 1218
  /*
    This TABLE_LIST object is just placeholder for prelocking, it will be
    used for implicit LOCK TABLES only and won't be used in real statement.
  */
  bool          prelocking_placeholder;
unknown's avatar
unknown committed
1219 1220 1221 1222 1223 1224
  /*
    This TABLE_LIST object corresponds to the table to be created
    so it is possible that it does not exist (used in CREATE TABLE
    ... SELECT implementation).
  */
  bool          create;
1225
  bool          internal_tmp_table;
1226 1227


unknown's avatar
unknown committed
1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252
  /* View creation context. */

  View_creation_ctx *view_creation_ctx;

  /*
    Attributes to save/load view creation context in/from frm-file.

    Ther are required only to be able to use existing parser to load
    view-definition file. As soon as the parser parsed the file, view
    creation context is initialized and the attributes become redundant.

    These attributes MUST NOT be used for any purposes but the parsing.
  */

  LEX_STRING view_client_cs_name;
  LEX_STRING view_connection_cl_name;

  /*
    View definition (SELECT-statement) in the UTF-form.
  */

  LEX_STRING view_body_utf8;

   /* End of view definition context. */

1253 1254 1255 1256 1257 1258 1259
  /**
    Indicates what triggers we need to pre-load for this TABLE_LIST
    when opening an associated TABLE. This is filled after
    the parsed tree is created.
  */
  uint8 trg_event_map;

1260 1261 1262 1263
  uint i_s_requested_object;
  bool has_db_lookup_value;
  bool has_table_lookup_value;
  uint table_open_method;
1264
  enum enum_schema_table_state schema_table_state;
unknown's avatar
VIEW  
unknown committed
1265
  void calc_md5(char *buffer);
1266
  void set_underlying_merge();
unknown's avatar
unknown committed
1267
  int view_check_option(THD *thd, bool ignore_failure);
1268
  bool setup_underlying(THD *thd);
unknown's avatar
unknown committed
1269
  void cleanup_items();
unknown's avatar
unknown committed
1270 1271 1272 1273 1274
  bool placeholder()
  {
    return derived || view || schema_table || create && !table->db_stat ||
           !table;
  }
1275
  void print(THD *thd, String *str, enum_query_type query_type);
1276 1277
  bool check_single_table(TABLE_LIST **table, table_map map,
                          TABLE_LIST *view);
1278
  bool set_insert_values(MEM_ROOT *mem_root);
1279
  void hide_view_error(THD *thd);
1280 1281 1282
  TABLE_LIST *find_underlying_table(TABLE *table);
  TABLE_LIST *first_leaf_for_name_resolution();
  TABLE_LIST *last_leaf_for_name_resolution();
unknown's avatar
unknown committed
1283
  bool is_leaf_for_name_resolution();
1284
  inline TABLE_LIST *top_table()
1285
    { return belong_to_view ? belong_to_view : this; }
1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299
  inline bool prepare_check_option(THD *thd)
  {
    bool res= FALSE;
    if (effective_with_check)
      res= prep_check_option(thd, effective_with_check);
    return res;
  }
  inline bool prepare_where(THD *thd, Item **conds,
                            bool no_where_clause)
  {
    if (effective_algorithm == VIEW_ALGORITHM_MERGE)
      return prep_where(thd, conds, no_where_clause);
    return FALSE;
  }
1300 1301 1302 1303 1304 1305 1306

  void register_want_access(ulong want_access);
  bool prepare_security(THD *thd);
#ifndef NO_EMBEDDED_ACCESS_CHECKS
  Security_context *find_view_security_context(THD *thd);
  bool prepare_view_securety_context(THD *thd);
#endif
1307 1308 1309 1310 1311
  /*
    Cleanup for re-execution in a prepared statement or a stored
    procedure.
  */
  void reinit_before_use(THD *thd);
unknown's avatar
unknown committed
1312
  Item_subselect *containing_subselect();
1313

1314 1315 1316 1317 1318 1319 1320
  /* 
    Compiles the tagged hints list and fills up st_table::keys_in_use_for_query,
    st_table::keys_in_use_for_group_by, st_table::keys_in_use_for_order_by,
    st_table::force_index and st_table::covering_keys.
  */
  bool process_index_hints(TABLE *table);

1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334
  /* Access MERGE child def version.  See top comment in ha_myisammrg.cc */
  inline ulong get_child_def_version()
  {
    return child_def_version;
  }
  inline void set_child_def_version(ulong version)
  {
    child_def_version= version;
  }
  inline void init_child_def_version()
  {
    child_def_version= ~0UL;
  }

unknown's avatar
unknown committed
1335 1336 1337 1338 1339
  /**
    Compare the version of metadata from the previous execution
    (if any) with values obtained from the current table
    definition cache element.

1340
    @sa check_and_update_table_version()
unknown's avatar
unknown committed
1341 1342
  */
  inline
1343
  bool is_metadata_id_equal(TABLE_SHARE *s) const
unknown's avatar
unknown committed
1344 1345 1346 1347 1348 1349 1350 1351 1352
  {
    return (m_metadata_type == s->get_metadata_type() &&
            m_metadata_version == s->get_metadata_version());
  }

  /**
    Record the value of metadata version of the corresponding
    table definition cache element in this parse tree node.

1353
    @sa check_and_update_table_version()
unknown's avatar
unknown committed
1354 1355
  */
  inline
1356
  void set_metadata_id(TABLE_SHARE *s)
unknown's avatar
unknown committed
1357 1358 1359 1360 1361
  {
    m_metadata_type= s->get_metadata_type();
    m_metadata_version= s->get_metadata_version();
  }

1362 1363 1364
private:
  bool prep_check_option(THD *thd, uint8 check_opt_type);
  bool prep_where(THD *thd, Item **conds, bool no_where_clause);
1365 1366 1367 1368
  /*
    Cleanup for re-execution in a prepared statement or a stored
    procedure.
  */
1369 1370 1371

  /* Remembered MERGE child def version.  See top comment in ha_myisammrg.cc */
  ulong         child_def_version;
1372
  /** See comments for set_metadata_id() */
unknown's avatar
unknown committed
1373
  enum enum_metadata_type m_metadata_type;
1374
  /** See comments for set_metadata_id() */
unknown's avatar
unknown committed
1375
  ulong m_metadata_version;
1376
};
1377

unknown's avatar
VIEW  
unknown committed
1378 1379
class Item;

unknown's avatar
unknown committed
1380 1381 1382 1383
/*
  Iterator over the fields of a generic table reference.
*/

unknown's avatar
VIEW  
unknown committed
1384 1385 1386
class Field_iterator: public Sql_alloc
{
public:
1387
  Field_iterator() {}                         /* Remove gcc warning */
unknown's avatar
VIEW  
unknown committed
1388 1389 1390
  virtual ~Field_iterator() {}
  virtual void set(TABLE_LIST *)= 0;
  virtual void next()= 0;
1391
  virtual bool end_of_fields()= 0;              /* Return 1 at end of list */
unknown's avatar
VIEW  
unknown committed
1392
  virtual const char *name()= 0;
1393
  virtual Item *create_item(THD *)= 0;
unknown's avatar
VIEW  
unknown committed
1394 1395 1396 1397
  virtual Field *field()= 0;
};


unknown's avatar
unknown committed
1398 1399 1400 1401 1402
/* 
  Iterator over the fields of a base table, view with temporary
  table, or subquery.
*/

unknown's avatar
VIEW  
unknown committed
1403 1404 1405 1406 1407 1408 1409 1410
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++; }
1411
  bool end_of_fields() { return *ptr == 0; }
unknown's avatar
VIEW  
unknown committed
1412
  const char *name();
1413
  Item *create_item(THD *thd);
unknown's avatar
VIEW  
unknown committed
1414 1415 1416 1417
  Field *field() { return *ptr; }
};


unknown's avatar
unknown committed
1418 1419
/* Iterator over the fields of a merge view. */

unknown's avatar
VIEW  
unknown committed
1420 1421
class Field_iterator_view: public Field_iterator
{
1422
  Field_translator *ptr, *array_end;
1423
  TABLE_LIST *view;
unknown's avatar
VIEW  
unknown committed
1424 1425 1426 1427
public:
  Field_iterator_view() :ptr(0), array_end(0) {}
  void set(TABLE_LIST *table);
  void next() { ptr++; }
1428
  bool end_of_fields() { return ptr == array_end; }
unknown's avatar
VIEW  
unknown committed
1429
  const char *name();
1430
  Item *create_item(THD *thd);
unknown's avatar
unknown committed
1431
  Item **item_ptr() {return &ptr->item; }
unknown's avatar
VIEW  
unknown committed
1432
  Field *field() { return 0; }
1433
  inline Item *item() { return ptr->item; }
unknown's avatar
unknown committed
1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444
  Field_translator *field_translator() { return ptr; }
};


/*
  Field_iterator interface to the list of materialized fields of a
  NATURAL/USING join.
*/

class Field_iterator_natural_join: public Field_iterator
{
1445
  List_iterator_fast<Natural_join_column> column_ref_it;
unknown's avatar
unknown committed
1446 1447
  Natural_join_column *cur_column_ref;
public:
1448 1449
  Field_iterator_natural_join() :cur_column_ref(NULL) {}
  ~Field_iterator_natural_join() {}
unknown's avatar
unknown committed
1450
  void set(TABLE_LIST *table);
1451
  void next();
unknown's avatar
unknown committed
1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495
  bool end_of_fields() { return !cur_column_ref; }
  const char *name() { return cur_column_ref->name(); }
  Item *create_item(THD *thd) { return cur_column_ref->create_item(thd); }
  Field *field() { return cur_column_ref->field(); }
  Natural_join_column *column_ref() { return cur_column_ref; }
};


/*
  Generic iterator over the fields of an arbitrary table reference.

  DESCRIPTION
    This class unifies the various ways of iterating over the columns
    of a table reference depending on the type of SQL entity it
    represents. If such an entity represents a nested table reference,
    this iterator encapsulates the iteration over the columns of the
    members of the table reference.

  IMPLEMENTATION
    The implementation assumes that all underlying NATURAL/USING table
    references already contain their result columns and are linked into
    the list TABLE_LIST::next_name_resolution_table.
*/

class Field_iterator_table_ref: public Field_iterator
{
  TABLE_LIST *table_ref, *first_leaf, *last_leaf;
  Field_iterator_table        table_field_it;
  Field_iterator_view         view_field_it;
  Field_iterator_natural_join natural_join_it;
  Field_iterator *field_it;
  void set_field_iterator();
public:
  Field_iterator_table_ref() :field_it(NULL) {}
  void set(TABLE_LIST *table);
  void next();
  bool end_of_fields()
  { return (table_ref == last_leaf && field_it->end_of_fields()); }
  const char *name() { return field_it->name(); }
  const char *table_name();
  const char *db_name();
  GRANT_INFO *grant();
  Item *create_item(THD *thd) { return field_it->create_item(thd); }
  Field *field() { return field_it->field(); }
unknown's avatar
unknown committed
1496
  Natural_join_column *get_or_create_column_ref(TABLE_LIST *parent_table_ref);
1497
  Natural_join_column *get_natural_column_ref();
unknown's avatar
VIEW  
unknown committed
1498 1499
};

1500

1501 1502 1503 1504
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 */
1505
  table_map         not_null_tables; /* tables that rejects nulls           */
1506
  struct st_join_table *first_nested;/* the first nested table in the plan  */
1507 1508 1509 1510 1511 1512 1513 1514 1515
  /* 
    Used to count tables in the nested join in 2 isolated places:
    1. In make_outerjoin_info(). 
    2. check_interleaving_with_nj/restore_prev_nj_state (these are called
       by the join optimizer. 
    Before each use the counters are zeroed by reset_nj_counters.
  */
  uint              counter;
  nested_join_map   nj_map;          /* Bit used to identify this nested join*/
1516
} NESTED_JOIN;
1517

1518

1519 1520
typedef struct st_changed_table_list
{
1521
  struct	st_changed_table_list *next;
1522
  char		*key;
1523 1524 1525
  uint32        key_length;
} CHANGED_TABLE_LIST;

1526

1527
typedef struct st_open_table_list{
1528 1529 1530 1531
  struct st_open_table_list *next;
  char	*db,*table;
  uint32 in_use,locked;
} OPEN_TABLE_LIST;
unknown's avatar
unknown committed
1532

1533 1534 1535 1536 1537 1538 1539
typedef struct st_table_field_w_type
{
  LEX_STRING name;
  LEX_STRING type;
  LEX_STRING cset;
} TABLE_FIELD_W_TYPE;

unknown's avatar
unknown committed
1540

1541
my_bool
1542
table_check_intact(TABLE *table, const uint table_f_count,
1543
                   const TABLE_FIELD_W_TYPE *table_def);
1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578

static inline my_bitmap_map *tmp_use_all_columns(TABLE *table,
                                                 MY_BITMAP *bitmap)
{
  my_bitmap_map *old= bitmap->bitmap;
  bitmap->bitmap= table->s->all_set.bitmap;
  return old;
}


static inline void tmp_restore_column_map(MY_BITMAP *bitmap,
                                          my_bitmap_map *old)
{
  bitmap->bitmap= old;
}

/* The following is only needed for debugging */

static inline my_bitmap_map *dbug_tmp_use_all_columns(TABLE *table,
                                                      MY_BITMAP *bitmap)
{
#ifndef DBUG_OFF
  return tmp_use_all_columns(table, bitmap);
#else
  return 0;
#endif
}

static inline void dbug_tmp_restore_column_map(MY_BITMAP *bitmap,
                                               my_bitmap_map *old)
{
#ifndef DBUG_OFF
  tmp_restore_column_map(bitmap, old);
#endif
}
1579 1580 1581

size_t max_row_length(TABLE *table, const uchar *data);