jakarta.nosql.query

Interface InsertQuery

All Superinterfaces:

Query

public interface InsertQuery
extends Query

Inserting data for an entity is done using an INSERT statement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	InsertQuery.InsertQueryProvider A provider to InsertQuery

Method Summary

Modifier and Type	Method and Description
List<Condition>	getConditions() The list of changes as conditions.
String	getEntity() The entity name
Optional<Duration>	getTtl() This duration set a time for data in an entity to expire.
Optional<JSONQueryValue>	getValue() Returns the value to insert when the query uses JSON value instead of Conditions.
static InsertQuery	parse(String query) Obtains an instance of InsertQuery.InsertQueryProvider from a text string.

Method Detail

getEntity

String getEntity()

The entity name

Returns:

the entity

getTtl

Optional<Duration> getTtl()

This duration set a time for data in an entity to expire. It defines the time to live of an object in a database.

Returns:

the TTL otherwise Optional.empty()

getConditions

List<Condition> getConditions()

The list of changes as conditions. Each condition will use the equals operator, Operator.EQUALS, e.g., name = "any name"

Returns:

the conditions

getValue

Optional<JSONQueryValue> getValue()

Returns the value to insert when the query uses JSON value instead of Conditions. In an insert, an operation is not able to use both: getConditions() and getValue(). Therefore, execution will use just one operation type.

Returns:

a JSONQueryValue or Optional.empty() when it uses getConditions()

parse

static InsertQuery parse(String query)

Obtains an instance of InsertQuery.InsertQueryProvider from a text string.

Parameters:

query - the query

Returns:

InsertQuery.InsertQueryProvider instance

Throws:

NullPointerException - when the query is null

QuerySyntaxException - if the text cannot be parsed

ProviderNotFoundException - when the provider is not found