Generated banner for Java Hibernate Jpa
Generated logo for Java Hibernate Jpa

Java Hibernate Jpa

GitHubOfficialFirst committed by jduboisDistributed by GitHub

  • Skill
  • Guidelines
  • Software development
  • MIT
  • No issues found

From the author

Diagnose and fix Hibernate ORM / Jakarta Persistence problems in plain Java: N+1 queries, lazy loading errors, identifier generation, entity equals/hashCode, cascades, pagination, batching, locking, caching, Lombok on entities, and Hibernate 6/7 differences. Use when reviewing or writing JPA entities, mappings, and queries. Framework-neutral.
— the description by jdubois

AutoGineer summary

Written by AutoGineer from the skill’s own files, not by the author

This skill provides a structured approach to identifying and fixing common Hibernate ORM and Jakarta Persistence (JPA) issues. It covers entity mapping, association management, query optimization, and transaction handling. The content is framework-neutral, focusing on the behavior of the EntityManager, Session, JPQL/HQL, and mapping annotations across different Hibernate versions.

What it does

  • Detects N+1 query problems and provides optimization strategies like JOIN FETCH and batch fetching.
  • Provides rules for entity design, including identifier generation and equals/hashCode implementation.
  • Explains how to manage associations, cascades, and orphan removal to prevent data anomalies.
  • Offers guidance on schema management and versioned migrations.
  • Helps resolve LazyInitializationException and other common persistence errors.
  • Details differences between Hibernate versions and Jakarta Persistence specifications.

When to use it

  • When debugging performance issues related to database queries.
  • During code reviews of JPA entities and persistence logic.
  • When configuring Hibernate for new projects or upgrading between versions.
  • When encountering unexpected behavior in entity state management or transaction boundaries.

Advantages

  • Provides a clear decision table for common persistence symptoms.
  • Offers specific, actionable rules for mapping and association management.
  • Includes guidance on testing strategies to verify statement counts and behavior.
  • Maintains a framework-neutral perspective applicable to various Java environments.

Usage examples

“How do I fix an N+1 query issue in my Hibernate application?”
The agent will explain how to detect the issue using SQL logging and provide solutions such as JOIN FETCH, entity graphs, or batch fetching.
“What are the best practices for implementing equals and hashCode in JPA entities?”
The agent will provide rules for stable equality, warning against using generated IDs in hashCode and advising on Lombok usage with associations.
“How should I handle schema management in production with Hibernate?”
The agent will recommend using versioned migration tools like Flyway or Liquibase and setting hibernate.hbm2ddl.auto to validate or none.
“Why am I getting a LazyInitializationException?”
The agent will explain that the session has closed before the lazy association was accessed and suggest loading the required data within the transaction boundary.

Install

  1. Download the skill as a ZIP:

    https://mp-staging.autogineer.com/agent-skills/github/java-hibernate-jpa/download
  2. Unzip it into the cross-client skills folder of your project:

    mkdir -p .agents/skills && unzip java-hibernate-jpa.zip -d .agents/skills

Documentation by jdubois

Hibernate ORM and Jakarta Persistence

Problem -> anti-pattern -> fix library for entity mapping and querying. Framework-neutral: it covers EntityManager/Session behavior, JPQL/HQL, and mapping annotations. If the project uses Spring Boot and the java-springboot and spring-boot-testing skills are installed, use them for Spring Data repositories, transaction wiring, and @DataJpaTest; for Panache and reactive persistence see the Quarkus skills. Integration tests against a real database: java-testcontainers.

First: detect the stack

  1. Read pom.xml/build.gradle (or the dependency tree) for hibernate-core and the persistence API: jakarta.persistence (Hibernate 6+/Jakarta EE 9+) vs javax.persistence (Hibernate 5, see javax-to-jakarta-migration).

  2. Note the Hibernate major version; behavior differs (see references/tooling-and-versions.md). Hibernate 6.0-6.1 implement Jakarta Persistence 3.0, 6.2+ implement 3.1, 7.x implements 3.2, and Hibernate 7 needs Java 17+.

  3. Note the database and whether the schema is managed by Flyway/Liquibase.

  4. Turn on SQL logging and statistics in a test (see references/tooling-and-versions.md) before "optimizing" anything: measure statement counts.

