DOCSP-35922: csot - gridfs

(cherry picked from commit 7b3e28b)

Author: rustagir

source/connect/csot.txt

@@ -274,6 +274,35 @@ inherited timeout:
    :dedent:
    :emphasize-lines: 3
 
+.. _scala-csot-gridfs:
+
+GridFS
+------
+
+You can set a timeout option for :ref:`GridFS <scala-gridfs>`
+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.scala
+   :language: scala
+   :start-after: start-gridfsbucket-timeout
+   :end-before: end-gridfsbucket-timeout
+   :dedent:
+
+.. important:: Observable Timeout Support
+
+   When you call the ``uploadFromObservable()`` method on a ``GridFSBucket``
+   that has an operation timeout, timeout breaches might occur because
+   the ``Observable`` class lacks inherent read timeout support. This might
+   extend the operation beyond the specified timeout limit, causing a
+   timeout exception.
+
 API Documentation
 -----------------
 
@@ -288,3 +317,4 @@ API documentation:
 - `ClientEncryptionSettings.Builder.timeout() <{+core-api+}/com/mongodb/ClientEncryptionSettings.Builder.html#timeout(long,java.util.concurrent.TimeUnit)>`__
 - `FindIterable.timeoutMode() <{+api+}/org/mongodb/scala/FindObservable.html#timeoutMode(timeoutMode:org.mongodb.scala.TimeoutMode):org.mongodb.scala.FindObservable[TResult]>`__
 - `TimeoutMode <{+core-api+}/com/mongodb/client/cursor/TimeoutMode.html>`__
+- `GridFSBucket.withTimeout() <{+api+}/org/mongodb/scala/gridfs/GridFSBucket.html#withTimeout(timeout:scala.concurrent.duration.Duration):org.mongodb.scala.gridfs.GridFSBucket>`__

source/includes/connect/CsotExample.scala

@@ -93,7 +93,19 @@ object CsotExample {
         .timeoutMode(TimeoutMode.CURSOR_LIFETIME)
       // end-cursor-lifetime
     }
+    {
+      val settings = MongoClientSettings.builder
+        .applyConnectionString(ConnectionString("<connection string>"))
+        .timeout(200L, MILLISECONDS)
+        .build
 
+      val mongoClient = MongoClient(settings)
+      val database = mongoClient.getDatabase("db")
+
+      // start-gridfsbucket-timeout
+      val gridFSBucket = GridFSBucket(database).withTimeout(200L, MILLISECONDS)
+      // end-gridfsbucket-timeout
+    }
 
   }
 }

source/write/gridfs.txt

@@ -93,6 +93,14 @@ constructor, as shown in the following example:
    :start-after: start-create-custom-bucket
    :end-before: end-create-custom-bucket
 
+.. 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
+   on your bucket. To learn more about using this setting with GridFS, see the
+   :ref:`scala-csot-gridfs` section of the Limit Server Execution Time
+   guide.
+
 Upload Files
 ------------
 
@@ -222,4 +230,4 @@ API Documentation
 To learn more about using GridFS to store and retrieve large files,
 see the following API documentation:
 
-- `GridFSBucket <{+api+}/org/mongodb/scala/gridfs/GridFSBucket$.html>`__
+- `GridFSBucket <{+api+}/org/mongodb/scala/gridfs/GridFSBucket$.html>`__