`average()`

Description

Calculates the average value for a given property. Uses the SQL function AVG. If no records can be found to perform the calculation on you can use the ifNull argument to decide what should be returned.

Function Syntax

average(property [, where, include, distinct, parameterize, ifNull, includeSoftDeletes ])

Parameters

Parameter	Type	Required	Default	Description
`property`	`string`	Yes		Name of the property to calculate the average for.
`where`	`string`	No		This argument maps to the `WHERE` clause of the query. The following operators are supported: `=`, `!=`, `<>`, `<`, `<=`, `>`, `>=`, `LIKE`, `NOT LIKE`, `IN`, `NOT IN`, `IS NULL`, `IS NOT NULL`, `AND`, and `OR`. (Note that the key words need to be written in upper case.) You can also use parentheses to group statements. You do not need to specify the table name(s); Wheels will do that for you.
`include`	`string`	No		Associations that should be included in the query using `INNER` or `LEFT OUTER` joins (which join type that is used depends on how the association has been set up in your model). If all included associations are set on the current model, you can specify them in a list (e.g. `department,addresses,emails`). You can build more complex `include` strings by using parentheses when the association is set on an included model, like `album(artist(genre))`, for example. These complex `include` strings only work when `returnAs` is set to `query` though.
`distinct`	`boolean`	No	`false`	When `true`, `AVG` will be performed only on each unique instance of a value, regardless of how many times the value occurs.
`parameterize`	`any`	No	`true`	Set to `true` to use `cfqueryparam` on all columns, or pass in a list of property names to use `cfqueryparam` on those only.
`ifNull`	`any`	No		The value returned if no records are found. Common usage is to set this to `0` to make sure a numeric value is always returned instead of a blank string.
`includeSoftDeletes`	`boolean`	No	`false`	You can set this argument to `true` to include soft-deleted records in the results.

Examples

<!--- Get the average salary for all employees --->
<cfset avgSalary = model("employee").average("salary")>

<!--- Get the average salary for employees in a given department --->
<cfset avgSalary = model("employee").average(property="salary", where="departmentId=#params.key#")>

<!--- Make sure a numeric value is always returned if no records are calculated --->
<cfset avgSalary = model("employee").average(property="salary", where="salary BETWEEN #params.min# AND #params.max#", ifNull=0>