JHipster, Liquibase, MySQL, and initializing data, including booleans!

When generating a data model from JHipster JDL, we will often declare entities with Boolean fields.  I have so far abandoned H2 as a database because of liquibase issues, and both my dev and production databases will be MySQL.  This is relevant to the Boolean field desire there is a long history in software development of how to store Boolean data types in a SQL database whose standards classically do not support Boolean.

In the current JHipster/Liquibase incarnation, tables in MySQL are generated for us, which is really nice.  The Boolean data types are stored as BIT (1).  This is not a problem so far -- most developers seem to agree now that as a best practice, we should store values in databases as false = 0 and true = 1, and a BIT(1) is a great, simple way to do that.

An issue arises when we try to use liquibase to set/update our database to the desired starting state.  For my project, I've chosen gradle instead of maven as a build tool, and gradle has a plugin for liquibase.  (JHipster automatically includes it, hurray!)  To update my database to create tables as well as initialize data into those tables, I have to:

1. add more CSV files into the /main/resources/config/liquibase directory for each table that needs initial data.
2. modify the associated table's XML file so that it includes a loadData element to find and insert the data in the CSV.
3. run the liquibaseUpdate gradle target

As I tried to do these things, I ran into problems.

Problem #1: Database connection information

Spring boot allows me to differentiate environments using different application property files.  JHipster helps with this by automatically generating YML files -- one for dev and one for prod.  The problem is that updating these files is not enough.  Liquibase is separate/distinct from spring boot, and it uses connection information inside of the gradle targets, so I had to update the connection information in the liquibase activities main and diffLog settings, including url, username, password, and defaultSchemaName.  Once I made these updates, the connection worked.

url 'jdbc:mysql://<URL/IP CONNECTION INFO>:3306'
username 'username'

password 'password'

defaultSchemaName '<DATABASE SCHEMA/NAME>'

Problem #2: Boolean data as BIT values

In the second point, I ran into errors because the data in the CSV for boolean fields were being read as strings instead of as bits/booleans.  As a result, I had to specify that the columns were type="boolean" so that liquibase would know that the values in the CSV were bits, not strings.  The loadData element looks like this:

<loadData encoding="UTF-8" 

        file="config/liquibase/TABLE_FILE_NAME.csv" 

        separator=";" 

        tableName="TABLE_NAME"> 

    <column name="BOOLEAN_COLUMN_NAME_1" type="boolean"/> 

    <column name="BOOLEAN_COLUMN_NAME_2" type="boolean"/>

</loadData>

At this point, I delete all tables in the database and run the liquibaseUpdate gradle target (I typically do this via my IDE's gradle tool), and my database now has all of the tables and data I want.