Commit ee833334 authored by Jeremy Mikola's avatar Jeremy Mikola

Common docs for hint option

parent 1ba76bfb
...@@ -23,7 +23,7 @@ post: | ...@@ -23,7 +23,7 @@ post: |
.. versionadded:: 1.4 .. versionadded:: 1.4
--- ---
source: source:
file: apiargs-aggregate-option.yaml file: apiargs-common-option.yaml
ref: hint ref: hint
post: | post: |
.. versionadded:: 1.3 .. versionadded:: 1.3
......
...@@ -87,18 +87,11 @@ interface: phpmethod ...@@ -87,18 +87,11 @@ interface: phpmethod
operation: ~ operation: ~
optional: true optional: true
--- ---
arg_name: option source:
name: hint file: apiargs-common-option.yaml
type: string|array|object ref: hint
description: | post: |
The index to use. Specify either the index name as a string or the index key
pattern as a document. If specified, then the query system will only consider
plans using the hinted index.
.. versionadded:: 1.2 .. versionadded:: 1.2
interface: phpmethod
operation: ~
optional: true
--- ---
arg_name: option arg_name: option
name: maxAwaitTimeMS name: maxAwaitTimeMS
......
...@@ -19,8 +19,10 @@ source: ...@@ -19,8 +19,10 @@ source:
ref: comment ref: comment
--- ---
source: source:
file: apiargs-MongoDBCollection-method-find-option.yaml file: apiargs-common-option.yaml
ref: hint ref: hint
post: |
.. versionadded:: 1.2
--- ---
source: source:
file: apiargs-common-option.yaml file: apiargs-common-option.yaml
......
...@@ -19,7 +19,7 @@ source: ...@@ -19,7 +19,7 @@ source:
ref: explain ref: explain
--- ---
source: source:
file: apiargs-aggregate-option.yaml file: apiargs-common-option.yaml
ref: hint ref: hint
--- ---
source: source:
......
...@@ -49,15 +49,4 @@ description: | ...@@ -49,15 +49,4 @@ description: |
interface: phpmethod interface: phpmethod
operation: ~ operation: ~
optional: true optional: true
---
arg_name: option
name: hint
type: string|array|object
description: |
The index to use. Specify either the index name as a string or the index key
pattern as a document. If specified, then the query system will only consider
plans using the hinted index.
interface: phpmethod
operation: ~
optional: true
... ...
...@@ -16,6 +16,17 @@ operation: ~ ...@@ -16,6 +16,17 @@ operation: ~
optional: true optional: true
--- ---
arg_name: option arg_name: option
name: hint
type: string|array|object
description: |
The index to use. Specify either the index name as a string or the index key
pattern as a document. If specified, then the query system will only consider
plans using the hinted index.
interface: phpmethod
operation: ~
optional: true
---
arg_name: option
name: maxTimeMS name: maxTimeMS
type: integer type: integer
description: | description: |
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment