Skip to content

Commit 0c7e297

Browse files
authored
PHPLIB-659 Support options for time-series collections (#829)
* PHPLIB-659 Support options for time-series collections * Update wording about 5.0 support
1 parent 6966d03 commit 0c7e297

File tree

1 file changed

+29
-0
lines changed

1 file changed

+29
-0
lines changed

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,21 @@ pre: |
3535
</reference/bson-type-comparison-order/#collation>` for the collection.
3636
---
3737
arg_name: option
38+
name: expireAfterSeconds
39+
type: integer
40+
description: |
41+
Allows specifying a TTL after which documents will be removed from a
42+
time-series collection.
43+
44+
This option is available in MongoDB 5.0+ and will result in an exception at
45+
execution time if specified for an older server version.
46+
47+
.. versionadded:: 1.9
48+
interface: phpmethod
49+
operation: ~
50+
optional: true
51+
---
52+
arg_name: option
3853
name: flags
3954
type: integer
4055
description: |
@@ -133,6 +148,20 @@ interface: phpmethod
133148
operation: ~
134149
optional: true
135150
---
151+
arg_name: option
152+
name: timeseries
153+
type: array|object
154+
description: |
155+
Allows users to specify options for time-series collections.
156+
157+
This option is available in MongoDB 5.0+ and will result in an exception at
158+
execution time if specified for an older server version.
159+
160+
.. versionadded:: 1.9
161+
interface: phpmethod
162+
operation: ~
163+
optional: true
164+
---
136165
source:
137166
file: apiargs-MongoDBDatabase-common-option.yaml
138167
ref: typeMap

0 commit comments

Comments
 (0)