Documentation Home
MySQL 9.2 Reference Manual
Related Documentation Download this Manual
PDF (US Ltr) - 40.8Mb
PDF (A4) - 40.9Mb
Man Pages (TGZ) - 259.7Kb
Man Pages (Zip) - 366.9Kb
Info (Gzip) - 4.1Mb
Info (Zip) - 4.1Mb


MySQL 9.2 Reference Manual  / ...  / SQL Statements  / Data Definition Statements  /  CREATE TABLE Statement

15.1.21 CREATE TABLE Statement

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_expressionCREATE [TEMPORARY] TABLE [IF NOT EXISTS]tbl_name    { LIKEold_tbl_name | (LIKEold_tbl_name) }create_definition: {col_namecolumn_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']      [COLLATEcollation_name]      [COLUMN_FORMAT {FIXED | DYNAMIC | DEFAULT}]      [ENGINE_ATTRIBUTE [=] 'string']      [SECONDARY_ENGINE_ATTRIBUTE [=] 'string']      [STORAGE {DISK | MEMORY}]      [reference_definition]      [check_constraint_definition]  |data_type      [COLLATEcollation_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 PARSERparser_name  | COMMENT 'string'  | {VISIBLE | INVISIBLE}  |ENGINE_ATTRIBUTE [=] 'string'  |SECONDARY_ENGINE_ATTRIBUTE [=] 'string'}check_constraint_definition:    [CONSTRAINT [symbol]] CHECK (expr) [[NOT] ENFORCED]reference_definition:    REFERENCEStbl_name (key_part,...)      [MATCH FULL | MATCH PARTIAL | MATCH SIMPLE]      [ON DELETEreference_option]      [ON UPDATEreference_option]reference_option:    RESTRICT | CASCADE | SET NULL | NO ACTION | SET DEFAULTtable_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)} }    [PARTITIONSnum]    [SUBPARTITION BY        { [LINEAR] HASH(expr)        | [LINEAR] KEY [ALGORITHM={1 | 2}] (column_list) }      [SUBPARTITIONSnum]    ]    [(partition_definition [,partition_definition] ...)]partition_definition:    PARTITIONpartition_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:    SUBPARTITIONlogical_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:    TABLESPACEtablespace_name [STORAGE DISK]  | [TABLESPACEtablespace_name] STORAGE MEMORYquery_expression:    SELECT ...   (Some valid select or union statement)

CREATE TABLE creates a table with the given name. You must have theCREATE privilege for the table.

By default, tables are created in the default database, using theInnoDB 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, seeSection 15.1.21.1, “Files Created by CREATE TABLE”.

There are several aspects to theCREATE TABLE statement, described under the following topics in this section:

Table Name

  • tbl_name

    The table name can be specified asdb_name.tbl_name to 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 inSection 11.2, “Schema Object Names”.

  • IF NOT EXISTS

    Prevents 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 theCREATE TABLE statement.

Temporary Tables

You can use theTEMPORARY keyword when creating a table. ATEMPORARY table is visible only within the current session, and is dropped automatically when the session is closed. For more information, seeSection 15.1.21.2, “CREATE TEMPORARY TABLE Statement”.

Table Cloning and Copying

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 inSection 10.4.7, “Limits on Table Column Count and Row Size”.

  • data_type

    data_type represents 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, seeChapter 13,Data Types.

    • AUTO_INCREMENT applies only to integer types.

    • Character data types (CHAR,VARCHAR, theTEXT types,ENUM,SET, and any synonyms) can includeCHARACTER SET to specify the character set for the column.CHARSET is a synonym forCHARACTER SET. A collation for the character set can be specified with theCOLLATE attribute, along with any other attributes. For details, seeChapter 12,Character Sets, Collations, Unicode. Example:

      CREATE TABLE t (c CHAR(20) CHARACTER SET utf8mb4 COLLATE utf8mb4_bin);

      MySQL 9.2 interprets length specifications in character column definitions in characters. Lengths forBINARY andVARBINARY are in bytes.

    • ForCHAR,VARCHAR,BINARY, andVARBINARY columns, indexes can be created that use only the leading part of column values, usingcol_name(length) syntax to specify an index prefix length.BLOB andTEXT columns also can be indexed, but a prefix lengthmust 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 firstlength characters of each column value forCHAR,VARCHAR, andTEXT columns, and the firstlength bytes of each column value forBINARY,VARBINARY, andBLOB columns. Indexing only a prefix of column values like this can make the index file much smaller. For additional information about index prefixes, seeSection 15.1.15, “CREATE INDEX Statement”.

      Only theInnoDB andMyISAM storage engines support indexing onBLOB andTEXT columns. 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 TABLE handles 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.

    • JSON columns cannot be indexed. You can work around this restriction by creating an index on a generated column that extracts a scalar value from theJSON column. SeeIndexing a Generated Column to Provide a JSON Column Index, for a detailed example.

  • NOT NULL | NULL

    If neitherNULL norNOT NULL is specified, the column is treated as thoughNULL had been specified.

    In MySQL 9.2, only theInnoDB,MyISAM, andMEMORY storage engines support indexes on columns that can haveNULL values. In other cases, you must declare indexed columns asNOT NULL or an error results.

  • DEFAULT

    Specifies a default value for a column. For more information about default value handling, including the case that a column definition includes no explicitDEFAULT value, seeSection 13.6, “Data Type Default Values”.

    If theNO_ZERO_DATE orNO_ZERO_IN_DATE SQL mode is enabled and a date-valued default is not correct according to that mode,CREATE TABLE produces a warning if strict SQL mode is not enabled and an error if strict mode is enabled. For example, withNO_ZERO_IN_DATE enabled,c1 DATE DEFAULT '2010-00-00' produces a warning.

  • VISIBLE,INVISIBLE

    Specify column visibility. The default isVISIBLE if 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, seeSection 15.1.21.10, “Invisible Columns”.

  • AUTO_INCREMENT

    An integer column can have the additional attributeAUTO_INCREMENT. When you insert a value ofNULL (recommended) or0 into an indexedAUTO_INCREMENT column, the column is set to the next sequence value. Typically this isvalue+1, wherevalue is the largest value for the column currently in the table.AUTO_INCREMENT sequences begin with1.

    To retrieve anAUTO_INCREMENT value after inserting a row, use theLAST_INSERT_ID() SQL function or themysql_insert_id() C API function. SeeSection 14.15, “Information Functions”, andmysql_insert_id().

    If theNO_AUTO_VALUE_ON_ZERO SQL mode is enabled, you can store0 inAUTO_INCREMENT columns as0 without generating a new sequence value. SeeSection 7.1.11, “Server SQL Modes”.

    There can be only oneAUTO_INCREMENT column per table, it must be indexed, and it cannot have aDEFAULT value. AnAUTO_INCREMENT column 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 numberswrap over from positive to negative and also to ensure that you do not accidentally get anAUTO_INCREMENT column that contains0.

    ForMyISAM tables, you can specify anAUTO_INCREMENT secondary column in a multiple-column key. SeeSection 5.6.9, “Using AUTO_INCREMENT”.

    To make MySQL compatible with some ODBC applications, you can find theAUTO_INCREMENT value for the last inserted row with the following query:

    SELECT * FROMtbl_name WHEREauto_col IS NULL

    This method requires thatsql_auto_is_null variable is not set to 0. SeeSection 7.1.8, “Server System Variables”.

    For information aboutInnoDB andAUTO_INCREMENT, seeSection 17.6.1.6, “AUTO_INCREMENT Handling in InnoDB”. For information aboutAUTO_INCREMENT and MySQL Replication, seeSection 19.5.1.1, “Replication and AUTO_INCREMENT”.

  • COMMENT

    A comment for a column can be specified with theCOMMENT option, up to 1024 characters long. The comment is displayed by theSHOW CREATE TABLE andSHOW FULL COLUMNS statements. It is also shown in theCOLUMN_COMMENT column of the Information SchemaCOLUMNS table.

  • COLUMN_FORMAT

    In NDB Cluster, it is also possible to specify a data storage format for individual columns ofNDB tables usingCOLUMN_FORMAT. Permissible column formats areFIXED,DYNAMIC, andDEFAULT.FIXED is used to specify fixed-width storage,DYNAMIC permits the column to be variable-width, andDEFAULT causes the column to use fixed-width or variable-width storage as determined by the column's data type (possibly overridden by aROW_FORMAT specifier).

    ForNDB tables, the default value forCOLUMN_FORMAT isFIXED.

    In NDB Cluster, the maximum possible offset for a column defined withCOLUMN_FORMAT=FIXED is 8188 bytes. For more information and possible workarounds, seeSection 25.2.7.5, “Limits Associated with Database Objects in NDB Cluster”.

    COLUMN_FORMAT currently has no effect on columns of tables using storage engines other thanNDB. MySQL 9.2 silently ignoresCOLUMN_FORMAT.

  • ENGINE_ATTRIBUTE andSECONDARY_ENGINE_ATTRIBUTE options 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_ATTRIBUTE andSECONDARY_ENGINE_ATTRIBUTE values can be repeated without error. In this case, the last specified value is used.

    ENGINE_ATTRIBUTE andSECONDARY_ENGINE_ATTRIBUTE values are not checked by the server, nor are they cleared when the table's storage engine is changed.

  • STORAGE

    ForNDB tables, it is possible to specify whether the column is stored on disk or in memory by using aSTORAGE clause.STORAGE DISK causes the column to be stored on disk, andSTORAGE MEMORY causes in-memory storage to be used. TheCREATE TABLE statement used must still include aTABLESPACE clause:

    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)

    ForNDB tables,STORAGE DEFAULT is equivalent toSTORAGE MEMORY.

    TheSTORAGE clause has no effect on tables using storage engines other thanNDB. TheSTORAGE keyword is supported only in the build ofmysqld that is supplied with NDB Cluster; it is not recognized in any other version of MySQL, where any attempt to use theSTORAGE keyword causes a syntax error.

  • GENERATED ALWAYS

    Used to specify a generated column expression. For information aboutgenerated columns, seeSection 15.1.21.8, “CREATE TABLE and Generated Columns”.

    Stored generated columns can be indexed.InnoDB supports secondary indexes onvirtual generated columns. SeeSection 15.1.21.9, “Secondary Indexes and Generated Columns”.