Quick decision table

SymptomLikely causeGo to
Many similar SELECTs for one requestN+1 on lazy associationreferences/fetching-and-n-plus-one.md
LazyInitializationExceptionLazy access outside sessionreferences/fetching-and-n-plus-one.md
HHH000104 / HHH90003004 warning, big memory usePagination with collection fetch joinreferences/queries-pagination-batching.md
Inserts slow, no JDBC batchingIDENTITY ids or batching not configuredreferences/identifiers-and-entity-design.md, references/queries-pagination-batching.md
Duplicate rows / lost children / Set anomaliesBad equals/hashCode or cascade misusereferences/identifiers-and-entity-design.md, references/associations-and-cascade.md
Lost updates, deadlocksMissing locking strategyreferences/locking-transactions-caching.md
Stale or surprising data with cachesSecond-level/query cache misusereferences/locking-transactions-caching.md
Schema drift, ddl-auto in prodNo migration toolreferences/tooling-and-versions.md

Top rules (apply during review)

  1. Associations: @ManyToOne/@OneToOne default to EAGER; declare fetch = FetchType.LAZY explicitly. @OneToMany/@ManyToMany are LAZY by default and should stay so. Choose fetching per query (JOIN FETCH, entity graph), not by making mappings EAGER.

  2. Prefer @ManyToOne owning side plus a bidirectional @OneToMany(mappedBy=...) only when needed; keep both sides in sync through helper methods.

  3. Set or List for collections? Use Set for @ManyToMany; a unidirectional @OneToMany with @JoinColumn or List without an order has costly update patterns.

  4. Never use CascadeType.REMOVE/ALL on @ManyToOne or @ManyToMany. Use orphanRemoval only on a true parent-owned child collection.

  5. Ids: SEQUENCE (pooled optimizer, allocationSize matching the DB increment) for generated numeric ids; IDENTITY disables JDBC insert batching; use UUIDs (time-ordered preferred) when ids must be generated client-side.

  6. Entities: no Lombok @Data/@EqualsAndHashCode/@ToString over associations; implement equals/hashCode deliberately.

  7. Return DTOs/projections from read endpoints rather than entities; never expose entities (lazy proxies) directly in an API.

  8. Paginate with a stable ORDER BY including a unique tiebreaker; never combine setMaxResults with a collection JOIN FETCH.

  9. Keep transactions short, at the service boundary; no remote calls or user interaction inside one.

  10. Write and flush in batches for bulk work and clear the persistence context periodically.

  11. Verify behavior with statement counts in tests against the real database engine.

  12. Follow the schema management rule below.

Schema management rule

This is the single rule other skills refer to by name:

  • Prototype/local: hibernate.hbm2ddl.auto=update (or create-drop for throwaway tests) is acceptable.

  • Production (default): versioned migrations with Flyway or Liquibase, and hibernate.hbm2ddl.auto=validate (or none). Add them when the user wants versioned migrations or the app is headed to production.

  • Externally managed schema: none (or validate); do not add a migration tool.

Review focus

Check statement counts for N+1, explicit LAZY on to-one associations, sequence-based ids with matching allocationSize, and equals/hashCode stable across transient to persistent. Version-dependent details (Hibernate 5/6/7): references/tooling-and-versions.md.

References

  • references/fetching-and-n-plus-one.md: N+1 detection and fixes, lazy vs eager, LazyInitializationException, open-session-in-view, DTO projections.

  • references/identifiers-and-entity-design.md: id generation, equals/hashCode, Lombok, records vs entities, enums and converters, value types.

  • references/associations-and-cascade.md: bidirectional helpers, cascade, orphanRemoval, collection choice, @ManyToMany.

  • references/queries-pagination-batching.md: pagination (offset, keyset, in-memory warning), bulk operations, JDBC batching, StatelessSession.

  • references/locking-transactions-caching.md: optimistic/pessimistic locking, transaction boundaries, flush modes, second-level cache.

  • references/tooling-and-versions.md: SQL logging, statistics, tests, connection pool sizing, migrations, Hibernate 5/6/7 differences.

