Index (Jakarta NoSQL API documentation)

A B C D E F G I J L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

and(String) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteWhere: Create a new delete condition performing logical conjunction (AND) by specifying a column name.
and(String) - Method in interface jakarta.nosql.QueryMapper.MapperWhere: Create a new condition performing logical conjunction (AND) by specifying a column name.
asc() - Method in interface jakarta.nosql.QueryMapper.MapperOrder: Defines the sorting direction as ascending for the previously specified column.
AttributeConverter<X,Y> - Interface in jakarta.nosql: A class that implements this interface can be used to convert entity attribute state into a database column representation and vice versa.

B

between(T, T) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column name is between the provided values.
between(T, T) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column value is between the two provided bounds.
bind(int, Object) - Method in interface jakarta.nosql.Query: Binds a positional parameter to the query.
bind(String, Object) - Method in interface jakarta.nosql.Query: Binds a named parameter to the query.

C

Column - Annotation Interface in jakarta.nosql: Declares that the annotated attribute is persistable and maps to a database column or key.
contains(String) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column contains the given value.
contains(String) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column contains the given substring.
Convert - Annotation Interface in jakarta.nosql: 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.
convertToDatabaseColumn(X) - Method in interface jakarta.nosql.AttributeConverter: Converts the value stored in the entity attribute into the data representation to be stored in the database.
convertToEntityAttribute(Y) - Method in interface jakarta.nosql.AttributeConverter: Converts the data stored in the database column into the value to be stored in the entity attribute.
count() - Method in interface jakarta.nosql.QueryMapper.MapperQueryBuild: Executes the query and returns the number of entities that match the current filter conditions.

D

DEFAULT_DISCRIMINATOR_COLUMN - Static variable in annotation interface jakarta.nosql.DiscriminatorColumn: The default name of the discriminator column, which is "dtype".
delete(Class<T>) - Method in interface jakarta.nosql.Template: Start a query builder using the fluent API.
delete(Class<T>, K) - Method in interface jakarta.nosql.Template: Deletes by ID or key.
delete(Iterable<? extends T>) - Method in interface jakarta.nosql.Template: Deletes the given entities.
delete(T) - Method in interface jakarta.nosql.Template: Deletes a given entity.
desc() - Method in interface jakarta.nosql.QueryMapper.MapperOrder: Defines the sorting direction as descending for the previously specified column.
DiscriminatorColumn - Annotation Interface in jakarta.nosql: Specifies the discriminator column for the mapping strategy.
DiscriminatorValue - Annotation Interface in jakarta.nosql: Specifies the value of the discriminator column for the annotated entity type.

E

Embeddable - Annotation Interface in jakarta.nosql: Declares a type whose instances are stored as an intrinsic part of an owning entity, sharing the identity of the entity.
Embeddable.EmbeddableType - Enum Class in jakarta.nosql: Defines the strategies for how fields of an embeddable class are stored in the database.
endsWith(String) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column ends with the given value.
endsWith(String) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column ends with the given suffix.
Entity - Annotation Interface in jakarta.nosql: Annotates a class as an entity, representing a persistent domain object stored in a NoSQL database.
eq(T) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column name equals the provided value.
eq(T) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column value equals the given value.
execute() - Method in interface jakarta.nosql.QueryMapper.MapperDeleteQueryBuild: Executes the delete query based on the specified conditions.
executeUpdate() - Method in interface jakarta.nosql.Query: Executes a write operation query (such as UPDATE or DELETE).

F

find(Class<T>, K) - Method in interface jakarta.nosql.Template: Retrieves an entity by its Id.
FLAT - Enum constant in enum class jakarta.nosql.Embeddable.EmbeddableType: Fields of the embeddable class are embedded directly into the data structure of the parent entity or embeddable.
from() - Element in annotation interface jakarta.nosql.Projection: Specifies the source entity class that this projection is based on.

G

GROUPING - Enum constant in enum class jakarta.nosql.Embeddable.EmbeddableType: Fields of the embeddable class are stored in a grouped structure, such as a user-defined type (UDT) or embedded document.
gt(T) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column name is greater than the provided value.
gt(T) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column value is greater than the given value.
gte(T) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column name is greater than or equal to the provided value.
gte(T) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column value is greater than or equal to the given value.

I

Id - Annotation Interface in jakarta.nosql: Identifies the primary key of an entity.
in(Iterable<T>) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column name is in the provided iterable values.
in(Iterable<T>) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column value exists within the given collection.
Inheritance - Annotation Interface in jakarta.nosql: Specifies the inheritance mapping strategy for the entity class hierarchy, which descends from the annotated entity class.
insert(Iterable<T>) - Method in interface jakarta.nosql.Template: Inserts multiple entities into the database.
insert(Iterable<T>, Duration) - Method in interface jakarta.nosql.Template: Inserts multiple entities into the database with the expiration date.
insert(T) - Method in interface jakarta.nosql.Template: Inserts an entity into the database.
insert(T, Duration) - Method in interface jakarta.nosql.Template: Inserts an entity into the database with an expiration to the entity.

