Count

This function can be used when counting field values and expressions.

Function	Description
`count()`	Counts a row, or whether a given value is truthy

`count`

The count function counts the number of times that the function is called. This is useful for returning the total number of records in a SELECT statement with a GROUP BY clause.

API DEFINITION

count() -> 1

If a value is given as the first argument, then this function checks whether a given value is truthy. This is useful for returning the total number of rows, which match a certain condition, in a SELECT statement, with a GROUP BY clause.

API DEFINITION

count(any) -> number

If an array is given, this function counts the number of items in the array which are truthy. If, instead, you want to count the total number of items in the given array, then use the array::len() function.

API DEFINITION

count(array) -> number

The following example shows this function, and its output, when used in a RETURN statement:

/**[test]

[[test.results]]
value = "1"

*/

RETURN count();

-- 1

/**[test]

[[test.results]]
value = "1"

*/

RETURN count(true);

-- 1

/**[test]

[[test.results]]
value = "0"

*/

RETURN count(10 > 15);

-- 0

/**[test]

[[test.results]]
value = "5"

[[test.results]]
value = "5"

*/

RETURN count([ 1, 2, 3, null, 0, false, (15 > 10), rand::uuid() ]);

5

The following examples show this function being used in a SELECT statement with a GROUP clause:

/**[test]

[[test.results]]
value = "[{ count: 3 }]"

*/

SELECT 
	count() 
FROM [
	{ age: 33 }, 
	{ age: 45 }, 
	{ age: 39 }
] 
GROUP ALL;

Response

[
	{ count: 3 }
]

/**[test]

[[test.results]]
value = "[{ count: 2 }]"

*/

SELECT 
	count(age > 35) 
FROM [
	{ age: 33 }, 
	{ age: 45 }, 
	{ age: 39 }
] 
GROUP ALL;

Response

[
	{ count: 2 }
]

An advanced example of the count function can be seen below:

/**[test]

[[test.results]]
value = "[{ country: GBR, total: 2 }, { country: USA, total: 2 }]"

*/

SELECT
	country,
	count(age > 30) AS total
FROM [
	{ age: 33, country: 'GBR' },
	{ age: 45, country: 'GBR' },
	{ age: 39, country: 'USA' },
	{ age: 29, country: 'GBR' },
	{ age: 43, country: 'USA' }
]
GROUP BY country;

Response

[
	{
		country: 'GBR',
		total: 2
	},
	{
		country: 'USA',
		total: 2
	}
]

Using a `COUNT` index with `count()`

Available since: v3.0.0

A COUNT index can be defined to speed up count() when used with a GROUP ALL clause. This allows count() to access a single stored value when it is called instead of iterating over the entire table.

/**[test]

[[test.results]]
value = "[{ id: user:dbb4iogxntigq3m11rdp }]"

[[test.results]]
value = "[{ count: 1 }]"

[[test.results]]
value = "[]"

[[test.results]]
value = "[{ count: 100001 }"

[[test.results]]
value = "NONE"

[[test.results]]
value = "[{ count: 100001 }]"

*/

CREATE user;
-- One record in table, very fast
SELECT count() FROM user GROUP ALL;

-- 10,000 new records,
-- count() takes a bit longer than before
CREATE |user:10000| RETURN NONE;
SELECT count() FROM user GROUP ALL;

-- Add index, wait a moment for it to build
DEFINE INDEX user_count ON user COUNT;
-- count() very performant again
SELECT count() FROM user GROUP ALL;

count

Using a COUNT index with count()

`count`

Using a `COUNT` index with `count()`