Module storm

Package st.orm.template.impl

Class DeleteBuilderImpl<T extends Record,ID>

java.lang.Object

st.orm.template.QueryBuilder<T,Object,ID>

st.orm.template.impl.DeleteBuilderImpl<T,ID>

Type Parameters:

T - the type of the table being queried.

ID - the type of the primary key.

All Implemented Interfaces:

Subqueryable

public class DeleteBuilderImpl<T extends Record,ID>
extends QueryBuilder<T,Object,ID>

DeleteBuilderImpl relies on preview features of the Java platform:

• DeleteBuilderImpl refers to one or more preview APIs: StringTemplate.

Programs can only use DeleteBuilderImpl when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

A query builder for DELETE queries.

Nested Class Summary

Nested classes/interfaces inherited from class st.orm.template.QueryBuilder

QueryBuilder.JoinBuilder<T extends Record,R,ID>, QueryBuilder.PredicateBuilder<T extends Record,R,ID>, QueryBuilder.TypedJoinBuilder<T extends Record,R,ID>, QueryBuilder.WhereBuilder<T extends Record,R,ID>

Field Summary

Fields

Modifier and Type	Field	Description
protected final Class<T>	fromType
protected final List<st.orm.template.impl.Join>	join
protected final Supplier<Model<T,ID>>	modelSupplier
protected final QueryTemplate	queryTemplate
protected final List<StringTemplatePREVIEW>	templates
protected final List<Elements.Where>	where

Constructor Summary

Constructors

Constructor	Description
DeleteBuilderImpl(QueryTemplate queryTemplate, Class<T> fromType, Supplier<Model<T,ID>> modelSupplier)

Method Summary

Modifier and Type	Method	Description
QueryBuilder<T,Object,ID>	append(StringTemplatePREVIEW template)	Append the query with a string template.
Query	build()	Builds the query based on the current state of the query builder.
QueryBuilder<T,Object,ID>	crossJoin(Class<? extends Record> relation)	Adds a cross join to the query.
QueryBuilder<T,Object,ID>	crossJoin(StringTemplatePREVIEW template)	Adds a cross join to the query.
QueryBuilder<T,Object,ID>	distinct()	Marks the current query as a distinct query.
QueryBuilder<T,Object,ID>	forLock(StringTemplatePREVIEW template)	Locks the selected rows using a custom lock mode.
QueryBuilder<T,Object,ID>	forShare()	Locks the selected rows for reading.
QueryBuilder<T,Object,ID>	forUpdate()	Locks the selected rows for reading.
Stream<Object>	getResultStream()	Executes the query and returns a stream of results.
StringTemplatePREVIEW	getSubquery()	Returns the template for the query for the subquery.
QueryBuilder.TypedJoinBuilder<T,Object,ID>	innerJoin(Class<? extends Record> relation)	Adds an inner join to the query.
QueryBuilder.JoinBuilder<T,Object,ID>	innerJoin(StringTemplatePREVIEW template, String alias)	Adds an inner join to the query.
QueryBuilder.TypedJoinBuilder<T,Object,ID>	join(JoinType type, Class<? extends Record> relation, String alias)	Adds a join of the specified type to the query.
QueryBuilder.JoinBuilder<T,Object,ID>	join(JoinType type, StringTemplatePREVIEW template, String alias)	Adds a join of the specified type to the query using a template.
QueryBuilder.JoinBuilder<T,Object,ID>	join(JoinType type, QueryBuilder<?,?,?> subquery, String alias)	Adds a join of the specified type to the query using a subquery.
QueryBuilder.TypedJoinBuilder<T,Object,ID>	leftJoin(Class<? extends Record> relation)	Adds a left join to the query.
QueryBuilder.JoinBuilder<T,Object,ID>	leftJoin(StringTemplatePREVIEW template, String alias)	Adds a left join to the query.
QueryBuilder<T,Object,ID>	limit(int limit)	Adds a LIMIT clause to the query.
QueryBuilder<T,Object,ID>	offset(int offset)	Adds an OFFSET clause to the query.
QueryBuilder.TypedJoinBuilder<T,Object,ID>	rightJoin(Class<? extends Record> relation)	Adds a right join to the query.
QueryBuilder.JoinBuilder<T,Object,ID>	rightJoin(StringTemplatePREVIEW template, String alias)	Adds a right join to the query.
QueryBuilder<T,Object,ID>	safe()	Returns a query builder that does not require a WHERE clause for UPDATE and DELETE queries.
protected boolean	supportsJoin()	Indicates whether the DELETE query supports joins.
<X> QueryBuilder<T,Object,X>	typed(Class<X> pkType)	Returns a typed query builder for the specified primary key type.
QueryBuilder<T,Object,ID>	where(Function<QueryBuilder.WhereBuilder<T,Object,ID>,QueryBuilder.PredicateBuilder<?,?,?>> predicate)	Adds a WHERE clause to the query using a QueryBuilder.WhereBuilder.

