Skip to content

PHPLIB-663: Document aggregate "let" option #846

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.

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 1 commit into from
Jul 14, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ source:
post: |
.. versionadded:: 1.3
---
source:
file: apiargs-aggregate-option.yaml
ref: let
post: |
.. versionadded:: 1.9
---
source:
file: apiargs-common-option.yaml
ref: maxTimeMS
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ source:
file: apiargs-common-option.yaml
ref: hint
---
source:
file: apiargs-aggregate-option.yaml
ref: let
post: |
.. versionadded:: 1.9
---
source:
file: apiargs-common-option.yaml
ref: maxTimeMS
Expand Down
14 changes: 14 additions & 0 deletions docs/includes/apiargs-aggregate-option.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -49,4 +49,18 @@ description: |
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: let
type: array|object
description: |
Map of parameter names and values. Values must be constant or closed
expressions that do not reference document fields. Parameters can then be
accessed as variables in an aggregate expression context (e.g. ``$$var``).

This is not supported for server versions prior to 5.0 and will result in an
exception at execution time if used.
interface: phpmethod
operation: ~
optional: true
...