From 9a09286460b694e577d53f15143e97c273b224d9 Mon Sep 17 00:00:00 2001 From: Brendan Clement Date: Fri, 22 May 2026 20:52:16 -0700 Subject: [PATCH] docs(js): regenerate typedoc for read_consistency_interval --- docs/src/js/interfaces/ConnectionOptions.md | 20 ++++++++++++-------- 1 file changed, 12 insertions(+), 8 deletions(-) diff --git a/docs/src/js/interfaces/ConnectionOptions.md b/docs/src/js/interfaces/ConnectionOptions.md index 1ad0e127a..de2083a9b 100644 --- a/docs/src/js/interfaces/ConnectionOptions.md +++ b/docs/src/js/interfaces/ConnectionOptions.md @@ -70,16 +70,20 @@ client used by manifest-enabled native connections. optional readConsistencyInterval: number; ``` -(For LanceDB OSS only): The interval, in seconds, at which to check for -updates to the table from other processes. If None, then consistency is not -checked. For performance reasons, this is the default. For strong -consistency, set this to zero seconds. Then every read will check for -updates from other processes. As a compromise, you can set this to a -non-zero value for eventual consistency. If more than that interval -has passed since the last check, then the table will be checked for updates. -Note: this consistency only applies to read operations. Write operations are +The interval, in seconds, at which to check for updates to the table +from other processes. If None, then consistency is not checked. For +performance reasons, this is the default. For strong consistency, set +this to zero seconds. Then every read will check for updates from other +processes. As a compromise, you can set this to a non-zero value for +eventual consistency. If more than that interval has passed since the +last check, then the table will be checked for updates. Note: this +consistency only applies to read operations. Write operations are always consistent. +Stronger consistency is not free. The smaller the interval, the more +often each read pays the cost of checking for updates against object +storage, raising per-read latency and cost. + *** ### region?