Methods inherited from class st.orm.template.QueryBuilder

executeUpdate, getOptionalResult, getResult, getResultCount, getResultList, getSingleResult, groupBy, groupBy, groupBy, groupByAny, having, having, havingAny, orderBy, orderBy, orderBy, orderByAny, orderByDescending, prepare, slice, slice, where, where, where, where, where, where, where, where, where, where, whereId, whereRef, whereRef

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

queryTemplate

protected final QueryTemplate queryTemplate

fromType

protected final Class<T extends Record> fromType

join

protected final List<st.orm.template.impl.Join> join

where

protected final List<Elements.Where> where

templates

protected final List<StringTemplatePREVIEW> templates

modelSupplier

protected final Supplier<Model<T extends Record,ID>> modelSupplier

Constructor Details

DeleteBuilderImpl

public DeleteBuilderImpl(@Nonnull
 QueryTemplate queryTemplate,
 @Nonnull
 Class<T> fromType,
 @Nonnull
 Supplier<Model<T,ID>> modelSupplier)

Method Details

safe

public QueryBuilder<T,Object,ID> safe()

Returns a query builder that does not require a WHERE clause for UPDATE and DELETE queries.

This method is used to prevent accidental updates or deletions of all records in a table when a WHERE clause is not provided.

Specified by:

safe in class QueryBuilder<T extends Record,Object,ID>

Since:

1.2

supportsJoin

protected boolean supportsJoin()

Indicates whether the DELETE query supports joins.

Returns:

true if the query supports joins, false otherwise.

distinct

public QueryBuilder<T,Object,ID> distinct()

Marks the current query as a distinct query.

Specified by:

distinct in class QueryBuilder<T extends Record,Object,ID>

Returns:

the query builder.

offset

public QueryBuilder<T,Object,ID> offset(int offset)

Adds an OFFSET clause to the query.

Specified by:

offset in class QueryBuilder<T extends Record,Object,ID>

Parameters:

offset - the offset.

Returns:

the query builder.

Since:

1.2

limit

public QueryBuilder<T,Object,ID> limit(int limit)

Adds a LIMIT clause to the query.

Specified by:

limit in class QueryBuilder<T extends Record,Object,ID>

Parameters:

limit - the maximum number of records to return.

Returns:

the query builder.

Since:

1.2

forShare

public QueryBuilder<T,Object,ID> forShare()

Locks the selected rows for reading.

Specified by:

forShare in class QueryBuilder<T extends Record,Object,ID>

Returns:

the query builder.

Throws:

PersistenceException - if the database does not support the specified lock mode, or if the lock mode is not supported for the current query.

forUpdate

public QueryBuilder<T,Object,ID> forUpdate()

Locks the selected rows for reading.

Specified by:

forUpdate in class QueryBuilder<T extends Record,Object,ID>

Returns:

the query builder.

Throws:

PersistenceException - if the database does not support the specified lock mode, or if the lock mode is not supported for the current query.

forLock

public QueryBuilder<T,Object,ID> forLock(@Nonnull
 StringTemplatePREVIEW template)

Locks the selected rows using a custom lock mode.

Note that this method results in non-portable code, as the lock mode is specific to the underlying database.

Specified by:

forLock in class QueryBuilder<T extends Record,Object,ID>

Returns:

the query builder.

Throws:

PersistenceException - if the lock mode is not supported for the current query.

getSubquery

public StringTemplatePREVIEW getSubquery()

Description copied from interface: Subqueryable

Returns the template for the query for the subquery.

Returns:

the template.

build

public Query build()

Builds the query based on the current state of the query builder.

Specified by:

build in class QueryBuilder<T extends Record,Object,ID>

Returns:

the constructed query.

getResultStream

public Stream<Object> getResultStream()

Executes the query and returns a stream of results.

The resulting stream is lazily loaded, meaning that the records are only retrieved from the database as they are consumed by the stream. This approach is efficient and minimizes the memory footprint, especially when dealing with large volumes of records.

Note that calling this method does trigger the execution of the underlying query, so it should only be invoked when the query is intended to run. Since the stream holds resources open while in use, it must be closed after usage to prevent resource leaks. As the stream is AutoCloseable, it is recommended to use it within a try-with-resources block.

Specified by:

getResultStream in class QueryBuilder<T extends Record,Object,ID>

Returns:

a stream of results.

Throws:

PersistenceException - if the query operation fails due to underlying database issues, such as connectivity.

typed

public <X> QueryBuilder<T,Object,X> typed(@Nonnull
 Class<X> pkType)

Returns a typed query builder for the specified primary key type.

Specified by:

typed in class QueryBuilder<T extends Record,R,ID>

Type Parameters:

X - the type of the primary key.

Parameters:

pkType - the primary key type.

Returns:

the typed query builder.

Throws:

PersistenceException - if the pk type is not valid.

Since:

1.2

append

