Prerequisite - Java 11
Ebean 13+ requires Java 11. Please upgrade as soon as you can.
jakarta and javax persistence
Ebean 14.x/15.x use jakarta.persistence.
To use javax.persistence use Ebean version 14.x-javax.
Example projects
You can explore example Java projects for Maven, Gradle or example Kotlin projects using Maven or Gradle.
For other example projects like PostGIS etc goto /docs/examples.
Step-by-step guides (for AI agents and developers)
Prescriptive step-by-step guides for adding Ebean to an existing project are available in the Ebean GitHub repository. These guides are written to be followed by AI coding agents (Copilot, Cursor, Claude Code, etc.) as well as human developers.
- Add Ebean + PostgreSQL — Maven POM setup
- Database configuration (DataSourceBuilder + DatabaseBuilder)
- Test container setup (PostgreSQL / PostGIS via Docker)
- Database migration generation
- Using Lombok with Ebean entity beans
- Full guide index
Install IDE Plugin
Ebean uses bytecode enhancement to provide dirty checking and lazy loading.
We using tooling via IDEA, Eclipse, Maven and Gradle plugins to perform this enhancement.
Install the Plugin for IntelliJ IDEA or Eclipse IDE.