Skip to content

Commit b56c404

Browse files
Updates from 3.8 (#368)
* Remove defunct CB Live try it DOC-13762 * DOC-11940 Vector improvements * StartUsing.cs replacing outdated csx file DOC-11914 * Updated local code example DOC-11914 * Antora include:: tags DOC-11914 * Quick typo fix * Doc 13881 no more 7.1 (#366) * Replaced EOL 7.1 with evergreen attribute * Fixed evergreen attribute * expiry admonition updates DOC-11859 * h3 * forward ported changes from 3.8
1 parent 6da0041 commit b56c404

15 files changed

Lines changed: 37 additions & 29 deletions

antora.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ nav:
66
- modules/ROOT/nav.adoc
77
asciidoc:
88
attributes:
9-
server_version: '8.0'
9+
server_version: '8.0.1'
1010
sdk_current_version: '3.9.0'
1111
sdk_dot_minor: 3.9
1212
sdk_dot_major: 3.x
1313
version-server: '8.0'
14-
version-common: '8.0'
14+
version-common: '8.0.1'
1515
name_platform: '.NET'
1616
name-sdk: '.NET SDK'
17-
sdk_api: '3.8'
17+
sdk_api: '3.9'
1818
sdk-api-link: https://docs.couchbase.com/sdk-api/couchbase-net-client/
1919
sdk-gh-link: https://github.com/couchbase/couchbase-net-client/

modules/concept-docs/pages/analytics-for-sdk-users.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,5 @@ For complex and long-running queries, involving large ad hoc join, set, aggregat
2222
2323
== Additional Resources
2424
25-
* Start with our xref:7.1@server:analytics:primer-beer.adoc[introductory primer].
25+
* Start with our xref:{version-server}@server:analytics:primer-beer.adoc[introductory primer].
2626
* Read the practical introduction xref:howtos:analytics-using-sdk.adoc[using analytics from the SDK].

modules/concept-docs/pages/collections.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ include::project-docs:partial$attributes.adoc[]
1010

1111
The Collections feature in Couchbase Server is fully implemented in the 3.2 API version of the Couchbase SDK.
1212

13-
Information on _Collections_ can be found in the xref:7.1@server:learn:data:scopes-and-collections.adoc[server docs].
13+
Information on _Collections_ can be found in the xref:{version-server}@server:learn:data:scopes-and-collections.adoc[server docs].
1414

1515
== Using Collections & Scopes
1616

modules/concept-docs/pages/documents.adoc

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,10 @@
22
:description: Couchbase supports CRUD operations, various data structures, and binary documents.
33
:page-topic-type: concept
44
:page-aliases: ROOT:documents,ROOT:documents-basics,ROOT:documents-atomic
5+
:page-toclevels: 2
56
:link-with-underscores: https://docs.couchbase.com/sdk-api/couchbase-net-client/html/T_Couchbase_KeyValue_IBinaryCollection.htm
67

7-
include::project-docs:partial$attributes.adoc[]
8+
89

910
[abstract]
1011
{description}
@@ -41,7 +42,7 @@ await collection.MutateInAsync("customer123", new List<MutateInSpec>
4142
});
4243
----
4344
44-
or xref:7.1@server:n1ql:n1ql-language-reference/update.adoc[N1QL UPDATE] to update documents based on specific query criteria:
45+
or xref:{version-server}@server:n1ql:n1ql-language-reference/update.adoc[N1QL UPDATE] to update documents based on specific query criteria:
4546
4647
[source,sql]
4748
----
@@ -125,5 +126,5 @@ include::{version-common}@sdk:shared:partial$documents.adoc[tag=expiration]
125126
IMPORTANT: If you are using the overloads that take `IDocument`, note that the `IDocument.Expiry` property assumes ms (milli-seconds), and is converted to seconds before being sent to the server.
126127
All other overloads take a `TimeSpan` or an `uint`, and assume an expiry in seconds
127128
A time of zero will set the document to never expire
128-
(a negative number will set expiry to immediate -- creating a xref:7.1@server:learn:buckets-memory-and-storage/storage.adoc#tombstones[tombstone]).
129+
(a negative number will set expiry to immediate -- creating a xref:{version-server}@server:learn:buckets-memory-and-storage/storage.adoc#tombstones[tombstone]).
129130
Values above 0ms but below 1000ms are rounded up to one second before being sent to the server -- _if you are using .NET SDK 3.0.4 or later_.

modules/concept-docs/pages/n1ql-query.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:page-topic-type: concept
44
:page-aliases: ROOT:n1ql-query,ROOT:prepared-statements,ROOT:querying
55

6-
include::project-docs:partial$attributes.adoc[]
6+
77

88
[abstract]
99
{description}
@@ -28,15 +28,15 @@ var result = await cluster.QueryAsync<dynamic>(
2828
);
2929
----
3030

31-
CAUTION: *When running an application using Prepared Statements through the .NET SDK* -- if you plan to upgrade Couchbase Server from 6.0.x or earlier to 6.5.0 or later, and are running a version of the .NET SDK prior to xref:project-docs:sdk-release-notes.adoc#version-3-0-1-13-may-2020[3.0.1], you will need to xref:7.1@server:install:upgrade-strategy-for-features.adoc#prepared-statements[restart the app or otherwise work around] a change in the Server's behaviour.
31+
CAUTION: *When running an application using Prepared Statements through the .NET SDK* -- if you plan to upgrade Couchbase Server from 6.0.x or earlier to 6.5.0 or later, and are running a version of the .NET SDK prior to xref:project-docs:sdk-release-notes.adoc#version-3-0-1-13-may-2020[3.0.1], you will need to xref:{version-common}@server:install:upgrade-strategy-for-features.adoc#prepared-statements[restart the app or otherwise work around] a change in the Server's behaviour.
3232

3333

3434
== Indexes
3535

36-
The Couchbase query service makes use of xref:7.1@server:learn:services-and-indexes/indexes/indexes.adoc[_indexes_] in order to do its work.
36+
The Couchbase query service makes use of xref:{version-common}@server:learn:services-and-indexes/indexes/indexes.adoc[_indexes_] in order to do its work.
3737
Indexes replicate subsets of documents from data nodes over to index nodes,
3838
allowing specific data (for example, specific document properties) to be retrieved quickly,
39-
and to distribute load away from data nodes in xref:7.1@server:learn:services-and-indexes/services/services.adoc[MDS] topologies.
39+
and to distribute load away from data nodes in xref:{version-common}@server:learn:services-and-indexes/services/services.adoc[MDS] topologies.
4040

4141
[IMPORTANT]
4242
In order to make a bucket queryable, it must have at least one index defined.
@@ -81,7 +81,7 @@ Indexes help improve the performance of a query.
8181
When an index includes the actual values of all the fields specified in the query,
8282
the index _covers_ the query, and eliminates the need to fetch the actual values from the Data Service.
8383
An index, in this case, is called a _covering index_, and the query is called a _covered_ query.
84-
For more information, see xref:7.1@server:n1ql:n1ql-language-reference/covering-indexes.adoc[Covering Indexes].
84+
For more information, see xref:{version-common}@server:n1ql:n1ql-language-reference/covering-indexes.adoc[Covering Indexes].
8585

8686
You can also create and define indexes in the SDK using:
8787

@@ -130,7 +130,7 @@ include::{version-common}@sdk:shared:partial$n1ql-queries.adoc[tag=index-consist
130130

131131
The following options are available:
132132

133-
include::7.1@server:learn:page$services-and-indexes/indexes/index-replication.adoc[tag=scan_consistency]
133+
include::{version-common}@server:learn:page$services-and-indexes/indexes/index-replication.adoc[tag=scan_consistency]
134134
////
135135
* `not_bounded`: Executes the query immediately, without requiring any consistency for the query.
136136
If index-maintenance is running behind, out-of-date results may be returned.

modules/hello-world/pages/webui-cli-access.adoc renamed to modules/hello-world/pages/.webui-cli-access.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ You can access individual documents using the _command line_ and _web console_.
1818
== Command-Line
1919

2020
You can access documents in Couchbase using command line interfaces.
21-
You can use the `cbc` tool for simple document lookups by their IDs (or _keys_) and the xref:7.1@server:n1ql:n1ql-intro/cbq.adoc[cbq] tool to issue {sqlpp} (formerly N1QL) queries.
21+
You can use the `cbc` tool for simple document lookups by their IDs (or _keys_) and the xref:{version-server}@server:n1ql:n1ql-intro/cbq.adoc[cbq] tool to issue {sqlpp} (formerly N1QL) queries.
2222
This section will discuss the installation and usage of the `cbc` tool, and is targeted towards Linux and Mac OS X users.
2323

2424
NOTE: You can also use `cbc` on Windows by extracting the archive with libcouchbase.

modules/howtos/pages/analytics-using-sdk.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ or the Enterprise Edition of self-managed Couchbase Server.
2121

2222
== Getting Started
2323

24-
After familiarizing yourself with our xref:7.1@server:analytics:primer-beer.adoc[introductory primer],
24+
After familiarizing yourself with our xref:{version-server}@server:analytics:primer-beer.adoc[introductory primer],
2525
in particular creating a dataset and linking it to a bucket to shadow the operational data,
2626
try Couchbase Analytics using the .NET SDK.
2727
Intentionally, the API for analytics is very similar to that of the query service.
@@ -103,7 +103,7 @@ var result = await cluster.AnalyticsQueryAsync<dynamic>("select airportname, cou
103103
After checking that `QueryStatus` is success, we iterate over the rows.
104104
These rows may contain various sorts of data and metadata,
105105
depending upon the nature of the query,
106-
as you will have seen when working through our xref:7.1@server:analytics:primer-beer.adoc[introductory primer].
106+
as you will have seen when working through our xref:{version-server}@server:analytics:primer-beer.adoc[introductory primer].
107107

108108
[source,csharp]
109109
----

modules/howtos/pages/full-text-searching-with-sdk.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ include::example$Couchbase.Examples.SearchV2/SearchV2Examples/Program.cs[tag=sco
5252

5353

5454
All simple query types are created in the same manner, some have additional properties, which can be seen in common query type descriptions.
55-
Couchbase FTS's xref:7.1@server:fts:fts-query-types.adoc[range of query types] enable powerful searching using multiple options, to ensure results are just within the range wanted.
55+
Couchbase FTS's xref:{version-server}@server:fts:fts-query-types.adoc[range of query types] enable powerful searching using multiple options, to ensure results are just within the range wanted.
5656
Here is a date range query that looks for dates between 1st January 2021 and 31st January:
5757

5858
[source,csharp]

modules/howtos/pages/kv-operations.adoc

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ include::example$KvOperations.csx[tag=replacewithcas,indent=0]
6262
Expiration sets an explicit time to live (TTL) for a document.
6363
We'll discuss modifying `Expiration` in more details xref:#expiration-ttl[below].
6464
For a discussion of item (Document) _vs_ Bucket expiration, see the
65-
xref:7.1@server:learn:buckets-memory-and-storage/expiration.adoc#expiration-ttl[Expiration Overview page].
65+
xref:{version-server}@server:learn:buckets-memory-and-storage/expiration.adoc#expiration-ttl[Expiration Overview page].
6666

6767
[source,csharp]
6868
----
@@ -202,11 +202,10 @@ include::example$KvOperations.csx[tag=touchwithtimeout,indent=0]
202202
IMPORTANT: If you are using the overloads that take `IDocument`, note that the `IDocument.Expiry` property assumes ms (milli-seconds), and is converted to seconds before being sent to the server.
203203
All other overloads take a `TimeSpan` or an `uint`, and assume an expiry in seconds
204204
A time of zero will set the document to never expire
205-
(a negative number will set expiry to immediate -- creating a xref:7.1@server:learn:buckets-memory-and-storage/storage.adoc#tombstones[tombstone]).
205+
(a negative number will set expiry to immediate -- creating a xref:{version-server}@server:learn:buckets-memory-and-storage/storage.adoc#tombstones[tombstone]).
206206
Values above 0ms but below 1000ms are rounded up to one second before being sent to the server.
207207

208208

209-
210209
== Atomic Counters
211210

212211
The value of a document can be increased or decreased atomically using `Binary.Increment()` and `Binary.Decrement()`.
@@ -244,7 +243,7 @@ include::{version-common}@sdk:shared:partial$atomic.adoc[tag=xdcr]
244243

245244
== Scoped KV Operations
246245

247-
It is possible to perform scoped key value operations on named xref:7.1@server:learn:data/scopes-and-collections.adoc[`Collections`] with _Couchbase Server release 7.0_ onwards.
246+
It is possible to perform scoped key value operations on named xref:{version-server}@server:learn:data/scopes-and-collections.adoc[`Collections`] with _Couchbase Server release 7.0_ onwards.
248247

249248
Here is an example showing an upsert in the `users` collection, which lives in the `travel-sample.tenant_agent_00` keyspace:
250249

modules/howtos/pages/n1ql-queries-with-sdk.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@ of .NET, this is not necessary and the option isn't necessary.
195195

196196
== Querying at Scope Level
197197

198-
From version 3.0.5 of the .NET SDK, it is possible to query off the xref:7.1@server:learn:data/scopes-and-collections.adoc[`Scope` level] _with the Couchbase Server release 7.0_,
198+
From version 3.0.5 of the .NET SDK, it is possible to query off the xref:{version-server}@server:learn:data/scopes-and-collections.adoc[`Scope` level] _with the Couchbase Server release 7.0_ onwards,
199199
using the `QueryOptions() {QueryContext = "namespace:bucket:scope:collection"}` method.
200200

201201
The following code snippet shows how to run a query to fetch 10 random rows from `travel-sample.inventory` and print the results.
@@ -214,8 +214,8 @@ NOTE: {sqlpp} is not the only query option in Couchbase.
214214
Be sure to check that xref:concept-docs:data-services.adoc[your use case fits your selection of query service].
215215

216216
* For a deeper dive into {sqlpp} from the SDK, refer to our xref:concept-docs:n1ql-query.adoc[{sqlpp} SDK concept doc].
217-
* The xref:7.1@server:n1ql:n1ql-language-reference/index.adoc[Server doc {sqlpp} intro] introduces a complete guide to the {sqlpp} language, including all of the latest additions.
217+
* The xref:{version-server}@server:n1ql:n1ql-language-reference/index.adoc[Server doc {sqlpp} intro] introduces a complete guide to the {sqlpp} language, including all of the latest additions.
218218
* The http://query.pub.couchbase.com/tutorial/#1[{sqlpp} interactive tutorial] is a good introduction to the basics of {sqlpp} use.
219-
* For scaling up queries, be sure to xref:7.1@server:learn:services-and-indexes/indexes/index-replication.adoc[read up on Indexes].
219+
* For scaling up queries, be sure to xref:{version-server}@server:learn:services-and-indexes/indexes/index-replication.adoc[read up on Indexes].
220220
* The Query Service is for operational queries; for analytical workloads, read more on xref:concept-docs:http-services.adoc#long-running-queries-big-data[when to choose Analytics].
221221

0 commit comments

Comments
 (0)