Navigation

MongoDB\GridFS\Bucket::downloadToStream()

Definition

MongoDB\GridFS\Bucket::downloadToStream

Selects a GridFS file by its _id and copies its contents to a writable stream.

function downloadToStream($id, $destination): void

This method has the following parameters:

Parameter Type Description
$id mixed The _id of the file.
$destination resource Writable stream, to which the GridFS file’s contents will be written.

Errors/Exceptions

MongoDB\GridFS\Exception\FileNotFoundException if no file was found for the selection criteria.

MongoDB\Exception\InvalidArgumentException for errors related to the parsing of parameters or options.

MongoDB\Driver\Exception\RuntimeException for other errors at the driver level (e.g. connection errors).