MySQL 8.0.29
Source Code Documentation
sql_tmp_table.h
Go to the documentation of this file.
1#ifndef SQL_TMP_TABLE_INCLUDED
2#define SQL_TMP_TABLE_INCLUDED
3
4/* Copyright (c) 2000, 2021, Oracle and/or its affiliates.
5
6 This program is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License, version 2.0,
8 as published by the Free Software Foundation.
9
10 This program is also distributed with certain software (including
11 but not limited to OpenSSL) that is licensed under separate terms,
12 as designated in a particular file or component or in included license
13 documentation. The authors of MySQL hereby grant you an additional
14 permission to link the program and your derivative works with the
15 separately licensed software that they have included with MySQL.
16
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 GNU General Public License, version 2.0, for more details.
21
22 You should have received a copy of the GNU General Public License
23 along with this program; if not, write to the Free Software
24 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */
25
26/**
27 @file
28
29 @brief
30 Temporary table handling functions.
31*/
32
33#include <sys/types.h>
34
35#include "my_base.h" // ha_rows
36#include "my_inttypes.h"
37#include "sql/item.h" // Item
39
40class Create_field;
41class Field;
42class SJ_TMP_TABLE;
43class THD;
44struct ORDER;
45struct TABLE;
46template <class T>
47class List;
48
52};
53
55 const mem_root_deque<Item *> &fields, ORDER *group,
56 bool distinct, bool save_sum_fields,
57 ulonglong select_options, ha_rows rows_limit,
58 const char *table_alias);
59bool open_tmp_table(TABLE *table);
61 bool is_virtual = true,
62 ulonglong select_options = 0,
63 const char *alias = nullptr);
64bool create_ondisk_from_heap(THD *thd, TABLE *table, int error,
65 bool insert_last_record, bool ignore_last_dup,
66 bool *is_duplicate);
67void close_tmp_table(TABLE *table);
68void free_tmp_table(TABLE *table);
69TABLE *create_duplicate_weedout_tmp_table(THD *thd, uint uniq_tuple_length_arg,
70 SJ_TMP_TABLE *sjtbl);
71bool setup_tmp_table_handler(THD *thd, TABLE *table, ulonglong select_options,
72 bool force_disk_table = false,
73 bool schema_table = false);
74bool instantiate_tmp_table(THD *thd, TABLE *table);
75Field *create_tmp_field(THD *thd, TABLE *table, Item *item, Item::Type type,
76 Func_ptr_array *copy_func, Field **from_field,
77 Field **default_field, bool group, bool modify_item,
78 bool table_cant_handle_bit_fields,
79 bool make_copy_field);
80Field *create_tmp_field_from_field(THD *thd, const Field *org_field,
81 const char *name, TABLE *table,
82 Item_field *item);
83
84/**
85 Get the minimum of max_key_length and max_key_part_length between
86 HEAP engine and internal_tmp_disk_storage_engine.
87*/
88void get_max_key_and_part_length(uint *max_key_length,
89 uint *max_key_part_length,
90 uint *max_key_parts);
92void encode_innodb_position(uchar *rowid_bytes, uint length, ha_rows row_num);
93bool reposition_innodb_cursor(TABLE *table, ha_rows row_num);
94#endif /* SQL_TMP_TABLE_INCLUDED */
Create_field is a description a field/column that may or may not exists in a table.
Definition: create_field.h:50
Definition: field.h:573
Definition: item.h:4043
Base class that is used to represent any kind of expression in a relational query.
Definition: item.h:802
Type
Definition: item.h:838
Definition: sql_list.h:433
A typesafe replacement for DYNAMIC_ARRAY.
Definition: mem_root_array.h:421
Definition: sql_executor.h:103
For each client connection we create a separate thread with THD serving as a thread/connection descri...
Definition: sql_class.h:945
Object containing parameters used when creating and using temporary tables.
Definition: temp_table_param.h:98
A (partial) implementation of std::deque allocating its blocks on a MEM_ROOT.
Definition: mem_root_deque.h:109
This file includes constants used by all storage engines.
my_off_t ha_rows
Definition: my_base.h:1139
Some integer typedefs for easier portability.
unsigned long long int ulonglong
Definition: my_inttypes.h:55
unsigned char uchar
Definition: my_inttypes.h:51
Log error(cerr, "ERROR")
bool length(const dd::Spatial_reference_system *srs, const Geometry *g1, double *length, bool *null) noexcept
Computes the length of linestrings and multilinestrings.
Definition: length.cc:75
bool is_duplicate(Country_record *record, int skip_index)
Check for duplicate value of Primary/Unique Key column(s).
Definition: pfs_example_country.cc:50
required string type
Definition: replication_group_member_actions.proto:33
bool setup_tmp_table_handler(THD *thd, TABLE *table, ulonglong select_options, bool force_disk_table=false, bool schema_table=false)
Helper function to create_tmp_table_* family for setting up table's SE.
Definition: sql_tmp_table.cc:2041
Field * create_tmp_field(THD *thd, TABLE *table, Item *item, Item::Type type, Func_ptr_array *copy_func, Field **from_field, Field **default_field, bool group, bool modify_item, bool table_cant_handle_bit_fields, bool make_copy_field)
Create field for temporary table.
Definition: sql_tmp_table.cc:353
void free_tmp_table(TABLE *table)
Free temporary table.
Definition: sql_tmp_table.cc:2421
enum_internal_tmp_mem_storage_engine
Definition: sql_tmp_table.h:49
@ TMP_TABLE_TEMPTABLE
Definition: sql_tmp_table.h:51
@ TMP_TABLE_MEMORY
Definition: sql_tmp_table.h:50
Field * create_tmp_field_from_field(THD *thd, const Field *org_field, const char *name, TABLE *table, Item_field *item)
Lifecycle management of internal temporary tables.
Definition: sql_tmp_table.cc:187
TABLE * create_tmp_table(THD *thd, Temp_table_param *param, const mem_root_deque< Item * > &fields, ORDER *group, bool distinct, bool save_sum_fields, ulonglong select_options, ha_rows rows_limit, const char *table_alias)
Definition: sql_tmp_table.cc:865
void close_tmp_table(TABLE *table)
Close a temporary table at end of preparation or execution.
Definition: sql_tmp_table.cc:2372
TABLE * create_tmp_table_from_fields(THD *thd, List< Create_field > &field_list, bool is_virtual=true, ulonglong select_options=0, const char *alias=nullptr)
Create an, optionally reduced, TABLE object with properly set up Field list from a list of field defi...
Definition: sql_tmp_table.cc:1855
bool reposition_innodb_cursor(TABLE *table, ha_rows row_num)
Helper function for create_ondisk_from_heap().
Definition: sql_tmp_table.cc:2852
void encode_innodb_position(uchar *rowid_bytes, uint length, ha_rows row_num)
Encode an InnoDB PK in 6 bytes, high-byte first; like InnoDB's dict_sys_write_row_id() does.
Definition: sql_tmp_table.cc:2830
bool open_tmp_table(TABLE *table)
Definition: sql_tmp_table.cc:2166
void get_max_key_and_part_length(uint *max_key_length, uint *max_key_part_length, uint *max_key_parts)
Get the minimum of max_key_length and max_key_part_length between HEAP engine and internal_tmp_disk_s...
Definition: sql_tmp_table.cc:623
TABLE * create_duplicate_weedout_tmp_table(THD *thd, uint uniq_tuple_length_arg, SJ_TMP_TABLE *sjtbl)
Create a temporary table to weed out duplicate rowid combinations.
Definition: sql_tmp_table.cc:1635
bool create_ondisk_from_heap(THD *thd, TABLE *table, int error, bool insert_last_record, bool ignore_last_dup, bool *is_duplicate)
If a MEMORY table gets full, create a disk-based table and copy all rows to this.
Definition: sql_tmp_table.cc:2518
void init_cache_tmp_engine_properties()
Initialize the storage engine properties for the alternative temporary table storage engines.
Definition: sql_tmp_table.cc:605
bool instantiate_tmp_table(THD *thd, TABLE *table)
Instantiates temporary table.
Definition: sql_tmp_table.cc:2302
case opt name
Definition: sslopt-case.h:32
Definition: table.h:279
Definition: table.h:1394
unsigned int uint
Definition: uca-dump.cc:29