Skip to content

Commit 75ea95f

Browse files
committed
Merge pull request #731
* phplib-516: PHPLIB-516: Append PHPLIB version information to handshake data
2 parents 5fad17a + 69518eb commit 75ea95f

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

source/includes/apiargs-MongoDBClient-method-construct-driverOptions.yaml

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,34 @@ description: |
142142
For the ``keyVaultClient`` option, you may pass a :phpclass:`MongoDB\\Client`
143143
instance, which will be unwrapped to provide a :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>`
144144
to the extension.
145+
.. versionadded:: 1.6
146+
interface: phpmethod
147+
operation: ~
148+
optional: true
149+
---
150+
arg_name: option
151+
name: driver
152+
type: array
153+
description: |
154+
Additional driver metadata to be passed on to the server handshake. This is an
155+
array containing ``name``, ``version``, and ``platform`` fields:
156+
157+
.. code-block:: php
158+
159+
[
160+
'name' => 'my-driver',
161+
'version' => '1.2.3-dev',
162+
'platform' => 'some-platform',
163+
]
164+
165+
.. note::
166+
167+
This feature is primarily designed for custom drivers and ODMs, which may
168+
want to identify themselves to the server for diagnostic purposes.
169+
Applications should use the ``appName`` URI option instead of driver
170+
metadata.
171+
172+
.. versionadded:: 1.7
145173
interface: phpmethod
146174
operation: ~
147175
optional: true

0 commit comments

Comments
 (0)