DOCSP-35922: csot - gridfs

(cherry picked from commit abd9c10)

Author: rustagir

source/connect-to-mongo/csot.txt

@@ -284,6 +284,36 @@ inherited timeout:
    :dedent:
    :emphasize-lines: 3
 
+.. _java-rs-csot-gridfs:
+
+GridFS
+------
+
+You can set a timeout option for :ref:`GridFS <java-rs-store-large-docs>`
+operations when instantiating a ``GridFSBucket`` by using the
+``withTimeout()`` method. This timeout applies to all operations
+performed on the bucket, such as uploading and downloading data. If you
+do not set a timeout, the ``GridFSBucket`` instance inherits the timeout
+setting from the ``MongoDatabase`` it is created with.
+
+The following code demonstrates how to set a timeout when instantiating
+a ``GridFSBucket``:
+
+.. literalinclude:: /includes/connect/CsotExample.java
+   :language: java
+   :start-after: start-gridfsbucket-timeout
+   :end-before: end-gridfsbucket-timeout
+   :dedent:
+   :emphasize-lines: 3
+
+.. important:: InputStream Timeout Support
+
+   When you call the ``uploadFromStream()`` method on a ``GridFSBucket``
+   that has an operation timeout, timeout breaches might occur because
+   the ``InputStream`` class lacks inherent read timeout support. This might
+   extend the operation beyond the specified timeout limit, causing a
+   timeout exception.
+
 API Documentation
 -----------------
 
@@ -298,3 +328,4 @@ API documentation:
 - `ClientEncryptionSettings.Builder.timeout() <{+core-api+}/ClientEncryptionSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__
 - `FindIterable.timeoutMode() <{+driver-api+}/FindPublisher.html#timeoutMode(com.mongodb.client.cursor.TimeoutMode)>`__
 - `TimeoutMode <{+core-api+}/client/cursor/TimeoutMode.html>`__
+- `GridFSBucket.withTimeout() <{+driver-api+}/gridfs/GridFSBucket.html#withTimeout(long,java.util.concurrent.TimeUnit)>`__

source/includes/connect/CsotExample.java

@@ -118,4 +118,22 @@ private void cursorTimeout(){
         }
 
     }
+
+    private void gridFSTimeout(){
+        MongoClientSettings settings = MongoClientSettings.builder()
+                .applyConnectionString(new ConnectionString("<connection string>"))
+                .build();
+
+        try (MongoClient mongoClient = MongoClients.create(settings)) {
+            MongoDatabase database = mongoClient.getDatabase("db");
+
+            // start-gridfsbucket-timeout
+            GridFSBucket gridFSBucket = GridFSBuckets
+                    .create(database)
+                    .withTimeout(200L, MILLISECONDS);
+            // end-gridfsbucket-timeout
+        }
+
+    }
+
 }

source/write/store-large-docs.txt

@@ -29,6 +29,14 @@ The code examples in this guide come from the `GridFSTour.java
 <{+driver-source-gh+}/blob/master/driver-reactive-streams/src/examples/reactivestreams/gridfs/GridFSTour.java>`__
 file in the driver source code GitHub repository.
 
+.. tip:: Timeout Setting
+
+   You can use the client-side operation timeout (CSOT) setting to limit
+   the amount of time in which the server can finish GridFS operations.
+   To learn more about using this setting with GridFS, see the
+   :ref:`java-rs-csot-gridfs` section of the Limit Server Execution Time
+   guide.
+
 Prerequisites
 -------------