ReQL command: sample

Command syntax

sequence.sample(number) → selection
stream.sample(number) → array
array.sample(number) → array

Description

Select a given number of elements from a sequence with uniform random distribution. Selection is done without replacement.

If the sequence has less than the requested number of elements (i.e., calling sample(10) on a sequence with only five elements), sample will return the entire sequence in a random order.

Example: Select 3 random heroes.

r.table('marvel').sample(3).run(conn, callback)

Example: Select and stratify 3 random heroes by belovedness.

r.table('marvel').group('belovedness').sample(3).run(conn, callback)

© RethinkDB contributors
Licensed under the Creative Commons Attribution-ShareAlike 3.0 Unported License.
https://rethinkdb.com/api/javascript/sample/