MongoDBGridFSBucket-openUploadStream.txt

===========================================
MongoDB\\GridFS\\Bucket::openUploadStream()
===========================================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\\GridFS\\Bucket::openUploadStream()

   Opens a writable stream for a new GridFS file.

   .. code-block:: php

      function openUploadStream($filename, array $options = []): resource

   :phpmethod:`MongoDB\\GridFS\\Bucket::openUploadStream()` has the following
   parameters:

   .. include:: /includes/apiargs/MongoDBGridFSBucket-method-openUploadStream-param.rst

   The ``$options`` parameter supports the following options:

   .. include:: /includes/apiargs/MongoDBGridFSBucket-method-openUploadStream-option.rst

   :returns:

      A writable stream resource.

Behavior
--------

Chunk documents will be created as data is written to the writable stream. The
metadata document will be created when the writable stream is closed.

.. todo: add examples

.. seealso::

   - :phpmethod:`MongoDB\\GridFS\\Bucket::uploadFromStream()`