https://github.com/holon-platform/holon-datastore-mongo
Holon Platform MongoDB Datastore module. This is the MongoDB implementation of the Datastore API, with asynchronous and reactive interaction support, along with a full Spring and Spring Boot integration.
https://github.com/holon-platform/holon-datastore-mongo
datastore document-database holon-platform json-database mongodb
Last synced: about 1 year ago
JSON representation
Holon Platform MongoDB Datastore module. This is the MongoDB implementation of the Datastore API, with asynchronous and reactive interaction support, along with a full Spring and Spring Boot integration.
- Host: GitHub
- URL: https://github.com/holon-platform/holon-datastore-mongo
- Owner: holon-platform
- License: apache-2.0
- Created: 2017-06-05T08:33:36.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-14T14:11:46.000Z (over 2 years ago)
- Last Synced: 2025-03-29T20:51:08.598Z (about 1 year ago)
- Topics: datastore, document-database, holon-platform, json-database, mongodb
- Language: Java
- Homepage: https://holon-platform.com
- Size: 931 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Holon platform MongoDB Datastore module
> Latest release: [5.7.0](#obtain-the-artifacts)
This is the reference __MongoDB__ implementation of the [Holon Platform](https://holon-platform.com) `Datastore` API, using the [MongoDB Java driver](https://mongodb.github.io/mongo-java-driver) for data access and manipulation.
The following interaction models are supported:
* __Synchronous__ interaction, using the `holon-datastore-mongo-sync` artifact.
* __Asynchronous__ interaction, using the `holon-datastore-mongo-async` artifact.
* __Reactive__ interaction, using the `holon-datastore-mongo-reactor` artifact and the [Project Reactor](https://projectreactor.io) library.
See the [Datastore API documentation](https://docs.holon-platform.com/current/reference/holon-core.html#Datastore) for information about the Holon Platform `Datastore` API.
A full __Spring__ and __Spring Boot__ integration is provided, which includes auto-configuration facilities and a set of _starters_ to quickly setup project dependencies.
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.
## 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.
### Releases
See [releases](https://github.com/holon-platform/holon-datastore-mongo/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.reactor` and a _BOM (Bill of Materials)_ is provided to obtain the module artifacts:
_Maven BOM:_
```xml
com.holon-platform.mongo
holon-datastore-mongo-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-mongo.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-mongo/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.mongo`
Artifact id | Description
----------- | -----------
`holon-datastore-mongo-core` | Common operations and data structures
`holon-datastore-mongo-core-async` | Common operations and data structures for the asynchronous `Datastore` API implementation
`holon-datastore-mongo-sync` | Synchronous __MongoDB__ `Datastore` API implementation
`holon-datastore-mongo-async` | Asynchronous __MongoDB__ `Datastore` API implementation
`holon-datastore-mongo-reactor` | Reactive __MongoDB__ `Datastore` API implementation using Project Reactor
`holon-datastore-mongo-spring` | __Spring__ integration using the `@EnableMongoDatastore` and `EnableMongoAsyncDatastore` annotation
`holon-datastore-mongo-spring-boot` | __Spring Boot__ integration for __MongoDB__ `Datastore` auto-configuration
`holon-starter-mongo-datastore` | __Spring Boot__ _starter_ for the __MongoDB__ `Datastore` auto-configuration
`holon-starter-mongo-datastore-reactor` | __Spring Boot__ _starter_ for the _reactive_ __MongoDB__ `Datastore` implementation auto-configuration
`holon-datastore-mongo-bom` | Bill Of Materials
`documentation-datastore-mongo` | Documentation