Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/holon-platform/holon-datastore-jpa
Holon Platform JPA Datastore module. This is the Java Persistence API implementation of the Datastore API, with relational expressions and transactions support, along with a full Spring and Spring Boot integration.
https://github.com/holon-platform/holon-datastore-jpa
database datastore eclipselink hibernate holon-platform jpa jpa-datastore jpa-entities orm spring-boot
Last synced: about 1 month ago
JSON representation
Holon Platform JPA Datastore module. This is the Java Persistence API implementation of the Datastore API, with relational expressions and transactions support, along with a full Spring and Spring Boot integration.
- Host: GitHub
- URL: https://github.com/holon-platform/holon-datastore-jpa
- Owner: holon-platform
- License: apache-2.0
- Created: 2017-06-01T17:24:39.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-11-14T14:11:19.000Z (about 1 year ago)
- Last Synced: 2024-04-24T12:21:39.892Z (8 months ago)
- Topics: database, datastore, eclipselink, hibernate, holon-platform, jpa, jpa-datastore, jpa-entities, orm, spring-boot
- Language: Java
- Homepage: https://holon-platform.com
- Size: 875 KB
- Stars: 5
- Watchers: 5
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Holon platform JPA Datastore
> Latest release: [5.7.0](#obtain-the-artifacts)
This is the reference __JPA__ `Datastore` implementation of the [Holon Platform](https://holon-platform.com), using the Java `JPA` API for data access and manipulation.
The JPA Datastore relies on the following conventions regarding __DataTarget__ and __Path__ naming strategy:
* The [DataTarget](https://docs.holon-platform.com/current/reference/holon-core.html#DataTarget) _name_ is interpreted as the JPA _entity_ name.
* The [Path](https://docs.holon-platform.com/current/reference/holon-core.html#Path) _name_ is interpreted as a JPA _entity_ attribute name, supporting nested classes through the conventional _dot_ notation.
As a _relational Datastore_, standard [relational expressions](https://docs.holon-platform.com/current/reference/holon-datastore-jpa.html#Relational-expressions) are supported (alias, joins and sub-queries).
The JPA Datastore supports any standard JPA __ORM__ library, altough is tested and optimized specifically for:
* [Hibernate](http://hibernate.org/orm) version __5.6__
* [EclipseLink](http://www.eclipse.org/eclipselink) version __2.7 or above__
A complete __Spring__ and __Spring Boot__ support is provided for JPA Datastore integration in a Spring environment and for __auto-configuration__ facilities.
See the module [documentation](https://docs.holon-platform.com/current/reference/holon-datastore-jpa.html) for details.
Just like any other platform module, this artifact is part of the [Holon Platform](https://holon-platform.com) ecosystem, but can be also used as a _stand-alone_ library.
See [Getting started](#getting-started) and the [platform documentation](https://docs.holon-platform.com/current/reference) for further details.
## At-a-glance overview
_JPA Datastore operations:_
```java
DataTarget TARGET = JpaTarget.of(MyEntity.class);
Datastore datastore = JpaDatastore.builder().entityManagerFactory(myEntityManagerFactory).build();
datastore.save(TARGET, PropertyBox.builder(TEST).set(ID, 1L).set(VALUE, "One").build());
Stream results = datastore.query().target(TARGET).filter(ID.goe(1L)).stream(TEST);
List values = datastore.query().target(TARGET).sort(ID.asc()).list(VALUE);
Stream values = datastore.query().target(TARGET).filter(VALUE.startsWith("prefix")).restrict(10, 0).stream(VALUE);
long count = datastore.query(TARGET).aggregate(QueryAggregation.builder().path(VALUE).filter(ID.gt(1L)).build()).count();
Stream months = datastore.query().target(TARGET).distinct().stream(LOCAL_DATE.month());
List entities = datastore.query().target(TARGET).list(BeanProjection.of(MyEntity.class));
datastore.bulkUpdate(TARGET).filter(ID.in(1L, 2L)).set(VALUE, "test").execute();
datastore.bulkDelete(TARGET).filter(ID.gt(0L)).execute();
```
_Transaction management:_
```java
long updatedCount = datastore.withTransaction(tx -> {
long updated = datastore.bulkUpdate(TARGET).set(VALUE, "test").execute().getAffectedCount();
tx.commit();
return updated;
});
```
_JPA Datastore configuration using Spring:_
```java
@EnableJpaDatastore
@Configuration
class Config {
@Bean
public FactoryBean entityManagerFactory(DataSource dataSource) {
LocalContainerEntityManagerFactoryBean emf = new LocalContainerEntityManagerFactoryBean();
emf.setDataSource(dataSource);
emf.setPackagesToScan("com.example.entities");
return emf;
}
}
@Autowired
Datastore datastore;
```
_JPA Datastore auto-configuration using Spring Boot:_
```yaml
spring:
datasource:
url: "jdbc:h2:mem:test"
username: "sa"
holon:
datastore:
trace: true
```
See the [module documentation](https://docs.holon-platform.com/current/reference/holon-datastore-jpa.html) for the user guide and a full set of examples.
## Code structure
See [Holon Platform code structure and conventions](https://github.com/holon-platform/platform/blob/master/CODING.md) to learn about the _"real Java API"_ philosophy with which the project codebase is developed and organized.
## Getting started
### System requirements
The Holon Platform is built using __Java 11__, so you need a JRE/JDK version 11 or above to use the platform artifacts.
The __JPA API version 2.x__ or above is reccomended to use all the functionalities of the JPA Datastore.
### Releases
See [releases](https://github.com/holon-platform/holon-datastore-jpa/releases) for the available releases. Each release tag provides a link to the closed issues.
### Obtain the artifacts
The [Holon Platform](https://holon-platform.com) is open source and licensed under the [Apache 2.0 license](LICENSE.md). All the artifacts (including binaries, sources and javadocs) are available from the [Maven Central](https://mvnrepository.com/repos/central) repository.
The Maven __group id__ for this module is `com.holon-platform.jpa` and a _BOM (Bill of Materials)_ is provided to obtain the module artifacts:
_Maven BOM:_
```xml
com.holon-platform.jpa
holon-datastore-jpa-bom
5.7.0
pom
import
```
See the [Artifacts list](#artifacts-list) for a list of the available artifacts of this module.
### Using the Platform BOM
The [Holon Platform](https://holon-platform.com) provides an overall Maven _BOM (Bill of Materials)_ to easily obtain all the available platform artifacts:
_Platform Maven BOM:_
```xml
com.holon-platform
bom
${platform-version}
pom
import
```
See the [Artifacts list](#artifacts-list) for a list of the available artifacts of this module.
### Build from sources
You can build the sources using Maven (version 3.3.x or above is recommended) like this:
`mvn clean install`
## Getting help
* Check the [platform documentation](https://docs.holon-platform.com/current/reference) or the specific [module documentation](https://docs.holon-platform.com/current/reference/holon-datastore-jpa.html).
* Ask a question on [Stack Overflow](http://stackoverflow.com). We monitor the [`holon-platform`](http://stackoverflow.com/tags/holon-platform) tag.
* Report an [issue](https://github.com/holon-platform/holon-datastore-jpa/issues).
* A [commercial support](https://holon-platform.com/services) is available too.
## Examples
See the [Holon Platform examples](https://github.com/holon-platform/holon-examples) repository for a set of example projects.
## Contribute
See [Contributing to the Holon Platform](https://github.com/holon-platform/platform/blob/master/CONTRIBUTING.md).
[](https://gitter.im/holon-platform/contribute?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
Join the __contribute__ Gitter room for any question and to contact us.
## License
All the [Holon Platform](https://holon-platform.com) modules are _Open Source_ software released under the [Apache 2.0 license](LICENSE).
## Artifacts list
Maven _group id_: `com.holon-platform.jpa`
Artifact id | Description
----------- | -----------
`holon-datastore-jpa` | __JPA__ `Datastore` implementation
`holon-datastore-jpa-spring` | __Spring__ integration using the `@EnableJpa` and `@EnableJpaDatastore` annotations
`holon-datastore-jpa-spring-boot` | __Spring Boot__ integration for JPA stack and Datastore auto-configuration
`holon-starter-jpa-hibernate` | __Spring Boot__ _starter_ for JPA stack and Datastore auto-configuration using [Hibernate](http://hibernate.org/orm) ORM
`holon-starter-jpa-eclipselink` | __Spring Boot__ _starter_ for JPA stack and Datastore auto-configuration using [EclipseLink](http://www.eclipse.org/eclipselink) ORM
`holon-datastore-jpa-bom` | Bill Of Materials
`documentation-datastore-jpa` | Documentation