Module is.codion.framework.domain

Package is.codion.framework.domain.entity.query

Interface EntitySelectQuery

public sealed interface EntitySelectQuery

Defines a select query or parts of a select query, that is, from, columns, where, groupBy, having and orderBy clauses. Supports Common Table Expressions (CTEs) via the EntitySelectQuery.Builder.with(String) method. EntitySelectQuery.Builder provided by builder().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntitySelectQuery.Builder	Builds a EntitySelectQuery.

Method Summary

Modifier and Type	Method	Description
static EntitySelectQuery.Builder	builder()	Creates a EntitySelectQuery.Builder
@Nullable String	columns()
@Nullable String	from()
@Nullable String	groupBy()
@Nullable String	having()
@Nullable String	orderBy()
@Nullable String	where()
Map<String,String>	with()
boolean	withRecursive()

Method Details

with

Map<String,String> with()

Returns:

the map of CTE names to their queries, empty if no CTEs defined

withRecursive

boolean withRecursive()

Returns:

true if the WITH clause should be marked as RECURSIVE

columns

@Nullable String columns()

Returns:

the COLUMNS clause

from

@Nullable String from()

Returns:

the FROM clause

where

@Nullable String where()

Returns:

the WHERE clause

groupBy

@Nullable String groupBy()

Returns:

the GROUP BY clause

having

@Nullable String having()

Returns:

the HAVING clause

orderBy

@Nullable String orderBy()

Returns:

the order by clause

builder

static EntitySelectQuery.Builder builder()

Creates a EntitySelectQuery.Builder

Returns:

a new EntitySelectQuery.Builder instance.