Skip to content

Commit 70b3ab6

Browse files
PHPLIB-869: Support viewOn and pipeline options in createCollection helper (#935)
1 parent 63f28c2 commit 70b3ab6

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

source/includes/apiargs-MongoDBDatabase-method-createCollection-option.yaml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -145,6 +145,20 @@ source:
145145
file: apiargs-common-option.yaml
146146
ref: maxTimeMS
147147
---
148+
arg_name: option
149+
name: pipeline
150+
type: array
151+
description: |
152+
An array that consists of the aggregation pipeline stage(s), which will be
153+
applied to the collection or view specified by ``viewOn``. See the
154+
:manual:`create </reference/command/create>` command documentation for more
155+
information.
156+
157+
.. versionadded:: 1.13
158+
interface: phpmethod
159+
operation: ~
160+
optional: true
161+
---
148162
source:
149163
file: apiargs-common-option.yaml
150164
ref: session
@@ -295,6 +309,23 @@ interface: phpmethod
295309
operation: ~
296310
optional: true
297311
---
312+
arg_name: option
313+
name: viewOn
314+
type: string
315+
description: |
316+
The name of the source collection or view from which to create the view.
317+
318+
.. note::
319+
320+
The name is not the full namespace of the collection or view (i.e. it does
321+
not include the database name). Views must be created in the same databases
322+
as the source collection or view.
323+
324+
.. versionadded:: 1.13
325+
interface: phpmethod
326+
operation: ~
327+
optional: true
328+
---
298329
source:
299330
file: apiargs-MongoDBDatabase-common-option.yaml
300331
ref: writeConcern

0 commit comments

Comments
 (0)