Skip to content

Commit b95a9e2

Browse files
committed
Update docs
1 parent dd1add6 commit b95a9e2

5 files changed

+15
-4
lines changed

UPGRADE-1.18.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# UPGRADE FROM 1.x to 1.18
2+
3+
## Required options
4+
5+
### GridFS disableMD5 option must be true
6+
7+
Starting with 1.18, not passing the `disableMD5` option to `Database::getGridFSBucket()`
8+
is deprecated. You should explicitly pass `true` to this option to disable
9+
checksum computation. This feature is deprecated in the GridFS specification.
10+
In version 2.0 of the mongodb library, the default value will be `true` and an
11+
exception will be thrown if you set another value.

docs/reference/method/MongoDBDatabase-selectGridFSBucket.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Parameters
4848
- boolean
4949
- Whether to disable automatic MD5 generation when storing files.
5050

51-
Defaults to ``false``.
51+
Defaults to ``false``. Only ``true`` will be supported in 2.0.
5252

5353
.. versionadded: 1.4
5454

docs/reference/method/MongoDBGridFSBucket-openUploadStream.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Parameters
5555
- boolean
5656
- Whether to disable automatic MD5 generation when storing files.
5757

58-
Defaults to ``false``.
58+
Defaults to ``false``. Only ``true`` will be supported in 2.0.
5959

6060
.. versionadded: 1.4
6161

docs/reference/method/MongoDBGridFSBucket-uploadFromStream.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Parameters
5959
- boolean
6060
- Whether to disable automatic MD5 generation when storing files.
6161

62-
Defaults to ``false``.
62+
Defaults to ``false``. Only ``true`` will be supported in 2.0.
6363

6464
.. versionadded: 1.4
6565

docs/reference/method/MongoDBGridFSBucket__construct.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ Parameters
5959
- boolean
6060
- Whether to disable automatic MD5 generation when storing files.
6161

62-
Defaults to ``false``.
62+
Defaults to ``false``. Only ``true`` will be supported in 2.0.
6363

6464
.. versionadded: 1.4
6565

0 commit comments

Comments
 (0)