Skip to content

WIP: default timeout for durable ops in SDK3 #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: release/3.0
Choose a base branch
from
Open

WIP: default timeout for durable ops in SDK3 #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 25 additions & 3 deletions modules/ref/pages/client-settings.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,34 @@
= Client Settings
:nav-title: Client Settings
:page-topic-type: reference
:page-aliases: ROOT:client-settings
:page-aliases: ROOT:client-settings,ROOT:configuring-the-client,ROOT:env-config

[abstract]
Client settings

NOTE: Other Client Settings will be added to this document at a later date.

== Timeout Options
=== Timeout Options Reference

Name: *Key-Value Timeout*::
Builder Method: `TimeoutConfig.kvTimeout(Duration)`
+
Default: `2.5s` -- _but see TIP, below_
+
System Property: `com.couchbase.env.timeout.kvTimeout`
+
The Key/Value default timeout is used on operations which are performed on a specific key if not overridden by a custom timeout.
This includes all commands like get(), getFromReplica() and all mutation commands, but does not include operations that are performed with enhanced durability requirements.
+
TIP: xref:concept-docs:durability-replication-failure-considerations.adoc#synchronous-writes[Durable Write operations] have their own timeout setting, `kvDurableTimeout`, see below.

Name: *Key-Value Durable Operation Timeout*::
Builder Method: `TimeoutConfig.kvDurableTimeout(Duration)`
+
Default: `10s`
+
System Property: `com.couchbase.env.timeout.kvDurableTimeout`
+
Key/Value operations with enhanced durability requirements may take longer to complete, so they have a separate default timeout.
+
WARNING: The `kvDurableTimeout` property is not part of the stable API and may change or be removed at any time.