diff options
| author | Alex Gorrod <alexg@wiredtiger.com> | 2015-04-09 07:36:25 +0000 |
|---|---|---|
| committer | Alex Gorrod <alexg@wiredtiger.com> | 2015-04-09 07:36:25 +0000 |
| commit | 7609a565a11952c2ca14642dc2c837552dc1e86a (patch) | |
| tree | 2e2b7582df24dad8b7564eb33c174b37c6ff0a58 /src/docs/transactions.dox | |
| parent | 0a590331fdf5176ebbfbc6cb73a84c98b78d7af3 (diff) | |
| download | mongo-7609a565a11952c2ca14642dc2c837552dc1e86a.tar.gz | |
Update documentation for WT_SESSION::snapshot API.
Diffstat (limited to 'src/docs/transactions.dox')
| -rw-r--r-- | src/docs/transactions.dox | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/src/docs/transactions.dox b/src/docs/transactions.dox index 5bd74872fa8..32868b70335 100644 --- a/src/docs/transactions.dox +++ b/src/docs/transactions.dox @@ -129,22 +129,22 @@ re-configured on a per-session basis: @section transaction_named_snapshots Named Snapshots -Applications can create named snapshots by calling WT_SESSION::checkpoint -with a configuration that includes <code>"snapshot=(name=foo)"</code>. +Applications can create named snapshots by calling WT_SESSION::snapshot +with a configuration that includes <code>"name=foo"</code>. This configuration creates a new named snapshot, as if a snapshot isolation -transaction were started at the time of the WT_SESSION::checkpoint call. +transaction were started at the time of the WT_SESSION::snapshot call. -Subsequent transactions can be starts "as of" that snapshot by calling +Subsequent transactions can be started "as of" that snapshot by calling WT_SESSION::begin_transaction with a configuration that includes <code>snapshot=foo</code>. That transaction will run at snapshot isolation -as if the transaction started at the time of the WT_SESSION::checkpoint +as if the transaction started at the time of the WT_SESSION::snapshot call that created the snapshot. Named snapshots keep data pinned in cache as if a real transaction were running for the time that the named transaction is active. The resources associated with a named snapshot are released by calling -WT_SESSION::checkpoint with a configuration that includes -<code>"snapshot=(drop_to=foo)"</code>. +WT_SESSION::snapshot with a configuration that includes +<code>"drop=(to=foo)"</code>. Named snapshots are not durable: they do not survive WT_CONNECTION::close. */ |