docs: clarify tenant param is only for Databend Cloud management mode#781
Merged
youngsofun merged 2 commits intoJun 23, 2026
Merged
Conversation
This file contains hidden or 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
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.
Summary
Clarify that the
tenantDSN parameter is only used in Databend Cloud management mode, not for specifying tenant in normal usage.Motivation
The
tenantparameter in DSN/connection args can be confusing — users might think it's for daily use to specify a tenant. In reality, it's exclusively for Databend Cloud's internal management mode. This PR:tenantfrom the user-facing DSN documentation in README.md (users shouldn't need it)core/src/client.rsanddriver/src/flight_sql.rsto make the intent clear for developersTesting
Documentation and comment-only change. Verified with
cargo check— no build errors.