Adding cursor timeout, fixes #252

Author: jenssegers

README.md

@@ -557,6 +557,12 @@ The MongoClient and MongoDB objects can be accessed like this:
 
 ### MongoDB specific operations
 
+**Cursor timeout**
+
+To prevent MongoCursorTimeout exceptions, you can manually set a timeout value that will be applied to the cursor:
+
+    DB::collection('users')->timeout(-1)->get();
+
 **Upsert**
 
 Update or insert a document. Additional options for the update method are passed directly to the native update method.

src/Jenssegers/Mongodb/Query/Builder.php

@@ -25,6 +25,13 @@ class Builder extends \Illuminate\Database\Query\Builder {
      */
     public $projections;
 
+    /**
+     * The cursor timeout value.
+     *
+     * @var int
+     */
+    public $timeout;
+
     /**
      * All of the available clause operators.
      *
@@ -79,6 +86,19 @@ public function project($columns)
         return $this;
     }
 
+    /**
+     * Set the cursor timeout in seconds.
+     *
+     * @param  int $seconds
+     * @return $this
+     */
+    public function timeout($seconds)
+    {
+        $this->timeout = $seconds;
+
+        return $this;
+    }
+
     /**
      * Execute a query for a single record by ID.
      *
@@ -217,9 +237,10 @@ public function getFresh($columns = array())
             $cursor = $this->collection->find($wheres, $columns);
 
             // Apply order, offset and limit
-            if ($this->orders) $cursor->sort($this->orders);
-            if ($this->offset) $cursor->skip($this->offset);
-            if ($this->limit)  $cursor->limit($this->limit);
+            if ($this->timeout) $cursor->timeout($this->timeout);
+            if ($this->orders)  $cursor->sort($this->orders);
+            if ($this->offset)  $cursor->skip($this->offset);
+            if ($this->limit)   $cursor->limit($this->limit);
 
             // Return results as an array with numeric keys
             return iterator_to_array($cursor, false);