Installation Guide

What is JPA Buddy?

JPA Buddy is a plugin for IntelliJ IDEA that makes working with JPA and related technologies easier. It provides development tools for Hibernate, EclipseLink, Spring Data JPA, Liquibase, Flyway, SQL, and similar things.

JPA Buddy makes the development process easier by:

  • introducing rich code generation capabilities

  • integrating smart inspections

  • providing better navigation via a data-centric view of the project

  • offering comprehensive coding assistance capabilities

Installation and Project Setup

JPA Buddy is compatible with both IntelliJ IDEA Community Edition and IntelliJ IDEA Ultimate Edition. It is available on the JetBrains marketplace, where it can be downloaded and installed.

You can install JPA Buddy for running IntelliJ IDEA. Open Preferences -> Plugins and search for JPA Buddy, then simply push the install button, and there you go!

Dependencies

Since JPA Buddy supports Hibernate, EclipseLink, SpringData, Liquibase, and Flyway, JPA Buddy scans the project dependencies and enables the corresponding features.

Framework/Lib Features
Hibernate - Create and edit entities, entity attributes, lifecycle callbacks, indexes and constraints in both Java and Kotlin.
- Assign JPA converters and Hibernate custom types.
- Apply Lombok annotations to entities.
- Generate proper equals, hashCode and toString.
EclipseLink
Spring Data JPA - Create repositories for entities.
- Generate queries using visual constructors.
- Extract JPQL from derived method queries.
- Pick which fields to return from queries and generate projections.
Hibernate Validator Add Hibernate Validator annotations to Entity attributes via the JPA Inspector panel.
SpringBoot Starter Validation
Hibernate Types Assign Hibernate Custom Types to attributes via a code inspection with a quick fix.
Liquibase - Automatically generate Liquibase changelogs by comparing JPA model to target database, model to snapshot or DB to DB.
- Use visual designers for Liquibase changelogs
- Use coding assistance and autocomplete in Liquibase changelogs for table names, column names etc. JPA Buddy takes these values directly from your data model.
Flyway - Generate Flyway migrations by comparing JPA model to target database, model to snapshot or DB to DB.
- Scaffold INSERT, UPDATE and DELETE statements for your entities in SQL files.

After adding one of the dependencies to the project, do not forget to click on the "Load Maven Changes" button in the upper right corner.

Verifying Installation

To make sure that the plugin is installed correctly, follow these steps:

  • Open Plugin Settings IntelliJ IDEA window: clicks File -> Settings -> Plugins -> Installed. Make sure that JPA Buddy there is in this section and enabled.

  • Open existing or create a new entity and click somewhere in it. You should find three additional tool windows: JPA Structure, JPA Palette, and JPA Inspector. Note that visual tools will appear only after JPA Buddy detects one of the dependencies described in the section above.

Installing a Specific Version of JPA Buddy

Every version of JPA Buddy supports a range of IntelliJ IDEA versions. For example, JPA Buddy 4.3 works correctly with IntelliJ IDEA from 2021.1 to 2021.1.3. But if you have to install JPA Buddy on the other version of IntelliJ IDEA, you can do the following:

  • Open JPA Buddy JetBrains Marketplace page.
  • Open Versions tab.
  • Find a version of JPA Buddy which satisfies the version of your IntelliJ IDEA and click on it.

  • In the opened window, click on the “Download” button.

  • Save .zip file to your PC.

  • Now you have two options:

    • Open File -> Settings -> Plugins page click on the settings icon next to the “installed” tab and choose “install plugin from disc”. Find the downloaded .zip file, select it, and click “ok”.

    • Simply drag and drop the .zip file to any IntelliJ IDEA window.
  • To apply changes, click on the “Restart IDE” button

Something went wrong? Contact us!

Bugs and errors are unavoidable in any software, development tools are no exception. JPA Buddy team is always ready to help you cope with any difficulties that arise. Check out Reporting Issues section where you can find Contact Us information and tips for Error Reporting.