1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
===========================================
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
This method 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
See Also
--------
- :phpmethod:`MongoDB\\GridFS\\Bucket::uploadFromStream()`