DOCSP-35941 connection options #2892
Conversation
| - Boolean | ||
| - ``false`` | ||
| - Specifies whether to directly connect to a single host instead of | ||
| discovering and connecting to all servers in the cluster. |
There was a problem hiding this comment.
Note: I'll add a link to the Connection Guide section in the cleanup task on "Direct Connection" since that section is currently awaiting approval.
docs/fundamentals/connection.txt
Outdated
| Learn how to set up a connection and specify connection behavior from your | ||
| Laravel application to a MongoDB deployment by using {+odm-short+} in the | ||
| following sections: |
There was a problem hiding this comment.
S: I think this could be a little more concise
| Learn how to set up a connection and specify connection behavior from your | |
| Laravel application to a MongoDB deployment by using {+odm-short+} in the | |
| following sections: | |
| Learn how to use {+odm-short+} to set up a connection to a MongoDB deployment and specify connection behavior in the | |
| following sections: |
| ------------------------------------- | ||
|
|
||
| Learn how to add common connection and authentication options to your | ||
| configuration file in the following sections. |
There was a problem hiding this comment.
S: you could add a list of the subsections here
| - Append the setting and value as a query string parameter on the connection | ||
| string specified in the ``dsn`` array item. | ||
|
|
||
| To specify an option in the ``options`` array, add its name and value value as |
There was a problem hiding this comment.
I: remove the repeated word (value)
| To specify an option in the ``options`` array, add its name and value value as | |
| To specify an option in the ``options`` array, add its name and value as |
| - Non-negative integer | ||
| - 0 | ||
| - | Specifies the time in milliseconds that a connection can remain idle | ||
| in a connection pool the server closes it. |
There was a problem hiding this comment.
I: I think there's a missing conjunction here
| in a connection pool the server closes it. | |
| in a connection pool before the server closes it. |
There was a problem hiding this comment.
Good catch, thanks!
| * - **minPoolSize** | ||
| - Non-negative integer | ||
| - ``0`` | ||
| - | Specifies the minimum number of connections available in a server' |
There was a problem hiding this comment.
I: add an "s"
| - | Specifies the minimum number of connections available in a server' | |
| - | Specifies the minimum number of connections available in a server's |
| discovering and connecting to all servers in the cluster. | ||
|
|
||
| * - **heartbeatFrequencyMS** | ||
| - Integer greater than or equal to 500 |
There was a problem hiding this comment.
S: since you use monospace for most of the integer values in the table, I think this should be monospaced too
| - Integer greater than or equal to 500 | |
| - Integer greater than or equal to ``500`` |
There was a problem hiding this comment.
Applies elsewhere in the table (the localThresholdMS, maxIdleTimeMS, and zlibCompressionLevel rows)
There was a problem hiding this comment.
Good catch, thanks!
| // ... | ||
| ] | ||
|
|
||
| See the `$driverOptions: array section <https://www.mongodb.com/docs/php-library/current/reference/method/MongoDBClient__construct/#parameters>`__ |
There was a problem hiding this comment.
S: I'd take "section" out of the hyperlinked text
| See the `$driverOptions: array section <https://www.mongodb.com/docs/php-library/current/reference/method/MongoDBClient__construct/#parameters>`__ | |
| See the `$driverOptions: array <https://www.mongodb.com/docs/php-library/current/reference/method/MongoDBClient__construct/#parameters>`__ section |
JIRA: https://jira.mongodb.org/browse/DOCSP-35941
Note:
I used the list of connection options that we feature on other driver pages such as this Rust one, edited for grammar and clarity. I will test all the options featured on the page to see if they're picked up in
laravel-mongodb/src/Connection.php, but might not be able to verify whether the PHP Library completely supports them.Staging:
Checklist