summaryrefslogtreecommitdiff
path: root/src/third_party/wiredtiger/src/docs/cursor-ops.dox
diff options
context:
space:
mode:
Diffstat (limited to 'src/third_party/wiredtiger/src/docs/cursor-ops.dox')
-rw-r--r--src/third_party/wiredtiger/src/docs/cursor-ops.dox8
1 files changed, 8 insertions, 0 deletions
diff --git a/src/third_party/wiredtiger/src/docs/cursor-ops.dox b/src/third_party/wiredtiger/src/docs/cursor-ops.dox
index 9618396a77c..c6d0d30b827 100644
--- a/src/third_party/wiredtiger/src/docs/cursor-ops.dox
+++ b/src/third_party/wiredtiger/src/docs/cursor-ops.dox
@@ -70,6 +70,14 @@ WT_CURSOR::search_near method:
@snippet ex_cursor.c cursor search near
+The WT_CURSOR::search_near method can also be used with a prefix key by
+setting \c prefix_search=true in the cursor configuration options. This
+optimization ensures that search_near only traverses the relevant key
+range with the matching prefix. Limiting the key range that search_near
+can traverse through is particularly useful when there are a larger number
+of records present outside of the key range which are not visible to the
+search_near caller.
+
Cursor positions do not survive transactions: cursors that are open during
WT_SESSION::begin_transaction, WT_SESSION::commit_transaction or
WT_SESSION::rollback_transaction will lose their position as if