PCSM-207 Documented a PLM_MONGODB_CLI_OPERATION_TIMEOUT env var #14
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR documents a new environment variable PLM_MONGODB_CLI_OPERATION_TIMEOUT that controls the timeout duration for MongoDB client operations.
- Added documentation for the
PLM_MONGODB_CLI_OPERATION_TIMEOUTenvironment variable
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/install/parameters.md
Outdated
| | `PLM_CLONE_NUM_PARALLEL_COLLECTIONS` | Number of collections cloned in parallel | `2` | | ||
| | `PLM_CLONE_NUM_READ_WORKERS` | Number of read workers for cloning | `NumCPU / 4` | | ||
| | `PLM_CLONE_NUM_INSERT_WORKERS` | Number of insert workers for cloning | `NumCPU * 4` | | ||
| | `PLM_MONGODB_CLI_OPERATION_TIMEOUT` | The time to wait for the MongoDB client operation such as insert, update, delete | `5m` | |
There was a problem hiding this comment.
[nitpick] The description could be clearer by specifying what happens when this timeout is reached (e.g., 'Maximum time to wait before timing out MongoDB client operations').
| | `PLM_MONGODB_CLI_OPERATION_TIMEOUT` | The time to wait for the MongoDB client operation such as insert, update, delete | `5m` | | |
| | `PLM_MONGODB_CLI_OPERATION_TIMEOUT` | Maximum time to wait before timing out MongoDB client operations (such as insert, update, delete). If the timeout is reached, the operation will fail. | `5m` | |
modified: docs/install/parameters.md
nastena1606
force-pushed
the
PCSM-207-Doc-expose-op-timeout
branch
from
cbe3530 to
a584629
Compare
docs/install/parameters.md
Outdated
| | `PLM_CLONE_NUM_PARALLEL_COLLECTIONS` | Number of collections cloned in parallel | `2` | | ||
| | `PLM_CLONE_NUM_READ_WORKERS` | Number of read workers for cloning | `NumCPU / 4` | | ||
| | `PLM_CLONE_NUM_INSERT_WORKERS` | Number of insert workers for cloning | `NumCPU * 4` | | ||
| | `PLM_MONGODB_CLI_OPERATION_TIMEOUT` | Maximum time to wait before timing out MongoDB client operations such as insert, update, delete. If the timeout is reached, the operation will fail. | `5m` | |
There was a problem hiding this comment.
Hey, we can go with this name, but we could also go with updated PCSM_* prefix and maybe also change the rest of env var names. Wdyt?
There was a problem hiding this comment.
I will rebase and proceed with renaming this new one
nastena1606
temporarily deployed
to
PCSM-207-Doc-expose-op-timeout - plm-docs PR #14
Render
Destroyed
|
Closing as the changes are already in main |
modified: docs/install/parameters.md