- 15.1.20.1 Files Created by CREATE TABLE
- 15.1.20.2 CREATE TEMPORARY TABLE Statement
- 15.1.20.3 CREATE TABLE ... LIKE Statement
- 15.1.20.4 CREATE TABLE ... SELECT Statement
- 15.1.20.5 FOREIGN KEY Constraints
- 15.1.20.6 CHECK Constraints
- 15.1.20.7 Silent Column Specification Changes
- 15.1.20.8 CREATE TABLE and Generated Columns
- 15.1.20.9 Secondary Indexes and Generated Columns
- 15.1.20.10 Invisible Columns
- 15.1.20.11 Generated Invisible Primary Keys
- 15.1.20.12 Setting NDB Comment Options
CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name
(create_definition,...)
[table_options]
[partition_options]
CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name
[(create_definition,...)]
[table_options]
[partition_options]
[IGNORE | REPLACE]
[AS] query_expression
CREATE [TEMPORARY] TABLE [IF NOT EXISTS] tbl_name
{ LIKE old_tbl_name | (LIKE old_tbl_name) }
create_definition: {
col_name column_definition
| {INDEX | KEY} [index_name] [index_type] (key_part,...)
[index_option] ...
| {FULLTEXT | SPATIAL} [INDEX | KEY] [index_name] (key_part,...)
[index_option] ...
| [CONSTRAINT [symbol]] PRIMARY KEY
[index_type] (key_part,...)
[index_option] ...
| [CONSTRAINT [symbol]] UNIQUE [INDEX | KEY]
[index_name] [index_type] (key_part,...)
[index_option] ...
| [CONSTRAINT [symbol]] FOREIGN KEY
[index_name] (col_name,...)
reference_definition
| check_constraint_definition
}
column_definition: {
data_type [NOT NULL | NULL] [DEFAULT {literal | (expr)} ]
[VISIBLE | INVISIBLE]
[AUTO_INCREMENT] [UNIQUE [KEY]] [[PRIMARY] KEY]
[COMMENT 'string']
[COLLATE collation_name]
[COLUMN_FORMAT {FIXED | DYNAMIC | DEFAULT}]
[ENGINE_ATTRIBUTE [=] 'string']
[SECONDARY_ENGINE_ATTRIBUTE [=] 'string']
[STORAGE {DISK | MEMORY}]
[reference_definition]
[check_constraint_definition]
| data_type
[COLLATE collation_name]
[GENERATED ALWAYS] AS (expr)
[VIRTUAL | STORED] [NOT NULL | NULL]
[VISIBLE | INVISIBLE]
[UNIQUE [KEY]] [[PRIMARY] KEY]
[COMMENT 'string']
[reference_definition]
[check_constraint_definition]
}
data_type:
(see Chapter 13, Data Types)
key_part: {col_name [(length)] | (expr)} [ASC | DESC]
index_type:
USING {BTREE | HASH}
index_option: {
KEY_BLOCK_SIZE [=] value
| index_type
| WITH PARSER parser_name
| COMMENT 'string'
| {VISIBLE | INVISIBLE}
|ENGINE_ATTRIBUTE [=] 'string'
|SECONDARY_ENGINE_ATTRIBUTE [=] 'string'
}
check_constraint_definition:
[CONSTRAINT [symbol]] CHECK (expr) [[NOT] ENFORCED]
reference_definition:
REFERENCES tbl_name (key_part,...)
[MATCH FULL | MATCH PARTIAL | MATCH SIMPLE]
[ON DELETE reference_option]
[ON UPDATE reference_option]
reference_option:
RESTRICT | CASCADE | SET NULL | NO ACTION | SET DEFAULT
table_options:
table_option [[,] table_option] ...
table_option: {
AUTOEXTEND_SIZE [=] value
| AUTO_INCREMENT [=] value
| AVG_ROW_LENGTH [=] value
| [DEFAULT] CHARACTER SET [=] charset_name
| CHECKSUM [=] {0 | 1}
| [DEFAULT] COLLATE [=] collation_name
| COMMENT [=] 'string'
| COMPRESSION [=] {'ZLIB' | 'LZ4' | 'NONE'}
| CONNECTION [=] 'connect_string'
| {DATA | INDEX} DIRECTORY [=] 'absolute path to directory'
| DELAY_KEY_WRITE [=] {0 | 1}
| ENCRYPTION [=] {'Y' | 'N'}
| ENGINE [=] engine_name
| ENGINE_ATTRIBUTE [=] 'string'
| INSERT_METHOD [=] { NO | FIRST | LAST }
| KEY_BLOCK_SIZE [=] value
| MAX_ROWS [=] value
| MIN_ROWS [=] value
| PACK_KEYS [=] {0 | 1 | DEFAULT}
| PASSWORD [=] 'string'
| ROW_FORMAT [=] {DEFAULT | DYNAMIC | FIXED | COMPRESSED | REDUNDANT | COMPACT}
| START TRANSACTION
| SECONDARY_ENGINE_ATTRIBUTE [=] 'string'
| STATS_AUTO_RECALC [=] {DEFAULT | 0 | 1}
| STATS_PERSISTENT [=] {DEFAULT | 0 | 1}
| STATS_SAMPLE_PAGES [=] value
| tablespace_option
| UNION [=] (tbl_name[,tbl_name]...)
}
partition_options:
PARTITION BY
{ [LINEAR] HASH(expr)
| [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list)
| RANGE{(expr) | COLUMNS(column_list)}
| LIST{(expr) | COLUMNS(column_list)} }
[PARTITIONS num]
[SUBPARTITION BY
{ [LINEAR] HASH(expr)
| [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list) }
[SUBPARTITIONS num]
]
[(partition_definition [, partition_definition] ...)]
partition_definition:
PARTITION partition_name
[VALUES
{LESS THAN {(expr | value_list) | MAXVALUE}
|
IN (value_list)}]
[[STORAGE] ENGINE [=] engine_name]
[COMMENT [=] 'string' ]
[DATA DIRECTORY [=] 'data_dir']
[INDEX DIRECTORY [=] 'index_dir']
[MAX_ROWS [=] max_number_of_rows]
[MIN_ROWS [=] min_number_of_rows]
[TABLESPACE [=] tablespace_name]
[(subpartition_definition [, subpartition_definition] ...)]
subpartition_definition:
SUBPARTITION logical_name
[[STORAGE] ENGINE [=] engine_name]
[COMMENT [=] 'string' ]
[DATA DIRECTORY [=] 'data_dir']
[INDEX DIRECTORY [=] 'index_dir']
[MAX_ROWS [=] max_number_of_rows]
[MIN_ROWS [=] min_number_of_rows]
[TABLESPACE [=] tablespace_name]
tablespace_option:
TABLESPACE tablespace_name [STORAGE DISK]
| [TABLESPACE tablespace_name] STORAGE MEMORY
query_expression:
SELECT ... (Some valid select or union statement)
CREATE TABLE creates a table with
the given name. You must have the
CREATE privilege for the table.
By default, tables are created in the default database, using the
InnoDB storage engine. An error
occurs if the table exists, if there is no default database, or if
the database does not exist.
MySQL has no limit on the number of tables. The underlying file
system may have a limit on the number of files that represent
tables. Individual storage engines may impose engine-specific
constraints. InnoDB permits up to 4 billion
tables.
For information about the physical representation of a table, see Section 15.1.20.1, “Files Created by CREATE TABLE”.
There are several aspects to the CREATE
TABLE statement, described under the following topics in
this section:
Table Name
tbl_nameThe table name can be specified as
db_name.tbl_nameto create the table in a specific database. This works regardless of whether there is a default database, assuming that the database exists. If you use quoted identifiers, quote the database and table names separately. For example, write`mydb`.`mytbl`, not`mydb.mytbl`.Rules for permissible table names are given in Section 11.2, “Schema Object Names”.
IF NOT EXISTSPrevents an error from occurring if the table exists. However, there is no verification that the existing table has a structure identical to that indicated by the
CREATE TABLEstatement.
Temporary Tables
You can use the TEMPORARY keyword when creating
a table. A TEMPORARY table is visible only
within the current session, and is dropped automatically when the
session is closed. For more information, see
Section 15.1.20.2, “CREATE TEMPORARY TABLE Statement”.
Table Cloning and Copying
LIKEUse
CREATE TABLE ... LIKEto create an empty table based on the definition of another table, including any column attributes and indexes defined in the original table:CREATE TABLE new_tbl LIKE orig_tbl;For more information, see Section 15.1.20.3, “CREATE TABLE ... LIKE Statement”.
[AS]query_expressionTo create one table from another, add a
SELECTstatement at the end of theCREATE TABLEstatement:CREATE TABLE new_tbl AS SELECT * FROM orig_tbl;For more information, see Section 15.1.20.4, “CREATE TABLE ... SELECT Statement”.
IGNORE | REPLACEThe
IGNOREandREPLACEoptions indicate how to handle rows that duplicate unique key values when copying a table using aSELECTstatement.For more information, see Section 15.1.20.4, “CREATE TABLE ... SELECT Statement”.
Column Data Types and Attributes
There is a hard limit of 4096 columns per table, but the effective maximum may be less for a given table and depends on the factors discussed in Section 10.4.7, “Limits on Table Column Count and Row Size”.
data_typedata_typerepresents the data type in a column definition. For a full description of the syntax available for specifying column data types, as well as information about the properties of each type, see Chapter 13, Data Types.AUTO_INCREMENTapplies only to integer types.Character data types (
CHAR,VARCHAR, theTEXTtypes,ENUM,SET, and any synonyms) can includeCHARACTER SETto specify the character set for the column.CHARSETis a synonym forCHARACTER SET. A collation for the character set can be specified with theCOLLATEattribute, along with any other attributes. For details, see Chapter 12, Character Sets, Collations, Unicode. Example:CREATE TABLE t (c CHAR(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin);MySQL 9.0 interprets length specifications in character column definitions in characters. Lengths for
BINARYandVARBINARYare in bytes.For
CHAR,VARCHAR,BINARY, andVARBINARYcolumns, indexes can be created that use only the leading part of column values, usingsyntax to specify an index prefix length.col_name(length)BLOBandTEXTcolumns also can be indexed, but a prefix length must be given. Prefix lengths are given in characters for nonbinary string types and in bytes for binary string types. That is, index entries consist of the firstlengthcharacters of each column value forCHAR,VARCHAR, andTEXTcolumns, and the firstlengthbytes of each column value forBINARY,VARBINARY, andBLOBcolumns. Indexing only a prefix of column values like this can make the index file much smaller. For additional information about index prefixes, see Section 15.1.15, “CREATE INDEX Statement”.Only the
InnoDBandMyISAMstorage engines support indexing onBLOBandTEXTcolumns. For example:CREATE TABLE test (blob_col BLOB, INDEX(blob_col(10)));If a specified index prefix exceeds the maximum column data type size,
CREATE TABLEhandles the index as follows:For a nonunique index, either an error occurs (if strict SQL mode is enabled), or the index length is reduced to lie within the maximum column data type size and a warning is produced (if strict SQL mode is not enabled).
For a unique index, an error occurs regardless of SQL mode because reducing the index length might enable insertion of nonunique entries that do not meet the specified uniqueness requirement.
JSONcolumns cannot be indexed. You can work around this restriction by creating an index on a generated column that extracts a scalar value from theJSONcolumn. See Indexing a Generated Column to Provide a JSON Column Index, for a detailed example.
NOT NULL | NULLIf neither
NULLnorNOT NULLis specified, the column is treated as thoughNULLhad been specified.In MySQL 9.0, only the
InnoDB,MyISAM, andMEMORYstorage engines support indexes on columns that can haveNULLvalues. In other cases, you must declare indexed columns asNOT NULLor an error results.DEFAULTSpecifies a default value for a column. For more information about default value handling, including the case that a column definition includes no explicit
DEFAULTvalue, see Section 13.6, “Data Type Default Values”.If the
NO_ZERO_DATEorNO_ZERO_IN_DATESQL mode is enabled and a date-valued default is not correct according to that mode,CREATE TABLEproduces a warning if strict SQL mode is not enabled and an error if strict mode is enabled. For example, withNO_ZERO_IN_DATEenabled,c1 DATE DEFAULT '2010-00-00'produces a warning.VISIBLE,INVISIBLESpecify column visibility. The default is
VISIBLEif neither keyword is present. A table must have at least one visible column. Attempting to make all columns invisible produces an error. For more information, see Section 15.1.20.10, “Invisible Columns”.AUTO_INCREMENTAn integer column can have the additional attribute
AUTO_INCREMENT. When you insert a value ofNULL(recommended) or0into an indexedAUTO_INCREMENTcolumn, the column is set to the next sequence value. Typically this is, wherevalue+1valueis the largest value for the column currently in the table.AUTO_INCREMENTsequences begin with1.To retrieve an
AUTO_INCREMENTvalue after inserting a row, use theLAST_INSERT_ID()SQL function or themysql_insert_id()C API function. See Section 14.15, “Information Functions”, and mysql_insert_id().If the
NO_AUTO_VALUE_ON_ZEROSQL mode is enabled, you can store0inAUTO_INCREMENTcolumns as0without generating a new sequence value. See Section 7.1.11, “Server SQL Modes”.There can be only one
AUTO_INCREMENTcolumn per table, it must be indexed, and it cannot have aDEFAULTvalue. AnAUTO_INCREMENTcolumn works properly only if it contains only positive values. Inserting a negative number is regarded as inserting a very large positive number. This is done to avoid precision problems when numbers “wrap” over from positive to negative and also to ensure that you do not accidentally get anAUTO_INCREMENTcolumn that contains0.For
MyISAMtables, you can specify anAUTO_INCREMENTsecondary column in a multiple-column key. See Section 5.6.9, “Using AUTO_INCREMENT”.To make MySQL compatible with some ODBC applications, you can find the
AUTO_INCREMENTvalue for the last inserted row with the following query:SELECT * FROM tbl_name WHERE auto_col IS NULLThis method requires that
sql_auto_is_nullvariable is not set to 0. See Section 7.1.8, “Server System Variables”.For information about
InnoDBandAUTO_INCREMENT, see Section 17.6.1.6, “AUTO_INCREMENT Handling in InnoDB”. For information aboutAUTO_INCREMENTand MySQL Replication, see Section 19.5.1.1, “Replication and AUTO_INCREMENT”.COMMENTA comment for a column can be specified with the
COMMENToption, up to 1024 characters long. The comment is displayed by theSHOW CREATE TABLEandSHOW FULL COLUMNSstatements. It is also shown in theCOLUMN_COMMENTcolumn of the Information SchemaCOLUMNStable.COLUMN_FORMATIn NDB Cluster, it is also possible to specify a data storage format for individual columns of
NDBtables usingCOLUMN_FORMAT. Permissible column formats areFIXED,DYNAMIC, andDEFAULT.FIXEDis used to specify fixed-width storage,DYNAMICpermits the column to be variable-width, andDEFAULTcauses the column to use fixed-width or variable-width storage as determined by the column's data type (possibly overridden by aROW_FORMATspecifier).For
NDBtables, the default value forCOLUMN_FORMATisFIXED.In NDB Cluster, the maximum possible offset for a column defined with
COLUMN_FORMAT=FIXEDis 8188 bytes. For more information and possible workarounds, see Section 25.2.7.5, “Limits Associated with Database Objects in NDB Cluster”.COLUMN_FORMATcurrently has no effect on columns of tables using storage engines other thanNDB. MySQL 9.0 silently ignoresCOLUMN_FORMAT.ENGINE_ATTRIBUTEandSECONDARY_ENGINE_ATTRIBUTEoptions are used to specify column attributes for primary and secondary storage engines. The options are reserved for future use.The value assigned to this option is a string literal containing a valid JSON document or an empty string (''). Invalid JSON is rejected.
CREATE TABLE t1 (c1 INT ENGINE_ATTRIBUTE='{"key":"value"}');ENGINE_ATTRIBUTEandSECONDARY_ENGINE_ATTRIBUTEvalues can be repeated without error. In this case, the last specified value is used.ENGINE_ATTRIBUTEandSECONDARY_ENGINE_ATTRIBUTEvalues are not checked by the server, nor are they cleared when the table's storage engine is changed.STORAGEFor
NDBtables, it is possible to specify whether the column is stored on disk or in memory by using aSTORAGEclause.STORAGE DISKcauses the column to be stored on disk, andSTORAGE MEMORYcauses in-memory storage to be used. TheCREATE TABLEstatement used must still include aTABLESPACEclause:mysql> CREATE TABLE t1 ( -> c1 INT STORAGE DISK, -> c2 INT STORAGE MEMORY -> ) ENGINE NDB; ERROR 1005 (HY000): Can't create table 'c.t1' (errno: 140) mysql> CREATE TABLE t1 ( -> c1 INT STORAGE DISK, -> c2 INT STORAGE MEMORY -> ) TABLESPACE ts_1 ENGINE NDB; Query OK, 0 rows affected (1.06 sec)For
NDBtables,STORAGE DEFAULTis equivalent toSTORAGE MEMORY.The
STORAGEclause has no effect on tables using storage engines other thanNDB. TheSTORAGEkeyword is supported only in the build of mysqld that is supplied with NDB Cluster; it is not recognized in any other version of MySQL, where any attempt to use theSTORAGEkeyword causes a syntax error.GENERATED ALWAYSUsed to specify a generated column expression. For information about generated columns, see Section 15.1.20.8, “CREATE TABLE and Generated Columns”.
Stored generated columns can be indexed.
InnoDBsupports secondary indexes on virtual generated columns. See Section 15.1.20.9, “Secondary Indexes and Generated Columns”.
Indexes, Foreign Keys, and CHECK Constraints
Several keywords apply to creation of indexes, foreign keys, and
CHECK constraints. For general background in
addition to the following descriptions, see
Section 15.1.15, “CREATE INDEX Statement”,
Section 15.1.20.5, “FOREIGN KEY Constraints”, and
Section 15.1.20.6, “CHECK Constraints”.
CONSTRAINTsymbolThe
CONSTRAINTclause may be given to name a constraint. If the clause is not given, or asymbolsymbolis not included following theCONSTRAINTkeyword, MySQL automatically generates a constraint name, with the exception noted below. Thesymbolvalue, if used, must be unique per schema (database), per constraint type. A duplicatesymbolresults in an error. See also the discussion about length limits of generated constraint identifiers at Section 11.2.1, “Identifier Length Limits”.NoteIf the
CONSTRAINTclause is not given in a foreign key definition, or asymbolsymbolis not included following theCONSTRAINTkeyword, MySQL automatically generates a constraint name.The SQL standard specifies that all types of constraints (primary key, unique index, foreign key, check) belong to the same namespace. In MySQL, each constraint type has its own namespace per schema. Consequently, names for each type of constraint must be unique per schema, but constraints of different types can have the same name.
PRIMARY KEYA unique index where all key columns must be defined as
NOT NULL. If they are not explicitly declared asNOT NULL, MySQL declares them so implicitly (and silently). A table can have only onePRIMARY KEY. The name of aPRIMARY KEYis alwaysPRIMARY, which thus cannot be used as the name for any other kind of index.If you do not have a
PRIMARY KEYand an application asks for thePRIMARY KEYin your tables, MySQL returns the firstUNIQUEindex that has noNULLcolumns as thePRIMARY KEY.In
InnoDBtables, keep thePRIMARY KEYshort to minimize storage overhead for secondary indexes. Each secondary index entry contains a copy of the primary key columns for the corresponding row. (See Section 17.6.2.1, “Clustered and Secondary Indexes”.)In the created table, a
PRIMARY KEYis placed first, followed by allUNIQUEindexes, and then the nonunique indexes. This helps the MySQL optimizer to prioritize which index to use and also more quickly to detect duplicatedUNIQUEkeys.A
PRIMARY KEYcan be a multiple-column index. However, you cannot create a multiple-column index using thePRIMARY KEYkey attribute in a column specification. Doing so only marks that single column as primary. You must use a separatePRIMARY KEY(clause.key_part, ...)If a table has a
PRIMARY KEYorUNIQUE NOT NULLindex that consists of a single column that has an integer type, you can use_rowidto refer to the indexed column inSELECTstatements, as described in Unique Indexes.In MySQL, the name of a
PRIMARY KEYisPRIMARY. For other indexes, if you do not assign a name, the index is assigned the same name as the first indexed column, with an optional suffix (_2,_3,...) to make it unique. You can see index names for a table usingSHOW INDEX FROM. See Section 15.7.7.23, “SHOW INDEX Statement”.tbl_nameKEY | INDEXKEYis normally a synonym forINDEX. The key attributePRIMARY KEYcan also be specified as justKEYwhen given in a column definition. This was implemented for compatibility with other database systems.UNIQUEA
UNIQUEindex creates a constraint such that all values in the index must be distinct. An error occurs if you try to add a new row with a key value that matches an existing row. For all engines, aUNIQUEindex permits multipleNULLvalues for columns that can containNULL. If you specify a prefix value for a column in aUNIQUEindex, the column values must be unique within the prefix length.If a table has a
PRIMARY KEYorUNIQUE NOT NULLindex that consists of a single column that has an integer type, you can use_rowidto refer to the indexed column inSELECTstatements, as described in Unique Indexes.FULLTEXTA
FULLTEXTindex is a special type of index used for full-text searches. Only theInnoDBandMyISAMstorage engines supportFULLTEXTindexes. They can be created only fromCHAR,VARCHAR, andTEXTcolumns. Indexing always happens over the entire column; column prefix indexing is not supported and any prefix length is ignored if specified. See Section 14.9, “Full-Text Search Functions”, for details of operation. AWITH PARSERclause can be specified as anindex_optionvalue to associate a parser plugin with the index if full-text indexing and searching operations need special handling. This clause is valid only forFULLTEXTindexes.InnoDBandMyISAMsupport full-text parser plugins. See Full-Text Parser Plugins and Writing Full-Text Parser Plugins for more information.SPATIALYou can create
SPATIALindexes on spatial data types. Spatial types are supported only forInnoDBandMyISAMtables, and indexed columns must be declared asNOT NULL. See Section 13.4, “Spatial Data Types”.FOREIGN KEYMySQL supports foreign keys, which let you cross-reference related data across tables, and foreign key constraints, which help keep this spread-out data consistent. For definition and option information, see
reference_definition, andreference_option.Partitioned tables employing the
InnoDBstorage engine do not support foreign keys. See Section 26.6, “Restrictions and Limitations on Partitioning”, for more information.CHECKThe
CHECKclause enables the creation of constraints to be checked for data values in table rows. See Section 15.1.20.6, “CHECK Constraints”.key_partA
key_partspecification can end withASCorDESCto specify whether index values are stored in ascending or descending order. The default is ascending if no order specifier is given.Prefixes, defined by the
lengthattribute, can be up to 767 bytes long forInnoDBtables that use theREDUNDANTorCOMPACTrow format. The prefix length limit is 3072 bytes forInnoDBtables that use theDYNAMICorCOMPRESSEDrow format. ForMyISAMtables, the prefix length limit is 1000 bytes.Prefix limits are measured in bytes. However, prefix lengths for index specifications in
CREATE TABLE,ALTER TABLE, andCREATE INDEXstatements are interpreted as number of characters for nonbinary string types (CHAR,VARCHAR,TEXT) and number of bytes for binary string types (BINARY,VARBINARY,BLOB). Take this into account when specifying a prefix length for a nonbinary string column that uses a multibyte character set.The
exprfor akey_partspecification can take the form(CASTto create a multi-valued index on ajson_pathAStypeARRAY)JSONcolumn. Multi-Valued Indexes, provides detailed information regarding creation of, usage of, and restrictions and limitations on multi-valued indexes.
index_typeSome storage engines permit you to specify an index type when creating an index. The syntax for the
index_typespecifier isUSING.type_nameExample:
CREATE TABLE lookup (id INT, INDEX USING BTREE (id) ) ENGINE = MEMORY;The preferred position for
USINGis after the index column list. It can be given before the column list, but support for use of the option in that position is deprecated and you should expect it to be removed in a future MySQL release.index_optionindex_optionvalues specify additional options for an index.KEY_BLOCK_SIZEFor
MyISAMtables,KEY_BLOCK_SIZEoptionally specifies the size in bytes to use for index key blocks. The value is treated as a hint; a different size could be used if necessary. AKEY_BLOCK_SIZEvalue specified for an individual index definition overrides the table-levelKEY_BLOCK_SIZEvalue.For information about the table-level
KEY_BLOCK_SIZEattribute, see Table Options.WITH PARSERThe
WITH PARSERoption can be used only withFULLTEXTindexes. It associates a parser plugin with the index if full-text indexing and searching operations need special handling.InnoDBandMyISAMsupport full-text parser plugins. If you have aMyISAMtable with an associated full-text parser plugin, you can convert the table toInnoDBusingALTER TABLE.COMMENTIndex definitions can include an optional comment of up to 1024 characters.
You can set the
InnoDBMERGE_THRESHOLDvalue for an individual index using theindex_optionCOMMENTclause. See Section 17.8.11, “Configuring the Merge Threshold for Index Pages”.VISIBLE,INVISIBLESpecify index visibility. Indexes are visible by default. An invisible index is not used by the optimizer. Specification of index visibility applies to indexes other than primary keys (either explicit or implicit). For more information, see Section 10.3.12, “Invisible Indexes”.
ENGINE_ATTRIBUTEandSECONDARY_ENGINE_ATTRIBUTEoptions are used to specify index attributes for primary and secondary storage engines. The options are reserved for future use.
For more information about permissible
index_optionvalues, see Section 15.1.15, “CREATE INDEX Statement”. For more information about indexes, see Section 10.3.1, “How MySQL Uses Indexes”.For
reference_definitionsyntax details and examples, see Section 15.1.20.5, “FOREIGN KEY Constraints”.InnoDBandNDBtables support checking of foreign key constraints. The columns of the referenced table must always be explicitly named. BothON DELETEandON UPDATEactions on foreign keys are supported. For more detailed information and examples, see Section 15.1.20.5, “FOREIGN KEY Constraints”.For other storage engines, MySQL Server parses and ignores the
FOREIGN KEYsyntax inCREATE TABLEstatements.ImportantFor users familiar with the ANSI/ISO SQL Standard, please note that no storage engine, including
InnoDB, recognizes or enforces theMATCHclause used in referential integrity constraint definitions. Use of an explicitMATCHclause does not have the specified effect, and also causesON DELETEandON UPDATEclauses to be ignored. For these reasons, specifyingMATCHshould be avoided.The
MATCHclause in the SQL standard controls howNULLvalues in a composite (multiple-column) foreign key are handled when comparing to a primary key.InnoDBessentially implements the semantics defined byMATCH SIMPLE, which permit a foreign key to be all or partiallyNULL. In that case, the (child table) row containing such a foreign key is permitted to be inserted, and does not match any row in the referenced (parent) table. It is possible to implement other semantics using triggers.Additionally, MySQL requires that the referenced columns be indexed for performance. However,
InnoDBdoes not enforce any requirement that the referenced columns be declaredUNIQUEorNOT NULL. The handling of foreign key references to nonunique keys or keys that containNULLvalues is not well defined for operations such asUPDATEorDELETE CASCADE. You are advised to use foreign keys that reference only keys that are bothUNIQUE(orPRIMARY) andNOT NULL.MySQL accepts “inline
REFERENCESspecifications” (as defined in the SQL standard) where the references are defined as part of the column specification. MySQL also accepts implicit references to the parent table's primary key. For more information, see Section 15.1.20.5, “FOREIGN KEY Constraints”, as well as Section 1.7.2.3, “FOREIGN KEY Constraint Differences”.For information about the
RESTRICT,CASCADE,SET NULL,NO ACTION, andSET DEFAULToptions, see Section 15.1.20.5, “FOREIGN KEY Constraints”.
Table Options
Table options are used to optimize the behavior of the table. In
most cases, you do not have to specify any of them. These options
apply to all storage engines unless otherwise indicated. Options
that do not apply to a given storage engine may be accepted and
remembered as part of the table definition. Such options then
apply if you later use ALTER TABLE
to convert the table to use a different storage engine.
ENGINESpecifies the storage engine for the table, using one of the names shown in the following table. The engine name can be unquoted or quoted. The quoted name
'DEFAULT'is recognized but ignored.Storage Engine Description InnoDBTransaction-safe tables with row locking and foreign keys. The default storage engine for new tables. See Chapter 17, The InnoDB Storage Engine, and in particular Section 17.1, “Introduction to InnoDB” if you have MySQL experience but are new to InnoDB.MyISAMThe binary portable storage engine that is primarily used for read-only or read-mostly workloads. See Section 18.2, “The MyISAM Storage Engine”. MEMORYThe data for this storage engine is stored only in memory. See Section 18.3, “The MEMORY Storage Engine”. CSVTables that store rows in comma-separated values format. See Section 18.4, “The CSV Storage Engine”. ARCHIVEThe archiving storage engine. See Section 18.5, “The ARCHIVE Storage Engine”. EXAMPLEAn example engine. See Section 18.9, “The EXAMPLE Storage Engine”. FEDERATEDStorage engine that accesses remote tables. See Section 18.8, “The FEDERATED Storage Engine”. HEAPThis is a synonym for MEMORY.MERGEA collection of MyISAMtables used as one table. Also known asMRG_MyISAM. See Section 18.7, “The MERGE Storage Engine”.NDBClustered, fault-tolerant, memory-based tables, supporting transactions and foreign keys. Also known as NDBCLUSTER. See Chapter 25, MySQL NDB Cluster 9.0.By default, if a storage engine is specified that is not available, the statement fails with an error. You can override this behavior by removing
NO_ENGINE_SUBSTITUTIONfrom the server SQL mode (see Section 7.1.11, “Server SQL Modes”) so that MySQL allows substitution of the specified engine with the default storage engine instead. Normally in such cases, this isInnoDB, which is the default value for thedefault_storage_enginesystem variable. WhenNO_ENGINE_SUBSTITUTIONis disabled, a warning occurs if the storage engine specification is not honored.AUTOEXTEND_SIZEDefines the amount by which
InnoDBextends the size of the tablespace when it becomes full. The setting must be a multiple of 4MB. The default setting is 0, which causes the tablespace to be extended according to the implicit default behavior. For more information, see Section 17.6.3.9, “Tablespace AUTOEXTEND_SIZE Configuration”.AUTO_INCREMENTThe initial
AUTO_INCREMENTvalue for the table. In MySQL 9.0, this works forMyISAM,MEMORY,InnoDB, andARCHIVEtables. To set the first auto-increment value for engines that do not support theAUTO_INCREMENTtable option, insert a “dummy” row with a value one less than the desired value after creating the table, and then delete the dummy row.For engines that support the
AUTO_INCREMENTtable option inCREATE TABLEstatements, you can also useALTER TABLEto reset thetbl_nameAUTO_INCREMENT =NAUTO_INCREMENTvalue. The value cannot be set lower than the maximum value currently in the column.AVG_ROW_LENGTHAn approximation of the average row length for your table. You need to set this only for large tables with variable-size rows.
When you create a
MyISAMtable, MySQL uses the product of theMAX_ROWSandAVG_ROW_LENGTHoptions to decide how big the resulting table is. If you don't specify either option, the maximum size forMyISAMdata and index files is 256TB by default. (If your operating system does not support files that large, table sizes are constrained by the file size limit.) If you want to keep down the pointer sizes to make the index smaller and faster and you don't really need big files, you can decrease the default pointer size by setting themyisam_data_pointer_sizesystem variable. (See Section 7.1.8, “Server System Variables”.) If you want all your tables to be able to grow above the default limit and are willing to have your tables slightly slower and larger than necessary, you can increase the default pointer size by setting this variable. Setting the value to 7 permits table sizes up to 65,536TB.[DEFAULT] CHARACTER SETSpecifies a default character set for the table.
CHARSETis a synonym forCHARACTER SET. If the character set name isDEFAULT, the database character set is used.CHECKSUMSet this to 1 if you want MySQL to maintain a live checksum for all rows (that is, a checksum that MySQL updates automatically as the table changes). This makes the table a little slower to update, but also makes it easier to find corrupted tables. The
CHECKSUM TABLEstatement reports the checksum. (MyISAMonly.)[DEFAULT] COLLATESpecifies a default collation for the table.
COMMENTA comment for the table, up to 2048 characters long.
You can set the
InnoDBMERGE_THRESHOLDvalue for a table using thetable_optionCOMMENTclause. See Section 17.8.11, “Configuring the Merge Threshold for Index Pages”.Setting NDB_TABLE options. The table comment in a
CREATE TABLEthat creates anNDBtable or anALTER TABLEstatement which alters one can also be used to specify one to four of theNDB_TABLEoptionsNOLOGGING,READ_BACKUP,PARTITION_BALANCE, orFULLY_REPLICATEDas a set of name-value pairs, separated by commas if need be, immediately following the stringNDB_TABLE=that begins the quoted comment text. An example statement using this syntax is shown here (emphasized text):CREATE TABLE t1 ( c1 INT NOT NULL AUTO_INCREMENT PRIMARY KEY, c2 VARCHAR(100), c3 VARCHAR(100) ) ENGINE=NDB COMMENT="NDB_TABLE=READ_BACKUP=0,PARTITION_BALANCE=FOR_RP_BY_NODE";Spaces are not permitted within the quoted string. The string is case-insensitive.
The comment is displayed as part of the output of
SHOW CREATE TABLE. The text of the comment is also available as the TABLE_COMMENT column of the MySQL Information SchemaTABLEStable.This comment syntax is also supported with
ALTER TABLEstatements forNDBtables. Keep in mind that a table comment used withALTER TABLEreplaces any existing comment which the table might have had previously.Setting the
MERGE_THRESHOLDoption in table comments is not supported forNDBtables (it is ignored).For complete syntax information and examples, see Section 15.1.20.12, “Setting NDB Comment Options”.
COMPRESSIONThe compression algorithm used for page level compression for
InnoDBtables. Supported values includeZlib,LZ4, andNone. TheCOMPRESSIONattribute was introduced with the transparent page compression feature. Page compression is only supported withInnoDBtables that reside in file-per-table tablespaces, and is only available on Linux and Windows platforms that support sparse files and hole punching. For more information, see Section 17.9.2, “InnoDB Page Compression”.CONNECTIONThe connection string for a
FEDERATEDtable.NoteOlder versions of MySQL used a
COMMENToption for the connection string.DATA DIRECTORY,INDEX DIRECTORYFor
InnoDB, theDATA DIRECTORY='clause permits creating tables outside of the data directory. Thedirectory'innodb_file_per_tablevariable must be enabled to use theDATA DIRECTORYclause. The full directory path must be specified, and known toInnoDB. For more information, see Section 17.6.1.2, “Creating Tables Externally”.When creating
MyISAMtables, you can use theDATA DIRECTORY='clause, thedirectory'INDEX DIRECTORY='clause, or both. They specify where to put adirectory'MyISAMtable's data file and index file, respectively. UnlikeInnoDBtables, MySQL does not create subdirectories that correspond to the database name when creating aMyISAMtable with aDATA DIRECTORYorINDEX DIRECTORYoption. Files are created in the directory that is specified.You must have the
FILEprivilege to use theDATA DIRECTORYorINDEX DIRECTORYtable option.ImportantTable-level
DATA DIRECTORYandINDEX DIRECTORYoptions are ignored for partitioned tables. (Bug #32091)These options work only when you are not using the
--skip-symbolic-linksoption. Your operating system must also have a working, thread-saferealpath()call. See Section 10.12.2.2, “Using Symbolic Links for MyISAM Tables on Unix”, for more complete information.If a
MyISAMtable is created with noDATA DIRECTORYoption, the.MYDfile is created in the database directory. By default, ifMyISAMfinds an existing.MYDfile in this case, it overwrites it. The same applies to.MYIfiles for tables created with noINDEX DIRECTORYoption. To suppress this behavior, start the server with the--keep_files_on_createoption, in which caseMyISAMdoes not overwrite existing files and returns an error instead.If a
MyISAMtable is created with aDATA DIRECTORYorINDEX DIRECTORYoption and an existing.MYDor.MYIfile is found,MyISAMalways returns an error, and does not overwrite a file in the specified directory.ImportantYou cannot use path names that contain the MySQL data directory with
DATA DIRECTORYorINDEX DIRECTORY. This includes partitioned tables and individual table partitions. (See Bug #32167.)DELAY_KEY_WRITESet this to 1 if you want to delay key updates for the table until the table is closed. See the description of the
delay_key_writesystem variable in Section 7.1.8, “Server System Variables”. (MyISAMonly.)ENCRYPTIONThe
ENCRYPTIONclause enables or disables page-level data encryption for anInnoDBtable. A keyring plugin must be installed and configured before encryption can be enabled. TheENCRYPTIONclause can be specified when creating a table in an a file-per-table tablespace, or when creating a table in a general tablespace.The
ENCRYPTIONoption is supported only by theInnoDBstorage engine; thus it works only if the default storage engine isInnoDB, or if theCREATE TABLEstatement also specifiesENGINE=InnoDB. Otherwise the statement is rejected withER_CHECK_NOT_IMPLEMENTED.A table inherits the default schema encryption if an
ENCRYPTIONclause is not specified. If thetable_encryption_privilege_checkvariable is enabled, theTABLE_ENCRYPTION_ADMINprivilege is required to create a table with anENCRYPTIONclause setting that differs from the default schema encryption. When creating a table in a general tablespace, table and tablespace encryption must match.Specifying an
ENCRYPTIONclause with a value other than'N'or''is not permitted when using a storage engine that does not support encryption.For more information, see Section 17.13, “InnoDB Data-at-Rest Encryption”.
The
ENGINE_ATTRIBUTEandSECONDARY_ENGINE_ATTRIBUTEoptions are used to specify table attributes for primary and secondary storage engines. The options are reserved for future use.The value assigned to either of these options must be a string literal containing a valid JSON document or an empty string (''). Invalid JSON is rejected.
CREATE TABLE t1 (c1 INT) ENGINE_ATTRIBUTE='{"key":"value"}';ENGINE_ATTRIBUTEandSECONDARY_ENGINE_ATTRIBUTEvalues can be repeated without error. In this case, the last specified value is used.ENGINE_ATTRIBUTEandSECONDARY_ENGINE_ATTRIBUTEvalues are not checked by the server, nor are they cleared when the table's storage engine is changed.INSERT_METHODIf you want to insert data into a
MERGEtable, you must specify withINSERT_METHODthe table into which the row should be inserted.INSERT_METHODis an option useful forMERGEtables only. Use a value ofFIRSTorLASTto have inserts go to the first or last table, or a value ofNOto prevent inserts. See Section 18.7, “The MERGE Storage Engine”.KEY_BLOCK_SIZEFor
MyISAMtables,KEY_BLOCK_SIZEoptionally specifies the size in bytes to use for index key blocks. The value is treated as a hint; a different size could be used if necessary. AKEY_BLOCK_SIZEvalue specified for an individual index definition overrides the table-levelKEY_BLOCK_SIZEvalue.For
InnoDBtables,KEY_BLOCK_SIZEspecifies the page size in kilobytes to use for compressedInnoDBtables. TheKEY_BLOCK_SIZEvalue is treated as a hint; a different size could be used byInnoDBif necessary.KEY_BLOCK_SIZEcan only be less than or equal to theinnodb_page_sizevalue. A value of 0 represents the default compressed page size, which is half of theinnodb_page_sizevalue. Depending oninnodb_page_size, possibleKEY_BLOCK_SIZEvalues include 0, 1, 2, 4, 8, and 16. See Section 17.9.1, “InnoDB Table Compression” for more information.Oracle recommends enabling
innodb_strict_modewhen specifyingKEY_BLOCK_SIZEforInnoDBtables. Wheninnodb_strict_modeis enabled, specifying an invalidKEY_BLOCK_SIZEvalue returns an error. Ifinnodb_strict_modeis disabled, an invalidKEY_BLOCK_SIZEvalue results in a warning, and theKEY_BLOCK_SIZEoption is ignored.The
Create_optionscolumn in response toSHOW TABLE STATUSreports the actualKEY_BLOCK_SIZEused by the table, as doesSHOW CREATE TABLE.InnoDBonly supportsKEY_BLOCK_SIZEat the table level.KEY_BLOCK_SIZEis not supported with 32KB and 64KBinnodb_page_sizevalues.InnoDBtable compression does not support these pages sizes.InnoDBdoes not support theKEY_BLOCK_SIZEoption when creating temporary tables.MAX_ROWSThe maximum number of rows you plan to store in the table. This is not a hard limit, but rather a hint to the storage engine that the table must be able to store at least this many rows.
ImportantThe use of
MAX_ROWSwithNDBtables to control the number of table partitions is deprecated. It remains supported in later versions for backward compatibility, but is subject to removal in a future release. Use PARTITION_BALANCE instead; see Setting NDB_TABLE options.The
NDBstorage engine treats this value as a maximum. If you plan to create very large NDB Cluster tables (containing millions of rows), you should use this option to insure thatNDBallocates sufficient number of index slots in the hash table used for storing hashes of the table's primary keys by settingMAX_ROWS = 2 *, whererowsrowsis the number of rows that you expect to insert into the table.The maximum
MAX_ROWSvalue is 4294967295; larger values are truncated to this limit.MIN_ROWSThe minimum number of rows you plan to store in the table. The
MEMORYstorage engine uses this option as a hint about memory use.PACK_KEYSTakes effect only with
MyISAMtables. Set this option to 1 if you want to have smaller indexes. This usually makes updates slower and reads faster. Setting the option to 0 disables all packing of keys. Setting it toDEFAULTtells the storage engine to pack only longCHAR,VARCHAR,BINARY, orVARBINARYcolumns.If you do not use
PACK_KEYS, the default is to pack strings, but not numbers. If you usePACK_KEYS=1, numbers are packed as well.When packing binary number keys, MySQL uses prefix compression:
Every key needs one extra byte to indicate how many bytes of the previous key are the same for the next key.
The pointer to the row is stored in high-byte-first order directly after the key, to improve compression.
This means that if you have many equal keys on two consecutive rows, all following “same” keys usually only take two bytes (including the pointer to the row). Compare this to the ordinary case where the following keys takes
storage_size_for_key + pointer_size(where the pointer size is usually 4). Conversely, you get a significant benefit from prefix compression only if you have many numbers that are the same. If all keys are totally different, you use one byte more per key, if the key is not a key that can haveNULLvalues. (In this case, the packed key length is stored in the same byte that is used to mark if a key isNULL.)PASSWORDThis option is unused.
ROW_FORMATDefines the physical format in which the rows are stored.
When creating a table with strict mode disabled, the storage engine's default row format is used if the specified row format is not supported. The actual row format of the table is reported in the
Row_formatcolumn in response toSHOW TABLE STATUS. TheCreate_optionscolumn shows the row format that was specified in theCREATE TABLEstatement, as doesSHOW CREATE TABLE.Row format choices differ depending on the storage engine used for the table.
For
InnoDBtables:The default row format is defined by
innodb_default_row_format, which has a default setting ofDYNAMIC. The default row format is used when theROW_FORMAToption is not defined or whenROW_FORMAT=DEFAULTis used.If the
ROW_FORMAToption is not defined, or ifROW_FORMAT=DEFAULTis used, operations that rebuild a table also silently change the row format of the table to the default defined byinnodb_default_row_format. For more information, see Defining the Row Format of a Table.For more efficient
InnoDBstorage of data types, especiallyBLOBtypes, use theDYNAMIC. See DYNAMIC Row Format for requirements associated with theDYNAMICrow format.To enable compression for
InnoDBtables, specifyROW_FORMAT=COMPRESSED. TheROW_FORMAT=COMPRESSEDoption is not supported when creating temporary tables. See Section 17.9, “InnoDB Table and Page Compression” for requirements associated with theCOMPRESSEDrow format.The row format used in older versions of MySQL can still be requested by specifying the
REDUNDANTrow format.When you specify a non-default
ROW_FORMATclause, consider also enabling theinnodb_strict_modeconfiguration option.ROW_FORMAT=FIXEDis not supported. IfROW_FORMAT=FIXEDis specified whileinnodb_strict_modeis disabled,InnoDBissues a warning and assumesROW_FORMAT=DYNAMIC. IfROW_FORMAT=FIXEDis specified whileinnodb_strict_modeis enabled, which is the default,InnoDBreturns an error.For additional information about
InnoDBrow formats, see Section 17.10, “InnoDB Row Formats”.
For
MyISAMtables, the option value can beFIXEDorDYNAMICfor static or variable-length row format. myisampack sets the type toCOMPRESSED. See Section 18.2.3, “MyISAM Table Storage Formats”.For
NDBtables, the defaultROW_FORMATisDYNAMIC.START TRANSACTIONThis is an internal-use table option, used to permit
CREATE TABLE ... SELECTto be logged as a single, atomic transaction in the binary log when using row-based replication with a storage engine that supports atomic DDL. OnlyBINLOG,COMMIT, andROLLBACKstatements are permitted afterCREATE TABLE ... START TRANSACTION. For related information, see Section 15.1.1, “Atomic Data Definition Statement Support”.STATS_AUTO_RECALCSpecifies whether to automatically recalculate persistent statistics for an
InnoDBtable. The valueDEFAULTcauses the persistent statistics setting for the table to be determined by theinnodb_stats_auto_recalcconfiguration option. The value1causes statistics to be recalculated when 10% of the data in the table has changed. The value0prevents automatic recalculation for this table; with this setting, issue anANALYZE TABLEstatement to recalculate the statistics after making substantial changes to the table. For more information about the persistent statistics feature, see Section 17.8.10.1, “Configuring Persistent Optimizer Statistics Parameters”.STATS_PERSISTENTSpecifies whether to enable persistent statistics for an
InnoDBtable. The valueDEFAULTcauses the persistent statistics setting for the table to be determined by theinnodb_stats_persistentconfiguration option. The value1enables persistent statistics for the table, while the value0turns off this feature. After enabling persistent statistics through aCREATE TABLEorALTER TABLEstatement, issue anANALYZE TABLEstatement to calculate the statistics, after loading representative data into the table. For more information about the persistent statistics feature, see Section 17.8.10.1, “Configuring Persistent Optimizer Statistics Parameters”.STATS_SAMPLE_PAGESThe number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated by
ANALYZE TABLE. For more information, see Section 17.8.10.1, “Configuring Persistent Optimizer Statistics Parameters”.TABLESPACEThe
TABLESPACEclause can be used to create anInnoDBtable in an existing general tablespace, a file-per-table tablespace, or the system tablespace.CREATE TABLE tbl_name ... TABLESPACE [=] tablespace_nameThe general tablespace that you specify must exist prior to using the
TABLESPACEclause. For information about general tablespaces, see Section 17.6.3.3, “General Tablespaces”.The
is a case-sensitive identifier. It may be quoted or unquoted. The forward slash character (“/”) is not permitted. Names beginning with “innodb_” are reserved for special use.tablespace_nameTo create a table in the system tablespace, specify
innodb_systemas the tablespace name.CREATE TABLE tbl_name ... TABLESPACE [=] innodb_systemUsing
TABLESPACE [=] innodb_system, you can place a table of any uncompressed row format in the system tablespace regardless of theinnodb_file_per_tablesetting. For example, you can add a table withROW_FORMAT=DYNAMICto the system tablespace usingTABLESPACE [=] innodb_system.To create a table in a file-per-table tablespace, specify
innodb_file_per_tableas the tablespace name.CREATE TABLE tbl_name ... TABLESPACE [=] innodb_file_per_tableNoteIf
innodb_file_per_tableis enabled, you need not specifyTABLESPACE=innodb_file_per_tableto create anInnoDBfile-per-table tablespace.InnoDBtables are created in file-per-table tablespaces by default wheninnodb_file_per_tableis enabled.The
DATA DIRECTORYclause is permitted withCREATE TABLE ... TABLESPACE=innodb_file_per_tablebut is otherwise not supported for use in combination with theTABLESPACEclause. The directory specified in aDATA DIRECTORYclause must be known toInnoDB. For more information, see Using the DATA DIRECTORY Clause.NoteSupport for
TABLESPACE = innodb_file_per_tableandTABLESPACE = innodb_temporaryclauses withCREATE TEMPORARY TABLEis deprecated; expect it to be removed in a future version of MySQL.The
STORAGEtable option is employed only withNDBtables.STORAGEdetermines the type of storage used, and can be either ofDISKorMEMORY.TABLESPACE ... STORAGE DISKassigns a table to an NDB Cluster Disk Data tablespace.STORAGE DISKcannot be used inCREATE TABLEunless preceded byTABLESPACEtablespace_name.For
STORAGE MEMORY, the tablespace name is optional, thus, you can useTABLESPACEor simplytablespace_nameSTORAGE MEMORYSTORAGE MEMORYto specify explicitly that the table is in-memory.See Section 25.6.11, “NDB Cluster Disk Data Tables”, for more information.
Used to access a collection of identical
MyISAMtables as one. This works only withMERGEtables. See Section 18.7, “The MERGE Storage Engine”.You must have
SELECT,UPDATE, andDELETEprivileges for the tables you map to aMERGEtable.NoteFormerly, all tables used had to be in the same database as the
MERGEtable itself. This restriction no longer applies.
Table Partitioning
partition_options can be used to
control partitioning of the table created with
CREATE TABLE.
Not all options shown in the syntax for
partition_options at the beginning of
this section are available for all partitioning types. Please see
the listings for the following individual types for information
specific to each type, and see Chapter 26, Partitioning, for
more complete information about the workings of and uses for
partitioning in MySQL, as well as additional examples of table
creation and other statements relating to MySQL partitioning.
Partitions can be modified, merged, added to tables, and dropped from tables. For basic information about the MySQL statements to accomplish these tasks, see Section 15.1.9, “ALTER TABLE Statement”. For more detailed descriptions and examples, see Section 26.3, “Partition Management”.
PARTITION BYIf used, a
partition_optionsclause begins withPARTITION BY. This clause contains the function that is used to determine the partition; the function returns an integer value ranging from 1 tonum, wherenumis the number of partitions. (The maximum number of user-defined partitions which a table may contain is 1024; the number of subpartitions—discussed later in this section—is included in this maximum.)NoteThe expression (
expr) used in aPARTITION BYclause cannot refer to any columns not in the table being created; such references are specifically not permitted and cause the statement to fail with an error. (Bug #29444)HASH(expr)Hashes one or more columns to create a key for placing and locating rows.
expris an expression using one or more table columns. This can be any valid MySQL expression (including MySQL functions) that yields a single integer value. For example, these are both validCREATE TABLEstatements usingPARTITION BY HASH:CREATE TABLE t1 (col1 INT, col2 CHAR(5)) PARTITION BY HASH(col1); CREATE TABLE t1 (col1 INT, col2 CHAR(5), col3 DATETIME) PARTITION BY HASH ( YEAR(col3) );You may not use either
VALUES LESS THANorVALUES INclauses withPARTITION BY HASH.PARTITION BY HASHuses the remainder ofexprdivided by the number of partitions (that is, the modulus). For examples and additional information, see Section 26.2.4, “HASH Partitioning”.The
LINEARkeyword entails a somewhat different algorithm. In this case, the number of the partition in which a row is stored is calculated as the result of one or more logicalANDoperations. For discussion and examples of linear hashing, see Section 26.2.4.1, “LINEAR HASH Partitioning”.KEY(column_list)This is similar to
HASH, except that MySQL supplies the hashing function so as to guarantee an even data distribution. Thecolumn_listargument is simply a list of 1 or more table columns (maximum: 16). This example shows a simple table partitioned by key, with 4 partitions:CREATE TABLE tk (col1 INT, col2 CHAR(5), col3 DATE) PARTITION BY KEY(col3) PARTITIONS 4;For tables that are partitioned by key, you can employ linear partitioning by using the
LINEARkeyword. This has the same effect as with tables that are partitioned byHASH. That is, the partition number is found using the&operator rather than the modulus (see Section 26.2.4.1, “LINEAR HASH Partitioning”, and Section 26.2.5, “KEY Partitioning”, for details). This example uses linear partitioning by key to distribute data between 5 partitions:CREATE TABLE tk (col1 INT, col2 CHAR(5), col3 DATE) PARTITION BY LINEAR KEY(col3) PARTITIONS 5;The
ALGORITHM={1 | 2}option is supported with[SUB]PARTITION BY [LINEAR] KEY.ALGORITHM=1causes the server to use the same key-hashing functions as MySQL 5.1;ALGORITHM=2means that the server employs the key-hashing functions implemented and used by default for newKEYpartitioned tables in MySQL 5.5 and later. (Partitioned tables created with the key-hashing functions employed in MySQL 5.5 and later cannot be used by a MySQL 5.1 server.) Not specifying the option has the same effect as usingALGORITHM=2. This option is intended for use chiefly when upgrading or downgrading[LINEAR] KEYpartitioned tables between MySQL 5.1 and later MySQL versions, or for creating tables partitioned byKEYorLINEAR KEYon a MySQL 5.5 or later server which can be used on a MySQL 5.1 server. For more information, see Section 15.1.9.1, “ALTER TABLE Partition Operations”.mysqldump writes this option encased in versioned comments.
ALGORITHM=1is shown when necessary in the output ofSHOW CREATE TABLEusing versioned comments in the same manner as mysqldump.ALGORITHM=2is always omitted fromSHOW CREATE TABLEoutput, even if this option was specified when creating the original table.You may not use either
VALUES LESS THANorVALUES INclauses withPARTITION BY KEY.RANGE(expr)In this case,
exprshows a range of values using a set ofVALUES LESS THANoperators. When using range partitioning, you must define at least one partition usingVALUES LESS THAN. You cannot useVALUES INwith range partitioning.NoteFor tables partitioned by
RANGE,VALUES LESS THANmust be used with either an integer literal value or an expression that evaluates to a single integer value. In MySQL 9.0, you can overcome this limitation in a table that is defined usingPARTITION BY RANGE COLUMNS, as described later in this section.Suppose that you have a table that you wish to partition on a column containing year values, according to the following scheme.
Partition Number: Years Range: 0 1990 and earlier 1 1991 to 1994 2 1995 to 1998 3 1999 to 2002 4 2003 to 2005 5 2006 and later A table implementing such a partitioning scheme can be realized by the
CREATE TABLEstatement shown here:CREATE TABLE t1 ( year_col INT, some_data INT ) PARTITION BY RANGE (year_col) ( PARTITION p0 VALUES LESS THAN (1991), PARTITION p1 VALUES LESS THAN (1995), PARTITION p2 VALUES LESS THAN (1999), PARTITION p3 VALUES LESS THAN (2002), PARTITION p4 VALUES LESS THAN (2006), PARTITION p5 VALUES LESS THAN MAXVALUE );PARTITION ... VALUES LESS THAN ...statements work in a consecutive fashion.VALUES LESS THAN MAXVALUEworks to specify “leftover” values that are greater than the maximum value otherwise specified.VALUES LESS THANclauses work sequentially in a manner similar to that of thecaseportions of aswitch ... caseblock (as found in many programming languages such as C, Java, and PHP). That is, the clauses must be arranged in such a way that the upper limit specified in each successiveVALUES LESS THANis greater than that of the previous one, with the one referencingMAXVALUEcoming last of all in the list.RANGE COLUMNS(column_list)This variant on
RANGEfacilitates partition pruning for queries using range conditions on multiple columns (that is, having conditions such asWHERE a = 1 AND b < 10orWHERE a = 1 AND b = 10 AND c < 10). It enables you to specify value ranges in multiple columns by using a list of columns in theCOLUMNSclause and a set of column values in eachPARTITION ... VALUES LESS THAN (partition definition clause. (In the simplest case, this set consists of a single column.) The maximum number of columns that can be referenced in thevalue_list)column_listandvalue_listis 16.The
column_listused in theCOLUMNSclause may contain only names of columns; each column in the list must be one of the following MySQL data types: the integer types; the string types; and time or date column types. Columns usingBLOB,TEXT,SET,ENUM,BIT, or spatial data types are not permitted; columns that use floating-point number types are also not permitted. You also may not use functions or arithmetic expressions in theCOLUMNSclause.The
VALUES LESS THANclause used in a partition definition must specify a literal value for each column that appears in theCOLUMNS()clause; that is, the list of values used for eachVALUES LESS THANclause must contain the same number of values as there are columns listed in theCOLUMNSclause. An attempt to use more or fewer values in aVALUES LESS THANclause than there are in theCOLUMNSclause causes the statement to fail with the error Inconsistency in usage of column lists for partitioning.... You cannot useNULLfor any value appearing inVALUES LESS THAN. It is possible to useMAXVALUEmore than once for a given column other than the first, as shown in this example:CREATE TABLE rc ( a INT NOT NULL, b INT NOT NULL ) PARTITION BY RANGE COLUMNS(a,b) ( PARTITION p0 VALUES LESS THAN (10,5), PARTITION p1 VALUES LESS THAN (20,10), PARTITION p2 VALUES LESS THAN (50,MAXVALUE), PARTITION p3 VALUES LESS THAN (65,MAXVALUE), PARTITION p4 VALUES LESS THAN (MAXVALUE,MAXVALUE) );Each value used in a
VALUES LESS THANvalue list must match the type of the corresponding column exactly; no conversion is made. For example, you cannot use the string'1'for a value that matches a column that uses an integer type (you must use the numeral1instead), nor can you use the numeral1for a value that matches a column that uses a string type (in such a case, you must use a quoted string:'1').For more information, see Section 26.2.1, “RANGE Partitioning”, and Section 26.4, “Partition Pruning”.
LIST(expr)This is useful when assigning partitions based on a table column with a restricted set of possible values, such as a state or country code. In such a case, all rows pertaining to a certain state or country can be assigned to a single partition, or a partition can be reserved for a certain set of states or countries. It is similar to
RANGE, except that onlyVALUES INmay be used to specify permissible values for each partition.VALUES INis used with a list of values to be matched. For instance, you could create a partitioning scheme such as the following:CREATE TABLE client_firms ( id INT, name VARCHAR(35) ) PARTITION BY LIST (id) ( PARTITION r0 VALUES IN (1, 5, 9, 13, 17, 21), PARTITION r1 VALUES IN (2, 6, 10, 14, 18, 22), PARTITION r2 VALUES IN (3, 7, 11, 15, 19, 23), PARTITION r3 VALUES IN (4, 8, 12, 16, 20, 24) );When using list partitioning, you must define at least one partition using
VALUES IN. You cannot useVALUES LESS THANwithPARTITION BY LIST.NoteFor tables partitioned by
LIST, the value list used withVALUES INmust consist of integer values only. In MySQL 9.0, you can overcome this limitation using partitioning byLIST COLUMNS, which is described later in this section.LIST COLUMNS(column_list)This variant on
LISTfacilitates partition pruning for queries using comparison conditions on multiple columns (that is, having conditions such asWHERE a = 5 AND b = 5orWHERE a = 1 AND b = 10 AND c = 5). It enables you to specify values in multiple columns by using a list of columns in theCOLUMNSclause and a set of column values in eachPARTITION ... VALUES IN (partition definition clause.value_list)The rules governing regarding data types for the column list used in
LIST COLUMNS(and the value list used incolumn_list)VALUES IN(are the same as those for the column list used invalue_list)RANGE COLUMNS(and the value list used incolumn_list)VALUES LESS THAN(, respectively, except that in thevalue_list)VALUES INclause,MAXVALUEis not permitted, and you may useNULL.There is one important difference between the list of values used for
VALUES INwithPARTITION BY LIST COLUMNSas opposed to when it is used withPARTITION BY LIST. When used withPARTITION BY LIST COLUMNS, each element in theVALUES INclause must be a set of column values; the number of values in each set must be the same as the number of columns used in theCOLUMNSclause, and the data types of these values must match those of the columns (and occur in the same order). In the simplest case, the set consists of a single column. The maximum number of columns that can be used in thecolumn_listand in the elements making up thevalue_listis 16.The table defined by the following
CREATE TABLEstatement provides an example of a table usingLIST COLUMNSpartitioning:CREATE TABLE lc ( a INT NULL, b INT NULL ) PARTITION BY LIST COLUMNS(a,b) ( PARTITION p0 VALUES IN( (0,0), (NULL,NULL) ), PARTITION p1 VALUES IN( (0,1), (0,2), (0,3), (1,1), (1,2) ), PARTITION p2 VALUES IN( (1,0), (2,0), (2,1), (3,0), (3,1) ), PARTITION p3 VALUES IN( (1,3), (2,2), (2,3), (3,2), (3,3) ) );PARTITIONSnumThe number of partitions may optionally be specified with a
PARTITIONSclause, wherenumnumis the number of partitions. If both this clause and anyPARTITIONclauses are used,nummust be equal to the total number of any partitions that are declared usingPARTITIONclauses.NoteWhether or not you use a
PARTITIONSclause in creating a table that is partitioned byRANGEorLIST, you must still include at least onePARTITION VALUESclause in the table definition (see below).SUBPARTITION BYA partition may optionally be divided into a number of subpartitions. This can be indicated by using the optional
SUBPARTITION BYclause. Subpartitioning may be done byHASHorKEY. Either of these may beLINEAR. These work in the same way as previously described for the equivalent partitioning types. (It is not possible to subpartition byLISTorRANGE.)The number of subpartitions can be indicated using the
SUBPARTITIONSkeyword followed by an integer value.Rigorous checking of the value used in
PARTITIONSorSUBPARTITIONSclauses is applied and this value must adhere to the following rules:The value must be a positive, nonzero integer.
No leading zeros are permitted.
The value must be an integer literal, and cannot not be an expression. For example,
PARTITIONS 0.2E+01is not permitted, even though0.2E+01evaluates to2. (Bug #15890)
partition_definitionEach partition may be individually defined using a
partition_definitionclause. The individual parts making up this clause are as follows:PARTITIONpartition_nameSpecifies a logical name for the partition.
VALUESFor range partitioning, each partition must include a
VALUES LESS THANclause; for list partitioning, you must specify aVALUES INclause for each partition. This is used to determine which rows are to be stored in this partition. See the discussions of partitioning types in Chapter 26, Partitioning, for syntax examples.[STORAGE] ENGINEMySQL accepts a
[STORAGE] ENGINEoption for bothPARTITIONandSUBPARTITION. Currently, the only way in which this option can be used is to set all partitions or all subpartitions to the same storage engine, and an attempt to set different storage engines for partitions or subpartitions in the same table raises the error ERROR 1469 (HY000): The mix of handlers in the partitions is not permitted in this version of MySQL.COMMENTAn optional
COMMENTclause may be used to specify a string that describes the partition. Example:COMMENT = 'Data for the years previous to 1999'The maximum length for a partition comment is 1024 characters.
DATA DIRECTORYandINDEX DIRECTORYDATA DIRECTORYandINDEX DIRECTORYmay be used to indicate the directory where, respectively, the data and indexes for this partition are to be stored. Both theand thedata_dirmust be absolute system path names.index_dirThe directory specified in a
DATA DIRECTORYclause must be known toInnoDB. For more information, see Using the DATA DIRECTORY Clause.You must have the
FILEprivilege to use theDATA DIRECTORYorINDEX DIRECTORYpartition option.Example:
CREATE TABLE th (id INT, name VARCHAR(30), adate DATE) PARTITION BY LIST(YEAR(adate)) ( PARTITION p1999 VALUES IN (1995, 1999, 2003) DATA DIRECTORY = '/var/appdata/95/data' INDEX DIRECTORY = '/var/appdata/95/idx', PARTITION p2000 VALUES IN (1996, 2000, 2004) DATA DIRECTORY = '/var/appdata/96/data' INDEX DIRECTORY = '/var/appdata/96/idx', PARTITION p2001 VALUES IN (1997, 2001, 2005) DATA DIRECTORY = '/var/appdata/97/data' INDEX DIRECTORY = '/var/appdata/97/idx', PARTITION p2002 VALUES IN (1998, 2002, 2006) DATA DIRECTORY = '/var/appdata/98/data' INDEX DIRECTORY = '/var/appdata/98/idx' );DATA DIRECTORYandINDEX DIRECTORYbehave in the same way as in theCREATE TABLEstatement'stable_optionclause as used forMyISAMtables.One data directory and one index directory may be specified per partition. If left unspecified, the data and indexes are stored by default in the table's database directory.
The
DATA DIRECTORYandINDEX DIRECTORYoptions are ignored for creating partitioned tables ifNO_DIR_IN_CREATEis in effect.MAX_ROWSandMIN_ROWSMay be used to specify, respectively, the maximum and minimum number of rows to be stored in the partition. The values for
max_number_of_rowsandmin_number_of_rowsmust be positive integers. As with the table-level options with the same names, these act only as “suggestions” to the server and are not hard limits.TABLESPACEMay be used to designate an
InnoDBfile-per-table tablespace for the partition by specifyingTABLESPACE `innodb_file_per_table`. All partitions must belong to the same storage engine.Placing
InnoDBtable partitions in sharedInnoDBtablespaces is not supported. Shared tablespaces include theInnoDBsystem tablespace and general tablespaces.
subpartition_definitionThe partition definition may optionally contain one or more
subpartition_definitionclauses. Each of these consists at a minimum of theSUBPARTITION, wherenamenameis an identifier for the subpartition. Except for the replacement of thePARTITIONkeyword withSUBPARTITION, the syntax for a subpartition definition is identical to that for a partition definition.Subpartitioning must be done by
HASHorKEY, and can be done only onRANGEorLISTpartitions. See Section 26.2.6, “Subpartitioning”.
Partitioning by Generated Columns
Partitioning by generated columns is permitted. For example:
CREATE TABLE t1 (
s1 INT,
s2 INT AS (EXP(s1)) STORED
)
PARTITION BY LIST (s2) (
PARTITION p1 VALUES IN (1)
);
Partitioning sees a generated column as a regular column, which
enables workarounds for limitations on functions that are not
permitted for partitioning (see
Section 26.6.3, “Partitioning Limitations Relating to Functions”). The
preceding example demonstrates this technique:
EXP() cannot be used directly in
the PARTITION BY clause, but a generated column
defined using EXP() is permitted.