Skip to content

PHPLIB-690 Update documentation for time series collection options #843

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 13, 2021
Merged

PHPLIB-690 Update documentation for time series collection options #843

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
201b3f3
PHPLIB-690 Update documentation for time series collection options
alcaeus Jul 13, 2021
23cb502
Apply suggestions from code review
alcaeus Jul 13, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 6 additions & 3 deletions docs/includes/apiargs-MongoDBDatabase-method-createCollection-option.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ arg_name: option
name: expireAfterSeconds
type: integer
description: |
Allows specifying a TTL after which documents will be removed from a
time-series collection.
Used to automatically delete documents in time series collections. See the
:manual:`create </reference/command/create>` command documentation for more
information.

This option is available in MongoDB 5.0+ and will result in an exception at
execution time if specified for an older server version.
Expand Down Expand Up @@ -152,7 +153,9 @@ arg_name: option
name: timeseries
type: array|object
description: |
Allows users to specify options for time-series collections.
An object containing options for creating time series collections. See the
:manual:`create </reference/command/create>` command documentation for
supported options.

This option is available in MongoDB 5.0+ and will result in an exception at
execution time if specified for an older server version.
Expand Down
1 change: 1 addition & 0 deletions docs/reference/method/MongoDBDatabase-createCollection.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,3 +97,4 @@ See Also
- :manual:`create </reference/command/create>` command reference in the MongoDB
manual
- :manual:`db.createCollection() </reference/method/db.createCollection>`
- :manual:`Time Series Collections </core/timeseries-collections>`