Java, MySQL: Is there a way to embed a MySQL server with a Java program?

Question

One thing I love about .NET is the ability to have a database file along with the project. I know that using a SQLite database, this can be done, but did someone achieve this with a MySQL database backend?

So for instance, if I run a java program, it should be able to start its own mini MySQL server and manipulate data. So essentially, I want the same flow as with a SQLite but I need the power of MySQL.

Apache Derby(JavaDB) is extremely easy to embed in a java application and it works quite well. — ChadNC, Nov 24 '09 at 17:11
Thanks.. I'll look into that. I have a lot of scripts that work with MySQL currently. Would you happen to know if it is easy enough to convert JavaDB into a MySQL Database? — Legend, Nov 24 '09 at 17:14
HSQLDB is also easy, for that matter. But the question is about MySQL :) — Bozho, Nov 24 '09 at 17:18
Now in 2018 there are some perfect options. Check my answer for more information about these. — Simon Baars, Apr 03 '18 at 14:23

Simon Baars · Answer 1 · 2021-01-05T11:01:13.060

If you don't mind using MariaDB (the open source variant of MySQL, basically works the same) MariaDB4j can be the perfect option for production enviroments.

MariaDB4j is a Java (!) "launcher" for MariaDB (the "backward compatible, drop-in replacement of the MySQL(R) Database Server", see FAQ and Wikipedia), allowing you to use MariaDB (MySQL(R)) from Java without ANY installation / external dependencies. Read again: You do NOT have to have MariaDB binaries installed on your system to use MariaDB4j!

As it works completely without any requirements that have to be on the users' pc it is probably the best option to get MySQL embedded. Converting a project that doesn't use an Embedded database into MariaDB4j is as easy as calling:

DB db = DB.newEmbeddedDB(3306);

Read the github page for more information. Maven central dependency is:

<dependency>
    <groupId>ch.vorburger.mariaDB4j</groupId>
    <artifactId>mariaDB4j</artifactId>
    <version>2.2.3</version>
</dependency>

You can combine this with the newest driver to get access to all functionality of MySQL 8.0 (win64/win32=windows, mac64=macos, linux64=linux):

<dependency>
  <groupId>org.craftercms.mariaDB4j</groupId>
  <artifactId>mariaDB4j-db-win64</artifactId>
  <version>10.4.6.2</version>
</dependency>

If you do mind using MariaDB, another option is Wix Embedded MySQL.

Wix Embedded MySQL is a library that provides a way to run real MySql within integration tests.

Why?

Your tests can run on production-like environments: match version, encoding, timezone, database/schema/user settings;

Its easy, much easier than installing right version by hand;

You can use different versions/configuration per project without any local set-up;

Supports multiple platforms: Windows, Linux, and OSX;

Provides constantly updated multiple versions of MySql - 5.5, 5.6, 5.7, 8.0;

Testing matrix for all supported OSes (x86/x64) and versions (5.5, 5.6, 5.7, 8.0).

@LasithaWeerasinghe Not that I know of, but mariadb4j can be combined with a newer driver version to get the same functionality. I edited my post to show what you should add to `pom.xml` to get this newer driver. — Simon Baars, Sep 01 '19 at 14:21
It looks like MySQL 8.0 is supported since version 4.5.0 ([reference commit](https://github.com/wix/wix-embedded-mysql/commit/7b2143cea267396f526fc254add28d6634acb554)). — Robin, Oct 30 '20 at 14:05

score 18 · Answer 2 · answered Nov 24 '09 at 17:02

18

A quick search shows this: MySQL Connector/MXJ — for embedding MySQL server in Java applications on the MySQL Downloads page at:

http://dev.mysql.com/downloads/

answered Nov 24 '09 at 17:02

Legend

113,822
119
272
400

8

For anyone else reading this answer long after it was given, MXJ stopped development at MySQL version 5.1.40, Connector/J version 5.0.11. See http://dev.mysql.com/doc/connector-mxj/en/connector-mxj-versions.html – Peter Dolberg Sep 05 '13 at 12:54
@PeterDolberg are there alternative packages achieving a MySQL (embedded) to be run while JUnit testing? – TheConstructor Feb 20 '14 at 08:02
1

@TheConstructor Check my answer. Wix Embedded MySQL could be your solution. – Simon Baars Mar 29 '18 at 07:03

score 7 · Answer 3 · edited Feb 17 '14 at 15:36

7

For future reference to anyone looking to embed mysql, there is a utility from the mysql guys that does this http://downloads.mysql.com/archives/c-mxj/

edited Feb 17 '14 at 15:36

Guy Bouallet

2,099
11
16

answered Jul 30 '10 at 16:14

zcourts

4,863
6
49
74

2

Please note that development of MySQL Connector/MXJ has been discontinued. – Ron Klein Mar 31 '15 at 15:04
And what is the alternative for this ? is there any solution that can be freely embedded ? – Marouane Gazanayi Jul 12 '16 at 08:21

score 6 · Answer 4 · answered Nov 24 '09 at 17:12

6

It sounds like you want an embedded database. While MySQL Connector seems nice, it will launch a separate server process. If you want the database server to run in the Java virtual machine, there are several embedded databases for Java.

The two that I've seen used the most are:

Apache Derby / JavaDB
HSQL

answered Nov 24 '09 at 17:12

Steve K

19,408
6
52
50

7

I've had terrible experiences with depending on HSQL for testing a production system that uses Oracle. The differences in behavior results in test-specific hacks or worse, never-written test cases because it was too much trouble. I think it's more important than anything to create a test environment as close as possible to the real thing. Using some extra system resources is usually a very acceptable tradeoff. – oksayt Jun 27 '11 at 10:33

Java, MySQL: Is there a way to embed a MySQL server with a Java program?

4 Answers4

Linked

Related