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
default java.util.Set<java.lang.String>	getAdditionalRequiredParameters() Returns the names of additional required parameters for this query.
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.
java.util.Map<java.lang.String,DataType>	getParameterTypes()
java.lang.String	getQuery()
static QueryResult	of(java.lang.String query, java.util.Map<java.lang.String,java.lang.String> parameters, java.util.Map<java.lang.String,DataType> parameterTypes, java.util.Set<java.lang.String> additionalRequiredParameters) Creates a new encoded query.

Method Detail

getQuery

@NonNull
java.lang.String getQuery()

Returns:

A string representation of the original query.

getParameters

@NonNull
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
java.util.Map<java.lang.String,DataType> getParameterTypes()

Returns:

The computed parameter types.

getAdditionalRequiredParameters

default java.util.Set<java.lang.String> getAdditionalRequiredParameters()

Returns the names of additional required parameters for this query.

Returns:

The additional required parameters, if any

of

@NonNull
static QueryResult of(@NonNull
                               java.lang.String query,
                               @Nullable
                               java.util.Map<java.lang.String,java.lang.String> parameters,
                               @Nullable
                               java.util.Map<java.lang.String,DataType> parameterTypes,
                               @Nullable
                               java.util.Set<java.lang.String> additionalRequiredParameters)

Creates a new encoded query.

Parameters:

query - The query

parameters - The parameters

parameterTypes - The parameter types

additionalRequiredParameters - Names of the additional required parameters to execute the query

Returns:

The query