<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[39921] trunk: dbDelta: Ignore index subparts when checking for duplicate indices.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/39921">39921</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/39921","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>pento</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-01-17 04:00:09 +0000 (Tue, 17 Jan 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>dbDelta: Ignore index subparts when checking for duplicate indices.
If index lengths change in table definitions, we don't recreate the index - instead, we throw a database error, as `dbDelta()` tries to create a new index with the same name.
It's better to leave the index as is, MySQL doesn't have an efficient process for resizing indices, and dropping/creating is a slow process which we don't want to trigger automatically.
Fixes <a href="https://core.trac.wordpress.org/ticket/34870">#34870</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesupgradephp">trunk/src/wp-admin/includes/upgrade.php</a></li>
<li><a href="#trunktestsphpunittestsdbdeltaphp">trunk/tests/phpunit/tests/dbdelta.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesupgradephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/upgrade.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/upgrade.php 2017-01-17 03:52:24 UTC (rev 39920)
+++ trunk/src/wp-admin/includes/upgrade.php 2017-01-17 04:00:09 UTC (rev 39921)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2216,7 +2216,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Clear the field and index arrays.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $cfields = $indices = array();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $cfields = $indices = $indices_without_subparts = array();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Get all of the field names in the query from between the parentheses.
</span><span class="cx" style="display: block; padding: 0 10px"> preg_match("|\((.*)\)|ms", $qry, $match2);
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2289,10 +2289,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $index_name = ( 'PRIMARY KEY' === $index_type ) ? '' : '`' . strtolower( $index_matches['index_name'] ) . '`';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Parse the columns. Multiple columns are separated by a comma.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $index_columns = array_map( 'trim', explode( ',', $index_matches['index_columns'] ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $index_columns = $index_columns_without_subparts = array_map( 'trim', explode( ',', $index_matches['index_columns'] ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Normalize columns.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $index_columns as &$index_column ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ foreach ( $index_columns as $id => &$index_column ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> // Extract column name and number of indexed characters (sub_part).
</span><span class="cx" style="display: block; padding: 0 10px"> preg_match(
</span><span class="cx" style="display: block; padding: 0 10px"> '/'
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2319,6 +2319,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Escape the column name with backticks.
</span><span class="cx" style="display: block; padding: 0 10px"> $index_column = '`' . $index_column_matches['column_name'] . '`';
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // We don't need to add the subpart to $index_columns_without_subparts
+ $index_columns_without_subparts[ $id ] = $index_column;
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Append the optional sup part with the number of indexed characters.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $index_column_matches['sub_part'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $index_column .= '(' . $index_column_matches['sub_part'] . ')';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2327,9 +2330,10 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Build the normalized index definition and add it to the list of indices.
</span><span class="cx" style="display: block; padding: 0 10px"> $indices[] = "{$index_type} {$index_name} (" . implode( ',', $index_columns ) . ")";
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $indices_without_subparts[] = "{$index_type} {$index_name} (" . implode( ',', $index_columns_without_subparts ) . ")";
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Destroy no longer needed variables.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- unset( $index_column, $index_column_matches, $index_matches, $index_type, $index_name, $index_columns );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ unset( $index_column, $index_column_matches, $index_matches, $index_type, $index_name, $index_columns, $index_columns_without_subparts );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> break;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2446,25 +2450,16 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add the field to the column list string.
</span><span class="cx" style="display: block; padding: 0 10px"> $index_columns .= '`' . $column_data['fieldname'] . '`';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ($column_data['subpart'] != '') {
- $index_columns .= '('.$column_data['subpart'].')';
- }
</del><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // The alternative index string doesn't care about subparts
- $alt_index_columns = preg_replace( '/\([^)]*\)/', '', $index_columns );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Add the column list to the index create string.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $index_strings = array(
- "$index_string ($index_columns)",
- "$index_string ($alt_index_columns)",
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $index_string .= " ($index_columns)";
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- foreach ( $index_strings as $index_string ) {
- if ( ! ( ( $aindex = array_search( $index_string, $indices ) ) === false ) ) {
- unset( $indices[ $aindex ] );
- break;
- }
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Check if the index definition exists, ignoring subparts.
+ if ( ! ( ( $aindex = array_search( $index_string, $indices_without_subparts ) ) === false ) ) {
+ // If the index already exists (even with different subparts), we don't need to create it.
+ unset( $indices_without_subparts[ $aindex ] );
+ unset( $indices[ $aindex ] );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre></div>
<a id="trunktestsphpunittestsdbdeltaphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/dbdelta.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/dbdelta.php 2017-01-17 03:52:24 UTC (rev 39920)
+++ trunk/tests/phpunit/tests/dbdelta.php 2017-01-17 04:00:09 UTC (rev 39921)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -826,6 +826,106 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @ticket 34870
+ */
+ function test_unchanged_key_lengths_do_not_recreate_index() {
+ global $wpdb;
+
+ $updates = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 text,
+ column_3 blob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1(255)),
+ KEY compound_key (id,column_1),
+ FULLTEXT KEY fulltext_key (column_1)
+ ) ENGINE=MyISAM
+ ", false );
+
+ $this->assertEmpty( $updates );
+ }
+
+ /**
+ * @ticket 34870
+ */
+ function test_changed_key_lengths_do_not_recreate_index() {
+ global $wpdb;
+
+ $updates = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 text,
+ column_3 blob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1),
+ KEY changing_key_length (column_1(20)),
+ FULLTEXT KEY fulltext_key (column_1)
+ ) ENGINE=MyISAM
+ " );
+
+ $this->assertSame( array(
+ "Added index {$wpdb->prefix}dbdelta_test KEY `changing_key_length` (`column_1`(20))"
+ ), $updates );
+
+ $updates = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 text,
+ column_3 blob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1),
+ KEY changing_key_length (column_1(50)),
+ FULLTEXT KEY fulltext_key (column_1)
+ ) ENGINE=MyISAM
+ " );
+
+ $this->assertEmpty( $updates );
+
+ $updates = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 text,
+ column_3 blob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1),
+ KEY changing_key_length (column_1(1)),
+ FULLTEXT KEY fulltext_key (column_1)
+ ) ENGINE=MyISAM
+ " );
+
+ $this->assertEmpty( $updates );
+
+ $updates = dbDelta(
+ "
+ CREATE TABLE {$wpdb->prefix}dbdelta_test (
+ id bigint(20) NOT NULL AUTO_INCREMENT,
+ column_1 varchar(255) NOT NULL,
+ column_2 text,
+ column_3 blob,
+ PRIMARY KEY (id),
+ KEY key_1 (column_1),
+ KEY compound_key (id,column_1),
+ KEY changing_key_length (column_1),
+ FULLTEXT KEY fulltext_key (column_1)
+ ) ENGINE=MyISAM
+ " );
+
+ $this->assertEmpty( $updates );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * @ticket 31679
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function test_column_type_change_with_hyphens_in_name() {
</span></span></pre>
</div>
</div>
</body>
</html>