DOCSP-47031 Connection Pools #620
Conversation
✅ Deploy Preview for docs-java ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| The following code creates a client with a maximum connection pool size of ``50`` | ||
| by using either a :guilabel:`Connection String` or :guilabel:`MongoClientSettings` | ||
| object: |
There was a problem hiding this comment.
I haven't seen :guilabel: used before? I guess it just bold the text?
Anyway, would make these links to the Connection Options and MongoClient Settings pages.
There was a problem hiding this comment.
@rachel-mack Thanks for the below comments! The links to these pages can be found in the tabs. Since the links are now in a more content relevant place in the tabs, I think leaving without a link here is appropriate.
guilabel can be used when referring to UI components on the page (such as the tabs) or in the Atlas UI. Here are a few examples I've seen:
- https://github.com/mongodb/docs-java/blob/52989b698e6f0d9cd350bcdf018b3e0f6122c792/source/security/enterprise-auth.txt#L71C1-L71C76
- https://github.com/mongodb/docs-ruby/blob/88c9d5c460caa4fa1f57d12752f82d35e05a1522/source/security/auth-mechanisms/ldap.txt#L53
Updated the copy to specifically mention the tabs.
There was a problem hiding this comment.
In general there is not much guidance here on why you would set any of these properties to a non-default value, but if we're not trying to explain that, than I can accept it. It would certainly require a lot more thought, as there are no strict rules to follow.
| * - Setting | ||
| - Description | ||
|
|
||
| * - ``connectTimeoutMS`` |
There was a problem hiding this comment.
connectTimeoutMS and socketTimeoutMS are considered socket settings, not connection pool settings, and are configured programmatically not via ConnectionPoolSettings but via SocketSettings.
It's ok to include them on the same page but they should be separated, and we should show how to configure them programmatically as well.
There was a problem hiding this comment.
Thanks for the context, I can remove them from the table for simplicity's sake.
|
|
||
| - Specifies the maximum amount of time, in milliseconds, the Java driver | ||
| waits for a connection to open before timing out. A value of 0 instructs | ||
| the driver to never time out while waiting for a connection to open. |
There was a problem hiding this comment.
This is true, but in practice the OS has a connect timeout so it won't really wait forever. See if you can find a reference for that somewhere?
There was a problem hiding this comment.
Removed from the option instead, due to previous comment.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-47031
Staging Links
Self-Review Checklist