Skip to content

Commit d81dc7e

Browse files
authored
Merge pull request #189 from osfameron/DOC-9723-couchbasepp-client-settings
DOC-9723: Couchbase++ Client Settings admonitions
2 parents 0d4466a + 6081a2c commit d81dc7e

File tree

3 files changed

+13
-5
lines changed

3 files changed

+13
-5
lines changed

modules/howtos/pages/managing-connections.adoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ The client fetches the full address list from the first node it is able to conta
4242
[#connection-strings]
4343
== Connection Strings
4444

45+
WARNING: The backend implementation of connection strings parameters changed substantially in 4.0 and is not currently fully documented.
46+
This will be resolved in a future 4.x release.
47+
See xref:project-docs:migrating-sdk-code-to-3.n.adoc#sdk4-specifics[more details on migrating to 4.0].
48+
4549
A Couchbase connection string is a comma-delimited list of IP addresses and/or hostnames, optionally followed by a list of parameters.
4650

4751
The parameter list is just like the query component of a URI; name-value pairs have an equals sign (`=`) separating the name and value, with an ampersand (`&`) between each pair.

modules/project-docs/pages/migrating-sdk-code-to-3.n.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,10 +535,12 @@ They are available in 3.2, and will be available in a later 4.x release.
535535
* xref:concept-docs:response-time-observability.adoc[Response Time Availability]
536536
* xref:concept-docs:durability-replication-failure-considerations.adoc#older-server-versions[Legacy durability]
537537
* Log forwarding
538-
* Replica reads
538+
* Replica reads
539539

540540
In addition:
541541

542542
* The required minimum version of Node.js is now v12 (the oldest supported maintenance LTS release).
543543
* Ping error entries are now typed.
544544
* `get` requests on locked documents now retry rather than fast-fail.
545+
* The changes to xref:ref:client-settings.adoc[Client Settings] are not currently documented.
546+
* The changes to xref:howtos:managing-connections.adoc#connection-strings[Connection Strings] are not currently documented.

modules/ref/pages/client-settings.adoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,12 @@ include::project-docs:partial$attributes.adoc[]
99
[abstract]
1010
{description}
1111

12-
Beyond the connection string, most settings are changed by calls to the libcouchbase API
13-
(implemented with Couchbase++ from Node.js SDK 4.0) --
14-
refer to the https://docs.couchbase.com/sdk-api/couchbase-c-client/group\__lcb-cntl.html[API doc on `lcb_cntl()`]
15-
and the https://docs.couchbase.com/sdk-api/couchbase-c-client/group__lcb-cntl-settings.html[settings list].
12+
WARNING: The backend implementation of client settings changed substantially in 4.0 and is not currently fully documented.
13+
This will be resolved in a future 4.x release.
14+
See xref:project-docs:migrating-sdk-code-to-3.n.adoc#sdk4-specifics[more details on migrating to 4.0].
15+
16+
Some details from the old `libcouchbase`
17+
https://docs.couchbase.com/sdk-api/couchbase-c-client/group__lcb-cntl-settings.html[settings list] may be useful for reference.
1618
1719
// == Timeout Options
1820

0 commit comments

Comments
 (0)