Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add handling for adding/modifying columns with FIRST/AFTER #147

Merged
merged 4 commits into from
Aug 7, 2024
Merged

Add handling for adding/modifying columns with FIRST/AFTER #147

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3f4246c
Add handling for adding/modifying columns with FIRST/AFTER
JanJakes Aug 7, 2024
c4efdfd
Add table structure assertion
JanJakes Aug 7, 2024
4615adc
Add more table structure assertion, unify defaults
JanJakes Aug 7, 2024
31ecd65
Add test for adding and modifying multiple columns with FIRST/AFTER
JanJakes Aug 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions tests/WP_SQLite_Translator_Tests.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1027,6 +1027,31 @@ public function testAlterTableAddNotNullVarcharColumn() {
);
}

public function testAlterTableWithColumnFirstAndAfter() {
$this->assertQuery(
"CREATE TABLE _tmp_table (
id int(11) NOT NULL,
name varchar(20) NOT NULL default ''
);"
);

$this->assertQuery(
"ALTER TABLE _tmp_table ADD COLUMN new_first_column VARCHAR(255) NOT NULL DEFAULT '' FIRST"
);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to also make assertions about the resulting table structure like this:

sqlite-database-integration/tests/WP_SQLite_Translator_Tests.php

Lines 885 to 907 in dea3efd

$this->assertQuery( 'DESCRIBE _tmp_table;' );
$results = $this->engine->get_query_results();
$this->assertEquals(
array(
(object) array(
'Field' => 'name',
'Type' => 'varchar(20)',
'Null' => 'NO',
'Key' => '',
'Default' => '',
'Extra' => '',
),
(object) array(
'Field' => 'column',
'Type' => 'int',
'Null' => 'YES',
'Key' => '',
'Default' => null,
'Extra' => '',
),
),
$results
);

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Added in c4efdfd.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Let's add them after each assertQuery() here to check each is doing what is expected.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK! Added in 4615adc.


$this->assertQuery(
"ALTER TABLE _tmp_table ADD COLUMN new_column VARCHAR(255) NOT NULL DEFAULT '' AFTER id"
);

$this->assertQuery(
"ALTER TABLE _tmp_table CHANGE id id int(11) NOT NULL DEFAULT '' FIRST"
);

$this->assertQuery(
"ALTER TABLE _tmp_table CHANGE id id int(11) NOT NULL DEFAULT '' AFTER name"
);
}

public function testAlterTableAddIndex() {
$result = $this->assertQuery(
"CREATE TABLE _tmp_table (
Expand Down
29 changes: 29 additions & 0 deletions wp-includes/sqlite/class-wp-sqlite-translator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2939,6 +2939,35 @@ private function execute_alter() {
WP_SQLite_Token::FLAG_KEYWORD_DATA_TYPE
)
);

// Drop "FIRST" and "AFTER <another-column>", as these are not supported in SQLite.
$column_position = $this->rewriter->peek(
array(
'type' => WP_SQLite_Token::TYPE_KEYWORD,
'value' => array( 'FIRST', 'AFTER' ),
)
);

$comma = $this->rewriter->peek(
array(
'type' => WP_SQLite_Token::TYPE_OPERATOR,
'value' => ',',
)
);

if ( $column_position && ( ! $comma || $column_position->position < $comma->position ) ) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What kind of SQL syntax is this comma check intended to address? Could you provide an example?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@brandonpayton Without the check, it can consume too much, up to the following column definitions.

E.g., for a query like this one:

ALTER TABLE _tmp_table
ADD COLUMN new1 VARCHAR(255),
ADD COLUMN new2 VARCHAR(255) FIRST

You would get a SQLSTATE[HY000]: General error: 1 near ",": syntax error., since you've consumed up to FIRST from the second column when processing the first column.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, I see. I hadn't noticed that the translator loops to support the comma-separated MySQL ALTER TABLE syntax.

Let's add a test for comma-separated syntax as well.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for explaining!

Copy link
Collaborator Author

@JanJakes JanJakes Aug 7, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a test in 31ecd65.

$this->rewriter->consume(
array(
'type' => WP_SQLite_Token::TYPE_KEYWORD,
'value' => array( 'FIRST', 'AFTER' ),
)
);
$this->rewriter->drop_last();
if ( 'AFTER' === strtoupper( $column_position->value ) ) {
$this->rewriter->skip();
}
}

$this->update_data_type_cache(
$this->table_name,
$column_name,
Expand Down
Loading