J

jakarta.nosql - package jakarta.nosql: Provides classes and interfaces for integrating Java applications with various NoSQL databases.
jakarta.nosql.core - module jakarta.nosql.core: Jakarta NoSQL

L

like(String) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column name is like the provided value.
like(String) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column value matches the provided pattern.
limit(long) - Method in interface jakarta.nosql.QueryMapper.MapperFrom: Defines the maximum number of results to retrieve (pagination limit).
limit(long) - Method in interface jakarta.nosql.QueryMapper.MapperNameOrder: Sets the maximum number of results to return.
limit(long) - Method in interface jakarta.nosql.QueryMapper.MapperSkip: Defines the maximum number of results to retrieve (pagination limit).
limit(long) - Method in interface jakarta.nosql.QueryMapper.MapperWhere: Defines the maximum number of results to retrieve (pagination limit).
lt(T) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column name is less than the provided value.
lt(T) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column value is less than the given value.
lte(T) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column name is less than or equal to the provided value.
lte(T) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column value is less than or equal to the given value.

M

MappedSuperclass - Annotation Interface in jakarta.nosql: Defines a class whose mapping information is applied to entities that inherit from it.
MappingException - Exception Class in jakarta.nosql: An exception that occurs when there is a mapping error during entity mapping or persistence.
MappingException(String) - Constructor for exception class jakarta.nosql.MappingException: Constructs a MappingException using the given message.
MappingException(String, Throwable) - Constructor for exception class jakarta.nosql.MappingException: Constructs a MappingException using the given message and cause.
MappingException(Throwable) - Constructor for exception class jakarta.nosql.MappingException: Constructs a MappingException using the given cause.

N

