Package 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 Details

    • getQuery

      String getQuery()
      Returns:
      A string representation of the original query.

    • getUpdate

      default @Nullable String getUpdate()
      Returns:
      A string representation of the update part.

    • getAggregate

      @Deprecated(forRemoval=true, since="4.10") default @Nullable String getAggregate()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Not used
      Returns:
      A string representation of the aggregate part.

    • getQueryParts

      List<String> getQueryParts()
      Returns:
      A string parts representation of the original query.

    • getParameters

      default Map<String,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

      default Map<String,DataType> getParameterTypes()
      Returns:
      The computed parameter types.

    • getParameterBindings

      List<QueryParameterBinding> getParameterBindings()
      Returns the parameters binding for this query.
      Returns:
      the parameters binding

    • getAdditionalRequiredParameters

      default Map<String,String> getAdditionalRequiredParameters()
      Returns additional required parameters.
      Returns:
      the additional required parameters

    • getMax

      default int getMax()

    • getOffset

      default long getOffset()

    • getSort

      default Sort getSort()

    • getJoinPaths

      default Collection<JoinPath> getJoinPaths()
      Gets the join paths.
      Returns:
      the join paths or empty

    • of

      static QueryResult of(String query, List<QueryParameterBinding> parameterBindings)
      Creates a new encoded query.
      Parameters:
      query - The query
      parameterBindings - The parameters binding
      Returns:
      The query
      Since:
      4.10

    • of

      static QueryResult of(String query, List<String> queryParts, List<QueryParameterBinding> parameterBindings, Map<String,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

      static QueryResult of(String query, List<String> queryParts, List<QueryParameterBinding> parameterBindings)
      Creates a new encoded query.
      Parameters:
      query - The query
      queryParts - The queryParts
      parameterBindings - The parameters binding
      Returns:
      The query

    • of

      static QueryResult of(String query, List<String> queryParts, List<QueryParameterBinding> parameterBindings, Map<String,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

    • of

      static QueryResult of(String query, List<String> queryParts, List<QueryParameterBinding> parameterBindings, Map<String,String> additionalRequiredParameters, int max, long offset, @Nullable Collection<JoinPath> joinPaths)
      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
      joinPaths - The join paths
      Returns:
      The query

    • of

      static QueryResult of(String query, List<String> queryParts, List<QueryParameterBinding> parameterBindings, int max, long offset, @Nullable Collection<JoinPath> joinPaths)
      Creates a new encoded query.
      Parameters:
      query - The query
      queryParts - The queryParts
      parameterBindings - The parameters binding
      max - The query limit
      offset - The query offset
      joinPaths - The join paths
      Returns:
      The query

    • of

      static QueryResult of(String query, List<String> queryParts, List<QueryParameterBinding> parameterBindings, int max, long offset, Sort sort, @Nullable Collection<JoinPath> joinPaths)
      Creates a new encoded query.
      Parameters:
      query - The query
      queryParts - The queryParts
      parameterBindings - The parameters binding
      max - The query limit
      offset - The query offset
      sort - The sort
      joinPaths - The join paths
      Returns:
      The query

    • of

      static QueryResult of(String query, List<String> queryParts, List<QueryParameterBinding> parameterBindings, @Nullable Collection<JoinPath> joinPaths)
      Creates a new encoded query.
      Parameters:
      query - The query
      queryParts - The queryParts
      parameterBindings - The parameters binding
      joinPaths - The join paths
      Returns:
      The query