jakarta.nosql.query

Interface UpdateQuery

All Superinterfaces:

Query

public interface UpdateQuery
extends Query

Updating an entity is done using an UPDATE statement.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	UpdateQuery.UpdateQueryProvider A provider to UpdateQuery

Method Summary

Modifier and Type	Method and Description
List<Condition>	getConditions() The list of changes as conditions.
String	getEntity() The entity name
Optional<JSONQueryValue>	getValue() Returns the value to update when the query uses JSON value instead of Conditions.
static UpdateQuery	parse(String query) Obtains an instance of UpdateQuery from a text string.

Method Detail

getEntity

String getEntity()

The entity name

Returns:

the entity name

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 update 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 UpdateQuery parse(String query)

Obtains an instance of UpdateQuery from a text string.

Parameters:

query - the query

Returns:

UpdateQuery instance

Throws:

NullPointerException - when the query is null

QuerySyntaxException - if the text cannot be parsed

ProviderNotFoundException - when the provider is not found