summaryrefslogtreecommitdiff
path: root/src/include/wiredtiger.in
diff options
context:
space:
mode:
authorKeith Bostic <keith@wiredtiger.com>2015-12-12 10:34:59 -0500
committerKeith Bostic <keith@wiredtiger.com>2015-12-12 10:34:59 -0500
commitf38bd7a3271dff84025131a96761e8d6a19b3eab (patch)
tree861a44096b4b7e50abc3e6c0f3853836168daf0a /src/include/wiredtiger.in
parente6550aed804c5cbe0d5e5c6d31a954b09afb7173 (diff)
downloadmongo-f38bd7a3271dff84025131a96761e8d6a19b3eab.tar.gz
Change the parameter to be called "sample_size" and to be a count of the
number of samples the application will perform (which might be 1000, or 0.1%).
Diffstat (limited to 'src/include/wiredtiger.in')
-rw-r--r--src/include/wiredtiger.in18
1 files changed, 10 insertions, 8 deletions
diff --git a/src/include/wiredtiger.in b/src/include/wiredtiger.in
index 62f2bb0712f..315d77e3fc5 100644
--- a/src/include/wiredtiger.in
+++ b/src/include/wiredtiger.in
@@ -923,14 +923,16 @@ struct __wt_session {
* record from the object when the WT_CURSOR::next method is called;
* valid only for row-store cursors. See @ref cursor_random for
* details., a boolean flag; default \c false.}
- * @config{next_random_sample_percent, cursors configured with \c
- * next_random to return pseudo-random records from the object randomly
- * select from the entire object\, by default. Setting \c
- * next_random_sample_percent to a non-zero value causes \c next_random
- * cursors to randomly select the first returned record from the object
- * as a whole\, and on subsequent returns to skip forward through the
- * specified percentage of pages in the tree\, returning a record from
- * the new location., an integer between 1 and 100; default \c 0.}
+ * @config{next_random_sample_size, cursors configured by \c next_random
+ * to return pseudo-random records from the object randomly select from
+ * the entire object\, by default. Setting \c next_random_sample_size
+ * to a non-zero value sets the number of samples the application
+ * expects to take using the \c next_random cursor. A cursor configured
+ * with both \c next_random and \c next_random_sample_size attempts to
+ * divide the object into \c next_random_sample_size equal-sized
+ * pieces\, and each retrieval returns a record from one of those
+ * pieces. See @ref cursor_random for details., an integer greater than
+ * or equal to 1; default \c 0.}
* @config{overwrite, configures whether the cursor's insert\, update
* and remove methods check the existing state of the record. If \c
* overwrite is \c false\, WT_CURSOR::insert fails with