Skip to content

Commit 1b276f6

Browse files
ianf-mongodbianf-mongodb
authored
Docsp-20542 rename versioned api verbiage v5.0 (#449)
* DOCSP-20542 rename all versioned-api verbiage and refs * fix header lengths * tweak redirects * comments back to Versioned API * * * remove duplicate redirects * stable-api.txt update * stable-api.txt headers * more tweaks to stable-api.txt * Add naming note and reference the versioned api name change * * * ** * add name change to release 5.0 notes * move naming changes section * ** * ***
1 parent 5009db3 commit 1b276f6

File tree

14 files changed

+255
-45
lines changed

14 files changed

+255
-45
lines changed

‎config/redirects‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1877,9 +1877,12 @@ raw: /manual/core/wildcard -> ${base}/manual/core/index-wildcard/
18771877
[v3.6-v4.4]: /${version}/reference/versioned-api -> ${base}/${version}/reference/
18781878
[v3.6-v4.4]: /${version}/tutorial/mitigate-psa-performance-issues -> ${base}/${version}/administration/replica-set-maintenance/
18791879
[v3.6-v4.4]: /${version}/tutorial/modify-psa-replica-set-safely -> ${base}/${version}/administration/replica-set-maintenance/
1880+
[v3.6-v4.4]: /${version}/reference/stable-api/ -> ${base}/${version}/reference/
1881+
[v3.6-v4.4]: /${version}/reference/stable-api-reference/ -> ${base}/${version}/reference/
18801882

18811883
[v5.0-*]: /${version}/reference/read-concern-majority/#disable-read-concern-majority -> ${base}/${version}/reference/read-concern-majority/#primary-secondary-arbiter-replica-sets
1882-
1884+
[v5.0-*]: /${version}/reference/versioned-api/ -> ${base}/${version}/reference/stable-api/
1885+
[v5.0-*]: /${version}/reference/versioned-api-reference/ -> ${base}/${version}/reference/stable-api-reference/
18831886

18841887
#
18851888
# Redirects for 5.1 and greater (if pages are removed in 5.0 that used to exist in earlier versions)

‎snooty.toml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ toc_landing_pages = [
145145
"/reference/replication",
146146
"/reference/security",
147147
"/reference/sharding",
148-
"/reference/versioned-api",
148+
"/reference/stable-api",
149149
"/release-notes/2.4",
150150
"/release-notes/2.6",
151151
"/release-notes/3.0",

‎source/core/capped-collections.txt‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,12 @@ Transactions
139139

140140
.. include:: /includes/extracts/transactions-capped-collection-change.rst
141141

142+
Stable API
143+
~~~~~~~~~~
144+
145+
Capped collections are not supported in :ref:`Stable API
146+
<stable-api>` V1.
147+
142148
Procedures
143149
----------
144150

‎source/includes/driver-examples/stable-api-java-example.java‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
private static MongoClient setApiVersionParam(String connectionString) {
2+
// Start Versioned API Example 1
3+
MongoClient client = MongoClients.create(
4+
MongoClientSettings.builder()
5+
.applyConnectionString(new ConnectionString(<connection string>))
6+
.serverApi(
7+
ServerApi.builder()
8+
.version(ServerApiVersion.V1)
9+
.build()
10+
).build()
11+
);
12+
13+
return client;
14+
// End Versioned API Example 1
15+
}
16+
17+
private static MongoClient setApiVersionStrict(String connectionString) {
18+
// Start Versioned API Example 2
19+
MongoClient client = MongoClients.create(
20+
MongoClientSettings.builder()
21+
.applyConnectionString(new ConnectionString(<connection string>))
22+
.serverApi(
23+
ServerApi.builder()
24+
.version(ServerApiVersion.V1)
25+
.strict(true)
26+
.build()
27+
).build()
28+
);
29+
30+
return client;
31+
// End Versioned API Example 2
32+
}
33+
34+
private static MongoClient setApiVersionNotStrict(String connectionString) {
35+
// Start Versioned API Example 3
36+
MongoClient client = MongoClients.create(
37+
MongoClientSettings.builder()
38+
.applyConnectionString(new ConnectionString(<connection string>))
39+
.serverApi(
40+
ServerApi.builder()
41+
.version(ServerApiVersion.V1)
42+
.strict(false)
43+
.build()
44+
).build()
45+
);
46+
// End Versioned API Example 3
47+
return client;
48+
49+
}
50+
51+
private static MongoClient setApiVersionDeprecationErrors(String connectionString) {
52+
// Start Versioned API Example 4
53+
MongoClient client = MongoClients.create(
54+
MongoClientSettings.builder()
55+
.applyConnectionString(new ConnectionString(<connection string>))
56+
.serverApi(
57+
ServerApi.builder()
58+
.version(ServerApiVersion.V1)
59+
.deprecationErrors(true)
60+
.build()
61+
).build()
62+
);
63+
64+
// End Versioned API Example 4
65+
return client;
66+
}
67+

‎source/reference.txt‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@ Reference
7979
:doc:`/reference/server-sessions`
8080
Describes server sessions.
8181

82-
:doc:`/reference/versioned-api`
83-
Describes the Versioned API.
82+
:doc:`/reference/stable-api`
83+
Describes the Stable API.
8484

8585
.. seealso::
8686

@@ -112,4 +112,4 @@ Reference
112112
/reference/default-mongodb-port
113113
/reference/mongodb-defaults
114114
/reference/server-sessions
115-
/reference/versioned-api
115+
/reference/stable-api

‎source/reference/command/aggregate.txt‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,25 @@ For :dbcommand:`aggregate` operation that do not include the
309309

310310
.. include:: /includes/extracts/4.2-changes-disconnect.rst
311311

312+
Stable API
313+
----------
314+
315+
When using :ref:`Stable API <stable-api>` V1:
316+
317+
- You cannot use the following stages in an :dbcommand:`aggregate`
318+
command:
319+
320+
- :pipeline:`$currentOp`
321+
- :pipeline:`$indexStats`
322+
- :pipeline:`$listLocalSessions`
323+
- :pipeline:`$listSessions`
324+
- :pipeline:`$planCacheStats`
325+
- :pipeline:`$search`
326+
327+
- When using the :pipeline:`$collStats` stage, you can only use the
328+
``count`` field. No other :pipeline:`$collStats` fields are
329+
available.
330+
312331
Example
313332
-------
314333

‎source/reference/command/create.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -400,6 +400,21 @@ Transactions
400400

401401
.. |operation| replace:: :dbcommand:`create`
402402

403+
Stable API
404+
~~~~~~~~~~
405+
406+
.. versionchanged:: 5.0
407+
408+
When using :ref:`Stable API <stable-api>` V1, you cannot specify
409+
the following fields in a :dbcommand:`create` command:
410+
411+
- ``autoIndexId``
412+
- ``capped``
413+
- ``indexOptionDefaults``
414+
- ``max``
415+
- ``size``
416+
- ``storageEngine``
417+
403418
Access Control
404419
--------------
405420

‎source/reference/command/createIndexes.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -594,6 +594,21 @@ Collation and Index Types
594594

595595
.. include:: /includes/extracts/collation-index-type-restrictions-addendum.rst
596596

597+
Stable API
598+
~~~~~~~~~~
599+
600+
When using :ref:`Stable API <stable-api>` V1:
601+
602+
- You cannot specify any of the following fields in the ``indexes`` array:
603+
604+
- ``background``
605+
- ``bucketSize``
606+
- ``sparse``
607+
- ``storageEngine``
608+
609+
- You cannot create :ref:`geoHaystack <index-geohaystack-index>` or
610+
:ref:`text <index-feature-text>` indexes.
611+
597612
Behavior
598613
--------
599614

‎source/reference/command/find.txt‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -545,6 +545,21 @@ Client Disconnection
545545

546546
.. include:: /includes/extracts/4.2-changes-disconnect.rst
547547

548+
Stable API
549+
~~~~~~~~~~
550+
551+
When using :ref:`Stable API <stable-api>` V1, the following
552+
:dbcommand:`find` command fields are not supported:
553+
554+
- ``awaitData``
555+
- ``max``
556+
- ``min``
557+
- ``noCursorTimeout``
558+
- ``oplogReplay``
559+
- ``returnKey``
560+
- ``showRecordId``
561+
- ``tailable``
562+
548563

549564
Examples
550565
--------

‎source/reference/command/setParameter.txt‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,20 @@ setParameter
3232
For the available parameters, including examples, see
3333
:doc:`/reference/parameters`.
3434

35+
Behavior
36+
--------
37+
38+
Persistence
39+
~~~~~~~~~~~
40+
41+
Commands issued by the admin command :dbcommand:`setParameter`
42+
do not survive server restarts. For a persistent option use the
43+
:option:`--setParameter <mongod --setParameter>` command line option
44+
or the :setting:`setParameter` configuration file setting.
45+
46+
Stable API
47+
~~~~~~~~~~
48+
49+
When using :ref:`Stable API <stable-api>` V1 with :ref:`apiStrict
50+
<api-strict-desc>` set to ``true``, you cannot use
51+
:dbcommand:`setParameter` to modify server parameters.

0 commit comments

Comments
 (0)