Support Mysql Function Indexes

[nvoxland]

Description

Moved the "select the index metadata" SQL from the driver to our code so that we can also pull from the new column if we have a new enough database.

Fixes #1626 as well as generally snapshots indexes with functions correctly now.

Impact

On Mysql 8.0.13+ create a table and index like:

create table my_table (id int primary key, first_name varchar(50), last_name varchar(50));
create index idx_test on my_table((lower(first_name)));

When running liquibase snapshot you now see the idx_test index.

On older mysql versions, you can't create the index with the lower(first_name) function, but an index like create index idx_test on my_table(first_name); is still correctly found without a SQL error.

Because this snapshot functionality works now, the reported indexExists precondition works as well.

---

Dev Handoff Notes (Internal Use)

Links

• Fixed Issue: indexExists precondition not working for function index in MySQL 8 #1626
• Local Branch: https://github.com/liquibase/liquibase/tree/mysql-function-indexes
• Unit Tests: https://github.com/liquibase/liquibase/pull/2180/checks
• Integration Tests: (shown in Unit Tests link above)
• Functional Tests: https://jenkins.datical.net/job/liquibase-pro/job/mysql-function-indexes/

Testing

• Steps to Reproduce:
  • Snapshot steps above
  • indexExists precondition not working for function index in MySQL 8 #1626
• Guidance:
  • Impact: snapshotting of indexes on mysql
  • Logic is different between 8.0.13 and prior versions, so need to ensure both work

Dev Verification

Tested snapshot and precondition check on both the latest mysql 8 and 5.7 versions

Test Requirements (Liquibase Internal QA)

Testing this ticket requires a MySQL 5.7 instance and a MySQL 8 instance. One test case will require a Pro license to validate the JSON snapshot feature correctly gathers the function index.

Manual Tests

Setup the SQL in

• On a MySQL 8 database, execute the SQL in the attached lb2160-setup.sql.
• on a MySQL 5.7 database. execute the SQL in the attached lb2160-setup-mysql5.sql

Verify snapshot of a MySQL 8 database includes an index that uses a function.

liquibase --output-file mysql8-snapshot.txt snapshot

• Snapshot includes index idx_lb2160 on table lb2160

Pro: Verify JSON formatted snapshot of a MySQL 8 database includes the

liquibase --output-file mysql8-pro-snapshot.json snapshot --snapshot-format JSON

• Snapshot includes index idx_lb2160 on table lb2160

Verify validate of an indexExists precondition correctly identifies existence of an index that uses a function.

liquibase --log-level INFO validate--changelog-file lb2160-changelog.xml

• The indexExists precondition triggers.

Validation Error:
1 preconditions failed
lb2160-changelog.xml : index idx_lb2160 already exists
Liquibase command 'validate' was executed successfully.

**Automated Tests**

* No new functional test is required for this ticket.
* A new test harness test is required for this ticket. There is already a test for the MySQL 5.7 createIndex. The new test will be mySQL 8.0 specific as earlier versions of MySQL do not support creating indexes that use functions.
* Add an XML changelog with two changesets:
  * createTable
  * createIndex
  * Name your file createFunctionIndex.xml
  * liquibase-test-harness/main/src/main/resources/liquibase/harness/change/changelogs/mysql
* Add the JSON snapshot for test validation:
  * src/main/resources/liquibase/harness/change/expectedSnapshot/mysql/8
* Add the generated SQL for test validation:
  * src/main/resources/liquibase/harness/change/expectedSql/mysql/8.0
* Validate that Liquibase correctly generates SQL for MySQL indexes that use functions.



┆Issue is synchronized with this [Jira Bug](https://datical.atlassian.net/browse/LB-2160) by [Unito](https://www.unito.io)

[sync-by-unito]

➤ Kristyl Gomes commented:

Jack Odzhubeiskyi Surya Aki Erzsebet Carmean – the test-harness PR (liquibase/liquibase-test-harness#139 ( https://github.com/liquibase/liquibase-test-harness/pull/139|smart-link ) ) has been approved by me.

Please note that merging the test-harness PR will need to wait until the fix (#2180 ( #2180 )) is shipped with the next release of Liquibase Core, otherwise this test will fail.