public QueryBuilder<T,Object,ID> append(@Nonnull
 StringTemplatePREVIEW template)

Append the query with a string template.

Specified by:

append in class QueryBuilder<T extends Record,R,ID>

Parameters:

template - the string template to append.

Returns:

the query builder.

crossJoin

public QueryBuilder<T,Object,ID> crossJoin(@Nonnull
 Class<? extends Record> relation)

Adds a cross join to the query.

Specified by:

crossJoin in class QueryBuilder<T extends Record,R,ID>

Parameters:

relation - the relation to join.

Returns:

the query builder.

innerJoin

public QueryBuilder.TypedJoinBuilder<T,Object,ID> innerJoin(@Nonnull
 Class<? extends Record> relation)

Adds an inner join to the query.

Specified by:

innerJoin in class QueryBuilder<T extends Record,R,ID>

Parameters:

relation - the relation to join.

Returns:

the query builder.

leftJoin

public QueryBuilder.TypedJoinBuilder<T,Object,ID> leftJoin(@Nonnull
 Class<? extends Record> relation)

Adds a left join to the query.

Specified by:

leftJoin in class QueryBuilder<T extends Record,R,ID>

Parameters:

relation - the relation to join.

Returns:

the query builder.

rightJoin

public QueryBuilder.TypedJoinBuilder<T,Object,ID> rightJoin(@Nonnull
 Class<? extends Record> relation)

Adds a right join to the query.

Specified by:

rightJoin in class QueryBuilder<T extends Record,R,ID>

Parameters:

relation - the relation to join.

Returns:

the query builder.

join

public QueryBuilder.JoinBuilder<T,Object,ID> join(@Nonnull
 JoinType type,
 @Nonnull
 StringTemplatePREVIEW template,
 @Nonnull
 String alias)

Adds a join of the specified type to the query using a template.

Specified by:

join in class QueryBuilder<T extends Record,R,ID>

Parameters:

type - the join type.

template - the template to join.

alias - the alias to use for the joined relation.

Returns:

the query builder.

join

public QueryBuilder.JoinBuilder<T,Object,ID> join(@Nonnull
 JoinType type,
 @Nonnull
 QueryBuilder<?,?,?> subquery,
 @Nonnull
 String alias)

Adds a join of the specified type to the query using a subquery.

Specified by:

join in class QueryBuilder<T extends Record,R,ID>

Parameters:

type - the join type.

subquery - the subquery to join.

alias - the alias to use for the joined relation.

Returns:

the query builder.

crossJoin

public QueryBuilder<T,Object,ID> crossJoin(@Nonnull
 StringTemplatePREVIEW template)

Adds a cross join to the query.

Specified by:

crossJoin in class QueryBuilder<T extends Record,R,ID>

Parameters:

template - the template to join.

Returns:

the query builder.

innerJoin

public QueryBuilder.JoinBuilder<T,Object,ID> innerJoin(@Nonnull
 StringTemplatePREVIEW template,
 @Nonnull
 String alias)

Adds an inner join to the query.

Specified by:

innerJoin in class QueryBuilder<T extends Record,R,ID>

Parameters:

template - the template to join.

alias - the alias to use for the joined relation.

Returns:

the query builder.

leftJoin

public QueryBuilder.JoinBuilder<T,Object,ID> leftJoin(@Nonnull
 StringTemplatePREVIEW template,
 @Nonnull
 String alias)

Adds a left join to the query.

Specified by:

leftJoin in class QueryBuilder<T extends Record,R,ID>

Parameters:

template - the template to join.

alias - the alias to use for the joined relation.

Returns:

the query builder.

rightJoin

public QueryBuilder.JoinBuilder<T,Object,ID> rightJoin(@Nonnull
 StringTemplatePREVIEW template,
 @Nonnull
 String alias)

Adds a right join to the query.

Specified by:

rightJoin in class QueryBuilder<T extends Record,R,ID>

Parameters:

template - the template to join.

alias - the alias to use for the joined relation.

Returns:

the query builder.

join

public QueryBuilder.TypedJoinBuilder<T,Object,ID> join(@Nonnull
 JoinType type,
 @Nonnull
 Class<? extends Record> relation,
 @Nonnull
 String alias)

Adds a join of the specified type to the query.

Specified by:

join in class QueryBuilder<T extends Record,R,ID>

Parameters:

type - the type of the join (e.g., INNER, LEFT, RIGHT).

relation - the relation to join.

alias - the alias to use for the joined relation.

Returns:

the query builder.

where

public QueryBuilder<T,Object,ID> where(@Nonnull
 Function<QueryBuilder.WhereBuilder<T,Object,ID>,QueryBuilder.PredicateBuilder<?,?,?>> predicate)

Adds a WHERE clause to the query using a QueryBuilder.WhereBuilder.

Specified by:

where in class QueryBuilder<T extends Record,R,ID>

Parameters:

predicate - the predicate to add.

Returns:

the query builder.