The Eclipse JNoSQL Mapping Extension API is a collection of implementations/specializations from the Jakarta NoSQL specification that defines specific behavior in various NoSQL databases.
Eclipse JNoSQL provide support for bean validation. It will validate before inserting/updating and constructing an entity.
<dependency>
<groupId>org.eclipse.jnosql.mapping</groupId>
<artifactId>jnosql-mapping-validation</artifactId>
<version>1.0.1</version>
</dependency>This requires the Jakarta Bean Validation specification.
@Entity
public class Car {
@Column
@NotNull
@Pattern(regexp = "[A-Z]{3}-[0-9]{4}", message = "Invalid car plate")
private String plate;
@Column
@NotNull
@MonetaryMin(value = "100", message = "There is not car cheap like that")
@MonetaryMax(value = "1000000", message = "The parking does not support fancy car")
@CurrencyAccepted(currencies = "USD", message = "The car price must work with USD")
@Convert(MonetaryAmountConverter.class)
private MonetaryAmount price;
@Column
@NotBlank
private String model;
@Column
@NotBlank
private String color;
...
}@Inject
Template template;
...
template.insert(new Car()); // invalid carGraph connections is a project that contains several GraphConfiguration implementations.
<dependency>
<groupId>org.eclipse.jnosql.mapping</groupId>
<artifactId>jnosql-jnosql-graph-connections</artifactId>
<version>1.0.1</version>
</dependency>| Configuration property | Description |
|---|---|
|
The edge collection. It uses as a prefix. E.g.:jnosql.arangodb.graph.edge.1=edge |
|
Edge collection, the source vertex collection and the target vertex collection split by pipe. It hou,It uses as a prefix. E.g.: jnosql.arangodb.graph.relationship.1=Person|knows|Person |
|
The vertex collection. It uses as a prefix. E.g.: jnosql.arangodb.graph.vertex.1=vertex |
|
Name of the graph to use. |
|
The database host. |
|
The user’s credential. |
|
The password’s credential. |
This is an example using ArangoDB’s Graph API with MicroProfile Config.
jnosql.graph.provider=org.eclipse.jnosql.mapping.graph.connections.ArangoDBGraphConfiguration
jnosql.arangodb.graph.graph=marketing
jnosql.arangodb.graph.vertex.1=Person
jnosql.arangodb.graph.edge.1=knows
jnosql.arangodb.graph.relationship.1=Person|knows|PersonThis is an example using Janus’s Graph API with MicroProfile Config.
|
Warning
|
The API will pass and use the properties from org.janusgraph.graphdb.configuration.GraphDatabaseConfiguration
|
jnosql.graph.provider=org.eclipse.jnosql.mapping.graph.connections.JanusGraphConfiguration
graphname=name
allow-upgrade=falseThis is an example using Titan’s Graph API with MicroProfile Config.
|
Warning
|
The API will pass and use the properties from com.thinkaurelius.titan.graphdb.configuration.GraphDatabaseConfiguration
|
jnosql.graph.provider=org.eclipse.jnosql.mapping.graph.connections.TitanGraphConfiguration| Configuration property | Description |
|---|---|
|
The database host. Default: "bolt://localhost:7687" |
|
The user’s credential. Default: "neo4j" |
|
The password’s credential. Default: "neo4j" |
This is an example using Neo4J’s Graph API with MicroProfile Config.
jnosql.graph.provider=org.eclipse.jnosql.mapping.graph.connections.Neo4JGraphConfiguration
jnosql.neo4j.user=neo4j
jnosql.neo4j.password=neo4j
jnosql.neo4j.host=bolt://localhost:7687| Configuration property | Description |
|---|---|
|
The database host. Default: "bolt://localhost:7687" |
This is an example using Neo4J’s Graph API with MicroProfile Config.
jnosql.graph.provider=org.eclipse.jnosql.mapping.graph.connections.Neo4JEmbeddedGraphConfiguration
jnosql.neo4j.host=/home/otaviojava/data/This is the experimental Criteria API, largely inspired by the JPA one. Using this API you can execute queries built via CriteriaQuery. The CriteriaQuery is used in combination with Metamodel Attributes. These attributes are automagically generated from the defined NoSQL Entities.
The Criteria API can be used via CriteriaDocumentTemplate.
<dependency>
<groupId>org.eclipse.jnosql.mapping</groupId>
<artifactId>jnosql-metamodel-processor-extension</artifactId>
<version>1.0.1</version>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.eclipse.jnosql.mapping</groupId>
<artifactId>jnosql-criteria-extension</artifactId>
<version>1.0.1</version>
</dependency> @Inject
private CriteriaDocumentTemplateProducer producer;
@Inject
private DocumentManager documentManager; CriteriaDocumentTemplate template = producer.get(documentManager);You can fetch entities with an EntityQuery :
CriteriaQuery<Person> personQuery = template.createQuery(Person.class);
EntityQueryResult<Person> executeQuery = template.executeQuery(
personQuery.select().where(
personQuery.from().get(
Person_.name
).equal(
"Poliana"
).or(
personQuery.from().get(
Person_.age
).greaterThanOrEqualTo(17)
)
)
);
Stream<Person> stream = executeQuery.getEntities();You can fetch single columns/projections using an ExpressionQuery :
CriteriaQuery<Person> personQuery = template.createQuery(Person.class);
StringExpression<Person, Person> nameExpression = personQuery.from().get(
Person_.name
);
NumberExpression<Person, Person, Integer> ageExpression = personQuery.from().get(
Person_.age
);
ExpressionQueryResult<Person> executeQuery = template.executeQuery(
personQuery.select(
nameExpression,
ageExpression
).where(
nameExpression.equal(
"Poliana"
).or(
ageExpression.greaterThanOrEqualTo(17)
)
)
);
Optional<ExpressionQueryResultRow<Person>> findFirst = executeQuery.getRows().findFirst();
String name = findFirst.get().get(
nameExpression
);
Integer age = findFirst.get().get(
ageExpression
);Having trouble with Eclipse JNoSQL extensions? We’d love to help!
Please report any bugs, concerns or questions with Eclipse JNoSQL extensions to https://github.com/eclipse/jnosql. Follow the instructions in the templates and remember to mention that the issue refers to JNoSQL extensions.
We are very happy you are interested in helping us and there are plenty ways you can do so.
-
Open an Issue: Recommend improvements, changes and report bugs. Please, mention that the issue refers to the JNoSQL extensions project.
-
Open a Pull Request: If you feel like you can even make changes to our source code and suggest them, just check out our contributing guide to learn about the development process, how to suggest bugfixes and improvements.