Skip to content

Commit c614525

Browse files
committed
PHPLIB-187: Remind users to encode connection URIs
1 parent 308f53d commit c614525

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

docs/includes/apiargs-MongoDBClient-method-construct-param.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,12 @@ description: |
77
</reference/connection-string>` for formatting.
88
99
Defaults to ``"mongodb://127.0.0.1:27017"`` if unspecified.
10+
11+
Any special characters in the URI components need to be encoded according to
12+
`RFC 3986 <http://www.faqs.org/rfcs/rfc3986.html>`_. This is particularly
13+
relevant to the username and password, which can often include special
14+
characters such as ``@``, ``:``, or ``%``. The :php:`rawurlencode()
15+
<rawurlencode>` function may be used to encode constituent parts of the URI.
1016
interface: phpmethod
1117
operation: ~
1218
optional: true

0 commit comments

Comments
 (0)