Canonical docs: Hibernate ORM user guide https://docs.hibernate.org/orm/current/userguide/html_single/ and Jakarta Persistence https://jakarta.ee/specifications/persistence/. Deep background articles: https://vladmihalcea.com/.

Upgrading (fetch the page for the target version; prefer it over this skill): migration guides https://hibernate.org/orm/documentation/migrate/ (6.6: https://docs.hibernate.org/orm/6.6/migration-guide/, 7.0: https://docs.hibernate.org/orm/7.0/migration-guide/), release notes https://hibernate.org/orm/releases/.

Files

references/tooling-and-versions.md

Tooling, diagnosis, migrations, versions

SQL logging and statistics

Prefer logger categories to hibernate.show_sql (which prints to stdout, unformatted, without parameters). Add these elements inside the existing Logback logback.xml <configuration> (keep its appender and root logger):

<logger name="org.hibernate.SQL" level="DEBUG"/>
<logger name="org.hibernate.orm.jdbc.bind" level="TRACE"/>

org.hibernate.orm.jdbc.bind is for Hibernate 6+; on Hibernate 5 use org.hibernate.type.descriptor.sql.BasicBinder. For Log4j2, configure the same categories with <Logger name="..." level="..."/> elements inside <Loggers> in log4j2.xml; bare category properties in hibernate.properties do not configure either backend.

Statistics and slow-query log:

hibernate.generate_statistics=true
hibernate.session.events.log.LOG_QUERIES_SLOWER_THAN_MS=25

For total SQL statement-count assertions in N+1 regression tests, compare sessionFactory.getStatistics().getPrepareStatementCount() before and after the use case, or use a datasource proxy (e.g. datasource-proxy, p6spy). getQueryExecutionCount() counts executed ORM queries, not secondary SELECTs issued to initialize lazy associations; getEntityFetchCount() and getCollectionFetchCount() are useful supplemental diagnostics, not total statement counts. Keep logging at DEBUG/TRACE only in dev/test; statistics have overhead.

Use EXPLAIN (ANALYZE) on the real database for slow SQL; indexes on foreign keys are your responsibility (Hibernate does not create them for FKs on most databases).

Testing persistence code

  • Test against the production database engine via Testcontainers (java-testcontainers), not H2 with a compatibility mode.

  • Flush and clear in tests (em.flush(); em.clear();) before asserting reads, otherwise you only test the first-level cache.

  • Run the real migrations in tests, and use hibernate.hbm2ddl.auto=validate to catch mapping/schema drift.

  • Add a statement-count assertion for list endpoints to prevent N+1 regressions.

Connection pool sizing

  • Hibernate uses the pool for each transaction; pool size bounds concurrent DB work, not request count. Start small (roughly cores * 2 + effective spindles rule of thumb, typically 10-20 per application instance) and tune with measurements.

  • Total connections across instances must stay below the database max_connections.

  • Long transactions, OSIV, and remote calls in transactions are the usual cause of pool exhaustion, not too few connections.

  • Set connection timeout, max lifetime (below DB/proxy idle limits), and leak detection (HikariCP leakDetectionThreshold) in dev.

  • Use the pool's autoCommit=false and hibernate.connection.provider_disables_autocommit=true to delay connection acquisition until the first statement, when your pool supports it.

Schema management

  • Production: Flyway or Liquibase migrations, versioned and reviewed; hibernate.hbm2ddl.auto set to validate or none.

  • update/create/create-drop only for prototypes and throwaway tests; update never drops or renames and can silently diverge from environments.

  • Jakarta Persistence schema generation (jakarta.persistence.schema-generation.*) can emit a script to diff against; do not apply it blindly.

  • Keep migrations compatible with the old release for zero-downtime (expand/contract). Sequence INCREMENT BY must match allocationSize.

  • Name constraints and indexes explicitly in migrations; add indexes on foreign keys and on filter/sort columns.

