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/queries-pagination-batching.md

Queries, pagination, batching

Pagination

Offset pagination
List<Order> orders = em.createQuery("select o from Order o order by o.createdAt desc, o.id desc", Order.class)
    .setFirstResult(page * size)
    .setMaxResults(size)
    .getResultList();
  • Always include a deterministic ORDER BY with a unique tiebreaker (id).

  • Large offsets are slow (the DB scans and discards rows). Use keyset pagination for deep paging.

Collection fetch join + pagination (HHH000104)
// anti-pattern
em.createQuery("select o from Order o join fetch o.lines", Order.class)
  .setMaxResults(20).getResultList();

Hibernate logs HHH000104: firstResult/maxResults specified with collection fetch; applying in memory (Hibernate 6: HHH90003004). It loads every matching row and paginates in the JVM: memory and latency explode.

Fix (two queries):

List<Long> ids = em.createQuery("select o.id from Order o where exists (select 1 from o.lines) order by o.createdAt desc, o.id desc", Long.class)
    .setMaxResults(20).getResultList();

List<Order> orders = em.createQuery(
    "select distinct o from Order o join fetch o.lines where o.id in :ids order by o.createdAt desc, o.id desc",
    Order.class).setParameter("ids", ids).getResultList();

The exists filter matches the inner join fetch, which drops orders without lines; use left join fetch and drop the filter to keep them. Alternatives: fetch only to-one associations in the paged query and rely on @BatchSize/default_batch_fetch_size for collections; or use a DTO projection. Fetch joins on @ManyToOne are safe with pagination.

Keyset (seek) pagination
List<Order> next = em.createQuery("""
    select o from Order o
    where (o.createdAt < :ts or (o.createdAt = :ts and o.id < :id))
    order by o.createdAt desc, o.id desc
    """, Order.class)
  .setParameter("ts", lastTs).setParameter("id", lastId)
  .setMaxResults(size).getResultList();

Needs an index on the sort columns (created_at desc, id desc), constant time per page, stable under inserts; no "jump to page N". Return an opaque cursor made from the last row's sort values. Hibernate 6.5+/7 also has KeyedPage/KeyedResultList APIs on SelectionQuery; check the docs of your version.

Total counts

A separate count query per page is costly; skip it when the UI can use "has next" (fetch size + 1 rows).

JDBC batching (inserts and updates)

Enable JDBC batching with a positive batch size:

hibernate.jdbc.batch_size=50

Hibernate can batch inserts with sequence, UUID, or assigned identifiers. IDENTITY prevents JDBC batching of entity inserts because Hibernate must execute each insert to obtain its generated id; it does not prevent batching updates. Do not change an existing identifier strategy solely to enable batching without considering its other tradeoffs.

Optional tuning (measure against the actual database and driver):

hibernate.order_inserts=true
hibernate.order_updates=true
hibernate.jdbc.batch_versioned_data=true

Ordering statements may group compatible operations, and PostgreSQL reWriteBatchedInserts=true / MySQL rewriteBatchedStatements=true may improve driver throughput; neither ordering nor driver rewrite flags are prerequisites for Hibernate JDBC batching. Check the dialect, driver, and Hibernate version before changing settings.

Write pattern for large loads:

for (int i = 0; i < items.size(); i++) {
    em.persist(items.get(i));
    if ((i + 1) % batchSize == 0) {
        em.flush();
        em.clear();      // release memory and dirty-checking cost
    }
}

Keep batchSize equal to hibernate.jdbc.batch_size. Commit per chunk (own transaction) if partial progress is acceptable.

Entities referenced after clear() are detached; reload or use getReference.

Bulk operations and StatelessSession

  • Updates over many rows: set-based update Order o set o.status = :s where ... (bypasses lifecycle callbacks, @Version unless versioned, and cascades; Hibernate invalidates the affected second-level cache regions itself, but managed entities in the current persistence context become stale, so flush before and clear or refresh afterwards).

  • Pure ETL/import: StatelessSession (no persistence context, no dirty checking, no cascade) with insert/update.

    • Hibernate 6: it bypasses the second-level cache and uses hibernate.jdbc.batch_size for JDBC batching.

    • Hibernate 7: it uses the second-level cache by default (disable per session if unwanted), and hibernate.jdbc.batch_size has no effect on it; set the batch size with StatelessSession.setJdbcBatchSize(n) and prefer the bulk operations insertMultiple/updateMultiple/upsertMultiple/deleteMultiple.

    • Confirm the API for your exact version.

  • Streaming reads: query.getResultStream()/scroll with hibernate.jdbc.fetch_size; close the stream and clear the context periodically. Many drivers (PostgreSQL) only stream inside a transaction with autocommit off and a fetch size set.

Query hygiene

  • Bind parameters; never concatenate user input into JPQL/native SQL.

  • IN lists: large lists blow up the SQL cache; Hibernate pads parameters with hibernate.query.in_clause_parameter_padding=true, and databases cap parameter counts, so chunk (e.g. 500-1000).

  • hibernate.query.fail_on_pagination_over_collection_fetch=true only throws when Hibernate would really paginate in memory. Hibernate 7.4+ only (the 7.4 query language guide: "Prior to Hibernate 7.4, limits didn't play well with many-valued fetch joins"; on 7.0-7.3 pagination over a collection fetch join stays in memory on every dialect, so this guard is useful there). Verified in the 7.4 source (SqmQueryImpl/AbstractSqmSelectionQuery): when the dialect supports LIMIT/OFFSET in a subquery (supportsOffsetInSubquery, true for PostgreSQL, MySQL, H2...), Hibernate 7.4+ pushes the pagination into a derived table, so join fetch + setMaxResults (and Spring Data Pageable on such a query) is paginated by the database and the setting never fires. It fires only for dialects without that support, or when in-memory limiting is forced; the old HHH000104 warning is then logged otherwise. Do not use it as a guard on 7.4+ with such dialects: check the generated SQL for limit/fetch first, and still prefer the two-step (ids first, then fetch) pattern for portability.

  • @QueryHints(readOnly)/setHint("org.hibernate.readOnly", true) for read paths that load entities but never modify them.

  • Prefer JPQL/HQL or Criteria for portability; use native SQL for database-specific features (window functions, SKIP LOCKED, upserts), mapped to DTOs.

  • existsBy-style checks: select 1 ... fetch first 1 rows only / count(*) > 0 instead of loading entities.

  • Check generated SQL for select *-like entity loads where only 2 columns are needed: use projections.

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