jakarta.nosql.query

Interface DeleteQuery

All Superinterfaces:

Query

public interface DeleteQuery
extends Query

Deleting either an entity or fields uses the DELETE statement

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DeleteQuery.DeleteQueryProvider A provider to DeleteQuery

Method Summary

Modifier and Type	Method and Description
String	getEntity() The entity name
List<String>	getFields() The fields that will delete in this query, if this fields is empty, this query will remove the whole entity.
Optional<Where>	getWhere() The condition at this DeleteQuery, if the Where is empty that means will delete the whole entities.
static DeleteQuery	parse(String query) Obtains an instance of DeleteQuery from a text string.

Method Detail

getFields

List<String> getFields()

The fields that will delete in this query, if this fields is empty, this query will remove the whole entity.

Returns:

the fields list

getEntity

String getEntity()

The entity name

Returns:

the entity name

getWhere

Optional<Where> getWhere()

The condition at this DeleteQuery, if the Where is empty that means will delete the whole entities.

Returns:

the Where entity otherwise Optional.empty()

parse

static DeleteQuery parse(String query)

Obtains an instance of DeleteQuery from a text string.

Parameters:

query - the query

Returns:

DeleteQuery instance

Throws:

NullPointerException - when the query is null

QuerySyntaxException - if the text cannot be parsed

ProviderNotFoundException - when the provider is not found