JarCastingsql-execute-maven-plugin
A maven plugin for executing single sql queries or sql files on a database
Usage
The below example is using MariaDB as an example. The plugin however supports also MySQL and PostgreSQL. See example module for more details.
<project>
[...]
<build>
<plugins>
<plugin>
<groupId>com.ragedunicorn.tools.maven</groupId>
<artifactId>sql-execute-maven-plugin</artifactId>
<version>[version]</version>
<dependencies>
<!-- mariadbdriver -->
<dependency>
<groupId>org.mariadb.jdbc</groupId>
<artifactId>mariadb-java-client</artifactId>
<version>2.0.3</version>
</dependency>
</dependencies>
<configuration>
<driver>org.mariadb.jdbc</driver>
<url>jdbc:mariadb://localhost:3306/</url>
<server>[server]</server>
</configuration>
<executions>
<execution>
<id>execute-query</id>
<phase>install</phase>
<goals>
<goal>sql-execute</goal>
</goals>
<configuration>
<sqlQuery>DROP SCHEMA IF EXISTS world_test</sqlQuery>
</configuration>
</execution>
<execution>
<id>execute-file</id>
<phase>install</phase>
<goals>
<goal>sql-execute</goal>
</goals>
<configuration>
<sqlFiles>
<sqlFiles>src/main/resources/[file].sql</sqlFiles>
</sqlFiles>
</configuration>
</execution>
</executions>
</plugin>
</plugins>
</build>
[...]
</project>
| Parameter | Required | Default Value | Description |
|---|---|---|---|
| driver | true | <> | The database driver to use |
| url | true | <> | Connection string for the database |
| user | false | <> | User to use to connect to the database - overwritten by server |
| password | false | <> | Password to use to connect to the database - overwritten by server |
| server | false | <> | References a server configuration in your .m2 settings.xml. This is the preferred way for storing credentials |
| sqlQuery | false | <> | An sql query to execute |
| sqlFiles | false | <> | A list of one or more sql files to execute |
Driver Dependencies
MariaDB
<dependency>
<groupId>org.mariadb.jdbc</groupId>
<artifactId>mariadb-java-client</artifactId>
<version>2.0.3</version>
</dependency>
MySQL
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.12</version>
</dependency>
PostgreSQL
<dependency>
<groupId>org.postgresql</groupId>
<artifactId>postgresql</artifactId>
<version>42.2.5</version>
</dependency>
Note: Feel free to use a newer version of the drivers. The above versions are the last used versions for testing.
Credentials
The plugin allows to either add database credentials directly into the plugin configuration or storing the in your maven settings.xml. The later should usually be preferred.
In settings.xml add a new server entry.
<server>
<id>some-database</id>
<username>app</username>
<password>app</password>
</server>
Then in the plugin configuration reference the server.
<configuration>
[...]
<server>somedatabase</server>
[...]
</configuration>
Or add the credentials directly into the plugin configuration.
<configuration>
[...]
<user>app</user>
<password>app</password>
[...]
</configuration>
Development
IntelliJ Run Configurations
The project contains IntelliJ run configurations that can be used for most tasks. Create a folder runConfigurations inside the .idea folder and copy over all run configurations.
Build Project
sql-execute-maven-plugin
clean install
Create a Release
In maven settings.xml configure the ossrh account
<server>
<id>ossrh</id>
<username></username>
<password></password>
</server>
Build and Release
mvn clean deploy -P deploy
Move Staging to Release
If autoReleaseAfterClose is set to false in the nexus-staging-maven-plugin plugin an additional step is required to move the deployment from staging to release.
mvn nexus-staging:release
Or if the deployment didn't workout you can drop the artifact from the staging repository.
mvn nexus-staging:drop
Note: On MacOS the error gpg: signing failed: Inappropriate ioctl for device can be solved by setting the tty export variable for gpg.
export GPG_TTY=$(tty)
If you are using the IntelliJ console this might need to be set directly in that console.
Docker
This project contains docker-compose files for testing and trying out for all supported databases. When using the dev variant of the docker-compose files you have to connect to the container and manually start the process by running the docker-entrypoint.sh script.
To start the containers either use the command line or the prepared docker run configurations if you are using intellij.
docker-compose -f [docker-compose-file] -d
Note: The MySQL and MariaDB container use the same ports and thus cannot be run at the same time.
License
Copyright (c) 2020 Michael Wiesendanger
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.