diff options
Diffstat (limited to 'src/third_party/wiredtiger/src/docs/error-handling.dox')
| -rw-r--r-- | src/third_party/wiredtiger/src/docs/error-handling.dox | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/src/third_party/wiredtiger/src/docs/error-handling.dox b/src/third_party/wiredtiger/src/docs/error-handling.dox index 2bf60104db7..38a2b48ec7b 100644 --- a/src/third_party/wiredtiger/src/docs/error-handling.dox +++ b/src/third_party/wiredtiger/src/docs/error-handling.dox @@ -37,45 +37,45 @@ inclusive. The following is a list of the WiredTiger-specific return values: @if IGNORE_BUILT_BY_API_ERR_BEGIN @endif -@par <code>WT_ROLLBACK</code> +@par \c WT_ROLLBACK This error is generated when an operation cannot be completed due to a conflict with concurrent operations. 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_DUPLICATE_KEY</code> +@par \c WT_DUPLICATE_KEY This error is generated when the application attempts to insert a record with the same key as an existing record without the 'overwrite' configuration to WT_SESSION::open_cursor. -@par <code>WT_ERROR</code> +@par \c WT_ERROR 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> +@par \c WT_NOTFOUND This error indicates an operation did not find a value to return. This includes cursor search and other operations where no record matched the cursor's search key such as WT_CURSOR::update or WT_CURSOR::remove. -@par <code>WT_PANIC</code> +@par \c WT_PANIC This error indicates an underlying problem that requires a database restart. The application may exit immediately, no further WiredTiger calls are required (and further calls will themselves immediately fail). -@par <code>WT_RUN_RECOVERY</code> +@par \c WT_RUN_RECOVERY 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> +@par \c WT_CACHE_FULL This error is generated when wiredtiger_open is configured to run in-memory, and a data modification operation requires more than the configured cache size to complete. 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_PREPARE_CONFLICT</code> +@par \c WT_PREPARE_CONFLICT This error is generated when the application attempts to read an updated record which is part of a transaction that has been prepared but not yet resolved. -@par <code>WT_TRY_SALVAGE</code> +@par \c WT_TRY_SALVAGE This error is generated when corruption is detected in an on-disk file. During normal operations, this may occur in rare circumstances as a result of a system crash. The application may choose to salvage the file or retry wiredtiger_open with the 'salvage=true' configuration setting. |