PHPLIB-748: Support 'let' option for multiple CRUD commands (#910)

aleksandr-rudo · jmikola · web-flow · commit 4889f736ffd2 · 2022-04-18T21:06:10.000+03:00
* Updating all necessary classes with new 'let' option support. * Adding actual tests from specifications for "let" option by syncing unified spec tests with mongodb/specifications@1028c34 * Updating tests skips as some features are not yet implemented. * Updating driver version requirements. * Updating Mongo docs. Co-authored-by: Jeremy Mikola <jmikola@gmail.com>
diff --git a/source/includes/apiargs-MongoDBCollection-method-aggregate-option.yaml b/source/includes/apiargs-MongoDBCollection-method-aggregate-option.yaml
@@ -29,7 +29,7 @@ post: |
   .. versionadded:: 1.3
 ---
 source:
-  file: apiargs-aggregate-option.yaml
+  file: apiargs-common-option.yaml
   ref: let
 post: |
   .. versionadded:: 1.9
diff --git a/source/includes/apiargs-MongoDBCollection-method-bulkWrite-option.yaml b/source/includes/apiargs-MongoDBCollection-method-bulkWrite-option.yaml
@@ -2,6 +2,12 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: bypassDocumentValidation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 arg_name: option
 name: ordered
 type: boolean
diff --git a/source/includes/apiargs-MongoDBCollection-method-deleteMany-option.yaml b/source/includes/apiargs-MongoDBCollection-method-deleteMany-option.yaml
@@ -11,6 +11,12 @@ post: |
 
   .. versionadded:: 1.7
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: session
diff --git a/source/includes/apiargs-MongoDBCollection-method-deleteOne-option.yaml b/source/includes/apiargs-MongoDBCollection-method-deleteOne-option.yaml
@@ -11,6 +11,12 @@ post: |
 
   .. versionadded:: 1.7
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: session
diff --git a/source/includes/apiargs-MongoDBCollection-method-find-option.yaml b/source/includes/apiargs-MongoDBCollection-method-find-option.yaml
@@ -257,4 +257,10 @@ description: |
 interface: phpmethod
 operation: ~
 optional: true
+---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
 ...
diff --git a/source/includes/apiargs-MongoDBCollection-method-findOne-option.yaml b/source/includes/apiargs-MongoDBCollection-method-findOne-option.yaml
@@ -75,4 +75,10 @@ source:
 source:
   file: apiargs-MongoDBCollection-method-find-option.yaml
   ref: modifiers
+---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
 ...
diff --git a/source/includes/apiargs-MongoDBCollection-method-findOneAndDelete-option.yaml b/source/includes/apiargs-MongoDBCollection-method-findOneAndDelete-option.yaml
@@ -19,6 +19,12 @@ post: |
 
   .. versionadded:: 1.7
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: maxTimeMS
diff --git a/source/includes/apiargs-MongoDBCollection-method-findOneAndReplace-option.yaml b/source/includes/apiargs-MongoDBCollection-method-findOneAndReplace-option.yaml
@@ -27,6 +27,12 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: bypassDocumentValidation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 arg_name: option
 name: returnDocument
 type: integer
diff --git a/source/includes/apiargs-MongoDBCollection-method-findOneAndUpdate-option.yaml b/source/includes/apiargs-MongoDBCollection-method-findOneAndUpdate-option.yaml
@@ -33,6 +33,12 @@ source:
   file: apiargs-MongoDBCollection-common-option.yaml
   ref: bypassDocumentValidation
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 arg_name: option
 name: returnDocument
 type: integer
diff --git a/source/includes/apiargs-MongoDBCollection-method-replaceOne-option.yaml b/source/includes/apiargs-MongoDBCollection-method-replaceOne-option.yaml
@@ -19,6 +19,12 @@ post: |
 
   .. versionadded:: 1.6
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: session
diff --git a/source/includes/apiargs-MongoDBCollection-method-updateMany-option.yaml b/source/includes/apiargs-MongoDBCollection-method-updateMany-option.yaml
@@ -25,6 +25,12 @@ post: |
 
   .. versionadded:: 1.6
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: session
diff --git a/source/includes/apiargs-MongoDBCollection-method-updateOne-option.yaml b/source/includes/apiargs-MongoDBCollection-method-updateOne-option.yaml
@@ -25,6 +25,12 @@ post: |
 
   .. versionadded:: 1.6
 ---
+source:
+  file: apiargs-common-option.yaml
+  ref: let
+post: |
+  .. versionadded:: 1.13
+---
 source:
   file: apiargs-common-option.yaml
   ref: session
diff --git a/source/includes/apiargs-MongoDBDatabase-method-aggregate-option.yaml b/source/includes/apiargs-MongoDBDatabase-method-aggregate-option.yaml
@@ -23,7 +23,7 @@ source:
   ref: hint
 ---
 source:
-  file: apiargs-aggregate-option.yaml
+  file: apiargs-common-option.yaml
   ref: let
 post: |
   .. versionadded:: 1.9
diff --git a/source/includes/apiargs-aggregate-option.yaml b/source/includes/apiargs-aggregate-option.yaml
@@ -45,18 +45,4 @@ 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
 ...
diff --git a/source/includes/apiargs-common-option.yaml b/source/includes/apiargs-common-option.yaml
@@ -24,6 +24,20 @@ 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
+---
+arg_name: option
 name: maxTimeMS
 type: integer
 description: |
