Projections (Grace Data - 2024.1.0-RC1)

org.grails.datastore.mapping.query.Projections

```
public class Projections
extends Object
```
Projections used to customize the results of a query
Authors:
Graeme Rocher
Since:
1.0

Field Summary

Fields
Modifiers	Name	Description
`static CountProjection`	`COUNT_PROJECTION`
`static IdProjection`	`ID_PROJECTION`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`public static AvgProjection`	`avg(String name)` Computes the average value of a property
	`public static CountProjection`	`count()` Projection that returns the number of records from the query instead of the results themselves
	`public static CountDistinctProjection`	`countDistinct(String property)` Projection that signifies to return only distinct results
	`public static DistinctProjection`	`distinct()` Projection that signifies to return only distinct results
	`public static DistinctPropertyProjection`	`distinct(String property)` Projection that signifies to return only distinct results
	`public static GroupPropertyProjection`	`groupProperty(String property)` Defines a group by projection for datastores that support it
	`public static IdProjection`	`id()` Projection used to obtain the id of an object
	`public static MaxProjection`	`max(String name)` Computes the max value of a property
	`public static MinProjection`	`min(String name)` Computes the min value of a property
	`public static PropertyProjection`	`property(String name)` A projection that obtains the value of a property of an entity
	`public static SumProjection`	`sum(String name)` Computes the sum of a property

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- Field Detail
  - public static final CountProjection COUNT_PROJECTION
  - public static final IdProjection ID_PROJECTION
- Method Detail
  - public static AvgProjection avg(String name)
    
    Computes the average value of a property
    Parameters:
    name - The name of the property
    Returns:
    The PropertyProjection instance
  - public static CountProjection count()
    
    Projection that returns the number of records from the query instead of the results themselves
    Returns:
    The CountProjection instance
  - public static CountDistinctProjection countDistinct(String property)
    
    Projection that signifies to return only distinct results
    Parameters:
    property - The name of the property
    Returns:
    Distinct projection
  - public static DistinctProjection distinct()
    
    Projection that signifies to return only distinct results
    Returns:
    Distinct projection
  - public static DistinctPropertyProjection distinct(String property)
    
    Projection that signifies to return only distinct results
    Parameters:
    property - The name of the property
    Returns:
    Distinct projection
  - public static GroupPropertyProjection groupProperty(String property)
    
    Defines a group by projection for datastores that support it
    Parameters:
    property - The property name
    Returns:
    The projection list
  - public static IdProjection id()
    
    Projection used to obtain the id of an object
    Returns:
    The IdProjection instance
  - public static MaxProjection max(String name)
    
    Computes the max value of a property
    Parameters:
    name - The name of the property
    Returns:
    The PropertyProjection instance
  - public static MinProjection min(String name)
    
    Computes the min value of a property
    Parameters:
    name - The name of the property
    Returns:
    The PropertyProjection instance
  - public static PropertyProjection property(String name)
    
    A projection that obtains the value of a property of an entity
    Parameters:
    name - The name of the property
    Returns:
    The PropertyProjection instance
  - public static SumProjection sum(String name)
    
    Computes the sum of a property
    Parameters:
    name - The name of the property
    Returns:
    The PropertyProjection instance

Summary:
Field
Method

| Detail:
Field
Method

Groovy Documentation

[Java] Class Projections

Field Summary

Methods Summary

Inherited Methods Summary

Field Detail

public static final CountProjection COUNT_PROJECTION

public static final IdProjection ID_PROJECTION

Method Detail

public static AvgProjection avg(String name)

public static CountProjection count()

public static CountDistinctProjection countDistinct(String property)

public static DistinctProjection distinct()

public static DistinctPropertyProjection distinct(String property)

public static GroupPropertyProjection groupProperty(String property)

public static IdProjection id()

public static MaxProjection max(String name)

public static MinProjection min(String name)

public static PropertyProjection property(String name)

public static SumProjection sum(String name)