Back to top

ReQL command: sum

Command syntax

sequence.sum([field | function]) → number

r.sum(sequence, [field | function]) → number

Description

Sums all the elements of a sequence. If called with a field name, sums all the values of that field in the sequence, skipping elements of the sequence that lack that field. If called with a function, calls that function on every element of the sequence and sums the results, skipping elements of the sequence where that function returns null or a non-existence error.

Returns 0 when called on an empty sequence.

Example: What’s 3 + 5 + 7?

r.expr([3, 5, 7]).sum().run(conn, callback)

Example: How many points have been scored across all games?

r.table('games').sum('points').run(conn, callback)

Example: How many points have been scored across all games, counting bonus points?

r.table('games').sum(function(game) {
    return game('points').add(game('bonus_points'))
}).run(conn, callback)

Get more help

Couldn't find what you were looking for?