io.micronaut.data.model.query.builder

Interface QueryResult

public interface QueryResult

Used to represent a built query that is computed at compilation time.

Since:

1.0

Author:

graemerocher

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.String>	getAdditionalRequiredParameters() Returns additional required parameters.
default java.lang.String	getAggregate()
default int	getMax()
default long	getOffset()
java.util.List<QueryParameterBinding>	getParameterBindings() Returns the parameters binding for this query.
default java.util.Map<java.lang.String,java.lang.String>	getParameters() A map containing the parameter names and the references to the Argument names which define the values.
default java.util.Map<java.lang.String,DataType>	getParameterTypes()
java.lang.String	getQuery()
java.util.List<java.lang.String>	getQueryParts()
default java.lang.String	getUpdate()
static QueryResult	of(java.lang.String query, java.util.List<java.lang.String> queryParts, java.util.List<QueryParameterBinding> parameterBindings, java.util.Map<java.lang.String,java.lang.String> additionalRequiredParameters) Creates a new encoded query.
static QueryResult	of(java.lang.String query, java.util.List<java.lang.String> queryParts, java.util.List<QueryParameterBinding> parameterBindings, java.util.Map<java.lang.String,java.lang.String> additionalRequiredParameters, int max, long offset) Creates a new encoded query.

Method Detail

getQuery

@NonNull
java.lang.String getQuery()

Returns:

A string representation of the original query.

getUpdate

@Nullable
default java.lang.String getUpdate()

Returns:

A string representation of the update part.

getAggregate

@Nullable
default java.lang.String getAggregate()

Returns:

A string representation of the aggregate part.

getQueryParts

@NonNull
java.util.List<java.lang.String> getQueryParts()

Returns:

A string parts representation of the original query.

getParameters

@NonNull
default java.util.Map<java.lang.String,java.lang.String> getParameters()

A map containing the parameter names and the references to the Argument names which define the values. These can be used to resolve the runtime values to bind to the prepared statement.

Returns:

The map

getParameterTypes

@NonNull
default java.util.Map<java.lang.String,DataType> getParameterTypes()

Returns:

The computed parameter types.

getParameterBindings

java.util.List<QueryParameterBinding> getParameterBindings()

Returns the parameters binding for this query.

Returns:

the parameters binding

getAdditionalRequiredParameters

java.util.Map<java.lang.String,java.lang.String> getAdditionalRequiredParameters()

Returns additional required parameters.

Returns:

the additional required parameters

getMax

default int getMax()

getOffset

default long getOffset()

of

@NonNull
static QueryResult of(@NonNull
                               java.lang.String query,
                               @NonNull
                               java.util.List<java.lang.String> queryParts,
                               @NonNull
                               java.util.List<QueryParameterBinding> parameterBindings,
                               @NonNull
                               java.util.Map<java.lang.String,java.lang.String> additionalRequiredParameters)

Creates a new encoded query.

Parameters:

query - The query

queryParts - The queryParts

parameterBindings - The parameters binding

additionalRequiredParameters - Additional required parameters to execute the query

Returns:

The query

of

@NonNull
static QueryResult of(@NonNull
                               java.lang.String query,
                               @NonNull
                               java.util.List<java.lang.String> queryParts,
                               @NonNull
                               java.util.List<QueryParameterBinding> parameterBindings,
                               @NonNull
                               java.util.Map<java.lang.String,java.lang.String> additionalRequiredParameters,
                               int max,
                               long offset)

Creates a new encoded query.

Parameters:

query - The query

queryParts - The queryParts

parameterBindings - The parameters binding

additionalRequiredParameters - Additional required parameters to execute the query

max - The query limit

offset - The query offset

Returns:

The query