name() - Element in annotation interface jakarta.nosql.Entity: Defines the logical name used to reference this entity in Jakarta Query language.
NoSQLException - Exception Class in jakarta.nosql: Thrown by the persistence provider when a problem occurs.
NoSQLException() - Constructor for exception class jakarta.nosql.NoSQLException: Constructs a new runtime exception with null as its detail message.
NoSQLException(String) - Constructor for exception class jakarta.nosql.NoSQLException: Constructs a new runtime exception with the specified detail message.
NoSQLException(String, Throwable) - Constructor for exception class jakarta.nosql.NoSQLException: Constructs a new runtime exception with the specified detail message and cause.
NoSQLException(String, Throwable, boolean, boolean) - Constructor for exception class jakarta.nosql.NoSQLException: Constructs a new runtime exception with the specified detail message, cause, suppression enabled or disabled, and writable stack trace enabled or disabled.
NoSQLException(Throwable) - Constructor for exception class jakarta.nosql.NoSQLException: Constructs a new runtime exception with the specified cause and a detail message of (cause==null ?
not() - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a NOT delete condition for the specified column name.
not() - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a negated condition for the current column, allowing inverse logic.

O

or(String) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteWhere: Create a new delete condition performing logical disjunction (OR) by specifying a column name.
or(String) - Method in interface jakarta.nosql.QueryMapper.MapperWhere: Create a new condition performing logical disjunction (OR) by specifying a column name.
orderBy(String) - Method in interface jakarta.nosql.QueryMapper.MapperFrom: Add the order how the result will return based on a given column name.
orderBy(String) - Method in interface jakarta.nosql.QueryMapper.MapperNameOrder: Adds an ordering rule based on the specified column name.
orderBy(String) - Method in interface jakarta.nosql.QueryMapper.MapperWhere: Add the order how the result will return.

P

Projection - Annotation Interface in jakarta.nosql: Declares a Java record as a projection for query results in Jakarta NoSQL.

Q

query(String) - Method in interface jakarta.nosql.Template: Creates a query from a raw string using Jakarta Query language (core grammar).
Query - Interface in jakarta.nosql: Query represents a string-based query execution interface used in Jakarta NoSQL.
QueryMapper - Interface in jakarta.nosql: This interface defines the Fluent API for selecting and deleting NoSQL entities.
QueryMapper.MapperDeleteFrom - Interface in jakarta.nosql: Represents the first step in the delete query fluent API.
QueryMapper.MapperDeleteNameCondition - Interface in jakarta.nosql: Represents a delete condition based on a column name.
QueryMapper.MapperDeleteNotCondition - Interface in jakarta.nosql: Represents a NOT delete condition in the delete query fluent API.
QueryMapper.MapperDeleteQueryBuild - Interface in jakarta.nosql: Represents the last step of the delete query fluent API execution.
QueryMapper.MapperDeleteWhere - Interface in jakarta.nosql: 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 - Interface in jakarta.nosql: Represents the first step in the query fluent API.
QueryMapper.MapperLimit - Interface in jakarta.nosql: 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 - Interface in jakarta.nosql: Represents a condition based on a column name.
QueryMapper.MapperNameOrder - Interface in jakarta.nosql: 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 - Interface in jakarta.nosql: Represents a NOT condition in the delete query fluent API.
QueryMapper.MapperOrder - Interface in jakarta.nosql: 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 - Interface in jakarta.nosql: Represents the last step of the query fluent API execution.
QueryMapper.MapperSkip - Interface in jakarta.nosql: 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 - Interface in jakarta.nosql: 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

R

result() - Method in interface jakarta.nosql.Query: Executes a SELECT query and returns the result as a List.
result() - Method in interface jakarta.nosql.QueryMapper.MapperQueryBuild: Executes the query and returns the result as a List.
result() - Method in interface jakarta.nosql.TypedQuery: Executes the SELECT query and returns the results as a List of type T.

S

select(Class<T>) - Method in interface jakarta.nosql.Template: Start a query using the fluent API.
singleResult() - Method in interface jakarta.nosql.Query: Executes a SELECT query and returns a single result wrapped in an Optional.
singleResult() - Method in interface jakarta.nosql.QueryMapper.MapperQueryBuild: Executes the query and returns the result as a single element, wrapped in an Optional.
singleResult() - Method in interface jakarta.nosql.TypedQuery: Executes the SELECT query and returns a single result wrapped in an Optional.
skip(long) - Method in interface jakarta.nosql.QueryMapper.MapperFrom: Defines the position of the first result to retrieve (pagination offset).
skip(long) - Method in interface jakarta.nosql.QueryMapper.MapperLimit: Defines the position of the first result to retrieve (pagination offset).
skip(long) - Method in interface jakarta.nosql.QueryMapper.MapperNameOrder: Sets the number of results to skip before starting to return results.
skip(long) - Method in interface jakarta.nosql.QueryMapper.MapperWhere: Sets the number of results to skip before starting to return results.
startsWith(String) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteNameCondition: Creates a delete condition where the specified column starts with the given value.
startsWith(String) - Method in interface jakarta.nosql.QueryMapper.MapperNameCondition: Creates a condition where the specified column starts with the given prefix.
stream() - Method in interface jakarta.nosql.Query: Executes a SELECT query and returns the result as a Stream.
stream() - Method in interface jakarta.nosql.QueryMapper.MapperQueryBuild: Executes the query and returns the result as a Stream.
stream() - Method in interface jakarta.nosql.TypedQuery: Executes the SELECT query and returns the results as a Stream of type T.

T

Template - Interface in jakarta.nosql: Template is a helper class that increases productivity when performing common NoSQL operations.
typedQuery(String, Class<T>) - Method in interface jakarta.nosql.Template: Creates a TypedQuery using the given query string and result type.
TypedQuery<T> - Interface in jakarta.nosql: A type-safe variant of Query that maps query results directly to the target type T.

U

udt() - Element in annotation interface jakarta.nosql.Column: (Optional) Defines the name of the user-defined type (UDT) used by the NoSQL database for this field.
update(Iterable<T>) - Method in interface jakarta.nosql.Template: Modifies entities that already exist in the database.
update(T) - Method in interface jakarta.nosql.Template: Modifies an entity that already exists in the database.

V

value() - Element in annotation interface jakarta.nosql.Column: (Optional) The name of the column.
value() - Element in annotation interface jakarta.nosql.Convert: Specifies the converter to be applied.
value() - Element in annotation interface jakarta.nosql.DiscriminatorColumn: (Optional) The name of the column to be used for the discriminator.
value() - Element in annotation interface jakarta.nosql.DiscriminatorValue: (Optional) The value that indicates that the row is an entity of the annotated entity type.
value() - Element in annotation interface jakarta.nosql.Embeddable: Specifies the embeddable type.
value() - Element in annotation interface jakarta.nosql.Entity: Defines the name of the NoSQL structure used to persist this entity.
value() - Element in annotation interface jakarta.nosql.Id: The name of the entity ID.
valueOf(String) - Static method in enum class jakarta.nosql.Embeddable.EmbeddableType: Returns the enum constant of this class with the specified name.
values() - Static method in enum class jakarta.nosql.Embeddable.EmbeddableType: Returns an array containing the constants of this enum class, in the order they are declared.

W

where(String) - Method in interface jakarta.nosql.QueryMapper.MapperDeleteFrom: Starts a new delete condition by specifying a column name.
where(String) - Method in interface jakarta.nosql.QueryMapper.MapperFrom: Starts a new condition by specifying a column name.

A B C D E F G I J L M N O P Q R S T U V W
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form