Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/marschall/hibernate-batch-sequence-generator

Special purpose implementation of a Hibernate sequence generator
https://github.com/marschall/hibernate-batch-sequence-generator

batch-insert database-access database-sequence hibernate rdbms sql

Last synced: 3 days ago
JSON representation

Special purpose implementation of a Hibernate sequence generator

Host: GitHub
URL: https://github.com/marschall/hibernate-batch-sequence-generator
Owner: marschall
License: mit
Created: 2017-06-19T08:08:55.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-06-21T15:54:46.000Z (5 months ago)
Last Synced: 2024-06-22T08:18:36.582Z (5 months ago)
Topics: batch-insert, database-access, database-sequence, hibernate, rdbms, sql
Language: Java
Size: 161 KB
Stars: 6
Watchers: 3
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

Hibernate Batch Sequence Generator [![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.github.marschall/hibernate-batch-sequence-generator/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.github.marschall/hibernate-batch-sequence-generator) [![Javadocs](https://www.javadoc.io/badge/com.github.marschall/hibernate-batch-sequence-generator.svg)](https://www.javadoc.io/doc/com.github.marschall/hibernate-batch-sequence-generator) [![Build Status](https://travis-ci.org/marschall/hibernate-batch-sequence-generator.svg?branch=master)](https://travis-ci.org/marschall/hibernate-batch-sequence-generator)
==================================

A batch sequence generator for Hibernate that uses [recursive queries](https://en.wikipedia.org/wiki/Hierarchical_and_recursive_queries_in_SQL) to preallocate multiple values in a single database access.

The code is also present in [Hibernate Types](https://github.com/vladmihalcea/hibernate-types) starting with version 2.13.1.

```xml

com.github.marschall
hibernate-batch-sequence-generator
2.2.0

```

Versions 2.2.x support Hibernate 6.5.

Versions 2.1.x support Hibernate 6.4.

Versions 2.0.x support Hibernate 6.x.

Versions 1.x support Hibernate 5.6.

This sequence generator combines the advantages of several existing sequence generators and avoids their disadvantages:

- [hi/lo](https://vladmihalcea.com/2014/06/23/the-hilo-algorithm/)
- all database access has to be aware of it
- there is no clear relationship between the current sequence value and the column value
- `pooled` and `pooledlo`
- `INCREMENT BY` has to be set on the database sequence
- direct use of the sequence can cause a lot of identifier waste
- the pool size and the `INCREMENT BY` value need to match
- `IDENTITY`
- does not support JDBC batch inserts
- `TABLE`
- has bad write performance

The limitations of this sequence generator are:

- limited database dialect support (see below)
- if you're using hbm2ddl then the `CACHE` value on the sequence is not set

Usage
-----

You can use this sequence generator like this

```java
@Id
@BatchSequence(name = "SOME_SEQUENCE_NAME", fetch_size = SOME_FETCH_SIZE_VALUE)
private Long someColumnName;
```

You need to configure the following things

SOME_SEQUENCE_NAME: the SQL name of the sequence from which the values should be fetched
SOME_FETCH_SIZE_VALUE: integer, how many values should be fetched at once, this should be equal to the CACHE value of the sequence, optional, default value is 10

Database Support
----------------

The following RDBMS have been verified to work

- DB2
- Firebird
- H2
- HSQLDB
- MariaDB 10.3 with Hibernate 5.2.17 or later
- Oracle
- Postgres
- SQL Sever
- In theory any RDBMS that supports `WITH RECURSIVE` and sequences is supported.

Unfortunately these RDBMS are currently not supported

- MySQL due to the lack of sequence support

DDL
---

For the best possible performance the `CACHE` value of the database sequence should be set to the same value as the `"fetch_size"` parameter.

Hibernate Versions
------------------

The project has been developed and tested against Hibernate 6.5.

Dependencies
------------

The project has no dependencies other than Hibernate.