diff options
author | Luke Chen <luke.chen@mongodb.com> | 2022-03-02 17:10:12 +1100 |
---|---|---|
committer | Evergreen Agent <no-reply@evergreen.mongodb.com> | 2022-03-02 06:46:31 +0000 |
commit | 1a331d9b3216fb317c784e6a3857414385ccc654 (patch) | |
tree | 7adb6b3aa83993b475f8550e53b84311c41b0e86 /src/third_party | |
parent | 2d50afc549513ae4d1dbcb0009b23b7d06e520a5 (diff) | |
download | mongo-1a331d9b3216fb317c784e6a3857414385ccc654.tar.gz |
Import wiredtiger: b6f7e3570f92b13214bc1e670544e28f20ebb6bc from branch mongodb-master
ref: bafff542e4..b6f7e3570f
for: 6.0.0
WT-8878 Documentation cleanups
Diffstat (limited to 'src/third_party')
-rw-r--r-- | src/third_party/wiredtiger/dist/api_data.py | 28 | ||||
-rw-r--r-- | src/third_party/wiredtiger/dist/api_err.py | 9 | ||||
-rw-r--r-- | src/third_party/wiredtiger/import.data | 2 | ||||
-rw-r--r-- | src/third_party/wiredtiger/src/docs/error-handling.dox | 6 | ||||
-rw-r--r-- | src/third_party/wiredtiger/src/docs/programming.dox | 2 | ||||
-rw-r--r-- | src/third_party/wiredtiger/src/include/wiredtiger.in | 19 |
6 files changed, 33 insertions, 33 deletions
diff --git a/src/third_party/wiredtiger/dist/api_data.py b/src/third_party/wiredtiger/dist/api_data.py index 6c85064ca3f..ed63cc0a876 100644 --- a/src/third_party/wiredtiger/dist/api_data.py +++ b/src/third_party/wiredtiger/dist/api_data.py @@ -1750,26 +1750,22 @@ methods = { older than the current oldest timestamp. See @ref timestamp_txn_api'''), Config('roundup_timestamps', '', r''' - round up timestamps of the transaction. This setting alters the - visibility expected in a transaction. See @ref - timestamp_roundup''', + round up timestamps of the transaction''', type='category', subconfig= [ Config('prepared', 'false', r''' - applicable only for prepared transactions, and intended only for special-purpose - use. (See @ref timestamp_roundup_prepare.) Allows the prepare timestamp and the - commit timestamp of this transaction to be rounded up to be no older than the - oldest timestamp, and allows violating the usual restriction that the prepare - timestamp must be newer than the stable timestamp. Specifically: at transaction - prepare, if the prepare - timestamp is less than or equal to the oldest timestamp, the prepare timestamp - will be rounded to the oldest timestamp. Subsequently, at commit time, if the - commit timestamp is less than the (now rounded) prepare timestamp, the commit - timestamp will be rounded up to it and thus to at least oldest. - Neither timestamp will be checked against the stable timestamp''', + applicable only for prepared transactions, and intended only for special-purpose use, + see @ref timestamp_prepare_roundup. Allows the prepare timestamp and the commit + timestamp of this transaction to be rounded up to be no older than the oldest timestamp, + and allows violating the usual restriction that the prepare timestamp must be newer than + the stable timestamp. Specifically: at transaction prepare, if the prepare timestamp is + less than or equal to the oldest timestamp, the prepare timestamp will be rounded to the + oldest timestamp. Subsequently, at commit time, if the commit timestamp is less than the + (now rounded) prepare timestamp, the commit timestamp will be rounded up to it and thus + to at least oldest. Neither timestamp will be checked against the stable timestamp''', type='boolean'), Config('read', 'false', r''' - if the read timestamp is less than the oldest timestamp, the - read timestamp will be rounded up to the oldest timestamp''', + if the read timestamp is less than the oldest timestamp, the read timestamp will be + rounded up to the oldest timestamp, see @ref timestamp_read_roundup''', type='boolean'), ]), Config('sync', '', r''' diff --git a/src/third_party/wiredtiger/dist/api_err.py b/src/third_party/wiredtiger/dist/api_err.py index dea96d25dc2..0089ad3f58a 100644 --- a/src/third_party/wiredtiger/dist/api_err.py +++ b/src/third_party/wiredtiger/dist/api_err.py @@ -31,8 +31,9 @@ errors = [ 'overwrite' configuration to WT_SESSION::open_cursor.'''), Error('WT_ERROR', -31802, 'non-specific WiredTiger error', ''' - This error is returned when an error is not covered by a - specific error return.'''), + This error is returned when an error is not covered by a specific error + return. The operation may be retried; if a transaction is in progress, + it should be rolled back and the operation retried in a new transaction.'''), Error('WT_NOTFOUND', -31803, 'item not found', ''' This error indicates an operation did not find a value to @@ -49,8 +50,8 @@ errors = [ 'restart the operation (internal)', undoc=True), Error('WT_RUN_RECOVERY', -31806, 'recovery must be run to continue', ''' - This error is generated when wiredtiger_open is configured - to return an error if recovery is required to use the database.'''), + This error is generated when ::wiredtiger_open is configured to return + an error if recovery is required to use the database.'''), Error('WT_CACHE_FULL', -31807, 'operation would overflow cache', ''' This error is only generated when wiredtiger_open is configured diff --git a/src/third_party/wiredtiger/import.data b/src/third_party/wiredtiger/import.data index 8f10073f80e..a298363ba92 100644 --- a/src/third_party/wiredtiger/import.data +++ b/src/third_party/wiredtiger/import.data @@ -2,5 +2,5 @@ "vendor": "wiredtiger", "github": "wiredtiger/wiredtiger.git", "branch": "mongodb-master", - "commit": "bafff542e46c9102a553dba7dd8e550e2412490d" + "commit": "b6f7e3570f92b13214bc1e670544e28f20ebb6bc" } diff --git a/src/third_party/wiredtiger/src/docs/error-handling.dox b/src/third_party/wiredtiger/src/docs/error-handling.dox index 1c8578d2814..c40e3c2762b 100644 --- a/src/third_party/wiredtiger/src/docs/error-handling.dox +++ b/src/third_party/wiredtiger/src/docs/error-handling.dox @@ -33,7 +33,9 @@ This error is generated when the application attempts to insert a record with th existing record without the 'overwrite' configuration to WT_SESSION::open_cursor. @par <code>WT_ERROR</code> -This error is returned when an error is not covered by a specific error return. +This error is returned when an error is not covered by a specific error return. The operation may be +retried; if a transaction is in progress, it should be rolled back and the operation retried in a +new transaction. @par <code>WT_NOTFOUND</code> This error indicates an operation did not find a value to return. This includes cursor search and @@ -46,7 +48,7 @@ exit immediately, no further WiredTiger calls are required (and further calls wi immediately fail). @par <code>WT_RUN_RECOVERY</code> -This error is generated when wiredtiger_open is configured to return an error if recovery is +This error is generated when ::wiredtiger_open is configured to return an error if recovery is required to use the database. @par <code>WT_CACHE_FULL</code> diff --git a/src/third_party/wiredtiger/src/docs/programming.dox b/src/third_party/wiredtiger/src/docs/programming.dox index 2fa0cd0737a..43925ad894b 100644 --- a/src/third_party/wiredtiger/src/docs/programming.dox +++ b/src/third_party/wiredtiger/src/docs/programming.dox @@ -25,7 +25,7 @@ each of which is ordered by one or more columns. - @subpage timestamp_global_api - @subpage timestamp_txn_api - @subpage timestamp_prepare -- @subpage timestamp_roundup +- @subpage timestamp_prepare_roundup - @subpage timestamp_misc - @subpage explain_acid - @subpage explain_durability diff --git a/src/third_party/wiredtiger/src/include/wiredtiger.in b/src/third_party/wiredtiger/src/include/wiredtiger.in index 5f2a922d6a0..6f8f9b24c72 100644 --- a/src/third_party/wiredtiger/src/include/wiredtiger.in +++ b/src/third_party/wiredtiger/src/include/wiredtiger.in @@ -1716,12 +1716,11 @@ struct __wt_session { * @config{read_timestamp, read using the specified timestamp. The supplied value must not * be older than the current oldest timestamp. See @ref timestamp_txn_api., a string; * default empty.} - * @config{roundup_timestamps = (, round up timestamps of the transaction. This setting - * alters the visibility expected in a transaction. See @ref timestamp_roundup., a set of - * related configuration options defined below.} + * @config{roundup_timestamps = (, round up timestamps of the transaction., a set of related + * configuration options defined below.} * @config{ prepared, - * applicable only for prepared transactions\, and intended only for special-purpose use. - * (See @ref timestamp_roundup_prepare.) Allows the prepare timestamp and the commit + * applicable only for prepared transactions\, and intended only for special-purpose use\, + * see @ref timestamp_prepare_roundup. Allows the prepare timestamp and the commit * timestamp of this transaction to be rounded up to be no older than the oldest timestamp\, * and allows violating the usual restriction that the prepare timestamp must be newer than * the stable timestamp. Specifically: at transaction prepare\, if the prepare timestamp is @@ -1732,7 +1731,8 @@ struct __wt_session { * timestamp., a boolean flag; default \c false.} * @config{ read, if * the read timestamp is less than the oldest timestamp\, the read timestamp will be rounded - * up to the oldest timestamp., a boolean flag; default \c false.} + * up to the oldest timestamp\, see @ref timestamp_read_roundup., a boolean flag; default \c + * false.} * @config{ ),,} * @config{sync, whether to sync log records when the transaction commits\, inherited from * ::wiredtiger_open \c transaction_sync., a boolean flag; default empty.} @@ -3789,7 +3789,8 @@ const char *wiredtiger_version(int *majorp, int *minorp, int *patchp) /*! * Non-specific WiredTiger error. * This error is returned when an error is not covered by a specific error - * return. + * return. The operation may be retried; if a transaction is in progress, it + * should be rolled back and the operation retried in a new transaction. */ #define WT_ERROR (-31802) /*! @@ -3812,8 +3813,8 @@ const char *wiredtiger_version(int *majorp, int *minorp, int *patchp) /*! @endcond */ /*! * Recovery must be run to continue. - * This error is generated when wiredtiger_open is configured to return an error - * if recovery is required to use the database. + * This error is generated when ::wiredtiger_open is configured to return an + * error if recovery is required to use the database. */ #define WT_RUN_RECOVERY (-31806) /*! |