Indexes, Foreign Keys, and CHECK Constraints

Several keywords apply to creation of indexes, foreign keys, andCHECK constraints. For general background in addition to the following descriptions, seeSection 15.1.15, “CREATE INDEX Statement”,Section 15.1.21.5, “FOREIGN KEY Constraints”, andSection 15.1.21.6, “CHECK Constraints”.

  • CONSTRAINTsymbol

    TheCONSTRAINTsymbol clause may be given to name a constraint. If the clause is not given, or asymbol is not included following theCONSTRAINT keyword, MySQL automatically generates a constraint name, with the exception noted below. Thesymbol value, if used, must be unique per schema (database), per constraint type. A duplicatesymbol results in an error. See also the discussion about length limits of generated constraint identifiers atSection 11.2.1, “Identifier Length Limits”.

    Note

    If theCONSTRAINTsymbol clause is not given in a foreign key definition, or asymbol is not included following theCONSTRAINT keyword, 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 KEY

    A unique index where all key columns must be defined asNOT 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 KEY is alwaysPRIMARY, which thus cannot be used as the name for any other kind of index.

    If you do not have aPRIMARY KEY and an application asks for thePRIMARY KEY in your tables, MySQL returns the firstUNIQUE index that has noNULL columns as thePRIMARY KEY.

    InInnoDB tables, keep thePRIMARY KEY short to minimize storage overhead for secondary indexes. Each secondary index entry contains a copy of the primary key columns for the corresponding row. (SeeSection 17.6.2.1, “Clustered and Secondary Indexes”.)

    In the created table, aPRIMARY KEY is placed first, followed by allUNIQUE indexes, and then the nonunique indexes. This helps the MySQL optimizer to prioritize which index to use and also more quickly to detect duplicatedUNIQUE keys.

    APRIMARY KEY can be a multiple-column index. However, you cannot create a multiple-column index using thePRIMARY KEY key attribute in a column specification. Doing so only marks that single column as primary. You must use a separatePRIMARY KEY(key_part, ...) clause.

    If a table has aPRIMARY KEY orUNIQUE NOT NULL index that consists of a single column that has an integer type, you can use_rowid to refer to the indexed column inSELECT statements, as described inUnique Indexes.

    In MySQL, the name of aPRIMARY KEY isPRIMARY. 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 FROMtbl_name. SeeSection 15.7.7.24, “SHOW INDEX Statement”.

  • KEY | INDEX

    KEY is normally a synonym forINDEX. The key attributePRIMARY KEY can also be specified as justKEY when given in a column definition. This was implemented for compatibility with other database systems.

  • UNIQUE

    AUNIQUE index 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, aUNIQUE index permits multipleNULL values for columns that can containNULL. If you specify a prefix value for a column in aUNIQUE index, the column values must be unique within the prefix length.

    If a table has aPRIMARY KEY orUNIQUE NOT NULL index that consists of a single column that has an integer type, you can use_rowid to refer to the indexed column inSELECT statements, as described inUnique Indexes.

  • FULLTEXT

    AFULLTEXT index is a special type of index used for full-text searches. Only theInnoDB andMyISAM storage engines supportFULLTEXT indexes. They can be created only fromCHAR,VARCHAR, andTEXT columns. Indexing always happens over the entire column; column prefix indexing is not supported and any prefix length is ignored if specified. SeeSection 14.9, “Full-Text Search Functions”, for details of operation. AWITH PARSER clause can be specified as anindex_option value to associate a parser plugin with the index if full-text indexing and searching operations need special handling. This clause is valid only forFULLTEXT indexes.InnoDB andMyISAM support full-text parser plugins. SeeFull-Text Parser Plugins andWriting Full-Text Parser Plugins for more information.

  • SPATIAL

    You can createSPATIAL indexes on spatial data types. Spatial types are supported only forInnoDB andMyISAM tables, and indexed columns must be declared asNOT NULL. SeeSection 13.4, “Spatial Data Types”.

  • FOREIGN KEY

    MySQL 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, seereference_definition, andreference_option.

    Partitioned tables employing theInnoDB storage engine do not support foreign keys. SeeSection 26.6, “Restrictions and Limitations on Partitioning”, for more information.

  • CHECK

    TheCHECK clause enables the creation of constraints to be checked for data values in table rows. SeeSection 15.1.21.6, “CHECK Constraints”.

  • key_part

    • Akey_part specification can end withASC orDESC to specify whether index values are stored in ascending or descending order. The default is ascending if no order specifier is given.

    • Prefixes, defined by thelength attribute, can be up to 767 bytes long forInnoDB tables that use theREDUNDANT orCOMPACT row format. The prefix length limit is 3072 bytes forInnoDB tables that use theDYNAMIC orCOMPRESSED row format. ForMyISAM tables, the prefix length limit is 1000 bytes.

      Prefixlimits are measured in bytes. However, prefixlengths for index specifications inCREATE TABLE,ALTER TABLE, andCREATE INDEX statements 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.

    • Theexpr for akey_part specification can take the form(CASTjson_path AStype ARRAY) to create a multi-valued index on aJSON column.Multi-Valued Indexes, provides detailed information regarding creation of, usage of, and restrictions and limitations on multi-valued indexes.

  • index_type

    Some storage engines permit you to specify an index type when creating an index. The syntax for theindex_type specifier isUSINGtype_name.

    Example:

    CREATE TABLE lookup  (id INT, INDEX USING BTREE (id)) ENGINE = MEMORY;

    The preferred position forUSING is 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_option

    index_option values specify additional options for an index.

    • KEY_BLOCK_SIZE

      ForMyISAM tables,KEY_BLOCK_SIZE optionally 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_SIZE value specified for an individual index definition overrides the table-levelKEY_BLOCK_SIZE value.

      For information about the table-levelKEY_BLOCK_SIZE attribute, seeTable Options.

    • WITH PARSER

      TheWITH PARSER option can be used only withFULLTEXT indexes. It associates a parser plugin with the index if full-text indexing and searching operations need special handling.InnoDB andMyISAM support full-text parser plugins. If you have aMyISAM table with an associated full-text parser plugin, you can convert the table toInnoDB usingALTER TABLE.

    • COMMENT

      Index definitions can include an optional comment of up to 1024 characters.

      You can set theInnoDBMERGE_THRESHOLD value for an individual index using theindex_optionCOMMENT clause. SeeSection 17.8.11, “Configuring the Merge Threshold for Index Pages”.

    • VISIBLE,INVISIBLE

      Specify 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, seeSection 10.3.12, “Invisible Indexes”.

    • ENGINE_ATTRIBUTE andSECONDARY_ENGINE_ATTRIBUTE options are used to specify index attributes for primary and secondary storage engines. The options are reserved for future use.

    For more information about permissibleindex_option values, seeSection 15.1.15, “CREATE INDEX Statement”. For more information about indexes, seeSection 10.3.1, “How MySQL Uses Indexes”.

  • reference_definition

    Forreference_definition syntax details and examples, seeSection 15.1.21.5, “FOREIGN KEY Constraints”.

    InnoDB andNDB tables support checking of foreign key constraints. The columns of the referenced table must always be explicitly named. BothON DELETE andON UPDATE actions on foreign keys are supported. For more detailed information and examples, seeSection 15.1.21.5, “FOREIGN KEY Constraints”.

    For other storage engines, MySQL Server parses and ignores theFOREIGN KEY syntax inCREATE TABLE statements.

    Important

    For users familiar with the ANSI/ISO SQL Standard, please note that no storage engine, includingInnoDB, recognizes or enforces theMATCH clause used in referential integrity constraint definitions. Use of an explicitMATCH clause does not have the specified effect, and also causesON DELETE andON UPDATE clauses to be ignored. For these reasons, specifyingMATCH should be avoided.

    TheMATCH clause in the SQL standard controls howNULL values in a composite (multiple-column) foreign key are handled when comparing to a primary key.InnoDB essentially 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,InnoDB does not enforce any requirement that the referenced columns be declaredUNIQUE orNOT NULL. The handling of foreign key references to nonunique keys or keys that containNULL values is not well defined for operations such asUPDATE orDELETE CASCADE. You are advised to use foreign keys that reference only keys that are bothUNIQUE (orPRIMARY) andNOT NULL.

    MySQL acceptsinlineREFERENCES specifications (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, seeSection 15.1.21.5, “FOREIGN KEY Constraints”, as well asSection 1.7.2.3, “FOREIGN KEY Constraint Differences”.

  • reference_option

    For information about theRESTRICT,CASCADE,SET NULL,NO ACTION, andSET DEFAULT options, seeSection 15.1.21.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 useALTER TABLE to convert the table to use a different storage engine.

  • ENGINE

    Specifies 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 EngineDescription
    InnoDBTransaction-safe tables with row locking and foreign keys. The default storage engine for new tables. SeeChapter 17,The InnoDB Storage Engine, and in particularSection 17.1, “Introduction to InnoDB” if you have MySQL experience but are new toInnoDB.
    MyISAMThe binary portable storage engine that is primarily used for read-only or read-mostly workloads. SeeSection 18.2, “The MyISAM Storage Engine”.
    MEMORYThe data for this storage engine is stored only in memory. SeeSection 18.3, “The MEMORY Storage Engine”.
    CSVTables that store rows in comma-separated values format. SeeSection 18.4, “The CSV Storage Engine”.
    ARCHIVEThe archiving storage engine. SeeSection 18.5, “The ARCHIVE Storage Engine”.
    EXAMPLEAn example engine. SeeSection 18.9, “The EXAMPLE Storage Engine”.
    FEDERATEDStorage engine that accesses remote tables. SeeSection 18.8, “The FEDERATED Storage Engine”.
    HEAPThis is a synonym forMEMORY.
    MERGEA collection ofMyISAM tables used as one table. Also known asMRG_MyISAM. SeeSection 18.7, “The MERGE Storage Engine”.
    NDBClustered, fault-tolerant, memory-based tables, supporting transactions and foreign keys. Also known asNDBCLUSTER. SeeChapter 25,MySQL NDB Cluster 9.2.

    By default, if a storage engine is specified that is not available, the statement fails with an error. You can override this behavior by removingNO_ENGINE_SUBSTITUTION from the server SQL mode (seeSection 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_engine system variable. WhenNO_ENGINE_SUBSTITUTION is disabled, a warning occurs if the storage engine specification is not honored.

  • AUTOEXTEND_SIZE

    Defines the amount by whichInnoDB extends 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, seeSection 17.6.3.9, “Tablespace AUTOEXTEND_SIZE Configuration”.

  • AUTO_INCREMENT

    The initialAUTO_INCREMENT value for the table. In MySQL 9.2, this works forMyISAM,MEMORY,InnoDB, andARCHIVE tables. To set the first auto-increment value for engines that do not support theAUTO_INCREMENT table option, insert adummy row with a value one less than the desired value after creating the table, and then delete the dummy row.

    For engines that support theAUTO_INCREMENT table option inCREATE TABLE statements, you can also useALTER TABLEtbl_name AUTO_INCREMENT =N to reset theAUTO_INCREMENT value. The value cannot be set lower than the maximum value currently in the column.

  • AVG_ROW_LENGTH

    An 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 aMyISAM table, MySQL uses the product of theMAX_ROWS andAVG_ROW_LENGTH options to decide how big the resulting table is. If you don't specify either option, the maximum size forMyISAM data 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_size system variable. (SeeSection 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 SET

    Specifies a default character set for the table.CHARSET is a synonym forCHARACTER SET. If the character set name isDEFAULT, the database character set is used.

  • CHECKSUM

    Set 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. TheCHECKSUM TABLE statement reports the checksum. (MyISAM only.)

  • [DEFAULT] COLLATE

    Specifies a default collation for the table.

  • COMMENT

    A comment for the table, up to 2048 characters long.

    You can set theInnoDBMERGE_THRESHOLD value for a table using thetable_optionCOMMENT clause. SeeSection 17.8.11, “Configuring the Merge Threshold for Index Pages”.

    Setting NDB_TABLE options.  The table comment in aCREATE TABLE that creates anNDB table or anALTER TABLE statement which alters one can also be used to specify one to four of theNDB_TABLE optionsNOLOGGING,READ_BACKUP,PARTITION_BALANCE, orFULLY_REPLICATED as 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=NDBCOMMENT="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 ofSHOW CREATE TABLE. The text of the comment is also available as the TABLE_COMMENT column of the MySQL Information SchemaTABLES table.

    This comment syntax is also supported withALTER TABLE statements forNDB tables. Keep in mind that a table comment used withALTER TABLE replaces any existing comment which the table might have had previously.

    Setting theMERGE_THRESHOLD option in table comments is not supported forNDB tables (it is ignored).

    For complete syntax information and examples, seeSection 15.1.21.12, “Setting NDB Comment Options”.

  • COMPRESSION

    The compression algorithm used for page level compression forInnoDB tables. Supported values includeZlib,LZ4, andNone. TheCOMPRESSION attribute was introduced with the transparent page compression feature. Page compression is only supported withInnoDB tables that reside infile-per-table tablespaces, and is only available on Linux and Windows platforms that support sparse files and hole punching. For more information, seeSection 17.9.2, “InnoDB Page Compression”.

  • CONNECTION

    The connection string for aFEDERATED table.

    Note

    Older versions of MySQL used aCOMMENT option for the connection string.

  • DATA DIRECTORY,INDEX DIRECTORY

    ForInnoDB, theDATA DIRECTORY='directory' clause permits creating tables outside of the data directory. Theinnodb_file_per_table variable must be enabled to use theDATA DIRECTORY clause. The full directory path must be specified, and known toInnoDB. For more information, seeSection 17.6.1.2, “Creating Tables Externally”.

    When creatingMyISAM tables, you can use theDATA DIRECTORY='directory' clause, theINDEX DIRECTORY='directory' clause, or both. They specify where to put aMyISAM table's data file and index file, respectively. UnlikeInnoDB tables, MySQL does not create subdirectories that correspond to the database name when creating aMyISAM table with aDATA DIRECTORY orINDEX DIRECTORY option. Files are created in the directory that is specified.

    You must have theFILE privilege to use theDATA DIRECTORY orINDEX DIRECTORY table option.

    Important

    Table-levelDATA DIRECTORY andINDEX DIRECTORY options are ignored for partitioned tables. (Bug #32091)

    These options work only when you are not using the--skip-symbolic-links option. Your operating system must also have a working, thread-saferealpath() call. SeeSection 10.12.2.2, “Using Symbolic Links for MyISAM Tables on Unix”, for more complete information.

    If aMyISAM table is created with noDATA DIRECTORY option, the.MYD file is created in the database directory. By default, ifMyISAM finds an existing.MYD file in this case, it overwrites it. The same applies to.MYI files for tables created with noINDEX DIRECTORY option. To suppress this behavior, start the server with the--keep_files_on_create option, in which caseMyISAM does not overwrite existing files and returns an error instead.

    If aMyISAM table is created with aDATA DIRECTORY orINDEX DIRECTORY option and an existing.MYD or.MYI file is found,MyISAM always returns an error, and does not overwrite a file in the specified directory.

    Important

    You cannot use path names that contain the MySQL data directory withDATA DIRECTORY orINDEX DIRECTORY. This includes partitioned tables and individual table partitions. (See Bug #32167.)

  • DELAY_KEY_WRITE

    Set this to 1 if you want to delay key updates for the table until the table is closed. See the description of thedelay_key_write system variable inSection 7.1.8, “Server System Variables”. (MyISAM only.)

  • ENCRYPTION

    TheENCRYPTION clause enables or disables page-level data encryption for anInnoDB table. A keyring plugin must be installed and configured before encryption can be enabled. TheENCRYPTION clause can be specified when creating a table in an a file-per-table tablespace, or when creating a table in a general tablespace.

    TheENCRYPTION option is supported only by theInnoDB storage engine; thus it works only if the default storage engine isInnoDB, or if theCREATE TABLE statement also specifiesENGINE=InnoDB. Otherwise the statement is rejected withER_CHECK_NOT_IMPLEMENTED.

    A table inherits the default schema encryption if anENCRYPTION clause is not specified. If thetable_encryption_privilege_check variable is enabled, theTABLE_ENCRYPTION_ADMIN privilege is required to create a table with anENCRYPTION clause setting that differs from the default schema encryption. When creating a table in a general tablespace, table and tablespace encryption must match.

    Specifying anENCRYPTION clause with a value other than'N' or'' is not permitted when using a storage engine that does not support encryption.

    For more information, seeSection 17.13, “InnoDB Data-at-Rest Encryption”.

  • TheENGINE_ATTRIBUTE andSECONDARY_ENGINE_ATTRIBUTE options 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_ATTRIBUTE andSECONDARY_ENGINE_ATTRIBUTE values can be repeated without error. In this case, the last specified value is used.

    ENGINE_ATTRIBUTE andSECONDARY_ENGINE_ATTRIBUTE values are not checked by the server, nor are they cleared when the table's storage engine is changed.

  • INSERT_METHOD

    If you want to insert data into aMERGE table, you must specify withINSERT_METHOD the table into which the row should be inserted.INSERT_METHOD is an option useful forMERGE tables only. Use a value ofFIRST orLAST to have inserts go to the first or last table, or a value ofNO to prevent inserts. SeeSection 18.7, “The MERGE Storage Engine”.

  • KEY_BLOCK_SIZE

    ForMyISAM tables,KEY_BLOCK_SIZE optionally 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_SIZE value specified for an individual index definition overrides the table-levelKEY_BLOCK_SIZE value.

    ForInnoDB tables,KEY_BLOCK_SIZE specifies thepage size in kilobytes to use forcompressedInnoDB tables. TheKEY_BLOCK_SIZE value is treated as a hint; a different size could be used byInnoDB if necessary.KEY_BLOCK_SIZE can only be less than or equal to theinnodb_page_size value. A value of 0 represents the default compressed page size, which is half of theinnodb_page_size value. Depending oninnodb_page_size, possibleKEY_BLOCK_SIZE values include 0, 1, 2, 4, 8, and 16. SeeSection 17.9.1, “InnoDB Table Compression” for more information.

    Oracle recommends enablinginnodb_strict_mode when specifyingKEY_BLOCK_SIZE forInnoDB tables. Wheninnodb_strict_mode is enabled, specifying an invalidKEY_BLOCK_SIZE value returns an error. Ifinnodb_strict_mode is disabled, an invalidKEY_BLOCK_SIZE value results in a warning, and theKEY_BLOCK_SIZE option is ignored.

    TheCreate_options column in response toSHOW TABLE STATUS reports the actualKEY_BLOCK_SIZE used by the table, as doesSHOW CREATE TABLE.

    InnoDB only supportsKEY_BLOCK_SIZE at the table level.

    KEY_BLOCK_SIZE is not supported with 32KB and 64KBinnodb_page_size values.InnoDB table compression does not support these pages sizes.

    InnoDB does not support theKEY_BLOCK_SIZE option when creating temporary tables.

  • MAX_ROWS

    The 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.

    Important

    The use ofMAX_ROWS withNDB tables 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; seeSetting NDB_TABLE options.

    TheNDB storage 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 thatNDB allocates sufficient number of index slots in the hash table used for storing hashes of the table's primary keys by settingMAX_ROWS = 2 *rows, whererows is the number of rows that you expect to insert into the table.

    The maximumMAX_ROWS value is 4294967295; larger values are truncated to this limit.

  • MIN_ROWS

    The minimum number of rows you plan to store in the table. TheMEMORY storage engine uses this option as a hint about memory use.

  • PACK_KEYS

    Takes effect only withMyISAM tables. 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 toDEFAULT tells the storage engine to pack only longCHAR,VARCHAR,BINARY, orVARBINARY columns.

    If you do not usePACK_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 followingsame keys usually only take two bytes (including the pointer to the row). Compare this to the ordinary case where the following keys takesstorage_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 haveNULL values. (In this case, the packed key length is stored in the same byte that is used to mark if a key isNULL.)

  • PASSWORD

    This option is unused.

  • ROW_FORMAT

    Defines the physical format in which the rows are stored.

    When creating a table withstrict 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 theRow_format column in response toSHOW TABLE STATUS. TheCreate_options column shows the row format that was specified in theCREATE TABLE statement, as doesSHOW CREATE TABLE.

    Row format choices differ depending on the storage engine used for the table.

    ForInnoDB tables:

    • The default row format is defined byinnodb_default_row_format, which has a default setting ofDYNAMIC. The default row format is used when theROW_FORMAT option is not defined or whenROW_FORMAT=DEFAULT is used.

      If theROW_FORMAT option is not defined, or ifROW_FORMAT=DEFAULT is 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, seeDefining the Row Format of a Table.

    • For more efficientInnoDB storage of data types, especiallyBLOB types, use theDYNAMIC. SeeDYNAMIC Row Format for requirements associated with theDYNAMIC row format.

    • To enable compression forInnoDB tables, specifyROW_FORMAT=COMPRESSED. TheROW_FORMAT=COMPRESSED option is not supported when creating temporary tables. SeeSection 17.9, “InnoDB Table and Page Compression” for requirements associated with theCOMPRESSED row format.

    • The row format used in older versions of MySQL can still be requested by specifying theREDUNDANT row format.

    • When you specify a non-defaultROW_FORMAT clause, consider also enabling theinnodb_strict_mode configuration option.

    • ROW_FORMAT=FIXED is not supported. IfROW_FORMAT=FIXED is specified whileinnodb_strict_mode is disabled,InnoDB issues a warning and assumesROW_FORMAT=DYNAMIC. IfROW_FORMAT=FIXED is specified whileinnodb_strict_mode is enabled, which is the default,InnoDB returns an error.

    • For additional information aboutInnoDB row formats, seeSection 17.10, “InnoDB Row Formats”.

    ForMyISAM tables, the option value can beFIXED orDYNAMIC for static or variable-length row format.myisampack sets the type toCOMPRESSED. SeeSection 18.2.3, “MyISAM Table Storage Formats”.

    ForNDB tables, the defaultROW_FORMAT isDYNAMIC.

  • START TRANSACTION

    This is an internal-use table option, used to permitCREATE TABLE ... SELECT to 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, andROLLBACK statements are permitted afterCREATE TABLE ... START TRANSACTION. For related information, seeSection 15.1.1, “Atomic Data Definition Statement Support”.

  • STATS_AUTO_RECALC

    Specifies whether to automatically recalculatepersistent statistics for anInnoDB table. The valueDEFAULT causes the persistent statistics setting for the table to be determined by theinnodb_stats_auto_recalc configuration option. The value1 causes statistics to be recalculated when 10% of the data in the table has changed. The value0 prevents automatic recalculation for this table; with this setting, issue anANALYZE TABLE statement to recalculate the statistics after making substantial changes to the table. For more information about the persistent statistics feature, seeSection 17.8.10.1, “Configuring Persistent Optimizer Statistics Parameters”.

  • STATS_PERSISTENT

    Specifies whether to enablepersistent statistics for anInnoDB table. The valueDEFAULT causes the persistent statistics setting for the table to be determined by theinnodb_stats_persistent configuration option. The value1 enables persistent statistics for the table, while the value0 turns off this feature. After enabling persistent statistics through aCREATE TABLE orALTER TABLE statement, issue anANALYZE TABLE statement to calculate the statistics, after loading representative data into the table. For more information about the persistent statistics feature, seeSection 17.8.10.1, “Configuring Persistent Optimizer Statistics Parameters”.

  • STATS_SAMPLE_PAGES

    The number of index pages to sample when estimating cardinality and other statistics for an indexed column, such as those calculated byANALYZE TABLE. For more information, seeSection 17.8.10.1, “Configuring Persistent Optimizer Statistics Parameters”.

  • TABLESPACE

    TheTABLESPACE clause can be used to create anInnoDB table in an existing general tablespace, a file-per-table tablespace, or the system tablespace.

    CREATE TABLEtbl_name ... TABLESPACE [=]tablespace_name

    The general tablespace that you specify must exist prior to using theTABLESPACE clause. For information about general tablespaces, seeSection 17.6.3.3, “General Tablespaces”.

    Thetablespace_name is a case-sensitive identifier. It may be quoted or unquoted. The forward slash character (/) is not permitted. Names beginning withinnodb_ are reserved for special use.

    To create a table in the system tablespace, specifyinnodb_system as the tablespace name.

    CREATE TABLEtbl_name ... TABLESPACE [=] innodb_system

    UsingTABLESPACE [=] innodb_system, you can place a table of any uncompressed row format in the system tablespace regardless of theinnodb_file_per_table setting. For example, you can add a table withROW_FORMAT=DYNAMIC to the system tablespace usingTABLESPACE [=] innodb_system.

    To create a table in a file-per-table tablespace, specifyinnodb_file_per_table as the tablespace name.

    CREATE TABLEtbl_name ... TABLESPACE [=] innodb_file_per_table
    Note

    Ifinnodb_file_per_table is enabled, you need not specifyTABLESPACE=innodb_file_per_table to create anInnoDB file-per-table tablespace.InnoDB tables are created in file-per-table tablespaces by default wheninnodb_file_per_table is enabled.

    TheDATA DIRECTORY clause is permitted withCREATE TABLE ... TABLESPACE=innodb_file_per_table but is otherwise not supported for use in combination with theTABLESPACE clause. The directory specified in aDATA DIRECTORY clause must be known toInnoDB. For more information, seeUsing the DATA DIRECTORY Clause.

    Note

    Support forTABLESPACE = innodb_file_per_table andTABLESPACE = innodb_temporary clauses withCREATE TEMPORARY TABLE is deprecated; expect it to be removed in a future version of MySQL.

    TheSTORAGE table option is employed only withNDB tables.STORAGE determines the type of storage used, and can be either ofDISK orMEMORY.

    TABLESPACE ... STORAGE DISK assigns a table to an NDB Cluster Disk Data tablespace.STORAGE DISK cannot be used inCREATE TABLE unless preceded byTABLESPACEtablespace_name.

    ForSTORAGE MEMORY, the tablespace name is optional, thus, you can useTABLESPACEtablespace_name STORAGE MEMORY or simplySTORAGE MEMORY to specify explicitly that the table is in-memory.

    SeeSection 25.6.11, “NDB Cluster Disk Data Tables”, for more information.

  • UNION

    Used to access a collection of identicalMyISAM tables as one. This works only withMERGE tables. SeeSection 18.7, “The MERGE Storage Engine”.

    You must haveSELECT,UPDATE, andDELETE privileges for the tables you map to aMERGE table.

    Note

    Formerly, all tables used had to be in the same database as theMERGE table itself. This restriction no longer applies.

Table Partitioning

partition_options can be used to control partitioning of the table created withCREATE TABLE.

Not all options shown in the syntax forpartition_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 seeChapter 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, seeSection 15.1.9, “ALTER TABLE Statement”. For more detailed descriptions and examples, seeSection 26.3, “Partition Management”.

  • PARTITION BY

    If used, apartition_options clause 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, wherenum is 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.)

    Note

    The expression (expr) used in aPARTITION BY clause 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.expr is 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 TABLE statements 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 eitherVALUES LESS THAN orVALUES IN clauses withPARTITION BY HASH.

    PARTITION BY HASH uses the remainder ofexpr divided by the number of partitions (that is, the modulus). For examples and additional information, seeSection 26.2.4, “HASH Partitioning”.

    TheLINEAR keyword 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 logicalAND operations. For discussion and examples of linear hashing, seeSection 26.2.4.1, “LINEAR HASH Partitioning”.

  • KEY(column_list)

    This is similar toHASH, except that MySQL supplies the hashing function so as to guarantee an even data distribution. Thecolumn_list argument 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 theLINEAR keyword. 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 (seeSection 26.2.4.1, “LINEAR HASH Partitioning”, andSection 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;

    TheALGORITHM={1 | 2} option is supported with[SUB]PARTITION BY [LINEAR] KEY.ALGORITHM=1 causes the server to use the same key-hashing functions as MySQL 5.1;ALGORITHM=2 means that the server employs the key-hashing functions implemented and used by default for newKEY partitioned 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] KEY partitioned tables between MySQL 5.1 and later MySQL versions, or for creating tables partitioned byKEY orLINEAR KEY on a MySQL 5.5 or later server which can be used on a MySQL 5.1 server. For more information, seeSection 15.1.9.1, “ALTER TABLE Partition Operations”.

    mysqldump writes this option encased in versioned comments.

    ALGORITHM=1 is shown when necessary in the output ofSHOW CREATE TABLE using versioned comments in the same manner asmysqldump.ALGORITHM=2 is always omitted fromSHOW CREATE TABLE output, even if this option was specified when creating the original table.

    You may not use eitherVALUES LESS THAN orVALUES IN clauses withPARTITION BY KEY.

  • RANGE(expr)

    In this case,expr shows a range of values using a set ofVALUES LESS THAN operators. When using range partitioning, you must define at least one partition usingVALUES LESS THAN. You cannot useVALUES IN with range partitioning.

    Note

    For tables partitioned byRANGE,VALUES LESS THAN must be used with either an integer literal value or an expression that evaluates to a single integer value. In MySQL 9.2, 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:
    01990 and earlier
    11991 to 1994
    21995 to 1998
    31999 to 2002
    42003 to 2005
    52006 and later

    A table implementing such a partitioning scheme can be realized by theCREATE TABLE statement 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 MAXVALUE works to specifyleftover values that are greater than the maximum value otherwise specified.

    VALUES LESS THAN clauses work sequentially in a manner similar to that of thecase portions of aswitch ... case block (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 THAN is greater than that of the previous one, with the one referencingMAXVALUE coming last of all in the list.

  • RANGE COLUMNS(column_list)

    This variant onRANGE facilitates partition pruning for queries using range conditions on multiple columns (that is, having conditions such asWHERE a = 1 AND b < 10 orWHERE 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 theCOLUMNS clause and a set of column values in eachPARTITION ... VALUES LESS THAN (value_list) partition definition clause. (In the simplest case, this set consists of a single column.) The maximum number of columns that can be referenced in thecolumn_list andvalue_list is 16.

    Thecolumn_list used in theCOLUMNS clause 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 theCOLUMNS clause.

    TheVALUES LESS THAN clause 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 THAN clause must contain the same number of values as there are columns listed in theCOLUMNS clause. An attempt to use more or fewer values in aVALUES LESS THAN clause than there are in theCOLUMNS clause causes the statement to fail with the errorInconsistency in usage of column lists for partitioning.... You cannot useNULL for any value appearing inVALUES LESS THAN. It is possible to useMAXVALUE more 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 aVALUES LESS THAN value 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 numeral1 instead), nor can you use the numeral1 for 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, seeSection 26.2.1, “RANGE Partitioning”, andSection 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 toRANGE, except that onlyVALUES IN may be used to specify permissible values for each partition.

    VALUES IN is 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 usingVALUES IN. You cannot useVALUES LESS THAN withPARTITION BY LIST.

    Note

    For tables partitioned byLIST, the value list used withVALUES IN must consist of integer values only. In MySQL 9.2, you can overcome this limitation using partitioning byLIST COLUMNS, which is described later in this section.

  • LIST COLUMNS(column_list)

    This variant onLIST facilitates partition pruning for queries using comparison conditions on multiple columns (that is, having conditions such asWHERE a = 5 AND b = 5 orWHERE a = 1 AND b = 10 AND c = 5). It enables you to specify values in multiple columns by using a list of columns in theCOLUMNS clause and a set of column values in eachPARTITION ... VALUES IN (value_list) partition definition clause.

    The rules governing regarding data types for the column list used inLIST COLUMNS(column_list) and the value list used inVALUES IN(value_list) are the same as those for the column list used inRANGE COLUMNS(column_list) and the value list used inVALUES LESS THAN(value_list), respectively, except that in theVALUES IN clause,MAXVALUE is not permitted, and you may useNULL.

    There is one important difference between the list of values used forVALUES IN withPARTITION BY LIST COLUMNS as opposed to when it is used withPARTITION BY LIST. When used withPARTITION BY LIST COLUMNS, each element in theVALUES IN clause must be aset of column values; the number of values in each set must be the same as the number of columns used in theCOLUMNS clause, 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_list and in the elements making up thevalue_list is 16.

    The table defined by the followingCREATE TABLE statement provides an example of a table usingLIST COLUMNS partitioning:

    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) ));
  • PARTITIONSnum

    The number of partitions may optionally be specified with aPARTITIONSnum clause, wherenum is the number of partitions. If both this clauseand anyPARTITION clauses are used,num must be equal to the total number of any partitions that are declared usingPARTITION clauses.

    Note

    Whether or not you use aPARTITIONS clause in creating a table that is partitioned byRANGE orLIST, you must still include at least onePARTITION VALUES clause in the table definition (see below).

  • SUBPARTITION BY

    A partition may optionally be divided into a number of subpartitions. This can be indicated by using the optionalSUBPARTITION BY clause. Subpartitioning may be done byHASH orKEY. 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 byLIST orRANGE.)

    The number of subpartitions can be indicated using theSUBPARTITIONS keyword followed by an integer value.

  • Rigorous checking of the value used inPARTITIONS orSUBPARTITIONS clauses 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+01 is not permitted, even though0.2E+01 evaluates to2. (Bug #15890)

  • partition_definition

    Each partition may be individually defined using apartition_definition clause. The individual parts making up this clause are as follows:

    • PARTITIONpartition_name

      Specifies a logical name for the partition.

    • VALUES

      For range partitioning, each partition must include aVALUES LESS THAN clause; for list partitioning, you must specify aVALUES IN clause for each partition. This is used to determine which rows are to be stored in this partition. See the discussions of partitioning types inChapter 26,Partitioning, for syntax examples.

    • [STORAGE] ENGINE

      MySQL accepts a[STORAGE] ENGINE option for bothPARTITION andSUBPARTITION. 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 errorERROR 1469 (HY000): The mix of handlers in the partitions is not permitted in this version of MySQL.

    • COMMENT

      An optionalCOMMENT clause 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 DIRECTORY andINDEX DIRECTORY

      DATA DIRECTORY andINDEX DIRECTORY may be used to indicate the directory where, respectively, the data and indexes for this partition are to be stored. Both thedata_dir and theindex_dir must be absolute system path names.

      The directory specified in aDATA DIRECTORY clause must be known toInnoDB. For more information, seeUsing the DATA DIRECTORY Clause.

      You must have theFILE privilege to use theDATA DIRECTORY orINDEX DIRECTORY partition 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 DIRECTORY andINDEX DIRECTORY behave in the same way as in theCREATE TABLE statement'stable_option clause as used forMyISAM tables.

      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.

      TheDATA DIRECTORY andINDEX DIRECTORY options are ignored for creating partitioned tables ifNO_DIR_IN_CREATE is in effect.

    • MAX_ROWS andMIN_ROWS

      May be used to specify, respectively, the maximum and minimum number of rows to be stored in the partition. The values formax_number_of_rows andmin_number_of_rows must be positive integers. As with the table-level options with the same names, these act only assuggestions to the server and are not hard limits.

    • TABLESPACE

      May be used to designate anInnoDB file-per-table tablespace for the partition by specifyingTABLESPACE `innodb_file_per_table`. All partitions must belong to the same storage engine.

      PlacingInnoDB table partitions in sharedInnoDB tablespaces is not supported. Shared tablespaces include theInnoDB system tablespace and general tablespaces.

  • subpartition_definition

    The partition definition may optionally contain one or moresubpartition_definition clauses. Each of these consists at a minimum of theSUBPARTITIONname, wherename is an identifier for the subpartition. Except for the replacement of thePARTITION keyword withSUBPARTITION, the syntax for a subpartition definition is identical to that for a partition definition.

    Subpartitioning must be done byHASH orKEY, and can be done only onRANGE orLIST partitions. SeeSection 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 (seeSection 26.6.3, “Partitioning Limitations Relating to Functions”). The preceding example demonstrates this technique:EXP() cannot be used directly in thePARTITION BY clause, but a generated column defined usingEXP() is permitted.