MongoDB\BSON\PackedArray::get
(mongodb >=1.16.0)
MongoDB\BSON\PackedArray::get — Returns the value of an index in the array
Parameters
-
key(int) -
The index to retrieve from the array.
Return Values
Returns the value associated with the given index. If the index is not present in the document, an exception is thrown.
Note: When encountering a value encoded as 64-bit integer in the BSON array, the return value of this method will be a MongoDB\BSON\Int64 instance.
Errors/Exceptions
- Throws MongoDB\Driver\Exception\InvalidArgumentException on argument parsing errors.
- Throws MongoDB\Driver\Exception\RuntimeException if the index is not present in the array.
See Also
- MongoDB\BSON\PackedArray::has() - Returns whether a index is present in the array
- » BSON Types
add a note
User Contributed Notes
There are no user contributed notes for this page.
