_______  .___ _______        ____.  _____   
 \      \ |   |\      \      |    | /  _  \  
 /   |   \|   |/   |   \     |    |/  /_\  \
/    |    \   /    |    \/\__|    /    |    \
\____|__  /___\____|__  /\________\____|__  /
     web\/framework   \/                  \/

Ebean support for Ninja

Ebean is a simple and powerful ORM tool. This plugin allows to use Ebean in any Ninja application.

More

• Source: https://github.com/ninjaframework/ninja
• Continuous integration:

Getting started

Configuring the module for your application is quite easy. There is a demo application that shows you how to do it. Check out subproject ninja-ebean-demo/pom.xml for further information.

More about Ebean: https://ebean.io/

Overview

This module works with the Ebean version 12 (if you use ninja-ebean-module) OR 14+ (if you use ninja-ebean15-module).

If you need compatibility with earlier versions of Ebean please see v2.0.0 which supports a minimum Ebean version v3.2.5, and has also been tested with the later versions in the 6.x-8.x series.

If you need compatibility with earlier versions of Ebean please see v1.5.1 which supports a minimum Ebean version v3.2.5, and has also been tested with the later versions in the 4.x series.

NOTE: This module only supports a single (default) Ebean server. Feel free to contribute code to the project if you need other features. Thanks!

Upgrading from Ebean 12 to v14+

In version 12 of ebean, your code will interact primarily with an EbeanServer. In version 14+, this class was deprecated and was renamed to Database. The methods are generally the same, although many previous deprecated methods were removed, so you may need to update your code.

Also, and this is very important, your entity classes must use jakarta.persistence.Entity instead of the old javax.persistence.Entity. If you don't change to jakarta your entities will NOT be found and you'll end up with runtime errors.

Setup

1. Add your db conf to your application.conf file. For a simple H2 database:

   ebean.datasource.databaseUrl=jdbc:h2:testdatabase:tests;DB_CLOSE_DELAY=-1;AUTO_SERVER=TRUE

For a MySQL database (you'll also need to add the MySQL driver dependency to your project)

ebean.ddl.generate = false
ebean.ddl.run = false
ebean.models = com.company.models.*,org.otherorg.models.Foo
ebean.datasource.name = NameOfEbeanServer
ebean.datasource.databaseUrl = jdbc:mysql://localhost:3306/dbname
ebean.datasource.databaseDriver = com.mysql.jdbc.Driver
ebean.datasource.username = root
ebean.datasource.password = test

Please note that ebean.models accepts a comma delimited list of both class names as well as packages (just make sure it ends with .*)

2. For Ebean v12, add the ninja-ebean-module dependency to your pom.xml:

   org.ninjaframework ninja-ebean-module 4.0.0

Or for Ebean v14+, add the ninja-ebean15-module dependency to your pom.xml:

<dependency>
    <groupId>org.ninjaframework</groupId>
    <artifactId>ninja-ebean15-module</artifactId>
    <version>4.0.0</version>
</dependency>

3. Add ebean's enhancer plugin to your pom.xml:

   io.ebean ebean-maven-plugin 12.1.1 ebean-enhancer process-classes ${project.build.outputDirectory} models debug=1 enhance

4. Install the module in your conf.Module:

   protected void configure() {

    // This installs the NinjaModule and handles the lifecycle
    install(new NinjaEbeanModule());
   

   }

And that's it already :)

Releasing (committers only)

Make sure you got gpg installed on your machine. Gpg is as good as gpg2, so there's not much difference. But the gpg plugin in maven works better with gpg, so we go with that one

brew install gpg

Make sure to create a key

gpg --gen-key

Then list the keys and send the public key to a keyserver so that people can verify that it's you:

gpg --keyserver hkp://pool.sks-keyservers.net --send-keys YOUR_PUBLIC_KEY

Make sure to set

export GPG_TTY=$(tty)

... that way any input of gpg will be properly shown (entering your passphrase for instance)...

Make sure you set the sonatype credentials in your ~/.m2/settings.xml:

<settings>

  <servers>
    <server>
      <id>ossrh</id>
      <username>USERNAME</username>
      <password>PASSWORD</password>
    </server>
  </servers>

</settings>

Then you can create a new release like so:

mvn release:clean -Prelease
mvn release:prepare -Prelease
mvn release:perform -Prelease