Module jakarta.nosql.core

Package jakarta.nosql

package jakarta.nosql

Provides classes and interfaces for integrating Java applications with various NoSQL databases.

NoSQL databases are a category of database systems that differ from traditional relational databases in their data storage and retrieval mechanisms. Unlike relational databases, which organize data into tables with predefined schemas, NoSQL databases use flexible data models that allow for unstructured or semi-structured data storage. These databases are often preferred for their ability to handle large volumes of data, their scalability, and their flexibility in accommodating evolving data schemas.

The Entity annotation specifies that the class is an entity.

The Embeddable annotation declares a class whose instances are stored as an intrinsic part of an owning entity, sharing the identity of the entity.

The Id annotation specifies the primary key of an entity.

The Column annotation specifies the mapping of a persistent property or field to a database column.

The Convert annotation specifies how the values of a field or property are converted to a basic type or a type that can be persisted by a persistence provider.

The MappedSuperclass annotation specifies a class whose mapping information is applied to entities that inherit from it.

The Inheritance annotation specifies the inheritance mapping strategy for the entity class hierarchy.

The DiscriminatorColumn annotation specifies the discriminator column for the inheritance mapping strategy.

The DiscriminatorValue annotation specifies the value of the discriminator column for the annotated entity type.

The Template interface provides methods for interacting with NoSQL databases, allowing operations such as insertion, updating, querying, and deletion of entities.

Class	Description
AttributeConverter<X,Y>	A class that implements this interface can be used to convert entity attribute state into a database column representation and vice versa.
Column	Specifies the column mapped by the annotated persistent property or field.
Convert	Specifies how the values of a field or property are converted to a basic type or a type that can be persisted by a persistence provider.
DiscriminatorColumn	Specifies the discriminator column for the mapping strategy.
DiscriminatorValue	Specifies the value of the discriminator column for the annotated entity type.
Embeddable	Declares a type whose instances are stored as an intrinsic part of an owning entity, sharing the identity of the entity.
Embeddable.EmbeddableType	Defines the strategy for how fields of the embeddable class are stored.
Entity	Annotates a class as an entity, representing a persistent class corresponding to a database structure.
Id	Identifies the primary key of an entity.
Inheritance	Specifies the inheritance mapping strategy for the entity class hierarchy, which descends from the annotated entity class.
MappedSuperclass	Defines a class whose mapping information is applied to entities that inherit from it.
MappingException	An exception that occurs when there is a mapping error during entity mapping or persistence.
NoSQLException	Thrown by the persistence provider when a problem occurs.
QueryMapper	This interface defines the Fluent API for selecting and deleting NoSQL entities.
QueryMapper.MapperDeleteFrom	Represents the first step in the delete query fluent API.
QueryMapper.MapperDeleteNameCondition	Represents a delete condition based on a column name.
QueryMapper.MapperDeleteNotCondition	Represents a NOT delete condition in the delete query fluent API.
QueryMapper.MapperDeleteQueryBuild	Represents the last step of the delete query fluent API execution.
QueryMapper.MapperDeleteWhere	Represents a step where it's possible to perform a logical conjunction or disjunction, add one more delete condition, or end up performing the built query.
QueryMapper.MapperFrom	Represents the first step in the query fluent API.
QueryMapper.MapperLimit	Represents the step in the query fluent API where it's possible to define the maximum number of results to retrieve or to perform the query execution.
QueryMapper.MapperNameCondition	Represents a condition based on a column name.
QueryMapper.MapperNameOrder	Represents the step in the query fluent API where it's possible to define the order of the results or to perform the query execution.
QueryMapper.MapperNotCondition	Represents a NOT condition in the delete query fluent API.
QueryMapper.MapperOrder	Represents the step in the query fluent API where it's possible to define the order of the results or to perform the query execution.
QueryMapper.MapperQueryBuild	Represents the last step of the query fluent API execution.
QueryMapper.MapperSkip	Represents the step in the query fluent API where it's possible to define the position of the first result to retrieve or to perform the query execution.
QueryMapper.MapperWhere	Represents a step where it's possible to: Create a new condition performing logical conjunction (AND) by specifying a column name Create a new condition performing logical disjunction (OR) by specifying a column name Define the position of the first result Define the maximum number of results to retrieve Define the order of the results Perform the query execution
Template	Template is a helper class that increases productivity when performing common NoSQL operations.