From b50f380fc0cfb754c5e69761cb12d1bb73c7aac4 Mon Sep 17 00:00:00 2001 From: Richard Smedley Date: Sun, 8 Mar 2020 21:03:17 +0000 Subject: [PATCH 1/2] WIP: default timeout for durable ops in SDK3 Needs localising for LCB/Python --- modules/ref/pages/client-settings.adoc | 28 ++++++++++++++++++++++++-- 1 file changed, 26 insertions(+), 2 deletions(-) diff --git a/modules/ref/pages/client-settings.adoc b/modules/ref/pages/client-settings.adoc index 60be7e9f..4a82fc3c 100644 --- a/modules/ref/pages/client-settings.adoc +++ b/modules/ref/pages/client-settings.adoc @@ -1,12 +1,36 @@ = 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 include::partial$beta-warning.adoc[] -== Timeout Options +NOTE: Other Client Settings will be added to this document at a later date. +=== 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. From 7fe467a93d866cb7a1101f3414314cb5f54cf134 Mon Sep 17 00:00:00 2001 From: Richard Smedley Date: Tue, 5 May 2020 13:14:47 +0100 Subject: [PATCH 2/2] GA --- modules/ref/pages/client-settings.adoc | 1 - 1 file changed, 1 deletion(-) diff --git a/modules/ref/pages/client-settings.adoc b/modules/ref/pages/client-settings.adoc index 4a82fc3c..54c2570f 100644 --- a/modules/ref/pages/client-settings.adoc +++ b/modules/ref/pages/client-settings.adoc @@ -6,7 +6,6 @@ [abstract] Client settings -include::partial$beta-warning.adoc[] NOTE: Other Client Settings will be added to this document at a later date.