Hibernate version differences (detect first)

TopicHibernate 5.xHibernate 6.xHibernate 7.x
Namespacejavax.persistence (5.5+ also offers hibernate-core-jakarta)jakarta.persistencejakarta.persistence
Jakarta Persistence2.23.0 (6.0-6.1), 3.1 (6.2+)3.2
Java baseline8+11+17+
Query engineHQL parser (ANTLR 2)Rewritten (semantic query model, ANTLR 4); stricter HQL; more SQL featuresContinues 6 architecture; more HQL features, stricter validation
Fetch-join duplicatesNeed DISTINCTAuto de-duplicatedSame as 6
Pagination + collection fetch warningHHH000104HHH90003004Same as 6
Id generationLegacy hibernate.id.new_generator_mappingsSequence-first AUTO; @GenericGenerator deprecated from 6.5Prefer standard annotations and @UuidGenerator/@IdGeneratorType
Metamodel generatorhibernate-jpamodelgenhibernate-jpamodelgen (hibernate-processor is the successor, introduced in 7.0)hibernate-processor
Hibernate Reactive/othern/aSeparate artifactsSeparate artifacts

Migration notes (5 -> 6): fix javax -> jakarta imports (javax-to-jakarta-migration skill), review HQL for stricter parsing, re-check generated sequence names and allocationSize, re-check @Type/custom type usages and AttributeConverters, Query.getResultList behavior and @Where/@Filter use. Read the official migration guides: https://docs.hibernate.org/orm/6.0/migration-guide/ and the matching guide for 7. Hibernate 8 is in beta at the time of writing; do not assume its APIs.

Version-specific APIs mentioned elsewhere in this skill (entity-graph hint vs setEntityGraph, KeyedPage, UUID styles) should be checked against the project's Hibernate version before use.

Tools

  • Metamodel/typed Criteria: hibernate-jpamodelgen for Hibernate 6.x (hibernate-processor first appears in 7.0.0.Alpha1 on Maven Central), hibernate-processor for Hibernate 7 (org.hibernate.orm:hibernate-processor, provided/annotation-processor scope; hibernate-jpamodelgen 7.x is only a Maven relocation to it).

  • JDK 23+ no longer runs annotation processors found only on the classpath: with a plain provided dependency Entity_ classes are not generated. Set <proc>full</proc> on maven-compiler-plugin (or list the processor in annotationProcessorPaths; Gradle: annotationProcessor).

  • Bytecode enhancement (lazy basic attributes, dirty tracking, lazy to-one inverse): Hibernate Maven/Gradle plugin; test carefully.

  • Validation: Jakarta Bean Validation integrates with persist/update and does not replace DB constraints.

Requirements and compatibility

Written for: GitHub Copilot

Works with: Claude Code, Claude apps, OpenAI Codex, GitHub Copilot, Cursor, Gemini CLI, Kiro, OpenCode, Goose, Amp, Roo Code, JetBrains Junie, Factory Droid, Devin (ex-Windsurf), Mistral Vibe, OpenHands, Letta

“Works with” means the tool reads the open Agent Skills format; a skill written for one tool may use features others lack.

Needs: Needs network access

Security

No issues found by our static scan· No issues found

A static scan is not a guarantee. Skills are third-party content: review a skill before you let an agent use it.

Attribution and licence

First committed by
GitHub avatar of jduboisjdubois
Publisher
GitHub (Official)
Distributed by
GitHub
Source
github/awesome-copilot · skills/java-hibernate-jpa · commit 797337f
Licence
MIT License (redistribution allowed)
  • LICENSE (added by AutoGineer from LICENSE)
  • ATTRIBUTION.md (written by AutoGineer)
Synced
Contributors
jdubois

AutoGineer is not affiliated with or endorsed by jdubois or GitHub.

Download ZIP

The ZIP holds the skill’s files, its licence files and an ATTRIBUTION.md. Download java-hibernate-jpa.zip