diff options
author | Michael Cahill <michael.cahill@wiredtiger.com> | 2013-06-19 10:59:47 +1000 |
---|---|---|
committer | Michael Cahill <michael.cahill@wiredtiger.com> | 2013-06-19 10:59:47 +1000 |
commit | 952389d109ad75bd2fcf3b161cc41427a846eaba (patch) | |
tree | 0161ba1c69c7bdb801c8cd976e68dbbbc3eee3aa | |
parent | a9eaa81d90f43a59acdeaeebc98275f1b17172d9 (diff) | |
download | mongo-952389d109ad75bd2fcf3b161cc41427a846eaba.tar.gz |
Minor edit to the upgrade wording for the overwrite API change.
refs #512
-rw-r--r-- | src/docs/upgrading.dox | 36 |
1 files changed, 18 insertions, 18 deletions
diff --git a/src/docs/upgrading.dox b/src/docs/upgrading.dox index c77a82149ce..8ea4abfa605 100644 --- a/src/docs/upgrading.dox +++ b/src/docs/upgrading.dox @@ -5,29 +5,29 @@ <dt>Cursor overwrite configuration</dt> <dd> -In previous releases, the WT_SESSION::open_cursor "overwrite" configuration -string behaved inconsistently across Btree and LSM tables. In Btree tables, -"overwrite" was configured \c off by default and was limited to the -WT_CURSOR::insert method, changing an insert to succeed regardless of whether -or not the record previously existed. In LSM tables, "overwrite" was -configured \c on by default, and applied to the WT_CURSOR::insert, -WT_CURSOR::remove and WT_CURSOR::update methods, configuring all three methods -to ignore the existing state of the record. - -In the 1.6.3 release, the "overwrite" configuration is consistent across both -Btree and LSM tables, and, for performance reasons, defaults to the behavior -previously described for LSM tables: in other words, "overwrite" is configured -to \c on by default, causing WT_CURSOR::insert, WT_CURSOR::remove and +In previous releases, the WT_SESSION::open_cursor \c overwrite configuration +string behaved inconsistently across Btree and LSM data sources. In Btree, +\c overwrite was \c false by default and was limited to the WT_CURSOR::insert +method, changing an insert to succeed regardless of whether or not the record +previously existed. In LSM trees, \c overwrite was \c true by default, and +applied to the WT_CURSOR::insert, WT_CURSOR::remove and WT_CURSOR::update +methods, configuring all three methods to ignore the existing state of the +record. + +In the 1.6.3 release, the \c overwrite configuration is consistent across both +Btree and LSM tree data source. For performance reasons, the default is the +behavior previously described for LSM trees: in other words, \c overwrite is +\c true by default, causing WT_CURSOR::insert, WT_CURSOR::remove and WT_CURSOR::update to ignore the current state of the record, and these methods will succeed regardless of whether or not the record previously exists. When -an application configures "overwrite" to \c off, WT_CURSOR::insert will fail -with ::WT_DUPLICATE_KEY if the record previously exists, and WT_CURSOR::update +an application configures \c overwrite to \c false, WT_CURSOR::insert will fail +with ::WT_DUPLICATE_KEY if the record previously exists, and WT_CURSOR::update and WT_CURSOR::remove will fail with ::WT_NOTFOUND if the record does not previously exist. -<b>This is a potentially serious change for applications that will not be -detected by compilation.</b> Application cursors should be reviewed to -confirm they are configured for the desired behavior. +<b>This is a potentially serious API change that will not be detected by +compilation.</b> Application cursors should be reviewed to confirm they are +configured for the desired behavior. </dd> </dl> |