docs: Explicitly document underlying BMQ_BROKER_URI behavior
#4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
`libbmq` supports a `BMQ_BROKER_URI` environment variable, which when set, [overrides any broker URI passed in through the `SessionOptions`][envvar]. As the Python SDK is a set of bindings on top of `libbmq`, we inherit this behavior as well. More specifically, setting `BMQ_BROKER_URI` overrides whatever value is passed in with the `broker` argument to the `blazingmq.Session` object. Our integration tests use the environment variable in this way, so it is important to document it correctly. This patch documents this behavior, which is stable and supported in `libbmq`, is exposed through the Python SDK, and is used by the Python SDK’s tests. [envvar]: https://bloomberg.github.io/blazingmq/docs/apidocs/cpp_apidocs/group__bmqa__session.html Signed-off-by: Patrick M. Niedzielski <[email protected]>
pniedzielski
added
skip news
hallfox
approved these changes
Nov 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
libbmqsupports aBMQ_BROKER_URIenvironment variable, which when set, overrides any broker URI passed in through theSessionOptions. As the Python SDK is a set of bindings on top oflibbmq, we inherit this behavior as well. More specifically, settingBMQ_BROKER_URIoverrides whatever value is passed in with thebrokerargument to theblazingmq.Sessionobject. Our integration tests use the environment variable in this way, so it is important to document it correctly.This patch documents this behavior, which is stable and supported in
libbmq, is exposed through the Python SDK, and is used by the Python SDK’s tests.